saviour 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8673c1ddde4f8e16189bfd2d54ea7ad239155679
-  data.tar.gz: 8a97558346780d9105a5b2145fcdc3a038ae3bc6
+  metadata.gz: fa3f38c97bf8c5fee8d2696496b167b7ea312367
+  data.tar.gz: 6ca9294640f87778851e17d87676273e4f183472
 SHA512:
-  metadata.gz: 541052bdedf19b045140c57fa154d9f40007f56bd4fd4cd63895d99a2f577d24e4e10e39e876c597c1bc38fbd462797dcc59173d3b5f36d89aaa06e91c2cf52c
-  data.tar.gz: beea334842a6e686c7df91b933ed55a70298fb00818a950381c2d015bc138ff90ff7deff9b7d74f0a4c150a8069600800f5afc5ff002d77b92e3e1cb0fde2380
+  metadata.gz: 0fa86cf2f8def862e78f0fb019cd90eb085495c4da0247a6b3fc97a8514b6277e1ec7252960ecb8a32cd6c242f520dde6406cbdb4e171ead83bff92b484fa3cd
+  data.tar.gz: ee7cf2411e9d881f2cd5c70fcc6a6bfa93e11b8c5197b9d73cff27a4823ad63991fdfe3a683c50e2bccc226c73f9fafcf43bf54c31a2b9f60d69881c38b5a160

data/.travis.yml

@@ -5,6 +5,13 @@ rvm:
   - 2.1.8
   - 2.2.4
   - 2.3.0
+  - 2.4.0
+
+gemfile:
+  - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
 
 addons:
   code_climate:
@@ -12,3 +19,15 @@ addons:
 
 after_success:
   - bundle exec codeclimate-test-reporter
+
+matrix:
+  exclude:
+    # rails 5 requires 2.2+
+    - rvm: 2.1.8
+      gemfile: gemfiles/5.0.gemfile
+
+    # Arel support for ruby 2.4 starts in 4.2
+    - rvm: 2.4.0
+      gemfile: gemfiles/4.0.gemfile
+    - rvm: 2.4.0
+      gemfile: gemfiles/4.1.gemfile

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "4.0" do
+  gem "activesupport", "~> 4.0.0"
+  gem "activerecord", "~> 4.0.0"
+end
+
+appraise "4.1" do
+  gem "activesupport", "~> 4.1.0"
+  gem "activerecord", "~> 4.1.0"
+end
+
+appraise "4.2" do
+  gem "activesupport", "~> 4.2.0"
+  gem "activerecord", "~> 4.2.0"
+end
+
+appraise "5.0" do
+  gem "activesupport", "~> 5.0.0"
+  gem "activerecord", "~> 5.0.0"
+end

data/gemfiles/4.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activesupport", "~> 4.0.0"
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activesupport", "~> 4.1.0"
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activesupport", "~> 4.2.0"
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/5.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activesupport", "~> 5.0.0"
+gem "activerecord", "~> 5.0.0"
+
+gemspec :path => "../"

data/lib/saviour.rb

@@ -1,8 +1,6 @@
 require 'fileutils'
 require 'fog/aws'
 
-require 'saviour/utils/class_attribute'
-
 require 'saviour/version'
 require 'saviour/base_uploader'
 require 'saviour/file'
@@ -11,12 +9,13 @@ 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/model'
+require 'saviour/integrator'
 require 'saviour/attribute_name_calculator'
 require 'saviour/source_filename_extractor'
 require 'saviour/life_cycle'
-
+require 'saviour/persistence_layer'
+require 'saviour/validator'
 
 module Saviour
 end

data/lib/saviour/base_uploader.rb

@@ -19,7 +19,7 @@ module Saviour
       end
     end
 
-    def respond_to?(name, *)
+    def respond_to_missing?(name, *)
       @data.key?(name) || super
     end
 
@@ -27,7 +27,9 @@ module Saviour
       store_dir = Uploader::StoreDirExtractor.new(self).store_dir
       raise RuntimeError, "Please use `store_dir` before trying to write" unless store_dir
 
-      contents, filename = Uploader::ProcessorsRunner.new(self, @version_name).run!(contents, filename) if Config.processing_enabled
+      if Config.processing_enabled
+        contents, filename = Uploader::ProcessorsRunner.new(self, @version_name).run!(contents, filename)
+      end
 
       path = ::File.join(store_dir, filename)
       Config.storage.write(contents, path)
@@ -51,9 +53,9 @@ module Saviour
         element = Uploader::Element.new(@current_version, name || block)
 
         if block_given?
-          processors.push({element: element, type: type})
+          processors.push(element: element, type: type)
         else
-          processors.push({element: element, type: type, opts: opts})
+          processors.push(element: element, type: type, opts: opts)
         end
       end
 

data/lib/saviour/{base_integrator.rb → integrator.rb}

@@ -1,21 +1,30 @@
 module Saviour
-  class BaseIntegrator
-    def initialize(klass)
+  class Integrator
+    def initialize(klass, persistence_klass)
       @klass = klass
+      @persistence_klass = persistence_klass
     end
 
     def file_instantiator_hook(model, file_instance, attach_as, version)
-      # noop
+      layer = @persistence_klass.new(model)
+      file_instance.set_path!(layer.read(Saviour::AttributeNameCalculator.new(attach_as, version).name)) if layer.persisted?
     end
 
     def attach_file_hook(klass, attach_as, uploader_klass)
-      # noop
+      versions = uploader_klass.versions || []
+
+      ([nil] + versions).each do |version|
+        column_name = Saviour::AttributeNameCalculator.new(attach_as, version).name
+
+        if klass.table_exists? && !klass.column_names.include?(column_name.to_s)
+          raise RuntimeError, "#{klass} must have a database string column named '#{column_name}'"
+        end
+      end
     end
 
     def setup!
       raise "You cannot include Saviour twice in the same class" if @klass.respond_to?(:attached_files)
 
-      @klass.send :extend, ClassAttribute
       @klass.class_attribute :attached_files
       @klass.attached_files = {}
 
@@ -48,6 +57,15 @@ module Saviour
           end
         end
       end
+
+      @klass.class_attribute :__saviour_validations
+
+      class << @klass
+        def attach_validation(attach_as, method_name = nil, &block)
+          self.__saviour_validations ||= Hash.new { [] }
+          self.__saviour_validations[attach_as] += [method_name || block]
+        end
+      end
     end
   end
 end

data/lib/saviour/local_storage.rb

@@ -63,7 +63,7 @@ module Saviour
       basedir = ::File.dirname(path)
       return if basedir == "."
 
-      while basedir != "/" && Dir.entries(real_path(basedir)) == [".", ".."]
+      while basedir != "/" && Dir.entries(real_path(basedir)) - [".", ".."] ==[]
         Dir.rmdir(real_path(basedir))
         basedir = ::File.dirname(basedir)
       end

data/lib/saviour/model.rb

@@ -0,0 +1,24 @@
+module Saviour
+  NoActiveRecordDetected = Class.new(StandardError)
+
+  module Model
+    def self.included(klass)
+      Integrator.new(klass, PersistenceLayer).setup!
+
+      klass.class_eval do
+        raise(NoActiveRecordDetected, "Error: ActiveRecord not detected in #{self}") unless self.ancestors.include?(ActiveRecord::Base)
+
+        after_destroy { Saviour::LifeCycle.new(self, PersistenceLayer).delete! }
+        after_save { Saviour::LifeCycle.new(self, PersistenceLayer).save! }
+        validate { Saviour::Validator.new(self).validate! }
+      end
+    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
+  end
+end

data/lib/saviour/persistence_layer.rb

@@ -0,0 +1,19 @@
+module Saviour
+  class PersistenceLayer
+    def initialize(model)
+      @model = model
+    end
+
+    def read(attr)
+      @model.read_attribute(attr)
+    end
+
+    def write(attr, value)
+      @model.update_columns(attr => value)
+    end
+
+    def persisted?
+      @model.persisted? || @model.destroyed?
+    end
+  end
+end

data/lib/saviour/s3_storage.rb

@@ -6,7 +6,8 @@ module Saviour
       @conf = conf
       @overwrite_protection = conf.delete(:overwrite_protection) { true }
       @create_options = conf.delete(:create_options) { {} }
-      assert_directory_exists!
+      conf.fetch(:aws_access_key_id) { raise ArgumentError.new("aws_access_key_id is required")}
+      conf.fetch(:aws_secret_access_key) { raise ArgumentError.new("aws_secret_access_key is required")}
     end
 
     def write(contents, path)
