carrierwave 0.1 → 0.2.0

data/lib/carrierwave/orm/activerecord.rb

@@ -4,17 +4,68 @@ module CarrierWave
   module ActiveRecord
 
     include CarrierWave::Mount
+    
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      super
 
-    def after_mount(column, uploader)
       alias_method :read_uploader, :read_attribute
       alias_method :write_uploader, :write_attribute
 
+      validates_integrity_of column if uploader_options[column.to_sym][:validate_integrity]
+      validates_processing_of column if uploader_options[column.to_sym][:validate_processing]
+
       before_save do |record|
         record.send("store_#{column}!")
       end
     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)
+ActiveRecord::Base.send(:extend, CarrierWave::ActiveRecord)

data/lib/carrierwave/orm/datamapper.rb

@@ -5,7 +5,12 @@ module CarrierWave
 
     include CarrierWave::Mount
 
-    def after_mount(column, uploader)
+    ##
+    # 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
 
@@ -17,4 +22,4 @@ module CarrierWave
   end # DataMapper
 end # CarrierWave
 
-DataMapper::Model.send(:include, CarrierWave::DataMapper)
+DataMapper::Model.send(:include, CarrierWave::DataMapper)

data/lib/carrierwave/orm/sequel.rb

@@ -0,0 +1,23 @@
+require 'sequel'
+
+module CarrierWave
+  module Sequel
+
+    include CarrierWave::Mount
+
+    def mount_uploader(column, uploader)
+      super
+
+      alias_method :read_uploader, :[]
+      alias_method :write_uploader, :[]=
+
+      before_save do
+        send("store_#{column}!")
+      end
+    end
+
+  end # Sequel
+end # CarrierWave
+
+Sequel::Model.send(:extend, CarrierWave::Sequel)
+

data/lib/carrierwave/processing/image_science.rb

@@ -2,7 +2,7 @@ require "image_science"
 
 module CarrierWave
   module ImageScience
-    
+
     # Resize the image so that it will not exceed the dimensions passed
     # via geometry, geometry should be a string, formatted like '200x100' where
     # the first number is the height and the second is the width
@@ -63,8 +63,8 @@ module CarrierWave
     end
 
     def convert_geometry(geometry)
-      geometry.split('x').map{|i| i.to_f }      
+      geometry.split('x').map{|i| i.to_f }
     end
 
   end # ImageScience
-end # CarrierWave
+end # CarrierWave

data/lib/carrierwave/processing/rmagick.rb

@@ -1,37 +1,40 @@
 require 'rmagick'
 
 module CarrierWave
-  
+
   ##
   # This module simplifies manipulation with RMagick by providing a set
   # of convenient helper methods. If you want to use them, you'll need to
-  # require this file
+  # require this file:
   #
   #     require 'carrierwave/processing/rmagick'
   #
-  # And then include it in your uploader
+  # And then include it in your uploader:
   #
-  #     MyUploade < CarrierWave::Uploader
+  #     class MyUploader
+  #       include CarrierWave::Uploader
   #       include CarrierWave::RMagick
   #     end
   #
   # You can now use the provided helpers:
   #
-  #     MyUploade < CarrierWave::Uploader
+  #     class MyUploader
+  #       include CarrierWave::Uploader
   #       include CarrierWave::RMagick
-  #       
-  #       process :resize_to_fit => [200, 200] 
+  #
+  #       process :resize_to_fit => [200, 200]
   #     end
   #
   # Or create your own helpers with the powerful manipulate! method. Check
   # out the RMagick docs at http://www.imagemagick.org/RMagick/doc/ for more
   # info
   #
-  #     MyUploade < CarrierWave::Uploader
+  #     class MyUploader
+  #       include CarrierWave::Uploader
   #       include CarrierWave::RMagick
-  #       
+  #
   #       process :do_stuff => 10.0
-  #       
+  #
   #       def do_stuff(blur_factor)
   #         manipulate! do |img|
   #           img = img.sepiatone
@@ -41,17 +44,41 @@ module CarrierWave
   #       end
   #     end
   #
+  # === Note
+  #
+  # You should be aware how RMagick handles memory. manipulate! takes care
+  # of freeing up memory for you, but for optimum memory usage you should
+  # use destructive operations as much as possible:
+  #
+  # DON'T DO THIS:
+  #     img = img.resize_to_fit
+  #
+  # DO THIS INSTEAD:
+  #     img.resize_to_fit!
+  #
+  # Read this for more information why:
+  #
+  # http://rubyforge.org/forum/forum.php?thread_id=1374&forum_id=1618
+  #
   module RMagick
-    
+
     ##
     # Changes the image encoding format to the given format
     #
-    # @see http://www.imagemagick.org/RMagick/doc/magick.html#formats
-    # @param [#to_s] format an abreviation of the format
-    # @yieldparam [Magick::Image] img additional manipulations to perform
-    # @example
+    # See even http://www.imagemagick.org/RMagick/doc/magick.html#formats
+    #
+    # === Parameters
+    #
+    # [format (#to_s)] an abreviation of the format
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    # === Examples
+    #
     #     image.convert(:png)
-    # 
+    #
     def convert(format)
       manipulate! do |img|
         img.format = format.to_s.upcase
@@ -66,12 +93,17 @@ module CarrierWave
     # image may be shorter or narrower than specified in the smaller dimension
     # but will not be larger than the specified values."
     #
-    # @see http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fit
+    # 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
+    #
+    # [Magick::Image] additional manipulations to perform
     #
-    # @param [Integer] width the width to scale the image to
-    # @param [Integer] height the height to scale the image to
-    # @yieldparam [Magick::Image] img additional manipulations to perform
-    # 
     def resize_to_fit(width, height)
       manipulate! do |img|
         img.resize_to_fit!(width, height)
@@ -79,7 +111,7 @@ module CarrierWave
         img
       end
     end
-    
+
     alias_method :resize, :resize_to_fit
 
     ##
@@ -87,11 +119,16 @@ module CarrierWave
     # specified dimensions while retaining the aspect ratio of the original
     # image. If necessary, crop the image in the larger dimension."
     #
-    # @see http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fill
+    # See even http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fill
+    #
+    # === Parameters
     #
-    # @param [Integer] width the width to scale the image to
-    # @param [Integer] height the height to scale the image to
-    # @yieldparam [Magick::Image] img additional manipulations to perform
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
     #
     def resize_to_fill(width, height)
       manipulate! do |img|
@@ -100,33 +137,40 @@ module CarrierWave
         img
       end
     end
-    
+
     alias_method :crop_resized, :resize_to_fill
-    
+
     ##
     # Resize the image to fit within the specified dimensions while retaining
-    # the original aspect ratio. If necessary will pad the remaining area
+    # 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).
     #
-    # @param [Integer] width the width to scale the image to
-    # @param [Integer] height the height to scale the image to
-    # @param [String, :transparent] background the color of the background as a hexcode, like "#ff45de"
-    # @param [Magick::GravityType] gravity how to position the image
-    # @yieldparam [Magick::Image] img additional manipulations to perform
+    # === 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 (Magick::GravityType)] how to position the image
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
     #
     def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
       manipulate! do |img|
         img.resize_to_fit!(width, height)
         new_img = ::Magick::Image.new(width, height)
         if background == :transparent
-          new_img = new_img.matte_floodfill(1, 1)
+          filled = new_img.matte_floodfill(1, 1)
         else
-          new_img = new_img.color_floodfill(1, 1, ::Magick::Pixel.from_color(background))
+          filled = new_img.color_floodfill(1, 1, ::Magick::Pixel.from_color(background))
         end
-        new_img = new_img.composite(img, gravity, ::Magick::OverCompositeOp)
-        new_img = yield(new_img) if block_given?
-        new_img
+        new_img.destroy!
+        filled.composite!(img, gravity, ::Magick::OverCompositeOp)
+        img.destroy!
+        filled = yield(filled) if block_given?
+        filled
       end
     end
 
@@ -135,11 +179,20 @@ module CarrierWave
     # and then pass each of its frames to the supplied block. It will then
     # save the image to disk.
     #
-    # Note: This method assumes that the object responds to current_path
-    # any class that this is mixed into must have a current_path method.
+    # === 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
     #
