dry-events 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df0a07c20aa79e2b47d1f8eda583936b6109e09e5307826593e1e8f792c7675
-  data.tar.gz: c99dfee0bf7614b62fc70d8ea809d419fcf8fb01400149f83610fd9a9e586019
+  metadata.gz: 1423fe7cb9ad77d3af4fea999666f1ff275204e5dad84e4ba8f83ea230b0e2d0
+  data.tar.gz: 30a0f8b923a890af19b9937fbf502b51c8a568b33444bba0f3d09995045a016d
 SHA512:
-  metadata.gz: 3060f0fe13e7cb9199e81e82c82be67bca90a547a0750b094f0afcdcb193aba0866c3c3a7af2e81923dec194bc1828d9fc4ae7fa099c0c87952cba68f77afff2
-  data.tar.gz: 33845156cc553098260f562001b3fa0d2aa711c95ee8d056c0f1362eccda69e8b8954040bf0b542b47826a81b813d1a338ced05712e10e36a8770fad4eef867f
+  metadata.gz: d985af03635dea492d89ae37dd5935aa4576d92ca2201bbf4096d12a396df7857fd0007bf7a28275f7d5a985560ef26532ca977bf1ea05e04e815d88db02bd8f
+  data.tar.gz: 8de1e80e33a2a5429fddce3a675ed9c72ae5224bc919d6fcab5300f4f8d7b11617d18330b0af5451884e76accbc755b37d4282155c0aa52dbddd380e1cc723af

data/.travis.yml

@@ -2,21 +2,23 @@ language: ruby
 cache: bundler
 bundler_args: --without benchmarks console tools
 script: "bundle exec rake ci"
-before_install: gem update --system
 after_success:
   - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.5.0
-  - 2.4.3
-  - 2.3.6
-  - jruby-9.1.9.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2.7.0
+  - truffleruby
+matrix:
+  allow_failures:
+    - rvm: truffleruby
+    - rvm: jruby-9.2.7.0
 env:
   global:
     - COVERAGE='true'
 notifications:
   webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/19098b4253a72c9796db
     on_success: change
     on_failure: always
     on_start: false

data/CHANGELOG.md

