carrierwave 0.11.2 → 3.0.3

data/lib/carrierwave/uploader/proxy.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Proxy
@@ -19,20 +17,33 @@ 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 || (file && storage.try(:identifier))
+      end
+
+      ##
+      # Returns a String which is to be used as a temporary value which gets assigned to the column.
+      # The purpose is to mark the column that it will be updated. Finally before the save it will be
+      # overwritten by the #identifier value, which is usually #filename.
+      #
+      # === Returns
+      #
+      # [String] a temporary_identifier, by default @original_filename is used
+      #
+      def temporary_identifier
+        @original_filename || @identifier
       end
 
       ##
@@ -42,8 +53,8 @@ module CarrierWave
       #
       # [String] contents of the file
       #
-      def read
-        file.read if file.respond_to?(:read)
+      def read(*args)
+        file.try(:read, *args)
       end
 
       ##
@@ -54,7 +65,7 @@ module CarrierWave
       # [Integer] size of the file
       #
       def size
-        file.respond_to?(:size) ? file.size : 0
+        file.try(:size) || 0
       end
 
       ##
@@ -80,7 +91,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, @deduplication_index = nil
+          end
+        }
+      end
+
       ##
       # Override this in your Uploader to change the filename.
       #
@@ -27,9 +34,26 @@ module CarrierWave
         @filename
       end
 
+      ##
+      # Returns a filename which doesn't conflict with already-stored files.
+      #
+      # === Returns
+      #
+      # [String] the filename with suffix added for deduplication
+      #
+      def deduplicated_filename
+        return unless filename
+        return filename unless @deduplication_index
+
+        parts = filename.split('.')
+        basename = parts.shift
+        basename.sub!(/ ?\(\d+\)\z/, '')
+        ([basename.to_s + (@deduplication_index > 1 ? "(#{@deduplication_index})" : '')] + parts).join('.')
+      end
+
       ##
       # Calculates the path where the file should be stored. If +for_file+ is given, it will be
-      # used as the filename, otherwise +CarrierWave::Uploader#filename+ is assumed.
+      # used as the identifier, otherwise +CarrierWave::Uploader#identifier+ is assumed.
       #
       # === Parameters
       #
@@ -39,7 +63,7 @@ module CarrierWave
       #
       # [String] the store path
       #
-      def store_path(for_file=filename)
+      def store_path(for_file=identifier)
         File.join([store_dir, full_filename(for_file)].compact)
       end
 
@@ -53,32 +77,18 @@ module CarrierWave
       # [new_file (File, IOString, Tempfile)] any kind of file object
       #
       def store!(new_file=nil)
-        cache!(new_file) if new_file && ((@cache_id != parent_cache_id) || @cache_id.nil?)
-        if @file and @cache_id
+        cache!(new_file) if new_file && !cached?
+        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
+            @identifier = storage.identifier
+            @cache_id = @deduplication_index = nil
+            @staged = false
           end
         end
       end
@@ -93,13 +103,34 @@ module CarrierWave
       def retrieve_from_store!(identifier)
         with_callbacks(:retrieve_from_store, identifier) do
           @file = storage.retrieve!(identifier)
+          @identifier = identifier
+        end
+      end
+
+      ##
+      # Look for an identifier which doesn't collide with the given already-stored identifiers.
+      # It is done by adding a index number as the suffix.
+      # For example, if there's 'image.jpg' and the @deduplication_index is set to 2,
+      # The stored file will be named as 'image(2).jpg'.
+      #
+      # === Parameters
+      #
+      # [current_identifiers (Array[String])] List of identifiers for already-stored files
+      #
+      def deduplicate(current_identifiers)
+        @deduplication_index = nil
+        return unless current_identifiers.include?(identifier)
+
+        (1..current_identifiers.size + 1).each do |i|
+          @deduplication_index = i
+          break unless current_identifiers.include?(identifier)
         end
       end
 
     private
 
       def full_filename(for_file)
-        for_file
+        forcing_extension(for_file)
       end
 
       def storage

data/lib/carrierwave/uploader/url.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Url
@@ -17,12 +15,15 @@ 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)
-        elsif file.respond_to?(:path)
-          path = encode_path(file.path.gsub(File.expand_path(root), ''))
+        if file.respond_to?(:url)
+          tmp_url = file.method(:url).arity.zero? ? file.url : file.url(options)
+          return tmp_url if tmp_url.present?
+        end
+
+        if file.respond_to?(:path)
+          path = encode_path(file.path.sub(File.expand_path(root), ''))
 