-    # @yieldparam [Magick::Image] img manipulations to perform
-    # @raise [CarrierWave::ProcessingError] if manipulation failed.
+    # [Magick::Image] manipulations to perform
+    #
+    # === Raises
+    #
+    # [CarrierWave::ProcessingError] if manipulation failed.
     #
     def manipulate!
       image = ::Magick::Image.read(current_path)
@@ -150,12 +203,15 @@ module CarrierWave
           list << yield( frame )
         end
         list.write(current_path)
+        list.destroy!
       else
-        yield( image.first ).write(current_path)
+        frame = image.first
+        yield( frame ).write(current_path)
+        frame.destroy!
       end
     rescue ::Magick::ImageMagickError => e
       raise CarrierWave::ProcessingError.new("Failed to manipulate with rmagick, maybe it is not an image? Original Error: #{e}")
-    end   
-      
+    end
+
   end # RMagick
-end # CarrierWave
+end # CarrierWave

data/lib/carrierwave/sanitized_file.rb

@@ -10,17 +10,18 @@ module CarrierWave
   #
   class SanitizedFile
 
-    attr_accessor :file, :options
+    attr_accessor :file
 
-    def initialize(file, options = {})
+    def initialize(file)
       self.file = file
-      self.options = options
     end
 
     ##
     # Returns the filename as is, without sanizting it.
     #
-    # @return [String] the unsanitized filename
+    # === Returns
+    #
+    # [String] the unsanitized filename
     #
     def original_filename
       return @original_filename if @original_filename
@@ -30,32 +31,38 @@ module CarrierWave
         File.basename(path)
       end
     end
-  
+
     ##
     # Returns the filename, sanitized to strip out any evil characters.
     #
-    # @return [String] the sanitized filename
+    # === Returns
+    #
+    # [String] the sanitized filename
     #
     def filename
       sanitize(original_filename) if original_filename
     end
-  
+
     alias_method :identifier, :filename
-  
+
     ##
     # Returns the part of the filename before the extension. So if a file is called 'test.jpeg'
     # this would return 'test'
     #
-    # @return [String] the first part of the filename
+    # === Returns
+    #
+    # [String] the first part of the filename
     #
     def basename
       split_extension(filename)[0] if filename
     end
-  
+
     ##
     # Returns the file extension
     #
-    # @return [String] the extension
+    # === Returns
+    #
+    # [String] the extension
     #
     def extension
       split_extension(filename)[1] if filename
@@ -64,16 +71,18 @@ module CarrierWave
     ##
     # Returns the file's size.
     #
-    # @return [Integer] the file's size in bytes.
+    # === Returns
+    #
+    # [Integer] the file's size in bytes.
     #
     def size
-      if string?
+      if is_path?
         exists? ? File.size(path) : 0
       elsif @file.respond_to?(:size)
-        @file.size 
+        @file.size
       elsif path
         exists? ? File.size(path) : 0
-      else 
+      else
         0
       end
     end
@@ -81,53 +90,59 @@ module CarrierWave
     ##
     # Returns the full path to the file. If the file has no path, it will return nil.
     #
-    # @return [String, nil] the path where the file is located.
+    # === Returns
+    #
+    # [String, nil] the path where the file is located.
     #
     def path
       unless @file.blank?
-        if string?
+        if is_path?
           File.expand_path(@file)
         elsif @file.respond_to?(:path) and not @file.path.blank?
           File.expand_path(@file.path)
         end
       end
     end
-  
+
     ##
-    # Returns true if the file is supplied as a pathname or as a string.
+    # === Returns
     #
-    # @return [Boolean]
+    # [Boolean] whether the file is supplied as a pathname or string.
     #
-    def string?
+    def is_path?
       !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?)
     end
 
     ##
-    # Checks if the file is valid and has a non-zero size
+    # === Returns
     #
-    # @return [Boolean]
+    # [Boolean] whether the file is valid and has a non-zero size
     #
     def empty?
       @file.nil? || self.size.nil? || self.size.zero?
     end
 
+    alias_method :blank?, :empty?
+
     ##
-    # Checks if the file exists
+    # === Returns
     #
-    # @return [Boolean]
+    # [Boolean] Whether the file exists
     #
     def exists?
       return File.exists?(self.path) if self.path
       return false
     end
-  
+
     ##
     # Returns the contents of the file.
     #
