activestorage-delayed 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21cd7652c2fbe15057bf6f36a36c7ec510ed1e622f5adb0e0f566f5a2e30c111
-  data.tar.gz: e16a8f72a0cc7049dfccb958499ba112659abcf0afbf03e9961fdcaea6cd76cd
+  metadata.gz: 23b95115e89560a1c7e3a880f0b89a1d7aaf99fe4b6e54c1b207ce0d435dfda2
+  data.tar.gz: 727dd8e29453607c884e4ddf126fd1f41da790bb8c1db89ae30cedc506b02900
 SHA512:
-  metadata.gz: 1c69f49fc4c77684d71a9ccc9b6fdf09bdea824a0f6588974024dce997ebfe7bac49bfa0c257a8c4610437a133837d00a3040e812b8d1014f9efb5c078104079
-  data.tar.gz: '0802bc892fa31b38e35042860919944b7eeee09811057eb082d0a4eaf426d880a624aa306835e75acbf54cc9cf0e631c3ab5a07e18307a0f9c70ef9b99492160'
+  metadata.gz: 976b9b1c03bab65f651fb81d2915aeb9561e380fbd35b26069c3263d4f443f029cc4fd22bee015a4e946eb20487b68228a5d66d175978c556f0a76e6979b59b8
+  data.tar.gz: 29d8ae5308daa56f5845e4deeb70a709cce48a9f5c48b2759ad4473cea0041c6a84a0f50b50657235177d5d10dd6736696c305a304d38474dc2cca05d5a6de5b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activestorage-delayed (0.1.3)
+    activestorage-delayed (0.2.0)
       activestorage
       rails
 

data/README.md

@@ -39,7 +39,7 @@ Note: This gem assumes that the app has already configured activestorage.
   class User < ApplicationRecord
   include ActivestorageDelayed::DelayedConcern
 
-  has_one_attached :photo, require: true, use_filename: true
+  has_one_attached :photo, required: true, use_filename: true, variant_info: { resize_to_fit: [400, 400], convert: 'jpg' }
   delayed_attach :photo
 
   has_many_attached :certificates
@@ -48,8 +48,9 @@ end
 
 ```
 ### `delayed_attach` accepts an optional hash with the following options:
-- `require`: If set to `true`, the `photo` or the `photo_tmp` will be required before saving.
+- `required`: If set to `true`, the `photo` or the `photo_tmp` will be required before saving.
 - `use_filename`: If set to `true`, the image filename will be used as the name of uploaded file instead of the hash-key used by `activestorage`
+- `variant_info`: (Hash) Variant information to be performed before uploading the file.
 
 ### Examples to upload files in background 
 - Upload a single file
@@ -90,7 +91,7 @@ end
     User.first.update(certificates_tmp: { clean_before: true, files: [File.open('my_file.png')] })
   ```
   
-- Upload files with custom names (requires `use_filename: true`)
+- Upload files with custom names (requires `use_filename: true`): `<attr_name>_filename`
   ```ruby
   class User < ApplicationRecord
     def photo_filename(filename)
@@ -101,42 +102,27 @@ end
   When `<attr_name>_filename` is defined, then it is called to fetch the uploaded file name.    
   Note: Check [this](https://gist.github.com/owen2345/33730a452d73b6b292326bb602b0ee6b) if you want to rename an already uploaded file (remote file)
 
-- Capture event when file upload has failed
+- Capture event when file upload has failed: `<attr_name>_error_upload`
   ```ruby
     class User < ApplicationRecord
-      def ast_delayed_on_error(attr_name, error)
-        puts "Failed #{attr_name} with #{error}"
+      def photo_error_upload(error)
+        puts "Failed with #{error}"
       end
     end
   ```
 
-- Capture event when file has been uploaded
+- Capture event when file has been uploaded: `<attr_name>_after_upload`
   ```ruby
     class User < ApplicationRecord
