kt-paperclip 7.0.0 → 7.2.2

data/CONTRIBUTING.md

@@ -10,8 +10,7 @@ Here's a quick guide for contributing:
 
 1. Fork the repo.
 
-1. Make sure you have ImageMagick and Ghostscript installed. See [this section]
-(./README.md#image-processor) of the README.
+1. Make sure you have ImageMagick and Ghostscript installed. See [this section](./README.md#image-processor) of the README.
 
 1. Run the tests. We only take pull requests with passing tests, and it's great
 to know that you have a clean slate: `bundle && bundle exec rake`
@@ -78,9 +77,9 @@ Syntax
 
 * Two spaces, no tabs.
 * No trailing whitespace. Blank lines should not have any space.
-* Prefer &&/|| over and/or.
-* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-* a = b and not a=b.
+* Prefer `&&` instead of `and` ; prefer `||` instead of `or`.
+* Use `MyClass.my_method(my_arg)` instead of `MyClass.my_method( my_arg )` or `MyClass.my_method my_arg`.
+* `a = b` rather than `a=b` .
 * Follow the conventions you see used in the source already.
 
 And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -12,7 +12,8 @@ group :development, :test do
   gem "builder"
   gem "listen", "~> 3.0.8"
   gem "rspec"
-  gem "rubocop", require: false
+  # Hound only supports certain versions of Rubocop -- 1.22.1 is currently the most recent one supported.
+  gem "rubocop", "1.22.1", require: false
   gem "rubocop-rails"
   gem "sprockets", "3.7.2"
 end

data/NEWS

@@ -1,3 +1,14 @@
+[UNRELEASED]
+
+7.2.1 (2023-09-09)
+* Improvement: Support file extension names both as symbols and strings for :content_type_mappings
+
+7.2.0 (2023-05-30)
+* Paperclip schema statements are consistent with ActiveRecord::Migration::Compatibility versioning. Old migrations containing Paperclip schema statements perform the same schema changes both before and after an ActiveRecord version upgrade.
+
+7.0.1 (2021-10-06)
+* Issue file delete only once per unique style when nullifying attachment or destroying an object. Avoids triggering a rate limit error on Google Cloud Storage.
+
 7.0.0 (2021-05-28)
 * Replace `mimemagic` gem with `marcel` due to licensing issues. See https://github.com/kreeti/kt-paperclip/pull/54 for details and limitations
 

data/README.md

@@ -592,9 +592,9 @@ Storage
 
 Paperclip ships with 3 storage adapters:
 
-* File Storage
-* S3 Storage (via `aws-sdk-s3`)
-* Fog Storage
+* File Storage (`storage: :filesystem`)
+* S3 Storage (via `aws-sdk-s3`) (`storage: :s3`)
+* Fog Storage (`storage: :fog`)
 
 If you would like to use Paperclip with another storage, you can install these
 gems along side with Paperclip:

data/gemfiles/7.0.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "sqlite3", "~> 1.4", platforms: :ruby
+gem "aruba", "~> 1.0", ">= 1.0.4"
+gem "rails", "~> 7.0.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "bootsnap", require: false
+  gem "builder"
+  gem "listen", "~> 3.0.8"
+  gem "rspec"
+  gem "rubocop", require: false
+  gem "rubocop-rails"
+  gem "sprockets", "3.7.2"
+end
+
+gemspec path: "../"

data/lib/paperclip/attachment.rb

@@ -38,7 +38,7 @@ module Paperclip
     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,

data/lib/paperclip/content_type_detector.rb

@@ -67,9 +67,14 @@ module Paperclip
     end
 
     def type_from_marcel
-      @type_from_marcel ||= File.open(@filepath) do |file|
-        Marcel::Magic.by_magic(file).try(:type)
-      end
+      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/geometry_detector_factory.rb

@@ -7,7 +7,7 @@ module Paperclip
 
     def make
       geometry = GeometryParser.new(geometry_string.strip).make
-      geometry || raise(Errors::NotIdentifiedByImageMagickError.new)
+      geometry || raise(Errors::NotIdentifiedByImageMagickError.new("Could not identify image size"))
     end
 
     private

data/lib/paperclip/glue.rb

@@ -4,14 +4,15 @@ 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/interpolations.rb

@@ -54,10 +54,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/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/media_type_spoof_detector.rb

@@ -76,11 +76,14 @@ module Paperclip
       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.")
+
       ""
     end
 
     def mapped_content_type
-      Paperclip.options[:content_type_mappings][filename_extension]
+      content_type_mappings = Paperclip.options[:content_type_mappings]
+      content_type_mappings[filename_extension] || content_type_mappings[filename_extension.to_s]
     end
 
     def filename_extension

data/lib/paperclip/schema.rb

@@ -6,12 +6,12 @@ module Paperclip
     COLUMNS = { file_name: :string,
                 content_type: :string,
                 file_size: :bigint,
-                updated_at: :datetime }.freeze
+                updated_at: :datetime }
 
     def self.included(_base)
       ActiveRecord::ConnectionAdapters::Table.include TableDefinition
       ActiveRecord::ConnectionAdapters::TableDefinition.include TableDefinition
-      ActiveRecord::ConnectionAdapters::AbstractAdapter.include Statements
+      ActiveRecord::Migration.include Statements
       ActiveRecord::Migration::CommandRecorder.include CommandRecorder
     end
 

data/lib/paperclip/storage/filesystem.rb

@@ -57,7 +57,7 @@ module Paperclip
       end
 
       def flush_deletes #:nodoc:
-        @queued_for_delete.each do |path|
+        @queued_for_delete.uniq.each do |path|
           begin
             log("deleting #{path}")
             FileUtils.rm(path) if File.exist?(path)

data/lib/paperclip/storage/fog.rb

@@ -135,7 +135,7 @@ module Paperclip
       end
 
       def flush_deletes
-        @queued_for_delete.each do |path|
+        @queued_for_delete.uniq.each do |path|
           log("deleting #{path}")
           directory.files.new(key: path).destroy
         end

data/lib/paperclip/storage/s3.rb

@@ -137,6 +137,9 @@ module Paperclip
           @s3_headers = {}
           merge_s3_headers(@options[:s3_headers], @s3_headers, @s3_metadata)
 
+          @s3_acl_enabled = @options[:s3_acl_enabled]
+          @s3_acl_enabled = true if @s3_acl_enabled.nil?
+
           @s3_storage_class = set_storage_class(@options[:s3_storage_class])
 
           @s3_server_side_encryption = "AES256"
@@ -359,9 +362,12 @@ module Paperclip
             log("saving #{path(style)}")
             write_options = {
               content_type: file.content_type,
-              acl: s3_permissions(style)
             }
 
+            if @s3_acl_enabled
+              write_options[:acl] = s3_permissions(style)
+            end
+
             # add storage class for this style if defined
             storage_class = s3_storage_class(style)
             write_options.merge!(storage_class: storage_class) if storage_class
@@ -403,7 +409,7 @@ module Paperclip
       end
 
       def flush_deletes #:nodoc:
-        @queued_for_delete.each do |path|
+        @queued_for_delete.uniq.each do |path|
           begin
             log("deleting #{path}")
             s3_bucket.object(path.sub(%r{\A/}, "")).delete
@@ -427,9 +433,9 @@ module Paperclip
       def find_credentials(creds)
         case creds
         when File
-          YAML::safe_load(ERB.new(File.read(creds.path)).result, [], [], true)
+          load_credentials_from_file(creds.path)
         when String, Pathname
-          YAML::safe_load(ERB.new(File.read(creds)).result, [], [], true)
+          load_credentials_from_file(creds)
         when Hash
           creds
         when NilClass
@@ -439,6 +445,14 @@ module Paperclip
         end
       end
 
+      def load_credentials_from_file(path)
+        if Gem::Version.new(Psych::VERSION) >= Gem::Version.new("3.1.0")
+          YAML::safe_load(ERB.new(File.read(path)).result, aliases: true)
+        else
+          YAML::safe_load(ERB.new(File.read(path)).result, [], [], true)
+        end
+      end
+
       def use_secure_protocol?(style_name)
         s3_protocol(style_name) == "https"
       end

data/lib/paperclip/validators/attachment_file_name_validator.rb

@@ -27,7 +27,7 @@ module Paperclip
             [:both, :base].include?(options[:add_validation_errors_to])
 
           record.errors[attribute].each do |error|
-            record.errors.add base_attribute, error
+            record.errors.add(base_attribute, error)
           end
 
           record.errors.delete(attribute) if options[:add_validation_errors_to] == :base

data/lib/paperclip/validators/attachment_size_validator.rb

@@ -35,8 +35,9 @@ module Paperclip
           options.slice(*AVAILABLE_CHECKS).each do |option, option_value|
             option_value = option_value.call(record) if option_value.is_a?(Proc)
             option_value = extract_option_value(option, option_value)
+            operator = ActiveModel::VERSION::MAJOR >= 7 ? COMPARE_CHECKS[option] : CHECKS[option]
 
-            unless value.send(CHECKS[option], option_value)
+            unless value.send(operator, option_value)
               error_message_key = options[:in] ? :in_between : option
               error_attrs.each do |error_attr_name|
                 record.errors.add(error_attr_name, error_message_key, **filtered_options(value).merge(

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "7.0.0" unless defined?(Paperclip::VERSION)
+  VERSION = "7.2.2" unless defined?(Paperclip::VERSION)
 end

data/paperclip.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency("activesupport", ">= 4.2.0")
   s.add_dependency("mime-types")
   s.add_dependency("marcel", "~> 1.0.1")
-  s.add_dependency("terrapin", "~> 0.6.0")
+  s.add_dependency("terrapin", ">= 0.6.0", "< 2.0")
 
   s.add_development_dependency("activerecord", ">= 4.2.0")
   s.add_development_dependency("appraisal")

data/spec/paperclip/attachment_spec.rb

@@ -1333,7 +1333,7 @@ describe Paperclip::Attachment do
 
   context "An attachment with only a avatar_file_name column" do
     before do
-      ActiveRecord::Base.connection.create_table :dummies, force: true do |table|
+      ActiveRecord::Migration.create_table :dummies, force: true do |table|
         table.column :avatar_file_name, :string
       end
       rebuild_class
@@ -1359,7 +1359,7 @@ describe Paperclip::Attachment do
 
     context "and avatar_created_at column" do
       before do
-        ActiveRecord::Base.connection.add_column :dummies, :avatar_created_at, :timestamp
+        ActiveRecord::Migration.add_column :dummies, :avatar_created_at, :timestamp
         rebuild_class
         @dummy = Dummy.new
       end
@@ -1396,7 +1396,7 @@ describe Paperclip::Attachment do
 
     context "and avatar_updated_at column" do
       before do
-        ActiveRecord::Base.connection.add_column :dummies, :avatar_updated_at, :timestamp
+        ActiveRecord::Migration.add_column :dummies, :avatar_updated_at, :timestamp
         rebuild_class
         @dummy = Dummy.new
       end
@@ -1426,7 +1426,7 @@ describe Paperclip::Attachment do
 
     context "and avatar_content_type column" do
       before do
-        ActiveRecord::Base.connection.add_column :dummies, :avatar_content_type, :string
+        ActiveRecord::Migration.add_column :dummies, :avatar_content_type, :string
         rebuild_class
         @dummy = Dummy.new
       end
@@ -1443,7 +1443,7 @@ describe Paperclip::Attachment do
 
     context "and avatar_file_size column" do
       before do
-        ActiveRecord::Base.connection.add_column :dummies, :avatar_file_size, :bigint
+        ActiveRecord::Migration.add_column :dummies, :avatar_file_size, :bigint
         rebuild_class
         @dummy = Dummy.new
       end
@@ -1467,7 +1467,7 @@ describe Paperclip::Attachment do
 
     context "and avatar_fingerprint column" do
       before do
-        ActiveRecord::Base.connection.add_column :dummies, :avatar_fingerprint, :string
+        ActiveRecord::Migration.add_column :dummies, :avatar_fingerprint, :string
         rebuild_class
         @dummy = Dummy.new
       end

data/spec/paperclip/content_type_detector_spec.rb

@@ -7,6 +7,13 @@ describe Paperclip::ContentTypeDetector do
                  Paperclip::ContentTypeDetector.new(file.path).detect
   end
 
+  it 'returns a more specific content type based on the filename if it matches
+      multiple content types' do
+    file = File.new(fixture_file('sample.xlsm'))
+    assert_equal 'application/vnd.ms-excel.sheet.macroenabled.12',
+                 Paperclip::ContentTypeDetector.new(file.path).detect
+  end
+
   it "gives a sensible default when the name is empty" do
     assert_equal "application/octet-stream", Paperclip::ContentTypeDetector.new("").detect
   end

data/spec/paperclip/geometry_detector_spec.rb

@@ -35,4 +35,13 @@ describe Paperclip::GeometryDetector do
       Paperclip.options[:use_exif_orientation] = true
     end
   end
+
+  it "raises an exception with a message when the file is not an image" do
+    file = fixture_file("text.txt")
+    factory = Paperclip::GeometryDetector.new(file)
+
+    expect do
+      factory.make
+    end.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError, "Could not identify image size")
+  end
 end

data/spec/paperclip/geometry_spec.rb

@@ -147,23 +147,35 @@ describe Paperclip::Geometry do
 
     it "does not generate from a bad file" do
       file = "/home/This File Does Not Exist.omg"
-      expect { @geo = Paperclip::Geometry.from_file(file) }.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError)
+      expect do
+        @geo = Paperclip::Geometry.from_file(file)
+      end.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError,
+                         "Could not identify image size")
     end
 
     it "does not generate from a blank filename" do
       file = ""
-      expect { @geo = Paperclip::Geometry.from_file(file) }.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError)
+      expect do
+        @geo = Paperclip::Geometry.from_file(file)
+      end.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError,
+                         "Cannot find the geometry of a file with a blank name")
     end
 
     it "does not generate from a nil file" do
       file = nil
-      expect { @geo = Paperclip::Geometry.from_file(file) }.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError)
+      expect do
+        @geo = Paperclip::Geometry.from_file(file)
+      end.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError,
+                         "Cannot find the geometry of a file with a blank name")
     end
 
     it "does not generate from a file with no path" do
       file = double("file", path: "")
       allow(file).to receive(:respond_to?).with(:path).and_return(true)
-      expect { @geo = Paperclip::Geometry.from_file(file) }.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError)
+      expect do
+        @geo = Paperclip::Geometry.from_file(file)
+      end.to raise_error(Paperclip::Errors::NotIdentifiedByImageMagickError,
+                         "Cannot find the geometry of a file with a blank name")
     end
 
     it "lets us know when a command isn't found versus a processing error" do

data/spec/paperclip/glue_spec.rb

@@ -39,4 +39,25 @@ describe Paperclip::Glue do
       Object.send :remove_const, "NonActiveRecordModel"
     end
   end
+
+  describe "when included" do
+    it "does not mutate I18n.load_path more than once" do
+      before_load_path = I18n.load_path
+      I18n.load_path = []
+
+      # expect twice because the load_path is reset after creating the classes
+      expect(I18n.config).to receive(:load_path=).and_call_original.twice
+
+      FirstModel = Class.new
+      FirstModel.include Paperclip::Glue
+
+      SecondModel = Class.new
+      SecondModel.include Paperclip::Glue
+
+      ThirdModel = Class.new
+      ThirdModel.include Paperclip::Glue
+
+      I18n.load_path = before_load_path
+    end
+  end
 end

