saviour 0.2.3 → 0.3.0

data/lib/saviour.rb

@@ -1,11 +1,7 @@
 require 'fileutils'
-require 'digest/md5'
-require 'active_support/concern'
-require 'active_support/core_ext'
-require 'active_support/core_ext/module/attribute_accessors'
 require 'fog/aws'
 
-require 'saviour/processors/digest'
+require 'saviour/utils/class_attribute'
 
 require 'saviour/version'
 require 'saviour/base_uploader'
@@ -15,156 +11,12 @@ require 'saviour/s3_storage'
 require 'saviour/config'
 require 'saviour/string_source'
 require 'saviour/url_source'
+require 'saviour/basic_model'
+require 'saviour/base_integrator'
+require 'saviour/attribute_name_calculator'
+require 'saviour/source_filename_extractor'
+require 'saviour/life_cycle'
 
-module Saviour
-  class ColumnNamer
-    def initialize(attached_as, version = nil)
-      @attached_as, @version = attached_as, version
-    end
-
-    def name
-      if @version
-        "#{@attached_as}_#{@version}"
-      else
-        @attached_as.to_s
-      end
-    end
-  end
-
-  class ModelHooks
-    def initialize(model)
-      @model = model
-    end
-
-    def delete!
-      attached_files.each do |column, versions|
-        (versions + [nil]).each { |version| @model.send(column, version).delete if @model.send(column, version).exists? }
-      end
-    end
-
-    def save!
-      attached_files.each do |column, versions|
-        base_file_changed = @model.send(column).changed?
-        original_content = @model.send(column).source_data if base_file_changed
-
-        versions.each do |version|
-          if @model.send(column, version).changed?
-            upload_file(column, version)
-          elsif base_file_changed
-            @model.send(column, version).assign(StringSource.new(original_content, default_version_filename(column, version)))
-            upload_file(column, version)
-          end
-        end
-
-        upload_file(column, nil) if base_file_changed
-      end
-    end
-
-    def validate!
-      validations.each do |column, method_or_blocks|
-        (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
-        end
-      end
-    end
-
-    def default_version_filename(column, version)
-      filename = @model.send(column).filename_to_be_assigned
-      "#{::File.basename(filename, ".*")}_#{version}#{::File.extname(filename)}"
-    end
-
-    def upload_file(column, version)
-      name = ColumnNamer.new(column, version).name
-      Config.storage.delete(@model.read_attribute(name)) if @model.read_attribute(name)
-      new_path = @model.send(column, version).write
-      @model.update_column(name, new_path)
-    end
-
-    def attached_files
-      @model.class.attached_files || {}
-    end
-
-    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}
-
-      if method_or_block.respond_to?(:call)
-        if method_or_block.arity == 2
-          @model.instance_exec(data, filename, &method_or_block)
-        else
-          @model.instance_exec(data, filename, opts, &method_or_block)
-        end
-      else
-        if @model.method(method_or_block).arity == 2
-          @model.send(method_or_block, data, filename)
-        else
-          @model.send(method_or_block, data, filename, opts)
-        end
-      end
-    end
-
-    def validations
-      @model.class.__saviour_validations || {}
-    end
-  end
 