-      after_save_commit do
-        puts 'Photo has been uploaded' if photo.blob.present?
-        puts 'No pending enqueued photo uploads' unless photo_delayed_uploads.any?
-      end
-      
-      before_save do 
-        puts "current assigned tmp photo: #{photo_tmp.inspect}"
+      def photo_after_upload
+        puts "Photo has been uploaded"
       end
     end
   ```
+
+Note:       
   `<attr_name>_delayed_uploads` is a `has_many` association that contains the list of scheduled uploads for the corresponding attribute.
   
-  
-## Preprocessing original files before uploading (Rails 7+)
-```ruby
-class User < ApplicationRecord
-  has_one_attached :photo do |attachable|
-    attachable.variant :default, strip: true, quality: 70, resize_to_fill: [200, 200]
-  end
-end
-```
-`:default` variant will be used to pre-preprocess the original file before uploading (if defined). By this way you have your desired image size and quality as the original image.
-
-
 
 ## Contributing
 Bug reports and pull requests are welcome on https://github.com/owen2345/activestorage-delayed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.    

data/lib/activestorage-delayed/delayed_concern.rb

@@ -3,10 +3,14 @@
 module ActivestorageDelayed
   module DelayedConcern
     extend ActiveSupport::Concern
-    included do
+    included do # rubocop:disable Metrics/BlockLength
       @ast_delayed_settings = {}
-      def self.delayed_attach(attr_name, required: false, use_filename: false) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        @ast_delayed_settings[attr_name] = { use_filename: use_filename }
+
+      # @param settings (Hash)
+      #   use_filename: (Boolean)
+      #   variant_info: (Hash) Sample: { resize_to_fit: [400, 400], convert: 'jpg' }
+      def self.delayed_attach(attr_name, required: false, **settings) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        @ast_delayed_settings[attr_name] = settings
         tmp_attr_name = :"#{attr_name}_tmp"
         has_many_attr = :"#{attr_name}_delayed_uploads"
         attr_accessor tmp_attr_name
@@ -27,11 +31,22 @@ module ActivestorageDelayed
           delayed_data[:attr_name] = attr_name
           send(has_many_attr) << send(has_many_attr).new(delayed_data)
         end
+
+        # @param filename (String) File name
+        define_method "#{attr_name}_filename" do |filename|
+          name = File.basename(filename, '.*').parameterize
+          is_multiple = send(attr_name).class.name.include?('Many')
+          name = "#{SecureRandom.uuid}-#{name}" if is_multiple
+          "#{send(:id)}-#{name}#{File.extname(filename)}"
+        end
+
+        define_method "#{attr_name}_after_upload" do
+        end
+
+        # @param _error (Exception)
+        define_method "#{attr_name}_error_upload" do |_error|
+        end
       end
     end
-
-    # @param _attr_name (String)
-    # @param _error (Exception)
-    def ast_delayed_on_error(_attr_name, _error); end
   end
 end

data/lib/activestorage-delayed/delayed_uploader.rb

@@ -18,19 +18,27 @@ module ActivestorageDelayed
 
     private
 
-    # TODO: check the ability to delete io with save or upload method
-    # file_data['io'].close
-    def upload_photos # rubocop:disable Metrics/AbcSize
-      tmp_files_data.each do |file_data|
-        model.send(attr_name).attach(file_data.transform_keys(&:to_sym))
-      end
+    def upload_photos
+      tmp_files_data.each(&method(:upload_photo))
+      model.send("#{attr_name}_after_upload")
       true
     rescue => e # rubocop:disable Style/RescueStandardError
-      Rails.logger.error("********* #{self.class.name} -> Failed uploading files: #{e.message}. #{e.backtrace[0..20]}")
-      model.ast_delayed_on_error(attr_name, e)
+      print_failure(e)
       false
     end
 
+    def upload_photo(file_data)
+      parse_file_io(file_data) do |io|
+        file_data['io'] = io
+        model.send(attr_name).attach(file_data.transform_keys(&:to_sym))
+      end
+    end
+
+    def print_failure(error)
+      Rails.logger.error("***#{self.class.name} -> Failed uploading files: #{error.message}. #{error.backtrace[0..20]}")
+      model.send("#{attr_name}_error_upload", error)
+    end
+
     def save_changes
       model.save!
       delayed_upload.destroy!
@@ -41,7 +49,6 @@ module ActivestorageDelayed
       @tmp_files_data ||= begin
         files = JSON.parse(delayed_upload.files || '[]')
         files.each do |file_data|
-          file_data['io'] = base64_to_file(file_data)
           if attr_settings[:use_filename]
             file_data['key'] = filename_for(file_data['filename'])
             file_data['filename'] = file_data['key']
@@ -50,12 +57,22 @@ module ActivestorageDelayed
       end
     end
 
-    def base64_to_file(file_data)
-      tempfile = Tempfile.new(file_data['filename'])
-      tempfile.binmode
+    def parse_file_io(file_data, &block)
+      tempfile = Tempfile.new(file_data['filename'], binmode: true)
       tempfile.write Base64.decode64(file_data['io'])
       tempfile.rewind
-      tempfile
+      transform_variation(tempfile, attr_settings[:variant_info]) do |io|
+        block.call(io)
+        tempfile.close
+      end
+    end
+
+    # @param io [StringIO, File]
+    # @param variant_info [Hash, Nil] ActiveStorage variant info. Sample: { resize_to_fit: [400, 400], convert: 'jpg' }
+    def transform_variation(io, variant_info, &block)
+      return block.call(io) unless variant_info
+
+      ActiveStorage::Variation.wrap(variant_info).transform(io, &block)
     end
 
     def model
@@ -64,11 +81,7 @@ module ActivestorageDelayed
 
     def filename_for(filename)
       method_name = "#{attr_name}_filename".to_sym
-      return model.send(method_name, filename) if model.respond_to?(method_name)
-
-      name = File.basename(filename, '.*').parameterize
-      name = "#{SecureRandom.uuid}-#{name}" if support_multiple?
-      "#{model.id}-#{name}#{File.extname(filename)}"
+      model.send(method_name, filename)
     end
 
     def remove_files

data/lib/activestorage-delayed/models/delayed_upload.rb

@@ -10,7 +10,7 @@ module ActivestorageDelayed
     self.table_name = 'activestorage_delayed_uploads'
     attr_accessor :tmp_files
 
-    belongs_to :uploadable, polymorphic: true
+    belongs_to :uploadable, polymorphic: true, touch: true
 
     before_save :parse_tmp_files
     after_create_commit do

data/lib/activestorage-delayed/railtie.rb

@@ -4,9 +4,5 @@ require 'rails'
 module ActivestorageDelayed
   class Railtie < ::Rails::Railtie
     railtie_name :activestorage_delayed
-
-    config.after_initialize do |_app|
-      require_relative '../../initializers/upload_default_variation'
-    end
   end
 end

data/lib/activestorage-delayed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivestorageDelayed
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-delayed
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Owen Peredo Diaz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -64,7 +64,6 @@ files:
 - bin/test
 - db/test.sqlite3
 - docker-compose.yaml
-- initializers/upload_default_variation.rb
 - lib/activestorage-delayed.rb
 - lib/activestorage-delayed/delayed_concern.rb
 - lib/activestorage-delayed/delayed_uploader.rb

data/initializers/upload_default_variation.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# Ability to auto apply :default variant before uploading original image
-module ActivetoragePreprocessDefaultVariation
-  def self.prepended(base)
-    base.extend(ClassMethods)
-  end
-
-  def upload_without_unfurling(io) # rubocop:disable Metrics/MethodLength
-    variant = attachments.first.try(:send, :variants)
-    default_variant = variant ? variant[:default] : nil
-    if default_variant && self.class.enabled_default_variant?
-      ActiveStorage::Variation.wrap(default_variant).transform(io) do |output|
-        unfurl output, identify: identify
-        save! if id.present? # update new unfurl information
-        super(output)
-      end
-    else
-      super(io)
-    end
-  end
-
-  module ClassMethods
-    # To improve testing performance, we don't want to preprocess images in test environment
-    def enabled_default_variant?
-      !Rails.env.test?
-    end
-  end
-end
-
-ActiveStorage::Blob.prepend ActivetoragePreprocessDefaultVariation