listenable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa0682e0a477e1a2367d552bab4b480cfdb2d902628cc0f3eff9b566750332b4
+  data.tar.gz: 81f80897906e86612474240bf7b1dedb2e7e21e4572d4313e61e65208f830d64
+SHA512:
+  metadata.gz: 781cc4d59e3a98604a8c2e06a5d0d981513ab08814949695b0da3b4ff4d9bb3ce737386e414969ae13e1fca1bee2b67708a12f71d7b46a9f76fe2b19c4c961f3
+  data.tar.gz: c2ae5d198f292ea9fb2c9792da90cc0bb9a97ec950b48dbf79090a2c0ddbdef832289a807b958d9f83739d8b0999e48a50560e3a21b3be176041923a903a1669

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Den Meralpis
+
+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,95 @@
+# Listenable
+
+Listenable is a Rails DSL that connects your ActiveRecord models to dedicated listener classes using `ActiveSupport::Notifications`.
+
+Instead of cluttering your models with callbacks, you declare listeners in `app/listeners`. Listenable automatically wires up the callbacks, instruments events, and runs your listener methods.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add listenable
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install listenable
+```
+
+## Usage
+
+#### 1. Define a model
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+end
+```
+
+#### 2. Create a listener
+```ruby
+# app/listeners/user_listener.rb
+class UserListener
+  include Listenable
+
+  listen :on_created, :on_updated, :on_deleted
+
+  # Handle user creation
+  def on_created(record)
+    Rails.logger.info "User created: #{user.id}"
+    SendWelcomeEmailJob.perform_later(user)
+  end
+
+  # Handle user update
+  def on_updated(record)
+    Rails.logger.info "User updated: #{user.id}"
+    SendProfileUpdateNotificationJob.perform_later(user)
+  end
+
+  # Handle user deletion
+  def on_deleted(record)
+    Rails.logger.info "User deleted: #{user.id}"
+    ArchiveUserDataJob.perform_later(user)
+  end
+end
+```
+
+#### 3. Done
+* When a user is created, `UserListener.on_created` runs.
+* When a user is updated, `UserListener.on_updated` runs.
+* When a user is deleted, `UserListener.on_deleted` runs.
+
+Under the hood:
+* `after_create`, `after_update`, and `after_destroy` callbacks are injected into the model.
+* `ActiveSupport::Notifications.instrument` fires events like `user.created`.
+* The Railtie subscribes your listener methods to those events.
+
+## Supported hooks
+| Listener hook         | Model callback        |
+|-----------------------|-----------------------|
+| `on_created`          | `after_create`       |
+| `on_updated`          | `after_update`       |
+| `on_deleted`          | `after_destroy`      |
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Todo:
+* Create rake tasks to generate listener files.
+* RSpec tests for Railtie and integration tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/denmarkmeralpis/listenable. 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/denmarkmeralpis/listenable/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 Listenable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/denmarkmeralpis/listenable/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/listenable/concern.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Listenable
+  CALLBACK_MAP = {
+    "created" => :after_create,
+    "updated" => :after_update,
+    "deleted" => :after_destroy
+  }.freeze
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def listen(*hooks)
+      @pending_hooks ||= []
+      @pending_hooks.concat(hooks.map(&:to_s))
+    end
+
+    def pending_hooks
+      @pending_hooks || []
+    end
+  end
+end

data/lib/listenable/railtie.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Listenable
+  class Railtie < Rails::Railtie
+    initializer "listenable.load" do
+      Rails.application.config.to_prepare do
+        # Load all listeners (supports nested paths)
+        Dir[Rails.root.join("app/listeners/**/*.rb")].each { |f| require_dependency f }
+
+        # Wire models + listeners
+        ObjectSpace.each_object(Class).select { |klass| klass < Listenable }.each do |listener_class|
+          model_class_name = listener_class.name.sub("Listener", "")
+          model_class = model_class_name.safe_constantize
+          next unless model_class
+
+          listener_class.pending_hooks.each do |hook|
+            action   = hook.sub("on_", "")
+            callback = Listenable::CALLBACK_MAP[action] or next
+            method   = "on_#{action}"
+            event    = "#{model_class_name.underscore}.#{action}"
+
+            # Avoid duplicate subscriptions on reload
+            ActiveSupport::Notifications.notifier.listeners_for(event).each do |subscriber|
+              ActiveSupport::Notifications.unsubscribe(subscriber)
+            end
+
+            # Inject ActiveRecord callback
+            model_class.send(callback) do
+              ActiveSupport::Notifications.instrument(event, record: self)
+            end
+
+            # Subscribe listener
+            next unless listener_class.respond_to?(method)
+
+            ActiveSupport::Notifications.subscribe(event) do |*args|
+              _name, _start, _finish, _id, payload = args
+              listener_class.public_send(method, payload[:record])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/listenable/version.rb

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

data/lib/listenable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+require "active_support/notifications"
+
+require_relative "listenable/version"
+require_relative "listenable/concern"
+require_relative "listenable/railtie" if defined?(Rails)
+
+module Listenable
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/listenable.rbs

@@ -0,0 +1,4 @@
+module Listenable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: listenable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Den Meralpis
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Listenable makes it easy to wire ActiveRecord models to listener classes.
+  Define <Model>Listener classes in app/listeners, declare listen :on_created, :on_updated,
+  etc., and Listenable automatically injects callbacks and subscribes to ActiveSupport::Notifications.
+email:
+- denmarkmeralpis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/listenable.rb
+- lib/listenable/concern.rb
+- lib/listenable/railtie.rb
+- lib/listenable/version.rb
+- sig/listenable.rbs
+homepage: https://github.com/denmarkmeralpis/listenable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/denmarkmeralpis/listenable
+  source_code_uri: https://github.com/denmarkmeralpis/listenable
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: A Rails DSL for model event listeners using ActiveSupport::Notifications.
+test_files: []