carrierwave-rails3 0.4.5

data/lib/carrierwave/orm/activerecord.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require 'active_record'
+
+module CarrierWave
+  module ActiveRecord
+
+    include CarrierWave::Mount
+    
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      super
+
+      alias_method :read_uploader, :read_attribute
+      alias_method :write_uploader, :write_attribute
+      public :read_uploader
+      public :write_uploader
+
+      validates_integrity_of column if uploader_option(column.to_sym, :validate_integrity)
+      validates_processing_of column if uploader_option(column.to_sym, :validate_processing)
+
+      after_save "store_#{column}!"
+      before_save "write_#{column}_identifier"
+      after_destroy "remove_#{column}!"
+    end
+
+    ##
+    # Makes the record invalid if the file couldn't be uploaded due to an integrity error
+    #
+    # Accepts the usual parameters for validations in Rails (:if, :unless, etc...)
+    #
+    # === Note
+    #
+    # Set this key in your translations file for I18n:
+    #
+    #     carrierwave:
+    #       errors:
+    #         integrity: 'Here be an error message'
+    #
+    def validates_integrity_of(*attrs)
+      options = attrs.last.is_a?(Hash) ? attrs.last : {}
+      options[:message] ||= I18n.t('carrierwave.errors.integrity', :default => 'is not an allowed type of file.')
+      validates_each(*attrs) do |record, attr, value|
+        record.errors.add attr, options[:message] if record.send("#{attr}_integrity_error")
+      end
+    end
+
+    ##
+    # Makes the record invalid if the file couldn't be processed (assuming the process failed
+    # with a CarrierWave::ProcessingError)
+    #
+    # Accepts the usual parameters for validations in Rails (:if, :unless, etc...)
+    #
+    # === Note
+    #
+    # Set this key in your translations file for I18n:
+    #
+    #     carrierwave:
+    #       errors:
+    #         processing: 'Here be an error message'
+    #
+    def validates_processing_of(*attrs)
+      options = attrs.last.is_a?(Hash) ? attrs.last : {}
+      options[:message] ||= I18n.t('carrierwave.errors.processing', :default => 'failed to be processed.')
+      validates_each(*attrs) do |record, attr, value|
+        record.errors.add attr, options[:message] if record.send("#{attr}_processing_error")
+      end
+    end
+
+  end # ActiveRecord
+end # CarrierWave
+
+ActiveRecord::Base.send(:extend, CarrierWave::ActiveRecord)

data/lib/carrierwave/orm/datamapper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'dm-core'
+
+module CarrierWave
+  module DataMapper
+
+    include CarrierWave::Mount
+
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      super
+
+      alias_method :read_uploader, :attribute_get
+      alias_method :write_uploader, :attribute_set
+      after :save, "store_#{column}!".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
+
+  end # DataMapper
+end # CarrierWave
+
+DataMapper::Model.send(:include, CarrierWave::DataMapper)

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::ClassMethods.send(:include, CarrierWave::Mongoid)

data/lib/carrierwave/orm/mongomapper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'mongo_mapper'
+
+module CarrierWave
+  module MongoMapper
+    include CarrierWave::Mount
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      # We need to set the mount_on column (or key in MongoMapper's case)
+      # since MongoMapper will attempt to set the filename on 
+      # the uploader instead of the file on a Document's initialization.
+      options[:mount_on] ||= "#{column}_filename"
+      key options[:mount_on]
+      
+      super
+      alias_method :read_uploader, :[]
+      alias_method :write_uploader, :[]=
+      after_save "store_#{column}!".to_sym
+      before_save "write_#{column}_identifier".to_sym
+      after_destroy "remove_#{column}!".to_sym
+    end
+  end # MongoMapper
+end # CarrierWave
+
+MongoMapper::Document::ClassMethods.send(:include, CarrierWave::MongoMapper)

data/lib/carrierwave/orm/sequel.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'sequel'
+ 
+module CarrierWave
+  module Sequel
+    include CarrierWave::Mount
+ 
+    def mount_uploader(column, uploader)
+      raise "You need to use Sequel 3.0 or higher. Please upgrade." unless ::Sequel::Model.respond_to?(:plugin)
+      super
+ 
+      alias_method :read_uploader, :[]
+      alias_method :write_uploader, :[]=
+ 
+      include CarrierWave::Sequel::Hooks
+      include CarrierWave::Sequel::Validations
+    end
+
+  end # Sequel
+end # CarrierWave
+ 
+# Instance hook methods for the Sequel 3.x
+module CarrierWave::Sequel::Hooks
+  def after_save
+    return false if super == false
+    self.class.uploaders.each_key {|column| self.send("store_#{column}!") }
+  end
+
+  def before_save
+    return false if super == false
+    self.class.uploaders.each_key {|column| self.send("write_#{column}_identifier") }
+  end
+
+  def before_destroy
+    return false if super == false
+    self.class.uploaders.each_key {|column| self.send("remove_#{column}!") }
+  end
+end
+
+# Instance validation methods for the Sequel 3.x
+module CarrierWave::Sequel::Validations
+end
+
+Sequel::Model.send(:extend, CarrierWave::Sequel)

data/lib/carrierwave/processing/image_science.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require "image_science"
+
+module CarrierWave
+  module ImageScience
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      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
+    end
+
+    ##
+    # 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
+    #
+    def resize_to_fit(new_width, new_height)
+      ::ImageScience.with_image(self.current_path) do |img|
+        width, height = extract_dimensions(img.width, img.height, new_width, new_height)
+        img.resize( width, height ) do |file|
+          file.save( self.current_path )
+        end
+      end
+    end
+
+    ##
+    # 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
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    def resize_to_fill(new_width, new_height)
+      ::ImageScience.with_image(self.current_path) do |img|
+        width, height = extract_dimensions_for_crop(img.width, img.height, new_width, new_height)
+        x_offset, y_offset = extract_placement_for_crop(width, height, new_width, new_height)
+
+        img.resize( width, height ) do |i2|
+
+          i2.with_crop( x_offset, y_offset, new_width + x_offset, new_height + y_offset) do |file|
+            file.save( self.current_path )
+          end
+        end
+      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
+    #
+    def resize_to_limit(new_width, new_height)
+      ::ImageScience.with_image(self.current_path) do |img|
+        if img.width > new_width or img.height > new_height
+          resize_to_fit(new_width, new_height)
+        end
+      end
+    end
+
+  private
+
+    def extract_dimensions(width, height, new_width, new_height, type = :resize)
+      aspect_ratio = width.to_f / height.to_f
+      new_aspect_ratio = new_width / new_height
+
+      if (new_aspect_ratio > aspect_ratio) ^ ( type == :crop )  # Image is too wide, the caret is the XOR operator
+        new_width, new_height = [ (new_height * aspect_ratio), new_height]
+      else #Image is too narrow
+        new_width, new_height = [ new_width, (new_width / aspect_ratio)]
+      end
+
+      [new_width, new_height].collect! { |v| v.round }
+    end
+
+    def extract_dimensions_for_crop(width, height, new_width, new_height)
+      extract_dimensions(width, height, new_width, new_height, :crop)
+    end
+
+    def extract_placement_for_crop(width, height, new_width, new_height)
+      x_offset = (width / 2.0) - (new_width / 2.0)
+      y_offset = (height / 2.0) - (new_height / 2.0)
+      [x_offset, y_offset].collect! { |v| v.round }
+    end
+
+  end # ImageScience
+end # CarrierWave

data/lib/carrierwave/processing/mini_magick.rb

@@ -0,0 +1,261 @@
+# 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
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def convert(format)
+        process :convert => 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, 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