attach 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bba016e24c62143435904ab7adec8d742dfc2cff
-  data.tar.gz: 7fd96092ed4196d2eb765788adf376bbb8caec46
+  metadata.gz: 97d4588d2fde59f28aa8079b2ebc8d423c200e3d
+  data.tar.gz: 98b5176bb728e78f37b0193d0934916b98162e63
 SHA512:
-  metadata.gz: 1728d88028c90ca2701943199a9fecfe5cbe4b6f3358a3533f617aa279942e05974f94d3bb7089e31e99af1082781a2f9979cb2857d617c07d6399f590ef2e09
-  data.tar.gz: abb0b019475de3fb68a433aa99a80facdd95c86701e76ba5fea90c7b097e0bb507337a1404f67571f2aceb9aae8cf1f2ef0248fedc87ca37764e007f7d5f33fa
+  metadata.gz: b1fb19b9cc73ac94e525b962c7212bcbff13bc7cad628c184235d1992f00e16c9963e0377839ebfb0d38f744832a1c59689a29ad9de7c89cd65022596798aaef
+  data.tar.gz: 9bc6875dfa3e5d8017872ec0924b588791f70194fa567b12ca66584cc561026e4d1c025d532d1e4b9149780cd23c5817537cc573b6ce8ee4bec2389b0b16b724

data/lib/attach.rb

@@ -1,5 +1,6 @@
 require 'records_manipulator'
 require 'attach/processor'
+require 'attach/file'
 require 'attach/railtie' if defined?(Rails)
 
 module Attach
@@ -15,6 +16,14 @@ module Attach
     @backend = backend
   end
 
+  def self.asset_host
+    @asset_host
+  end
+
+  def self.asset_host=(host)
+    @asset_host = host
+  end
+
   def self.use_filesystem!(config = {})
     require 'attach/backends/file_system'
     @backend = Attach::Backends::FileSystem.new(config)

data/lib/attach/attachment.rb

@@ -11,7 +11,6 @@ module Attach
 
     # This will be the ActionDispatch::UploadedFile object which be diseminated
     # by the class on save.
-    attr_accessor :uploaded_file
     attr_writer :binary
 
     # Relationships
@@ -29,15 +28,11 @@ module Attach
     # All attachments should have a token assigned to this
     before_validation { self.token = SecureRandom.uuid if self.token.blank? }
 
-    # Copy values from the `uploaded_file` and set them as the appropriate
-    # fields on this model
-    before_validation do
-      if self.uploaded_file
-        self.binary = self.uploaded_file.tempfile.read
-        self.file_name = self.uploaded_file.original_filename
-        self.file_type = self.uploaded_file.content_type
-      end
+    # Allow custom data to be stored on the attachment
+    serialize :custom, Hash
 
+    # Set size and digest
+    before_validation do
       self.digest = Digest::SHA1.hexdigest(self.binary)
       self.file_size = self.binary.bytesize
     end
@@ -72,6 +67,7 @@ module Attach
     # Return the binary data for this attachment
     def binary
       @binary ||= persisted? ? Attach.backend.read(self) : nil
+      @binary == :nil ? nil : @binary
     end
 
     # Return the path to the attachment
@@ -92,9 +88,13 @@ module Attach
     # Return a child process
     def child(role)
       @cached_children ||= {}
-      @cached_children[role.to_sym] ||= begin
-        self.children.where(:role => role).first
-      end
+      @cached_children[role.to_sym] ||= self.children.where(:role => role).first || :nil
+      @cached_children[role.to_sym] == :nil ? nil : @cached_children[role.to_sym]
+    end
+
+    # Try to return a given otherwise revert to the parent
+    def try(role)
+      child(role) || self
     end
 
     # Add a child attachment

data/lib/attach/attachment_dsl.rb

@@ -0,0 +1,26 @@
+module Attach
+  class AttachmentDSL
+
+    attr_reader :processors
+    attr_reader :validators
+
+    def initialize(&block)
+      @processors = []
+      @validators = []
+      if block_given?
+        instance_eval(&block)
+      end
+    end
+
+    def processor(*processors, &block)
+      processors.each { |p| @processors << p }
+      @processors << block if block_given?
+    end
+
+    def validator(*validators, &block)
+      validators.each { |v| @validators << v }
+      @validators << block if block_given?
+    end
+
+  end
+end

data/lib/attach/backends/abstract.rb

@@ -28,7 +28,17 @@ module Attach
       # Return the URL that this attachment can be accessed at
       #
       def url(attachment)
-        "/attachment/#{attachment.token}/#{attachment.file_name}"
+        "#{Attach.asset_host}/attachment/#{attachment.token}/#{attachment.file_name}"
+      end
+
+      #
+      # Return binaries for a set of files. They should be returned as a hash consisting
+      # of the attachment ID followed by the data
+      #
+      def read_multi(attachments)
+        attachments.compact.each_with_object({}) do |attachment, hash|
+          hash[attachment] = read(attachment)
+        end
       end
 
     end

