carrierwave 0.11.2 → 3.1.2

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
@@ -20,7 +18,7 @@ module CarrierWave
         # Adds a processor callback which applies operations as a file is uploaded.
         # The argument may be the name of any method of the uploader, expressed as a symbol,
         # or a list of such methods, or a hash where the key is a method and the value is
-        # an array of arguments to call the method with
+        # an array of arguments to call the method with. Also accepts an :if or :unless condition
         #
         # === Parameters
         #
@@ -33,6 +31,7 @@ module CarrierWave
         #       process :sepiatone, :vignette
         #       process :scale => [200, 200]
         #       process :scale => [200, 200], :if => :image?
+        #       process :scale => [200, 200], :unless => :disallowed_image_type?
         #       process :sepiatone, :if => :image?
         #
         #       def sepiatone
@@ -51,6 +50,10 @@ module CarrierWave
         #         ...
         #       end
         #
+        #       def disallowed_image_type?
+        #         ...
+        #       end
+        #
         #     end
         #
         def process(*args)
@@ -59,12 +62,20 @@ module CarrierWave
             hash.merge!(arg)
           end
 
-          condition = new_processors.delete(:if)
+          condition_type = new_processors.keys.detect { |key| [:if, :unless].include?(key) }
+          condition = new_processors.delete(:if) || new_processors.delete(:unless)
           new_processors.each do |processor, processor_args|
-            self.processors += [[processor, processor_args, condition]]
+            self.processors += [[processor, processor_args, condition, condition_type]]
+
+            if processor == :convert
+              # Treat :convert specially, since it should trigger the file extension change
+              force_extension processor_args
+              if condition
+                warn "Use of 'process convert: format' with conditionals has an issue and doesn't work correctly. See https://github.com/carrierwaveuploader/carrierwave/issues/2723 for details. "
+              end
+            end
           end
         end
-
       end # ClassMethods
 
       ##
@@ -73,18 +84,45 @@ 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)
+        with_callbacks(:process, new_file) do
+          self.class.processors.each do |method, args, condition, condition_type|
+            if condition && condition_type == :if
+              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
+            elsif condition && condition_type == :unless
+              if condition.respond_to?(:call)
+                next if condition.call(self, :args => args, :method => method, :file => new_file)
+              elsif self.send(condition, new_file)
+                next
+              end
+            end
+
+            if args.is_a? Array
+              kwargs, args = args.partition { |arg| arg.is_a? Hash }
+            end
+
+            if kwargs.present?
+              kwargs = kwargs.reduce(:merge)
+              self.send(method, *args, **kwargs)
             else
-              next unless self.send(condition, new_file)
+              self.send(method, *args)
             end
           end
-          self.send(method, *args)
         end
       end
 
+    private
+
+      def forcing_extension(filename)
+        if force_extension && filename
+          Pathname.new(filename).sub_ext(".#{force_extension.to_s.delete_prefix('.')}").to_s
+        else
+          filename
+        end
+      end
     end # Processing
   end # Uploader
 end # CarrierWave

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 the value of #cache_name is used
+      #
+      def temporary_identifier
+        cache_name || @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,29 @@ 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
+        }
+
+        after :store, :show_warning_when_filename_is_unavailable
+
+        class_attribute :filename_safeguard_checked
+      end
+
+      module ClassMethods
+      private
+
+        def inherited(subclass)
+          # To perform the filename safeguard check once per a class
+          self.filename_safeguard_checked = false
+          super
+        end
+      end
+
       ##
       # Override this in your Uploader to change the filename.
       #
@@ -27,9 +48,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 +77,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 +91,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
+            @original_filename = @cache_id = @deduplication_index = nil
+            @staged = false
           end
         end
       end
@@ -93,13 +117,46 @@ 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 show_warning_when_filename_is_unavailable(_)
+        return if self.class.filename_safeguard_checked
+        self.class.filename_safeguard_checked = true
+        return if filename
+
+        warn <<~MESSAGE
+          [WARNING] Your uploader's #filename method defined at #{method(:filename).source_location.join(':')} didn't return value after storing the file.
+          It's likely that the method is safeguarded with `if original_filename`, which were necessary for pre-3.x CarrierWave but is no longer needed.
+          Removing it is recommended, as it is known to cause issues depending on the use case: https://github.com/carrierwaveuploader/carrierwave/issues/2708
+        MESSAGE
       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