activestorage-after_analyze_attached 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f44aaa9dd72737da7e125e5605caf5d1d603a3e21de7f948aacd9193e0be3f1
+  data.tar.gz: e053f0e7f6e7e9a6b0600f04fcd528d69a1a23352ddde2e842b345573203d0a8
+SHA512:
+  metadata.gz: f6d238f23278a948c65877a8cc4cd772d106ec9c6010a5382e0b96183d82dffe8d1910ba4c830c69573619dc810f8ffc5a9c272b6a703141c9e391351922fa50
+  data.tar.gz: 28e3f54ecfa8ac16899133cd490c09c0692c9de15c413e5c329b9ae32a285c810c4d8608345b0fb491b51c954a3f430aa545db8eee07e62817328a327501f377

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Syed Fazil Basheer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Activestorage::AfterAnalyzeAttached
+
+A Rails gem that provides a callback for when Active Storage attachments are analyzed. This is particularly useful when you need to perform actions after Active Storage has analyzed an attachment, such as updating flags, triggering background jobs, or updating the UI.
+
+## Why use this gem?
+
+Active Storage analyzes uploaded files asynchronously to extract metadata like image dimensions, document page count, etc. However, there's no built-in way to hook into this analysis completion event. This gem provides that missing callback, allowing you to:
+
+- Update UI when image processing is complete
+- Trigger downstream processing after file analysis
+- Track progress of batch uploads
+- Maintain analysis state for attachments
+
+## Usage
+
+This gem adds an `after_analyze_attached` callback that you can use in your models. The callback is triggered after Active Storage analyzes an attachment.
+
+Example:
+
+```ruby
+class Product < ApplicationRecord
+  has_one_attached :thumbnail
+  has_many_attached :gallery_images
+
+  # Update UI when thumbnail is ready
+  after_analyze_attached :thumbnail do
+    broadcast_replace_to :products,
+      target: dom_id(self, :thumbnail_status),
+      partial: "products/thumbnail_status",
+      locals: { product: self }
+  end
+
+  # Track gallery processing progress
+  after_analyze_attached :gallery_images do
+    increment!(:processed_images_count)
+    if processed_images_count == gallery_images.count
+      update!(gallery_ready: true)
+      GalleryProcessingJob.perform_later(self)
+    end
+  end
+end
+
+class Document < ApplicationRecord
+  has_one_attached :pdf
+  belongs_to :organization
+
+  # Trigger OCR when PDF is analyzed
+  after_analyze_attached :pdf do
+    OcrProcessingJob.perform_later(self)
+    organization.members.each do |member|
+      DocumentMailer.ready_for_review(member, self).deliver_later
+    end
+  end
+end
+```
+
+In these examples:
+- Product thumbnails trigger UI updates via Turbo Streams when ready
+- Gallery images track processing progress and trigger a job when complete
+- Documents start OCR processing and notify team members when ready
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activestorage-after_analyze_attached"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activestorage-after_analyze_attached
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/frayzil/activestorage-after_analyze_attached.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/activestorage/after_analyze_attached/railtie.rb

@@ -0,0 +1,6 @@
+module Activestorage
+  module AfterAnalyzeAttached
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/activestorage/after_analyze_attached/version.rb

@@ -0,0 +1,5 @@
+module Activestorage
+  module AfterAnalyzeAttached
+    VERSION = "0.1.0"
+  end
+end

data/lib/activestorage/after_analyze_attached.rb

@@ -0,0 +1,42 @@
+require "activestorage/after_analyze_attached/version"
+require "active_storage/engine"
+require "rails"
+
+module ActiveStorage::AfterAnalyzeAttached
+  module BlobCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      define_callbacks :analyze
+      set_callback(:analyze, :after) { attachments.map(&:record).uniq.each { _1.blob_analyzed self } }
+    end
+
+    def analyze = run_callbacks(:analyze) { super }
+  end
+
+  module RecordCallbacks
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def after_analyze_attached(name, &callback)
+        after_analyze_attached_callbacks[name.to_sym] << callback
+      end
+
+      def after_analyze_attached_callbacks
+        @after_analyze_attached_callbacks ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+    end
+
+    def blob_analyzed(blob)
+      after_analyze_attached_callbacks(blob).each { instance_eval(&_1) }
+    end
+
+    def after_analyze_attached_callbacks(blob)
+      attachment_names = ActiveStorage::Attachment.where(blob: blob).pluck(:name).map(&:to_sym)
+      attachment_names.flat_map { |name| self.class.after_analyze_attached_callbacks[name] }
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_storage_blob) { include ActiveStorage::AfterAnalyzeAttached::BlobCallbacks }
+ActiveSupport.on_load(:active_record)       { include ActiveStorage::AfterAnalyzeAttached::RecordCallbacks }

data/lib/tasks/activestorage/after_analyze_attached_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :activestorage_after_analyze_attached do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-after_analyze_attached
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syed Fazil Basheer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+description: This gem extends ActiveStorage to provide an after_analyze callback that
+  gets triggered after analyzing an attachment
+email:
+- fazil@fazn.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/activestorage/after_analyze_attached.rb
+- lib/activestorage/after_analyze_attached/railtie.rb
+- lib/activestorage/after_analyze_attached/version.rb
+- lib/tasks/activestorage/after_analyze_attached_tasks.rake
+homepage: https://github.com/frayzil/activestorage-after_analyze_attached
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/frayzil/activestorage-after_analyze_attached
+  source_code_uri: https://github.com/frayzil/activestorage-after_analyze_attached
+  changelog_uri: https://github.com/frayzil/activestorage-after_analyze_attached/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Adds after_analyze callback to ActiveStorage attachments
+test_files: []