saviour 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 299270bf4c0f5d46a9fd7a57d51062a5a86a1c9216187baf3d0d3a6258295811
-  data.tar.gz: a0ed19b72e62d0fc006698958bd057eaf0543c8595ae080e9279c07e33fddb95
+  metadata.gz: 518c8ff0b7b4f9109e1639526b4ff4d25e1878b9e0a4e572cbaab60321788f58
+  data.tar.gz: bfba0fd29fc19d8464e9c4aac30e8b100c029b2a034dba3bc44a62fc36d2cd94
 SHA512:
-  metadata.gz: 90ac6353b42b4c3422bb3154b983422658837e9c0c307bb4871e2c3c0e50d7101286524984c036fcf68abb91b830d82aa39886f88d362490ddf86d459401c9a3
-  data.tar.gz: 82d6cdeab9db03a38a8819109c2cf24d4824a9ca1a9c77830bdb8d95efb98c50664ad1eeb8862224f795e9c334d8d36a9f071955e0f232ae14d2198b95124720
+  metadata.gz: 6b3d3a893c42fdc9cec9eeb661955f2c43be8540f8175772bb4d8086de9625bb86026ee2038fa1566fc8db81996f42d17107620abfddb7a6f65061adeb54e72d
+  data.tar.gz: c1b569e988c4a515289ea4cbabe48ba6ad3ab739bd791b19cefd2168ba0c81f6c148aef3745fdb3b8c0e55e8581700090abc14866ec4705463a250ff87cff80e

data/README.md

@@ -817,11 +817,14 @@ as in the processor's case.
 
 ### Introspection
 
-Two methods are added to any class including `Saviour::Model` to give you information about what attachments
+Three methods are added to any class including `Saviour::Model` to give you information about what attachments
 have been defined in that class.
 
 `Model.attached_files` will give an array of symbols, representing all the attachments declared in that class.
 
+`Model.uploader_classes` will give you a hash with all the uploader classes being used in that model, key-ed by
+the name of each attachment.
+
 `Model.attached_followers_per_leader` will give a hash where the keys are attachments that have versions
 assigned, and the values being an array of symbols, representing the attachments that are following that attachment.
 
@@ -837,6 +840,7 @@ end
 
 Post.attached_files # => [:image, :image_thumb, :image_thumb_2, :cover]
 Post.attached_followers_per_leader # => { image: [:image_thumb, :image_thumb_2] }
