Module: Gluttonberg::Library

Defined in:
lib/gluttonberg/library.rb,
lib/gluttonberg/library/quick_magick.rb,
lib/gluttonberg/library/attachment_mixin.rb,
lib/gluttonberg/library/quick_magick/image.rb,
lib/gluttonberg/library/quick_magick/image_list.rb

Overview

The library module encapsulates the few bits of functionality that lives outside of the library models and controllers. It contains some configuration details and is responsible for bootstrapping the various bits of meta-data used when categorising uploaded assets.

Defined Under Namespace

Modules: AttachmentMixin, QuickMagick Classes: String

Constant Summary collapse

UNCATEGORISED_CATEGORY = 
'uncategorised'
@@assets_root = 
nil
@@test_assets_root = 
nil

Class Method Summary collapse

Class Method Details

.bootstrap ⇒ Object 



17
18
19
 
# File 'lib/gluttonberg/library.rb', line 17

def self.bootstrap
  build_default_asset_types
end

.build_default_asset_types ⇒ Object

Adds a the inbuilt asset types to the database.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/gluttonberg/library.rb', line 57

def self.build_default_asset_types
  begin
      # ensure that all the categories exist
      AssetCategory.build_defaults
      ensure_type('Unknown Image', 'image', AssetCategory.image_category)
      ensure_type('Unknown Video', 'video', AssetCategory.video_category)
      ensure_type('Unknown Audio', 'audio', AssetCategory.audio_category)
      ensure_type('Unknown File',   'multi-part model message unknown', AssetCategory.uncategorised_category)

      ensure_type('Jpeg Image', 'image/jpeg image/pjpeg', AssetCategory.image_category)
      ensure_type('Gif Image', 'image/gif', AssetCategory.image_category)
      ensure_type('Png Image', 'image/png', AssetCategory.image_category)
      ensure_type('Tiff Image', 'image/tiff', AssetCategory.image_category)
      ensure_type('Adobe Photoshop Image', 'image/vnd.adobe.photoshop', AssetCategory.image_category)
      ensure_type('Autocad Image', 'image/vnd.dwg', AssetCategory.image_category)
      ensure_type('Autocad Image', 'image/vnd.dxf', AssetCategory.image_category)
      ensure_type('Icon Image', 'image/vnd.microsoft.icon', AssetCategory.image_category)
      ensure_type('Bitmap Image', 'image/x-bmp image/bmp image/x-win-bmp', AssetCategory.image_category)
      ensure_type('Paintshop Pro Image', 'image/x-paintshoppro', AssetCategory.image_category)
      ensure_type('Mobile Image (plb,psb,pvb)', 'application/vnd.3gpp.pic-bw-large application/vnd.3gpp.pic-bw-small application/vnd.3gpp.pic-bw-var', AssetCategory.image_category)

      ensure_type('Moile Audio (3gpp,3gpp2)', 'audio/3gpp audio/3gpp2', AssetCategory.audio_category)
      ensure_type('Dolby Digital Audio (ac3)', 'audio/ac3', AssetCategory.audio_category)
      ensure_type('Mpeg Audio (mpga,mp2,mp3,mp4,mpa)', 'audio/mpeg audio/mpeg4-generic audio/mp4 audio/mpa-robust', AssetCategory.audio_category) # @mpga,mp2,mp3
      ensure_type('Aiff Audio (aif,aifc,aiff)', 'audio/x-aiff', AssetCategory.audio_category)
      ensure_type('Midi Audio (mid,midi,kar)', 'audio/x-midi', AssetCategory.audio_category)
      ensure_type('Real Audio (rm,ram,ra)', 'audio/x-pn-realaudio audio/x-realaudio', AssetCategory.audio_category)
      ensure_type('Wav Audio (wav)', 'audio/x-wav', AssetCategory.audio_category)
      ensure_type('Ogg Vorbis Audio (ogg)', 'application/ogg', AssetCategory.audio_category)

      ensure_type('Mobile Video', 'video/3gpp video/3gpp-tt video/3gpp2', AssetCategory.video_category) #  @3gp,3gpp 'RFC3839,DRAFT:draft-gellens-mime-bucket
      ensure_type('Digital Video', 'video/DV', AssetCategory.video_category) #  RFC3189
      ensure_type('Compressed Video', 'application/mpeg4-iod-xmt application/mpeg4-iod application/mpeg4-generic video/mp4  application/mp4 video/MPV video/mpeg4-generic video/mpeg video/MP2T video/H261 video/H263 video/H263-1998 video/H263-2000 video/H264 video/MP1S video/MP2P', AssetCategory.video_category) #  RFC3555
      ensure_type('Jpeg Video', 'video/JPEG video/MJ2', AssetCategory.video_category) #  RFC3555
      ensure_type('Quicktime Video', 'video/quicktime', AssetCategory.video_category)
      ensure_type('Uncompressed Video', 'video/raw', AssetCategory.video_category)
      ensure_type('Mpeg Playlist (mxu,m4u)', 'video/vnd.mpegurl', AssetCategory.video_category)
      ensure_type('Avi Video (avi)', 'video/x-msvideo', AssetCategory.video_category)
      ensure_type('Flash Video', 'video/x-flv', AssetCategory.video_category)
    
      ensure_type('M4v Video', 'video/x-m4v', AssetCategory.video_category)  
      
      #document category
      ensure_type('Generic Document', 'application/x-csh application/x-dvi application/oda application/pgp-encrypted application/pgp-keys application/pgp-signature', AssetCategory.document_category)
      ensure_type('Calendar Document', 'text/calendar text/x-vcalendar', AssetCategory.document_category)
      ensure_type('Comma Seperated Values Document (csv)', 'text/csv text/comma-separated-values', AssetCategory.document_category)
      ensure_type('Tab Seperated Values Text Document', 'text/tab-separated-values', AssetCategory.document_category)
      ensure_type('Web Document', 'text/html', AssetCategory.document_category)
      ensure_type('Plain Text Document', 'text/plain', AssetCategory.document_category)
      ensure_type('Rich Text Document', 'text/richtext text/rtf', AssetCategory.document_category)
      ensure_type('Sgml Document', 'text/sgml', AssetCategory.document_category)
      ensure_type('Wap Document', 'text/vnd.wap.wml text/vnd.wap.wmlscript', AssetCategory.document_category)
      ensure_type('XML Document', 'text/xml text/xml-external-parsed-entity', AssetCategory.document_category)
      ensure_type('V-Card Document (vcf)', 'text/x-vcard', AssetCategory.document_category)
      ensure_type('Apple Macintosh Document (hqx)', 'application/mac-binhex40', AssetCategory.document_category)      
      ensure_type('Adobe Acrobat Document (pdf)', 'application/pdf', AssetCategory.document_category)
      ensure_type('Microsoft Word Document (doc,dot,docx)', 'application/msword application/word', AssetCategory.document_category)
      ensure_type('Microsoft Powerpoint Document (ppt,pps,pot,pptx)', 'application/vnd.ms-powerpoint application/powerpoint', AssetCategory.document_category)
      ensure_type('Microsoft Excel Document (xls,xlt,xlsx)', 'application/vnd.ms-excel application/excel', AssetCategory.document_category)
      ensure_type('Microsoft Works Document', 'application/vnd.ms-works', AssetCategory.document_category)
      ensure_type('Microsoft Project Document (mpp)', 'application/vnd.ms-project', AssetCategory.document_category)
      ensure_type('Microsoft Visio Document (vsd,vst,vsw,vss)', 'application/vnd.visio', AssetCategory.document_category)
      ensure_type('HTML Help Document (chm)', 'application/x-chm', AssetCategory.document_category)
      
      
  rescue => e
    puts "asset library init fails."
    puts e
  end    

