saviour 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74f1d7faa90b8712dbf65f86ce592db60c296ac3
-  data.tar.gz: 680a73e0bb124fc7de9ca66ea09e1ee486088731
+  metadata.gz: 6a8dde206061328305a93bbcbcf03ef6e15d9659
+  data.tar.gz: 828b58ec76d1974a88bf595ea2306cded359f752
 SHA512:
-  metadata.gz: a152333b01f299de797c04ab0d76a07401ebdf673cb2e2d93f02151b495b4d8d18bafbec884b9ddb53aaf12ae94bf409d0e1769ae60e0e06fa939be14486a2ea
-  data.tar.gz: eabe42debcdc6c8caf0e48f8fbb4645964bb848329198844607ef0b7b3cd93bd41855bfdf5ccb71aaaac717921c10b6c6203203ad203d3eb1c03236fced79860
+  metadata.gz: 0a13bc0dced7f96b5306a6ef7dbb72f01a66d8b9f9f962b4de99697eea8212db71f706abb9f7d12ef1cb29ae5a879d329c408937ddffd9f225d1c35ae4bb4e76
+  data.tar.gz: dee3ef8dab84f49536c9c311d23e97cbe66ee6e1e5278fe48f02267720dfa7178a424b814746ba0dd1fdf67d4cd8e213c11f37d17e26144fa1bd281e40a801ea

data/README.md

@@ -410,6 +410,20 @@ some File instance different than the one you received pointing to a file.
 
 From inside a process you can also access the current store dir with `store_dir`.
 
