carrierwave-rails3 0.4.5

data/lib/carrierwave.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+require 'fileutils'
+require 'carrierwave/core_ext/file'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/class/inheritable_attributes'
+require 'active_support/concern'
+
+module CarrierWave
+
+  VERSION = "0.4.5"
+
+  class << self
+    attr_accessor :root
+
+    def configure(&block)
+      CarrierWave::Uploader::Base.configure(&block)
+    end
+
+    def clean_cached_files!
+      CarrierWave::Uploader::Base.clean_cached_files!
+    end
+  end
+
+  class UploadError < StandardError; end
+  class IntegrityError < UploadError; end
+  class InvalidParameter < UploadError; end
+  class ProcessingError < UploadError; end
+  class DownloadError < UploadError; end
+
+  autoload :SanitizedFile, 'carrierwave/sanitized_file'
+  autoload :Mount, 'carrierwave/mount'
+  autoload :RMagick, 'carrierwave/processing/rmagick'
+  autoload :ImageScience, 'carrierwave/processing/image_science'
+  autoload :MiniMagick, 'carrierwave/processing/mini_magick'
+
+  module Storage
+    autoload :Abstract, 'carrierwave/storage/abstract'
+    autoload :File, 'carrierwave/storage/file'
+    autoload :S3, 'carrierwave/storage/s3'
+    autoload :GridFS, 'carrierwave/storage/grid_fs'
+    autoload :RightS3, 'carrierwave/storage/right_s3'
+    autoload :CloudFiles, 'carrierwave/storage/cloud_files'
+  end
+
+  module Uploader
+    autoload :Base, 'carrierwave/uploader'
+    autoload :Cache, 'carrierwave/uploader/cache'
+    autoload :Store, 'carrierwave/uploader/store'
+    autoload :Download, 'carrierwave/uploader/download'
+    autoload :Callbacks, 'carrierwave/uploader/callbacks'
+    autoload :Processing, 'carrierwave/uploader/processing'
+    autoload :Versions, 'carrierwave/uploader/versions'
+    autoload :Remove, 'carrierwave/uploader/remove'
+    autoload :ExtensionWhitelist, 'carrierwave/uploader/extension_whitelist'
+    autoload :DefaultUrl, 'carrierwave/uploader/default_url'
+    autoload :Proxy, 'carrierwave/uploader/proxy'
+    autoload :Url, 'carrierwave/uploader/url'
+    autoload :Mountable, 'carrierwave/uploader/mountable'
+    autoload :Configuration, 'carrierwave/uploader/configuration'
+  end
+
+  module Compatibility
+    autoload :Paperclip, 'carrierwave/compatibility/paperclip'
+  end
+
+  module Test
+    autoload :Matchers, 'carrierwave/test/matchers'
+  end
+
+end
+
+if defined?(Merb)
+
+  CarrierWave.root = Merb.dir_for(:public)
+  Merb::BootLoader.before_app_loads do
+    # Setup path for uploaders and load all of them before classes are loaded
+    Merb.push_path(:uploaders, Merb.root / 'app' / 'uploaders', '*.rb')
+    Dir.glob(File.join(Merb.load_paths[:uploaders])).each {|f| require f }
+  end
+
+elsif defined?(Rails)
+
+  module CarrierWave
+    class Railtie < Rails::Railtie
+      initializer "carrierwave.setup_paths" do
+        CarrierWave.root = Rails.root.join(Rails.public_path).to_s
+      end
+    end
+  end
+
+elsif defined?(Sinatra)
+
+  CarrierWave.root = Sinatra::Application.public
+
+end
+
+
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'activerecord') if defined?(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/compatibility/paperclip.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Compatibility
+
+    ##
+    # Mix this module into an Uploader to make it mimic Paperclip's storage paths
+    # This will make your Uploader use the same default storage path as paperclip
+    # does. If you need to override it, you can override the +paperclip_path+ method
+    # and provide a Paperclip style path:
+    #
+    #     class MyUploader < CarrierWave::Uploader::Base
+    #       include CarrierWave::Compatibility::Paperclip
+    #       
+    #       def paperclip_path
+    #         ":rails_root/public/uploads/:id/:attachment/:style_:basename.:extension"
+    #       end
+    #     end
+    #
+    # ---
+    #
+    # This file contains code taken from Paperclip
+    # 
+    # LICENSE
+    # 
+    # The MIT License
+    # 
+    # Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+    # 
+    # Permission is hereby granted, free of charge, to any person obtaining a copy
+    # of this software and associated documentation files (the "Software"), to deal
+    # in the Software without restriction, including without limitation the rights
+    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    # copies of the Software, and to permit persons to whom the Software is
+    # furnished to do so, subject to the following conditions:
+    # 
+    # The above copyright notice and this permission notice shall be included in
+    # all copies or substantial portions of the Software.
+    # 
+    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    # THE SOFTWARE.
+    #
+    module Paperclip
+
+      def store_path(for_file=filename)
+        path = paperclip_path
+        path ||= File.join(*[store_dir, paperclip_style.to_s, for_file].compact)
+        interpolate_paperclip_path(path, for_file)
+      end
+
+      def store_dir
+        ":rails_root/public/system/:attachment/:id"
+      end
+
+      def paperclip_default_style
+        :original
+      end
+
+      def paperclip_path
+      end
+
+      def paperclip_style
+        version_name || paperclip_default_style
+      end
+
+    private
+
+      def interpolate_paperclip_path(path, filename)
+        mappings.inject(path) do |agg, pair|
+          agg.gsub(":#{pair[0]}") { pair[1].call(self, filename).to_s }
+        end
+      end
+
+      def mappings
+        {
+          :rails_root   => lambda{|u, f| Rails.root },
+          :rails_env    => lambda{|u, f| Rails.env },
+          :class        => lambda{|u, f| u.model.class.name.underscore.pluralize},
+          :id           => lambda{|u, f| u.model.id },
+          :id_partition => lambda{|u, f| ("%09d" % u.model.id).scan(/\d{3}/).join("/")},
+          :attachment   => lambda{|u, f| u.mounted_as.to_s.downcase.pluralize },
+          :style        => lambda{|u, f| u.paperclip_style },
+          :basename     => lambda{|u, f| f.gsub(/#{File.extname(f)}$/, "") },
+          :extension    => lambda{|u, f| File.extname(f).gsub(/^\.+/, "")}
+        }
+      end
+
+    end # Paperclip
+  end # Compatibility
+end # CarrierWave

data/lib/carrierwave/core_ext/file.rb

@@ -0,0 +1,11 @@
+class File
+  def size
+    File.size(path)
+  end
+
+  def empty?
+    size == 0
+  rescue Errno::ENOENT
+    false
+  end
+end

data/lib/carrierwave/mount.rb

@@ -0,0 +1,359 @@
+# encoding: utf-8
+
+module CarrierWave
+
+  ##
+  # If a Class is extended with this module, it gains the mount_uploader
+  # method, which is used for mapping attributes to uploaders and allowing
+  # easy assignment.
+  #
+  # You can use mount_uploader with pretty much any class, however it is
+  # intended to be used with some kind of persistent storage, like an ORM.
+  # If you want to persist the uploaded files in a particular Class, it
+  # needs to implement a `read_uploader` and a `write_uploader` method.
+  #
+  module Mount
+
+    ##
+    # === Returns
+    #
+    # [Hash{Symbol => CarrierWave}] what uploaders are mounted on which columns
+    #
+    def uploaders
+      @uploaders ||= {}
+      @uploaders = superclass.uploaders.merge(@uploaders)
+    rescue NoMethodError
+      @uploaders
+    end
+
+    def uploader_options
+      @uploader_options ||= {}
+      @uploader_options = superclass.uploader_options.merge(@uploader_options)
+    rescue NoMethodError
+      @uploader_options
+    end
+
+    ##
+    # Return a particular option for a particular uploader
+    #
+    # === Parameters
+    #
+    # [column (Symbol)] The column the uploader is mounted at
+    # [option (Symbol)] The option, e.g. validate_integrity
+    #
+    # === Returns
+    #
+    # [Object] The option value
+    #
+    def uploader_option(column, option)
+      if uploader_options[column].has_key?(option)
+        uploader_options[column][option]
+      else
+        uploaders[column].send(option)
+      end
+    end
+
+    ##
+    # Mounts the given uploader on the given column. This means that assigning
+    # and reading from the column will upload and retrieve files. Supposing
+    # that a User class has an uploader mounted on image, you can assign and
+    # retrieve files like this:
+    #
+    #     @user.image # => <Uploader>
+    #     @user.image = some_file_object
+    #
+    #     @user.store_image!
+    #
+    #     @user.image.url # => '/some_url.png'
+    #
+    # It is also possible (but not recommended) to ommit the uploader, which
+    # will create an anonymous uploader class. Passing a block to this method
+    # makes it possible to customize it. This can be convenient for brevity,
+    # but if there is any significatnt logic in the uploader, you should do
+    # the right thing and have it in its own file.
+    #
+    # === Added instance methods
+    #
+    # Supposing a class has used +mount_uploader+ to mount an uploader on a column
+    # named +image+, in that case the following methods will be added to the class:
+    #
+    # [image]                   Returns an instance of the uploader only if anything has been uploaded
+    # [image=]                  Caches the given file
+    #
+    # [image_url]               Returns the url to the uploaded file
+    #
+    # [image_cache]             Returns a string that identifies the cache location of the file 
+    # [image_cache=]            Retrieves the file from the cache based on the given cache name
+    #
+    # [remote_image_url]        Returns previously cached remote url
+    # [remote_image_url=]       Retrieve the file from the remote url
+    #
+    # [remove_image]            An attribute reader that can be used with a checkbox to mark a file for removal
+    # [remove_image=]           An attribute writer that can be used with a checkbox to mark a file for removal
+    # [remove_image?]           Whether the file should be removed when store_image! is called.
+    #
+    # [store_image!]            Stores a file that has been assigned with +image=+
+    # [remove_image!]           Removes the uploaded file from the filesystem.
+    #
+    # [image_integrity_error]   Returns an error object if the last file to be assigned caused an integrity error
+    # [image_processing_error]  Returns an error object if the last file to be assigned caused a processing error
+    #
+    # [write_image_identifier]  Uses the write_uploader method to set the identifier.
+    #
+    # === Parameters
+    #
+    # [column (Symbol)]                   the attribute to mount this uploader on
+    # [uploader (CarrierWave::Uploader)]  the uploader class to mount
+    # [options (Hash{Symbol => Object})]  a set of options
+    # [&block (Proc)]                     customize anonymous uploaders
+    #
+    # === Options
+    # 
+    # [:mount_on => Symbol] if the name of the column to be serialized to differs you can override it using this option
+    # [:ignore_integrity_errors => Boolean] if set to true, integrity errors will result in caching failing silently
+    # [:ignore_processing_errors => Boolean] if set to true, processing errors will result in caching failing silently
+    #
+    # === Examples
+    #
+    # Mounting uploaders on different columns.
+    #
+    #     class Song
+    #       mount_uploader :lyrics, LyricsUploader
+    #       mount_uploader :alternative_lyrics, LyricsUploader
+    #       mount_uploader :file, SongUploader
+    #     end
+    #
+    # This will add an anonymous uploader with only the default settings:
+    #
+    #     class Data
+    #       mount_uploader :csv
+    #     end
+    #
+    # this will add an anonymous uploader overriding the store_dir:
+    #
+    #     class Product
+    #       mount_uploader :blueprint do
+    #         def store_dir
+    #           'blueprints'
+    #         end
+    #       end
+    #     end
+    #
+    def mount_uploader(column, uploader=nil, options={}, &block)
+      unless uploader
+        uploader = Class.new(CarrierWave::Uploader::Base)
+        uploader.class_eval(&block)
+      end
+
+      uploaders[column.to_sym] = uploader
+      uploader_options[column.to_sym] = options
+
+      include CarrierWave::Mount::Extension
+
+      # Make sure to write over accessors directly defined on the class.
+      # Simply super to the included module below.
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def #{column}; super; end
+        def #{column}=(new_file); super; end
+      RUBY
+
+      # Mixing this in as a Module instead of class_evaling directly, so we
+      # can maintain the ability to super to any of these methods from within
+      # the class.
+      mod = Module.new
+      include mod
+      mod.class_eval <<-RUBY, __FILE__, __LINE__+1
+
+        def #{column}
+          _mounter(:#{column}).uploader
+        end
+
+        def #{column}=(new_file)
+          _mounter(:#{column}).cache(new_file)
+        end
+
+        def #{column}?
+          !_mounter(:#{column}).blank?
+        end
+
+        def #{column}_url(*args)
+          _mounter(:#{column}).url(*args)
+        end
+
+        def #{column}_cache
+          _mounter(:#{column}).cache_name
+        end
+
+        def #{column}_cache=(cache_name)
+          _mounter(:#{column}).cache_name = cache_name
+        end
+
+        def remote_#{column}_url
+          _mounter(:#{column}).remote_url
+        end
+
+        def remote_#{column}_url=(url)
+          _mounter(:#{column}).remote_url = url
+        end
+
+        def remove_#{column}
+          _mounter(:#{column}).remove
+        end
+
+        def remove_#{column}!
+          _mounter(:#{column}).remove!
+        end
+
+        def remove_#{column}=(value)
+          _mounter(:#{column}).remove = value
+        end
+
+        def remove_#{column}?
+          _mounter(:#{column}).remove?
+        end
+
+        def store_#{column}!
+          _mounter(:#{column}).store!
+        end
+
+        def #{column}_integrity_error
+          _mounter(:#{column}).integrity_error
+        end
+
+        def #{column}_processing_error
+          _mounter(:#{column}).processing_error
+        end
+
+        def write_#{column}_identifier
+          _mounter(:#{column}).write_identifier
+        end
+
+      RUBY
+
+    end
+
+    module Extension
+
+      ##
+      # overwrite this to read from a serialized attribute
+      #
+      def read_uploader(column); end
+
+      ##
+      # overwrite this to write to a serialized attribute
+      #
+      def write_uploader(column, identifier); end
+
+    private
+
+      def _mounter(column)
+        # We cannot memoize in frozen objects :(
+        return Mounter.new(self, column) if frozen?
+        @_mounters ||= {}
+        @_mounters[column] ||= Mounter.new(self, column)
+      end
+
+    end # Extension
+
+    # this is an internal class, used by CarrierWave::Mount so that
+    # we don't pollute the model with a lot of methods.
+    class Mounter #:nodoc:
+
+      attr_reader :column, :record, :remote_url, :integrity_error, :processing_error
+      attr_accessor :remove
+
+      def initialize(record, column, options={})
+        @record = record
+        @column = column
+        @options = record.class.uploader_options[column]
+      end
+
+      def write_identifier
+        if remove?
+          record.write_uploader(serialization_column, '')
+        elsif not uploader.identifier.blank?
+          record.write_uploader(serialization_column, uploader.identifier)
+        end
+      end
+      
+      def identifier
+        record.read_uploader(serialization_column)
+      end
+
+      def uploader
+        @uploader ||= record.class.uploaders[column].new(record, column)
+
+        if @uploader.blank? and not identifier.blank?
+          @uploader.retrieve_from_store!(identifier)
+        end
+        return @uploader
+      end
+
+      def cache(new_file)
+        uploader.cache!(new_file)
+        @integrity_error = nil
+        @processing_error = nil
+      rescue CarrierWave::IntegrityError => e
+        @integrity_error = e
+        raise e unless option(:ignore_integrity_errors)
+      rescue CarrierWave::ProcessingError => e
+        @processing_error = e
+        raise e unless option(:ignore_processing_errors)
+      end
+
+      def cache_name
+        uploader.cache_name
+      end
+
+      def cache_name=(cache_name)
+        uploader.retrieve_from_cache!(cache_name) unless uploader.cached?
+      rescue CarrierWave::InvalidParameter
+      end
+
+      def remote_url=(url)
+        unless uploader.cached?
+          @remote_url = url
+          uploader.download!(url) 
+        end
+      end
+
+      def store!
+        unless uploader.blank?
+          if remove?
+            uploader.remove!
+          else
+            uploader.store!
+          end
+        end
+      end
+
+      def url(*args)
+        uploader.url(*args)
+      end
+
+      def blank?
+        uploader.blank?
+      end
+
+      def remove?
+        !remove.blank? and remove !~ /\A0|false$\z/
+      end
+
+      def remove!
+        uploader.remove!
+      end
+
+    private
+      
+      def option(name)
+        record.class.uploader_option(column, name)
+      end
+
+      def serialization_column
+        option(:mount_on) || column
+      end
+
+    end # Mounter
+
+  end # Mount
+end # CarrierWave