saviour 0.3.0 → 0.3.1

data/spec/models/model_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Saviour do
+  it "raises error if included in a non active record class" do
+    expect {
+      Class.new do
+        include Saviour::Model
+      end
+    }.to raise_error(Saviour::NoActiveRecordDetected)
+  end
+
+  it "error if column not present" do
+    expect {
+      Class.new(Test) do
+        include Saviour::Model
+
+        attach_file :not_present, Saviour::BaseUploader
+      end
+    }.to raise_error(RuntimeError)
+  end
+
+  context do
+    it "error if column not present on version" do
+      uploader = Class.new(Saviour::BaseUploader) do
+        store_dir { "/store/dir" }
+
+        version(:thumb) do
+          store_dir { "/versions/store/dir" }
+        end
+
+        version(:not_present)
+      end
+
+      expect {
+        Class.new(Test) do
+          include Saviour::Model
+
+          attach_file :file, uploader
+        end
+      }.to raise_error(RuntimeError)
+    end
+  end
+
+  it "does not raise error if table is not present" do
+    allow(Test).to receive(:table_exists?).and_return(false)
+
+    expect {
+      Class.new(Test) do
+        include Saviour::Model
+
+        attach_file :not_present, Saviour::BaseUploader
+      end
+    }.to_not raise_error
+  end
+
+  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(Test) do
+        include Saviour::Model
+        attach_file :file, uploader
+      end
+
+      expect(klass.attached_files).to eq({file: [:thumb, :thumb_2]})
+
+      klass2 = Class.new(Test) do
+        include Saviour::Model
+        attach_file :file, Saviour::BaseUploader
+      end
+
+      expect(klass2.attached_files).to eq({file: []})
+    end
+  end
+
+  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(Test) do
+        include Saviour::Model
+        attach_file :file, uploader
+      end
+
+      expect(klass.attached_files).to eq({file: [:thumb, :thumb_2]})
+
+      klass2 = Class.new(Test) do
+        include Saviour::Model
+        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(Test) do
+      include Saviour::Model
+      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

data/spec/models/s3_storage_spec.rb

@@ -11,12 +11,6 @@ describe Saviour::S3Storage do
         Saviour::S3Storage.new(bucket: "fake-bucket")
       }.to raise_error(ArgumentError)
     end
-
-    it "fails when the bucket doesn't exists" do
-      expect {
-        Saviour::S3Storage.new(bucket: "no-bucket", aws_access_key_id: "stub", aws_secret_access_key: "stub")
-      }.to raise_error(ArgumentError)
-    end
   end
 
   describe "#write" do

data/spec/spec_helper.rb

@@ -3,9 +3,34 @@ SimpleCov.start
 
 require 'bundler/setup'
 require 'rspec'
+require 'active_record'
+require 'sqlite3'
 
 require File.expand_path("../../lib/saviour", __FILE__)
 
+connection_opts = case ENV.fetch('DB', "sqlite")
+                    when "sqlite"
+                      {adapter: "sqlite3", database: ":memory:"}
+                    when "mysql"
+                      {adapter: "mysql2", database: "saviour", username: "root", encoding: "utf8"}
+                    when "postgres"
+                      {adapter: "postgresql", database: "saviour", username: "postgres"}
+                  end
+
+ActiveRecord::Base.establish_connection(connection_opts)
+
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+  old_stream.close
+end
+
+silence_stream(STDOUT) { require 'support/schema' }
+
 require 'support/models'
 
 RSpec.configure do |config|

data/spec/support/models.rb

@@ -1,8 +1,12 @@
+class Test < ActiveRecord::Base
+
+end
+
 # Constant lookup in ruby works by lexical scope, so we can't create classes dynamically to test this.
-class TestForSaviourFileResolution
-  include Saviour::BasicModel
+class TestForSaviourFileResolution < Test
+  include Saviour::Model
 
   def foo
     File.file?("/tasdasdasdmp/blabla.txt")
   end
-end
+end

data/spec/support/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  create_table :tests do |t|
+    t.string :file
+    t.string :file_thumb
+    t.string :file_thumb_2
+    t.string :name
+    t.timestamps null: false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,20 +145,25 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- DECOMPOSE.md
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
 - lib/saviour.rb
 - lib/saviour/attribute_name_calculator.rb
-- lib/saviour/base_integrator.rb
 - lib/saviour/base_uploader.rb
-- lib/saviour/basic_model.rb
 - lib/saviour/config.rb
 - lib/saviour/file.rb
+- lib/saviour/integrator.rb
 - lib/saviour/life_cycle.rb
 - lib/saviour/local_storage.rb
+- lib/saviour/model.rb
+- lib/saviour/persistence_layer.rb
 - lib/saviour/s3_storage.rb
 - lib/saviour/source_filename_extractor.rb
 - lib/saviour/string_source.rb
@@ -110,17 +171,21 @@ files:
 - lib/saviour/uploader/processors_runner.rb
 - lib/saviour/uploader/store_dir_extractor.rb
 - lib/saviour/url_source.rb
