kt-paperclip 5.4.0 → 7.1.1

data/lib/paperclip/attachment.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
-require 'uri'
-require 'paperclip/url_generator'
-require 'active_support/deprecation'
-require 'active_support/core_ext/string/inflections'
+require "uri"
+require "paperclip/url_generator"
+require "active_support/deprecation"
+require "active_support/core_ext/string/inflections"
 
 module Paperclip
   # The Attachment class manages the files for a given attachment. It saves
@@ -11,35 +10,35 @@ module Paperclip
   class Attachment
     def self.default_options
       @default_options ||= {
-        :convert_options       => {},
-        :default_style         => :original,
-        :default_url           => "/:attachment/:style/missing.png",
-        :escape_url            => true,
-        :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/,
-        :filename_cleaner      => nil,
-        :hash_data             => ":class/:attachment/:id/:style/:updated_at",
-        :hash_digest           => "SHA1",
-        :interpolator          => Paperclip::Interpolations,
-        :only_process          => [],
-        :path                  => ":rails_root/public:url",
-        :preserve_files        => false,
-        :processors            => [:thumbnail],
-        :source_file_options   => {},
-        :storage               => :filesystem,
-        :styles                => {},
-        :url                   => "/system/:class/:attachment/:id_partition/:style/:filename",
-        :url_generator         => Paperclip::UrlGenerator,
-        :use_default_time_zone => true,
-        :use_timestamp         => true,
-        :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
-        :validate_media_type   => true,
-        :adapter_options       => { hash_digest: Digest::MD5 },
-        :check_validity_before_processing => true
+        convert_options:                  {},
+        default_style:                    :original,
+        default_url:                      "/:attachment/:style/missing.png",
+        escape_url:                       true,
+        restricted_characters:            /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/,
+        filename_cleaner:                 nil,
+        hash_data:                        ":class/:attachment/:id/:style/:updated_at",
+        hash_digest:                      "SHA1",
+        interpolator:                     Paperclip::Interpolations,
+        only_process:                     [],
+        path:                             ":rails_root/public:url",
+        preserve_files:                   false,
+        processors:                       [:thumbnail],
+        source_file_options:              {},
+        storage:                          :filesystem,
+        styles:                           {},
+        url:                              "/system/:class/:attachment/:id_partition/:style/:filename",
+        url_generator:                    Paperclip::UrlGenerator,
+        use_default_time_zone:            true,
+        use_timestamp:                    true,
+        whiny:                            Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
+        validate_media_type:              true,
+        adapter_options:                  { hash_digest: Digest::MD5 },
+        check_validity_before_processing: true
       }
     end
 
     attr_reader :name, :instance, :default_style, :convert_options, :queued_for_write, :whiny,
-                :options, :interpolator, :source_file_options
+                :options, :interpolator, :source_file_options, :queued_for_delete
     attr_accessor :post_processing
 
     # Creates an Attachment object. +name+ is the name of the attachment,
@@ -113,8 +112,6 @@ module Paperclip
           post_process_file
           reset_file_if_original_reprocessed
         end
-      else
-        nil
       end
     end
 
@@ -143,7 +140,7 @@ module Paperclip
 
     def url(style_name = default_style, options = {})
       if options == true || options == false # Backwards compatibility.
-        @url_generator.for(style_name, default_options.merge(:timestamp => options))
+        @url_generator.for(style_name, default_options.merge(timestamp: options))
       else
         @url_generator.for(style_name, default_options.merge(options))
       end
@@ -151,15 +148,15 @@ module Paperclip
 
     def default_options
       {
-        :timestamp => @options[:use_timestamp],
-        :escape => @options[:escape_url]
+        timestamp: @options[:use_timestamp],
+        escape: @options[:escape_url]
       }
     end
 
     # Alias to +url+ that allows using the expiring_url method provided by the cloud
     # storage implementations, but keep using filesystem storage for development and
     # testing.
-    def expiring_url(time = 3600, style_name = default_style)
+    def expiring_url(_time = 3600, style_name = default_style)
       url(style_name)
     end
 
@@ -174,18 +171,16 @@ module Paperclip
 
     # :nodoc:
     def staged_path(style_name = default_style)
-      if staged?
-        @queued_for_write[style_name].path
-      end
+      @queued_for_write[style_name].path if staged?
     end
 
     # :nodoc:
     def staged?
-      ! @queued_for_write.empty?
+      !@queued_for_write.empty?
     end
 
     # Alias to +url+
-    def to_s style_name = default_style
+    def to_s(style_name = default_style)
       url(style_name)
     end
 
