carrierwave 0.11.2 → 3.0.3

data/lib/carrierwave/mount.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
 
   ##
@@ -62,7 +60,7 @@ module CarrierWave
     # will create an anonymous uploader class.
     #
     # Passing a block makes it possible to customize the uploader. This can be
-    # convenient for brevity, but if there is any significatnt logic in the
+    # convenient for brevity, but if there is any significant logic in the
     # uploader, you should do the right thing and have it in its own file.
     #
     # === Added instance methods
@@ -92,7 +90,6 @@ module CarrierWave
     # [image_processing_error]  Returns an error object if the last file to be assigned caused a processing error
     # [image_download_error]    Returns an error object if the last file to be remotely assigned caused a download error
     #
-    # [write_image_identifier]  Uses the write_uploader method to set the identifier.
     # [image_identifier]        Reads out the identifier of the file
     #
     # === Parameters
@@ -135,56 +132,218 @@ module CarrierWave
     #     end
     #
     def mount_uploader(column, uploader=nil, options={}, &block)
-      include CarrierWave::Mount::Extension
+      mount_base(column, uploader, options.merge(multiple: false), &block)
 
-      uploader = build_uploader(uploader, &block)
-      uploaders[column.to_sym] = uploader
-      uploader_options[column.to_sym] = options
-
-      # 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
+          _mounter(:#{column}).uploaders[0] ||= _mounter(:#{column}).blank_uploader
         end
 
         def #{column}=(new_file)
-          _mounter(:#{column}).cache(new_file)
-        end
-
-        def #{column}?
-          _mounter(:#{column}).present?
+          _mounter(:#{column}).cache([new_file])
         end
 
         def #{column}_url(*args)
-          _mounter(:#{column}).url(*args)
+          #{column}.url(*args)
         end
 
         def #{column}_cache
-          _mounter(:#{column}).cache_name
+          _mounter(:#{column}).cache_names[0]
         end
 
         def #{column}_cache=(cache_name)
-          _mounter(:#{column}).cache_name = cache_name
+          _mounter(:#{column}).cache_names = [cache_name]
         end
 
         def remote_#{column}_url
-          _mounter(:#{column}).remote_url
+          [_mounter(:#{column}).remote_urls].flatten[0]
         end
 
         def remote_#{column}_url=(url)
-          _mounter(:#{column}).remote_url = url
+          _mounter(:#{column}).remote_urls = url
+        end
+
+        def remote_#{column}_request_header=(header)
+          _mounter(:#{column}).remote_request_headers = [header]
+        end
+
+        def #{column}_identifier
+          _mounter(:#{column}).read_identifiers[0]
+        end
+
+        def #{column}_integrity_error
+          #{column}_integrity_errors.last
+        end
+
+        def #{column}_processing_error
+          #{column}_processing_errors.last
+        end
+
+        def #{column}_download_error
+          #{column}_download_errors.last
+        end
+      RUBY
+    end
+
+    ##
+    # Mounts the given uploader on the given array column. This means that
+    # assigning and reading from the array column will upload and retrieve
+    # multiple files. Supposing that a User class has an uploader mounted on
+    # images, and that images can store an array, for example it could be a
+    # PostgreSQL JSON column. You can assign and retrieve files like this:
+    #
+    #     @user.images # => []
+    #     @user.images = [some_file_object]
+    #     @user.images # => [<Uploader>]
+    #
+    #     @user.images[0].url # => '/some_url.png'
+    #
+    # It is also possible (but not recommended) to omit the uploader, which
+    # will create an anonymous uploader class.
+    #
+    # Passing a block makes it possible to customize the uploader. This can be
+    # convenient for brevity, but if there is any significant 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_uploaders+ to mount an uploader on a column
+    # named +images+, in that case the following methods will be added to the class:
+    #
+    # [images]                  Returns an array of uploaders for each uploaded file
+    # [images=]                 Caches the given files
+    #
+    # [images_urls]             Returns the urls to the uploaded files
+    #
+    # [images_cache]            Returns a string that identifies the cache location of the files
+    # [images_cache=]           Retrieves the files from the cache based on the given cache name
+    #
+    # [remote_image_urls]       Returns previously cached remote urls
+    # [remote_image_urls=]      Retrieve files from the given remote urls
+    #
+    # [remove_images]           An attribute reader that can be used with a checkbox to mark the files for removal
+    # [remove_images=]          An attribute writer that can be used with a checkbox to mark the files for removal
+    # [remove_images?]          Whether the files should be removed when store_image! is called.
+    #
+    # [store_images!]           Stores all files that have been assigned with +images=+
+    # [remove_images!]          Removes the uploaded file from the filesystem.
+    #
+    # [image_integrity_errors]   Returns error objects of files which failed to pass integrity check
+    # [image_processing_errors]  Returns error objects of files which failed to be processed
+    # [image_download_errors]    Returns error objects of files which failed to be downloaded
+    #
+    # [image_identifiers]       Reads out the identifiers of the files
+    #
+    # === 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_uploaders :lyrics, LyricsUploader
+    #       mount_uploaders :alternative_lyrics, LyricsUploader
+    #       mount_uploaders :files, SongUploader
+    #     end
+    #
+    # This will add an anonymous uploader with only the default settings:
+    #
+    #     class Data
+    #       mount_uploaders :csv_files
+    #     end
+    #
+    # this will add an anonymous uploader overriding the store_dir:
+    #
+    #     class Product
+    #       mount_uploaders :blueprints do
+    #         def store_dir
+    #           'blueprints'
+    #         end
+    #       end
+    #     end
+    #
+    def mount_uploaders(column, uploader=nil, options={}, &block)
+      mount_base(column, uploader, options.merge(multiple: true), &block)
+
+      mod = Module.new
+      include mod
+      mod.class_eval <<-RUBY, __FILE__, __LINE__+1
+
+        def #{column}
+          _mounter(:#{column}).uploaders
+        end
+
+        def #{column}=(new_files)
+          _mounter(:#{column}).cache(new_files)
+        end
+
+        def #{column}_urls(*args)
+          _mounter(:#{column}).urls(*args)
+        end
+
+        def #{column}_cache
+          names = _mounter(:#{column}).cache_names
+          names.to_json if names.present?
+        end
+
+        def #{column}_cache=(cache_name)
+          _mounter(:#{column}).cache_names = JSON.parse(cache_name) if cache_name.present?
+        end
+
+        def remote_#{column}_urls
+          _mounter(:#{column}).remote_urls
+        end
+
+        def remote_#{column}_urls=(urls)
+          _mounter(:#{column}).remote_urls = urls
+        end
+
+        def remote_#{column}_request_headers=(headers)
+          _mounter(:#{column}).remote_request_headers = headers
+        end
+
+        def #{column}_identifiers
+          _mounter(:#{column}).read_identifiers
+        end
+      RUBY
+    end
+
+  private
+
+    def mount_base(column, uploader=nil, options={}, &block)
+      include CarrierWave::Mount::Extension
+
+      uploader = build_uploader(uploader, column, &block)
+      uploaders[column.to_sym] = uploader
+      uploader_options[column.to_sym] = options
+
+      # 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
+
+      mod = Module.new
+      include mod
+      mod.class_eval <<-RUBY, __FILE__, __LINE__+1
+
+        def #{column}?
+          _mounter(:#{column}).present?
         end
 
         def remove_#{column}
@@ -193,6 +352,8 @@ module CarrierWave
 
         def remove_#{column}!
           _mounter(:#{column}).remove!
+          self.remove_#{column} = true
+          write_#{column}_identifier
         end
 
         def remove_#{column}=(value)
@@ -207,64 +368,48 @@ module CarrierWave
           _mounter(:#{column}).store!
         end
 
-        def #{column}_integrity_error
-          _mounter(:#{column}).integrity_error
+        def #{column}_integrity_errors
+          _mounter(:#{column}).integrity_errors
         end
 
-        def #{column}_processing_error
-          _mounter(:#{column}).processing_error
+        def #{column}_processing_errors
+          _mounter(:#{column}).processing_errors
         end
 
-        def #{column}_download_error
-          _mounter(:#{column}).download_error
+        def #{column}_download_errors
+          _mounter(:#{column}).download_errors
         end
 
         def write_#{column}_identifier
           _mounter(:#{column}).write_identifier
         end
 
-        def #{column}_identifier
-          _mounter(:#{column}).identifier
-        end
-
-        def store_previous_model_for_#{column}
-          serialization_column = _mounter(:#{column}).serialization_column
-
-          if #{column}.remove_previously_stored_files_after_update && send(:"\#{serialization_column}_changed?")
-            @previous_model_for_#{column} ||= self.find_previous_model_for_#{column}
-          end
+        def mark_remove_#{column}_false
+          _mounter(:#{column}).remove = false
         end
 
-        def find_previous_model_for_#{column}
-          self.class.find(to_key.first)
+        def reset_previous_changes_for_#{column}
+          _mounter(:#{column}).reset_changes!
         end
 
         def remove_previously_stored_#{column}
-          if @previous_model_for_#{column} && @previous_model_for_#{column}.#{column}.path != #{column}.path
-            @previous_model_for_#{column}.#{column}.remove!
-            @previous_model_for_#{column} = nil
-          end
+          _mounter(:#{column}).remove_previous
         end
 
-        def mark_remove_#{column}_false
-          _mounter(:#{column}).remove = false
+        def remove_rolled_back_#{column}
+          _mounter(:#{column}).remove_added
         end
-
       RUBY
     end
 
-    private
-
-    def build_uploader(uploader, &block)
-      return uploader if uploader && !block_given?
+    def build_uploader(uploader, column, &block)
+      uploader ||= CarrierWave::Uploader::Base
+      return uploader unless block_given?
 
-      uploader = Class.new(uploader || CarrierWave::Uploader::Base)
-      const_set("Uploader#{uploader.object_id}".gsub('-', '_'), uploader)
+      uploader = Class.new(uploader)
+      const_set("CarrierWave#{column.to_s.camelize}Uploader", uploader)
 
-      if block_given?
-        uploader.class_eval(&block)
-        uploader.recursively_apply_block_to_versions(&block)
-      end
+      uploader.class_eval(&block)
 
       uploader
     end
@@ -285,127 +430,12 @@ module CarrierWave
 
       def _mounter(column)
         # We cannot memoize in frozen objects :(
-        return Mounter.new(self, column) if frozen?
+        return Mounter.build(self, column) if frozen?
         @_mounters ||= {}
-        @_mounters[column] ||= Mounter.new(self, column)
+        @_mounters[column] ||= Mounter.build(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, :download_error
-      attr_accessor :remove
-
-      def initialize(record, column, options={})
-        @record = record
-        @column = column
-        @options = record.class.uploader_options[column]
-      end
-
-      def write_identifier
-        return if record.frozen?
-
-        if remove?
-          record.write_uploader(serialization_column, nil)
-        elsif uploader.identifier.present?
-          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)
-        @uploader.retrieve_from_store!(identifier) if @uploader.blank? && identifier.present?
-
-        @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)
-        return if url.blank?
-
-        @remote_url = url
-        @download_error = nil
-        @integrity_error = nil
-
-        uploader.download!(url)
-
-      rescue CarrierWave::DownloadError => e
-        @download_error = e
-        raise e unless option(:ignore_download_errors)
-      rescue CarrierWave::ProcessingError => e
-        @processing_error = e
-        raise e unless option(:ignore_processing_errors)
-      rescue CarrierWave::IntegrityError => e
-        @integrity_error = e
-        raise e unless option(:ignore_integrity_errors)
-      end
-
-      def store!
-        return if uploader.blank?
-
-        if remove?
-          uploader.remove!
-        else
-          uploader.store!
-        end
-      end
-
-      def url(*args)
-        uploader.url(*args)
-      end
-
-      def blank?
-        uploader.blank?
-      end
-
-      def remove?
-        remove.present? && remove !~ /\A0|false$\z/
-      end
-
-      def remove!
-        uploader.remove!
-      end
-
-      def serialization_column
-        option(:mount_on) || column
-      end
-
-      attr_accessor :uploader_options
-
-    private
-
-      def option(name)
-        self.uploader_options ||= {}
-        self.uploader_options[name] ||= record.class.uploader_option(column, name)
-      end
-
-    end # Mounter
-
   end # Mount
 end # CarrierWave