carrierwave-meta 0.0.1 → 0.0.2

data/README.rdoc

@@ -11,14 +11,6 @@ Add the following line to your Gemfile:
     include CarrierWave::RMagick
     include CarrierWave::Meta
   
-    def store_dir
-      "tmp/store"
-    end
-
-    def cache_dir
-      "tmp/cache"
-    end
-
     storage :file
 
     process :store_meta
@@ -46,6 +38,9 @@ Add the following line to your Gemfile:
 
 = 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.
+
   class TestModel
     attr_accessor :image_width  
     attr_accessor :image_height
@@ -74,25 +69,188 @@ When columns are available in the model instance, metadata is stored in that col
 
 = Behind the scenes
 
-After the file is retrieved from store metadata is recalculated for it unless uploader has
-attached model 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
 
-So, if you are storing width and height in database column and then you decided to store 
-content type.
+= model_delegate_attribute
+
+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
+  end
+
+  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_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.
+3. If file is deleted, value becomes nil.
+
+Otherwise acts as regular uploader's instance variables.
+
+This is very useful for:
+
+= Integrating CarrierWave with JCrop
+
+Let implement the behavior like at this demo: http://deepliquid.com/projects/Jcrop/demos.php?demo=thumbnail
+
+The uploader:
+
+  class CropUploader < SobakaUploader
+    include CarrierWave::Meta
+
+    # Crop source is a source image converted from original which could be bigger than source area (left image in the example).
+    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]
+      end
+    end
+
+    # Defines crop area dimensions.
+    # 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.
+    model_delegate_attribute :x
+    model_delegate_attribute :y
+    model_delegate_attribute :w
+    model_delegate_attribute :h
+
+    # Crop processor
+    def crop_to(width, height)
+      # Checks that crop area is defined and crop should be done.
+      if ((crop_args[0] == crop_args[2]) || (crop_args[1] == crop_args[3]))
+        # If not creates default image and saves it's dimensions.
+        resize_to_fill_and_save_dimensions(width, height)
+      else
+        args = crop_args + [width, height]
+        crop_and_resize(*args)
+      end
+    end
+
+    def crop_and_resize(x, y, width, height, new_width, new_height)
+      manipulate! do |img|
+        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)      
+        new_img
+      end
+    end
+
+    # Creates the default crop image.
+    # 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
+        new_img = img.resize_to_fill(new_width, new_height)
+        destroy_image(img)
+
+        w_ratio = width.to_f / new_width.to_f
+        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
+
+  # Post should have :crop_source_version_x, :crop_source_version_y, :crop_source_version_h, :crop_source_version_w columns
+  class Post < ActiveRecord::Base
+    mount_uploader CropUploader, :image
+  end
+
+  # Let's upload an image
+  post = Post.new
+  post.image = params[:image] # Let the uploaded file is 800x600 JPEG
+  post.save!
+
+  post.image.crop_source.width  # 300
+  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.h # 200
+
+  # Let user change the crop area with JCrop script. Pass new crop area parameters to the model.
+  post.crop_source_crop_x = 100
+  post.crop_source_crop_y = 100
+  post.crop_source_crop_w = 100
+  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
 
-Uploader tries to retrieve metadata from a model's column first.
+= A note about testing
 
-= Integrating CarrierWave & JCrop using carrierwave-meta
+fschwahn added support for mini-magick. To run tests with mini-magick do:
 
+  bundle exec rake spec PROCESSOR=mini_magick
 
 = 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. It works now only with RMagick. Add support for other image libraries. It's easy.
+4. Improve my english skills.

data/carrierwave-meta.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |s|
   
   s.add_dependency(%q<carrierwave>, [">= 0.5.7"])
   s.add_dependency(%q<activesupport>, [">= 3.0"])  
+  s.add_dependency(%q<mime-types>)
   s.add_development_dependency(%q<rspec-rails>, ">= 2.6")
   s.add_development_dependency(%q<sqlite3-ruby>)    
   s.add_development_dependency(%q<rmagick>)
+  s.add_development_dependency(%q<mini_magick>)
   s.add_development_dependency(%q<mime-types>)
 end

data/lib/carrierwave-meta.rb

@@ -1,4 +1,5 @@
 require 'active_support/concern'
+require 'mime/types'
 require "carrierwave-meta/version"
 require 'carrierwave-meta/model_delegate_attribute'
 require 'carrierwave-meta/meta'

data/lib/carrierwave-meta/meta.rb

@@ -37,6 +37,10 @@ module CarrierWave
         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.
@@ -47,9 +51,12 @@ module CarrierWave
         [].tap do |size|
           if self.file.content_type =~ /image/
             manipulate! do |img|
-              if img.is_a?(::Magick::Image)
+              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 is supported yet. Fork and update it."
               end        

data/lib/carrierwave-meta/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Meta
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/modules/meta_spec.rb

@@ -13,14 +13,16 @@ describe TestUploader do
     uploader.width.should eq(ORIGINAL_SIZE[0])
     uploader.height.should eq(ORIGINAL_SIZE[1])
     uploader.image_size.should eq(ORIGINAL_SIZE)
-    uploader.content_type.should eq(Mime::Types.type_for(file_name).first.to_s)
+    uploader.content_type.should eq(MIME::Types.type_for(file_name).first.to_s)
     uploader.file_size.should_not be_blank
+    uploader.image_size_s.should eq(ORIGINAL_SIZE.join('x'))
 
     uploader.version.width.should eq(VERSION_SIZE[0])
     uploader.version.height.should eq(VERSION_SIZE[1])
     uploader.version.image_size.should eq(VERSION_SIZE)
-    uploader.version.content_type.should eq(Mime::Types.type_for(file_name).first.to_s)
+    uploader.version.content_type.should eq(MIME::Types.type_for(file_name).first.to_s)
     uploader.version.file_size.should_not be_blank
+    uploader.version.image_size_s.should eq(VERSION_SIZE.join('x'))    
   end
 
   def obj_values_are_correct(obj)
@@ -37,11 +39,6 @@ describe TestUploader do
     obj.image_version_file_size.should_not be_blank
   end
 
-  def uploader_values_are_correct(obj)
-    obj.width.should eq(ORIGINAL_SIZE[0])
-    obj.height.should eq(ORIGINAL_SIZE[1])
-  end
-
   context "detached uploader" do
     it "stores metadata after cache!" do
       uploader = TestUploader.new

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ rescue Bundler::GemNotFound
     "Did you run `bundle install`?"
 end
 
+PROCESSOR = (ENV["PROCESSOR"] || :rmagick).to_sym
+
 require 'mime/types'
 require 'carrierwave'
 require 'carrierwave-meta'

data/spec/support/test_uploader.rb

@@ -1,5 +1,9 @@
 class TestUploader < CarrierWave::Uploader::Base
-  include CarrierWave::RMagick
+  if PROCESSOR == :mini_magick
+    include CarrierWave::MiniMagick
+  else
+    include CarrierWave::RMagick
+  end
   include CarrierWave::Meta
   
   def store_dir

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carrierwave-meta
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Victor Sokolov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-09 00:00:00 Z
+date: 2011-10-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: carrierwave
@@ -49,9 +49,23 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: mime-types
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,11 +76,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,11 +90,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rmagick
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,11 +104,25 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mini_magick
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: mime-types
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -104,7 +132,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id008
 description: ""
 email: 
 - gzigzigzi@gmail.com