@@ -241,9 +236,7 @@ module Paperclip
     def save
       flush_deletes unless @options[:keep_old_files]
       process = only_process
-      if process.any? && !process.include?(:original)
-        @queued_for_write.except!(:original)
-      end
+      @queued_for_write.except!(:original) if process.any? && !process.include?(:original)
       flush_writes
       @dirty = false
       true
@@ -325,7 +318,8 @@ module Paperclip
     # publicly viewable attachment.
     def hash_key(style_name = default_style)
       raise ArgumentError, "Unable to generate hash without :hash_secret" unless @options[:hash_secret]
-      require 'openssl' unless defined?(OpenSSL)
+
+      require "openssl" unless defined?(OpenSSL)
       data = interpolate(@options[:hash_data], style_name)
       OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@options[:hash_digest]).new, @options[:hash_secret], data)
     end
@@ -338,8 +332,15 @@ module Paperclip
     # inconsistencies in timing of S3 commands. It's possible that calling
     # #reprocess! will lose data if the files are not kept.
     def reprocess!(*style_args)
-      saved_only_process, @options[:only_process] = @options[:only_process], style_args
-      saved_preserve_files, @options[:preserve_files] = @options[:preserve_files], true
+      saved_flags = @options.slice(
+        :only_process,
+        :preserve_files,
+        :check_validity_before_processing
+      )
+      @options[:only_process] = style_args
+      @options[:preserve_files] = true
+      @options[:check_validity_before_processing] = false
+
       begin
         assign(self)
         save
@@ -348,8 +349,7 @@ module Paperclip
         warn "#{e} - skipping file."
         false
       ensure
-        @options[:only_process] = saved_only_process
-        @options[:preserve_files] = saved_preserve_files
+        @options.merge!(saved_flags)
       end
     end
 
@@ -375,18 +375,14 @@ module Paperclip
     # "avatar_file_name" field (assuming the attachment is called avatar).
     def instance_write(attr, value)
       setter = :"#{@name_string}_#{attr}="
-      if instance.respond_to?(setter)
-        instance.send(setter, value)
-      end
+      instance.send(setter, value) if instance.respond_to?(setter)
     end
 
     # Reads the attachment-specific attribute on the instance. See instance_write
     # for more details.
     def instance_read(attr)
       getter = :"#{@name_string}_#{attr}"
-      if instance.respond_to?(getter)
-        instance.send(getter)
-      end
+      instance.send(getter) if instance.respond_to?(getter)
     end
 
     private
@@ -404,9 +400,7 @@ module Paperclip
     end
 
     def ensure_required_validations!
-      if missing_required_validator?
-        raise Paperclip::Errors::MissingRequiredValidatorError
-      end
+      raise Paperclip::Errors::MissingRequiredValidatorError if missing_required_validator?
     end
 
     def ensure_required_accessors! #:nodoc:
@@ -417,7 +411,7 @@ module Paperclip
       end
     end
 
-    def log message #:nodoc:
+    def log(message) #:nodoc:
       Paperclip.log(message)
     end
 
@@ -428,7 +422,7 @@ module Paperclip
       rescue NameError
         raise Errors::StorageMethodNotFound, "Cannot load storage module '#{storage_class_name}'"
       end
-      self.extend(storage_module)
+      extend(storage_module)
     end
 
     def assign_attributes
@@ -445,15 +439,11 @@ module Paperclip
     end
 
     def assign_fingerprint
-      if instance_respond_to?(:fingerprint)
-        instance_write(:fingerprint, yield)
-      end
+      instance_write(:fingerprint, yield) if instance_respond_to?(:fingerprint)
     end
 
     def assign_timestamps
-      if has_enabled_but_unset_created_at?
-        instance_write(:created_at, Time.now)
-      end
+      instance_write(:created_at, Time.now) if has_enabled_but_unset_created_at?
 
       instance_write(:updated_at, Time.now)
     end
@@ -461,9 +451,7 @@ module Paperclip
     def post_process_file
       dirty!
 
-      if post_processing
-        post_process(*only_process)
-      end
+      post_process(*only_process) if post_processing
     end
 
     def dirty!
@@ -477,9 +465,7 @@ module Paperclip
     end
 
     def reset_updater
-      if instance.respond_to?(updater)
-        instance.send(updater)
-      end
+      instance.send(updater) if instance.respond_to?(updater)
     end
 
     def updater
@@ -496,56 +482,63 @@ module Paperclip
 
     def process_options(options_type, style) #:nodoc:
       all_options   = @options[options_type][:all]
-      all_options   = all_options.call(instance)   if all_options.respond_to?(:call)
+      all_options   = all_options.call(instance) if all_options.respond_to?(:call)
       style_options = @options[options_type][style]
       style_options = style_options.call(instance) if style_options.respond_to?(:call)
 
