kt-paperclip 7.2.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7308352f1d792e5e861ba828d1eb3994b5956fc51df06a4cbfedfe134ce105d
-  data.tar.gz: be4d4161c411a18edaf2a92b5a48d746d87d01f3d5a6e4fe5fecc20f87ad42a4
+  metadata.gz: 57acb40c010d089179840fb06116bb36527035ce5e6ddaa25531d2d24067456f
+  data.tar.gz: f49b37dbd63550be17c59b47ce930981dae6f7d88461cf90721925051e579efa
 SHA512:
-  metadata.gz: e202f7d5a1a9466f69118e485c5c747f10942644337940b6141ffb41904118353cab09858fbdabf4e68ba87d9e5199109a1a1525d7eaeea4a1601ba9e384459f
-  data.tar.gz: 20fb1d6bd39a2d21a5b2f627d5ab92aba95ae88d523319de7b06e5e0983c281e76ae218a6bccf64fdc16362652cb1cc1251eab7fdacc14b6428b8dbafd2bdc81
+  metadata.gz: f92b7453a259e25763375ba727dc262910ec647e54017182befa98e0330e6ac5890cd76ab27476a3be6725de35aeb8b85f73db463ad75007370d0076ed3220bb
+  data.tar.gz: dae535db1d37087c4505aaa0db691c2e300377755c9345ef412a28dfde1bf55f64f169d6f438d0285672db9bc8681629708c1c366e719cfcb2773d89f6ad5906

data/LICENSE

@@ -1,9 +1,9 @@
-
 LICENSE
 
 The MIT License
 
 Copyright (c) 2008-2016 Jon Yurek and thoughtbot, inc.