-          if host = asset_host
+          if (host = asset_host)
             if host.respond_to? :call
               "#{host.call(file)}#{path}"
             else

data/lib/carrierwave/uploader/versions.rb

@@ -1,26 +1,113 @@
-# encoding: utf-8
+require "active_support/core_ext/object/deep_dup"
 
 module CarrierWave
   module Uploader
     module Versions
+      class Builder
+        def initialize(name)
+          @name = name
+          @options = {}
+          @blocks = []
+          @klass = nil
+        end
+
+        def configure(options, &block)
+          @options.merge!(options)
+          @blocks << block if block
+          @klass = nil
+        end
+
+        def build(superclass)
+          return @klass if @klass
+          @klass = Class.new(superclass)
+          superclass.const_set("#{@name.to_s.camelize}VersionUploader", @klass)
+
+          @klass.version_names += [@name]
+          @klass.versions = {}
+          @klass.processors = []
+          @klass.version_options = @options
+          @klass.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
+
+            # Need to rely on the parent version's identifier, as versions don't have its own one.
+            def identifier
+              parent_version.identifier
+            end
+          RUBY
+          @blocks.each { |block| @klass.class_eval(&block) }
+          @klass
+        end
+
+        def deep_dup
+          other = dup
+          other.instance_variable_set(:@blocks, @blocks.dup)
+          other
+        end
+
+        def method_missing(name, *args)
+          super
+        rescue NoMethodError => e
+          raise e.exception <<~ERROR
+            #{e.message}
+            If you're trying to configure a version, do it inside a block like `version(:thumb) { self.#{name} #{args.map(&:inspect).join(', ')} }`.
+          ERROR
+        end
+
+        def respond_to_missing?(*)
+          super
+        end
+      end
+
       extend ActiveSupport::Concern
 
       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_version
 
-        after :cache, :assign_parent_cache_id
         after :cache, :cache_versions!
         after :store, :store_versions!
         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
@@ -46,78 +133,33 @@ module CarrierWave
         #         process :scale => [200, 200]
         #       end
         #
+        #       version :square, :unless => :invalid_image_type? do
+        #         process :scale => [100, 100]
+        #       end
+        #
         #     end
         #
         def version(name, options = {}, &block)
           name = name.to_sym
-          build_version(name, options) unless versions[name]
-
-          versions[name][:uploader].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)
-          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
-              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
+          versions[name] ||= Builder.new(name)
+          versions[name].configure(options, &block)
 
