carrierwave 0.4.1 → 0.4.2

data/History.txt

@@ -1,4 +1,11 @@
-=== Version 0.4.1
+=== Version 0.4.2 2009-11-26
+
+* [added] RightAWS as an alternative S3 implementation
+* [added] An option to enable/disable processing for tests
+* [added] Mongoid ORM support
+* [fixed] DataMapper now works both with and without dm-validations
+
+=== Version 0.4.1 2009-10-26
 
 * [changed] Major changes to the ImageScience module, it actually works now!
 * [fixed] Bug in configuration where it complais that it can't dup Symbol

data/Manifest.txt

@@ -36,14 +36,17 @@ lib/carrierwave/core_ext/module_setup.rb
 lib/carrierwave/mount.rb
 lib/carrierwave/orm/activerecord.rb
 lib/carrierwave/orm/datamapper.rb
+lib/carrierwave/orm/mongoid.rb
 lib/carrierwave/orm/mongomapper.rb
 lib/carrierwave/orm/sequel.rb
 lib/carrierwave/processing/image_science.rb
+lib/carrierwave/processing/mini_magick.rb
 lib/carrierwave/processing/rmagick.rb
 lib/carrierwave/sanitized_file.rb
 lib/carrierwave/storage/abstract.rb
 lib/carrierwave/storage/file.rb
 lib/carrierwave/storage/grid_fs.rb
+lib/carrierwave/storage/right_s3.rb
 lib/carrierwave/storage/s3.rb
 lib/carrierwave/test/matchers.rb
 lib/carrierwave/uploader.rb
@@ -68,16 +71,23 @@ script/destroy
 script/generate
 spec/compatibility/paperclip_spec.rb
 spec/fixtures/bork.txt
+spec/fixtures/landscape.jpg
+spec/fixtures/portrait.jpg
 spec/fixtures/test.jpeg
 spec/fixtures/test.jpg
 spec/mount_spec.rb
 spec/orm/activerecord_spec.rb
 spec/orm/datamapper_spec.rb
+spec/orm/mongoid_spec.rb
 spec/orm/mongomapper_spec.rb
 spec/orm/sequel_spec.rb
+spec/processing/image_science_spec.rb
+spec/processing/mini_magick_spec.rb
+spec/processing/rmagick_spec.rb
 spec/sanitized_file_spec.rb
 spec/spec_helper.rb
 spec/storage/grid_fs_spec.rb
+spec/storage/right_s3_spec.rb
 spec/storage/s3_spec.rb
 spec/uploader/cache_spec.rb
 spec/uploader/configuration_spec.rb

data/README.rdoc

@@ -199,7 +199,8 @@ this easily by overriding the +default_url+ method in your uploader:
 
 == Configuring CarrierWave
 
-CarrierWave has a broad range of configuration options, which you can configure, both globally and on a per-uploader basis:
+CarrierWave has a broad range of configuration options, which you can configure,
+both globally and on a per-uploader basis:
 
     CarrierWave.configure do |config|
       config.permissions = 0666
@@ -212,6 +213,54 @@ Or alternatively:
       permissions 0777
     end
 
+== Testing CarrierWave
+
+It's a good idea to test you uploaders in isolation. In order to speed up your
+tests, it's recommended to switch off processing in your tests, and to use the
+file storage. In Rails you could do that by adding an initializer with:
+
+    if Rails.env.test?
+      Carrierwave.configure do |config|
+        config.storage = :file
+        config.enable_processing = false
+      end
+    end
+
+If you need to test your processing, you should test it in isolation, and enable
+processing only for those tests that need it.
+
+CarrierWave comes with some RSpec matchers which you may find useful:
+
+    require 'carrierwave/test/matchers'
+
+    describe MyUploader do
+      before do
+        MyUploader.enable_processing = true
+        @uploader = MyUploader.new(@user, :avatar)
+        @uploader.store!(File.open(path_to_file))
+      end
+
+      after do
+        MyUploader.enable_processing = false
+      end
+
+      context 'the thumb version' do
+        it "should scale down a landscape image to be exactly 64 by 64 pixels" do
+          @uploader.thumb.should have_dimensions(200, 200)
+        end
+      end
+
+      context 'the small version' do
+        it "should scale down a landscape image to fit within 200 by 200 pixels" do
+          @uploader.small.should be_no_larger_than(200, 200)
+        end
+      end
+
+      it "should make the image readable only to the owner and not executable" do
+        @uploader.should have_premissions(0600)
+      end
+    end
+
 == Using Amazon S3
 
 You'll need to configure a bucket, access id and secret key like this:
@@ -231,7 +280,18 @@ And then in your uploader, set the storage to :s3
     end
 
 That's it! You can still use the +CarrierWave::Uploader#url+ method to return
