after_attached 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d86dd83ab47f5cdc21e98eccb6e0e31d601cae0c808be8860496cad87729fa6d
+  data.tar.gz: b33242818b08a4dc54fe5b7271421f24f7a5f5e3e2a1127de3036eaadbf532cc
+SHA512:
+  metadata.gz: ec32489dd3032e32e6f0d2d7c676ea758dbcd0a54eea6dc203930f3a74349961e3f9ae0c5f17ee01f5a30ab0beea3ee2f9dd487cd1147851635876261edeb3f8
+  data.tar.gz: 97edac8538345e742d81397d58ca2304618487ed9926baa598b5c0a64e12cf28c2877eca5f26fdcbd26d8a636b5c1cd7d90e3b3d19821d4496c16994701d0dd7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'lib/after_attached/railtie.rb'
+
+Style/Documentation:
+  Enabled: false
+
+# Allow array style in schema definitions
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Style/SymbolArray:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-31
+
+### Added
+- Initial release of after_attached gem
+- Complete set of attachment lifecycle callbacks:
+  - `before_attached` - runs before an attachment is saved
+  - `after_attached` - runs after an attachment is committed to the database
+  - `before_detached` - runs before an attachment is destroyed
+  - `after_detached` - runs after an attachment is destroyed and committed
+- Support for method symbols and blocks as callbacks
+- Support for multiple callbacks per attachment
+- Support for both `has_one_attached` and `has_many_attached` associations
+- Automatic inclusion in all Active Record models via Railtie
+- Guards to prevent duplicate callback execution
+- Full test coverage with RSpec
+- CI/CD setup with GitHub Actions testing against Rails 6.1, 7.0, 7.1, and 8.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,180 @@
+# AfterAttached
+
+Provides comprehensive attachment lifecycle callbacks for Rails models with Active Storage attachments. Run code before and after attachments are created or destroyed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'after_attached'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+The gem automatically includes the `AttachmentCallbacks` concern in all Active Record models, providing four callbacks for attachment lifecycle events:
+
+- `before_attached` - runs before an attachment is saved
+- `after_attached` - runs after an attachment is committed to the database
+- `before_detached` - runs before an attachment is destroyed
+- `after_detached` - runs after an attachment is destroyed and committed
+
+### Basic Usage
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+
+  # Using a method
+  after_attached :avatar, :process_avatar
+
+  private
+
+  def process_avatar(attachment)
+    # This will run once when avatar is attached
+    AvatarProcessingJob.perform_later(self, attachment)
+  end
+end
+```
+
+You can also use a block:
+
+```ruby
+class Document < ApplicationRecord
+  has_one_attached :file
+
+  after_attached :file do |attachment|
+    # Access attachment properties
+    Rails.logger.info "Attached file: #{attachment.filename}"
+    Rails.logger.info "Content type: #{attachment.content_type}"
+    Rails.logger.info "File size: #{attachment.byte_size}"
+  end
+end
+```
+
+### Multiple Callbacks
+
+You can define multiple callbacks for the same attachment:
+
+```ruby
+class Photo < ApplicationRecord
+  has_one_attached :image
+
+  after_attached :image, :generate_thumbnail
+  after_attached :image, :extract_metadata
+  after_attached :image do |attachment|
+    notify_admin("New photo uploaded: #{attachment.filename}")
+  end
+end
+```
+
+### Works with has_many_attached
+
+The callbacks fire for each attachment when using `has_many_attached`:
+
+```ruby
+class Gallery < ApplicationRecord
+  has_many_attached :photos
+
+  after_attached :photos do |attachment|
+    # This runs for each photo attached
+    ProcessPhotoJob.perform_later(attachment)
+  end
+end
+
+# Attaching multiple files
+gallery.photos.attach([photo1, photo2]) # Callback fires twice, once for each photo
+
+# Adding more photos later
+gallery.photos.attach(photo3) # Callback fires once for the new photo
+```
+
+### All Available Callbacks
+
+```ruby
+class Document < ApplicationRecord
+  has_one_attached :file
+
+  # Called before the attachment record is created
+  before_attached :file do |attachment|
+    Rails.logger.info "About to attach: #{attachment.filename}"
+  end
+
+  # Called after the attachment record is committed
+  after_attached :file do |attachment|
+    ProcessingJob.perform_later(attachment)
+  end
+
+  # Called before the attachment record is destroyed
+  before_detached :file do |attachment|
+    Rails.logger.info "About to detach: #{attachment.filename}"
+  end
+
+  # Called after the attachment record is destroyed and committed
+  after_detached :file do |attachment|
+    CleanupJob.perform_later(record_id: id, filename: attachment.filename.to_s)
+  end
+end
+```
+
+### Replacing Attachments
+
+When replacing a `has_one_attached` attachment, both detachment callbacks (for the old attachment) and attachment callbacks (for the new one) fire:
+
+```ruby
+user.avatar.attach(first_file)  # before_attached, after_attached fire
+user.avatar.attach(second_file) # before_detached, after_detached fire for first_file
+                                # then before_attached, after_attached fire for second_file
+```
+
+### Removing Attachments
+
+To trigger detachment callbacks, you need to destroy the attachment record:
+
+```ruby
+# This triggers before_detached and after_detached callbacks
+document.file.attachment.destroy!
+
+# Note: purge and purge_later bypass the destroy callbacks
+# If you need the callbacks to fire, use destroy! instead
+```
+
+## How It Works
+
+Under the hood, the gem:
+1. Includes an `AttachmentCallbacks` concern in all Active Record models via a Rails initializer
+2. Patches ActiveStorage::Attachment with ActiveRecord callbacks:
+   - `before_create` → triggers `before_attached`
+   - `after_create_commit` → triggers `after_attached`
+   - `before_destroy` → triggers `before_detached`
+   - `after_destroy_commit` → triggers `after_detached`
+3. Maintains a registry of callbacks per model and attachment name using a `class_attribute`
+
+No blob ID tracking or complex bookkeeping - just simple, reliable callbacks that fire at the appropriate points in the attachment lifecycle. Since the callbacks are triggered at the `ActiveStorage::Attachment` level, they work seamlessly with both `has_one_attached` and `has_many_attached` associations.
+
+## Compatibility
+
+- Rails 6.0+
+- Ruby 3.0+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/obiefernandez/after_attached. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/obiefernandez/after_attached/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AfterAttached project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/obiefernandez/after_attached/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/after_attached/attachment_callbacks.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module AfterAttached
+  module AttachmentCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_attachment_callbacks, default: {
+        before_attached: {},
+        after_attached: {},
+        before_detached: {},
+        after_detached: {}
+      }
+    end
+
+    class_methods do
+      def before_attached(attachment_name, method_name = nil, &block)
+        register_attachment_callback(:before_attached, attachment_name, method_name, &block)
+      end
+
+      def after_attached(attachment_name, method_name = nil, &block)
+        register_attachment_callback(:after_attached, attachment_name, method_name, &block)
+      end
+
+      def before_detached(attachment_name, method_name = nil, &block)
+        register_attachment_callback(:before_detached, attachment_name, method_name, &block)
+      end
+
+      def after_detached(attachment_name, method_name = nil, &block)
+        register_attachment_callback(:after_detached, attachment_name, method_name, &block)
+      end
+
+      private
+
+      def register_attachment_callback(callback_type, attachment_name, method_name = nil, &block)
+        raise ArgumentError, "Must provide either a method name or a block" unless method_name || block
+
+        callback = method_name || block
+        attachment_name = attachment_name.to_s
+
+        # Deep dup the callbacks hash to avoid mutation issues
+        new_callbacks = _attachment_callbacks.deep_dup
+        new_callbacks[callback_type][attachment_name] ||= []
+        new_callbacks[callback_type][attachment_name] << callback
+
+        self._attachment_callbacks = new_callbacks
+      end
+    end
+
+    def _run_attachment_callbacks(callback_type, attachment)
+      callbacks = self.class._attachment_callbacks[callback_type][attachment.name]
+      return unless callbacks
+
+      callbacks.each do |cb|
+        invoke_callback(cb, attachment)
+      end
+    rescue StandardError => e
+      Rails.logger.error("#{callback_type} callback failed on #{self.class}##{attachment.name}: #{e.message}")
+      raise
+    end
+
+    # Convenience methods for backward compatibility and clarity
+    def _run_before_attached_callbacks(attachment)
+      _run_attachment_callbacks(:before_attached, attachment)
+    end
+
+    def _run_after_attached_callbacks(attachment)
+      _run_attachment_callbacks(:after_attached, attachment)
+    end
+
+    def _run_before_detached_callbacks(attachment)
+      _run_attachment_callbacks(:before_detached, attachment)
+    end
+
+    def _run_after_detached_callbacks(attachment)
+      _run_attachment_callbacks(:after_detached, attachment)
+    end
+
+    def invoke_callback(callback, attachment)
+      case callback
+      when Symbol, String
+        send(callback, attachment)
+      else
+        instance_exec(attachment, &callback)
+      end
+    end
+  end
+end

data/lib/after_attached/railtie.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module AfterAttached
+  class Railtie < Rails::Railtie
+    initializer "after_attached.setup_callbacks" do
+      ActiveSupport.on_load(:active_record) do
+        include AfterAttached::AttachmentCallbacks
+      end
+
+      ActiveSupport.on_load(:active_storage_attachment) do
+        # Before attached - runs before the attachment is saved
+        before_create do
+          record = self.record
+          # Guard against multiple calls
+          @_before_attached_run ||= false
+          unless @_before_attached_run
+            @_before_attached_run = true
+            if record && record.class.respond_to?(:_attachment_callbacks) &&
+               record.respond_to?(:_run_before_attached_callbacks)
+              record._run_before_attached_callbacks(self)
+            end
+          end
+        end
+
+        # After attached - runs after the attachment is committed
+        after_create_commit do
+          record = self.record
+
+          # Guard against multiple calls
+          @_after_attached_run ||= false
+          unless @_after_attached_run
+            @_after_attached_run = true
+            if record && record.class.respond_to?(:_attachment_callbacks) &&
+               record.respond_to?(:_run_after_attached_callbacks)
+              record._run_after_attached_callbacks(self)
+            end
+          end
+        end
+
+        # Before detached - runs before the attachment is destroyed
+        before_destroy do
+          record = self.record
+          # Guard against multiple calls
+          @_before_detached_run ||= false
+          unless @_before_detached_run
+            @_before_detached_run = true
+            if record && record.class.respond_to?(:_attachment_callbacks) &&
+               record.respond_to?(:_run_before_detached_callbacks)
+              record._run_before_detached_callbacks(self)
+            end
+          end
+        end
+
+        # After detached - runs after the attachment is destroyed and committed
+        after_destroy_commit do
+          # Need to get the record before destruction
+          record = self.record
+
+          # Guard against multiple calls
+          @_after_detached_run ||= false
+          unless @_after_detached_run
+            @_after_detached_run = true
+            if record && record.class.respond_to?(:_attachment_callbacks) &&
+               record.respond_to?(:_run_after_detached_callbacks)
+              record._run_after_detached_callbacks(self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/after_attached/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AfterAttached
+  VERSION = "0.1.0"
+end

data/lib/after_attached.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+
+require_relative "after_attached/version"
+require_relative "after_attached/attachment_callbacks"
+require_relative "after_attached/railtie" if defined?(Rails::Railtie)
+
+module AfterAttached
+  class Error < StandardError; end
+end