saviour 0.4.5 → 0.4.6

data/spec/feature/dirty_spec.rb

@@ -3,34 +3,42 @@ require 'spec_helper'
 describe "dirty model" do
   before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
 
-  context "provides changes and previous file" do
-    it do
-      uploader = Class.new(Saviour::BaseUploader) { store_dir { "/store/dir" } }
-      klass = Class.new(Test) { include Saviour::Model }
-      klass.attach_file :file, uploader
-      a = klass.create!
+  it "provides changes and previous file" do
+    uploader = Class.new(Saviour::BaseUploader) { store_dir { "/store/dir" } }
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+    a = klass.create!
 
-      with_test_file("example.xml") do |xml_file|
-        with_test_file("camaloon.jpg") do |jpg_file|
-          a.update_attributes! file: xml_file
+    with_test_file("example.xml") do |xml_file|
+      with_test_file("camaloon.jpg") do |jpg_file|
+        a.update_attributes! file: xml_file
 
-          expect(a.changed_attributes).to eq({})
+        expect(a.changed_attributes).to eq({})
 
-          expect(a.file.exists?).to be_truthy
-          expect(a.file_changed?).to be_falsey
-          expect(a.file.persisted?).to be_truthy
+        expect(a.file.exists?).to be_truthy
+        expect(a.file_changed?).to be_falsey
+        expect(a.file.persisted?).to be_truthy
 
-          a.file = jpg_file
-          expect(a.file.persisted?).to be_falsey
+        a.file = jpg_file
+        expect(a.file.persisted?).to be_falsey
 
-          expect(a.file_changed?).to be_truthy
-          expect(a.file_was).to_not eq(a.file)
-          expect(a.file_was.url).to match /\.xml$/
-          expect(a.file_was.persisted?).to be_truthy
+        expect(a.file_changed?).to be_truthy
+        expect(a.file_was).to_not eq(a.file)
+        expect(a.file_was.url).to match /\.xml$/
+        expect(a.file_was.persisted?).to be_truthy
 
-          expect(a.changed_attributes).to include("file" => a.file_was)
-        end
+        expect(a.changed_attributes).to include("file" => a.file_was)
       end
     end
   end
+
+  it "changes are nil when not persisted" do
+    uploader = Class.new(Saviour::BaseUploader) { store_dir { "/store/dir" } }
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+
+    a = klass.new file: Saviour::StringSource.new("contents", "file.txt")
+    expect(a.file_changed?).to be_truthy
+    expect(a.file_was).to be_nil
+  end
 end

data/spec/feature/memory_usage_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe "memory usage" do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  let(:base_klass) {
+    a = Class.new(Test) { include Saviour::Model }
+    a.attach_file :file, uploader
+    a
+  }
+
+  CHUNK = ("A" * 1024).freeze
+
+  let(:size_to_test) { 10 } # Test with 10Mb files
+
+  def with_tempfile
+    f = Tempfile.new "test"
+
+    size_to_test.times do
+      1024.times do
+        f.write CHUNK
+      end
+    end
+    f.flush
+
+    begin
+      yield f
+    ensure
+      f.close!
+    end
+  end
+
+  describe "is kept low when using exclusively with_file processors" do
+    let(:uploader) {
+      Class.new(Saviour::BaseUploader) {
+        store_dir { "/store/dir" }
+
+        process_with_file do |file, filename|
+          digest = Digest::MD5.file(file.path).hexdigest
+          [file, "#{digest}-#{filename}"]
+        end
+      }
+    }
+
+    it do
+      a = base_klass.create!
+
+      with_tempfile do |f|
+        base_line = GetProcessMem.new.mb
+
+        a.update_attributes! file: f
+
+        # Expect memory usage to grow below 10% of the file size
+        expect(GetProcessMem.new.mb - base_line).to be < size_to_test / 10
+      end
+    end
+  end
+
+  describe "increases to file size when using in memory processors" do
+    let(:uploader) {
+      Class.new(Saviour::BaseUploader) {
+        store_dir { "/store/dir" }
+
+        process do |contents, filename|
+          digest = Digest::MD5.hexdigest(contents)
+          [contents, "#{digest}-#{filename}"]
+        end
+      }
+    }
+
+    it do
+      a = base_klass.create!
+
+      with_tempfile do |f|
+        base_line = GetProcessMem.new.mb
+
+        a.update_attributes! file: f
+
+        # Expect memory usage to grow at least the size of the file
+        expect(GetProcessMem.new.mb - base_line).to be > size_to_test
+      end
+    end
+  end
+end

data/spec/feature/{processors_api.rb → processors_api_spec.rb}

@@ -5,8 +5,8 @@ describe "processor's API" do
 
   let(:uploader) {
     Class.new(Saviour::BaseUploader) do
-      store_dir { "/store/dir/#{model.id}" }
-      process { |contents, name| [contents, "#{model.id}-#{attached_as}-#{name}"] }
+      store_dir { "/store/dir/#{model.value}" }
+      process { |contents, name| [contents, "#{model.value}-#{attached_as}-#{name}"] }
     end
   }
 
@@ -14,7 +14,7 @@ describe "processor's API" do
     klass = Class.new(Test) {
       include Saviour::Model
 
-      def id
+      def value
         87
       end
     }
@@ -38,8 +38,8 @@ describe "processor's API" do
   describe "can access store_dir" do
     let(:uploader) {
       Class.new(Saviour::BaseUploader) do
-        store_dir { "/store/dir/#{model.id}" }
-        process { |contents, name| ["FAKE: #{store_dir}", name] }
+        store_dir { "/store/dir/#{model.value}" }
+        process { |_, name| ["FAKE: #{store_dir}", name] }
       end
     }
 
@@ -55,4 +55,21 @@ describe "processor's API" do
       end
     end
   end
+
+  describe "can access id on the model (after_create)" do
+    let(:uploader) {
+      Class.new(Saviour::BaseUploader) do
+        store_dir { "/store/dir/#{model.id}" }
+      end
+    }
+
+    it do
+      with_test_file("example.xml") do |example, name|
+        a = klass.create! file: example
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+        expect(a[:file]).to eq "/store/dir/#{a.id}/#{name}"
+      end
+    end
+  end
 end

data/spec/feature/transactional_behavior_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe "transactional behavior" do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  let(:uploader) {
+    Class.new(Saviour::BaseUploader) {
+      store_dir { "/store/dir" }
+    }
+  }
+
+  let(:klass) {
+    a = Class.new(Test) { include Saviour::Model }
+    a.attach_file :file, uploader
+    a
+  }
+
+  describe "deletion" do
+    it "deletes on after commit" do
+      with_test_file("example.xml") do |example|
+        a = klass.create! file: example
+        expect(a.file.exists?).to be_truthy
+
+        ActiveRecord::Base.transaction do
+          expect(a.destroy).to be_truthy
+          expect(klass.count).to eq 0
+          expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+        end
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_falsey
+      end
+    end
+
+    it "doesn't delete on rollback" do
+      with_test_file("example.xml") do |example|
+        a = klass.create! file: example
+        expect(a.file.exists?).to be_truthy
+
+        ActiveRecord::Base.transaction do
+          expect(a.destroy).to be_truthy
+          expect(klass.count).to eq 0
+          raise ActiveRecord::Rollback
+        end
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+      end
+    end
+  end
+
+  describe "creation" do
+    it "upload happens right after insert" do
+      with_test_file("example.xml") do |example|
+        a = nil
+
+        ActiveRecord::Base.transaction do
+          a = klass.create! file: example
+          expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+        end
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+      end
+    end
+
+    it "upload is deleted on rollback" do
+      with_test_file("example.xml") do |example|
+        path = nil
+
+        ActiveRecord::Base.transaction do
+          a = klass.create! file: example
+          path = a[:file]
+          expect(Saviour::Config.storage.exists?(path)).to be_truthy
+          raise ActiveRecord::Rollback
+        end
+
+        expect(klass.count).to eq 0
+        expect(Saviour::Config.storage.exists?(path)).to be_falsey
+      end
+    end
+  end
+
+  describe "update with a different path" do
+    it "leaves the previous file alive until after commit, then deletes it" do
+      with_test_file("example.xml") do |example|
+        a = klass.create! file: example
+        path1 = a[:file]
+        expect(Saviour::Config.storage.exists?(path1)).to be_truthy
+
+        with_test_file("camaloon.jpg") do |file2|
+          ActiveRecord::Base.transaction do
+            a.update_attributes! file: file2
+
+            expect(Saviour::Config.storage.exists?(path1)).to be_truthy
+            expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+          end
+
+          expect(Saviour::Config.storage.exists?(path1)).to be_falsey
+        end
+      end
+    end
+
+    it "on rollback doesn't delete previous file and deletes new file" do
+      with_test_file("example.xml") do |example|
+        a = klass.create! file: example
+        path1 = a[:file]
+        path2 = nil
+        expect(Saviour::Config.storage.exists?(path1)).to be_truthy
+
+        with_test_file("camaloon.jpg") do |file2|
+          ActiveRecord::Base.transaction do
+            a.update_attributes! file: file2
+            path2 = a[:file]
+
+            expect(Saviour::Config.storage.exists?(path1)).to be_truthy
+            expect(Saviour::Config.storage.exists?(path2)).to be_truthy
+
+            raise ActiveRecord::Rollback
+          end
+
+          expect(a.reload[:file]).to eq path1
+
+          expect(Saviour::Config.storage.exists?(path1)).to be_truthy
+          expect(Saviour::Config.storage.exists?(path2)).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe "update with the same path" do
+    before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+    it "leaves the previous file contents on rollback" do
+      a = klass.create! file: Saviour::StringSource.new("original content", "file.txt")
+
+      expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+      expect(Saviour::Config.storage.read(a[:file])).to eq "original content"
+
+      ActiveRecord::Base.transaction do
+        a.update_attributes! file: Saviour::StringSource.new("new content", "file.txt")
+        expect(Saviour::Config.storage.read(a[:file])).to eq "new content"
+        raise ActiveRecord::Rollback
+      end
+
+      expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+      expect(Saviour::Config.storage.read(a[:file])).to eq "original content"
+    end
+  end
+end

data/spec/feature/validations_spec.rb

@@ -150,4 +150,23 @@ describe "validations saving a new file" do
       expect(a.errors[:file][0]).to eq "Received error in file"
     end
   end
+
+  describe "validations with file" do
+    it "fails reading the contents" do
+      klass = Class.new(base_klass) do
+        attach_validation_with_file :file, :check_contents
+
+        def check_contents(file, _, opts)
+          errors.add(:file, "Error!") if ::File.read(file.path) == "X"
+        end
+      end
+
+      Tempfile.open("") do |f|
+        f.write("X")
+        f.flush
+        a = klass.new file: f
+        expect(a).not_to be_valid
+      end
+    end
+  end
 end

data/spec/feature/with_copy_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe "#with_copy" do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  let(:uploader) do
+    Class.new(Saviour::BaseUploader) {
+      store_dir { "/store/dir" }
+      process { |contents, filename| [contents, "foo_#{filename}"] }
+    }
+  end
+
+  let(:klass) do
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+    klass
+  end
+
+  it "provides a copy of the stored file" do
+    a = klass.create! file: Saviour::StringSource.new("some contents", "houhou.txt")
+    a.file.with_copy do |tmpfile|
+      expect(tmpfile.read).to eq "some contents"
+    end
+  end
+
+  it "deletes the copied file even on exception" do
+    test_exception = Class.new(StandardError)
+
+    a = klass.create! file: Saviour::StringSource.new("some contents", "houhou.txt")
+    path = nil
+
+    begin
+      a.file.with_copy do |f|
+        path = f.path
+        expect(File.file?(path)).to be_truthy
+        raise(test_exception, "some exception within the block")
+      end
+    rescue test_exception
+    end
+
+    expect(File.file?(path)).to be_falsey
+  end
+end

data/spec/models/base_uploader_spec.rb

@@ -1,16 +1,6 @@
 require 'spec_helper'
 
 describe Saviour::BaseUploader do
-  let(:mocked_storage) {
-    Class.new {
-      def write(content, filename)
-        # pass
-      end
-    }.new
-  }
-  before { allow(Saviour::Config).to receive(:storage).and_return(mocked_storage) }
-
-
   describe "DSL" do
     subject { Class.new(Saviour::BaseUploader) }
 
@@ -81,14 +71,14 @@ describe Saviour::BaseUploader do
     end
   end
 
-  describe "#write" do
+  describe "#_process_as_contents" do
     subject { uploader.new(data: { model: "model", attached_as: "attached_as" }) }
 
     context do
       let(:uploader) { Class.new(Saviour::BaseUploader) }
 
       it "error if no store_dir" do
-        expect { subject.write("contents", "filename.jpg") }.to raise_error(RuntimeError)
+        expect { subject._process_as_contents("contents", "filename.jpg") }.to raise_error(Saviour::ConfigurationError)
       end
     end
 
@@ -97,13 +87,8 @@ describe Saviour::BaseUploader do
         store_dir { "/store/dir" }
       } }
 
-      it "calls storage write" do
-        expect(Saviour::Config.storage).to receive(:write).with("contents", "/store/dir/file.jpg")
-        subject.write("contents", "file.jpg")
-      end
-
-      it "returns the fullpath" do
-        expect(subject.write("contents", "file.jpg")).to eq '/store/dir/file.jpg'
+      it "returns the final contents and fullpath" do
+        expect(subject._process_as_contents("contents", "file.jpg")).to eq ["contents", '/store/dir/file.jpg']
       end
     end
 
@@ -120,8 +105,7 @@ describe Saviour::BaseUploader do
 
       it "calls the processors" do
         expect(subject).to receive(:resize).with("content", "output.png").and_call_original
-        expect(Saviour::Config.storage).to receive(:write).with("content-x2", "/store/dir/output.png")
-        subject.write("content", "output.png")
+        expect(subject._process_as_contents("content", "output.png")).to eq ["content-x2", "/store/dir/output.png"]
       end
     end
 
@@ -138,8 +122,7 @@ describe Saviour::BaseUploader do
       } }
 
       it "respects ordering on processor calling" do
-        expect(Saviour::Config.storage).to receive(:write).with("content-x2_x9", "/store/dir/prefix-output.png")
-        subject.write("content", "output.png")
+        expect(subject._process_as_contents("content", "output.png")).to eq ["content-x2_x9", "/store/dir/prefix-output.png"]
       end
     end
 
@@ -155,8 +138,7 @@ describe Saviour::BaseUploader do
       } }
 
       it "calls the method using the stored arguments" do
-        expect(Saviour::Config.storage).to receive(:write).with("content-50-10", "/store/dir/output.png")
-        subject.write("content", "output.png")
+        expect(subject._process_as_contents("content", "output.png")).to eq ["content-50-10", "/store/dir/output.png"]
       end
     end
 
@@ -176,8 +158,7 @@ describe Saviour::BaseUploader do
       subject { uploader.new(data: { model: model, attached_as: "attached_as" }) }
 
       it "can access model from processors" do
-        expect(Saviour::Config.storage).to receive(:write).with("content", "/store/dir/Robert_8_output.png")
-        subject.write("content", "output.png")
+        expect(subject._process_as_contents("content", "output.png")).to eq ["content", "/store/dir/Robert_8_output.png"]
       end
     end
 
@@ -188,8 +169,8 @@ describe Saviour::BaseUploader do
       } }
 
       it do
-        expect(Saviour::Config.storage).to_not receive(:write)
-        expect(subject.write("contents", "file.jpg")).to be_nil
+        expect(Saviour::Config.storage).to_not receive(:_process_as_contents)
+        expect(subject._process_as_contents("contents", "file.jpg")).to be_nil
       end
     end
   end
@@ -211,8 +192,7 @@ describe Saviour::BaseUploader do
 
       it "calls the processors" do
         expect(subject).to receive(:foo).with(an_instance_of(Tempfile), "output.png").and_call_original
-        expect(Saviour::Config.storage).to receive(:write).with("modified-contents", "/store/dir/output.png")
-        subject.write("contents", "output.png")
+        expect(subject._process_as_contents("contents", "output.png")).to eq ["modified-contents", "/store/dir/output.png"]
       end
     end
 
@@ -237,8 +217,7 @@ describe Saviour::BaseUploader do
       } }
 
       it "can mix types of runs between file and contents" do
-        expect(Saviour::Config.storage).to receive(:write).with("pre-contents_first_run-modified-contents", "/store/dir/pre-aaa.png")
-        subject.write("contents", "aaa.png")
+        expect(subject._process_as_contents("contents", "aaa.png")).to eq ["pre-contents_first_run-modified-contents", "/store/dir/pre-aaa.png"]
       end
     end
   end