-  extend ActiveSupport::Concern
-
-  NoActiveRecordDetected = Class.new(StandardError)
-
-  included do
-    raise(NoActiveRecordDetected, "Error: ActiveRecord not detected in #{self}") unless self.ancestors.include?(ActiveRecord::Base)
-
-    class_attribute(:attached_files, :__saviour_validations)
-
-    after_destroy { ModelHooks.new(self).delete! }
-    after_save { ModelHooks.new(self).save! }
-    validate { ModelHooks.new(self).validate! }
-  end
-
-  def reload
-    self.class.attached_files.each do |attach_as, versions|
-      (versions + [nil]).each { |version| instance_variable_set("@__uploader_#{version}_#{attach_as}", nil) }
-    end
-    super
-  end
-
-  module ClassMethods
-    def attach_file(attach_as, uploader_klass)
-      self.attached_files ||= {}
-      versions = uploader_klass.versions || []
-
-      ([nil] + versions).each do |version|
-        column_name = ColumnNamer.new(attach_as, version).name
-
-        if self.table_exists? && !self.column_names.include?(column_name.to_s)
-          raise RuntimeError, "#{self} must have a database string column named '#{column_name}'"
-        end
-      end
-
-      define_method(attach_as) do |version = nil|
-        instance_variable_get("@__uploader_#{version}_#{attach_as}") ||
-            instance_variable_set("@__uploader_#{version}_#{attach_as}", ::Saviour::File.new(uploader_klass, self, attach_as, version))
-      end
-
-      define_method("#{attach_as}=") do |value|
-        send(attach_as).assign(value)
-      end
-
-      define_method("#{attach_as}_changed?") do
-        send(attach_as).changed?
-      end
-
-      self.attached_files[attach_as] ||= []
-      self.attached_files[attach_as] += versions
-    end
-
-    def attach_validation(attach_as, method_name = nil, &block)
-      self.__saviour_validations ||= Hash.new { [] }
-      self.__saviour_validations[attach_as] += [method_name || block]
-    end
-  end
+module Saviour
 end

data/saviour.gemspec

@@ -13,15 +13,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.1.0"
 
-  spec.add_dependency "activerecord", ">= 4.0"
-  spec.add_dependency "activesupport", ">= 4.0"
   spec.add_dependency "fog-aws"
   spec.add_dependency "mime-types"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "appraisal"
 end

data/spec/feature/access_to_model_and_mounted_as_spec.rb

@@ -11,7 +11,13 @@ describe "access to model data from uploaders" do
   }
 
   let(:klass) {
-    klass = Class.new(Test) { include Saviour }
+    klass = Class.new {
+      include Saviour::BasicModel
+
+      def id
+        87
+      end
+    }
     klass.attach_file :file, uploader
     klass
   }
@@ -19,10 +25,12 @@ describe "access to model data from uploaders" do
   describe "file store" do
     it do
       with_test_file("example.xml") do |example, name|
-        a = klass.create! id: 87
-        expect(a.update_attributes(file: example)).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
-        expect(a[:file]).to eq "/store/dir/87/87-file-#{name}"
+        a = klass.new
+        a.file = example
+        path = a.file.write
+
+        expect(Saviour::Config.storage.exists?(path)).to be_truthy
+        expect(path).to eq "/store/dir/87/87-file-#{name}"
       end
     end
   end

data/spec/feature/versions_spec.rb

@@ -14,7 +14,7 @@ describe "saving a new file" do
   }
 
   let(:klass) {
-    a = Class.new(Test) { include Saviour }
+    a = Class.new { include Saviour::BasicModel }
     a.attach_file :file, uploader
     a
   }
@@ -22,9 +22,13 @@ describe "saving a new file" do
   describe "creation following main file" do
     it do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
+
+        path = a.file(:thumb).persisted_path
+        expect(path).not_to be_nil
+        expect(Saviour::Config.storage.exists?(path)).to be_truthy
       end
     end
   end
@@ -32,14 +36,16 @@ describe "saving a new file" do
   describe "deletion" do
     it do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        a.update_attributes(file: example)
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
-
-        a.destroy
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_falsey
-        expect(Saviour::Config.storage.exists?(a[:file])).to be_falsey
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
+
+        expect(Saviour::Config.storage.exists?(a.file(:thumb).persisted_path)).to be_truthy
+        expect(Saviour::Config.storage.exists?(a.file.persisted_path)).to be_truthy
+
+        Saviour::LifeCycle.new(a).delete!
+        expect(Saviour::Config.storage.exists?(a.file(:thumb).persisted_path)).to be_falsey
+        expect(Saviour::Config.storage.exists?(a.file.persisted_path)).to be_falsey
       end
     end
   end