@@ -60,10 +61,6 @@ module Saviour
       path.gsub(/\A\/*/, '')
     end
 
-    def assert_directory_exists!
-      directory || raise(ArgumentError, "The bucket #{@bucket} doesn't exists or misconfigured connection.")
-    end
-
     def assert_exists(path)
       raise RuntimeError, "File does not exists: #{path}" unless exists?(path)
     end

data/lib/saviour/url_source.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'net/http'
 
 module Saviour
   class UrlSource

data/lib/saviour/validator.rb

@@ -0,0 +1,50 @@
+module Saviour
+  class Validator
+    def initialize(model)
+      raise "Please provide an object compatible with Saviour." unless model.class.respond_to?(:attached_files)
+
+      @model = model
+    end
+
+    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
+        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}
+
+      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 attached_files
+      @model.class.attached_files || {}
+    end
+
+    def validations
+      @model.class.__saviour_validations || {}
+    end
+  end
+end

data/lib/saviour/version.rb

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

data/saviour.gemspec

@@ -17,7 +17,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "fog-aws"
   spec.add_dependency "mime-types"
+  spec.add_dependency "activerecord", ">= 4.0"
+  spec.add_dependency "activesupport", ">= 4.0"
+
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "appraisal"
 end

data/spec/feature/access_to_model_and_mounted_as_spec.rb

@@ -11,8 +11,8 @@ describe "access to model data from uploaders" do
   }
 
   let(:klass) {
-    klass = Class.new {
-      include Saviour::BasicModel
+    klass = Class.new(Test) {
+      include Saviour::Model
 
       def id
         87

data/spec/feature/crud_workflows_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe "saving a new file" 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 "creation" do
+    it do
+      with_test_file("example.xml") do |example|
+        a = klass.create!
+        expect(a.update_attributes(file: example)).to be_truthy
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example|
+        a = klass.create!
+        a.update_attributes(file: example)
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example, real_filename|
+        a = klass.create!
+        a.update_attributes(file: example)
+        expect(a[:file]).to eq "/store/dir/#{real_filename}"
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example|
+        a = klass.create!
+        a.update_attributes(file: example)
+
+        example.rewind
+        expect(a.file.read).to eq example.read
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example|
+        a = klass.create!
+        a.update_attributes(file: example)
+
+        expect(a.file.exists?).to be_truthy
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example, real_filename|
+        a = klass.create!
+        a.update_attributes(file: example)
+
+        expect(a.file.filename).to eq real_filename
+      end
+    end
+
+    it do
+      with_test_file("example.xml") do |example, real_filename|
+        a = klass.create!
+        a.update_attributes(file: example)
+
+        expect(a.file.url).to eq "http://domain.com/store/dir/#{real_filename}"
+        expect(a.file.public_url).to eq a.file.url
+      end
+    end
+
+    it "don't create anything if save do not completes (halt during before_save)" do
+      klass = Class.new(Test) do
+        attr_accessor :fail_at_save
+        before_save {
+          if ActiveRecord.version >= Gem::Version.new("5.0")
+            throw(:abort) if fail_at_save
+          else
+            !fail_at_save
+          end
+        }
+        include Saviour::Model
+      end
+      klass.attach_file :file, uploader
+
+      expect {
+        a = klass.new
+        a.fail_at_save = true
+        a.save!
+      }.to raise_error(ActiveRecord::RecordNotSaved)
+
+      with_test_file("example.xml") do |example, _|
+        a = klass.new
+        a.fail_at_save = true
+        a.file = example
+
+        expect(Saviour::Config.storage).not_to receive(:write)
+        a.save
+      end
+    end
+  end
+
+  describe "deletion" do
+    it do
+      with_test_file("example.xml") do |example|
+        a = klass.create!
+        a.update_attributes(file: example)
+        expect(a.file.exists?).to be_truthy
+        expect(a.destroy).to be_truthy
+
+        expect(Saviour::Config.storage.exists?(a[:file])).to be_falsey
+      end
+    end
+  end
+
+  describe "updating" 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])).to be_truthy
+        previous_location = a[:file]
+
+        with_test_file("camaloon.jpg") do |example_2|
+          a.update_attributes(file: example_2)
+          expect(Saviour::Config.storage.exists?(a[:file])).to be_truthy
+
+          expect(Saviour::Config.storage.exists?(previous_location)).to be_falsey
+        end
+      end
+    end
+  end
+end