saviour 0.3.1 → 0.4.0

data/lib/saviour/uploader/store_dir_extractor.rb

@@ -5,33 +5,17 @@ module Saviour
         @uploader = uploader
       end
 
-      def candidate_store_dirs
-        @candidate_store_dirs ||= @uploader.class.store_dirs
-      end
-
-      def versioned_store_dirs?
-        candidate_store_dirs.any? { |x| x.versioned? && x.version == @uploader.version_name }
-      end
-
-      def versioned_store_dir
-        candidate_store_dirs.select { |x| x.versioned? && x.version == @uploader.version_name }.last if versioned_store_dirs?
-      end
-
-      def non_versioned_store_dir
-        candidate_store_dirs.select { |x| !x.versioned? }.last
-      end
-
       def store_dir_handler
-        @store_dir_handler ||= versioned_store_dir || non_versioned_store_dir
+        @store_dir_handler ||= @uploader.class.store_dirs.last
       end
 
       def store_dir
         @store_dir ||= begin
           if store_dir_handler
-            if store_dir_handler.block?
-              @uploader.instance_eval(&store_dir_handler.method_or_block)
+            if store_dir_handler.respond_to?(:call)
+              @uploader.instance_eval(&store_dir_handler)
             else
-              @uploader.send(store_dir_handler.method_or_block)
+              @uploader.send(store_dir_handler)
             end
           end
         end

data/lib/saviour/url_source.rb

@@ -9,21 +9,29 @@ module Saviour
       @uri = wrap_uri_string(url)
     end
 
-    def read
-      with_retry(3) { resolve(@uri) }
+    def read(*args)
+      stringio.read(*args)
     end
 
-    def original_filename
-      ::File.basename(@uri.path)
+    def rewind
+      stringio.rewind
     end
 
-    def path
-      @uri.path
+    def original_filename
+      ::File.basename(@uri.path)
     end
 
 
     private
 
+    def stringio
+      @stringio ||= StringIO.new(raw_data)
+    end
+
+    def raw_data
+      @raw_data ||= with_retry(3) { resolve(@uri) }
+    end
+
     def resolve(uri, max_redirects = MAX_REDIRECTS)
       raise RuntimeError, "Max number of allowed redirects reached (#{MAX_REDIRECTS}) when resolving #{uri}" if max_redirects == 0
 

data/lib/saviour/validator.rb

@@ -8,21 +8,19 @@ module Saviour
 
     def validate!
       validations.each do |column, method_or_blocks|
-        raise(ArgumentError, "There is no attachment defined as '#{column}'") unless attached_files[column]
-        (attached_files[column] + [nil]).each do |version|
-          if @model.send(column, version).changed?
-            method_or_blocks.each { |method_or_block| run_validation(column, version, method_or_block) }
-          end
+        raise(ArgumentError, "There is no attachment defined as '#{column}'") unless attached_files.include?(column)
+        if @model.send(column).changed?
+          method_or_blocks.each { |method_or_block| run_validation(column, method_or_block) }
         end
       end
     end
 
     private
 
-    def run_validation(column, version, method_or_block)
-      data = @model.send(column, version).source_data
-      filename = @model.send(column, version).filename_to_be_assigned
-      opts = {attached_as: column, version: version}
+    def run_validation(column, method_or_block)
+      data = @model.send(column).source_data
+      filename = @model.send(column).filename_to_be_assigned
+      opts = { attached_as: column }
 
       if method_or_block.respond_to?(:call)
         if method_or_block.arity == 2
@@ -40,7 +38,7 @@ module Saviour
     end
 
     def attached_files
-      @model.class.attached_files || {}
+      @model.class.attached_files
     end
 
     def validations

data/lib/saviour/version.rb

@@ -1,3 +1,3 @@
 module Saviour
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/saviour.gemspec

@@ -15,8 +15,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.1.0"
 
-  spec.add_dependency "fog-aws"
-  spec.add_dependency "mime-types"
   spec.add_dependency "activerecord", ">= 4.0"
   spec.add_dependency "activesupport", ">= 4.0"
 
@@ -25,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "fog-aws"
+  spec.add_development_dependency "mime-types"
 end