@@ -47,13 +53,18 @@ describe "saving a new file" do
   describe "changes following main file" do
     it do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
+        path = a.file(:thumb).persisted_path
+        expect(Saviour::Config.storage.exists?(path)).to be_truthy
 
         with_test_file("camaloon.jpg") do |file|
-          a.update_attributes(file: file)
-          expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
+          a.file = file
+          Saviour::LifeCycle.new(a).save!
+          path = a.file(:thumb).persisted_path
+
+          expect(Saviour::Config.storage.exists?(path)).to be_truthy
           file.rewind
           expect(a.file(:thumb).read).to eq file.read
         end
@@ -75,8 +86,9 @@ describe "saving a new file" do
 
     it "#url" do
       with_test_file("example.xml") do |example, name|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
 
         versioned_name = "#{File.basename(name, ".*")}_thumb#{File.extname(name)}"
         expect(a.file(:thumb).url).to eq "http://domain.com/versions/store/dir/#{versioned_name}"
@@ -85,8 +97,9 @@ describe "saving a new file" do
 
     it "#read" do
       with_test_file("text.txt") do |example|
-        a = klass.create!
-        a.update_attributes(file: example)
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
 
         expect(a.file(:thumb).read).to eq "Hello world\n_for_version_thumb"
       end
@@ -94,21 +107,24 @@ describe "saving a new file" do
 
     it "#delete" do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
+        expect(Saviour::Config.storage.exists?(a.file(:thumb).persisted_path)).to be_truthy
+        expect(Saviour::Config.storage.exists?(a.file.persisted_path)).to be_truthy
 
         a.file(:thumb).delete
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_falsey
-        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+
+        expect(Saviour::Config.storage.exists?(a.file(:thumb).persisted_path)).to be_falsey
+        expect(Saviour::Config.storage.exists?(a.file.persisted_path)).to be_truthy
       end
     end
 
     it "#exists?" do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
         expect(a.file(:thumb).exists?).to be_truthy
       end
     end
@@ -117,18 +133,21 @@ describe "saving a new file" do
   describe "assign specific version after first creation" do
     it do
       with_test_file("example.xml") do |example|
-        a = klass.create!
-        expect(a.update_attributes(file: example)).to be_truthy
-        expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-        expect(a[:file_thumb]).to eq "/versions/store/dir/#{File.basename(example, ".*")}_thumb.xml"
+        a = klass.new
+        a.file = example
+        Saviour::LifeCycle.new(a).save!
+
+        thumb_path = a.file(:thumb).persisted_path
+        expect(Saviour::Config.storage.exists?(thumb_path)).to be_truthy
+        expect(thumb_path).to eq "/versions/store/dir/#{File.basename(example, ".*")}_thumb.xml"
 
         with_test_file("camaloon.jpg") do |ex2, filename|
           a.file(:thumb).assign(ex2)
+          Saviour::LifeCycle.new(a).save!
+          thumb_path = a.file(:thumb).persisted_path
 
-          expect(a.save!).to be_truthy
-
-          expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-          expect(a[:file_thumb]).to eq "/versions/store/dir/#{File.basename(filename, ".*")}.jpg"
+          expect(Saviour::Config.storage.exists?(thumb_path)).to be_truthy
+          expect(thumb_path).to eq "/versions/store/dir/#{File.basename(filename, ".*")}.jpg"
         end
       end
     end
@@ -147,19 +166,23 @@ describe "saving a new file" do
 
       it "runs the processors for that version only" do
         with_test_file("example.xml") do |example|
