pubsub_on_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5aeb57501923d0faf35b735734647ab6880660059475126dc4aae2bce6f6d59
+  data.tar.gz: 7da45ebcbc7c928f93c4960c02bed54585dfe3bfa9c91906bba7070e8f8b45a5
+SHA512:
+  metadata.gz: 730b60a32e1f9873e783f9f029f60f1cf9ec105d55e001afba968dd80eee794f74f2f685fe944419780dc381d64a43157f6f51c660022d70766a1d9b7532fe94
+  data.tar.gz: 69c30741019142f5124e9e98f58723efad81fb74ec918a1ffd7a27822dedd66c74f5db888ac4c97f5cf0296ad84e19cc1ceae46ad1858730740048d666bad954

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    pubsub_on_rails (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pubsub_on_rails!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2019 Stevo <b.kosmowski@selleo.com>
+
+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/lib/pub_sub.rb

@@ -0,0 +1,2 @@
+module PubSub
+end

data/lib/pub_sub/domain.rb

@@ -0,0 +1,23 @@
+module PubSub
+  module Domain
+    def method_missing(event_or_method_name, *event_data)
+      if handler_name(event_or_method_name)
+        const_get(handler_name(event_or_method_name)).new(*event_data).call!
+      else
+        super
+      end
+    end
+
+    def handler_name(event_name)
+      return nil unless event_name.to_s.start_with?(/[a-z_]+__/)
+      "#{event_name.to_s.camelize}Handler"
+    end
+
+    def respond_to_missing?(event_or_method_name, include_private = false)
+      return super unless handler_name(event_or_method_name)
+      const_get(handler_name(event_or_method_name))
+    rescue NameError
+      super
+    end
+  end
+end

data/lib/pub_sub/domain_event.rb

@@ -0,0 +1,15 @@
+module PubSub
+  class DomainEvent < Dry::Struct
+    include Wisper::Publisher
+
+    def broadcast!
+      broadcast(event_name, attributes)
+    end
+
+    private
+
+    def event_name
+      self.class.name.underscore.sub('/', '__').chomp('_event')
+    end
+  end
+end

data/lib/pub_sub/domain_event_handler.rb

@@ -0,0 +1,27 @@
+module PubSub
+  class DomainEventHandler
+    def initialize(*args)
+      @event_data_hash = args.extract_options!
+    end
+
+    def call
+      raise NotImplementedError
+    end
+
+    def call!
+      call if process_event?
+    end
+
+    private
+
+    attr_reader :event_data_hash
+
+    def process_event?
+      true
+    end
+
+    def event_data
+      @event_data ||= OpenStruct.new(event_data_hash)
+    end
+  end
+end

data/lib/pub_sub/emit.rb

@@ -0,0 +1,16 @@
+require 'pub_sub/event_class_factory'
+require 'pub_sub/event_emission'
+
+module PubSub
+  module Emit
+    def emit(event_name, explicit_payload = {})
+      event_class = EventClassFactory.build(
+        event_name,
+        domain_name: self.class.name.deconstantize.demodulize,
+        abstract_event_class: explicit_payload.delete(:abstract_event_class)
+      )
+
+      EventEmission.new(event_class, explicit_payload, self).call
+    end
+  end
+end

data/lib/pub_sub/event_class_factory.rb

@@ -0,0 +1,59 @@
+module PubSub
+  class EventClassFactory
+    EventClassDoesNotExist = Class.new(StandardError)
+
+    def self.build(event_name, domain_name: nil, abstract_event_class: nil)
+      new(
+        event_name,
+        domain_name: domain_name,
+        abstract_event_class: abstract_event_class
+      ).build_event_class
+    end
+
+    def initialize(event_name, domain_name:, abstract_event_class:)
+      @event_name = event_name.to_s
+      @abstract_event_class = abstract_event_class
+      @domain_name = domain_name
+    end
+
+    def build_event_class
+      event_class = event_class_name.safe_constantize
+
+      return event_class unless event_class.nil?
+
+      if abstract_event_class.nil?
+        raise(EventClassDoesNotExist, event_class_name)
+      else
+        register_new_event_class
+      end
+    end
+
+    private
+
+    attr_reader :event_name, :abstract_event_class, :domain_name
+
+    def register_new_event_class
+      event_class_namespace.const_set(event_class_name.demodulize, Class.new(abstract_event_class))
+    end
+
+    def event_class_namespace
+      event_class_name.deconstantize.constantize
+    end
+
+    def event_name_includes_domain?
+      event_name.include?('__')
+    end
+
+    def event_name_with_domain
+      if event_name_includes_domain?
+        event_name.to_s.sub('__', '/')
+      else
+        "#{domain_name}/#{event_name}"
+      end
+    end
+
+    def event_class_name
+      @event_class_name ||= "#{event_name_with_domain}_event".classify
+    end
+  end
+end

data/lib/pub_sub/event_emission.rb

@@ -0,0 +1,44 @@
+require 'pub_sub/payload_attribute'
+
+module PubSub
+  class EventEmission
+    EventPayloadArgumentMissing = Class.new(StandardError)
+
+    def initialize(event_class, explicit_payload, context)
+      @event_class = event_class
+      @explicit_payload = explicit_payload
+      @context = context
+    end
+
+    def call
+      event_class.new(full_payload).broadcast!
+    end
+
+    private
+
+    attr_reader :event_class, :explicit_payload, :context
+
+    def event_payload_attribute_names
+      event_class.attribute_names
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def full_payload
+      event_payload_attribute_names.each_with_object({}) do |attribute_name, result|
+        result[attribute_name] = PayloadAttribute.new(attribute_name, explicit_payload, context).get
+      rescue PayloadAttribute::CannotEvaluate => cannot_evaluate_error
+        if event_class.schema[attribute_name.to_sym].default?
+          next
+        else
+          raise(
+            EventPayloadArgumentMissing,
+            "Event [#{event_class.name}] expects [#{attribute_name}] payload attribute to be" \
+              " either exposed as [#{cannot_evaluate_error.message}] method in emitting object" \
+              ' or provided as argument'
+          )
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/pub_sub/linter.rb

@@ -0,0 +1,39 @@
+class Linter
+  MissingSubscriptions = Class.new(StandardError)
+
+  def initialize(config)
+    @config = config
+  end
+
+  def lint!
+    raise MissingSubscriptions, error_message if missing_subscriptions.present?
+  end
+
+  private
+
+  def error_message
+    "The following subscriptions are missing: \n#{missing_subscriptions.join("\n")}"
+  end
+
+  def missing_subscriptions
+    (handlers_list - subscriptions_list)
+  end
+
+  attr_reader :config
+
+  def subscriptions_list
+    config.flat_map do |domain_name, subscriptions|
+      subscriptions.keys.map do |event_name|
+        "#{domain_name}/#{event_name.sub('__', '_')}"
+      end
+    end
+  end
+
+  def handlers_list
+    Dir[Rails.root.join('app/event_handlers/*/*.rb')].map do |file_path|
+      file_path.
+        sub("#{Rails.root}/app/event_handlers/", '').
+        sub('_handler.rb', '')
+    end
+  end
+end

data/lib/pub_sub/payload_attribute.rb

@@ -0,0 +1,31 @@
+module PubSub
+  class PayloadAttribute
+    CannotEvaluate = Class.new(StandardError)
+
+    def initialize(attribute_name, explicit_payload, context)
+      @attribute_name = attribute_name
+      @explicit_payload = explicit_payload
+      @context = context
+    end
+
+    def get
+      return explicit_payload.fetch(attribute_name) if explicit_payload.key?(attribute_name)
+
+      identifier? ? context.send(getter_name)&.id : context.send(getter_name)
+    rescue NoMethodError
+      raise CannotEvaluate, getter_name
+    end
+
+    private
+
+    attr_reader :attribute_name, :explicit_payload, :context
+
+    def identifier?
+      !context.respond_to?(attribute_name, true) && attribute_name.to_s.end_with?('_id')
+    end
+
+    def getter_name
+      identifier? ? attribute_name.to_s.chomp('_id') : attribute_name
+    end
+  end
+end

data/lib/pub_sub/subscriptions.rb

@@ -0,0 +1,50 @@
+require 'pub_sub/linter'
+
+module PubSub
+  mattr_accessor :subscriptions
+
+  class Subscriptions
+    include Singleton
+
+    cattr_accessor :subscriptions_path
+    self.subscriptions_path = 'config/subscriptions.yml'
+
+    def self.load!
+      PubSub.subscriptions = Subscriptions.instance
+      PubSub.subscriptions.register(:all)
+    end
+
+    def self.lint!
+      instance.lint!
+    end
+
+    def lint!
+      Linter.new(config).lint!
+    end
+
+    def initialize
+      @config = YAML.load_file(self.class.subscriptions_path)
+    end
+
+    def register(scope = :all)
+      (scope == :all ? config : config.slice(scope.to_s)).each do |domain_name, subscriptions|
+        subscriptions.each do |event_name, subscription_type|
+          options = {}
+          options[:on] = event_name unless event_name == 'all_events'
+          options[:async] = true if subscription_type == 'async'
+          options[:broadcaster] = :run_once if subscription_type == 'run_once'
+
+          Wisper.subscribe("::#{domain_name.camelize}".constantize, options)
+        end
+      end
+    end
+
+    def clear!
+      Wisper.clear
+    end
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/pub_sub/testing.rb

@@ -0,0 +1,3 @@
+require 'wisper/rspec/matchers'
+require 'pub_sub/testing/event_data_helper'
+require 'pub_sub/testing/subscription_helpers'

data/lib/pub_sub/testing/event_data_helper.rb

@@ -0,0 +1,12 @@
+module PubSub
+  module Testing
+    module EventDataHelper
+      def event_data_for(event_name, **payload)
+        EventClassFactory.
+          build(event_name, abstract_event_class: payload.delete(:abstract_event_class)).
+          new(payload).
+          attributes
+      end
+    end
+  end
+end

data/lib/pub_sub/testing/subscription_helpers.rb

@@ -0,0 +1,24 @@
+module PubSub
+  module Testing
+    module SubscriptionsHelper
+      def with_subscription_to(*domains)
+        domains.each do |domain|
+          PubSub.subscriptions.register(domain)
+        end
+        yield
+        clear_wisper_subscriptions!
+      end
+
+      def subscribe_logger!
+        PubSub.subscriptions.register(:logging)
+      end
+      module_function :subscribe_logger!
+
+      def clear_wisper_subscriptions!
+        PubSub.subscriptions.clear!
+        subscribe_logger!
+      end
+      module_function :clear_wisper_subscriptions!
+    end
+  end
+end

data/lib/pub_sub/version.rb

@@ -0,0 +1,3 @@
+module PubSub
+  VERSION = '0.0.1'
+end

data/lib/pubsub_on_rails.rb

@@ -0,0 +1,9 @@
+require 'wisper'
+require 'wisper/sidekiq'
+
+require 'pub_sub'
+require 'pub_sub/emit'
+require 'pub_sub/subscriptions'
+require 'pub_sub/domain'
+require 'pub_sub/domain_event'
+require 'pub_sub/domain_event_handler'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pubsub_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stevo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: wisper-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wisper-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opinionated publish-subscribe pattern for ruby and rails
+email:
+- b.kosmowski@selleo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- lib/pub_sub.rb
+- lib/pub_sub/domain.rb
+- lib/pub_sub/domain_event.rb
+- lib/pub_sub/domain_event_handler.rb
+- lib/pub_sub/emit.rb
+- lib/pub_sub/event_class_factory.rb
+- lib/pub_sub/event_emission.rb
+- lib/pub_sub/linter.rb
+- lib/pub_sub/payload_attribute.rb
+- lib/pub_sub/subscriptions.rb
+- lib/pub_sub/testing.rb
+- lib/pub_sub/testing/event_data_helper.rb
+- lib/pub_sub/testing/subscription_helpers.rb
+- lib/pub_sub/version.rb
+- lib/pubsub_on_rails.rb
+homepage: https://github.com/Selleo/pubsub_on_rails
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Opinionated publish-subscribe pattern for ruby and rails
+test_files: []