saviour 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1da8130c0e682e7d8c0d86a936a498a8d70d85f5feb8b94d287217062bbb69c
-  data.tar.gz: ce046b7ff42417a32229f5ba4ee717ecf4a49c1d07ab0923aae3b96152d998ec
+  metadata.gz: e06f1497a5f51dab300598d70e8c31f3930255ed8398857725cf5a6d7789a7b2
+  data.tar.gz: 915adfc7973e402555b7edcf7fef4791227098c065f37aa867df519d5c73902d
 SHA512:
-  metadata.gz: 5b532b295d640352549307de69ac0bf4d4ca63cb1f8312d4e43f97f98d28a122b4249e31e44dc4ee5d99e24a811d31e63f1dfb22d4cda280f20ba634a077f571
-  data.tar.gz: da792dd8c19baa075f43ba22062f7f8bc920e985f465c5b09660e31e762f5b8c13e93ef3847c9d7fdefe673bbba3dac60c58a920240f76cb91d3611536399741
+  metadata.gz: f477a2b6baa7a031b8ddef7634b3d086651c309c67c9e41328654a42569ef9dc9ecbe096cf680b3ac7447ef5f29d3e807f136ea8f704ed406cac0de624a4366a
+  data.tar.gz: bf268771af642e63095e82abb1cee2bc28149a51d918b48a2dbd5228e9d7262785f2a5b66325b8339acc577fcf17fd3b3914419a5de2b61144e2d23318454195

data/lib/saviour/file.rb

@@ -71,8 +71,12 @@ module Saviour
     def assign(object)
       raise(SourceError, "given object to #assign or #<attach_as>= must respond to `read`") if object && !object.respond_to?(:read)
 
-      followers = @model.class.attached_followers_per_leader[@attached_as]
-      followers.each { |x| @model.send(x).assign(object) unless @model.send(x).changed? } if followers
+      followers = @model.class.followers_per_leader_config[@attached_as]
+
+      (followers || []).each do |x|
+        attachment = @model.send(x[:attachment])
+        attachment.assign(object) unless attachment.changed?
+      end
 
       @source_data = nil
       @source = object

data/lib/saviour/integrator.rb

@@ -10,8 +10,8 @@ module Saviour
 
       @klass.class_attribute :attached_files
       @klass.attached_files = []
-      @klass.class_attribute :attached_followers_per_leader
-      @klass.attached_followers_per_leader = {}
+      @klass.class_attribute :followers_per_leader_config
+      @klass.followers_per_leader_config = {}
 
       klass = @klass
       persistence_klass = @persistence_klass
@@ -21,8 +21,14 @@ module Saviour
         uploader_klass = maybe_uploader_klass[0]
 
         if opts[:follow]
-          klass.attached_followers_per_leader[opts[:follow]] ||= []
-          klass.attached_followers_per_leader[opts[:follow]].push(attach_as)
+          dependent = opts[:dependent]
+
+          if dependent.nil? || ![:destroy, :ignore].include?(dependent)
+            raise(ConfigurationError, "You must specify a :dependent option when using :follow. Use either :destroy or :ignore")
+          end
+
+          klass.followers_per_leader_config[opts[:follow]] ||= []
+          klass.followers_per_leader_config[opts[:follow]].push({ attachment: attach_as, dependent: dependent })
         end
 
         if uploader_klass.nil? && block.nil?
@@ -50,17 +56,33 @@ module Saviour
             send(attach_as).changed?
           end
 
-          define_method("remove_#{attach_as}!") do
-            work = proc do
-              send(attach_as).delete
-              layer = persistence_klass.new(self)
-              layer.write(attach_as, nil)
+          define_method("remove_#{attach_as}!") do |dependent: nil|
+            if !dependent.nil? && ![:destroy, :ignore].include?(dependent)
+              raise ArgumentError, ":dependent option must be either :destroy or :ignore"
+            end
+
+            layer = persistence_klass.new(self)
+
+            attachment_remover = proc do |attach_as|
+              work = proc do
+                send(attach_as).delete
+                layer.write(attach_as, nil)
+              end
+
+              if ActiveRecord::Base.connection.current_transaction.open?
+                DbHelpers.run_after_commit &work
+              else
+                work.call
+              end
             end
 
-            if ActiveRecord::Base.connection.current_transaction.open?
-              DbHelpers.run_after_commit &work
-            else
-              work.call
+            attachment_remover.call(attach_as)
+
+            (self.class.followers_per_leader_config[attach_as] || []).each do |follower|
+              dependent_option = dependent || follower[:dependent]
+              next if dependent_option == :ignore || send(follower[:attachment]).changed?
+
+              attachment_remover.call(follower[:attachment])
             end
           end
         end
@@ -68,6 +90,12 @@ module Saviour
         klass.include mod
       end
 
