kt-paperclip 7.0.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e74021df46ad0074287f891fba5ca682856e9e04ee8d4799dd12d3ee6a16b6
-  data.tar.gz: 286dd1db7397931937182a720e399073708eb2288e90fb335ba202cb57209803
+  metadata.gz: d75e4f51d12950eb66e358408303a9640cc7d33b06a3fc8c6bcc66d1271cd7f8
+  data.tar.gz: dbbd1c7ee77e6755bcc2d6e321e29b948782f20b431035f9f21f9fe6f55fd87a
 SHA512:
-  metadata.gz: bdd6685f4c714492582fd1fce2a2db7b26b0b6499134438aee64c4f384398cbd9e568ef7640c6856d83cde06b0616e04e081143b5a7131a3d0607258655ff6dd
-  data.tar.gz: 258c88aa96a0fee96f8fe1def58e1e6cbf94e59945fed2b41d6e45b71a483fdbb976ccff6b772a8e36fa973ad0f31e1c8d0026975101569393234d4a8f316057
+  metadata.gz: 1a594dabed3a1227fdaac88a48cde395d86cbe2401f86cedd21331219a25b32106c4f447099f0486023e251c78edb84c38d509c6c9742a026dd9860f41685f3f
+  data.tar.gz: 81ddf5f9db9ebdd21ababce60620d2575391e04f4e11643ac0ad64e6a865b4f4931ae88f81eeb7d36cbea7ff9a7307e21842794b5f97dc78efbaf8d19fbe63ea

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/NEWS

@@ -1,3 +1,6 @@
+[UNRELEASED]
+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/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/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

@@ -403,7 +403,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

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/version.rb

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

data/spec/paperclip/storage/filesystem_spec.rb

@@ -49,6 +49,29 @@ describe Paperclip::Storage::Filesystem do
         assert_equal @file.read, tempfile.read
         tempfile.close
       end
+
+      it "only issues a delete call once for each unique attachment style when nullifying attachment" do
+        @dummy.save
+        @dummy.avatar.clear(:thumbnail)
+        @dummy.avatar = nil
+        assert_equal 3, @dummy.avatar.queued_for_delete.size
+
+        expect(FileUtils).to receive(:rm).twice
+        @dummy.save
+
+        FileUtils.rm_rf("tmp")
+      end
+
+      it "only issues a delete call once for each unique attachment style when destroying model" do
+        @dummy.save
+        @dummy.avatar.clear(:thumbnail)
+        assert_equal 1, @dummy.avatar.queued_for_delete.size
+
+        expect(FileUtils).to receive(:rm).twice
+        @dummy.destroy
+
+        FileUtils.rm_rf("tmp")
+      end
     end
 
     context "with file that has space in file name" do

data/spec/paperclip/storage/fog_spec.rb

@@ -7,6 +7,52 @@ describe Paperclip::Storage::Fog do
   context "" do
     before { Fog.mock! }
 
+    context "deleting attachment styles" do
+      before do
+        rebuild_model styles: { medium: "300x300>", thumb: "100x100>" },
+                      storage: :fog,
+                      url: "/:attachment/:style/:filename",
+                      fog_directory: "paperclip",
+                      fog_credentials: fixture_file("fog.yml")
+        @file = File.open(fixture_file("5k.png"))
+        @dummy = Dummy.new
+        @dummy.avatar = @file
+        @dummy.save
+      end
+
+      after do
+        @file.close
+        FileUtils.rm_rf("tmp")
+      end
+
+      it "only issues a delete call once for each unique attachment style when nullifying attachment" do
+        @dummy.avatar.clear(:thumb)
+        @dummy.avatar = nil
+        assert_equal 4, @dummy.avatar.queued_for_delete.size
+
+        original = double("original")
+        medium = double("medium")
+        thumb = double("thumb")
+
+        allow(Fog::AWS::Storage::File).to receive(:new).and_return(original, medium, thumb)
+
+        expect(original).to receive(:destroy).once
+        expect(medium).to receive(:destroy).once
+        expect(thumb).to receive(:destroy).once
+        @dummy.save
+      end
+
+      it "only issues a delete call once for each unique attachment style when destroying model" do
+        @dummy.avatar.clear(:thumb)
+        assert_equal 1, @dummy.avatar.queued_for_delete.size
+
+        file = double("file")
+        allow(Fog::AWS::Storage::File).to receive(:new).and_return(file)
+        expect(file).to receive(:destroy).exactly(3).times
+        @dummy.destroy
+      end
+    end
+
     context "with credentials provided in a path string" do
       before do
         rebuild_model styles: { medium: "300x300>", thumb: "100x100>" },