-    # @return [String] contents of the file
+    # === Returns
+    #
+    # [String] contents of the file
     #
     def read
-      if string?
+      if is_path?
         File.read(@file)
       else
         @file.rewind if @file.respond_to?(:rewind)
@@ -138,9 +153,12 @@ module CarrierWave
     ##
     # Moves the file to the given path
     #
-    # @param [String] new_path The path where the file should be moved.
+    # === Parameters
     #
-    def move_to(new_path)
+    # [new_path (String)] The path where the file should be moved.
+    # [permissions (Integer)] permissions to set on the file in its new location.
+    #
+    def move_to(new_path, permissions=nil)
       return if self.empty?
       new_path = File.expand_path(new_path)
 
@@ -150,17 +168,23 @@ module CarrierWave
       else
         File.open(new_path, "wb") { |f| f.write(read) }
       end
-      chmod!(new_path)
+      chmod!(new_path, permissions)
       self.file = new_path
     end
 
     ##
     # Creates a copy of this file and moves it to the given path. Returns the copy.
     #
-    # @param [String] new_path The path where the file should be copied to.
+    # === Parameters
+    #
+    # [new_path (String)] The path where the file should be copied to.
+    # [permissions (Integer)] permissions to set on the copy
+    #
+    # === Returns
+    #
     # @return [CarrierWave::SanitizedFile] the location where the file will be stored.
     #
-    def copy_to(new_path)
+    def copy_to(new_path, permissions=nil)
       return if self.empty?
       new_path = File.expand_path(new_path)
 
@@ -170,7 +194,7 @@ module CarrierWave
       else
         File.open(new_path, "wb") { |f| f.write(read) }
       end
-      chmod!(new_path)
+      chmod!(new_path, permissions)
       self.class.new(new_path)
     end
 
@@ -184,7 +208,9 @@ module CarrierWave
     ##
     # Returns the content type of the file.
     #
-    # @return [String] the content type of the file 
+    # === Returns
+    #
+    # [String] the content type of the file
     #
     def content_type
       return @content_type if @content_type
@@ -192,26 +218,26 @@ module CarrierWave
     end
 
   private
-  
+
     def file=(file)
       if file.is_a?(Hash)
-        @file = file["tempfile"]
-        @original_filename = file["filename"]
-        @content_type = file["content_type"]
+        @file = file["tempfile"] || file[:tempfile]
+        @original_filename = file["filename"] || file[:filename]
+        @content_type = file["content_type"] || file[:content_type]
       else
         @file = file
         @original_filename = nil
         @content_type = nil
       end
     end
-  
+
     # create the directory if it doesn't exist
     def mkdir!(path)
       FileUtils.mkdir_p(File.dirname(path)) unless File.exists?(File.dirname(path))
     end
-  
-    def chmod!(path)
-      File.chmod(@options[:permissions], path) if @options[:permissions]
+
+    def chmod!(path, permissions)
+      File.chmod(permissions, path) if permissions
     end
 
     # Sanitize the filename, to prevent hacking
@@ -219,16 +245,16 @@ module CarrierWave
       name = name.gsub("\\", "/") # work-around for IE
       name = File.basename(name)
       name = name.gsub(/[^a-zA-Z0-9\.\-\+_]/,"_")
-      name = "_#{name}" if name =~ /^\.+$/
+      name = "_#{name}" if name =~ /\A\.+\z/
       name = "unnamed" if name.size == 0
       return name.downcase
     end
 
     def split_extension(fn)
       # regular expressions to try for identifying extensions
-      ext_regexps = [ 
-        /^(.+)\.([^\.]{1,3}\.[^\.]{1,4})$/, # matches "something.tar.gz"
-        /^(.+)\.([^\.]+)$/ # matches "something.jpg"
+      ext_regexps = [
+        /\A(.+)\.([^\.]{1,3}\.[^\.]{1,4})\z/, # matches "something.tar.gz"
+        /\A(.+)\.([^\.]+)\z/ # matches "something.jpg"
       ]
       ext_regexps.each do |regexp|
         if fn =~ regexp
@@ -239,4 +265,4 @@ module CarrierWave
     end
 
   end # SanitizedFile
-end # CarrierWave
+end # CarrierWave