carrierwave-meta 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5eb83f3482998f4a6d77e2f0eee81aac037cc2b4
+  data.tar.gz: c01a5c5d1c24f5ac61b7d7f02f082c37fa9ee22f
+SHA512:
+  metadata.gz: f3030e8b0b781f98cd64b6ab5bde51d70f80ad1551e7fadb6d8a508893df233c708ff72a03dcd64fe3d7ef506c6c7a83848872ccc0478857d76864a799715a3d
+  data.tar.gz: 80276a9f29cec556543907344b0b0d7f87ad8e5f53c651880a60f67da3545cad6b963af7323602a5d7443d38903301a7e9065980b1312bb122749ef1c9e3aac2

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-tmp/*
+tmp/*
+coverage

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 1.9.3
+before_install:
+  - uname -a
+  - sudo apt-get install libvips-dev

data/README.rdoc

@@ -1,5 +1,8 @@
 = carrierwave-meta
 
+{<img src="https://secure.travis-ci.org/gzigzigzeo/carrierwave-meta.png" alt="Build Status" />}[http://travis-ci.org/gzigzigzeo/carrierwave-meta]
+{<img src="https://codeclimate.com/github/gzigzigzeo/carrierwave-meta.png" />}[https://codeclimate.com/github/gzigzigzeo/carrierwave-meta]
+
 = Installation
 
 Add the following line to your Gemfile:
@@ -10,56 +13,59 @@ Add the following line to your Gemfile:
   class TestUploader < CarrierWave::Uploader::Base
     include CarrierWave::RMagick
     include CarrierWave::Meta
-  
-    storage :file
 
-    process :store_meta
+    process :store_meta => [{md5sum: true}]
     version :version do
       process :resize_to_fill => [200, 200]
       process :store_meta
     end
   end
-  
+
   file = File.open('test.jpg') # JPEG 500x300, 20000 bytes
   uploader = TestUploader.new
   uploader.store!(file)
-  
+
   uploader.width        # 500
   uploader.height       # 300
   uploader.image_size   # [500, 300]
-  uploader.file_zie     # 20000
+  uploader.file_size    # 20000
   uploader.content_type # "image/jpeg"
-  
+  uploader.md5sum       # "fuuaasdfasdf...."
+
   uploader.version.width        # 200
-  uploader.version.height       # 200  
-  uploader.version.image_size   # [200, 200]  
+  uploader.version.height       # 200
+  uploader.version.image_size   # [200, 200]
   uploader.version.file_zie     # less than 20000
   uploader.version.content_type # "image/jpeg"
+  uploader.version.md5sum       # nil
 
 = Saving values to database
 
-Simply create database columns to hold metadata in your model's table. Currently gem supports width, height, 
-image_size ([width, height]), content_type and file_size fields. Versions are supported too.
+Simply create database columns to hold metadata in your model's table. Currently
+gem supports width, height, image_size ([width, height]), content_type,
+file_size and MD5 fields. Versions are supported too.
 
   class TestModel
-    attr_accessor :image_width  
+    attr_accessor :image_width
     attr_accessor :image_height
-    attr_accessor :image_image_size  
+    attr_accessor :image_image_size
     attr_accessor :image_content_type
     attr_accessor :image_file_size
+    attr_accessor :image_md5sum
 
-    attr_accessor :image_version_width  
+    attr_accessor :image_version_width
     attr_accessor :image_version_height
     attr_accessor :image_version_image_size
     attr_accessor :image_version_content_type
-    attr_accessor :image_version_file_size  
+    attr_accessor :image_version_file_size
+    attr_accessor :image_version_md5sum
   end
 
   file = File.open('test.jpg')
   model = TestModel.new
   uploader = TestUploader.new(model, :image)
   uploader.store!(file)
-  
+
   uploader.width      # 500
   model.image_width   # 500
   model.image_height  # 300
@@ -67,38 +73,66 @@ image_size ([width, height]), content_type and file_size fields. Versions are su
 
 When columns are available in the model instance, metadata is stored in that columns.
 
+= Saving values into single column
+
+For now, works only with ActiveRecord.
+
+  class TestModel < ActiveRecord::Base
+    extend CarrierWave::Meta::ActiveRecord
+
+    mount_uploader :image, TestUploader
+    serialize :image_meta, OpenStruct
+    carrierwave_meta_composed :image_meta,
+      :image, image_version: [:width, :height, :md5sum]
+  end
+
+  model = TestModel.new
+  model.image.store!('test.jpg')
+  model.image_width         # 200
+  model.image_version_width # 200
+  model.image_meta          # {image_width: 200, image_height: 200, ...}
+
+All you need is image_meta column, all other attributes are virtual. Note
+that carrierwave_meta_composed should be called after mounting uploader.
+
 = Behind the scenes
 
-After the file is retrieved from store or cache metadata is recalculated unless uploader has attached
-model instance. If uploader has attached model instance values are read from that instance.
+After the file is retrieved from store or cache metadata is recalculated
+unless uploader has attached model instance. If uploader has attached
+model instance values are read from that instance.
 
   uploader = TestUploader.new
   uploader.retrieve_from_store!('test.jpg')
-
   uploader.version.width # 200
 
+  model = TestModel.new
+  model.image.store!('test.jpg')
+  model.image_width # 200
+  model.image.width # 200, actually read from image_width
+
 = model_delegate_attribute
 
-Used to synchronize data between uploader and mounted model instance. Model's instance is used like value cache.
+Is used to synchronize data between uploader and mounted model instance.
+Model's instance is used like value cache.
 
   class DelegateTestModel
     attr_accessor :processed
     attr_accessor :a_processed
     attr_accessor :a_b_processed
   end
-  
+
   class DelegateTestUploader < CarrierWave::Uploader::Base
     model_delegate_attribute :uploaded
-  
+
     set_processed
-  
+
     version :a do
       set_processed
       version :b do
         set_processed
       end
     end
-  
+
     def set_processed
       self.processed = true
     end
@@ -107,23 +141,25 @@ Used to synchronize data between uploader and mounted model instance. Model's in
   model = DelegateTestModel.new
   uploader = DelegateTestUploader.new(model, :image)
   file = File.open('test.jpg')
-  
+
   uploader.store!(file)
-  
+
   model.processed     # true
-  model.a_processed   # true  
+  model.a_processed   # true
   model.a_b_processed # true
-  
+
   model.a_processed = false
-  
+
   uploader.processed     # true
   uploader.a_processed   # false
   uploader.a_b_processed # true
 
 When model is mounted to uploader:
 
-1. If attribute is assigned inside uploader then corresponding property in model is also assigned.
-2. If attribute is retrieved from uploader instance first checks that value is defined in model and returns it. Otherwise returns uploader's instance variable.
+1. If attribute is assigned inside uploader then corresponding property
+in model is also assigned.
+2. If attribute is retrieved from uploader, uploader checks that value is
+defined in model and returns it. Otherwise returns uploader's instance variable.
 3. If file is deleted, value becomes nil.
 
 Otherwise acts as regular uploader's instance variables.
@@ -143,7 +179,7 @@ The uploader:
     version :crop_source do
       process :resize_to_fit => [300, 300]
       process :store_meta
-    
+
       # This is the cropped version of parent image. Let crop to 50x50 square.
       version :crop do
         process :crop_to => [50, 50]
@@ -151,7 +187,7 @@ The uploader:
     end
 
     # Defines crop area dimensions.
-    # This should be assigned before #store! and #cache! called and should be saved in the model's instance. 
+    # This should be assigned before #store! and #cache! called and should be saved in the model's instance.
     # Otherwise cropped image would be lost after #recreate_versions! is called.
     # If crop area dimensions are'nt assigned, uploader calculates crop area dimensions inside the
     # parent image and creates the default image.
@@ -177,13 +213,13 @@ The uploader:
         cropped_img = img.crop(x, y, width, height)
         new_img = cropped_img.resize_to_fill(new_width, new_height)
         destroy_image(cropped_img)
-        destroy_image(img)      
+        destroy_image(img)
         new_img
       end
     end
 
     # Creates the default crop image.
-    # Here the original crop area dimensions are restored and assigned to the model's instance.  
+    # Here the original crop area dimensions are restored and assigned to the model's instance.
     def resize_to_fill_and_save_dimensions(new_width, new_height)
       manipulate! do |img|
         width, height = img.columns, img.rows
@@ -194,20 +230,20 @@ The uploader:
         h_ratio = height.to_f / new_height.to_f
 
         ratio = [w_ratio, h_ratio].min
-      
+
         self.w = ratio * new_width
         self.h = ratio * new_height
         self.x = (width - self.w) / 2
         self.y = (height - self.h) / 2
-            
+
         new_img
       end
     end
-    
+
     private
     def crop_args
       %w(x y w h).map { |accessor| send(accessor).to_i }
-    end    
+    end
   end
 
   # Post should have :crop_source_version_x, :crop_source_version_y, :crop_source_version_h, :crop_source_version_w columns
@@ -221,14 +257,14 @@ The uploader:
   post.save!
 
   post.image.crop_source.width  # 300
-  post.image.crop_source.height # 200  
+  post.image.crop_source.height # 200
   post.image.crop_source.crop.width  # 50
   post.image.crop_source.crop.height # 50
-  
+
   # Default crop area coordinates within the limits of big image dimensions: square at the center of an image
   post.image.crop_source.crop.x # 50
   post.image.crop_source.crop.y # 50
-  post.image.crop_source.crop.w # 200 
+  post.image.crop_source.crop.w # 200
   post.image.crop_source.crop.h # 200
 
   # Let user change the crop area with JCrop script. Pass new crop area parameters to the model.
@@ -238,19 +274,51 @@ The uploader:
   post.crop_source_crop_h = 100
 
   post.save! # Crop image is reprocessed
-  
+
   post.image.crop_source.crop.width  # 50
   post.image.crop_source.crop.height # 50
 
+= PDF/GhostScript support
+
+If you want to use this plugin with PDF/PostScript files than you should install
+GhostScript and rebuild ImageMagick with GhostScript support:
+
+  brew install ghostscript
+  brew install imagemagick --with-ghostscript
+  gem uninstall rmagick && gem install rmagick
+
+To switch on PDF/EPS processing you should enable GhostScript somewhere in your
+app's initializer:
+
+  CarrierWave::Meta.ghostscript_enabled = true
+
 = A note about testing
 
+@SergeyKishenin added specs for EPS/GhostScript files. They run for image_magick
+or mini_magick processor by default. To make specs work please install
+GhostScript as described above. To run specs WITHOUT PDF/EPS do:
+
+  PDF_EPS=false bundle exec rspec
+
 @fschwahn added support for mini-magick. To run tests with mini-magick do:
 
-  bundle exec rake spec PROCESSOR=mini_magick
+  PROCESSOR=mini_magick bundle exec rspec
+
+@skord added support for ImageSorcery. To run specs do:
+
+  PROCESSOR=image_sorcery bundle exec rspec
+
+To run specs against VIPS processor do:
+
+  PROCESSOR=vips bundle exec rspec
+
+To run specs against with Fog (Amazon S3) simulation:
+
+  STORAGE=fog bundle exec rspec
 
 = TODO
 
 1. I do not know how it would work with S3 and other remote storages. Should be tested.
 2. Write integration guide for JCrop.
 3. A notice about content-type.
-4. Improve my english skills.
+

data/carrierwave-meta.gemspec

@@ -26,4 +26,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<rmagick>)
   s.add_development_dependency(%q<mini_magick>)
   s.add_development_dependency(%q<mime-types>)
+  s.add_development_dependency(%q<carrierwave-imagesorcery>)
+  s.add_development_dependency(%q<carrierwave-vips>)
+  s.add_development_dependency(%q<fog>, '~> 1.3.1')
+  s.add_development_dependency(%q<simplecov>)
+  s.add_development_dependency(%q<activerecord>, '>= 3.0')
 end

data/lib/carrierwave-meta.rb

@@ -1,5 +1,7 @@
 require 'active_support/concern'
+require 'active_support/core_ext/module/attribute_accessors'
 require 'mime/types'
-require "carrierwave-meta/version"
+require 'carrierwave-meta/version'
 require 'carrierwave-meta/model_delegate_attribute'
 require 'carrierwave-meta/meta'
+require 'carrierwave-meta/active_record'

data/lib/carrierwave-meta/active_record.rb

@@ -0,0 +1,22 @@
+module CarrierWave
+  module Meta
+    module ActiveRecord
+      ALLOWED = %w(width height md5sum image_size file_size content_type)
+
+      def carrierwave_meta_composed(single_attribute, *args)
+        defined_attrs = args.map do |arg|
+          name, to_define = if arg.is_a?(Symbol)
+            [arg, ALLOWED]
+          elsif arg.is_a?(Hash)
+            [arg.keys.first, arg.values.first]
+          end
+
+          to_define.map do |attr|
+            delegate :"#{name}_#{attr}", to: single_attribute, allow_nil: true
+            delegate :"#{name}_#{attr}=", to: single_attribute, allow_nil: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave-meta/meta.rb

@@ -2,6 +2,9 @@ module CarrierWave
   module Meta
     extend ActiveSupport::Concern
 
+    mattr_accessor :ghostscript_enabled
+    self.ghostscript_enabled = false
+
     included do
       include CarrierWave::ModelDelegateAttribute
       include CarrierWave::MimeTypes
@@ -10,7 +13,7 @@ module CarrierWave
 
       after :retrieve_from_cache, :set_content_type
       after :retrieve_from_cache, :call_store_meta
-      after :retrieve_from_store, :set_content_type
+      after :retrieve_from_store, :set_content_type unless storage.name =~ /Fog/
       after :retrieve_from_store, :call_store_meta
 
       model_delegate_attribute :content_type, ''
@@ -18,9 +21,10 @@ module CarrierWave
       model_delegate_attribute :image_size, []
       model_delegate_attribute :width, 0
       model_delegate_attribute :height, 0
+      model_delegate_attribute :md5sum, ''
     end
 
-    def store_meta
+    def store_meta(options = {})
       if self.file.present?
         dimensions = get_dimensions
         width, height = dimensions
@@ -29,41 +33,71 @@ module CarrierWave
         self.image_size = dimensions
         self.width = width
         self.height = height
+        if options[:md5sum]
+          self.md5sum = Digest::MD5.hexdigest(File.read(self.file.path))
+        end
       end
     end
 
-    def set_content_type(file = nil)
-      set_content_type(true)
-    end
-
     def image_size_s
       image_size.join('x')
     end
 
     private
     def call_store_meta(file = nil)
-      # Re-retrieve metadata for a file only if model is not present OR model is not saved.
-      store_meta if self.model.nil? || (self.model.respond_to?(:new_record?) && self.model.new_record?)
+      # Re-retrieve metadata for a file only if model is not present OR
+      # model is not saved.
+      if model.nil? || (model.respond_to?(:new_record?) && model.new_record?)
+        processor_options = processors.
+          find { |p| p.first == :store_meta }.
+          try(:[], 1)
+
+        store_meta(*processor_options)
+      end
     end
 
     def get_dimensions
       [].tap do |size|
-        if self.file.content_type =~ /image/
-          manipulate! do |img|
-            if defined?(::Magick::Image) && img.is_a?(::Magick::Image)
-              size << img.columns
-              size << img.rows
-            elsif defined?(::MiniMagick::Image) && img.is_a?(::MiniMagick::Image)
-              size << img["width"]
-              size << img["height"]
-            else
-              raise "Only RMagick & MiniMagick are supported yet. Fork and update it."
-            end
-            img
+        is_image = file.content_type =~ /image/
+        is_pdf =
+          file.content_type =~ /postscript|pdf/ &&
+          CarrierWave::Meta.ghostscript_enabled
+
+        is_dimensionable = is_image || is_pdf
+
+        manipulate! do |img|
+          if processor?(:rmagick, img) && is_dimensionable
+            size << img.columns
+            size << img.rows
+          elsif processor?(:mini_magick, img) && is_dimensionable
+            size << img['width']
+            size << img['height']
+          elsif processor?(:socrecy, img) && is_image
+            size << img.dimensions[:x].to_i
+            size << img.dimensions[:y].to_i
+          elsif processor?(:vips, img) && is_image
+            size << img.x_size
+            size << img.y_size
+          else
+            raise "Unsupported file type/image processor (use RMagick, MiniMagick, ImageSorcery, VIPS)"
           end
+          img
         end
       end
     rescue CarrierWave::ProcessingError
     end
+
+    def processor?(processor, img)
+      processor = PROCESSORS[processor]
+      processor_class = processor.constantize rescue nil
+      processor_class.present? && img.is_a?(processor_class)
+    end
+
+    PROCESSORS = {
+      rmagick: 'Magick::Image',
+      mini_magick: 'MiniMagick::Image',
+      socrecy: 'ImageSorcery',
+      vips: 'VIPS::Image'
+    }
   end
-end
+end