data/spec/feature/allow_overriding_attached_as_method.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "method override" do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  it "works with user redefinition" do
+    uploader = Class.new(Saviour::BaseUploader) {
+      store_dir { "/store/dir" }
+      process { |contents, filename| [contents, "foo_#{filename}"] }
+    }
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+    klass.class_eval do
+      attr_accessor :setter_bean, :getter_bean
+
+      def file=(value)
+        self.setter_bean = 'setted!'
+        super
+      end
+
+      def file
+        self.getter_bean = 'getted!'
+        super
+      end
+    end
+
+    a = klass.create! file: Saviour::StringSource.new("content", "houhou.txt")
+    expect(a.setter_bean).to eq 'setted!'
+    expect(a.file.filename).to eq "foo_houhou.txt"
+    expect(a.file.url).to eq 'http://domain.com/store/dir/foo_houhou.txt'
+    expect(a.getter_bean).to eq 'getted!'
+  end
+end

data/spec/feature/follow_file_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "Make one attachment follow another one" 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" }
+    end
+  }
+
+  let(:uploader_for_version) {
+    Class.new(Saviour::BaseUploader) do
+      store_dir { "/store/dir" }
+
+      process do |contents, filename|
+        [contents, "new_#{filename}"]
+      end
+    end
+  }
+
+  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
+  }
+
+  describe "automatic assignation" do
+    it "works when :file is assigned if previously empty" do
+      a = klass.create! file: Saviour::StringSource.new("blabla", "cuca.xml")
+
+      expect(a.file.filename).to eq "cuca.xml"
+      expect(a.file_thumb.filename).to eq "new_cuca.xml"
+
+      expect(a.file.read.bytesize).to eq 6
+      expect(a.file_thumb.read.bytesize).to eq 6
+    end
+
+    it "does not override a previously assigned source" do
+      a = klass.new
+      a.file_thumb = StringIO.new("some contents without a filename")
+      a.file = Saviour::StringSource.new("blabla", "cuca.xml")
+      a.save!
+
+      expect(a.file.filename).to eq "cuca.xml"
+      expect(a.file_thumb.read).to eq "some contents without a filename"
+
+      expect(a.file.read.bytesize).to eq 6
+      expect(a.file_thumb.read.bytesize).to eq 32
+    end
+  end
+end

data/spec/feature/rewind_source_before_read.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'source is rewinded before read' do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  it do
+    uploader = Class.new(Saviour::BaseUploader) {
+      store_dir { "/store/dir/#{model.id}" }
+    }
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+
+    with_test_file("example.xml") do |file|
+      a = klass.create! file: file
+      b = klass.create! file: file
+
+      expect(a.file.read.bytesize).to eq 409
+      expect(b.file.read.bytesize).to eq 409
+    end
+  end
+end

data/spec/feature/uploader_declaration.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe "uploader declaration" do
+  before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
+
+  it "raises exception if not provided either way" do
+    expect {
+      klass = Class.new(Test) { include Saviour::Model }
+      klass.attach_file :file
+    }.to raise_error.with_message "you must provide either an UploaderClass or a block to define it."
+  end
+
+  it "lets you provide uploader as a class" do
+    uploader = Class.new(Saviour::BaseUploader) {
+      store_dir { "/store/dir" }
+      process { |contents, filename| [contents, "foo_#{filename}"] }
+    }
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+    a = klass.create! file: Saviour::StringSource.new("content", "houhou.txt")
+
+    expect(a.file.filename).to eq "foo_houhou.txt"
+    expect(a.file.url).to eq 'http://domain.com/store/dir/foo_houhou.txt'
+  end
+
+  it "lets you provide uploader as a block" do
+    klass = Class.new(Test) { include Saviour::Model }
+
+    klass.attach_file(:file) do
+      store_dir { "/store/dir" }
+      process { |contents, filename| [contents, "foo_#{filename}"] }
+    end
+    a = klass.create! file: Saviour::StringSource.new("content", "houhou.txt")
+
+    expect(a.file.filename).to eq "foo_houhou.txt"
+    expect(a.file.url).to eq 'http://domain.com/store/dir/foo_houhou.txt'
+  end
+end

data/spec/feature/validations_spec.rb

@@ -150,29 +150,4 @@ describe "validations saving a new file" do
       expect(a.errors[:file][0]).to eq "Received error in file"
     end
   end