+      @klass.define_singleton_method("attached_followers_per_leader") do
+        self.followers_per_leader_config.map do |leader, followers|
+          [leader, followers.map { |data| data[:attachment] }]
+        end.to_h
+      end
+
       @klass.class_attribute :__saviour_validations
 
       @klass.define_singleton_method("attach_validation") do |attach_as, method_name = nil, &block|

data/lib/saviour/s3_storage.rb

@@ -26,6 +26,7 @@ module Saviour
         raise(KeyTooLarge, "The key in S3 must be at max 1024 bytes, this key is too big: #{path}")
       end
 
+      # TODO: Use multipart api
       client.put_object(@create_options.merge(body: file_or_contents, bucket: @bucket, key: path))
     end
 
@@ -36,20 +37,23 @@ module Saviour
     end
 
     def read_to_file(path, dest_file)
+      path = sanitize_leading_slash(path)
+
       dest_file.binmode
       dest_file.rewind
       dest_file.truncate(0)
 
-      io = get_file_stringio(path)
-      while data = io.read(1024 * 1024)
-        dest_file.write(data)
-      end
-
-      dest_file.flush
+      client.get_object({ bucket: @bucket, key: path }, target: dest_file)
+    rescue Aws::S3::Errors::NotFound, Aws::S3::Errors::NoSuchKey
+      raise FileNotPresent, "Trying to read an unexisting path: #{path}"
     end
 
     def read(path)
-      get_file_stringio(path).read
+      path = sanitize_leading_slash(path)
+
+      client.get_object(bucket: @bucket, key: path).body.read
+    rescue Aws::S3::Errors::NotFound, Aws::S3::Errors::NoSuchKey
+      raise FileNotPresent, "Trying to read an unexisting path: #{path}"
     end
 
     def delete(path)
@@ -57,7 +61,7 @@ module Saviour
 
       client.delete_object(
         bucket: @bucket,
-        key: path,
+        key: path
       )
     end
 
@@ -101,17 +105,6 @@ module Saviour
 
     private
 
-    def get_file_stringio(path)
-      path = sanitize_leading_slash(path)
-
-      client.get_object(
-        bucket: @bucket,
-        key: path
-      ).body
-    rescue Aws::S3::Errors::NotFound, Aws::S3::Errors::NoSuchKey
-      raise FileNotPresent, "Trying to read an unexisting path: #{path}"
-    end
-
     def public_url_prefix
       if @public_url_prefix.respond_to?(:call)
         @public_url_prefix.call

data/lib/saviour/version.rb

@@ -1,3 +1,3 @@
 module Saviour
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/saviour.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activerecord", ">= 5.0", "< 5.2"
   spec.add_dependency "activesupport", ">= 5.0"
   spec.add_dependency "concurrent-ruby", ">= 1.0.5"
 

data/spec/feature/concurrent_processors_spec.rb

@@ -3,7 +3,13 @@ require 'spec_helper'
 describe "concurrent processors" do
   before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
 