@@ -1,3 +1,41 @@
-# v0.1.0 to-be-released
+# v0.2.0 2019-07-24
+
+## Fixed
+
+* Trying to subscribe to a non-existant event raises an exception (issue #3) (@GustavoCaso + @mensfeld)
+
+[Compare v0.1.1...v0.2.0](https://github.com/dry-rb/dry-events/compare/v0.1.1...v0.2.0)
+
+# v0.1.1 2019-03-22
+
+## Added
+
+- Subscription filters can be more complex: nested hash inclusion, array inclusion, and proc checks were added (flash-gordon)
+  ```ruby
+  # nested hash check
+  subscribe(:event, logger: { level: :info })
+  # pass
+  trigger(:event, logger: { level: :info, output: :stdin })
+  # filtered out
+  trigger(:event, logger: { level: :debug })
+  trigger(:event, something: :else)
+
+  # array inclusion
+  subscribe(:event, logger: { level: %i(info warn error) })
+  # pass
+  trigger(:event, logger: { level: :info })
+  trigger(:event, logger: { level: :error })
+  trigger(:event, logger: { level: :info, output: :stdin })
+  # filtered out
+  trigger(:event, logger: { level: :debug })
+
+  # proc checks
+  # here acts as array inclusion example
+  subscribe(:event, logger: { level: -> level { %i(info warn error).include?(level) })
+  ```
+
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-events/compare/v0.1.0...v0.1.1)
+
+# v0.1.0 2018-01-02
 
 First public release

data/Gemfile

@@ -9,5 +9,6 @@ group :test do
 end
 
 group :tools do
-  gem 'byebug', platform: :mri
+  gem 'pry'
+  gem 'pry-byebug', platform: :mri
 end

data/README.md

@@ -1,26 +1,24 @@
 [gem]: https://rubygems.org/gems/dry-events
-[travis]: https://travis-ci.org/dry-rb/dry-events
-[gemnasium]: https://gemnasium.com/dry-rb/dry-events
+[travis]: https://travis-ci.com/dry-rb/dry-events
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-events
-[coveralls]: https://coveralls.io/r/dry-rb/dry-events
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-events
 
-# dry-events [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-events [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-events.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-events.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/dry-rb/dry-events.svg)][gemnasium]
+[![Build Status](https://travis-ci.com/dry-rb/dry-events.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/dry-rb/dry-events/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/dry-rb/dry-events/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-events.svg?branch=master)][inchpages]
 
 Standalone pub/sub system.
 
-## Synopsis
+## Links
 
-``` ruby
-```
+* [User docs](http://dry-rb.org/gems/dry-events)
+* [API docs](http://rubydoc.info/gems/dry-events)
 
-## License
+## LICENSE
 
 See `LICENSE` file.

data/lib/dry/events/bus.rb

@@ -18,7 +18,6 @@ module Dry
 
       # Initialize a new event bus
       #
-      # @param [Symbol] id The bus identifier
       # @param [Hash] events A hash with events
       # @param [Hash] listeners A hash with listeners
       #
@@ -29,11 +28,11 @@ module Dry
       end
 
       # @api private
-      def process(event_id, payload, &block)
-        listeners[event_id].each do |(listener, query)|
+      def process(event_id, payload)
+        listeners[event_id].each do |listener, filter|
           event = events[event_id].payload(payload)
 
-          if event.trigger?(query)
+          if filter.(payload)
             yield(event, listener)
           end
         end
@@ -47,12 +46,12 @@ module Dry
       end
 
       # @api private
-      def attach(listener, query)
+      def attach(listener, filter)
         events.each do |id, event|
           meth = event.listener_method
 
           if listener.respond_to?(meth)
-            listeners[id] << [listener.method(meth), query]
+            listeners[id] << [listener.method(meth), filter]
           end
         end
       end
@@ -68,14 +67,27 @@ module Dry
       end
 
       # @api private
-      def subscribe(event_id, query, &block)
-        listeners[event_id] << [block, query]
+      def subscribe(event_id, filter, &block)
+        listeners[event_id] << [block, filter]
         self
       end
 
       # @api private
       def subscribed?(listener)
-        listeners.values.any? { |value| value.any? { |(block, _)| block.equal?(listener) } }
+        listeners.values.any? { |value| value.any? { |block, _| block.equal?(listener) } }
+      end
+
+      # @api private
+      def can_handle?(object_or_event_id)
+        case object_or_event_id
+        when String, Symbol
+          events.key?(object_or_event_id)
+        else
+          events
+            .values
+            .map(&:listener_method)
+            .any?(&object_or_event_id.method(:respond_to?))
+        end
       end
     end
   end

data/lib/dry/events/event.rb

@@ -9,22 +9,36 @@ module Dry
     class Event
       include Dry::Equalizer(:id, :payload)
 
+      InvalidEventNameError = Class.new(StandardError) do
+        # @api private
+        def initialize
+          super("please provide a valid event name, it could be either String or Symbol")
+        end
+      end
+
       DOT = '.'.freeze
       UNDERSCORE = '_'.freeze
 
       # @!attribute [r] id
-      #   @return [Symbol] The event identifier
+      #   @return [Symbol, String] The event identifier
       attr_reader :id
 
+      # @api private
+      def self.new(id, payload = EMPTY_HASH)
+        return super(id, payload) if (id.is_a?(String) || id.is_a?(Symbol)) && !id.empty?
+
+        raise InvalidEventNameError.new
+      end
+
       # Initialize a new event
       #
-      # @param [Symbol] id The event identifier
-      # @param [Hash] payload Optional payload
+      # @param [Symbol, String] id The event identifier
+      # @param [Hash] payload
       #
       # @return [Event]
       #
       # @api private
-      def initialize(id, payload = EMPTY_HASH)
+      def initialize(id, payload)
         @id = id
         @payload = payload
       end
@@ -66,11 +80,6 @@ module Dry
         end
       end
 
-      # @api private
-      def trigger?(query)
-        query.empty? || query.all? { |key, value| payload[key] == value }
-      end
-
       # @api private
       def listener_method
         @listener_method ||= :"on_#{id.to_s.gsub(DOT, UNDERSCORE)}"

data/lib/dry/events/filter.rb

@@ -0,0 +1,72 @@
+require 'set'
+
+module Dry
+  module Events
+    # Event filter
+    #
+    # A filter cherry-picks probes payload of events.
+    # Events not matching the predicates don't fire callbacks.
+    #
+    # @api private
+    class Filter
+      NO_MATCH = Object.new.freeze
+
+      # @!attribute [r] events
+      #   @return [Array] A list of lambdas checking payloads
+      attr_reader :checks
+
+      # Create a new filter
+      #
+      # @param [Hash] filter Source filter
+      #
+      # @api private
+      def initialize(filter)
+        @checks = build_checks(filter)
+      end
+
+      # Test event payload against the checks
+      #
+      # @param [Hash] payload Event payload
+      #
+      # @api private
+      def call(payload = EMPTY_HASH)
+        checks.all? { |check| check.(payload) }
+      end
+
+      # Recursively build checks
+      #
+      # @api private
+      def build_checks(filter, checks = EMPTY_ARRAY, keys = EMPTY_ARRAY)
+        if filter.is_a?(Hash)
+          filter.reduce(checks) do |cs, (key, value)|
+            build_checks(value, cs, [*keys, key])
+          end
+        else
+          [*checks, method(:compare).curry.(keys, predicate(filter))]
+        end
+      end
+
+      # @api private
+      def compare(path, predicate, payload)
+        value = path.reduce(payload) do |acc, key|
+          if acc.is_a?(Hash) && acc.key?(key)
+            acc[key]
+          else
+            break NO_MATCH
+          end
+        end
+
+        predicate.(value)
+      end
+
+      # @api private
+      def predicate(value)
+        case value
+        when Proc then value
+        when Array then value.method(:include?)
+        else value.method(:==)
+        end
+      end
+    end
+  end
+end

data/lib/dry/events/listener.rb

@@ -11,7 +11,7 @@ module Dry
     #
     #     register_event("users.created")
     #   end
-
+    #
     #   class MyListener
     #     include Dry::Events::Listener[:app]
     #

data/lib/dry/events/publisher.rb

@@ -5,6 +5,7 @@ require 'dry/core/class_attributes'
 require 'dry/events/constants'
 require 'dry/events/event'
 require 'dry/events/bus'
+require 'dry/events/filter'
 
 module Dry
   module Events
@@ -18,6 +19,19 @@ module Dry
       end
     end
 
+    # @api public
+    InvalidSubscriberError = Class.new(StandardError) do
+      # @api private
+      def initialize(object_or_event_id)
+        case object_or_event_id
+        when String, Symbol
+          super("you are trying to subscribe to an event: `#{object_or_event_id}` that has not been registered")
+        else
+          super("you try use subscriber object that will never be executed")
+        end
+      end
+    end
+
     # Extension used for classes that can publish events
     #
     # @example
@@ -116,13 +130,13 @@ module Dry
         # Subscribe to an event
         #
         # @param [Symbol,String] event_id The event identifier
-        # @param [Hash] query An optional query for conditional listeners
+        # @param [Hash] filter_hash An optional filter for conditional listeners
         #
         # @return [Class] publisher class
         #
         # @api public
-        def subscribe(event_id, query = EMPTY_HASH, &block)
-          listeners[event_id] << [block, query]
+        def subscribe(event_id, filter_hash = EMPTY_HASH, &block)
+          listeners[event_id] << [block, Filter.new(filter_hash)]
           self
         end
 
@@ -180,21 +194,28 @@ module Dry
 
         # Subscribe to events.
         #
-        # If the query parameter is provided, filters events by payload.
+        # If the filter parameter is provided, filters events by payload.
         #
         # @param [Symbol,String,Object] object_or_event_id The event identifier or a listener object
-        # @param [Hash] query An optional event filter
+        # @param [Hash] filter_hash An optional event filter
         #
         # @return [Object] self
         #
         # @api public
-        def subscribe(object_or_event_id, query = EMPTY_HASH, &block)
-          if block
-            __bus__.subscribe(object_or_event_id, query, &block)
+        def subscribe(object_or_event_id, filter_hash = EMPTY_HASH, &block)
+          if __bus__.can_handle?(object_or_event_id)
+            filter = Filter.new(filter_hash)
+
+            if block
+              __bus__.subscribe(object_or_event_id, filter, &block)
+            else
+              __bus__.attach(object_or_event_id, filter)
+            end
+
+            self
           else
-            __bus__.attach(object_or_event_id, query)
+            raise InvalidSubscriberError, object_or_event_id
           end
-          self
         end
 
         # Unsubscribe a listener
@@ -217,7 +238,7 @@ module Dry
 
         # Utility method which yields event with each of its listeners
         #
-        # Listeners are already filtered out when query was provided during
+        # Listeners are already filtered out when filter was provided during
         # subscription
         #
         # @param [Symbol,String] event_id The event identifier

data/lib/dry/events/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Events
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -6,7 +6,8 @@ if RUBY_ENGINE == 'ruby' && ENV['COVERAGE'] == 'true'
 end
 
 begin
-  require 'byebug'
+  require 'pry'
+  require 'pry-byebug'
 rescue LoadError; end
 
 require 'dry-events'
@@ -17,7 +18,9 @@ Dir[SPEC_ROOT.join('shared/**/*.rb')].each(&method(:require))
 Dir[SPEC_ROOT.join('support/**/*.rb')].each(&method(:require))
 
 RSpec.configure do |config|
+  config.warnings = true
   config.disable_monkey_patching!
+  config.filter_run_when_matching :focus
 
   config.after(:example) do
     Dry::Events::Publisher.instance_variable_set(:@__registry__, Concurrent::Map.new)

data/spec/unit/dry/events/event_spec.rb

@@ -0,0 +1,66 @@
+require 'dry/events/event'
+
+RSpec.describe Dry::Events::Event do
+  subject(:event) do
+    described_class.new(event_id, payload)
+  end
+
+  let(:payload) { {} }
+
+  describe 'invalid event name' do
+    let(:event_id) { nil }
+    it 'raises InvalidEventNameError' do
+      expect{ event }.to raise_error(Dry::Events::Event::InvalidEventNameError)
+    end
+  end
+
+  describe '#[]' do
+    let(:event_id) { :test }
+    let(:payload) { {test: :foo} }
+
+    it 'fetches payload key' do
+      expect(event[:test]).to eq :foo
+    end
+
+    it 'raises KeyError when no key found' do
+      expect { event[:fake] }.to raise_error(KeyError)
+    end
+  end
+
+  describe '#payload' do
+    let(:event_id) { :test }
+    let(:payload) { {test: :foo} }
+
+    it 'returns payload if no argument' do
+      expect(event.payload).to eq payload
+    end
+
+    it 'returns new event with payload payload' do
+      new_event = event.payload({ bar: :baz })
+      expect(new_event).to_not eq event
+      expect(new_event.payload).to eq ({test: :foo, bar: :baz})
+    end
+  end
+
+  describe '#to_h' do
+    let(:event_id) { :test }
+    let(:payload) { {test: :foo} }
+
+    it 'returns payload' do
+      expect(event.to_h).to eq payload
+    end
+  end
+
+  describe '#listener_method' do
+    let(:event_id) { :test }
+
+    it 'returns listener method name' do
+      expect(event.listener_method).to eq :on_test
+    end
+
+    it 'replaces dots for underscores' do
+      ev = Dry::Events::Event.new('hello.world')
+      expect(ev.listener_method).to eq :on_hello_world
+    end
+  end
+end

data/spec/unit/dry/events/filter_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe Dry::Events::Filter do
+  subject(:filter) { described_class.new(query) }
+
+  context 'nested hash' do
+    let(:query) do
+      { logger: { level: :info } }
+    end
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(logger: { level: :info, output: :stdin })).to be true
+      expect(filter.(logger: { level: :debug })).to be false
+      expect(filter.(logger: :debug)).to be false
+    end
+  end
+
+  context 'multi-value check' do
+    let(:query) do
+      { logger: { level: :info, output: :stdin } }
+    end
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(logger: { level: :info, output: :stdin })).to be true
+      expect(filter.(logger: { level: :info })).to be false
+    end
+  end
+
+  context 'top-level array' do
+    let(:query) { %i(error fatal) }
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(random: :hash)).to be false
+      expect(filter.(:error)).to be true
+    end
+  end
+
+  context 'nested array' do
+    let(:query) do
+      { logger: { level: %i(info warn error fatal) } }
+    end
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(logger: { level: :info, output: :stdin })).to be true
+      expect(filter.(logger: { level: :fatal })).to be true
+      expect(filter.(logger: { level: :debug })).to be false
+      expect(filter.(level: :debug)).to be false
+    end
+  end
+
+  context 'nested proc' do
+    let(:query) do
+      { logger: { level: -> level { %i(error fatal).include?(level) } } }
+    end
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(logger: { level: :error, output: :stdin })).to be true
+    end
+  end
+
+  context 'top-level proc' do
+    let(:query) do
+      -> level: :debug, ** { %i(error fatal).include?(level) }
+    end
+
+    specify do
+      expect(filter.()).to be false
+      expect(filter.(level: :error, output: :stdin)).to be true
+    end
+  end
+end

data/spec/unit/dry/events/listener_spec.rb

@@ -16,16 +16,30 @@ RSpec.describe Dry::Events::Listener do
   end
 
   describe '.subscribe' do
-    it 'subscribes a listener at class level' do
-      result = []
+    let(:captured) { [] }
 
+    it 'subscribes a listener at class level' do
       listener.subscribe(:test_event) do |event|
-        result << event.id
+        captured << event.id
       end
 
       publisher.publish(:test_event)
 
-      expect(result).to eql([:test_event])
+      expect(captured).to eql([:test_event])
+    end
+
+    describe 'filters' do
+      it 'filters events' do
+        listener.subscribe(:test_event, level: :info) do |event|
+          captured << event.payload
+        end
+
+        publisher.publish(:test_event)
+        publisher.publish(:test_event, level: :debug)
+        publisher.publish(:test_event, level: :info)
+
+        expect(captured).to eql([level: :info])
+      end
     end
   end
 end

data/spec/unit/dry/events/publisher_spec.rb

@@ -39,6 +39,14 @@ RSpec.describe Dry::Events::Publisher do
 
       expect(publisher.subscribed?(listener)).to be(true)
     end
+
+    it 'raises an exception when subscribing to an unregister event' do
+      listener = -> * { }
+
+      expect {
+        publisher.subscribe(:not_register, &listener)
+      }.to raise_error(Dry::Events::InvalidSubscriberError, /not_register/)
+    end
   end
 
   describe '#register_event' do