data/spec/paperclip/io_adapters/uri_adapter_spec.rb

@@ -224,7 +224,7 @@ describe Paperclip::UriAdapter do
 
       it "calls open with read_timeout option" do
         expect(@uri_opener)
-          .to receive(:open).with(@uri, read_timeout: 120).at_least(1).times
+          .to receive(:open).with(@uri, { read_timeout: 120 }).at_least(1).times
       end
     end
   end

data/spec/paperclip/media_type_spoof_detector_spec.rb

@@ -32,12 +32,18 @@ describe Paperclip::MediaTypeSpoofDetector do
   end
 
   it "does not reject when the extension => content_type is in :content_type_mappings" do
+    file = Tempfile.open(["test", ".PEM"])
+    file.puts "Certificate!"
+    file.close
+
+    adapter = Paperclip.io_adapters.for(File.new(file.path))
+
     begin
       Paperclip.options[:content_type_mappings] = { pem: "text/plain" }
-      file = Tempfile.open(["test", ".PEM"])
-      file.puts "Certificate!"
-      file.close
-      adapter = Paperclip.io_adapters.for(File.new(file.path))
+      assert !Paperclip::MediaTypeSpoofDetector.using(adapter, adapter.original_filename, adapter.content_type).spoofed?
+
+      # As a string.
+      Paperclip.options[:content_type_mappings] = { "pem" => "text/plain" }
       assert !Paperclip::MediaTypeSpoofDetector.using(adapter, adapter.original_filename, adapter.content_type).spoofed?
     ensure
       Paperclip.options[:content_type_mappings] = {}

data/spec/paperclip/paperclip_missing_attachment_styles_spec.rb

@@ -49,7 +49,7 @@ describe "Missing Attachment Styles" do
     expected_hash = { Dummy: { avatar: [:export, :thumb] } }
     assert_equal expected_hash, Paperclip.missing_attachments_styles
 
-    ActiveRecord::Base.connection.create_table :books, force: true
+    ActiveRecord::Migration.create_table :books, force: true
     class ::Book < ActiveRecord::Base
       has_attached_file :cover, styles: { small: "x100", large: "1000x1000>" }
       has_attached_file :sample, styles: { thumb: "x100" }

data/spec/paperclip/paperclip_spec.rb

@@ -63,7 +63,7 @@ describe Paperclip do
   context "Calling Paperclip.run with a logger" do
     it "passes the defined logger if :log_command is set" do
       Paperclip.options[:log_command] = true
-      expect(Terrapin::CommandLine).to receive(:new).with("convert", "stuff", logger: Paperclip.logger).and_return(double(run: nil))
+      expect(Terrapin::CommandLine).to receive(:new).with("convert", "stuff", { logger: Paperclip.logger }).and_return(double(run: nil))
       Paperclip.run("convert", "stuff")
     end
   end