kt-paperclip 6.4.2 → 8.0.1

data/lib/paperclip/content_type_detector.rb

@@ -1,22 +1,25 @@
+# frozen_string_literal: true
+
 module Paperclip
+  # The content-type detection strategy is as follows:
+  #
+  # 1. Blank/Empty files: If there's no filepath or the file is empty,
+  #    provide a sensible default (application/octet-stream or inode/x-empty)
+  #
+  # 2. Calculated match: Return the first result that is found by both the
+  #    Marcel gem (or `file` command) and MIME::Types.
+  #
+  # 3. Standard types: Return the first standard (without an x- prefix) entry
+  #    in MIME::Types
+  #
+  # 4. Experimental types: If there were no standard types in MIME::Types
+  #    list, try to return the first experimental one
+  #
+  # 5. Raw `file` command: Just use the output of Marcel (or `file` command),
+  #    cached from step 2.
+  #
+  # 6. If nothing found, return a sensible default.
   class ContentTypeDetector
-    # The content-type detection strategy is as follows:
-    #
-    # 1. Blank/Empty files: If there's no filepath or the file is empty,
-    #    provide a sensible default (application/octet-stream or inode/x-empty)
-    #
-    # 2. Calculated match: Return the first result that is found by both the
-    #    `file` command and MIME::Types.
-    #
-    # 3. Standard types: Return the first standard (without an x- prefix) entry
-    #    in MIME::Types
-    #
-    # 4. Experimental types: If there were no standard types in MIME::Types
-    #    list, try to return the first experimental one
-    #
-    # 5. Raw `file` command: Just use the output of the `file` command raw, or
-    #    a sensible default. This is cached from Step 2.
-
     EMPTY_TYPE = "inode/x-empty"
     SENSIBLE_DEFAULT = "application/octet-stream"
 
@@ -25,15 +28,15 @@ module Paperclip
     end
 
     # Returns a String describing the file's content type
-    def detect
+    def detect(default = SENSIBLE_DEFAULT)
       if blank_name?
-        SENSIBLE_DEFAULT
+        default
       elsif empty_file?
         EMPTY_TYPE
       elsif calculated_type_matches.any?
         calculated_type_matches.first
       else
-        type_from_file_contents || SENSIBLE_DEFAULT
+        type_from_file_contents || default
       end.to_s
     end
 
@@ -60,21 +63,22 @@ module Paperclip
     end
 
     def type_from_file_contents
-      type_from_mime_magic || type_from_file_command
+      return @type_from_file_contents if defined?(@type_from_file_contents)
+
+      @type_from_file_contents = type_from_marcel || type_from_file_command
     rescue Errno::ENOENT => e
       Paperclip.log("Error while determining content type: #{e}")
-      SENSIBLE_DEFAULT
+      @type_from_file_contents = nil
     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
+      type = Marcel::MimeType.for(Pathname.new(@filepath), name: @filepath)
+      # Marcel::MineType returns 'application/octet-stream' if it can't find a valid type.
+      type == SENSIBLE_DEFAULT ? nil : type
     end
 
     def type_from_file_command
-      @type_from_file_command ||=
-        FileCommandContentTypeDetector.new(@filepath).detect
+      Commands::UnixFile.detect_content_type(@filepath)
     end
   end
 end

data/lib/paperclip/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   # A base error class for Paperclip. Most of the error that will be thrown
   # from Paperclip will inherits from this class.

data/lib/paperclip/file_command_content_type_detector.rb

@@ -1,28 +1,27 @@
+# frozen_string_literal: true
+
 module Paperclip
+  # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::ContentTypeDetector+ instead.
   class FileCommandContentTypeDetector
+    # @deprecated Will be removed in Paperclip 8.0.
     SENSIBLE_DEFAULT = "application/octet-stream"
 
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::ContentTypeDetector+ instead.
     def initialize(filename)
+      warn_deprecation
       @filename = filename
     end
 
+    # @deprecated Will be removed in Paperclip 8.0. Use +Paperclip::ContentTypeDetector+ instead.
     def detect
-      type_from_file_command
+      warn_deprecation
+      Paperclip::Commands::UnixFile.detect_content_type(@filename) || SENSIBLE_DEFAULT
     end
 
     private
 
-    def type_from_file_command
-      # On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
-      type = begin
-               Paperclip.run("file", "-b --mime :file", file: @filename)
-             rescue Terrapin::CommandLineError => e
-               Paperclip.log("Error while determining content type: #{e}")
-               SENSIBLE_DEFAULT
-             end
-
-      type = SENSIBLE_DEFAULT if type.nil? || type.match(/\(.*?\)/)
-      type.split(/[:;\s]+/)[0]
+    def warn_deprecation
+      Paperclip.deprecator.warn("Paperclip::FileCommandContentTypeDetector has been replaced by Paperclip::ContentTypeDetector.")
     end
   end
 end

data/lib/paperclip/filename_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class FilenameCleaner
     def initialize(invalid_character_regex)

data/lib/paperclip/geometry.rb

@@ -1,35 +1,42 @@
+# frozen_string_literal: true
+
 module Paperclip
   # Defines the geometry of an image.
   class Geometry
-    attr_accessor :height, :width, :modifier
+    attr_accessor :height, :width, :modifier, :orientation
 
     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)
+    def initialize(width = nil, height = nil, modifier = nil, orientation = nil)
       if width.is_a?(Hash)
         options = width
         @height = options[:height].to_f
         @width = options[:width].to_f