-      [ style_options, all_options ].compact.join(" ")
+      [style_options, all_options].compact.join(" ")
     end
 
     def post_process(*style_args) #:nodoc:
       return if @queued_for_write[:original].nil?
-
-      instance.run_paperclip_callbacks(:post_process) do
-        instance.run_paperclip_callbacks(:"#{name}_post_process") do
-          if !@options[:check_validity_before_processing] || !instance.errors.any?
+      if !@options[:check_validity_before_processing] || check_validity?
+        instance.run_paperclip_callbacks(:post_process) do
+          instance.run_paperclip_callbacks(:"#{name}_post_process") do
             post_process_styles(*style_args)
           end
         end
       end
     end
 
+    def check_validity?
+      instance.run_paperclip_callbacks(:"#{name}_validate")
+      instance.errors.none?
+    end
+
     def post_process_styles(*style_args) #:nodoc:
-      post_process_style(:original, styles[:original]) if styles.include?(:original) && process_style?(:original, style_args)
-      styles.reject{ |name, style| name == :original }.each do |name, style|
+      if styles.include?(:original) && process_style?(:original, style_args)
+        post_process_style(:original, styles[:original])
+      end
+      styles.reject { |name, _style| name == :original }.each do |name, style|
         post_process_style(name, style) if process_style?(name, style_args)
       end
     end
 
     def post_process_style(name, style) #:nodoc:
-      begin
-        raise RuntimeError.new("Style #{name} has no processors defined.") if style.processors.blank?
-        intermediate_files = []
-        original = @queued_for_write[:original]
-
-        @queued_for_write[name] = style.processors.
-          reduce(original) do |file, processor|
-          file = Paperclip.processor(processor).make(file, style.processor_options, self)
-          intermediate_files << file unless file == @queued_for_write[:original]
-          file
-        end
-
-        unadapted_file = @queued_for_write[name]
-        @queued_for_write[name] = Paperclip.io_adapters.
-          for(@queued_for_write[name], @options[:adapter_options])
-        unadapted_file.close if unadapted_file.respond_to?(:close)
-        @queued_for_write[name]
-      rescue Paperclip::Errors::NotIdentifiedByImageMagickError => e
-        log("An error was received while processing: #{e.inspect}")
-        (@errors[:processing] ||= []) << e.message if @options[:whiny]
-      ensure
-        unlink_files(intermediate_files)
+      raise "Style #{name} has no processors defined." if style.processors.blank?
+
+      intermediate_files = []
+      original = @queued_for_write[:original]
+
+      @queued_for_write[name] = style.processors.
+                                inject(original) do |file, processor|
+        file = Paperclip.processor(processor).make(file, style.processor_options, self)
+        intermediate_files << file unless file == @queued_for_write[:original]
+        # if we're processing the original, close + unlink the source tempfile
+        @queued_for_write[:original].close(true) if name == :original
+        file
       end
+
+      unadapted_file = @queued_for_write[name]
+      @queued_for_write[name] = Paperclip.io_adapters.
+                                for(@queued_for_write[name], @options[:adapter_options])
+      unadapted_file.close if unadapted_file.respond_to?(:close)
+      @queued_for_write[name]
+    rescue Paperclip::Errors::NotIdentifiedByImageMagickError => e
+      log("An error was received while processing: #{e.inspect}")
+      (@errors[:processing] ||= []) << e.message if @options[:whiny]
+    ensure
+      unlink_files(intermediate_files)
     end
 
     def process_style?(style_name, style_args) #:nodoc:
@@ -564,6 +557,7 @@ module Paperclip
 
     def queue_all_for_delete #:nodoc:
       return if !file?
+
       unless @options[:preserve_files]
         @queued_for_delete += [:original, *styles.keys].uniq.map do |style|
           path(style) if exists?(style)
@@ -578,8 +572,8 @@ module Paperclip
     end
 
     def flush_errors #:nodoc:
-      @errors.each do |error, message|
-        [message].flatten.each {|m| instance.errors.add(name, m) }
+      @errors.each do |_error, message|
+        [message].flatten.each { |m| instance.errors.add(name, m) }
       end
     end
 
@@ -591,7 +585,11 @@ module Paperclip
     def unlink_files(files)
       Array(files).each do |file|
         file.close unless file.closed?
-        file.unlink if file.respond_to?(:unlink) && file.path.present? && File.exist?(file.path)
+
+        begin
+          file.unlink if file.respond_to?(:unlink)
+        rescue Errno::ENOENT
+        end
       end
     end
 