-
-  context "versions are validated" do
-    let(:uploader) {
-      Class.new(Saviour::BaseUploader) {
-        store_dir { "/store/dir" }
-        version(:thumb)
-      }
-    }
-    let(:klass) {
-      Class.new(base_klass) do
-        attach_validation(:file) do |contents, _, opts|
-          errors.add(:file, "Cannot start with X in version #{opts[:version]}") if contents[0] == 'X'
-        end
-      end
-    }
-
-    it do
-      a = klass.create!
-      a.file.assign Saviour::StringSource.new("correct contents")
-      a.file(:thumb).assign Saviour::StringSource.new("X Incorrect contents")
-
-      expect(a).not_to be_valid
-      expect(a.errors[:file][0]).to eq "Cannot start with X in version thumb"
-    end
-  end
 end

data/spec/models/base_uploader_spec.rb

@@ -16,7 +16,7 @@ describe Saviour::BaseUploader do
 
     it do
       subject.process :hola
-      expect(subject.processors[0][:element].method_or_block).to eq :hola
+      expect(subject.processors[0][:method_or_block]).to eq :hola
       expect(subject.processors[0][:opts]).to eq({})
     end
 
@@ -24,77 +24,44 @@ describe Saviour::BaseUploader do
       subject.process :a
       subject.process :resize, width: 50
 
-      expect(subject.processors[0][:element].method_or_block).to eq :a
+      expect(subject.processors[0][:method_or_block]).to eq :a
       expect(subject.processors[0][:opts]).to eq({})
 
-      expect(subject.processors[1][:element].method_or_block).to eq :resize
+      expect(subject.processors[1][:method_or_block]).to eq :resize
       expect(subject.processors[1][:opts]).to eq({width: 50})
     end
 
     it do
       subject.process { 5 }
-      expect(subject.processors[0][:element].method_or_block).to respond_to :call
-      expect(subject.processors[0][:element].method_or_block.call).to eq 5
+      expect(subject.processors[0][:method_or_block]).to respond_to :call
+      expect(subject.processors[0][:method_or_block].call).to eq 5
     end
 
     it do
       subject.store_dir { "/my/dir" }
-      expect(subject.store_dirs[0].method_or_block.call).to eq "/my/dir"
+      expect(subject.store_dirs[0].call).to eq "/my/dir"
     end
 
     it do
       subject.store_dir :method_to_return_the_dir
-      expect(subject.store_dirs[0].method_or_block).to eq :method_to_return_the_dir
+      expect(subject.store_dirs[0]).to eq :method_to_return_the_dir
     end
 
     it "can use store_dir twice and last prevails" do
       subject.store_dir { "/my/dir" }
       subject.store_dir { "/my/dir/4" }
-      expect(subject.store_dirs[0].method_or_block.call).to eq "/my/dir"
-      expect(subject.store_dirs[1].method_or_block.call).to eq "/my/dir/4"
+      expect(subject.store_dirs[0].call).to eq "/my/dir"
+      expect(subject.store_dirs[1].call).to eq "/my/dir/4"
     end
 
     it "is not accessible from subclasses, works in isolation" do
       subject.process :hola
-      expect(subject.processors[0][:element].method_or_block).to eq :hola
+      expect(subject.processors[0][:method_or_block]).to eq :hola
       expect(subject.processors[0][:opts]).to eq({})
 
       subclass = Class.new(subject)
       expect(subclass.processors).to eq []
     end
-
-    describe "version" do
-      it "stores as elements with the given version" do
-        subject.process :hola
-        subject.version(:thumb) do
-          process :resize_to_thumb
-        end
-
-        expect(subject.processors[0][:element].method_or_block).to eq :hola
-        expect(subject.processors[0][:element].version).to eq nil
-        expect(subject.processors[0][:opts]).to eq({})
-
-        expect(subject.processors[1][:element].method_or_block).to eq :resize_to_thumb
-        expect(subject.processors[1][:element].version).to eq :thumb
-        expect(subject.processors[1][:opts]).to eq({})
-      end
-
-      it "respects ordering" do
-        subject.process :hola
-        subject.version(:thumb) { process :resize_to_thumb }
-        subject.process :top_level
-        subject.version(:another) { process(:foo) }
-
-        expect(subject.processors[0][:element].method_or_block).to eq :hola
-        expect(subject.processors[0][:element].version).to eq nil
-        expect(subject.processors[1][:element].method_or_block).to eq :resize_to_thumb
-        expect(subject.processors[1][:element].version).to eq :thumb
-        expect(subject.processors[2][:element].method_or_block).to eq :top_level
-        expect(subject.processors[2][:element].version).to eq nil
-        expect(subject.processors[3][:element].method_or_block).to eq :foo
-        expect(subject.processors[3][:element].version).to eq :another
-      end
-    end
   end
 
   describe "initialization with data" do
@@ -215,136 +182,6 @@ describe Saviour::BaseUploader do
     end
   end
 
-  describe "version" do
-    subject { uploader.new(version: :thumb) }
-
-    describe "store_dir" do
-      context "is the last one defined for the given version" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          store_dir { "/store/dir" }
-          version(:thumb) do
-            store_dir { "/thumb/store/dir" }
-          end
-          store_dir { "/store/dir/second" }
-        } }
-
-        it do
-          expect(Saviour::Uploader::StoreDirExtractor.new(subject).store_dir).to eq "/thumb/store/dir"
-        end
-      end
-
-      context "is the last one defined without version if not specified per version" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          store_dir { "/store/dir" }
-          version(:thumb) { process(:whatever) }
-          store_dir { "/store/dir/second" }
-        } }
-
-        it do
-          expect(Saviour::Uploader::StoreDirExtractor.new(subject).store_dir).to eq "/store/dir/second"
-        end
-      end
-
-    end
-
-    describe "processing behaviour on write" do
-      context "fails if no store_dir defined for root version" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          version(:thumb) { store_dir { "/store/dir" } }
-        } }
-
-        it do
-          a = uploader.new(data: {model: "model", attached_as: "attached_as"})
-          expect { a.write('1', '2') }.to raise_error(RuntimeError)
-        end
-      end
-
-      context "with only one version" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          store_dir { "/store/dir" }
-
-          version(:thumb) do
-            store_dir { "/versions/store/dir" }
-            process { |contents, name| [contents, "2_#{name}"] }
-          end
-        } }
-
-        it do
-          a = uploader.new(version: :thumb)
-          expect(Saviour::Config.storage).to receive(:write).with("content", "/versions/store/dir/2_output.png")
-          a.write("content", "output.png")
-        end
-
-        it do
-          a = uploader.new
-          expect(Saviour::Config.storage).to receive(:write).with("content", "/store/dir/output.png")
-          a.write("content", "output.png")
-        end
-      end
-
-      context "multiple definitions" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          store_dir { "/store/dir" }
-          process { |contents, name| ["#{contents}_altered", name] }
-
-          version(:thumb) do
-            store_dir { "/versions/store/dir" }
-            process { |contents, name| [contents, "2_#{name}"] }
-          end
-        } }
-
-        it do
-          a = uploader.new(version: :thumb)
-          expect(Saviour::Config.storage).to receive(:write).with("content_altered", "/versions/store/dir/2_output.png")
-          a.write("content", "output.png")
-        end
-
-        it do
-          a = uploader.new
-          expect(Saviour::Config.storage).to receive(:write).with("content_altered", "/store/dir/output.png")
-          a.write("content", "output.png")
-        end
-      end
-
-      context "consecutive versions" do
-        let(:uploader) { Class.new(Saviour::BaseUploader) {
-          store_dir { "/store/dir" }
-          process { |contents, name| ["#{contents}_altered", name] }
-
-          version(:thumb) do
-            store_dir { "/versions/store/dir" }
-            process { |contents, name| ["thumb_#{contents}", "2_#{name}"] }
-          end
-
-          version(:thumb_2) do
-            store_dir { "/versions/store/dir" }
-            process { |contents, name| ["thumb_2_#{contents}", "3_#{name}"] }
-          end
-
-          process { |contents, name| ["last_transform_#{contents}", name] }
-        } }
-
-        it do
-          a = uploader.new
-          expect(Saviour::Config.storage).to receive(:write).with("last_transform_content_altered", "/store/dir/output.png")
-          a.write("content", "output.png")
-        end
-
-        it do
-          a = uploader.new(version: :thumb)
-          expect(Saviour::Config.storage).to receive(:write).with("last_transform_thumb_content_altered", "/versions/store/dir/2_output.png")
-          a.write("content", "output.png")
-        end
-
-        it do
-          a = uploader.new(version: :thumb_2)
-          expect(Saviour::Config.storage).to receive(:write).with("last_transform_thumb_2_content_altered", "/versions/store/dir/3_output.png")
-          a.write("content", "output.png")
-        end
-      end
-    end
-  end
-
   describe "#process_with_file" do
     subject { uploader.new(data: {model: "model", attached_as: "attached_as"}) }