-  WAIT_TIME = 0.5
+  if ENV['TRAVIS']
+    WAIT_TIME = 2
+    THRESHOLD = 1.5
+  else
+    WAIT_TIME = 0.5
+    THRESHOLD = 0.1
+  end
 
   let(:uploader) {
     Class.new(Saviour::BaseUploader) {
@@ -52,7 +58,7 @@ describe "concurrent processors" do
                            file_thumb_3: Saviour::StringSource.new("contents", "file_4.txt")
 
       start_times = a.times.values.sort
-      expect((start_times[0] - start_times[-1]).abs).to be_within(0.1).of(0)
+      expect((start_times[0] - start_times[-1]).abs).to be_within(THRESHOLD).of(0)
     end
 
     it 'works in serial with 1 worker' do
@@ -80,8 +86,8 @@ describe "concurrent processors" do
                            file_thumb_3: Saviour::StringSource.new("contents", "file_4.txt")
 
       start_times = a.times.values.sort
-      expect((start_times[0] - start_times[1]).abs).to be_within(0.1).of(0)
-      expect((start_times[2] - start_times[3]).abs).to be_within(0.1).of(0)
+      expect((start_times[0] - start_times[1]).abs).to be_within(THRESHOLD).of(0)
+      expect((start_times[2] - start_times[3]).abs).to be_within(THRESHOLD).of(0)
       expect((start_times[0] - start_times[-1]).abs).to be > WAIT_TIME
     end
   end
@@ -96,7 +102,7 @@ describe "concurrent processors" do
                         file_thumb_3: Saviour::StringSource.new("contents", "file_4.txt")
 
       start_times = a.times.values.sort
-      expect((start_times[0] - start_times[-1]).abs).to be_within(0.1).of(0)
+      expect((start_times[0] - start_times[-1]).abs).to be_within(THRESHOLD).of(0)
     end
 
     it 'works in serial with 1 worker' do
@@ -120,8 +126,8 @@ describe "concurrent processors" do
                         file_thumb_3: Saviour::StringSource.new("contents", "file_4.txt")
 
       start_times = a.times.values.sort
-      expect((start_times[0] - start_times[1]).abs).to be_within(0.1).of(0)
-      expect((start_times[2] - start_times[3]).abs).to be_within(0.1).of(0)
+      expect((start_times[0] - start_times[1]).abs).to be_within(THRESHOLD).of(0)
+      expect((start_times[2] - start_times[3]).abs).to be_within(THRESHOLD).of(0)
       expect((start_times[0] - start_times[-1]).abs).to be > WAIT_TIME
     end
   end

data/spec/feature/follow_file_spec.rb

@@ -22,7 +22,7 @@ describe "Make one attachment follow another one" do
   let(:klass) {
     a = Class.new(Test) { include Saviour::Model }
     a.attach_file :file, uploader
-    a.attach_file :file_thumb, uploader_for_version, follow: :file
+    a.attach_file :file_thumb, uploader_for_version, follow: :file, dependent: :ignore
     a
   }
 
@@ -50,4 +50,71 @@ describe "Make one attachment follow another one" do
       expect(a.file_thumb.read.bytesize).to eq 32
     end
   end
+
+  describe "dependent destruction" do
+    context "with dependent: :destroy" do
+      let(:klass) {
+        a = Class.new(Test) { include Saviour::Model }
+        a.attach_file :file, uploader
+        a.attach_file :file_thumb, uploader_for_version, follow: :file, dependent: :destroy
+        a
+      }
+
+      it "removes followers" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        a.remove_file!
+        expect(a.file_thumb?).to be_falsey
+        expect(a.file_thumb.read).to be_nil
+      end
+
+      it "does not remove follower if it has been changed before destruction in a transaction" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        ActiveRecord::Base.transaction do
+          a.file_thumb = StringIO.new("replaced contents")
+          a.remove_file!
+          a.save!
+        end
+
+        expect(a.file_thumb?).to be_truthy
+        expect(a.file_thumb.read).to eq "replaced contents"
+        expect(a.file?).to be_falsey
+      end
+
+      it "does not remove follower if it has been changed before destruction outside a transaction" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        a.file_thumb = StringIO.new("replaced contents")
+        a.remove_file!
+        a.save!
+
+        expect(a.file_thumb?).to be_truthy
+        expect(a.file_thumb.read).to eq "replaced contents"
+        expect(a.file?).to be_falsey
+      end
+    end
+
+    context "with dependent: :ignore" do
+      let(:klass) {
+        a = Class.new(Test) { include Saviour::Model }
+        a.attach_file :file, uploader
+        a.attach_file :file_thumb, uploader_for_version, follow: :file, dependent: :ignore
+        a
+      }
+
+      it "leaves followers" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        a.remove_file!
+        expect(a.file_thumb?).to be_truthy
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+        expect(a.file.read).to be_nil
+      end
+    end
+  end
 end

data/spec/feature/introspection_spec.rb

@@ -22,7 +22,7 @@ describe "Introspection of attached files" do
   let(:klass) {
     a = Class.new(Test) { include Saviour::Model }
     a.attach_file :file, uploader
-    a.attach_file :file_thumb, uploader_for_version, follow: :file
+    a.attach_file :file_thumb, uploader_for_version, follow: :file, dependent: :ignore
     a
   }
 

data/spec/feature/remove_attachment_spec.rb

@@ -5,7 +5,7 @@ describe "remove attachment" do
 
   let(:uploader) {
     Class.new(Saviour::BaseUploader) {
-      store_dir { "/store/dir" }
+      store_dir { "/store/dir/#{model.id}/#{attached_as}" }
     }
   }
 
@@ -80,4 +80,46 @@ describe "remove attachment" do
       expect(a[:file]).to be_nil
     end
   end
+
+  context "with followers" do
+    context "when configured to destroy followers" do
+      let(:klass) {
+        a = Class.new(Test) { include Saviour::Model }
+        a.attach_file :file, uploader
+        a.attach_file :file_thumb, uploader, follow: :file, dependent: :destroy
+        a
+      }
+
+      it "does not remove followers when using dependent: :ignore on the remove call" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        a.remove_file!(dependent: :ignore)
+
+        expect(a.file_thumb?).to be_truthy
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+        expect(a.file?).to be_falsey
+      end
+    end
+
+    context "when configured to ignore followers" do
+      let(:klass) {
+        a = Class.new(Test) { include Saviour::Model }
+        a.attach_file :file, uploader
+        a.attach_file :file_thumb, uploader, follow: :file, dependent: :ignore
+        a
+      }
+
+      it "does remove followers when using dependent: :destroy on the remove call" do
+        a = klass.create! file: StringIO.new("some contents without a filename")
+        expect(a.file_thumb.read).to eq "some contents without a filename"
+
+        a.remove_file!(dependent: :destroy)
+
+        expect(a.file_thumb?).to be_falsey
+        expect(a.file_thumb.read).to be_nil
+        expect(a.file?).to be_falsey
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -253,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: File storage handler following active record model lifecycle