-        @modifier = options[:modifier]
+        @modifier = options[:modifier].presence
         @orientation = options[:orientation].to_i
       else
         @height = height.to_f
         @width  = width.to_f
-        @modifier = modifier
+        @modifier = modifier.presence
+        @orientation = orientation.to_i
       end
     end
 
     # Extracts the Geometry from a file (or path to a file)
+    #
+    # @deprecated Will be removed in Paperclip 8.0.
     def self.from_file(file)
-      GeometryDetector.new(file).make
+      Commands::ImageMagick::GeometryParser.from_file(file)
     end
 
     # Extracts the Geometry from a "WxH,O" string
     # Where W is the width, H is the height,
     # and O is the EXIF orientation
+    #
+    # @deprecated Will be removed in Paperclip 8.0.
     def self.parse(string)
-      GeometryParser.new(string).make
+      Commands::ImageMagick::GeometryParser.parse(string)
     end
 
     # Swaps the height and width if necessary
@@ -72,13 +79,21 @@ module Paperclip
 
     # Returns the width and height in a format suitable to be passed to Geometry.parse
     def to_s
-      s = ""
+      s = +""
       s << width.to_i.to_s if width > 0
       s << "x#{height.to_i}" if height > 0
       s << modifier.to_s
       s
     end
 
+    def ==(other)
+      other.is_a?(Geometry) &&
+        width == other.width &&
+        height == other.height &&
+        modifier == other.modifier &&
+        orientation == other.orientation
+    end
+
     # Same as to_s
     def inspect
       to_s

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)
+      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,17 +1,20 @@
+# frozen_string_literal: true
+
 require "paperclip/callbacks"
 require "paperclip/validators"
 require "paperclip/schema"
 
 module Paperclip
   module Glue
+    LOCALE_PATHS = Dir.glob("#{File.dirname(__FILE__)}/locales/*.{rb,yml}")
+
     def self.included(base)
       base.extend ClassMethods
       base.send :include, Callbacks
       base.send :include, Validators
       base.send :include, Schema if defined? ActiveRecord::Base
 
-      locale_path = Dir.glob(File.dirname(__FILE__) + "/locales/*.{rb,yml}")
-      I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)
+      I18n.load_path += LOCALE_PATHS unless (LOCALE_PATHS - I18n.load_path).empty?
     end
   end
 end

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
@@ -54,10 +56,14 @@ module Paperclip
     # Returns the interpolated URL. Will raise an error if the url itself
     # contains ":url" to prevent infinite recursion. This interpolation
     # is used in the default :path to ease default specifications.
-    RIGHT_HERE = "#{__FILE__.gsub(%r{\A\./}, '')}:#{__LINE__ + 3}"
     def url(attachment, style_name)
-      raise Errors::InfiniteInterpolationError if caller.any? { |b| b.index(RIGHT_HERE) }
+      if Thread.current.thread_variable_get(:kt_paperclip_no_recursion)
+        raise Errors::InfiniteInterpolationError
+      end
+      Thread.current.thread_variable_set(:kt_paperclip_no_recursion, true)
       attachment.url(style_name, timestamp: false, escape: false)
+    ensure
+      Thread.current.thread_variable_set(:kt_paperclip_no_recursion, false)
     end
 
     # Returns the timestamp as defined by the <attachment>_updated_at field

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
@@ -17,7 +19,7 @@ module Paperclip
       @fingerprint ||= begin
         digest = @options.fetch(:hash_digest).new
         File.open(path, "rb") do |f|
-          buf = ""
+          buf = String.new
           digest.update(buf) while f.read(16384, buf)
         end
         digest.hexdigest

data/lib/paperclip/io_adapters/attachment_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   class AttachmentAdapter < AbstractAdapter
     def self.register
@@ -33,6 +35,15 @@ module Paperclip
       else
         begin
           source.copy_to_local_file(@style, destination.path)
+
+          # Some sources (like S3) writes to a temporary file first for multi-part downloads then moves
+          # it to the final destination path. This means our destination Tempfile reference is stale
+          # and reads will return an empty string. For compatibility, we need to copy the contents
+          # of the destination file to our current Tempfile instance.
+          if destination.size.zero?
+            IO.copy_stream(destination.path, destination)
+            destination.rewind
+          end
         rescue Errno::EACCES
           # clean up lingering tempfile if we cannot access source file
           destination.close(true)

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/locales/fr.yml

@@ -0,0 +1,18 @@
+fr:
+  errors:
+    messages:
+      in_between: "doit être entre %{min} et %{max}"
+      spoofed_media_type: "à du contenu qui ne correspond pas au type déclaré"
+
+  number:
+    human:
+      storage_units:
+        format: "%n %u"
+        units:
+          byte:
+            one:   "Octet"
+            other: "Octets"
+          kb: "ko"
+          mb: "Mo"
+          gb: "Go"
+          tb: "To"

data/lib/paperclip/locales/gd.yml

@@ -0,0 +1,20 @@
+gd:
+  errors:
+    messages:
+      in_between: "– feumaidh seo a bhith eadar %{min} ’s %{max}"
+      spoofed_media_type: "– tha susbaint ann nach eil a-rèir na chaidh aithris"
+
+  number:
+    human:
+      storage_units:
+        format: "%n %u"
+        units:
+          byte:
+            one:   "bhaidht"
+            two:   "bhaidht"
+            few:   "baidhtean"
+            other: "baidht"
+          kb: "KB"
+          mb: "MB"
+          gb: "GB"
+          tb: "TB"

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"