active_pubsub_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bdad702dc5f5c7b7f559897fd91bcbba8172737f0355d3ff4e07d4a864cc7ce
+  data.tar.gz: 79a65c0ca27809760e87d981e08d1a37985f21e33e7b4d3846f371e0e304b761
+SHA512:
+  metadata.gz: bfc62a703a9c391bcd096fb6fc9cca2accb76ad64354612b233400bf0e96f946c59b12c93c5f91b7a96b1f28119c63421d333ddd2d5f03bb82c4099429cce242
+  data.tar.gz: 209419fad924d1e5128319c12c46222e0f7a59cffcc1ff0ada18c83dcbfa8b8c60f35c162d4f55666dce422b8dc754d8f710b1093983cbe6bd2fca381685bee4

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 160
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_pubsub_rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    active_pubsub_rails (0.1.0)
+      activesupport (>= 5.2.x)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  active_pubsub_rails!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Gaurav Tiwari
+
+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,75 @@
+# ActivePubsub
+
+Simple pub-sub message bus for Rails built on top of ActiveSupportNotifications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_pubsub_rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_pubsub_rails
+
+## Usage
+
+Create a subscriber that listens to events:
+
+```rb
+# Create your subscriber under app/subscribers
+# app/subscribers/account_subscriber.rb
+
+module AccountSubscriber
+  include ActivePubsubRails::Subscriber
+
+  event_action :account_opened
+  event_action :account_verified
+  event_action :account_deleted, event_name: :account_removed
+
+  def account_opened(event)
+    # Do something here
+  end
+
+  def account_verified(event)
+    # Do something here
+  end
+
+  def account_deleted(event)
+    # Do something here
+  end
+end
+```
+
+And, publish events like so
+
+```rb
+ActivePubsubRails.fire 'account_opened', account_id: 1
+# => <ActiveSupport::Notifications::Event:0x00007fec80755d90 @name="account_opened", @payload={:account_id=>1}, @time=2021-04-30 13:44:23.997487 +0100, @transaction_id="ff2eeaa4cfa39993eef1", @end=2021-04-30 13:44:23.997494 +0100, @children=[], @cpu_time_start=0, @cpu_time_finish=0, @allocation_count_start=0, @allocation_count_finish=0>
+
+ActivePubsubRails.fire 'account_verified', account_id: 1, verfied: true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gauravtiwari/active_pubsub_rails.
+
+```
+
+```
+
+```
+
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/active_pubsub_rails.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_pubsub_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_pubsub_rails"
+  spec.version       = ActivePubsubRails::VERSION
+  spec.authors       = ["Gaurav Tiwari"]
+  spec.email         = ["gaurav@gauravtiwari.co.uk"]
+
+  spec.summary       = "Simple pub-sub message bus for Rails built on top of ActiveSupportNotifications"
+  spec.description   = "Simple pub-sub message bus for Rails built on top of ActiveSupportNotifications"
+  spec.homepage      = "https://github.com/gauravtiwari/active_pubsub_rails"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.1")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gauravtiwari/active_pubsub_rails"
+  spec.metadata["changelog_uri"] = "https://github.com/gauravtiwari/active_pubsub_rails"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.2.x"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "active_pubsub_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_pubsub_rails.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "active_pubsub_rails/version"
+require_relative "active_pubsub_rails/engine"
+
+module ActivePubsubRails
+  extend self
+  delegate :activate_autoloadable_subscribers, :activate_all_subscribers, :deactivate_all_subscribers, to: :subscriber_registry
+
+  def fire(event_name, opts = {})
+    adapter.fire normalize_name(event_name), opts do
+      yield opts if block_given?
+    end
+  end
+
+  def subscribe(event_name, &block)
+    name = normalize_name(event_name)
+    listeners_names << name
+    adapter.subscribe(name, &block)
+  end
+
+  def unsubscribe(subscriber)
+    name_or_subscriber = subscriber.is_a?(String) ? normalize_name(subscriber) : subscriber
+    adapter.unsubscribe(name_or_subscriber)
+  end
+
+  def listeners
+    adapter.listeners_for(listeners_names)
+  end
+
+  def adapter
+    @adapter ||= ActivePubsubRails::Adapters::ActiveSupportNotifications
+  end
+
+  def subscriber_registry
+    @subscriber_registry ||= ActivePubsubRails::SubscriberRegistry.new
+  end
+
+  private
+
+  def normalize_name(name)
+    adapter.normalize_name(name)
+  end
+
+  def listeners_names
+    @listeners_names ||= Set.new
+  end
+end

data/lib/active_pubsub_rails/adapters/active_support_notifications.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActivePubsubRails
+  module Adapters
+    module ActiveSupportNotifications
+      class InvalidEventNameType < StandardError; end
+
+      module_function
+
+      def fire(event_name, opts)
+        ActiveSupport::Notifications.instrument event_name, opts do
+          yield opts if block_given?
+        end
+      end
+
+      def subscribe(event_name)
+        ActiveSupport::Notifications.subscribe event_name do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          yield event
+        end
+      end
+
+      def unsubscribe(subscriber_or_name)
+        ActiveSupport::Notifications.unsubscribe(subscriber_or_name)
+      end
+
+      def listeners_for(names)
+        names.each_with_object({}) do |name, memo|
+          listeners = ActiveSupport::Notifications.notifier.listeners_for(name)
+          memo[name] = listeners if listeners.present?
+        end
+      end
+
+      def normalize_name(event_name)
+        case event_name
+        when Regexp, String, Symbol
+          event_name
+        else
+          raise InvalidEventNameType, "Invalid event name type: #{event_name.class}"
+        end
+      end
+    end
+  end
+end