data/spec/paperclip/storage/s3_spec.rb

@@ -940,6 +940,19 @@ describe Paperclip::Storage::S3 do
         end
       end
 
+      context "and remove, calling S3 Object destroy once per unique style" do
+        before do
+          allow_any_instance_of(Aws::S3::Object).to receive(:exists?).and_return(true)
+          expect_any_instance_of(Aws::S3::Object).to receive(:delete).once
+          @dummy.avatar.clear(:original)
+          @dummy.destroy
+        end
+
+        it "succeeds" do
+          assert true
+        end
+      end
+
       context "that the file were missing" do
         before do
           allow_any_instance_of(Aws::S3::Object).to receive(:exists?).

data/spec/paperclip/validators_spec.rb

@@ -1,6 +1,11 @@
 require "spec_helper"
 
 describe Paperclip::Validators do
+  # required to support a range of rubies
+  def error_attribute_names(error)
+    error.try(:attribute_names) || error.keys
+  end
+
   context "using the helper" do
     before do
       rebuild_class
@@ -22,7 +27,9 @@ describe Paperclip::Validators do
     it "prevents you from attaching a file that violates that validation" do
       Dummy.class_eval { validate(:name) { raise "DO NOT RUN THIS" } }
       dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
-      expect(dummy.errors.keys).to match_array [:avatar_content_type, :avatar, :avatar_file_size]
+      expect(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar_content_type avatar avatar_file_size]
+      )
       assert_raises(RuntimeError) { dummy.valid? }
     end
   end
@@ -47,21 +54,27 @@ describe Paperclip::Validators do
     it "prevents you from attaching a file that violates all of these validations" do
       Dummy.class_eval { validate(:name) { raise "DO NOT RUN THIS" } }
       dummy = Dummy.new(avatar: File.new(fixture_file("spaced file.png")))
-      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      expect(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar avatar_file_name]
+      )
       assert_raises(RuntimeError) { dummy.valid? }
     end
 
     it "prevents you from attaching a file that violates only first of these validations" do
       Dummy.class_eval { validate(:name) { raise "DO NOT RUN THIS" } }
       dummy = Dummy.new(avatar: File.new(fixture_file("5k.png")))
-      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      expect(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar avatar_file_name]
+      )
       assert_raises(RuntimeError) { dummy.valid? }
     end
 
     it "prevents you from attaching a file that violates only second of these validations" do
       Dummy.class_eval { validate(:name) { raise "DO NOT RUN THIS" } }
       dummy = Dummy.new(avatar: File.new(fixture_file("spaced file.jpg")))
-      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      expect(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar avatar_file_name]
+      )
       assert_raises(RuntimeError) { dummy.valid? }
     end
 
@@ -88,7 +101,9 @@ describe Paperclip::Validators do
         end
       end
       dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
-      expect(dummy.errors.keys).to match_array [:avatar_content_type, :avatar, :avatar_file_size]
+      expect(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar_content_type avatar avatar_file_size]
+      )
     end
 
     it "does not validate attachment if title is not present" do
@@ -98,7 +113,7 @@ describe Paperclip::Validators do
         end
       end
       dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
-      assert_equal [], dummy.errors.keys
+      assert_equal [], error_attribute_names(dummy.errors)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kt-paperclip
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.1
 platform: ruby
 authors:
 - Surendra Singhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel