carrierwave 0.11.2 → 3.0.7

data/lib/carrierwave/test/matchers.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Test
 
@@ -23,13 +21,16 @@ module CarrierWave
           "expected #{@actual.inspect} to be identical to #{@expected.inspect}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.inspect} to not be identical to #{@expected.inspect}"
         end
 
         def description
           "be identical to #{@expected.inspect}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_identical_to(expected)
@@ -44,20 +45,23 @@ module CarrierWave
         def matches?(actual)
           @actual = actual
           # Satisfy expectation here. Return false or raise an error if it's not met.
-          (File.stat(@actual.path).mode & 0777) == @expected
+          (File.stat(@actual.path).mode & 0o777) == @expected
         end
 
         def failure_message
-          "expected #{@actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
+          "expected #{@actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0o777).to_s(8)}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
         end
 
         def description
           "have permissions #{@expected.to_s(8)}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_permissions(expected)
@@ -72,20 +76,23 @@ module CarrierWave
         def matches?(actual)
           @actual = actual
           # Satisfy expectation here. Return false or raise an error if it's not met.
-          (File.stat(File.dirname @actual.path).mode & 0777) == @expected
+          (File.stat(File.dirname(@actual.path)).mode & 0o777) == @expected
         end
 
         def failure_message
-          "expected #{File.dirname @actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
+          "expected #{File.dirname @actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0o777).to_s(8)}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{File.dirname @actual.current_path.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
         end
 
         def description
           "have permissions #{@expected.to_s(8)}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_directory_permissions(expected)
@@ -110,13 +117,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no larger than #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} to be larger than #{@width} by #{@height}, but it wasn't."
         end
 
         def description
           "be no larger than #{@width} by #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_larger_than(width, height)
@@ -141,13 +151,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@width} by #{@height}, but it did."
         end
 
         def description
           "have an exact size of #{@width} by #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_dimensions(width, height)
@@ -171,13 +184,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@height}, but it was #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@height}, but it did."
         end
 
         def description
           "have an exact height of #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_height(height)
@@ -201,13 +217,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@width}, but it was #{@actual_width}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@width}, but it did."
         end
 
         def description
           "have an exact width of #{@width}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_width(width)
@@ -231,13 +250,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no wider than #{@width}, but it was #{@actual_width}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to be wider than #{@width}, but it is."
         end
 
         def description
           "have a width less than or equal to #{@width}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_wider_than(width)
@@ -261,19 +283,55 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no taller than #{@height}, but it was #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to be taller than #{@height}, but it is."
         end
 
         def description
           "have a height less than or equal to #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_taller_than(height)
         BeNoTallerThan.new(height)
       end
 
+      class BeFormat # :nodoc:
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          image = ImageLoader.load_image(@actual.current_path)
+          @actual_expected = image.format
+          !@expected.nil? && @actual_expected.casecmp(@expected).zero?
+        end
+
+        def failure_message
+          "expected #{@actual.current_path.inspect} to have #{@expected} format, but it was #{@actual_expected}."
+        end
+
+        def failure_message_when_negated
+          "expected #{@actual.current_path.inspect} not to have #{@expected} format, but it did."
+        end
+
+        def description
+          "have #{@expected} format"
+        end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
+      end
+
+      def be_format(expected)
+        BeFormat.new(expected)
+      end
+
       class ImageLoader # :nodoc:
         def self.load_image(filename)
           if defined? ::MiniMagick
@@ -283,9 +341,11 @@ module CarrierWave
               begin
                 require 'rmagick'
               rescue LoadError
-                require 'RMagick'
-              rescue LoadError
-                puts "WARNING: Failed to require rmagick, image processing may fail!"
+                begin
+                  require 'RMagick'
+                rescue LoadError
+                  puts "WARNING: Failed to require rmagick, image processing may fail!"
+                end
               end
             end
             MagickWrapper.new(filename)
@@ -295,6 +355,7 @@ module CarrierWave
 
       class MagickWrapper # :nodoc:
         attr_reader :image
+
         def width
           image.columns
         end
@@ -303,6 +364,10 @@ module CarrierWave
           image.rows
         end
 
+        def format
+          image.format
+        end
+
         def initialize(filename)
           @image = ::Magick::Image.read(filename).first
         end
@@ -310,6 +375,7 @@ module CarrierWave
 
       class MiniMagickWrapper # :nodoc:
         attr_reader :image
+
         def width
           image[:width]
         end
@@ -318,6 +384,10 @@ module CarrierWave
           image[:height]
         end
 
+        def format
+          image[:format]
+        end
+
         def initialize(filename)
           @image = ::MiniMagick::Image.open(filename)
         end
@@ -326,4 +396,3 @@ module CarrierWave
     end # Matchers
   end # Test
 end # CarrierWave
-

data/lib/carrierwave/uploader/cache.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+require 'securerandom'
 
 module CarrierWave
 
@@ -24,10 +24,11 @@ module CarrierWave
   # [String] a cache id in the format TIMEINT-PID-COUNTER-RND
   #
   def self.generate_cache_id
-    [Time.now.utc.to_i,
-      Process.pid,
-      '%04d' % (CarrierWave::CacheCounter.increment % 1000),
-      '%04d' % rand(9999)
+    [
+      Time.now.utc.to_i,
+      SecureRandom.random_number(1_000_000_000_000_000),
+      '%04d' % (CarrierWave::CacheCounter.increment % 10_000),
+      '%04d' % SecureRandom.random_number(10_000)
     ].map(&:to_s).join('-')
   end
 
@@ -38,6 +39,16 @@ module CarrierWave
       include CarrierWave::Uploader::Callbacks
       include CarrierWave::Uploader::Configuration
 
+      included do
+        prepend Module.new {
+          def initialize(*)
+            super
+            @staged = false
+          end
+        }
+        attr_accessor :staged
+      end
+
       module ClassMethods
 
         ##
@@ -54,13 +65,7 @@ module CarrierWave
         # It's recommended that you keep cache files in one place only.
         #
         def clean_cached_files!(seconds=60*60*24)
-          Dir.glob(File.expand_path(File.join(cache_dir, '*'), CarrierWave.root)).each do |dir|
-            time = dir.scan(/(\d+)-\d+-\d+/).first.map { |t| t.to_i }
-            time = Time.at(*time)
-            if time < (Time.now.utc - seconds)
-              FileUtils.rm_rf(dir)
-            end
-          end
+          (cache_storage || storage).new(new).clean_cache!(seconds)
         end
       end
 
@@ -72,7 +77,7 @@ module CarrierWave
       # [Bool] whether the current file is cached
       #
       def cached?
-        @cache_id
+        !!@cache_id
       end
 
       ##
@@ -86,16 +91,8 @@ module CarrierWave
       end
 
       def sanitized_file
-        _content = file.read
-        if _content.is_a?(File) # could be if storage is Fog
-          sanitized = CarrierWave::Storage::Fog.new(self).retrieve!(File.basename(_content.path))
-          sanitized.read if sanitized.exists?
-
-        else
-          sanitized = SanitizedFile.new :tempfile => StringIO.new(file.read),
-            :filename => File.basename(path), :content_type => file.content_type
-        end
-        sanitized
+        ActiveSupport::Deprecation.warn('#sanitized_file is deprecated, use #file instead.')
+        file
       end
 
       ##
@@ -106,7 +103,7 @@ module CarrierWave
       # [String] a cache name, in the format TIMEINT-PID-COUNTER-RND/filename.txt
       #
       def cache_name
-        File.join(cache_id, full_original_filename) if cache_id and original_filename
+        File.join(cache_id, original_filename) if cache_id && original_filename
       end
 
       ##
@@ -114,7 +111,7 @@ module CarrierWave
       #
       # By default, cache!() uses copy_to(), which operates by copying the file
       # to the cache, then deleting the original file.  If move_to_cache() is
-      # overriden to return true, then cache!() uses move_to(), which simply
+      # overridden to return true, then cache!() uses move_to(), which simply
       # moves the file to the cache.  Useful for large files.
       #
       # === Parameters
@@ -125,24 +122,32 @@ module CarrierWave
       #
       # [CarrierWave::FormNotMultipart] if the assigned parameter is a string
       #
-      def cache!(new_file = sanitized_file)
+      def cache!(new_file = file)
         new_file = CarrierWave::SanitizedFile.new(new_file)
+        return if new_file.empty?
+
+        raise CarrierWave::FormNotMultipart if new_file.is_path? && ensure_multipart_form
 
-        unless new_file.empty?
-          raise CarrierWave::FormNotMultipart if new_file.is_path? && ensure_multipart_form
+        self.cache_id = CarrierWave.generate_cache_id unless cache_id
 
-          with_callbacks(:cache, new_file) do
-            self.cache_id = CarrierWave.generate_cache_id unless cache_id
+        @identifier = nil
+        @staged = true
+        @filename = new_file.filename
+        self.original_filename = new_file.filename
 
-            @filename = new_file.filename
-            self.original_filename = new_file.filename
+        begin
+          # first, create a workfile on which we perform processings
+          if move_to_cache
+            @file = new_file.move_to(File.expand_path(workfile_path, root), permissions, directory_permissions)
+          else
+            @file = new_file.copy_to(File.expand_path(workfile_path, root), permissions, directory_permissions)
+          end
 
-            if move_to_cache
-              @file = new_file.move_to(cache_path, permissions, directory_permissions)
-            else
-              @file = new_file.copy_to(cache_path, permissions, directory_permissions)
-            end
+          with_callbacks(:cache, @file) do
+            @file = cache_storage.cache!(@file)
           end
+        ensure
+          FileUtils.rm_rf(workfile_path(''))
         end
       end
 
@@ -160,26 +165,43 @@ module CarrierWave
       def retrieve_from_cache!(cache_name)
         with_callbacks(:retrieve_from_cache, cache_name) do
           self.cache_id, self.original_filename = cache_name.to_s.split('/', 2)
+          @staged = true
           @filename = original_filename
-          @file = CarrierWave::SanitizedFile.new(cache_path)
+          @file = cache_storage.retrieve_from_cache!(full_original_filename)
         end
       end
 
+      ##
+      # Calculates the path where the cache file should be stored.
+      #
+      # === Parameters
+      #
+      # [for_file (String)] name of the file <optional>
+      #
+      # === Returns
+      #
+      # [String] the cache path
+      #
+      def cache_path(for_file=full_original_filename)
+        File.join(*[cache_dir, @cache_id, for_file].compact)
+      end
+
+    protected
+
+      attr_reader :cache_id
+
     private
 
-      def cache_path
-        File.expand_path(File.join(cache_dir, cache_name), root)
+      def workfile_path(for_file=original_filename)
+        File.join(CarrierWave.tmp_path, @cache_id, version_name.to_s, for_file)
       end
 
-      attr_reader :cache_id, :original_filename
-
-      # We can override the full_original_filename method in other modules
-      alias_method :full_original_filename, :original_filename
+      attr_reader :original_filename
 
       def cache_id=(cache_id)
         # Earlier version used 3 part cache_id. Thus we should allow for
         # the cache_id to have both 3 part and 4 part formats.
-        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A[\d]+\-[\d]+(\-[\d]{4})?\-[\d]{4}\z/
+        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A(-)?[\d]+\-[\d]+(\-[\d]{4})?\-[\d]{4}\z/
         @cache_id = cache_id
       end
 
@@ -188,6 +210,14 @@ module CarrierWave
         @original_filename = filename
       end
 
+      def cache_storage
+        @cache_storage ||= (self.class.cache_storage || self.class.storage).new(self)
+      end
+
+      # We can override the full_original_filename method in other modules
+      def full_original_filename
+        forcing_extension(original_filename)
+      end
     end # Cache
   end # Uploader
 end # CarrierWave

data/lib/carrierwave/uploader/callbacks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Callbacks
@@ -7,7 +5,7 @@ module CarrierWave
 
       included do
         class_attribute :_before_callbacks, :_after_callbacks,
-          :instance_writer => false
+                        :instance_writer => false
         self._before_callbacks = Hash.new []
         self._after_callbacks = Hash.new []
       end

data/lib/carrierwave/uploader/configuration.rb

@@ -1,3 +1,5 @@
+require 'carrierwave/downloader/base'
+
 module CarrierWave
 
   module Uploader
@@ -5,7 +7,7 @@ module CarrierWave
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :_storage, :instance_writer => false
+        class_attribute :_storage, :_cache_storage, :instance_writer => false
 
         add_config :root
         add_config :base_path
@@ -21,14 +23,18 @@ module CarrierWave
         add_config :move_to_cache
         add_config :move_to_store
         add_config :remove_previously_stored_files_after_update
+        add_config :downloader
+        add_config :force_extension
 
         # fog
+        add_deprecated_config :fog_provider
         add_config :fog_attributes
         add_config :fog_credentials
         add_config :fog_directory
         add_config :fog_public
         add_config :fog_authenticated_url_expiration
         add_config :fog_use_ssl_for_aws
+        add_config :fog_aws_accelerate
 
         # Mounting
         add_config :ignore_integrity_errors
@@ -38,6 +44,9 @@ module CarrierWave
         add_config :validate_processing
         add_config :validate_download
         add_config :mount_on
+        add_config :cache_only
+        add_config :download_retry_count
+        add_config :download_retry_wait_time
 
         # set default values
         reset_config
@@ -69,36 +78,66 @@ module CarrierWave
         #     storage MyCustomStorageEngine
         #
         def storage(storage = nil)
-          if storage
-            self._storage = storage.is_a?(Symbol) ? eval(storage_engines[storage]) : storage
+          case storage
+          when Symbol
+            if (storage_engine = storage_engines[storage])
+              self._storage = eval storage_engine
+            else
+              raise CarrierWave::UnknownStorageError, "Unknown storage: #{storage}"
+            end
+          when nil
+            storage
+          else
+            self._storage = storage
           end
           _storage
         end
         alias_method :storage=, :storage
 
+        ##
+        # Sets the cache storage engine to be used when storing cache files with this uploader.
+        # Same as .storage except for required methods being #cache!(CarrierWave::SanitizedFile),
+        # #retrieve_from_cache! and #delete_dir!.
+        #
+        # === Parameters
+        #
+        # [storage (Symbol, Class)] The cache storage engine to use for this uploader
+        #
+        # === Returns
+        #
+        # [Class] the cache storage engine to be used with this uploader
+        #
+        # === Examples
+        #
+        #     cache_storage :file
+        #     cache_storage CarrierWave::Storage::File
+        #     cache_storage MyCustomStorageEngine
+        #
+        def cache_storage(storage = false)
+          unless storage == false
+            self._cache_storage = storage.is_a?(Symbol) ? eval(storage_engines[storage]) : storage
+          end
+          _cache_storage
+        end
+        alias_method :cache_storage=, :cache_storage
+
         def add_config(name)
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def self.eager_load_fog(fog_credentials)
-              # see #1198. This will hopefully no longer be necessary after fog 2.0
-              Fog::Storage.new(fog_credentials) if fog_credentials.present?
-            end
+            @#{name} = nil
 
             def self.#{name}(value=nil)
-              @#{name} = value if value
-              eager_load_fog(value) if value && '#{name}' == 'fog_credentials'
+              @#{name} = value unless value.nil?
               return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
               name = superclass.#{name}
-              return nil if name.nil? && !instance_variable_defined?("@#{name}")
+              return nil if name.nil? && !instance_variable_defined?(:@#{name})
               @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
             end
 
             def self.#{name}=(value)
-              eager_load_fog(value) if '#{name}' == 'fog_credentials'
               @#{name} = value
             end
 
             def #{name}=(value)
-              self.class.eager_load_fog(value) if '#{name}' == 'fog_credentials'
               @#{name} = value
             end
 
@@ -107,13 +146,33 @@ module CarrierWave
               value = self.class.#{name} unless instance_variable_defined?(:@#{name})
               if value.instance_of?(Proc)
                 value.arity >= 1 ? value.call(self) : value.call
-              else 
+              else
                 value
               end
             end
           RUBY
         end
 
+        def add_deprecated_config(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{name}(value=nil)
+              ActiveSupport::Deprecation.warn "##{name} is deprecated and has no effect"
+            end
+
+            def self.#{name}=(value)
+              ActiveSupport::Deprecation.warn "##{name} is deprecated and has no effect"
+            end
+
+            def #{name}=(value)
+              ActiveSupport::Deprecation.warn "##{name} is deprecated and has no effect"
+            end
+
+            def #{name}
+              ActiveSupport::Deprecation.warn "##{name} is deprecated and has no effect"
+            end
+          RUBY
+        end
+
         def configure
           yield self
         end
@@ -123,24 +182,28 @@ module CarrierWave
         #
         def reset_config
           configure do |config|
-            config.permissions = 0644
-            config.directory_permissions = 0755
+            config.permissions = 0o644
+            config.directory_permissions = 0o755
             config.storage_engines = {
               :file => "CarrierWave::Storage::File",
               :fog  => "CarrierWave::Storage::Fog"
             }
             config.storage = :file
+            config.cache_storage = nil
             config.fog_attributes = {}
             config.fog_credentials = {}
             config.fog_public = true
             config.fog_authenticated_url_expiration = 600
             config.fog_use_ssl_for_aws = true
+            config.fog_aws_accelerate = false
             config.store_dir = 'uploads'
             config.cache_dir = 'uploads/tmp'
             config.delete_tmp_file_after_storage = true
             config.move_to_cache = false
             config.move_to_store = false
             config.remove_previously_stored_files_after_update = true
+            config.downloader = CarrierWave::Downloader::Base
+            config.force_extension = false
             config.ignore_integrity_errors = true
             config.ignore_processing_errors = true
             config.ignore_download_errors = true
@@ -151,6 +214,8 @@ module CarrierWave
             config.base_path = CarrierWave.base_path
             config.enable_processing = true
             config.ensure_multipart_form = true
+            config.download_retry_count = 0
+            config.download_retry_wait_time = 5
           end
         end
       end
@@ -158,4 +223,3 @@ module CarrierWave
     end
   end
 end
-