-          class_eval <<-RUBY
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{name}
               versions[:#{name}]
             end
           RUBY
 
-          # Add the current version hash to class attribute :versions
-          current_version = {
-            name => {
-              :uploader => uploader,
-              :options  => options
-            }
-          }
-          self.versions = versions.merge(current_version)
+          versions[name]
         end
 
+      private
+
+        def inherited(subclass)
+          # To prevent subclass version changes affecting superclass versions
+          subclass.versions = versions.deep_dup
+          super
+        end
       end # ClassMethods
 
       ##
@@ -131,7 +173,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.build(self.class).new(model, mounted_as)
+          @versions[name].parent_version = self
         end
         @versions
       end
@@ -153,25 +196,44 @@ module CarrierWave
       #
       # === Returns
       #
-      # [Boolean] True when the version exists according to its :if condition
+      # [Boolean] True when the version exists according to its :if or :unless condition
       #
       def version_exists?(name)
         name = name.to_sym
 
-        return false unless self.class.versions.has_key?(name)
+        return false unless versions.has_key?(name)
+
+        if_condition = versions[name].class.version_options[:if]
+        unless_condition = versions[name].class.version_options[:unless]
 
-        condition = self.class.versions[name][:options][:if]
-        if(condition)
-          if(condition.respond_to?(:call))
-            condition.call(self, :version => name, :file => file)
+        if if_condition
+          if if_condition.respond_to?(:call)
+            if_condition.call(self, :version => name, :file => file)
+          else
+            send(if_condition, file)
+          end
+        elsif unless_condition
+          if unless_condition.respond_to?(:call)
+            !unless_condition.call(self, :version => name, :file => file)
           else
-            send(condition, file)
+            !send(unless_condition, file)
           end
         else
           true
         end
       end
 
+      ##
+      # Copies the parent's cache_id when caching a version file.
+      # This behavior is not essential but it makes easier to understand
+      # that the cached files are generated by the single upload attempt.
+      #
+      def cache!(*args)
+        self.cache_id = parent_version.cache_id if parent_version
+
+        super
+      end
+
       ##
       # When given a version name as a parameter, will return the url for that version
       # This also works with nested versions.
@@ -212,26 +274,26 @@ module CarrierWave
       # Recreate versions and reprocess them. This can be used to recreate
       # versions if their parameters somehow have changed.
       #
-      def recreate_versions!(*versions)
-        # 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)
-        else
-          cache! if !cached?
-          store!
+      def recreate_versions!(*names)
+        # As well as specified versions, we need to reprocess versions
+        # that are the source of another version.
+
+        self.cache_id = CarrierWave.generate_cache_id
+        derived_versions.each do |name, v|
+          v.cache!(file) if names.empty? || !(v.descendant_version_names & names).empty?
         end
+        active_versions.each do |name, v|
+          v.store! if names.empty? || names.include?(name)
+        end
+      ensure
+        @cache_id = nil
       end
 
-    private
-      def assign_parent_cache_id(file)
-        active_versions.each do |name, uploader|
-          uploader.parent_cache_id = @cache_id
+    protected
+
+      def descendant_version_names
+        [version_name] + derived_versions.flat_map do |name, version|
+          version.descendant_version_names
         end
       end
 
@@ -241,6 +303,20 @@ module CarrierWave
         end
       end
 
+    private
+
+      def derived_versions
+        active_versions.reject do |name, v|
+          v.class.version_options[:from_version]
+        end.to_a + active_sibling_versions.select do |name, v|
+          v.class.version_options[:from_version] == self.class.version_names.last
+        end.to_a
+      end
+
+      def active_sibling_versions
+        parent_version&.active_versions || []
+      end
+
       def full_filename(for_file)
         [version_name, super(for_file)].compact.join('_')
       end
@@ -250,39 +326,11 @@ 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
-        end
+        derived_versions.each { |name, v| v.cache!(new_file) }
       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)
+        active_versions.each { |name, v| v.store!(new_file) }
       end
 
       def remove_versions!
@@ -290,11 +338,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

data/lib/carrierwave/uploader.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "carrierwave/uploader/configuration"
 require "carrierwave/uploader/callbacks"
 require "carrierwave/uploader/proxy"
@@ -9,10 +7,12 @@ require "carrierwave/uploader/cache"
 require "carrierwave/uploader/store"
 require "carrierwave/uploader/download"
 require "carrierwave/uploader/remove"
-require "carrierwave/uploader/extension_whitelist"
-require "carrierwave/uploader/extension_blacklist"
-require "carrierwave/uploader/content_type_whitelist"
-require "carrierwave/uploader/content_type_blacklist"
+require "carrierwave/uploader/extension_allowlist"
+require "carrierwave/uploader/extension_denylist"
+require "carrierwave/uploader/content_type_allowlist"
+require "carrierwave/uploader/content_type_denylist"
+require "carrierwave/uploader/file_size"
+require "carrierwave/uploader/dimension"
 require "carrierwave/uploader/processing"
 require "carrierwave/uploader/versions"
 require "carrierwave/uploader/default_url"
@@ -53,10 +53,12 @@ module CarrierWave
       include CarrierWave::Uploader::Store
       include CarrierWave::Uploader::Download
       include CarrierWave::Uploader::Remove
-      include CarrierWave::Uploader::ExtensionWhitelist
-      include CarrierWave::Uploader::ExtensionBlacklist
-      include CarrierWave::Uploader::ContentTypeWhitelist
-      include CarrierWave::Uploader::ContentTypeBlacklist
+      include CarrierWave::Uploader::ExtensionAllowlist
+      include CarrierWave::Uploader::ExtensionDenylist
+      include CarrierWave::Uploader::ContentTypeAllowlist
+      include CarrierWave::Uploader::ContentTypeDenylist
+      include CarrierWave::Uploader::FileSize
+      include CarrierWave::Uploader::Dimension
       include CarrierWave::Uploader::Processing
       include CarrierWave::Uploader::Versions
       include CarrierWave::Uploader::DefaultUrl