+From inside a process, you can also call `halt_process` to abort the current processing and upload of the file.
+This can be useful for example for an "image_thumb" attachment that can be generic. If you're able to generate a
+thumbnail image for the given file, then it works normally, otherwise halt:
+
+```ruby
+process_with_file do |file, filename|
+  if can_generate_thumbnail?(file) # Only if jpg, png or pdf file
+    create_thumbnail(file, filename)
+  else
+    halt_process
+  end
+end
+```
+
 Finally, processors can be disabled entirely via a configuration parameter. Example:
 
 ```

data/lib/saviour/base_uploader.rb

@@ -22,13 +22,20 @@ module Saviour
     def write(contents, filename)
       raise RuntimeError, "Please use `store_dir` before trying to write" unless store_dir
 
-      if Config.processing_enabled
-        contents, filename = Uploader::ProcessorsRunner.new(self).run!(contents, filename)
+      catch(:halt_process) do
+        if Config.processing_enabled
+          contents, filename = Uploader::ProcessorsRunner.new(self).run!(contents, filename)
+        end
+
+        path = ::File.join(store_dir, filename)
+        Config.storage.write(contents, path)
+
+        path
       end
+    end
 
-      path = ::File.join(store_dir, filename)
-      Config.storage.write(contents, path)
-      path
+    def halt_process
+      throw(:halt_process)
     end
 
     def store_dir

data/lib/saviour/file.rb

@@ -105,8 +105,11 @@ module Saviour
 
       path = uploader.write(source_data, filename_to_be_assigned)
       @source_was = @source
-      @persisted_path = path
-      path
+
+      if path
+        @persisted_path = path
+        path
+      end
     end
 
     def source_data

data/lib/saviour/life_cycle.rb

@@ -32,7 +32,7 @@ module Saviour
       Config.storage.delete(current_path) if current_path
 
       new_path = @model.send(column).write
-      persistence_layer.write(column, new_path) if persistence_layer
+      persistence_layer.write(column, new_path) if persistence_layer && new_path
     end
 
     def attached_files

data/lib/saviour/version.rb

@@ -1,3 +1,3 @@
 module Saviour
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

data/spec/feature/halt_processor_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "halt processor 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) do
+      store_dir { "/store/dir" }
+      process { |_contents, _name| halt_process }
+    end
+  }
+
+  let(:klass) {
+    klass = Class.new(Test) {
+      include Saviour::Model
+    }
+    klass.attach_file :file, uploader
+    klass
+  }
+
+  it "does not write the file" do
+    a = klass.create!
+
+    expect(Saviour::Config.storage).to_not receive(:write)
+
+    a.update_attributes! file: StringIO.new("contents")
+    expect(a.reload.read_attribute(:file)).to be_nil
+  end
+
+  it "is considered as not persisted after save" do
+    a = klass.new
+    a.file = StringIO.new("contents")
+    expect(a.file.persisted?).to be_falsey
+    a.save
+    expect(a.file.persisted?).to be_falsey
+  end
+
+  it "is considered as not dirty after save" do
+    a = klass.new
+    a.file = StringIO.new("contents")
+    expect(a.file.changed?).to be_truthy
+    a.save
+    expect(a.file.changed?).to be_falsey
+  end
+end

data/spec/models/base_uploader_spec.rb

@@ -28,7 +28,7 @@ describe Saviour::BaseUploader do
       expect(subject.processors[0][:opts]).to eq({})
 
       expect(subject.processors[1][:method_or_block]).to eq :resize
-      expect(subject.processors[1][:opts]).to eq({width: 50})
+      expect(subject.processors[1][:opts]).to eq({ width: 50 })
     end
 
     it do
@@ -66,23 +66,23 @@ describe Saviour::BaseUploader do
 
   describe "initialization with data" do
     it "can declare wathever" do
-      uploader = Class.new(Saviour::BaseUploader).new(data: {a: "2", data: "my file"})
+      uploader = Class.new(Saviour::BaseUploader).new(data: { a: "2", data: "my file" })
       expect(uploader).to respond_to :a
       expect(uploader).to respond_to :data
       expect(uploader.a).to eq "2"
     end
 
     it do
-      uploader = Class.new(Saviour::BaseUploader).new(data: {a: "2", data: "my file"})
+      uploader = Class.new(Saviour::BaseUploader).new(data: { a: "2", data: "my file" })
       expect(uploader).to respond_to :a
 
-      uploader = Class.new(Saviour::BaseUploader).new(data: {name: "johny"})
+      uploader = Class.new(Saviour::BaseUploader).new(data: { name: "johny" })
       expect(uploader).not_to respond_to :a
     end
   end
 
   describe "#write" do
-    subject { uploader.new(data: {model: "model", attached_as: "attached_as"}) }
+    subject { uploader.new(data: { model: "model", attached_as: "attached_as" }) }
 
     context do
       let(:uploader) { Class.new(Saviour::BaseUploader) }
@@ -173,17 +173,29 @@ describe Saviour::BaseUploader do
       } }
 
       let(:model) { double(id: 8, name: "Robert") }
-      subject { uploader.new(data: {model: model, attached_as: "attached_as"}) }
+      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")
       end
     end
+
+    describe "returns nil if halted" do
+      let(:uploader) { Class.new(Saviour::BaseUploader) {
+        store_dir { "/store/dir" }
+        process { halt_process }
+      } }
+
+      it do
+        expect(Saviour::Config.storage).to_not receive(:write)
+        expect(subject.write("contents", "file.jpg")).to be_nil
+      end
+    end
   end
 
   describe "#process_with_file" do
-    subject { uploader.new(data: {model: "model", attached_as: "attached_as"}) }
+    subject { uploader.new(data: { model: "model", attached_as: "attached_as" }) }
 
     context do
       let(:uploader) { Class.new(Saviour::BaseUploader) {

data/spec/models/file_spec.rb

@@ -119,7 +119,7 @@ describe Saviour::File do
 
       uploader = double
       allow(file).to receive(:uploader).and_return(uploader)
-      expect(uploader).to receive(:write)
+      expect(uploader).to receive(:write).and_return("/some/path")
       file.write
 
       expect(file).not_to be_changed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -177,6 +177,7 @@ files:
 - spec/feature/crud_workflows_spec.rb
 - spec/feature/dirty_spec.rb
 - spec/feature/follow_file_spec.rb
+- spec/feature/halt_processor_spec.rb
 - spec/feature/persisted_path_spec.rb
 - spec/feature/processors_api.rb
 - spec/feature/reload_model_spec.rb