+Copyright (c) 2019-2025 Kreeti Technologies Pvt Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -93,73 +93,41 @@ Requirements
 Paperclip now requires Ruby version **>= 2.3** and Rails version **>= 4.2**
 (only if you're going to use Paperclip with Ruby on Rails).
 
-### Image Processor
+### ImageMagick Image Processor
 
-[ImageMagick](http://www.imagemagick.org) must be installed and Paperclip must have access to it. To ensure
-that it does, on your command line, run `which convert` (one of the ImageMagick
-utilities). This will give you the path where that utility is installed. For
-example, it might return `/usr/local/bin/convert`.
+[ImageMagick](http://www.imagemagick.org) must be installed and Paperclip must have access to it.
+Refer to ImageMagick's [installations instructions](https://imagemagick.org/download/).
+ImageMagick 7 is the latest version. As of April 2026, some package managers such as `apt`
+still install ImageMagick 6.
 
-Then, in your environment config file, let Paperclip know to look there by adding that
-directory to its path.
-
-In development mode, you might add this line to `config/environments/development.rb)`:
+Paperclip supports both ImageMagick versions 6 and 7, and will auto-detect your version.
+You may enforce a specific version in an initializer such as `config/initializers/paperclip.rb`:
 
 ```ruby
-Paperclip.options[:command_path] = "/usr/local/bin/"
+Paperclip.options[:imagemagick_version] = "7"
 ```
 
-If you're on Mac OS X, you'll want to run the following with [Homebrew](http://www.brew.sh):
-
-    brew install imagemagick
-
-If you are dealing with pdf uploads or running the test suite, you'll also need
-to install GhostScript. On Mac OS X, you can also install that using Homebrew:
-
-    brew install gs
-
-If you are on Ubuntu (or any Debian base Linux distribution), you'll want to run
-the following with apt-get:
-
-    sudo apt-get install imagemagick -y
-
-### `file`
-
-The Unix [`file` command](https://en.wikipedia.org/wiki/File_(command)) is required for content-type checking.
-This utility isn't available in Windows, but comes bundled with Ruby [Devkit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit),
-so Windows users must make sure that the devkit is installed and added to the system `PATH`.
-
-**Manual Installation**
-
-If you're using Windows 7+ as a development environment, you may need to install the `file.exe` application manually. The `file spoofing` system in Paperclip 4+ relies on this; if you don't have it working, you'll receive `Validation failed: Upload file has an extension that does not match its contents.` errors.
+Please ensure ImageMagick is in your environment path, or alternatively set
+the path manually in an initializer:
 
-To manually install, you should perform the following:
-
-> **Download & install `file` from [this URL](http://gnuwin32.sourceforge.net/packages/file.htm)**
-
-To test, you can use the image below:
-![untitled](https://cloud.githubusercontent.com/assets/1104431/4524452/a1f8cce4-4d44-11e4-872e-17adb96f79c9.png)
-
-Next, you need to integrate with your environment - preferably through the `PATH` variable, or by changing your `config/environments/development.rb` file
-
-**PATH**
-
-    1. Click "Start"
-    2. On "Computer", right-click and select "Properties"
-    3. In Properties, select "Advanced System Settings"
-    4. Click the "Environment Variables" button
-    5. Locate the "PATH" var - at the end, add the path to your newly installed `file.exe` (typically `C:\Program Files (x86)\GnuWin32\bin`)
-    6. Restart any CMD shells you have open & see if it works
+```ruby
+Paperclip.options[:imagemagick_path] = "/usr/local/bin/"
+```
 
-OR
+### Optional: Unix `file` Command
 
-**Environment**
+Paperclip uses the [Marcel gem](https://github.com/rails/marcel) to detect file content types.
+If Marcel cannot detect the type, the [Unix `file` command](https://en.wikipedia.org/wiki/File_(command))
+is used as an optional fallback. To use it, ensure `file` is in your environment path,
+or alternatively set its path manually in an initializer:
 
-    1. Open `config/environments/development.rb`
-    2. Add the following line: `Paperclip.options[:command_path] = 'C:\Program Files (x86)\GnuWin32\bin'`
-    3. Restart your Rails server
+```ruby
+Paperclip.options[:file_command_path] = "/usr/local/bin/"
+```
 
-Either of these methods will give your Rails setup access to the `file.exe` functionality, thus providing the ability to check the contents of a file (fixing the spoofing problem)
+Windows users should install the `file` utility via the Ruby Installer for Windows'
+[DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit), or alternatively,
+by installing [MSYS2](https://www.msys2.org/) which provides Unix utilities for Windows.
 
 ---
 

data/lib/generators/paperclip/paperclip_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/active_record"
 
 class PaperclipGenerator < ActiveRecord::Generators::Base
@@ -31,6 +33,6 @@ class PaperclipGenerator < ActiveRecord::Generators::Base
   end
 
   def migration_version
-    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if Rails.version.first.to_i > 4
+    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
   end
 end

data/lib/kt-paperclip.rb

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

data/lib/paperclip/attachment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "uri"
 require "paperclip/url_generator"
 require "active_support/deprecation"
@@ -10,30 +12,31 @@ 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,
+        return_file_attributes_on_destroy: false
       }
     end
 
@@ -69,6 +72,8 @@ module Paperclip
     # +interpolator+ - the object used to interpolate filenames and URLs. Defaults to Paperclip::Interpolations
     # +url_generator+ - the object used to generate URLs, using the interpolator. Defaults to Paperclip::UrlGenerator
     # +escape_url+ - Perform URI escaping to URLs. Defaults to true
+    # +return_file_attributes_on_destroy+ - whether attachment-related attributes should be displayed when
+    #                                       destroying a record. Defaults to false.
     def initialize(name, instance, options = {})
       @name              = name.to_sym
       @name_string       = name.to_s
@@ -563,12 +568,10 @@ module Paperclip
           path(style) if exists?(style)
         end.compact
       end
-      instance_write(:file_name, nil)
-      instance_write(:content_type, nil)
-      instance_write(:file_size, nil)
-      instance_write(:fingerprint, nil)
-      instance_write(:created_at, nil) if has_enabled_but_unset_created_at?
-      instance_write(:updated_at, nil)
+
+      return if show_attrs_and_destroy_callback_triggered?
+
+      clear_all_attachment_attributes
     end
 
     def flush_errors #:nodoc:
@@ -613,5 +616,21 @@ module Paperclip
     def has_enabled_but_unset_created_at?
       able_to_store_created_at? && !instance_read(:created_at)
     end
+
+    # Checks whether the option to show attributes to be destroyed is enabled and whether a destroy callback has been
+    # invoked when deleting the entire record.
+    def show_attrs_and_destroy_callback_triggered?
+      @options[:return_file_attributes_on_destroy] && instance.instance_variable_get(:@_destroy_callback_already_called)
+    end
+
+    # Sets attachment-related attributes to `nil`.
+    def clear_all_attachment_attributes
+      instance_write(:file_name, nil)
+      instance_write(:content_type, nil)
+      instance_write(:file_size, nil)
+      instance_write(:fingerprint, nil)
+      instance_write(:created_at, nil) if has_enabled_but_unset_created_at?
+      instance_write(:updated_at, nil)
+    end
   end
 end

data/lib/paperclip/attachment_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "singleton"
 
 module Paperclip

data/lib/paperclip/callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paperclip
   module Callbacks
     def self.included(base)
@@ -9,14 +11,15 @@ module Paperclip
       def define_paperclip_callbacks(*callbacks)
         define_callbacks(*[callbacks, { terminator: hasta_la_vista_baby }].flatten)
         callbacks.each do |callback|
-          eval <<-end_callbacks
-            def before_#{callback}(*args, &blk)
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def self.before_#{callback}(*args, &blk)
               set_callback(:#{callback}, :before, *args, &blk)
             end
-            def after_#{callback}(*args, &blk)
+
+            def self.after_#{callback}(*args, &blk)
               set_callback(:#{callback}, :after, *args, &blk)
             end
-          end_callbacks
+          RUBY
         end
       end
 

data/lib/paperclip/commands/imagemagick/geometry_parser.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Commands
+    module ImageMagick
+      module GeometryParser
+        extend self
+
+        FORMAT = /\b(\d*)x?(\d*)\b(?:,(\d?))?(@>|>@|[><#@%^!])?/i.freeze
+
+        # Runs `magick identify` and returns a Paperclip::Geometry
+        def detect(file)
+          parse(fetch(file))
+        end
+        alias_method :from_file, :detect
+
+        # Parses a "WxH,O" string into a Paperclip::Geometry
+        def parse(string)
+          return unless (match = string&.strip&.match(FORMAT))
+
+          Paperclip::Geometry.new(
+            width: match[1],
+            height: match[2],
+            orientation: match[3],
+            modifier: match[4]
+          )
+        end
+
+        private
+
+        def fetch(file)
+          filepath = path(file)
+          raise_error("Cannot find the geometry of a file with a blank name") if filepath.blank?
+
+          str = Paperclip::Commands::ImageMagick.identify(
+            "-format '%wx%h,#{orientation}' :file",
+            { file: "#{filepath}[0]" },
+            { swallow_stderr: true }
+          ).presence
+
+          raise_error unless str
+
+          str
+        rescue Terrapin::ExitStatusError
+          raise_error
+        end
+
+        def path(file)
+          file.respond_to?(:path) ? file.path : file
+        end
+
+        def orientation
+          Paperclip.options[:use_exif_orientation] ? "%[exif:orientation]" : "1"
+        end
+
+        def raise_error(message = nil)
+          message ||= "Could not identify image size"
+          raise Errors::NotIdentifiedByImageMagickError.new(message)
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/commands/imagemagick/version_detector.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Commands
+    module ImageMagick
+      module VersionDetector
+        extend self
+
+        # Returns 6, 7, or nil (not installed)
+        def detected_version
+          return @detected_version if defined?(@detected_version)
+
+          @detected_version = detect
+        end
+
+        private
+
+        def detect
+          return 7 if valid?("magick")
+          return 6 if valid?("convert")
+
+          nil
+        end
+
+        def valid?(command)
+          run(command).to_s.include?("ImageMagick")
+        end
+
+        def run(command)
+          Paperclip::Commands::Runner.run(command, path, "-version", {}, swallow_stderr: true)
+        rescue Terrapin::CommandLineError
+          nil
+        end
+
+        def path
+          Paperclip::Commands::ImageMagick.imagemagick_path
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/commands/imagemagick.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Commands
+    module ImageMagick
+      extend self
+
+      def convert(arguments = nil, interpolation_values = {}, local_options = {})
+        run(convert_command, imagemagick_path, arguments, interpolation_values, local_options)
+      end
+
+      def identify(arguments = nil, interpolation_values = {}, local_options = {})
+        run(identify_command, imagemagick_path, arguments, interpolation_values, local_options)
+      end
+
+      def imagemagick_path
+        Paperclip.options[:imagemagick_path]
+      end
+
+      private
+
+      def run(command, path = nil, arguments = nil, interpolation_values = {}, local_options = {})
+        Runner.run(command, path || imagemagick_path, arguments, interpolation_values, local_options)
+      rescue Terrapin::CommandNotFoundError
+        raise Errors::CommandNotFoundError.new("Could not run the `#{command}` command. Please install ImageMagick.")
+      end
+
+      # Returns true if ImageMagick 7 is in use (either detected or forced via config)
+      def magick_command?
+        version = Paperclip.options[:imagemagick_version]&.to_i ||
+                  VersionDetector.detected_version
+        !version.nil? && version >= 7
+      end
+
+      def convert_command
+        magick_command? ? "magick" : "convert"
+      end
+
+      def identify_command
+        magick_command? ? "magick identify" : "identify"
+      end
+    end
+  end
+end

data/lib/paperclip/commands/runner.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Commands
+    module Runner
+      extend self
+
+      def run(command, path = nil, arguments = nil, interpolation_values = {}, local_options = {})
+        if Paperclip.logging? && (Paperclip.options[:log_command] || local_options[:log_command])
+          local_options = local_options.merge(logger: Paperclip.logger)
+        end
+
+        binary = resolve_binary(command, path)
+
+        Terrapin::CommandLine.new(binary, arguments, local_options)
+                             .run(interpolation_values)
+      end
+
+      private
+
+      def resolve_binary(command, path)
+        # @deprecated +Paperclip.options[:command_path]+ will be removed in Paperclip 8.0
+        path ||= Paperclip.options[:command_path]
+        return command unless path
+
+        # command may be multi-word (e.g. "magick identify")
+        words = command.split(" ", 2)
+        candidate = File.join(path, words[0])
+        if File.executable?(candidate)
+          words[0] = candidate
+          words.join(" ")
+        else
+          command
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/commands/unix_file.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Commands
+    module UnixFile
+      extend self
+
+      # Returns a normalized content type value, otherwise nil.
+      def detect_content_type(file)
+        type = run_file_command(file)
+        return if type.blank? || type.match(/\(.*?\)/)
+
+        type.split(/[:;\s]+/)[0].strip
+      rescue Terrapin::CommandLineError => e
+        Paperclip.log("Error while determining content type: #{e}")
+        nil
+      end
+
+      private
+
+      def run_file_command(file)
+        Runner.run("file", Paperclip.options[:file_command_path], "-b --mime :file", { file: file })
+      rescue Terrapin::CommandLineError
+        nil
+      end
+    end
+  end
+end

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,26 +63,22 @@ module Paperclip
     end
 
     def type_from_file_contents
-      type_from_marcel || 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_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
+      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)