-the url to the file on Amazon S3
+the url to the file on Amazon S3.
+
+Alternatively, and especially if your bucket is located in Europe, you can use the 
+RightAWS library by setting the storage to :right_s3
+
+    class AvatarUploader < CarrierWave::Uploader::Base
+      storage :right_s3
+    end
+
+CarrierWave uses the RightAWS S3 Interface directly, meaning that the performance issues
+mentioned by Jonathan Yurek for paperclip do not apply: http://groups.google.com/group/paperclip-plugin/browse_thread/thread/d4dc166a9a5f0df4#
+
 
 == Using MongoDB's GridFS store
 
@@ -362,6 +422,8 @@ These people have contributed their time and effort to CarrierWave:
 * Scott Motte
 * Sho Fukamachi
 * Sam Lown
+* Dave Ott
+* Quin Hoxie
 
 == License
 

data/Rakefile

@@ -24,7 +24,9 @@ $hoe = Hoe.spec 'carrierwave' do
   self.extra_dev_deps << ['do_sqlite3', '>=0.9.11']
   self.extra_dev_deps << ['sequel', '>=3.2.0']
   self.extra_dev_deps << ['rmagick', '>=2.10.0']
-  self.extra_dev_deps << ['mongo_mapper', '>=0.5.4']
+  self.extra_dev_deps << ['mini_magick', '>=1.2.5']
+  self.extra_dev_deps << ['mongo_mapper', '>=0.5.8']
+  self.extra_dev_deps << ['mongoid', '>=0.5.11']
   self.extra_dev_deps << ['aws-s3', '>=0.6.2']
   self.extra_rdoc_files << 'README.rdoc'
 end

data/lib/carrierwave.rb

@@ -7,7 +7,7 @@ require 'carrierwave/core_ext/inheritable_attributes'
 
 module CarrierWave
 
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 
   class << self
     attr_accessor :root
@@ -33,6 +33,7 @@ module CarrierWave
     autoload :File, 'carrierwave/storage/file'
     autoload :S3, 'carrierwave/storage/s3'
     autoload :GridFS, 'carrierwave/storage/grid_fs'
+    autoload :RightS3, 'carrierwave/storage/right_s3'
   end
 
   module Uploader
@@ -86,3 +87,4 @@ require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'activerecord')
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'datamapper') if defined?(DataMapper)
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'sequel') if defined?(Sequel)
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongomapper") if defined?(MongoMapper)
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongoid") if defined?(Mongoid)

data/lib/carrierwave/orm/datamapper.rb

@@ -15,9 +15,9 @@ module CarrierWave
 
       alias_method :read_uploader, :attribute_get
       alias_method :write_uploader, :attribute_set
-
       after :save, "store_#{column}!".to_sym
-      before :save, "write_#{column}_identifier".to_sym
+      pre_hook = ::DataMapper.const_defined?(:Validate) ? :valid? : :save
+      before pre_hook, "write_#{column}_identifier".to_sym
       after :destroy, "remove_#{column}!".to_sym
     end
 

data/lib/carrierwave/orm/mongoid.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'mongoid'
+
+module CarrierWave
+  module Mongoid
+    include CarrierWave::Mount
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      options[:mount_on] ||= "#{column}_filename"
+      field options[:mount_on]
+      super
+      alias_method :read_uploader, :read_attribute
+      alias_method :write_uploader, :write_attribute
+      after_save "store_#{column}!".to_sym
+      before_save "write_#{column}_identifier".to_sym
+      after_destroy "remove_#{column}!".to_sym
+    end
+  end # Mongoid
+end # CarrierWave
+
+Mongoid::Document.send(:extend, CarrierWave::Mongoid)

data/lib/carrierwave/processing/mini_magick.rb

@@ -0,0 +1,269 @@
+# encoding: utf-8
+
+require 'mini_magick'
+
+module CarrierWave
+
+  ##
+  # This module simplifies manipulation with MiniMagick by providing a set
+  # of convenient helper methods. If you want to use them, you'll need to
+  # require this file:
+  #
+  #     require 'carrierwave/processing/mini_magick'
+  #
+  # And then include it in your uploader:
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::MiniMagick
+  #     end
+  #
+  # You can now use the provided helpers:
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::MiniMagick
+  #
+  #       process :resize_to_fit => [200, 200]
+  #     end
+  #
+  # Or create your own helpers with the powerful manipulate! method. Check
+  # out the ImageMagick docs at http://www.imagemagick.org/script/command-line-options.php for more
+  # info
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::MiniMagick
+  #
+  #       process :do_stuff => 10.0
+  #
+  #       def do_stuff(blur_factor)
+  #         manipulate! do |img|
+  #           img = img.sepiatone
+  #           img = img.auto_orient
+  #           img = img.radial_blur blur_factor
+  #         end
+  #       end
+  #     end
+  #
+  # === Note
+  #
+  # MiniMagick is a mini replacement for RMagick that uses the command line
+  # tool "mogrify" for image manipulation.
+  #
+  # You can find more information here:
+  #
+  # http://mini_magick.rubyforge.org/
+  # and
+  # http://github.com/probablycorey/mini_magick/
+  #
+  #
+  module MiniMagick
+
+    def self.included(base)
+      super
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def convert(format)
+        process :resize_to_limit => format
+      end
+
+      def resize_to_limit(width, height)
+        process :resize_to_limit => [width, height]
+      end
+
+      def resize_to_fit(width, height)
+        process :resize_to_fit => [width, height]
+      end
+
+      def resize_to_fill(width, height)
+        process :resize_to_fill => [width, height]
+      end
+
+      def resize_and_pad(width, height)
+        process :resize_to_fit => [width, height]
+      end
+
+      def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
+        process :resize_and_pad => [width, height, background, gravity]
+      end
+    end
+
+    ##
+    # Changes the image encoding format to the given format
+    #
+    # See http://www.imagemagick.org/script/command-line-options.php#format
+    #
+    # === Parameters
+    #
+    # [format (#to_s)] an abreviation of the format
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] additional manipulations to perform
+    #
+    # === Examples
+    #
+    #     image.convert(:png)
+    #
+    def convert(format)
+      manipulate! do |img|
+        img.format(format.to_s.upcase)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. Will only resize the image if it is larger than the
+    # specified dimensions. The resulting image may be shorter or narrower than specified
+    # in the smaller dimension but will not be larger than the specified values.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] additional manipulations to perform
+    #
+    def resize_to_limit(width, height)
+      manipulate! do |img|
+        img.resize "#{width}x#{height}>"
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # From the RMagick documentation: "Resize the image to fit within the
+    # specified dimensions while retaining the original aspect ratio. The
+    # image may be shorter or narrower than specified in the smaller dimension
+    # but will not be larger than the specified values."
+    #
+    # See even http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fit
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] additional manipulations to perform
+    #
+    def resize_to_fit(width, height)
+      manipulate! do |img|
+        img.resize "#{width}x#{height}"
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # From the RMagick documentation: "Resize the image to fit within the
+    # specified dimensions while retaining the aspect ratio of the original
+    # image. If necessary, crop the image in the larger dimension."
+    #
+    # See even http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fill
+    #
+    # and
+    #
+    # http://www.clipclip.org/clips/detail/4365/jerrett-net-»-crop_resized-in-rmagick
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] additional manipulations to perform
+    #
+    def resize_to_fill(width, height, gravity = 'Center')
+      manipulate! do |img|
+        cols, rows = img[:dimensions]
+        img.combine_options do |cmd|
+          if width != cols || height != rows
+            scale = [width/cols.to_f, height/rows.to_f].max
+            cols = (scale * (cols + 0.5)).round
+            rows = (scale * (rows + 0.5)).round
+            cmd.resize "#{cols}x#{rows}"
+          end
+          cmd.gravity gravity
+          cmd.extent "#{width}x#{height}" if cols != width || rows != height
+        end
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. If necessary, will pad the remaining area
+    # with the given color, which defaults to transparent (for gif and png,
+    # white for jpeg).
+    #
+    # See http://www.imagemagick.org/script/command-line-options.php#gravity
+    # for gravity options.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [background (String, :transparent)] the color of the background as a hexcode, like "#ff45de"
+    # [gravity (String)] how to position the image
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] additional manipulations to perform
+    #
+    def resize_and_pad(width, height, background=:transparent, gravity='Center')
+      manipulate! do |img|
+        img.combine_options do |cmd|
+          cmd.thumbnail "#{width}x#{height}>"
+          if background == :transparent
+            cmd.background "rgba(0, 0, 0, 0.0)"
+          else
+            cmd.background background
+          end
+          cmd.gravity gravity
+          cmd.extent "#{width}x#{height}"
+        end
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # Manipulate the image with RMagick. This method will load up an image
+    # and then pass each of its frames to the supplied block. It will then
+    # save the image to disk.
+    #
+    # === Gotcha
+    #
+    # This method assumes that the object responds to +current_path+.
+    # Any class that this module is mixed into must have a +current_path+ method.
+    # CarrierWave::Uploader does, so you won't need to worry about this in
+    # most cases.
+    #
+    # === Yields
+    #
+    # [MiniMagick::Image] manipulations to perform
+    #
+    # === Raises
+    #
+    # [CarrierWave::ProcessingError] if manipulation failed.
+    #
+    def manipulate!
+      image = ::MiniMagick::Image.from_file(current_path)
+      image = yield(image)
+      image.write(current_path)
+      ::MiniMagick::Image.from_file(current_path)
+    rescue ::MiniMagick::MiniMagickError => e
+      raise CarrierWave::ProcessingError.new("Failed to manipulate with MiniMagick, maybe it is not an image? Original Error: #{e}")
+    end
+
+  end # MiniMagick
+end # CarrierWave