kt-paperclip 7.3.0 → 8.0.1

data/lib/paperclip/geometry_detector_factory.rb

@@ -1,45 +1,25 @@
+# frozen_string_literal: true
+
 module Paperclip
+  # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
   class GeometryDetector
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
     def initialize(file)
+      warn_deprecation
       @file = file
-      raise_if_blank_file
+      raise Errors::NotIdentifiedByImageMagickError.new("Cannot find the geometry of a file with a blank name") if @file.blank?
     end
 
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
     def make
-      geometry = GeometryParser.new(geometry_string.strip).make
-      geometry || raise(Errors::NotIdentifiedByImageMagickError.new("Could not identify image size"))
+      warn_deprecation
+      Paperclip::Commands::ImageMagick::GeometryParser.from_file(@file)
     end
 
     private
 
-    def geometry_string
-      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
-      @file.respond_to?(:path) ? @file.path : @file
-    end
-
-    def raise_if_blank_file
-      if path.blank?
-        raise Errors::NotIdentifiedByImageMagickError.new("Cannot find the geometry of a file with a blank name")
-      end
-    end
-
-    def raise_because_imagemagick_missing
-      raise Errors::CommandNotFoundError.new("Could not run the `identify` command. Please install ImageMagick.")
+    def warn_deprecation
+      Paperclip.deprecator.warn("Paperclip::GeometryDetector has been replaced by Paperclip::Commands::ImageMagick::GeometryParser")
     end
   end
 end

data/lib/paperclip/geometry_parser_factory.rb

@@ -1,31 +1,27 @@
+# frozen_string_literal: true
+
 module Paperclip
+  # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
   class GeometryParser
-    FORMAT = /\b(\d*)x?(\d*)\b(?:,(\d?))?(\@\>|\>\@|[\>\<\#\@\%^!])?/i.freeze
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser::FORMAT+ instead.
+    FORMAT = Paperclip::Commands::ImageMagick::GeometryParser::FORMAT
+
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
     def initialize(string)
+      warn_deprecation
       @string = string
     end
 
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::ImageMagick::GeometryParser+ instead.
     def make
-      if match
-        Geometry.new(
-          height: @height,
-          width: @width,
-          modifier: @modifier,
-          orientation: @orientation
-        )
-      end
+      warn_deprecation
+      Paperclip::Commands::ImageMagick::GeometryParser.parse(@string)
     end
 
     private
 
-    def match
-      if actual_match = @string && @string.match(FORMAT)
-        @width = actual_match[1]
-        @height = actual_match[2]
-        @orientation = actual_match[3]
-        @modifier = actual_match[4]
-      end
-      actual_match
+    def warn_deprecation
+      Paperclip.deprecator.warn("Paperclip::GeometryParser has been replaced by Paperclip::Commands::ImageMagick::GeometryParser")
     end
   end
 end

data/lib/paperclip/glue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paperclip/callbacks"
 require "paperclip/validators"
 require "paperclip/schema"

data/lib/paperclip/has_attached_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class HasAttachedFile
     def self.define_on(klass, name, options)

data/lib/paperclip/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Helpers
     def configure
@@ -8,31 +10,9 @@ module Paperclip
       Paperclip::Interpolations[key] = block
     end
 
-    # The run method takes the name of a binary to run, the arguments
-    # to that binary, the values to interpolate and some local options.
-    #
-    #  :cmd -> The name of a binary to run.
-    #
-    #  :arguments -> The command line arguments to that binary.
-    #
-    #  :interpolation_values -> Values to be interpolated into the arguments.
-    #
-    #  :local_options -> The options to be used by Cocain::CommandLine.
-    #                    These could be: runner
-    #                                    logger
-    #                                    swallow_stderr
-    #                                    expected_outcodes
-    #                                    environment
-    #                                    runner_options
-    #
-    def run(cmd, arguments = "", interpolation_values = {}, local_options = {})
-      command_path = options[:command_path]
-      terrapin_path_array = Terrapin::CommandLine.path.try(:split, Terrapin::OS.path_separator)
-      Terrapin::CommandLine.path = [terrapin_path_array, command_path].flatten.compact.uniq
-      if logging? && (options[:log_command] || local_options[:log_command])
-        local_options = local_options.merge(logger: logger)
-      end
-      Terrapin::CommandLine.new(cmd, arguments, local_options).run(interpolation_values)
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::Commands::Runner.run+ instead.
+    def run(command, arguments = nil, interpolation_values = {}, local_options = {})
+      Commands::Runner.run(command, nil, arguments, interpolation_values, local_options)
     end
 
     # Find all instances of the given Active Record model +klass+ with attachment +name+.

data/lib/paperclip/interpolations/plural_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Interpolations
     class PluralCache

data/lib/paperclip/interpolations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   # This module contains all the methods that are available for interpolation
   # in paths and urls. To add your own (or override an existing one), you

data/lib/paperclip/io_adapters/abstract_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module/delegation"
 
 module Paperclip

data/lib/paperclip/io_adapters/attachment_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class AttachmentAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/data_uri_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class DataUriAdapter < StringioAdapter
     def self.register

data/lib/paperclip/io_adapters/empty_string_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class EmptyStringAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/file_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class FileAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/http_url_proxy_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class HttpUrlProxyAdapter < UriAdapter
     def self.register

data/lib/paperclip/io_adapters/identity_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class IdentityAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/nil_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class NilAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class AdapterRegistry
     class NoHandlerError < Paperclip::Error; end

data/lib/paperclip/io_adapters/stringio_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class StringioAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class UploadedFileAdapter < AbstractAdapter
     def self.register

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open-uri"
 
 module Paperclip
@@ -50,20 +52,10 @@ module Paperclip
       "index.html"
     end
 
-    if RUBY_VERSION < '2.5'
-      def download_content
-        options = { read_timeout: Paperclip.options[:read_timeout] }.compact
-
-        # rubocop:disable Security/Open
-        open(@target, options)
-        # rubocop:enable Security/Open
-      end
-    else
-      def download_content
-        options = { read_timeout: Paperclip.options[:read_timeout] }.compact
+    def download_content
+      options = { read_timeout: Paperclip.options[:read_timeout] }.compact
 
-        URI.open(@target, options)
-      end
+      URI.open(@target, options)
     end
 
     def copy_to_tempfile(src)

data/lib/paperclip/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Logger
     # Log a paperclip-specific line. This will log to STDOUT

data/lib/paperclip/matchers/have_attached_file_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Shoulda
     module Matchers

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Shoulda
     module Matchers
@@ -39,7 +41,7 @@ module Paperclip
         end
 
         def failure_message
-          "#{expected_attachment}\n".tap do |message|
+          (+"#{expected_attachment}\n").tap do |message|
             message << accepted_types_and_failures.to_s
             message << "\n\n" if @allowed_types.present? && @rejected_types.present?
             message << rejected_types_and_failures.to_s
@@ -54,7 +56,7 @@ module Paperclip
 
         def accepted_types_and_failures
           if @allowed_types.present?
-            "Accept content types: #{@allowed_types.join(', ')}\n".tap do |message|
+            (+"Accept content types: #{@allowed_types.join(', ')}\n").tap do |message|
               message << if @missing_allowed_types.present?
                            "  #{@missing_allowed_types.join(', ')} were rejected."
                          else
@@ -66,7 +68,7 @@ module Paperclip
 
         def rejected_types_and_failures
           if @rejected_types.present?
-            "Reject content types: #{@rejected_types.join(', ')}\n".tap do |message|
+            (+"Reject content types: #{@rejected_types.join(', ')}\n").tap do |message|
               message << if @missing_rejected_types.present?
                            "  #{@missing_rejected_types.join(', ')} were accepted."
                          else

data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Shoulda
     module Matchers

data/lib/paperclip/matchers/validate_attachment_size_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Shoulda
     module Matchers

data/lib/paperclip/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paperclip/matchers/have_attached_file_matcher"
 require "paperclip/matchers/validate_attachment_presence_matcher"
 require "paperclip/matchers/validate_attachment_content_type_matcher"

data/lib/paperclip/media_type_spoof_detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class MediaTypeSpoofDetector
     def self.using(file, name, content_type)
@@ -40,12 +42,27 @@ module Paperclip
     end
 
     def calculated_type_mismatch?
-      supplied_media_type.present? &&
-        !calculated_content_type.include?(supplied_media_type)
+      return false if supplied_media_type.blank?
+      # Fast path: the magic number already supports the supplied type, no shell out needed.
+      return false if supplied_type_consistent_with?(type_from_magic)
+      # The bytes told us nothing at all, so there is nothing to contradict the supplied type.
+      return false if calculated_content_types.empty?
+
+      !supplied_type_consistent_with?(type_from_file_command)
+    end
+
+    # The supplied type is supported by the bytes if it shares their media type, or if it is a
+    # specialization of what the bytes resolved to: image/svg+xml is a child of application/xml,
+    # which is all the magic number of an SVG with an XML declaration can tell us.
+    def supplied_type_consistent_with?(type)
+      return false if type.blank?
+
+      type.include?(supplied_media_type) ||
+        !!Marcel::Magic.child?(supplied_content_type, type)
     end
 
     def mapping_override_mismatch?
-      !Array(mapped_content_type).include?(calculated_content_type)
+      (Array(mapped_content_type) & calculated_content_types).empty?
     end
 
     def supplied_content_type
@@ -64,21 +81,35 @@ module Paperclip
       @media_types_from_name ||= content_types_from_name.collect(&:media_type)
     end
 
+    # Every type the file's *contents* resolve to. The filename is deliberately never consulted
+    # here -- trusting it is what let a renamed file pass this check (kreeti/kt-paperclip#173).
+    def calculated_content_types
+      @calculated_content_types ||=
+        # Both sources return nil, never a blank string, when they come up empty.
+        [type_from_magic, type_from_file_command].compact.uniq
+    end
+
     def calculated_content_type
-      @calculated_content_type ||= type_from_file_command.chomp
+      @calculated_content_type ||= calculated_content_types.first.to_s
     end
 
-    def calculated_media_type
-      @calculated_media_type ||= calculated_content_type.split("/").first
+    # Note the absence of a `name:` argument. Marcel lets the filename decide when the bytes carry
+    # no magic number of their own, which is exactly what spoof detection must not allow.
+    def type_from_magic
+      return @type_from_magic if defined?(@type_from_magic)
+
+      type = Marcel::MimeType.for(Pathname.new(@file.path))
+      # Marcel::MimeType returns 'application/octet-stream' if it can't find a valid type.
+      @type_from_magic = type == ContentTypeDetector::SENSIBLE_DEFAULT ? nil : type
+    rescue Errno::ENOENT => e
+      Paperclip.log("Error while determining content type: #{e}")
+      @type_from_magic = nil
     end
 
     def type_from_file_command
-      Paperclip.run("file", "-b --mime :file", file: @file.path).
-        split(/[:;\s]+/).first
-    rescue Terrapin::CommandLineError
-      Paperclip.log("Problem getting type from `file` command. Possible that `file` doesn't exist on this system. Content Type validations don't work without this.")
+      return @type_from_file_command if defined?(@type_from_file_command)
 
-      ""
+      @type_from_file_command = Commands::UnixFile.detect_content_type(@file.path)
     end
 
     def mapped_content_type

data/lib/paperclip/missing_attachment_styles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paperclip/attachment_registry"
 require "set"
 

data/lib/paperclip/processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   # Paperclip processors allow you to modify attached files when they are
   # attached in any way you are able. Paperclip itself uses command-line
@@ -15,9 +17,6 @@ module Paperclip
   #
   # #make must return an instance of File (Tempfile is acceptable) which
   # contains the results of the processing.
-  #
-  # See Paperclip.run for more information about using command-line
-  # utilities from within Processors.
   class Processor
     attr_accessor :file, :options, :attachment
 
@@ -33,24 +32,12 @@ module Paperclip
       new(file, options, attachment).make
     end
 
-    # The convert method runs the convert binary with the provided arguments.
-    # See Paperclip.run for the available options.
-    def convert(arguments = "", local_options = {})
-      Paperclip.run(
-        Paperclip.options[:is_windows] ? "magick convert" : "convert",
-        arguments,
-        local_options
-      )
+    def convert(arguments = nil, interpolation_values = {})
+      Paperclip::Commands::ImageMagick.convert(arguments, interpolation_values)
     end
 
-    # The identify method runs the identify binary with the provided arguments.
-    # See Paperclip.run for the available options.
-    def identify(arguments = "", local_options = {})
-      Paperclip.run(
-        Paperclip.options[:is_windows] ? "magick identify" : "identify",
-        arguments,
-        local_options
-      )
+    def identify(arguments = nil, interpolation_values = {})
+      Paperclip::Commands::ImageMagick.identify(arguments, interpolation_values)
     end
   end
 end

data/lib/paperclip/processor_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module ProcessorHelpers
     class NoSuchProcessor < StandardError; end

data/lib/paperclip/rails_environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class RailsEnvironment
     def self.get

data/lib/paperclip/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paperclip"
 require "paperclip/schema"
 

data/lib/paperclip/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/deprecation"
 
 module Paperclip
@@ -25,7 +27,7 @@ module Paperclip
 
         attachment_names.each do |attachment_name|
           COLUMNS.each_pair do |column_name, column_type|
-            column_options = options.merge(options[column_name.to_sym] || {})
+            column_options = options.merge(options[column_name.to_sym] || {}).except(*COLUMNS.keys)
             add_column(table_name, "#{attachment_name}_#{column_name}", column_type, **column_options)
           end
         end
@@ -44,7 +46,7 @@ module Paperclip
       end
 
       def drop_attached_file(*args)
-        ActiveSupport::Deprecation.warn "Method `drop_attached_file` in the migration has been deprecated and will be replaced by `remove_attachment`."
+        Paperclip.deprecator.warn "Method `drop_attached_file` in the migration has been deprecated and will be replaced by `remove_attachment`."
         remove_attachment(*args)
       end
     end
@@ -54,14 +56,14 @@ module Paperclip
         options = attachment_names.extract_options!
         attachment_names.each do |attachment_name|
           COLUMNS.each_pair do |column_name, column_type|
-            column_options = options.merge(options[column_name.to_sym] || {})
+            column_options = options.merge(options[column_name.to_sym] || {}).except(*COLUMNS.keys)
             column("#{attachment_name}_#{column_name}", column_type, **column_options)
           end
         end
       end
 
       def has_attached_file(*attachment_names)
-        ActiveSupport::Deprecation.warn "Method `t.has_attached_file` in the migration has been deprecated and will be replaced by `t.attachment`."
+        Paperclip.deprecator.warn "Method `t.has_attached_file` in the migration has been deprecated and will be replaced by `t.attachment`."
         attachment(*attachment_names)
       end
     end

data/lib/paperclip/storage/filesystem.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Storage
     # The default place to store attachments is in the filesystem. Files on the local

data/lib/paperclip/storage/fog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Storage
     # fog is a modern and versatile cloud computing library for Ruby.
@@ -44,8 +46,7 @@ module Paperclip
           begin
             require "fog"
           rescue LoadError => e
-            e.message << " (You may need to install the fog gem)"
-            raise e
+            raise("#{e.message} (You may need to install the fog gem)")
           end
         end
 
@@ -216,7 +217,7 @@ module Paperclip
         when File
           load_credentials_from_file(creds.path)
         when String, Pathname
-          load_credentials_from_file(creds.path)
+          load_credentials_from_file(creds)
         when Hash
           creds
         else

data/lib/paperclip/storage/s3.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module Paperclip
   module Storage
     # Amazon's S3 file hosting service is a scalable, easy place to store files for
@@ -126,8 +127,7 @@ module Paperclip
         begin
           require "aws-sdk-s3"
         rescue LoadError => e
-          e.message << " (You may need to install the aws-sdk-s3 gem)"
-          raise e
+          raise("#{e.message} (You may need to install the aws-sdk-s3 gem)")
         end
 
         base.instance_eval do

data/lib/paperclip/storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paperclip/storage/filesystem"
 require "paperclip/storage/fog"
 require "paperclip/storage/s3"

data/lib/paperclip/style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   # The Style class holds the definition of a thumbnail style,  applying
   # whatever processing is required to normalize the definition and delaying

data/lib/paperclip/tempfile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   # Overriding some implementation of Tempfile
   class Tempfile < ::Tempfile

data/lib/paperclip/tempfile_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class TempfileFactory
     def generate(name = random_name)