omnes 0.1.0 → 0.2.2

data/lib/omnes/event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dry/configurable"
+require "omnes/configurable"
 
 module Omnes
   # Event mixin for custom classes
@@ -27,7 +27,7 @@ module Omnes
   # bus.publish(MyEvent.new(1))
   # ```
   module Event
-    extend Dry::Configurable
+    extend Configurable
 
     # Generates the event name for an event instance
     #

data/lib/omnes/publication.rb

@@ -19,25 +19,16 @@ module Omnes
     # @return [Array<Omnes::Execution>]
     attr_reader :executions
 
-    # Location for the event caller
+    # Publication context, shared by all triggered executions
     #
-    # It's usually set by {Omnes::Bus#publish}, and it points to the caller of
-    # that method.
-    #
-    # @return [Thread::Backtrace::Location]
-    attr_reader :caller_location
-
-    # Time of the event publication
-    #
-    # @return [Time]
-    attr_reader :time
+    # @return [Omnes::PublicationContext]
+    attr_reader :context
 
     # @api private
-    def initialize(event:, executions:, caller_location:, time:)
+    def initialize(event:, executions:, context:)
       @event = event
       @executions = executions
-      @caller_location = caller_location
-      @time = time
+      @context = context
     end
   end
 end

data/lib/omnes/publication_context.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Omnes
+  # Context for an event publication
+  #
+  # An instance of this class is shared between all the executions that are
+  # triggered by the publication of a given event. It's provided to the
+  # subscriptions as their second argument when they take it.
+  #
+  # This class is useful mainly for debugging and logging purposes.
+  class PublicationContext
+    # Location for the event publisher
+    #
+    # It's set by {Omnes::Bus#publish}, and it points to the caller of that
+    # method.
+    #
+    # @return [Thread::Backtrace::Location]
+    attr_reader :caller_location
+
+    # Time of the event publication
+    #
+    # @return [Time]
+    attr_reader :time
+
+    # @api private
+    def initialize(caller_location:, time:)
+      @caller_location = caller_location
+      @time = time
+    end
+
+    # Serialized version of a publication context
+    #
+    # @return Hash<String, String>
+    def serialized
+      {
+        "caller_location" => caller_location.to_s,
+        "time" => time.to_s
+      }
+    end
+  end
+end

data/lib/omnes/subscriber/adapter/active_job.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dry/configurable"
+require "omnes/configurable"
 
 module Omnes
   module Subscriber
@@ -42,7 +42,7 @@ module Omnes
       # Omnes.config.subscriber.adapter.active_job.serializer = :serialized_payload.to_proc
       # ```
       module ActiveJob
-        extend Dry::Configurable
+        extend Configurable
 
         setting :serializer, default: :payload.to_proc
 
@@ -52,8 +52,8 @@ module Omnes
         end
 
         # @api private
-        def self.call(instance, event)
-          self.[].(instance, event)
+        def self.call(instance, event, publication_context)
+          self.[].(instance, event, publication_context)
         end
 
         # @api private
@@ -64,8 +64,12 @@ module Omnes
             @serializer = serializer
           end
 
-          def call(instance, event)
-            instance.class.perform_later(serializer.(event))
+          def call(instance, event, publication_context)
+            if Subscription.takes_publication_context?(instance.method(:perform))
+              instance.class.perform_later(serializer.(event), publication_context.serialized)
+            else
+              instance.class.perform_later(serializer.(event))
+            end
           end
         end
       end

data/lib/omnes/subscriber/adapter/method.rb

@@ -7,7 +7,7 @@ module Omnes
     module Adapter
       # Builds a callback from a method of the instance
       #
-      # You can use instance of this class as the adapter:
+      # You can use an instance of this class as the adapter:
       #
       # ```ruby
       # handle :foo, with: Adapter::Method.new(:foo)
@@ -29,7 +29,7 @@ module Omnes
         def call(instance)
           check_method(instance)
 
-          ->(event) { instance.method(name).(event) }
+          instance.method(name)
         end
 
         private

data/lib/omnes/subscriber/adapter/sidekiq.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dry/configurable"
+require "omnes/configurable"
 
 module Omnes
   module Subscriber
