carrierwave 0.10.0 → 2.1.1

data/lib/carrierwave/uploader/extension_whitelist.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module ExtensionWhitelist
       extend ActiveSupport::Concern
 
       included do
-        before :cache, :check_whitelist!
+        before :cache, :check_extension_whitelist!
       end
 
       ##
@@ -19,31 +17,36 @@ module CarrierWave
       #
       # === Returns
       #
-      # [NilClass, Array[String,Regexp]] a white list of extensions which are allowed to be uploaded
+      # [NilClass, String, Regexp, Array[String, Regexp]] a white list of extensions which are allowed to be uploaded
       #
       # === Examples
       #
-      #     def extension_white_list
+      #     def extension_whitelist
       #       %w(jpg jpeg gif png)
       #     end
       #
       # Basically the same, but using a Regexp:
       #
-      #     def extension_white_list
+      #     def extension_whitelist
       #       [/jpe?g/, 'gif', 'png']
       #     end
       #
-      def extension_white_list; end
+      def extension_whitelist; end
 
     private
 
-      def check_whitelist!(new_file)
+      def check_extension_whitelist!(new_file)
         extension = new_file.extension.to_s
-        if extension_white_list and not extension_white_list.detect { |item| extension =~ /\A#{item}\z/i }
-          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_white_list_error", :extension => new_file.extension.inspect, :allowed_types => extension_white_list.join(", "))
+        if extension_whitelist && !whitelisted_extension?(extension)
+          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_whitelist_error", extension: new_file.extension.inspect, allowed_types: Array(extension_whitelist).join(", "))
         end
       end
 
+      def whitelisted_extension?(extension)
+        downcase_extension = extension.downcase
+        Array(extension_whitelist).any? { |item| downcase_extension =~ /\A#{item}\z/i }
+      end
+
     end # ExtensionWhitelist
   end # Uploader
 end # CarrierWave

data/lib/carrierwave/uploader/file_size.rb

@@ -0,0 +1,43 @@
+require 'active_support'
+
+module CarrierWave
+  module Uploader
+    module FileSize
+      extend ActiveSupport::Concern
+
+      included do
+        before :cache, :check_size!
+      end
+
+      ##
+      # Override this method in your uploader to provide a Range of Size which
+      # are allowed to be uploaded.
+      # === Returns
+      #
+      # [NilClass, Range] a size range which are permitted to be uploaded
+      #
+      # === Examples
+      #
+      #     def size_range
+      #       3256...5748
+      #     end
+      #
+      def size_range; end
+
+      private
+
+      def check_size!(new_file)
+        size = new_file.size
+        expected_size_range = size_range
+        if expected_size_range.is_a?(::Range)
+          if size < expected_size_range.min
+            raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.min_size_error", :min_size => ActiveSupport::NumberHelper.number_to_human_size(expected_size_range.min))
+          elsif size > expected_size_range.max
+            raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.max_size_error", :max_size => ActiveSupport::NumberHelper.number_to_human_size(expected_size_range.max))
+          end
+        end
+      end
+
+    end # FileSize
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/mountable.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Mountable
@@ -7,13 +5,14 @@ module CarrierWave
       attr_reader :model, :mounted_as
 
       ##
-      # If a model is given as the first parameter, it will be stored in the uploader, and
-      # available throught +#model+. Likewise, mounted_as stores the name of the column
-      # where this instance of the uploader is mounted. These values can then be used inside
-      # your uploader.
+      # If a model is given as the first parameter, it will be stored in the
+      # uploader, and available through +#model+. Likewise, mounted_as stores
+      # the name of the column where this instance of the uploader is mounted.
+      # These values can then be used inside your uploader.
       #
-      # If you do not wish to mount your uploaders with the ORM extensions in -more then you
-      # can override this method inside your uploader. Just be sure to call +super+
+      # If you do not wish to mount your uploaders with the ORM extensions in
+      # -more then you can override this method inside your uploader. Just be
+      # sure to call +super+
       #
       # === Parameters
       #
@@ -34,6 +33,12 @@ module CarrierWave
         @mounted_as = mounted_as
       end
 
+      ##
+      # Returns array index of given uploader within currently mounted uploaders
+      #
+      def index
+        model.__send__(:_mounter, mounted_as).uploaders.index(self)
+      end
     end # Mountable
   end # Uploader
 end # CarrierWave

data/lib/carrierwave/uploader/processing.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Processing
@@ -11,7 +9,7 @@ module CarrierWave
         class_attribute :processors, :instance_writer => false
         self.processors = []
 
-        after :cache, :process!
+        before :cache, :process!
       end
 
       module ClassMethods
@@ -73,15 +71,17 @@ module CarrierWave
       def process!(new_file=nil)
         return unless enable_processing
 
-        self.class.processors.each do |method, args, condition|
-          if(condition)
-            if condition.respond_to?(:call)
-              next unless condition.call(self, :args => args, :method => method, :file => new_file)
-            else
-              next unless self.send(condition, new_file)
+        with_callbacks(:process, new_file) do
+          self.class.processors.each do |method, args, condition|
+            if(condition)
+              if condition.respond_to?(:call)
+                next unless condition.call(self, :args => args, :method => method, :file => new_file)
+              else
+                next unless self.send(condition, new_file)
+              end
             end
+            self.send(method, *args)
           end
-          self.send(method, *args)
         end
       end
 

data/lib/carrierwave/uploader/proxy.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Proxy
@@ -19,20 +17,20 @@ module CarrierWave
       # [String] the path where the file is currently located.
       #
       def current_path
-        file.path if file.respond_to?(:path)
+        file.try(:path)
       end
 
       alias_method :path, :current_path
 
       ##
-      # Returns a string that uniquely identifies the last stored file
+      # Returns a string that uniquely identifies the retrieved or last stored file
       #
       # === Returns
       #
       # [String] uniquely identifies a file
       #
       def identifier
-        storage.identifier if storage.respond_to?(:identifier)
+        @identifier || storage.try(:identifier)
       end
 
       ##
@@ -43,7 +41,7 @@ module CarrierWave
       # [String] contents of the file
       #
       def read
-        file.read if file.respond_to?(:read)
+        file.try(:read)
       end
 
       ##
@@ -54,7 +52,7 @@ module CarrierWave
       # [Integer] size of the file
       #
       def size
-        file.respond_to?(:size) ? file.size : 0
+        file.try(:size) || 0
       end
 
       ##
@@ -80,7 +78,7 @@ module CarrierWave
       # [String] content type of the file
       #
       def content_type
-        file.respond_to?(:content_type) ? file.content_type : nil
+        file.try(:content_type)
       end
 
     end # Proxy

data/lib/carrierwave/uploader/remove.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Remove

data/lib/carrierwave/uploader/serialization.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "json"
 require "active_support/core_ext/hash"
 
@@ -9,11 +7,11 @@ module CarrierWave
       extend ActiveSupport::Concern
 
       def serializable_hash(options = nil)
-        {"url" => url}.merge Hash[versions.map { |name, version| [name, { "url" => version.url }] }]
+        {"url" => url}.merge Hash[versions.map { |name, version| [name.to_s, { "url" => version.url }] }]
       end
 
       def as_json(options=nil)
-        Hash[mounted_as || "uploader", serializable_hash]
+        serializable_hash
       end
 
       def to_json(options=nil)

data/lib/carrierwave/uploader/store.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Store
@@ -9,6 +7,15 @@ module CarrierWave
       include CarrierWave::Uploader::Configuration
       include CarrierWave::Uploader::Cache
 
+      included do
+        prepend Module.new {
+          def initialize(*)
+            super
+            @file, @filename, @cache_id, @identifier = nil
+          end
+        }
+      end
+
       ##
       # Override this in your Uploader to change the filename.
       #
@@ -54,31 +61,16 @@ module CarrierWave
       #
       def store!(new_file=nil)
         cache!(new_file) if new_file && ((@cache_id != parent_cache_id) || @cache_id.nil?)
-        if @file and @cache_id
+        if !cache_only && @file && @cache_id
           with_callbacks(:store, new_file) do
             new_file = storage.store!(@file)
-            @file.delete if (delete_tmp_file_after_storage && ! move_to_store)
-            delete_cache_id
+            if delete_tmp_file_after_storage
+              @file.delete unless move_to_store
+              cache_storage.delete_dir!(cache_path(nil))
+            end
             @file = new_file
-            @cache_id = nil
-          end
-        end
-      end
-
-      ##
-      # Deletes a cache id (tmp dir in cache)
-      #
-      def delete_cache_id
-        if @cache_id
-          path = File.expand_path(File.join(cache_dir, @cache_id), CarrierWave.root)
-          begin
-            Dir.rmdir(path)
-          rescue Errno::ENOENT
-            # Ignore: path does not exist
-          rescue Errno::ENOTDIR
-            # Ignore: path is not a dir
-          rescue Errno::ENOTEMPTY, Errno::EEXIST
-            # Ignore: dir is not empty
+            @cache_id = @identifier = nil
+            @staged = false
           end
         end
       end
@@ -93,6 +85,7 @@ module CarrierWave
       def retrieve_from_store!(identifier)
         with_callbacks(:retrieve_from_store, identifier) do
           @file = storage.retrieve!(identifier)
+          @identifier = identifier
         end
       end
 

data/lib/carrierwave/uploader/url.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Url
@@ -17,10 +15,10 @@ module CarrierWave
       # [String] the location where this file is accessible via a url
       #
       def url(options = {})
-        if file.respond_to?(:url) and not file.url.blank?
-          file.method(:url).arity == 0 ? file.url : file.url(options)
+        if file.respond_to?(:url) && !(tmp_url = file.url).blank?
+          file.method(:url).arity.zero? ? tmp_url : file.url(options)
         elsif file.respond_to?(:path)
-          path = encode_path(file.path.gsub(File.expand_path(root), ''))
+          path = encode_path(file.path.sub(File.expand_path(root), ''))
 
           if host = asset_host
             if host.respond_to? :call

data/lib/carrierwave/uploader/versions.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Versions
@@ -8,12 +6,12 @@ module CarrierWave
       include CarrierWave::Uploader::Callbacks
 
       included do
-        class_attribute :versions, :version_names, :instance_reader => false, :instance_writer => false
+        class_attribute :versions, :version_names, :version_options, :instance_reader => false, :instance_writer => false
 
         self.versions = {}
         self.version_names = []
 
-        attr_accessor :parent_cache_id
+        attr_accessor :parent_cache_id, :parent_version
 
         after :cache, :assign_parent_cache_id
         after :cache, :cache_versions!
@@ -21,6 +19,13 @@ module CarrierWave
         after :remove, :remove_versions!
         after :retrieve_from_cache, :retrieve_versions_from_cache!
         after :retrieve_from_store, :retrieve_versions_from_store!
+
+        prepend Module.new {
+          def initialize(*)
+            super
+            @versions = nil
+          end
+        }
       end
 
       module ClassMethods
@@ -50,72 +55,74 @@ module CarrierWave
         #
         def version(name, options = {}, &block)
           name = name.to_sym
-          build_version(name, options) unless versions[name]
+          build_version(name, options)
 
-          versions[name][:uploader].class_eval(&block) if block
+          versions[name].class_eval(&block) if block
           versions[name]
         end
 
         def recursively_apply_block_to_versions(&block)
           versions.each do |name, version|
-            version[:uploader].class_eval(&block)
-            version[:uploader].recursively_apply_block_to_versions(&block)
+            version.class_eval(&block)
+            version.recursively_apply_block_to_versions(&block)
           end
         end
 
       private
 
         def build_version(name, options)
-          uploader = Class.new(self)
-          const_set("Uploader#{uploader.object_id}".gsub('-', '_'), uploader)
-          uploader.version_names += [name]
-          uploader.versions = {}
-          uploader.processors = []
-
-          uploader.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            # Define the enable_processing method for versions so they get the
-            # value from the parent class unless explicitly overwritten
-            def self.enable_processing(value=nil)
-              self.enable_processing = value if value
-              if !@enable_processing.nil?
-                @enable_processing
-              else
-                superclass.enable_processing
+          if !versions.has_key?(name)
+            uploader = Class.new(self)
+            const_set("Uploader#{uploader.object_id}".tr('-', '_'), uploader)
+            uploader.version_names += [name]
+            uploader.versions = {}
+            uploader.processors = []
+            uploader.version_options = options
+
+            uploader.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              # Define the enable_processing method for versions so they get the
+              # value from the parent class unless explicitly overwritten
+              def self.enable_processing(value=nil)
+                self.enable_processing = value if value
+                if defined?(@enable_processing) && !@enable_processing.nil?
+                  @enable_processing
+                else
+                  superclass.enable_processing
+                end
+              end
+
+              # Regardless of what is set in the parent uploader, do not enforce the
+              # move_to_cache config option on versions because it moves the original
+              # file to the version's target file.
+              #
+              # If you want to enforce this setting on versions, override this method
+              # in each version:
+              #
+              # version :thumb do
+              #   def move_to_cache
+              #     true
+              #   end
+              # end
+              #
+              def move_to_cache
+                false
               end
-            end
-
-            # Regardless of what is set in the parent uploader, do not enforce the
-            # move_to_cache config option on versions because it moves the original
-            # file to the version's target file.
-            #
-            # If you want to enforce this setting on versions, override this method
-            # in each version:
-            #
-            # version :thumb do
-            #   def move_to_cache
-            #     true
-            #   end
-            # end
-            #
-            def move_to_cache
-              false
-            end
-          RUBY
-
-          class_eval <<-RUBY
-            def #{name}
-              versions[:#{name}]
-            end
-          RUBY
+            RUBY
+
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{name}
+                versions[:#{name}]
+              end
+            RUBY
+          else
+            uploader = Class.new(versions[name])
+            const_set("Uploader#{uploader.object_id}".tr('-', '_'), uploader)
+            uploader.processors = []
+            uploader.version_options = uploader.version_options.merge(options)
+          end
 
           # Add the current version hash to class attribute :versions
-          current_version = {
-            name => {
-              :uploader => uploader,
-              :options  => options
-            }
-          }
-          self.versions = versions.merge(current_version)
+          self.versions = versions.merge(name => uploader)
         end
 
       end # ClassMethods
@@ -131,7 +138,8 @@ module CarrierWave
         return @versions if @versions
         @versions = {}
         self.class.versions.each do |name, version|
-          @versions[name] = version[:uploader].new(model, mounted_as)
+          @versions[name] = version.new(model, mounted_as)
+          @versions[name].parent_version = self
         end
         @versions
       end
@@ -160,7 +168,7 @@ module CarrierWave
 
         return false unless self.class.versions.has_key?(name)
 
-        condition = self.class.versions[name][:options][:if]
+        condition = self.class.versions[name].version_options[:if]
         if(condition)
           if(condition.respond_to?(:call))
             condition.call(self, :version => name, :file => file)
@@ -212,16 +220,18 @@ module CarrierWave
       # Recreate versions and reprocess them. This can be used to recreate
       # versions if their parameters somehow have changed.
       #
-      def recreate_versions!(*versions)
+      def recreate_versions!(*names)
         # Some files could possibly not be stored on the local disk. This
         # doesn't play nicely with processing. Make sure that we're only
         # processing a cached file
         #
         # The call to store! will trigger the necessary callbacks to both
         # process this version and all sub-versions
-        if versions.any?
-          file = sanitized_file if !cached?
-          store_versions!(file, versions)
+
+        if names.any?
+          set_versions_to_cache_and_store(names)
+          store!(file)
+          reset_versions_to_cache_and_store
         else
           cache! if !cached?
           store!
@@ -229,6 +239,39 @@ module CarrierWave
       end
 
     private
+
+      def set_versions_to_cache_and_store(names)
+        @versions_to_cache = source_versions_of(names)
+        @versions_to_store = active_versions_with_names_in(@versions_to_cache + names)
+      end
+
+      def reset_versions_to_cache_and_store
+        @versions_to_cache, @versions_to_store = nil, nil
+      end
+
+      def versions_to_cache
+        @versions_to_cache || dependent_versions
+      end
+
+      def versions_to_store
+        @versions_to_store || active_versions
+      end
+
+      def source_versions_of(requested_names)
+        versions.inject([]) do |sources, (name, uploader)|
+          next sources unless requested_names.include?(name)
+          next sources unless source_name = uploader.class.version_options[:from_version]
+
+          sources << [source_name, versions[source_name]]
+        end.uniq
+      end
+
+      def active_versions_with_names_in(names)
+        active_versions.select do |pretendent_name, uploader|
+          names.include?(pretendent_name)
+        end
+      end
+
       def assign_parent_cache_id(file)
         active_versions.each do |name, uploader|
           uploader.parent_cache_id = @cache_id
@@ -241,6 +284,18 @@ module CarrierWave
         end
       end
 
+      def dependent_versions
+        active_versions.reject do |name, v|
+          v.class.version_options[:from_version]
+        end.to_a + sibling_versions.select do |name, v|
+          v.class.version_options[:from_version] == self.class.version_names.last
+        end.to_a
+      end
+
+      def sibling_versions
+        parent_version.try(:versions) || []
+      end
+
       def full_filename(for_file)
         [version_name, super(for_file)].compact.join('_')
       end
@@ -250,39 +305,14 @@ module CarrierWave
       end
 
       def cache_versions!(new_file)
-        # We might have processed the new_file argument after the callbacks were
-        # initialized, so get the actual file based off of the current state of
-        # our file
-        processed_parent = SanitizedFile.new :tempfile => self.file,
-          :filename => new_file.original_filename
-
-        active_versions.each do |name, v|
-          next if v.cached?
-
-          v.send(:cache_id=, cache_id)
-          # If option :from_version is present, create cache using cached file from
-          # version indicated
-          if self.class.versions[name][:options] && self.class.versions[name][:options][:from_version]
-            # Maybe the reference version has not been cached yet
-            unless versions[self.class.versions[name][:options][:from_version]].cached?
-              versions[self.class.versions[name][:options][:from_version]].cache!(processed_parent)
-            end
-            processed_version = SanitizedFile.new :tempfile => versions[self.class.versions[name][:options][:from_version]],
-              :filename => new_file.original_filename
-            v.cache!(processed_version)
-          else
-            v.cache!(processed_parent)
-          end
+        versions_to_cache.each do |name, v|
+          v.send(:cache_id=, @cache_id)
+          v.cache!(new_file)
         end
       end
 
-      def store_versions!(new_file, versions=nil)
-        if versions
-          active = Hash[active_versions]
-          versions.each { |v| active[v].try(:store!, new_file) } unless active.empty?
-        else
-          active_versions.each { |name, v| v.store!(new_file) }
-        end
+      def store_versions!(new_file)
+        versions_to_store.each { |name, v| v.store!(new_file) }
       end
 
       def remove_versions!
@@ -290,11 +320,11 @@ module CarrierWave
       end
 
       def retrieve_versions_from_cache!(cache_name)
-        versions.each { |name, v| v.retrieve_from_cache!(cache_name) }
+        active_versions.each { |name, v| v.retrieve_from_cache!(cache_name) }
       end
 
       def retrieve_versions_from_store!(identifier)
-        versions.each { |name, v| v.retrieve_from_store!(identifier) }
+        active_versions.each { |name, v| v.retrieve_from_store!(identifier) }
       end
 
     end # Versions