end

.flush_asset_types ⇒ Object

Removes and re-adds all asset types.



51
52
53
54
 
# File 'lib/gluttonberg/library.rb', line 51

def self.flush_asset_types
  AssetType.all.each{|asset_type| asset_type.destroy}
  AssetMimeType.all.each{|asset_mime_type| asset_mime_type.destroy}
end

.rebuild ⇒ Object

This method is mainly for administrative purposes. It will rebuild the table of asset types, then recategorise each asset.



43
44
45
46
47
48
 
# File 'lib/gluttonberg/library.rb', line 43

def self.rebuild
  Asset.clear_all_asset_types
  flush_asset_types
  build_default_asset_types
  Asset.refresh_all_asset_types
end

.root ⇒ Object

Returns the path to the directory where assets are stored.



33
34
35
36
37
38
39
 
# File 'lib/gluttonberg/library.rb', line 33

def self.root
  if ::Rails.env == "test"
    @@test_assets_root
  else  
    @@assets_root
  end  
end

.setup ⇒ Object

Is run when the slice is loaded. It makes sure that all the required directories for storing assets are in the public dir, creating them if they are missing. It also stores the various paths so they can be retreived using the assets_dir method.



25
26
27
28
29
30
 
# File 'lib/gluttonberg/library.rb', line 25

def self.setup
  #logger.info("AssetLibrary is checking for asset folder")
  @@assets_root = "public/user_assets"
  @@test_assets_root = "public/test_assets"
  FileUtils.mkdir(root) unless File.exists?(root) || File.symlink?(root)      
end