+Post.uploader_classes # => { image: SomeUploader, image_thumb: SomeUploader, ... }
 ```
 
 
@@ -964,6 +968,38 @@ Any additional information the storage may require can be provided on instance c
 this is not used by Saviour.
 
 
+### Using `ReadOnlyFile`
+
+Sometimes you may find the need to have a saviour `File`-like object but you don't have the original model available.
+
+For example, if you're working directly fetching data from database, you have the `path` to an asset but you're not
+loading an ActiveRecord object.
+
+In such cases you can use the class `ReadOnlyFile`, like this:
+
+```ruby
+class Product
+  # ...
+  attach_file :image
+end
+
+my_cheap_products = ActiveRecord::Base.connection.select_all "select image, ... from products"
+
+# In this case, you have the path to the assets and want to convert it into an object so that the
+# rest of the application can work normally with it, you can do:
+ 
+storage = Product.uploader_classes[:image].storage
+file = Saviour::ReadOnlyFile.new(path, storage) 
+
+file.read # -> contents
+file.public_url # -> url
+# etc ...
+```
+
+You'll need to get the appropriate storage object from the same uploader that attachment is using, 
+and create a new `ReadOnlyFile` instance only with the asset's path and the storage.
+
+
 ### Bypassing Saviour
 
 The only reference to stored files Saviour holds and uses is the path persisted in the database. If you want to,

data/lib/saviour/file.rb

@@ -2,26 +2,26 @@ require 'securerandom'
 
 module Saviour
   class File
-    attr_reader :persisted_path
-    attr_reader :source
+    attr_reader :persisted_path, :source, :storage
 
     def initialize(uploader_klass, model, attached_as, persisted_path = nil)
       @uploader_klass, @model, @attached_as = uploader_klass, model, attached_as
       @source_was = @source = nil
       @persisted_path = persisted_path
+      @storage = @uploader_klass.storage
 
       if persisted_path
-        @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @uploader_klass))
+        @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @uploader_klass.storage))
       end
     end
 
     def exists?
-      persisted? && @uploader_klass.storage.exists?(@persisted_path)
+      persisted? && @storage.exists?(@persisted_path)
     end
 
     def read
       return nil unless persisted?
-      @uploader_klass.storage.read(@persisted_path)
+      @storage.read(@persisted_path)
     end
 
     def delete
@@ -32,7 +32,7 @@ module Saviour
 
     def public_url
       return nil unless persisted?
-      @uploader_klass.storage.public_url(@persisted_path)
+      @storage.public_url(@persisted_path)
     end
 
     def ==(another_file)
@@ -111,7 +111,7 @@ module Saviour
       temp_file.binmode
 
       begin
-        @uploader_klass.storage.read_to_file(@persisted_path, temp_file)
+        @storage.read_to_file(@persisted_path, temp_file)
 
         yield(temp_file)
       ensure
@@ -154,13 +154,13 @@ module Saviour
 
           case source_type
             when :stream
-              @uploader_klass.storage.write(contents, path)
+              @storage.write(contents, path)
             when :file
-              @uploader_klass.storage.write_from_file(contents, path)
+              @storage.write_from_file(contents, path)
           end
 
           @persisted_path = path
-          @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @uploader_klass))
+          @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @storage))
           path
         end
       end

data/lib/saviour/integrator.rb

@@ -12,6 +12,8 @@ module Saviour
       @klass.attached_files = []
       @klass.class_attribute :followers_per_leader_config
       @klass.followers_per_leader_config = {}
+      @klass.class_attribute :uploader_classes
+      @klass.uploader_classes = {}
 
       persistence_klass = @persistence_klass
 
@@ -36,10 +38,13 @@ module Saviour
           raise ConfigurationError, "you must provide either an UploaderClass or a block to define it."
         end
 
+        uploader_klass = Class.new(Saviour::BaseUploader, &block) if block
+
+        self.uploader_classes[attach_as] = uploader_klass
+
         mod = Module.new do
           define_method(attach_as) do
             instance_variable_get("@__uploader_#{attach_as}") || begin
-              uploader_klass = Class.new(Saviour::BaseUploader, &block) if block
               layer = persistence_klass.new(self)
               new_file = ::Saviour::File.new(uploader_klass, self, attach_as, layer.read(attach_as))
 

data/lib/saviour/read_only_file.rb

@@ -1,24 +1,24 @@
 module Saviour
   class ReadOnlyFile
-    attr_reader :persisted_path
+    attr_reader :persisted_path, :storage
 
-    def initialize(persisted_path, uploader_klass)
+    def initialize(persisted_path, storage)
       @persisted_path = persisted_path
-      @uploader_klass = uploader_klass
+      @storage = storage
     end
 
     def exists?
-      persisted? && Config.storage.exists?(@persisted_path)
+      persisted? && @storage.exists?(@persisted_path)
     end
 
     def read
       return nil unless persisted?
-      @uploader_klass.storage.read(@persisted_path)
+      @storage.read(@persisted_path)
     end
 
     def public_url
       return nil unless persisted?
-      @uploader_klass.storage.public_url(@persisted_path)
+      @storage.public_url(@persisted_path)
     end
     alias_method :url, :public_url
 

data/lib/saviour/version.rb

@@ -1,3 +1,3 @@
 module Saviour
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/spec/feature/read_only_file_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "direct usage of ReadOnlyFile" 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(:klass) {
+    klass = Class.new(Test) { include Saviour::Model }
+    klass.attach_file :file, uploader
+    klass
+  }
+
+  it "can be created" do
+    a = klass.create! file: Saviour::StringSource.new("contents", "file.txt")
+
+    path = a[:file]
+
+    read_only_file = Saviour::ReadOnlyFile.new(path, klass.uploader_classes[:file].storage)
+
+    expect(read_only_file.read).to eq "contents"
+    expect(read_only_file.public_url).to eq "http://domain.com/store/dir/file.txt"
+  end
+end

data/spec/feature/storage_overriding_spec.rb

@@ -8,7 +8,7 @@ describe "uploader declaration" do
     )
   end
 
-  let!(:custom_storage) do
+  let!(:another_storage) do
     Saviour::LocalStorage.new(
       local_prefix: @tmpdir,
       public_url_prefix: "http://custom-domain.com"
@@ -19,7 +19,7 @@ describe "uploader declaration" do
 
   it "lets you override storage on attachment basis" do
     klass = Class.new(Test) { include Saviour::Model }
-    kustom_storage = custom_storage
+    custom_storage = another_storage
 
     klass.attach_file(:file) do
       store_dir { "/store/dir" }
@@ -27,7 +27,7 @@ describe "uploader declaration" do
 
     klass.attach_file(:file_thumb) do
       store_dir { "/store/dir" }
-      with_storage kustom_storage
+      with_storage custom_storage
     end
 
     a = klass.create!(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -211,6 +211,7 @@ files:
 - spec/feature/original_assigned_file_is_not_modified_spec.rb
 - spec/feature/persisted_path_spec.rb
 - spec/feature/processors_api_spec.rb
+- spec/feature/read_only_file_spec.rb
 - spec/feature/reload_model_spec.rb
 - spec/feature/remove_attachment_spec.rb
 - spec/feature/reopens_file_at_every_process_spec.rb