activestorage-delayed 0.2.0.pre.pre → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b3779f97c4d12be774399968c3ef1b3e0c006bf4c39da9ecf5fd583bdeadf4
-  data.tar.gz: c9e4338a68b08f564d2b6e8c0c6f608d21dc70feea8688afbe22f1566b88a7ca
+  metadata.gz: 23b95115e89560a1c7e3a880f0b89a1d7aaf99fe4b6e54c1b207ce0d435dfda2
+  data.tar.gz: 727dd8e29453607c884e4ddf126fd1f41da790bb8c1db89ae30cedc506b02900
 SHA512:
-  metadata.gz: 88ebc7439257498bd71450e9958856102fb0a948bc1c3b3d0b26fabc43aae6094599187f3336dac6a125f8c3be320a5648f66c57cc9aa299d2ce540dcf4ec77e
-  data.tar.gz: cea2b0e318299d762121f285a270e72d11457b742537b6515fb95232de48222c52db8ea7d2af0b5281402d22b905de6fc869333de03daba393519214c88c3743
+  metadata.gz: 976b9b1c03bab65f651fb81d2915aeb9561e380fbd35b26069c3263d4f443f029cc4fd22bee015a4e946eb20487b68228a5d66d175978c556f0a76e6979b59b8
+  data.tar.gz: 29d8ae5308daa56f5845e4deeb70a709cce48a9f5c48b2759ad4473cea0041c6a84a0f50b50657235177d5d10dd6736696c305a304d38474dc2cca05d5a6de5b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activestorage-delayed (0.2.0.pre.pre)
+    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, required: 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
@@ -50,6 +50,7 @@ end
 ### `delayed_attach` accepts an optional hash with the following options:
 - `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_uploader.rb

@@ -18,20 +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.send("#{attr_name}_error_upload", 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!
@@ -42,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']
@@ -51,9 +57,22 @@ module ActivestorageDelayed
       end
     end
 
-    def base64_to_file(file_data)
-      io = StringIO.new(Base64.decode64(file_data['io']))
-      apply_variant(io, attr_settings[:variant_info]) { |io2| return io2 }
+    def parse_file_io(file_data, &block)
+      tempfile = Tempfile.new(file_data['filename'], binmode: true)
+      tempfile.write Base64.decode64(file_data['io'])
+      tempfile.rewind
+      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
@@ -84,13 +103,5 @@ module ActivestorageDelayed
     def attr_settings
       model.class.instance_variable_get(:@ast_delayed_settings)[attr_name]
     end
-
-    # @param io [StringIO, File]
-    # @param variant_info [Hash, Nil] ActiveStorage variant info. Sample: { resize_to_fit: [400, 400], convert: 'jpg' }
-    def apply_variant(io, variant_info, &block)
-      return block.call(io) unless variant_info
-
-      ActiveStorage::Variation.wrap(variant_info).transform(io, &block)
-    end
   end
 end

data/lib/activestorage-delayed/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-delayed
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.pre
+  version: 0.2.0
 platform: ruby
 authors:
 - Owen Peredo Diaz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -88,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: