carrierwave 0.11.0 → 1.0.0

data/lib/carrierwave/orm/activerecord.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'active_record'
 require 'carrierwave/validations/active_model'
 
@@ -14,6 +12,35 @@ module CarrierWave
     def mount_uploader(column, uploader=nil, options={}, &block)
       super
 
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def remote_#{column}_url=(url)
+          column = _mounter(:#{column}).serialization_column
+          send(:"\#{column}_will_change!")
+          super
+        end
+      RUBY
+    end
+
+    ##
+    # See +CarrierWave::Mount#mount_uploaders+ for documentation
+    #
+    def mount_uploaders(column, uploader=nil, options={}, &block)
+      super
+
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def remote_#{column}_urls=(url)
+          column = _mounter(:#{column}).serialization_column
+          send(:"\#{column}_will_change!")
+          super
+        end
+      RUBY
+    end
+
+  private
+
+    def mount_base(column, uploader=nil, options={}, &block)
+      super
+
       alias_method :read_uploader, :read_attribute
       alias_method :write_uploader, :write_attribute
       public :read_uploader
@@ -29,43 +56,45 @@ module CarrierWave
       before_save :"write_#{column}_identifier"
       after_commit :"remove_#{column}!", :on => :destroy
       after_commit :"mark_remove_#{column}_false", :on => :update
-      before_update :"store_previous_model_for_#{column}"
-      after_save :"remove_previously_stored_#{column}"
+
+      after_save :"store_previous_changes_for_#{column}"
+      after_commit :"remove_previously_stored_#{column}", :on => :update
 
       class_eval <<-RUBY, __FILE__, __LINE__+1
         def #{column}=(new_file)
           column = _mounter(:#{column}).serialization_column
-          send(:"\#{column}_will_change!")
+          if !(new_file.blank? && send(:#{column}).blank?)
+            send(:"\#{column}_will_change!")
+          end
+
           super
         end
 
-        def remote_#{column}_url=(url)
+        def remove_#{column}=(value)
           column = _mounter(:#{column}).serialization_column
           send(:"\#{column}_will_change!")
           super
         end
 
         def remove_#{column}!
+          self.remove_#{column} = true
+          write_#{column}_identifier
+          self.remove_#{column} = false
           super
-          _mounter(:#{column}).remove = true
-          _mounter(:#{column}).write_identifier
         end
 
-        def serializable_hash(options=nil)
-          hash = {}
-
-          except = options && options[:except] && Array.wrap(options[:except]).map(&:to_s)
-          only   = options && options[:only]   && Array.wrap(options[:only]).map(&:to_s)
+        # Reset cached mounter on record reload
+        def reload(*)
+          @_mounters = nil
+          super
+        end
 
-          self.class.uploaders.each do |column, uploader|
-            if (!only && !except) || (only && only.include?(column.to_s)) || (!only && except && !except.include?(column.to_s))
-              hash[column.to_s] = _mounter(column).uploader.serializable_hash
-            end
-          end
-          super(options).merge(hash)
+        # Reset cached mounter on record dup
+        def initialize_dup(other)
+          @_mounters = nil
+          super
         end
       RUBY
-
     end
 
   end # ActiveRecord

data/lib/carrierwave/processing/mini_magick.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
 
   ##
@@ -39,6 +37,7 @@ module CarrierWave
   #           img
   #         end
   #       end
+  #     end
   #
   # === Note
   #
@@ -49,7 +48,7 @@ module CarrierWave
   #
   # http://mini_magick.rubyforge.org/
   # and
-  # https://github.com/minimagic/minimagick/
+  # https://github.com/minimagick/minimagick/
   #
   #
   module MiniMagick
@@ -81,7 +80,7 @@ module CarrierWave
         process :resize_to_fill => [width, height, gravity]
       end
 
-      def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
+      def resize_and_pad(width, height, background=:transparent, gravity='Center')
         process :resize_and_pad => [width, height, background, gravity]
       end
     end
@@ -103,10 +102,10 @@ module CarrierWave
     #
     #     image.convert(:png)
     #
-    def convert(format)
+    def convert(format, page=nil)
       @format = format
+      @page = page
       manipulate! do |img|
-        img.format(format.to_s.downcase)
         img = yield(img) if block_given?
         img
       end
@@ -127,9 +126,12 @@ module CarrierWave
     #
     # [MiniMagick::Image] additional manipulations to perform
     #
-    def resize_to_limit(width, height)
+    def resize_to_limit(width, height, combine_options: {})
       manipulate! do |img|
-        img.resize "#{width}x#{height}>"
+        img.combine_options do |cmd|
+          cmd.resize "#{width}x#{height}>"
+          append_combine_options cmd, combine_options
+        end
         img = yield(img) if block_given?
         img
       end
@@ -149,9 +151,12 @@ module CarrierWave
     #
     # [MiniMagick::Image] additional manipulations to perform
     #
-    def resize_to_fit(width, height)
+    def resize_to_fit(width, height, combine_options: {})
       manipulate! do |img|
-        img.resize "#{width}x#{height}"
+        img.combine_options do |cmd|
+          cmd.resize "#{width}x#{height}"
+          append_combine_options cmd, combine_options
+        end
         img = yield(img) if block_given?
         img
       end
@@ -172,7 +177,7 @@ module CarrierWave
     #
     # [MiniMagick::Image] additional manipulations to perform
     #
-    def resize_to_fill(width, height, gravity = 'Center')
+    def resize_to_fill(width, height, gravity = 'Center', combine_options: {})
       manipulate! do |img|
         cols, rows = img[:dimensions]
         img.combine_options do |cmd|
@@ -192,6 +197,7 @@ module CarrierWave
           cmd.gravity gravity
           cmd.background "rgba(255,255,255,0.0)"
           cmd.extent "#{width}x#{height}" if cols != width || rows != height
+          append_combine_options cmd, combine_options
         end
         img = yield(img) if block_given?
         img
@@ -218,7 +224,7 @@ module CarrierWave
     #
     # [MiniMagick::Image] additional manipulations to perform
     #
-    def resize_and_pad(width, height, background=:transparent, gravity='Center')
+    def resize_and_pad(width, height, background=:transparent, gravity='Center', combine_options: {})
       manipulate! do |img|
         img.combine_options do |cmd|
           cmd.thumbnail "#{width}x#{height}>"
@@ -229,12 +235,35 @@ module CarrierWave
           end
           cmd.gravity gravity
           cmd.extent "#{width}x#{height}"
+          append_combine_options cmd, combine_options
         end
         img = yield(img) if block_given?
         img
       end
     end
 
+    ##
+    # Returns the width of the image in pixels.
+    #
+    # === Returns
+    #
+    # [Integer] the image's width in pixels
+    #
+    def width
+      mini_magick_image[:width]
+    end
+
+    ##
+    # Returns the height of the image in pixels.
+    #
+    # === Returns
+    #
+    # [Integer] the image's height in pixels
+    #
+    def height
+      mini_magick_image[:height]
+    end
+
     ##
     # Manipulate the image with MiniMagick. This method will load up an image
     # and then pass each of its frames to the supplied block. It will then
@@ -260,9 +289,15 @@ module CarrierWave
       image = ::MiniMagick::Image.open(current_path)
 
       begin
-        image.format(@format.to_s.downcase) if @format
+        image.format(@format.to_s.downcase, @page) if @format
         image = yield(image)
         image.write(current_path)
+
+        if @format
+          move_to = current_path.chomp(File.extname(current_path)) + ".#{@format}"
+          file.move_to(move_to, permissions, directory_permissions)
+        end
+
         image.run_command("identify", current_path)
       ensure
         image.destroy!
@@ -273,5 +308,21 @@ module CarrierWave
       raise CarrierWave::ProcessingError, message
     end
 
+    private
+
+      def append_combine_options(cmd, combine_options)
+        combine_options.each do |method, options|
+          cmd.send(method, options)
+        end
+      end
+
+      def mini_magick_image
+        if url
+          ::MiniMagick::Image.open(url)
+        else
+          ::MiniMagick::Image.open(current_path)
+        end
+      end
+
   end # MiniMagick
 end # CarrierWave

data/lib/carrierwave/processing/rmagick.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
 
   ##
@@ -251,6 +249,28 @@ module CarrierWave
       end
     end
 
+    ##
+    # Returns the width of the image.
+    #
+    # === Returns
+    #
+    # [Integer] the image's width in pixels
+    #
+    def width
+      rmagick_image.columns
+    end
+
+    ##
+    # Returns the height of the image.
+    #
+    # === Returns
+    #
+    # [Integer] the image's height in pixels
+    #
+    def height
+      rmagick_image.rows
+    end
+
     ##
     # Manipulate the image with RMagick. This method will load up an image
     # and then pass each of its frames to the supplied block. It will then
@@ -324,11 +344,15 @@ module CarrierWave
       frames.append(true) if block_given?
 
       write_block = create_info_block(options[:write])
+
       if options[:format] || @format
         frames.write("#{options[:format] || @format}:#{current_path}", &write_block)
+        move_to = current_path.chomp(File.extname(current_path)) + ".#{options[:format] || @format}"
+        file.move_to(move_to, permissions, directory_permissions)
       else
         frames.write(current_path, &write_block)
       end
+
       destroy_image(frames)
     rescue ::Magick::ImageMagickError => e
       raise CarrierWave::ProcessingError, I18n.translate(:"errors.messages.rmagick_processing_error", :e => e, :default => I18n.translate(:"errors.messages.rmagick_processing_error", :e => e, :locale => :en))
@@ -344,7 +368,11 @@ module CarrierWave
     end
 
     def destroy_image(image)
-      image.destroy! if image.respond_to?(:destroy!)
+      image.try(:destroy!)
+    end
+
+    def rmagick_image
+      ::Magick::Image.read(current_path).first
     end
 
   end # RMagick

data/lib/carrierwave/processing.rb

@@ -1,3 +1,2 @@
 require "carrierwave/processing/rmagick"
 require "carrierwave/processing/mini_magick"
-require "carrierwave/processing/mime_types"

data/lib/carrierwave/sanitized_file.rb

@@ -1,8 +1,12 @@
-# encoding: utf-8
-
 require 'pathname'
 require 'active_support/core_ext/string/multibyte'
-require 'mime/types'
+
+begin
+  # Use mime/types/columnar if available, for reduced memory usage
+  require 'mime/types/columnar'
+rescue LoadError
+  require 'mime/types'
+end
 
 module CarrierWave
 
@@ -22,7 +26,7 @@ module CarrierWave
       attr_writer :sanitize_regexp
 
       def sanitize_regexp
-        @sanitize_regexp ||= /[^a-zA-Z0-9\.\-\+_]/
+        @sanitize_regexp ||= /[^[:word:]\.\-\+]/
       end
     end
 
@@ -142,8 +146,7 @@ module CarrierWave
     # [Boolean] Whether the file exists
     #
     def exists?
-      return File.exists?(self.path) if self.path
-      return false
+      self.path.present? && File.exist?(self.path)
     end
 
     ##
@@ -159,9 +162,9 @@ module CarrierWave
       elsif is_path?
         File.open(@file, "rb") {|file| file.read}
       else
-        @file.rewind if @file.respond_to?(:rewind)
+        @file.try(:rewind)
         @content = @file.read
-        @file.close if @file.respond_to?(:close) && @file.respond_to?(:closed?) && !@file.closed?
+        @file.try(:close) unless @file.try(:closed?)
         @content
       end
     end
@@ -175,19 +178,29 @@ module CarrierWave
     # [permissions (Integer)] permissions to set on the file in its new location.
     # [directory_permissions (Integer)] permissions to set on created directories.
     #
-    def move_to(new_path, permissions=nil, directory_permissions=nil)
+    def move_to(new_path, permissions=nil, directory_permissions=nil, keep_filename=false)
       return if self.empty?
       new_path = File.expand_path(new_path)
 
       mkdir!(new_path, directory_permissions)
+      move!(new_path)
+      chmod!(new_path, permissions)
+      if keep_filename
+        self.file = {:tempfile => new_path, :filename => original_filename}
+      else
+        self.file = new_path
+      end
+      self
+    end
+    ##
+    # Helper to move file to new path.
+    #
+    def move!(new_path)
       if exists?
         FileUtils.mv(path, new_path) unless new_path == path
       else
         File.open(new_path, "wb") { |f| f.write(read) }
       end
-      chmod!(new_path, permissions)
-      self.file = new_path
-      self
     end
 
     ##
@@ -208,13 +221,20 @@ module CarrierWave
       new_path = File.expand_path(new_path)
 
       mkdir!(new_path, directory_permissions)
+      copy!(new_path)
+      chmod!(new_path, permissions)
+      self.class.new({:tempfile => new_path, :content_type => content_type})
+    end
+
+    ##
+    # Helper to create copy of file in new path.
+    #
+    def copy!(new_path)
       if exists?
         FileUtils.cp(path, new_path) unless new_path == path
       else
         File.open(new_path, "wb") { |f| f.write(read) }
       end
-      chmod!(new_path, permissions)
-      self.class.new({:tempfile => new_path, :content_type => content_type})
     end
 
     ##
@@ -280,7 +300,7 @@ module CarrierWave
       if file.is_a?(Hash)
         @file = file["tempfile"] || file[:tempfile]
         @original_filename = file["filename"] || file[:filename]
-        @content_type = file["content_type"] || file[:content_type]
+        @content_type = file["content_type"] || file[:content_type] || file["type"] || file[:type]
       else
         @file = file
         @original_filename = nil
@@ -292,7 +312,7 @@ module CarrierWave
     def mkdir!(path, directory_permissions)
       options = {}
       options[:mode] = directory_permissions if directory_permissions
-      FileUtils.mkdir_p(File.dirname(path), options) unless File.exists?(File.dirname(path))
+      FileUtils.mkdir_p(File.dirname(path), options) unless File.exist?(File.dirname(path))
     end
 
     def chmod!(path, permissions)
@@ -301,7 +321,7 @@ module CarrierWave
 
     # Sanitize the filename, to prevent hacking
     def sanitize(name)
-      name = name.gsub("\\", "/") # work-around for IE
+      name = name.tr("\\", "/") # work-around for IE
       name = File.basename(name)
       name = name.gsub(sanitize_regexp,"_")
       name = "_#{name}" if name =~ /\A\.+\z/

data/lib/carrierwave/storage/abstract.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Storage
 
@@ -25,6 +23,21 @@ module CarrierWave
       def retrieve!(identifier)
       end
 
+      def cache!(new_file)
+        raise NotImplementedError.new("Need to implement #cache! if you want to use #{self.class.name} as a cache storage.")
+      end
+
+      def retrieve_from_cache!(identifier)
+        raise NotImplementedError.new("Need to implement #retrieve_from_cache! if you want to use #{self.class.name} as a cache storage.")
+      end
+
+      def delete_dir!(path)
+        raise NotImplementedError.new("Need to implement #delete_dir! if you want to use #{self.class.name} as a cache storage.")
+      end
+
+      def clean_cache!(seconds)
+        raise NotImplementedError.new("Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage.")
+      end
     end # Abstract
   end # Storage
 end # CarrierWave

data/lib/carrierwave/storage/file.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Storage
 
@@ -51,6 +49,71 @@ module CarrierWave
         CarrierWave::SanitizedFile.new(path)
       end
 
+      ##
+      # Stores given file to cache directory.
+      #
+      # === Parameters
+      #
+      # [new_file (File, IOString, Tempfile)] any kind of file object
+      #
+      # === Returns
+      #
+      # [CarrierWave::SanitizedFile] a sanitized file
+      #
+      def cache!(new_file)
+        new_file.move_to(::File.expand_path(uploader.cache_path, uploader.root), uploader.permissions, uploader.directory_permissions, true)
+      rescue Errno::EMLINK => e
+        raise(e) if @cache_called
+        @cache_called = true
+
+        # NOTE: Remove cached files older than 10 minutes
+        clean_cache!(600)
+
+        cache!(new_file)
+      end
+
+      ##
+      # Retrieves the file with the given cache_name from the cache.
+      #
+      # === Parameters
+      #
+      # [cache_name (String)] uniquely identifies a cache file
+      #
+      # === Raises
+      #
+      # [CarrierWave::InvalidParameter] if the cache_name is incorrectly formatted.
+      #
+      def retrieve_from_cache!(identifier)
+        CarrierWave::SanitizedFile.new(::File.expand_path(uploader.cache_path(identifier), uploader.root))
+      end
+
+      ##
+      # Deletes a cache dir
+      #
+      def delete_dir!(path)
+        if path
+          begin
+            Dir.rmdir(::File.expand_path(path, uploader.root))
+          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
+          end
+        end
+      end
+
+      def clean_cache!(seconds)
+        Dir.glob(::File.expand_path(::File.join(uploader.cache_dir, '*'), CarrierWave.root)).each do |dir|
+          # generate_cache_id returns key formated TIMEINT-PID-COUNTER-RND
+          time = dir.scan(/(\d+)-\d+-\d+-\d+/).first.map(&:to_i)
+          time = Time.at(*time)
+          if time < (Time.now.utc - seconds)
+            FileUtils.rm_rf(dir)
+          end
+        end
+      end
     end # File
   end # Storage
 end # CarrierWave