-- lib/saviour/utils/class_attribute.rb
+- lib/saviour/validator.rb
 - lib/saviour/version.rb
 - saviour.gemspec
 - spec/feature/access_to_model_and_mounted_as_spec.rb
+- spec/feature/crud_workflows_spec.rb
+- spec/feature/persisted_path_spec.rb
+- spec/feature/reload_model_spec.rb
+- spec/feature/validations_spec.rb
 - spec/feature/versions_spec.rb
 - spec/models/attribute_name_calculator_spec.rb
 - spec/models/base_uploader_spec.rb
-- spec/models/basic_model_spec.rb
 - spec/models/config_spec.rb
 - spec/models/file_spec.rb
 - spec/models/local_storage_spec.rb
+- spec/models/model_spec.rb
 - spec/models/s3_storage_spec.rb
 - spec/models/url_source_spec.rb
 - spec/spec_helper.rb
@@ -128,6 +193,7 @@ files:
 - spec/support/data/example.xml
 - spec/support/data/text.txt
 - spec/support/models.rb
+- spec/support/schema.rb
 homepage: https://github.com/rogercampos/saviour
 licenses:
 - MIT
@@ -148,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: File storage handler following active record model lifecycle

data/DECOMPOSE.md

@@ -1,66 +0,0 @@
-- New saviour-ar gem will provide what's currently in saviour gem
-- saviour gem will be data-storage independent. It will provide a way to manage files with processors, but without a
-lifecycle attached to a database-model. It will provide a more low level api.
-- saviour-ar will provide the specific integration with active record.
-
-
-# Saviour agnostic gem API
-
-
-First, you'll need to define what files can be saved in what objects (any Ruby class). You can do that by including the `Saviour::BasicModel` module, example:
-
-```
-class MyObject
-  include Saviour::BasicModel
-
-  attach_file :image, ImageUploader
-  attach_file :scheme, FileUploader
-end
-```
-
-Now, you can assign and work with the files associated to instances of MyObject with the following api:
-
-```
-# New file
-
-a = MyObject.new
-a.image = File.open('/path/image.jpg')
-a.image.assign File.open('newfile.jpg')
-a.image.changed? # => true
-saved_path = a.image.write # => persists file in the storage and returns the path in which the file has been saved
-
-b = MyObject.new
-b.image.set_path!(saved_path) # => Link this image to the persisted image from before
-b.image.exists? # => true
-b.image.read # -> return bytes
-b.image.delete # -> delete
-b.image.exists? # => false
-
-# ...
-```
-
-If you want to work directly managing the files associated to those objects, you can use the `Saviour::File` public API directly.
-
-However, Saviour is designed to work with models that are saved in some kind of persistent storage, like a database of some sort. This is why Saviour also provides a generic `LifeCycle` service which you can use to simulate the persistence lifecycle of the object. You can then use:
-
-```
-a = MyObject.new image: File.open('image.jpg')
-
-Saviour::LifeCycle.new(a).save!
-Saviour::LifeCycle.new(a).delete!
-```
-
-`save!` will have the effect of saving all the attachments associated with the object, and `delete!` will have the effect of removing all the files associated with this object from the file storage defined.
-
-Using LifeCycle you consider the object as a whole, while working with individual files you have more control, but you always operate with individual files.
-
-The feature of versions, for example, only applies when you use the LifeCycle approach, since, by definition, a version is automatically constructed from the original file while this one is saved, and this involved operating in two or more attachments at the same time over an specific object. Since in Saviour versions can be managed exactly like regular attachments, such behavior don't apply when you work with File instances directly.
-
-
-# Saviour API for developers
-
-If you want to develop a new gem to integrate Saviour with another persistence technology, you need to do two things.
-
-1) Write a class with the api #read, #write and #persisted? and give it to Savior, so he knows how to work with the persistence layer.
-2) Write a new module for the final users to include in their models, providing the expected hooks so that the usage of the `LifeCycle` is automatic and transparent.
-

data/lib/saviour/basic_model.rb

@@ -1,7 +0,0 @@
-module Saviour
-  module BasicModel
-    def self.included(klass)
-      BaseIntegrator.new(klass).setup!
-    end
-  end
-end

data/lib/saviour/utils/class_attribute.rb

@@ -1,26 +0,0 @@
-# Port and simplification of ActiveSupport class attribute
-module Saviour
-  module ClassAttribute
-    def class_attribute(*attrs)
-      attrs.each do |name|
-        singleton_class.instance_eval do
-          undef_method(name) if method_defined?(name)
-        end
-
-        define_singleton_method(name) { nil }
-
-        singleton_class.instance_eval do
-          undef_method("#{name}=") if method_defined?("#{name}=")
-        end
-
-        define_singleton_method("#{name}=") do |val|
-          singleton_class.class_eval do
-            undef_method(name) if method_defined?(name)
-            define_method(name) { val }
-          end
-          val
-        end
-      end
-    end
-  end
-end