data/lib/attach/backends/database.rb

@@ -22,6 +22,12 @@ module Attach
         AttachmentBinary.where(:attachment_id => attachment.id).destroy_all
       end
 
+      def read_multi(attachments)
+        AttachmentBinary.where(:attachment_id => attachments.map(&:id)).each_with_object({}) do |binary, hash|
+          hash[binary.attachment_id] = binary.data
+        end
+      end
+
     end
   end
 end

data/lib/attach/file.rb

@@ -0,0 +1,15 @@
+module Attach
+  class File
+
+    attr_accessor :data
+    attr_accessor :name
+    attr_accessor :type
+
+    def initialize(data, name = "untitled", type = "application/octet-stream")
+      @data = data
+      @name = name
+      @type = type
+    end
+
+  end
+end

data/lib/attach/middleware.rb

@@ -9,11 +9,11 @@ module Attach
 
     def call(env)
       if env['PATH_INFO'] =~ /\A\/attachment\/([a-f0-9\-]{36})\/(.*)/
-        if attachment = Attach::Attachment.find_by_token($1)
+        if attachment = Attach::Attachment.where(:serve => true).find_by_token($1)
           [200, {
             'Content-Length' => attachment.file_size.to_s,
             'Content-Type' => attachment.file_type,
-            'Cache-Control' => "#{attachment.cache_type || 'private'}, immutable, maxage=#{attachment.cache_max_age || 30.days.to_i}",
+            'Cache-Control' => "#{attachment.cache_type || 'private'}, immutable, max-age=#{attachment.cache_max_age || 30.days.to_i}",
             'Content-Disposition' => "#{attachment.disposition || 'attachment'}; filename=\"#{attachment.file_name}\","
             },
           [attachment.binary]]

data/lib/attach/model_extension.rb

@@ -1,5 +1,6 @@
 require 'attach/attachment'
 require 'attach/processor'
+require 'attach/attachment_dsl'
 
 module Attach
   module ModelExtension
@@ -12,15 +13,7 @@ module Attach
         end
 
         if @pending_attachments
-          @pending_attachments.each do |pa|
-            attachment = self.attachments.build(:uploaded_file => pa[:file], :role => pa[:role])
-            if pa[:options]
-              pa[:options].each do |key, value|
-                attachment.send("#{key}=", value)
-              end
-            end
-            attachment.save!
-          end
+          @pending_attachments.values.each(&:save!)
           @pending_attachments = nil
         end
       end
@@ -33,43 +26,77 @@ module Attach
           if records.empty?
             # Nothing to do
           else
+
             if options.first.is_a?(Hash)
               options = options.first
+              binaries_to_include = options.delete(:_include_binaries) || {}
             else
-              options = options.each_with_object({}) do |role, hash|
-                hash[role.to_sym] = []
+              binaries_to_include = {}
+              options = options.each_with_object({}) do |opt, hash|
+                if opt.is_a?(Symbol) || opt.is_a?(String)
+                  hash[opt.to_sym] = []
+                elsif opt.is_a?(Hash)
+                  opt.each do |key, value|
+                    if key == :_include_binaries
+                      binaries_to_include = value
+                    else
+                      hash[key.to_sym] = value
+                    end
+                  end
+                end
               end
+
             end
 
             options.keys.each do |key|
               if options[key].is_a?(Symbol)
                 options[key] = [options[key]]
+              elsif options[key] == true
+                options[key] = []
               end
             end
 
+            attachments_for_binary_preload = []
             root_attachments = {}
             Attachment.where(:owner_id => records.map(&:id), :owner_type => records.first.class.to_s, :role => options.keys).each do |attachment|
               root_attachments[[attachment.owner_id, attachment.role]] = attachment
+              if binaries_to_include[attachment.role.to_sym] && binaries_to_include[attachment.role.to_sym].include?(:_self)
+                attachments_for_binary_preload << attachment
+              end
             end
 
-            child_attachments = {}
             child_roles = options.values.flatten
-            Attachment.where(:parent_id => root_attachments.values.map(&:id), :role => child_roles).each do |attachment|
-              child_attachments[[attachment.id, attachment.role]] = attachment
+            unless child_roles.empty?
+              child_attachments = {}
+              Attachment.where(:parent_id => root_attachments.values.map(&:id), :role => child_roles).each do |attachment|
+                child_attachments[[attachment.parent_id, attachment.role]] = attachment
+              end
+
+              root_attachments.values.each do |attachment|
+                options[attachment.role.to_sym].each do |role|
+                  child_attachment = child_attachments[[attachment.id, role.to_s]]
+
+                  if child_attachment && binaries_to_include[attachment.role.to_sym] && binaries_to_include[attachment.role.to_sym].include?(role)
+                    attachments_for_binary_preload << child_attachment
+                  end
+
+                  attachment.instance_variable_set("@cached_children", {}) if attachment.instance_variable_get("@cached_children").nil?
+                  attachment.instance_variable_get("@cached_children")[role.to_sym] = child_attachments[[attachment.id, role.to_s]] || :nil
+                end
+              end
             end
 
