dry-events 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18471031f2c5dcd9d2ea488ab48f5d42d9bd44de9158241dbb43324dd6fc0b4
-  data.tar.gz: '01160358743e52191c19bfc8b3a0550b4a201967f5fe96a8c60dfe50b560b2e1'
+  metadata.gz: 1423fe7cb9ad77d3af4fea999666f1ff275204e5dad84e4ba8f83ea230b0e2d0
+  data.tar.gz: 30a0f8b923a890af19b9937fbf502b51c8a568b33444bba0f3d09995045a016d
 SHA512:
-  metadata.gz: d5d2e2a9920e5fe2241d5ae0cf42337169f4836353475aeb1bf4d8e621eac86b33143440a160ba5addf0b3cae548772f02c1b42bd86d88283e466835714f42bd
-  data.tar.gz: 6b4b8cdc169c69523dc8ba29362113d4fd7b127d3532f80572bf687c44b07c02fbe95788d2356a1316b363e54fab1ad8db3cd4801823aecce0f59926f9ec5e9b
+  metadata.gz: d985af03635dea492d89ae37dd5935aa4576d92ca2201bbf4096d12a396df7857fd0007bf7a28275f7d5a985560ef26532ca977bf1ea05e04e815d88db02bd8f
+  data.tar.gz: 8de1e80e33a2a5429fddce3a675ed9c72ae5224bc919d6fcab5300f4f8d7b11617d18330b0af5451884e76accbc755b37d4282155c0aa52dbddd380e1cc723af

data/.travis.yml

@@ -2,25 +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,11 @@
+# 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

data/README.md

@@ -1,13 +1,13 @@
 [gem]: https://rubygems.org/gems/dry-events
-[travis]: https://travis-ci.org/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]
+[![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]

data/lib/dry/events/bus.rb

@@ -76,6 +76,19 @@ module Dry
       def subscribed?(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
 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

data/lib/dry/events/publisher.rb

@@ -19,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
@@ -190,14 +203,19 @@ module Dry
         #
         # @api public
         def subscribe(object_or_event_id, filter_hash = EMPTY_HASH, &block)
-          filter = Filter.new(filter_hash)
+          if __bus__.can_handle?(object_or_event_id)
+            filter = Filter.new(filter_hash)
 
-          if block
-            __bus__.subscribe(object_or_event_id, filter, &block)
+            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, filter)
+            raise InvalidSubscriberError, object_or_event_id
           end
-          self
         end
 
         # Unsubscribe a listener

data/lib/dry/events/version.rb

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

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/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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -121,6 +121,7 @@ files:
 - 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
@@ -143,12 +144,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+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