data/lib/paperclip/attachment_registry.rb

@@ -1,4 +1,4 @@
-require 'singleton'
+require "singleton"
 
 module Paperclip
   class AttachmentRegistry
@@ -35,7 +35,7 @@ module Paperclip
     end
 
     def clear
-      @attachments = Hash.new { |h,k| h[k] = {} }
+      @attachments = Hash.new { |h, k| h[k] = {} }
     end
 
     def names_for(klass)

data/lib/paperclip/content_type_detector.rb

@@ -60,16 +60,21 @@ module Paperclip
     end
 
     def type_from_file_contents
-      type_from_mime_magic || type_from_file_command
+      type_from_marcel || type_from_file_command
     rescue Errno::ENOENT => e
       Paperclip.log("Error while determining content type: #{e}")
       SENSIBLE_DEFAULT
     end
 
-    def type_from_mime_magic
-      @type_from_mime_magic ||= File.open(@filepath) do |file|
-        MimeMagic.by_magic(file).try(:type)
-      end
+    def type_from_marcel
+      return @type_from_marcel if defined? @type_from_marcel
+
+      @type_from_marcel = Marcel::MimeType.for Pathname.new(@filepath),
+                                               name: @filepath
+      # Marcel::MineType returns 'application/octet-stream' if it can't find
+      # a valid type.
+      @type_from_marcel = nil if @type_from_marcel == SENSIBLE_DEFAULT
+      @type_from_marcel
     end
 
     def type_from_file_command

data/lib/paperclip/file_command_content_type_detector.rb

@@ -21,9 +21,7 @@ module Paperclip
                SENSIBLE_DEFAULT
              end
 
-      if type.nil? || type.match(/\(.*?\)/)
-        type = SENSIBLE_DEFAULT
-      end
+      type = SENSIBLE_DEFAULT if type.nil? || type.match(/\(.*?\)/)
       type.split(/[:;\s]+/)[0]
     end
   end

data/lib/paperclip/filename_cleaner.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Paperclip
   class FilenameCleaner
     def initialize(invalid_character_regex)

data/lib/paperclip/geometry.rb

@@ -1,10 +1,9 @@
 module Paperclip
-
   # Defines the geometry of an image.
   class Geometry
     attr_accessor :height, :width, :modifier
 
-    EXIF_ROTATED_ORIENTATION_VALUES = [5, 6, 7, 8]
+    EXIF_ROTATED_ORIENTATION_VALUES = [5, 6, 7, 8].freeze
 
     # Gives a Geometry representing the given height and width
     def initialize(width = nil, height = nil, modifier = nil)
@@ -92,16 +91,16 @@ module Paperclip
     # destination Geometry would be completely filled by the source image, and any
     # overhanging image would be cropped. Useful for square thumbnail images. The cropping
     # is weighted at the center of the Geometry.
-    def transformation_to dst, crop = false
+    def transformation_to(dst, crop = false)
       if crop
-        ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
+        ratio = Geometry.new(dst.width / width, dst.height / height)
         scale_geometry, scale = scaling(dst, ratio)
         crop_geometry         = cropping(dst, ratio, scale)
       else
-        scale_geometry        = dst.to_s
+        scale_geometry = dst.to_s
       end
 
-      [ scale_geometry, crop_geometry ]
+      [scale_geometry, crop_geometry]
     end
 
     # resize to a new geometry
@@ -112,16 +111,16 @@ module Paperclip
     def resize_to(geometry)
       new_geometry = Paperclip::Geometry.parse geometry
       case new_geometry.modifier
-      when '!', '#'
+      when "!", "#"
         new_geometry
-      when '>'
-        if new_geometry.width >= self.width && new_geometry.height >= self.height
+      when ">"
+        if new_geometry.width >= width && new_geometry.height >= height
           self
         else
           scale_to new_geometry
         end
-      when '<'
-        if new_geometry.width <= self.width || new_geometry.height <= self.height
+      when "<"
+        if new_geometry.width <= width || new_geometry.height <= height
           self
         else
           scale_to new_geometry
@@ -133,26 +132,26 @@ module Paperclip
 
     private
 
-    def scaling dst, ratio
+    def scaling(dst, ratio)
       if ratio.horizontal? || ratio.square?
-        [ "%dx" % dst.width, ratio.width ]
+        ["%dx" % dst.width, ratio.width]
       else
-        [ "x%d" % dst.height, ratio.height ]
+        ["x%d" % dst.height, ratio.height]
       end
     end
 
-    def cropping dst, ratio, scale
+    def cropping(dst, ratio, scale)
       if ratio.horizontal? || ratio.square?