-            root_attachments.values.each do |attachment|
-              options[attachment.role.to_sym].each do |role|
-                attachment.instance_variable_set("@cached_children", {}) if attachment.instance_variable_get("@cached_children").nil?
-                attachment.instance_variable_get("@cached_children")[role.to_sym] = attachment
+            if binaries = Attach.backend.read_multi(attachments_for_binary_preload)
+              attachments_for_binary_preload.each do |attachment|
+                attachment.instance_variable_set("@binary", binaries[attachment.id] || :nil)
               end
+            else
+              # Preloading binaries isn't supported by the backend
             end
 
             records.each do |record|
               options.keys.each do |role|
-                if a = root_attachments[[record.id, role.to_s]]
-                  record.instance_variable_set("@#{role}", a)
-                end
+                record.instance_variable_set("@#{role}", root_attachments[[record.id, role.to_s]] || :nil)
               end
             end
           end
@@ -81,29 +108,63 @@ module Attach
           has_many :attachments, :as => :owner, :dependent => :destroy, :class_name => 'Attach::Attachment'
         end
 
-        if block_given?
-          Processor.register(self, name, &block)
+        dsl = AttachmentDSL.new(&block)
+
+        dsl.processors.each do |processor|
+          Processor.register(self, name, &processor)
         end
 
-        define_method name do
-          instance_variable_get("@#{name}") || begin
-            attachment = self.attachments.where(:role => name, :parent_id => nil).first
-            instance_variable_set("@#{name}", attachment)
+        if dsl.validators.size > 0
+          validate do
+            attachment = @pending_attachments && @pending_attachments[name] ? @pending_attachments[name] : send(name)
+            file_errors = []
+            dsl.validators.each do |validator|
+              validator.call(attachment, file_errors)
+            end
+            file_errors.each { |e| errors.add("#{name}_file", e) }
           end
         end
 
-        define_method "#{name}_file" do
-          instance_variable_get("@#{name}_file")
+        define_method name do
+          var = instance_variable_get("@#{name}")
+          if var
+            var == :nil ? nil : var
+          else
+            if attachment = self.attachments.where(:role => name, :parent_id => nil).first
+              instance_variable_set("@#{name}", attachment)
+            else
+              instance_variable_set("@#{name}", :nil)
+              nil
+            end
+          end
         end
 
-        define_method "#{name}_file=" do |file|
-          instance_variable_set("@#{name}_file", file)
-          if file.is_a?(ActionDispatch::Http::UploadedFile)
-            @pending_attachments ||= []
-            @pending_attachments << {:role => name, :file => file, :options => options}
-          else
-            nil
+        define_method "#{name}=" do |file|
+          if file.is_a?(Attach::Attachment)
+            attachment = file
+          elsif file
+            attachment = Attachment.new({:owner => self, :role => name}.merge(options))
+            case file
+            when ActionDispatch::Http::UploadedFile
+              attachment.binary = file.tempfile.read
+              attachment.file_name = file.original_filename
+              attachment.file_type = file.content_type
+            when Attach::File
+              attachment.binary = file.data
+              attachment.file_name = file.name
+              attachment.file_type = file.type
+            else
+              attachment.binary = file
+              attachment.file_name = "untitled"
+              attachment.file_type = "application/octet-stream"
+            end
+          end
+
+          if attachment
+            @pending_attachments ||= {}
+            @pending_attachments[name] = attachment
           end
+          instance_variable_set("@#{name}", attachment)
         end
 
         define_method "#{name}_delete" do

data/lib/attach/processor.rb

@@ -25,7 +25,8 @@ module Attach
 
     def process
       call_processors(@attachment)
-      @attachment.update_column(:processed, true)
+      @attachment.processed = true
+      @attachment.save(:validate => false)
     end
 
     def queue_or_process

data/lib/attach/version.rb

@@ -1,3 +1,3 @@
 module Attach
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attach
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: records_manipulator
@@ -40,9 +40,11 @@ files:
 - lib/attach.rb
 - lib/attach/attachment.rb
 - lib/attach/attachment_binary.rb
+- lib/attach/attachment_dsl.rb
 - lib/attach/backends/abstract.rb
 - lib/attach/backends/database.rb
 - lib/attach/backends/file_system.rb
+- lib/attach/file.rb
 - lib/attach/middleware.rb
 - lib/attach/model_extension.rb
 - lib/attach/processor.rb
@@ -73,3 +75,4 @@ signing_key:
 specification_version: 4
 summary: Attach documents & files to Active Record models
 test_files: []
+has_rdoc: