carrierwave 0.1

data/lib/carrierwave/orm/activerecord.rb

@@ -0,0 +1,20 @@
+require 'activerecord'
+
+module CarrierWave
+  module ActiveRecord
+
+    include CarrierWave::Mount
+
+    def after_mount(column, uploader)
+      alias_method :read_uploader, :read_attribute
+      alias_method :write_uploader, :write_attribute
+
+      before_save do |record|
+        record.send("store_#{column}!")
+      end
+    end
+
+  end # ActiveRecord
+end # CarrierWave
+
+ActiveRecord::Base.send(:extend, CarrierWave::ActiveRecord)

data/lib/carrierwave/orm/datamapper.rb

@@ -0,0 +1,20 @@
+require 'dm-core'
+
+module CarrierWave
+  module DataMapper
+
+    include CarrierWave::Mount
+
+    def after_mount(column, uploader)
+      alias_method :read_uploader, :attribute_get
+      alias_method :write_uploader, :attribute_set
+
+      before :save do
+        send("store_#{column}!")
+      end
+    end
+
+  end # DataMapper
+end # CarrierWave
+
+DataMapper::Model.send(:include, CarrierWave::DataMapper)

data/lib/carrierwave/processing/image_science.rb

@@ -0,0 +1,70 @@
+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
+    def resize!( geometry )
+      ::ImageScience.with_image(self.current_path) do |img|
+        width, height = extract_dimensions(img.width, img.height, geometry)
+        img.resize( width, height ) do |file|
+          file.save( self.current_path )
+        end
+      end
+    end
+
+    # Resize and crop the image so that it will have the exact 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
+    def crop_resized!( geometry )
+      ::ImageScience.with_image(self.current_path) do |img|
+        new_width, new_height = geometry.split('x').map{|i| i.to_i }
+
+        width, height = extract_dimensions_for_crop(img.width, img.height, geometry)
+        x_offset, y_offset = extract_placement_for_crop(width, height, geometry)
+
+        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
+
+    private
+
+    def extract_dimensions(width, height, new_geometry, type = :resize)
+      new_width, new_height = convert_geometry(new_geometry)
+
+      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_geometry)
+      extract_dimensions(width, height, new_geometry, :crop)
+    end
+
+    def extract_placement_for_crop(width, height, new_geometry)
+      new_width, new_height = convert_geometry(new_geometry)
+      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
+
+    def convert_geometry(geometry)
+      geometry.split('x').map{|i| i.to_f }      
+    end
+
+  end # ImageScience
+end # CarrierWave

data/lib/carrierwave/processing/rmagick.rb

@@ -0,0 +1,161 @@
+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 'carrierwave/processing/rmagick'
+  #
+  # And then include it in your uploader
+  #
+  #     MyUploade < CarrierWave::Uploader
+  #       include CarrierWave::RMagick
+  #     end
+  #
+  # You can now use the provided helpers:
+  #
+  #     MyUploade < CarrierWave::Uploader
+  #       include CarrierWave::RMagick
+  #       
+  #       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
+  #       include CarrierWave::RMagick
+  #       
+  #       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
+  #
+  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
+    #     image.convert(:png)
+    # 
+    def convert(format)
+      manipulate! do |img|
+        img.format = format.to_s.upcase
+        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 http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fit
+    #
+    # @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)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+    
+    alias_method :resize, :resize_to_fit
+
+    ##
+    # 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 http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fill
+    #
+    # @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_fill(width, height)
+      manipulate! do |img|
+        img.resize_to_fill!(width, height)
+        img = yield(img) if block_given?
+        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
+    # 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
+    #
+    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)
+        else
+          new_img = 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
+      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.
+    #
+    # Note: This method assumes that the object responds to current_path
+    # any class that this is mixed into must have a current_path method.
+    #
+    # @yieldparam [Magick::Image] img manipulations to perform
+    # @raise [CarrierWave::ProcessingError] if manipulation failed.
+    #
+    def manipulate!
+      image = ::Magick::Image.read(current_path)
+
+      if image.size > 1
+        list = ::Magick::ImageList.new
+        image.each do |frame|
+          list << yield( frame )
+        end
+        list.write(current_path)
+      else
+        yield( image.first ).write(current_path)
+      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 # RMagick
+end # CarrierWave

data/lib/carrierwave/sanitized_file.rb

@@ -0,0 +1,242 @@
+module CarrierWave
+
+  ##
+  # SanitizedFile is a base class which provides a common API around all
+  # the different quirky Ruby File libraries. It has support for Tempfile,
+  # File, StringIO, Merb-style upload Hashes, as well as paths given as
+  # Strings and Pathnames.
+  #
+  # It's probably needlessly comprehensive and complex. Help is appreciated.
+  #
+  class SanitizedFile
+
+    attr_accessor :file, :options
+
+    def initialize(file, options = {})
+      self.file = file
+      self.options = options
+    end
+
+    ##
+    # Returns the filename as is, without sanizting it.
+    #
+    # @return [String] the unsanitized filename
+    #
+    def original_filename
+      return @original_filename if @original_filename
+      if @file and @file.respond_to?(:original_filename)
+        @file.original_filename
+      elsif path
+        File.basename(path)
+      end
+    end
+  
+    ##
+    # Returns the filename, sanitized to strip out any evil characters.
+    #
+    # @return [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
+    #
+    def basename
+      split_extension(filename)[0] if filename
+    end
+  
+    ##
+    # Returns the file extension
+    #
+    # @return [String] the extension
+    #
+    def extension
+      split_extension(filename)[1] if filename
+    end
+
+    ##
+    # Returns the file's size.
+    #
+    # @return [Integer] the file's size in bytes.
+    #
+    def size
+      if string?
+        exists? ? File.size(path) : 0
+      elsif @file.respond_to?(:size)
+        @file.size 
+      elsif path
+        exists? ? File.size(path) : 0
+      else 
+        0
+      end
+    end
+
+    ##
+    # 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.
+    #
+    def path
+      unless @file.blank?
+        if string?
+          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.
+    #
+    # @return [Boolean]
+    #
+    def string?
+      !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?)
+    end
+
+    ##
+    # Checks if the file is valid and has a non-zero size
+    #
+    # @return [Boolean]
+    #
+    def empty?
+      @file.nil? || self.size.nil? || self.size.zero?
+    end
+
+    ##
+    # Checks if the file exists
+    #
+    # @return [Boolean]
+    #
+    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
+    #
+    def read
+      if string?
+        File.read(@file)
+      else
+        @file.rewind if @file.respond_to?(:rewind)
+        @file.read
+      end
+    end
+
+    ##
+    # Moves the file to the given path
+    #
+    # @param [String] new_path The path where the file should be moved.
+    #
+    def move_to(new_path)
+      return if self.empty?
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path)
+      if exists?
+        FileUtils.mv(path, new_path) unless new_path == path
+      else
+        File.open(new_path, "wb") { |f| f.write(read) }
+      end
+      chmod!(new_path)
+      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.
+    # @return [CarrierWave::SanitizedFile] the location where the file will be stored.
+    #
+    def copy_to(new_path)
+      return if self.empty?
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path)
+      if exists?
+        FileUtils.cp(path, new_path) unless new_path == path
+      else
+        File.open(new_path, "wb") { |f| f.write(read) }
+      end
+      chmod!(new_path)
+      self.class.new(new_path)
+    end
+
+    ##
+    # Removes the file from the filesystem.
+    #
+    def delete
+      FileUtils.rm(self.path) if exists?
+    end
+
+    ##
+    # Returns the content type of the file.
+    #
+    # @return [String] the content type of the file 
+    #
+    def content_type
+      return @content_type if @content_type
+      @file.content_type.chomp if @file.respond_to?(:content_type) and @file.content_type
+    end
+
+  private
+  
+    def file=(file)
+      if file.is_a?(Hash)
+        @file = file["tempfile"]
+        @original_filename = file["filename"]
+        @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]
+    end
+
+    # Sanitize the filename, to prevent hacking
+    def sanitize(name)
+      name = name.gsub("\\", "/") # work-around for IE
+      name = File.basename(name)
+      name = name.gsub(/[^a-zA-Z0-9\.\-\+_]/,"_")
+      name = "_#{name}" if name =~ /^\.+$/
+      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.each do |regexp|
+        if fn =~ regexp
+          return $1, $2
+        end
+      end
+      return fn, "" # In case we weren't able to split the extension
+    end
+
+  end # SanitizedFile
+end # CarrierWave