-          a = klass.create!
-          expect(a.update_attributes(file: example)).to be_truthy
-          expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-          expect(a[:file_thumb]).to eq "/versions/store/dir/#{File.basename(example, ".*")}_thumb.xml"
+          a = klass.new
+          a.file = example
+          Saviour::LifeCycle.new(a).save!
+          thumb_path = a.file(:thumb).persisted_path
+
+          expect(Saviour::Config.storage.exists?(thumb_path)).to be_truthy
+          expect(thumb_path).to eq "/versions/store/dir/#{File.basename(example, ".*")}_thumb.xml"
 
           with_test_file("camaloon.jpg") do |ex2, filename|
             a.file(:thumb).assign(ex2)
 
-            expect(a.save!).to be_truthy
+            Saviour::LifeCycle.new(a).save!
+            thumb_path = a.file(:thumb).persisted_path
 
-            expect(Saviour::Config.storage.exists?(a[:file_thumb])).to be_truthy
-            expect(a[:file_thumb]).to eq "/versions/store/dir/#{File.basename(filename, ".*")}.jpg"
-            expect(Saviour::Config.storage.read(a[:file_thumb])).to eq "modified_content"
+            expect(Saviour::Config.storage.exists?(thumb_path)).to be_truthy
+            expect(thumb_path).to eq "/versions/store/dir/#{File.basename(filename, ".*")}.jpg"
+            expect(Saviour::Config.storage.read(thumb_path)).to eq "modified_content"
           end
         end
       end
@@ -168,16 +191,16 @@ describe "saving a new file" do
 
   describe "respects version assignation vs main file assignation on conflict" do
     it do
-      a = klass.create!
+      a = klass.new
 
       with_test_file("example.xml") do |file1, fname1|
         with_test_file("camaloon.jpg") do |file2, fname2|
           a.file.assign(file1)
           a.file(:thumb).assign(file2)
-          a.save!
+          Saviour::LifeCycle.new(a).save!
 
-          expect(a[:file]).to eq "/store/dir/#{fname1}"
-          expect(a[:file_thumb]).to eq "/versions/store/dir/#{fname2}"
+          expect(a.file.persisted_path).to eq "/store/dir/#{fname1}"
+          expect(a.file(:thumb).persisted_path).to eq "/versions/store/dir/#{fname2}"
         end
       end
     end

data/spec/models/attribute_name_calculator_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Saviour::AttributeNameCalculator do
+  it "returns the attached_as value" do
+    expect(Saviour::AttributeNameCalculator.new("preview_file").name).to eq "preview_file"
+  end
+
+  it "appends the version if provided" do
+    expect(Saviour::AttributeNameCalculator.new("preview_file", "thumb").name).to eq "preview_file_thumb"
+  end
+end

data/spec/models/basic_model_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Saviour do
+  describe ".attached_files" do
+    it "includes a mapping of the currently attached files and their versions" do
+      uploader = Class.new(Saviour::BaseUploader) do
+        store_dir { "/store/dir" }
+
+        version(:thumb)
+        version(:thumb_2)
+      end
+
+      klass = Class.new do
+        include Saviour::BasicModel
+        attach_file :file, uploader
+      end
+
+      expect(klass.attached_files).to eq({file: [:thumb, :thumb_2]})
+
+      klass2 = Class.new do
+        include Saviour::BasicModel
+        attach_file :file, Saviour::BaseUploader
+      end
+
+      expect(klass2.attached_files).to eq({file: []})
+    end
+  end
+
+  it "doens't mess with default File constant" do
+    # Constant lookup in ruby works by lexical scope, so we can't create classes dynamically like above.
+    expect(TestForSaviourFileResolution.new.foo).to be_falsey
+  end
+
+  it "shares model definitions with subclasses" do
+    uploader = Class.new(Saviour::BaseUploader) do
+      store_dir { "/store/dir" }
+      version(:thumb)
+    end
+
+    klass = Class.new do
+      include Saviour::BasicModel
+      attach_file :file, uploader
+    end
+    expect(klass.attached_files).to eq({file: [:thumb]})
+
+    klass2 = Class.new(klass)
+    expect(klass2.attached_files).to eq({file: [:thumb]})
+
+    expect(klass2.new.file).to respond_to :exists?
+  end
+end