@@ -83,6 +91,20 @@ RSpec.describe Dry::Events::Publisher do
 
       expect(listener.captured).to eql(['it works'])
     end
+
+    it 'raises an exception when subscribing with no methods to execute' do
+      listener = Object.new
+
+      expect {
+        publisher.subscribe(listener)
+      }.to raise_error(Dry::Events::InvalidSubscriberError, /never be executed/)
+    end
+
+    it 'does not raise an exception when subscriber has methods for notification' do
+      listener = Object.new
+      def listener.on_test_event; nil; end
+      expect { publisher.subscribe(listener) }.not_to raise_error
+    end
   end
 
   describe '#publish' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -116,10 +116,13 @@ files:
 - lib/dry/events/bus.rb
 - lib/dry/events/constants.rb
 - lib/dry/events/event.rb
+- lib/dry/events/filter.rb
 - lib/dry/events/listener.rb
 - lib/dry/events/publisher.rb
 - lib/dry/events/version.rb
 - spec/spec_helper.rb
+- spec/unit/dry/events/event_spec.rb
+- spec/unit/dry/events/filter_spec.rb
 - spec/unit/dry/events/listener_spec.rb
 - spec/unit/dry/events/publisher_spec.rb
 homepage: https://github.com/dry-rb/dry-events
@@ -141,12 +144,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Pub/sub system
 test_files:
 - spec/spec_helper.rb
+- spec/unit/dry/events/event_spec.rb
+- spec/unit/dry/events/filter_spec.rb
 - spec/unit/dry/events/listener_spec.rb
 - spec/unit/dry/events/publisher_spec.rb