data/lib/active_pubsub_rails/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActivePubsubRails
+  class Configuration
+    def subscriber_registry
+      @subscriber_registry ||= ActivePubsubRails::SubscriberRegistry.new
+    end
+
+    attr_writer :adapter, :autoload_subscribers
+
+    def autoload_subscribers
+      @autoload_subscribers.nil? ? true : !!@autoload_subscribers
+    end
+
+    def adapter
+      @adapter ||= ActivePubsubRails::Adapters::ActiveSupportNotifications
+    end
+  end
+end

data/lib/active_pubsub_rails/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "adapters/active_support_notifications"
+require_relative "subscriber_registry"
+require_relative "configuration"
+require_relative "subscriber"
+
+module ActivePubsubRails
+  class Engine < ::Rails::Engine
+    initializer "spree.core.initialize_subscribers" do |app|
+      app.reloader.to_prepare do
+        ActivePubsubRails.activate_autoloadable_subscribers
+      end
+
+      app.reloader.before_class_unload do
+        ActivePubsubRails.deactivate_all_subscribers
+      end
+    end
+  end
+end

data/lib/active_pubsub_rails/subscriber.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActivePubsubRails
+  module Subscriber
+    def self.included(base)
+      base.extend base
+
+      base.mattr_accessor :event_actions
+      base.event_actions = {}
+
+      ActivePubsubRails.subscriber_registry.register(base)
+    end
+
+    def event_action(method_name, event_name: nil)
+      event_actions[method_name] = (event_name || method_name).to_s
+    end
+
+    def activate
+      ActivePubsubRails.subscriber_registry.activate_subscriber(self)
+    end
+
+    def deactivate(event_action_name = nil)
+      ActivePubsubRails.subscriber_registry.deactivate_subscriber(self, event_action_name)
+    end
+  end
+end

data/lib/active_pubsub_rails/subscriber_registry.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ActivePubsubRails
+  class SubscriberRegistry
+    def initialize
+      @registry = {}
+      @semaphore = Mutex.new
+    end
+
+    def register(subscriber)
+      registry[subscriber.name] ||= {}
+    end
+
+    def activate_autoloadable_subscribers
+      require_subscriber_files
+      activate_all_subscribers
+    end
+
+    def activate_all_subscribers
+      registry.each_key { |subscriber_name| activate_subscriber(subscriber_name.constantize) }
+    end
+
+    def deactivate_all_subscribers
+      registry.each_key { |subscriber_name| deactivate_subscriber(subscriber_name.constantize) }
+    end
+
+    def activate_subscriber(subscriber)
+      return unless registry[subscriber.name]
+
+      subscriber.event_actions.each do |event_action, event_name|
+        @semaphore.synchronize do
+          unsafe_deactivate_subscriber(subscriber, event_action)
+          subscription = ActivePubsubRails.subscribe(event_name) { |event| subscriber.send(event_action, event) }
+          registry[subscriber.name][event_action] = subscription
+        end
+      end
+    end
+
+    def deactivate_subscriber(subscriber, event_action_name = nil)
+      @semaphore.synchronize do
+        unsafe_deactivate_subscriber(subscriber, event_action_name)
+      end
+    end
+
+    private
+
+    attr_reader :registry
+
+    def require_subscriber_files
+      pattern = "app/subscribers/**/*_subscriber.rb"
+      Rails.root.glob(pattern) { |c| require_dependency(c.to_s) }
+    end
+
+    def unsafe_deactivate_subscriber(subscriber, event_action_name = nil)
+      to_unsubscribe = Array.wrap(event_action_name || subscriber.event_actions.keys)
+
+      to_unsubscribe.each do |event_action|
+        next unless (subscription = registry.dig(subscriber.name, event_action))
+
+        ActivePubsubRails.unsubscribe(subscription)
+
+        registry[subscriber.name].delete(event_action)
+      end
+    end
+  end
+end

data/lib/active_pubsub_rails/version.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: active_pubsub_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gaurav Tiwari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.x
+description: Simple pub-sub message bus for Rails built on top of ActiveSupportNotifications
+email:
+- gaurav@gauravtiwari.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active_pubsub_rails.gemspec
+- bin/console
+- bin/setup
+- lib/active_pubsub_rails.rb
+- lib/active_pubsub_rails/adapters/active_support_notifications.rb
+- lib/active_pubsub_rails/configuration.rb
+- lib/active_pubsub_rails/engine.rb
+- lib/active_pubsub_rails/subscriber.rb
+- lib/active_pubsub_rails/subscriber_registry.rb
+- lib/active_pubsub_rails/version.rb
+homepage: https://github.com/gauravtiwari/active_pubsub_rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/gauravtiwari/active_pubsub_rails
+  source_code_uri: https://github.com/gauravtiwari/active_pubsub_rails
+  changelog_uri: https://github.com/gauravtiwari/active_pubsub_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Simple pub-sub message bus for Rails built on top of ActiveSupportNotifications
+test_files: []