@@ -49,7 +49,7 @@ module Omnes
       # @example
       #   handle :my_event, with: Adapter::Sidekiq.in(60)
       module Sidekiq
-        extend Dry::Configurable
+        extend Configurable
 
         setting :serializer, default: :payload.to_proc
 
@@ -59,8 +59,8 @@ module Omnes
         end
 
         # @api private
-        def self.call(instance, event)
-          self.[].(instance, event)
+        def self.call(instance, event, publication_context)
+          self.[].(instance, event, publication_context)
         end
 
         # @param seconds [Integer]
@@ -76,15 +76,29 @@ module Omnes
             @serializer = serializer
           end
 
-          def call(instance, event)
-            instance.class.perform_async(serializer.(event))
+          def call(instance, event, publication_context)
+            if takes_publication_context?(instance)
+              instance.class.perform_async(serializer.(event), publication_context.serialized)
+            else
+              instance.class.perform_async(serializer.(event))
+            end
           end
 
           def in(seconds)
-            lambda do |instance, event|
-              instance.class.perform_in(seconds, serializer.(event))
+            lambda do |instance, event, publication_context|
+              if takes_publication_context?(instance)
+                instance.class.perform_in(seconds, serializer.(event), publication_context.serialized)
+              else
+                instance.class.perform_in(seconds, serializer.(event))
+              end
             end
           end
+
+          private
+
+          def takes_publication_context?(instance)
+            Subscription.takes_publication_context?(instance.method(:perform))
+          end
         end
       end
     end

data/lib/omnes/subscriber/adapter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "omnes/configurable"
 require "omnes/subscriber/adapter/active_job"
 require "omnes/subscriber/adapter/method"
 require "omnes/subscriber/adapter/sidekiq"
@@ -14,6 +15,11 @@ module Omnes
     # Alternatively, they can be curried and only take the instance as an
     # argument, returning a one-argument callable taking the event.
     module Adapter
+      extend Configurable
+
+      nest_config Sidekiq
+      nest_config ActiveJob
+
       # @api private
       # TODO: Simplify when when we can take callables and Proc in a polymorphic
       # way: https://bugs.ruby-lang.org/issues/18644

data/lib/omnes/subscriber/state.rb

@@ -10,6 +10,11 @@ module Omnes
     class State
       attr_reader :subscription_definitions, :calling_cache, :autodiscover_strategy
 
+      # @api private
+      def self.IdType(value)
+        value.respond_to?(:call) ? value : ->(_instance) { value }
+      end
+
       def initialize(autodiscover_strategy:, subscription_definitions: [], calling_cache: [])
         @subscription_definitions = subscription_definitions
         @calling_cache = calling_cache
@@ -19,9 +24,9 @@ module Omnes
       def call(bus, instance)
         raise MultipleSubscriberSubscriptionAttemptError if already_called?(bus, instance)
 
-        autodiscover_subscription_definitions(bus, instance) unless autodiscover_strategy.nil?
+        all_subscription_definitions = subscription_definitions + autodiscovered_subscription_definitions(bus, instance)
 
-        definitions = subscription_definitions.map { |defn| defn.(bus) }
+        definitions = all_subscription_definitions.map { |defn| defn.(bus, instance) }
 
         subscribe_definitions(definitions, bus, instance).tap do
           mark_as_called(bus, instance)
@@ -42,26 +47,38 @@ module Omnes
         @calling_cache << [bus, instance]
       end
 
-      def autodiscover_subscription_definitions(bus, instance)
-        bus.registry.event_names.each do |event_name|
-          method_name = autodiscover_strategy.(event_name)
-          next unless instance.respond_to?(method_name, true)
+      def autodiscovered_subscription_definitions(bus, instance)
+        return [] unless autodiscover_strategy
 
-          add_subscription_definition do |_bus|
+        bus.registry.event_names.reduce([]) do |defs, event_name|
+          method_name = autodiscover_strategy.(event_name)
+          if instance.respond_to?(method_name, true)
             [
-              Subscription::SINGLE_EVENT_MATCHER.curry[event_name],
-              Adapter.Type(Adapter::Method.new(method_name))
+              *defs,
+              autodiscovered_subscription_definition(event_name, method_name)
             ]
+          else
+            defs
           end
         end
       end
 
+      def autodiscovered_subscription_definition(event_name, method_name)
+        lambda do |_bus, _instance|
+          [
+            Subscription::SINGLE_EVENT_MATCHER.curry[event_name],
+            Adapter.Type(Adapter::Method.new(method_name)),
+            Subscription.random_id
+          ]
+        end
+      end
+
       def subscribe_definitions(definitions, bus, instance)
-        matcher_with_callbacks = definitions.map do |(matcher, adapter)|
-          [matcher, adapter.curry[instance]]
+        matcher_with_callbacks = definitions.map do |(matcher, adapter, id)|
+          [matcher, adapter.curry[instance], id]
         end
 
-        matcher_with_callbacks.map { |matcher, callback| bus.subscribe_with_matcher(matcher, callback) }
+        matcher_with_callbacks.map { |matcher, callback, id| bus.subscribe_with_matcher(matcher, callback, id: id) }
       end
     end
   end

data/lib/omnes/subscriber.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "dry/configurable"
 require "omnes/subscriber/adapter"
 require "omnes/subscriber/state"
 require "omnes/subscription"
@@ -122,14 +121,14 @@ module Omnes
   # bus. However, you can subscribe distinct instances to the same bus or the
   # same instance to different buses.
   module Subscriber
-    extend Dry::Configurable
+    extend Configurable
 
     # @api private
     ON_PREFIX_STRATEGY = ->(event_name) { :"on_#{event_name}" }
 
     setting :autodiscover, default: false
-
     setting :autodiscover_strategy, default: ON_PREFIX_STRATEGY
+    nest_config Adapter
 
     # Includes with options
     #
@@ -193,11 +192,12 @@ module Omnes
       #
       # @param event_name [Symbol]
       # @param with [Symbol, #call] Public method in the class or an adapter
-      def handle(event_name, with:)
+      # @param id [Symbol] Unique identifier for the subscription
+      def handle(event_name, with:, id: Subscription.random_id)
         @_mutex.synchronize do
-          @_state.add_subscription_definition do |bus|
+          @_state.add_subscription_definition do |bus, instance|
             bus.registry.check_event_name(event_name)
-            [Subscription::SINGLE_EVENT_MATCHER.curry[event_name], Adapter.Type(with)]
+            [Subscription::SINGLE_EVENT_MATCHER.curry[event_name], Adapter.Type(with), State.IdType(id).(instance)]
           end
         end
       end
@@ -205,10 +205,11 @@ module Omnes
       # Handles all events
       #
       # @param with [Symbol, #call] Public method in the class or an adapter
-      def handle_all(with:)
+      # @param id [Symbol] Unique identifier for the subscription
+      def handle_all(with:, id: Subscription.random_id)
         @_mutex.synchronize do
-          @_state.add_subscription_definition do |_bus|
-            [Subscription::ALL_EVENTS_MATCHER, Adapter.Type(with)]
+          @_state.add_subscription_definition do |_bus, instance|
+            [Subscription::ALL_EVENTS_MATCHER, Adapter.Type(with), State.IdType(id).(instance)]
           end
         end
       end
@@ -217,10 +218,11 @@ module Omnes
       #
       # @param matcher [#call]
       # @param with [Symbol, #call] Public method in the class or an adapter
-      def handle_with_matcher(matcher, with:)
+      # @param id [Symbol] Unique identifier for the subscription
+      def handle_with_matcher(matcher, with:, id: Subscription.random_id)
         @_mutex.synchronize do
-          @_state.add_subscription_definition do |_bus|
-            [matcher, Adapter.Type(with)]
+          @_state.add_subscription_definition do |_bus, instance|
+            [matcher, Adapter.Type(with), State.IdType(id).(instance)]
           end
         end
       end

data/lib/omnes/subscription.rb

@@ -2,6 +2,7 @@
 
 require "benchmark"
 require "omnes/execution"
+require "securerandom"
 
 module Omnes
   # Subscription to an event
@@ -24,19 +25,39 @@ module Omnes
     ALL_EVENTS_MATCHER = ->(_candidate) { true }
 
     # @api private
-    attr_reader :matcher, :callback
+    def self.random_id
+      SecureRandom.uuid.to_sym
+    end
+
+    # @api private
+    def self.takes_publication_context?(callable)
+      callable.parameters.count == 2
+    end
 
     # @api private
-    def initialize(matcher:, callback:)
+    attr_reader :matcher, :callback, :id
+
+    # @api private
+    def initialize(matcher:, callback:, id:)
+      raise Omnes::InvalidSubscriptionNameError.new(id: id) unless id.is_a?(Symbol)
+
       @matcher = matcher
       @callback = callback
+      @id = id
     end
 
     # @api private
-    def call(event)
+    def call(event, publication_context)
       result = nil
       benchmark = Benchmark.measure do
-        result = @callback.(event)
+        # work around Ruby not being able to tell remaining arity for a curried
+        # function (or uncurrying), because we want to be able to create subscriber
+        # adapters partially applying the subscriber instance
+        result = begin
+          @callback.(event, publication_context)
+        rescue ArgumentError
+          @callback.(event)
+        end
       end
 
       Execution.new(subscription: self, result: result, benchmark: benchmark)

data/lib/omnes/version.rb

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

data/lib/omnes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "omnes/bus"
+require "omnes/configurable"
 require "omnes/event"
 require "omnes/subscriber"
 require "omnes/version"
@@ -33,50 +34,22 @@ require "omnes/version"
 # Refer to {Omnes::Subscriber} for how to provide event handlers through methods
 # defined in a class.
 module Omnes
-  # Shortcut to access the configuration for different Omnes components
-  #
-  # TODO: Make automation for it
-  #
-  # @return [Omnes::Config]
-  def self.config
-    Config
-  end
-
-  # Wrapper for the configuration of Omnes components
-  module Config
-    # {Omnes::Subscriber} configuration
-    #
-    # @return [Dry::Configurable::Config]
-    def self.subscriber
-      Omnes::Subscriber.config.tap do |klass|
-        klass.define_singleton_method(:adapter) do
-          Module.new do
-            def self.sidekiq
-              Omnes::Subscriber::Adapter::Sidekiq.config
-            end
+  extend Configurable
 
-            def self.active_job
-              Omnes::Subscriber::Adapter::ActiveJob.config
-            end
-          end
-        end
-      end
-    end
-
-    # {Omnes::Event} configuration
-    #
-    # @return [Dry::Configurable::Config]
-    def self.event
-      Omnes::Event.config
-    end
-  end
+  nest_config Subscriber
+  nest_config Event
 
   # @api private
   def self.included(klass)
     klass.define_method(:omnes_bus) { @omnes_bus ||= Bus.new(cal_loc_start: 2) }
     Bus.instance_methods(false).each do |method|
       klass.define_method(method) do |*args, **kwargs, &block|
-        omnes_bus.send(method, *args, **kwargs, &block)
+        # TODO: Forward with ... once we deprecate ruby 2.5 & 2.6
+        if kwargs.any?
+          omnes_bus.send(method, *args, **kwargs, &block)
+        else
+          omnes_bus.send(method, *args, &block)
+        end
       end
     end
   end

data/omnes.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   MSG
   spec.homepage = "https://github.com/nebulab/omnes"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -36,9 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dry-configurable", "~> 0.14"
-
-  spec.add_development_dependency "activejob", "~> 7.0"
+  spec.add_development_dependency "activejob"
   spec.add_development_dependency "redcarpet", "~> 3.5"
   spec.add_development_dependency "sidekiq", "~> 6.4"
   spec.add_development_dependency "yard", "~> 0.9"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omnes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Marc Busqué
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +87,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -109,10 +94,12 @@ files:
 - bin/setup
 - lib/omnes.rb
 - lib/omnes/bus.rb
+- lib/omnes/configurable.rb
 - lib/omnes/errors.rb
 - lib/omnes/event.rb
 - lib/omnes/execution.rb
 - lib/omnes/publication.rb
+- lib/omnes/publication_context.rb
 - lib/omnes/registry.rb
 - lib/omnes/subscriber.rb
 - lib/omnes/subscriber/adapter.rb
@@ -135,7 +122,7 @@ metadata:
   source_code_uri: https://github.com/nebulab/omnes
   changelog_uri: https://github.com/nebulab/omnes/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -143,15 +130,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Pub/Sub for ruby
 test_files: []