-        "%dx%d+%d+%d" % [ dst.width, dst.height, 0, (self.height * scale - dst.height) / 2 ]
+        "%dx%d+%d+%d" % [dst.width, dst.height, 0, (height * scale - dst.height) / 2]
       else
-        "%dx%d+%d+%d" % [ dst.width, dst.height, (self.width * scale - dst.width) / 2, 0 ]
+        "%dx%d+%d+%d" % [dst.width, dst.height, (width * scale - dst.width) / 2, 0]
       end
     end
 
     # scale to the requested geometry and preserve the aspect ratio
     def scale_to(new_geometry)
-      scale = [new_geometry.width.to_f / self.width.to_f , new_geometry.height.to_f / self.height.to_f].min
-      Paperclip::Geometry.new((self.width * scale).round, (self.height * scale).round)
+      scale = [new_geometry.width.to_f / width.to_f, new_geometry.height.to_f / height.to_f].min
+      Paperclip::Geometry.new((width * scale).round, (height * scale).round)
     end
   end
 end

data/lib/paperclip/geometry_detector_factory.rb

@@ -13,22 +13,19 @@ module Paperclip
     private
 
     def geometry_string
-      begin
-        orientation = Paperclip.options[:use_exif_orientation] ?
-          "%[exif:orientation]" : "1"
-        Paperclip.run(
-          "identify",
-          "-format '%wx%h,#{orientation}' :file", {
-            :file => "#{path}[0]"
-          }, {
-            :swallow_stderr => true
-          }
-        )
-      rescue Terrapin::ExitStatusError
-        ""
-      rescue Terrapin::CommandNotFoundError => e
-        raise_because_imagemagick_missing
-      end
+      orientation = Paperclip.options[:use_exif_orientation] ?
+        "%[exif:orientation]" : "1"
+      Paperclip.run(
+        Paperclip.options[:is_windows] ? "magick identify" : "identify",
+        "-format '%wx%h,#{orientation}' :file", {
+          file: "#{path}[0]"
+        },
+        swallow_stderr: true
+      )
+    rescue Terrapin::ExitStatusError
+      ""
+    rescue Terrapin::CommandNotFoundError => e
+      raise_because_imagemagick_missing
     end
 
     def path

data/lib/paperclip/geometry_parser_factory.rb

@@ -1,6 +1,6 @@
 module Paperclip
   class GeometryParser
-    FORMAT = /\b(\d*)x?(\d*)\b(?:,(\d?))?(\@\>|\>\@|[\>\<\#\@\%^!])?/i
+    FORMAT = /\b(\d*)x?(\d*)\b(?:,(\d?))?(\@\>|\>\@|[\>\<\#\@\%^!])?/i.freeze
     def initialize(string)
       @string = string
     end
@@ -8,10 +8,10 @@ module Paperclip
     def make
       if match
         Geometry.new(
-          :height => @height,
-          :width => @width,
-          :modifier => @modifier,
-          :orientation => @orientation
+          height: @height,
+          width: @width,
+          modifier: @modifier,
+          orientation: @orientation
         )
       end
     end

data/lib/paperclip/glue.rb

@@ -1,6 +1,6 @@
-require 'paperclip/callbacks'
-require 'paperclip/validators'
-require 'paperclip/schema'
+require "paperclip/callbacks"
+require "paperclip/validators"
+require "paperclip/schema"
 
 module Paperclip
   module Glue

data/lib/paperclip/has_attached_file.rb

@@ -24,7 +24,7 @@ module Paperclip
     private
 
     def define_flush_errors
-      @klass.send(:validates_each, @name) do |record, attr, value|
+      @klass.send(:validates_each, @name) do |record, _attr, _value|
         attachment = record.send(@name)
         attachment.send(:flush_errors)
       end
@@ -48,7 +48,7 @@ module Paperclip
           instance_variable_set(ivar, attachment)
         end
 
-        if args.length > 0
+        if !args.empty?
           attachment.to_s(args.first)
         else
           attachment
@@ -83,7 +83,7 @@ module Paperclip
       if options[:validate_media_type] != false
         name = @name
         @klass.validates_media_type_spoof_detection name,
-          :if => ->(instance){ instance.send(name).dirty? }
+                                                    if: ->(instance) { instance.send(name).dirty? }
       end
     end
 
@@ -103,7 +103,8 @@ module Paperclip
     def add_paperclip_callbacks
       @klass.send(
         :define_paperclip_callbacks,
-        :post_process, :"#{@name}_post_process")
+        :post_process, :"#{@name}_post_process", :"#{@name}_validate"
+      )
     end
 
     module ClassMethods