emittance 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 480d65a814b24509517a96de13d0590117504f2d
-  data.tar.gz: 3c41c536af288cb32adc9cc00f2be9c0f8c7f15c
+  metadata.gz: 4e9a6fb1053c8170cf15f5b0591b50ee652a3e65
+  data.tar.gz: 99c427d6c87cddf253750f9e435454bdef626cec
 SHA512:
-  metadata.gz: d1946bdae18b76de6989aef2342a8ed87341a9d0475dfc1f5459598bdd804c69a97c789f6bbb37af270341d1a8cbda2d2249e0f1adada2a74066883fcf5b5729
-  data.tar.gz: 2b1735b0f9f56884ae2e9520b48df74b7540f26565c125a3272ec9165614cbebfa8b3ee2e36a64918b3c244589ff71a6100daeb667947abbe2fb25fc3fae3739
+  metadata.gz: 54ad3b23a947f7a138c2e6182d91beb618473e0f64b7475c0236fddfdfb39aac6984e0a49534dcb630912b1d226f69c1fd2eeb2b359e41ace6d12162ad52f2c1
+  data.tar.gz: 842994125c20aba135f5d1daec7a7842027e47c58b2129d02cf3fb5a90f852b8a692d2dd3afaa0be338cfc5f1cfcf5e8e9e984cab9ede5009e6ee9b94c8ed9db

data/.gitignore

@@ -18,3 +18,5 @@ doc/**
 
 # Other
 .rspec_status
+
+pkg

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'bin/**/*'
+
 # Metrics
 
 Metrics/LineLength:
@@ -10,3 +15,8 @@ Layout/MultilineMethodCallIndentation:
 
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
+
+# Style
+
+Style/DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,12 @@
+env:
+  global:
+    - secure: "uBY5L4Qs7b9dEVG2XAJ2x9O+PgJTIA9Ezkiu7KrfxjNhMViSUOGmkKvVxBWKwFzChfsFT2wQK/TYcNNtpZoFCLxqyBTCFV1DLHiPQ3mAW4yHPiRbwkEX5HSjypn+4ONd+nk26hMgfrnnAoHM5m4tkAQRo1dY8ARv46iH2wctErVYzj5ACf/OUmrIoF/+QXkE98oOWLMYhtyAhmlBusdcM+czreMD2BUzFilkhVLLY41KA1f7EE0W4v8aY87SOsBR6Q6bFKXm9bW3xxR6nKHukFXgXtfkkylcGOZur8VrvTxx/NAKTOyx/mCo4h1SqwZrIJQoPh3uBwv6n41YGkIzFQoebPiUnnsVYCnlz0V2AnnCdcZ/LrpIVra+bN7bh3oMtEKmlrU8cHeRQy0HlaD9u4o1KYwlg0X8lApGpsSsc+GKAC9MzGk4P3aOWFFSxqs/oo98bhlxuCvYjEh+x/aXeOqG6a/3Vlg6p/gJPxqDlaHmF6JfYGWrCysnJQtbBAstH/HhT2XHm/96uH3OURI7o+tx/I63/Qz/YG68O0nV9leFUrcmARK8XMavn1N5BM0Uoh/XhC0JUnu3GJJ7g7kABPkck81U1qWskDMeUm8hhfJgWVSixnAxKBehX+rKrizbcj3/UyqYKy7SnNHJ6fQo34rBxDLe0O8ULbWifj5/Xg4="
 language: ruby
 rvm:
   - 2.4.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in test.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    emittance (0.0.1)
+    emittance (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/aastronautss/emittance.svg?branch=master)](https://travis-ci.org/aastronautss/emittance)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b5900e32c5a385c96c95/maintainability)](https://codeclimate.com/github/aastronautss/emittance/maintainability)
+[![Inline docs](http://inch-ci.org/github/aastronautss/emittance.svg?branch=master)](http://inch-ci.org/github/aastronautss/emittance)
 
 Emittance is a flexible eventing library that provides a clean interface for both emitting and capturing events. It follows the following workflow:
 
@@ -50,7 +51,7 @@ Foo.emit :something_else_happened # Classes who extended Emitter can also emit e
 As you can see, event types are identified by a symbol. More on that later. You can also pass in an optional payload, which can be any object:
 
 ```ruby
-my_foo.emit :something_happened, "Here's a payload!"
+my_foo.emit :something_happened, payload: "Here's a payload!"
 ```
 
 The above examples are cool, but it's generally a better idea to have an object emit its own events:
@@ -60,7 +61,7 @@ class Foo
   extend Emittance::Emitter
 
   def make_something_happen
-    emit :something_happened, "Here's a payload!"
+    emit :something_happened, payload: "Here's a payload!"
   end
 end
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'emittance'

data/emittance.gemspec

@@ -1,39 +1,32 @@
+# frozen_string_literal: true
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'emittance/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'emittance'
-  spec.version       = Emittance::VERSION
-  spec.authors       = ['Tyler Guillen']
-  spec.email         = ['tyler@tylerguillen.com']
-
-  spec.summary       = %q{A robust and flexible eventing library for Ruby.}
-  spec.description   = %q{A robust and flexible eventing library for Ruby.}
-  spec.homepage      = 'https://github.com/aastronautss/emittance'
-  spec.license       = 'MIT'
+  spec.name = 'emittance'
+  spec.version = Emittance::VERSION
+  spec.authors = ['Tyler Guillen']
+  spec.email = ['tyler@tylerguillen.com']
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
+  spec.summary = 'A robust and flexible eventing library for Ruby.'
+  spec.description = 'A robust and flexible eventing library for Ruby.'
+  spec.homepage = 'https://github.com/aastronautss/emittance'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'yard'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

data/lib/emittance.rb

@@ -3,11 +3,13 @@
 require 'emittance/version'
 require 'emittance/errors'
 
+require 'emittance/helpers/string_helpers'
+require 'emittance/helpers/constant_helpers'
+require 'emittance/event_lookup'
 require 'emittance/brokerage'
 require 'emittance/broker'
 require 'emittance/registration'
 require 'emittance/event'
-require 'emittance/event/event_builder'
 require 'emittance/emitter'
 require 'emittance/watcher'
 require 'emittance/action'
@@ -20,22 +22,26 @@ module Emittance
   class << self
     # Enable eventing process-wide.
     def enable!
-      Emittance::Dispatcher.enable!
+      Emittance::Brokerage.enable!
     end
 
     # Disable eventing process-wide.
     def disable!
-      Emittance::Dispatcher.disable!
+      Emittance::Brokerage.disable!
     end
 
     # @return [Boolean] true if eventing is enabled, false otherwise.
     def enabled?
-      Emittance::Dispatcher.enabled?
+      Emittance::Brokerage.enabled?
     end
 
+    # Not yet implemented!
+    # :nocov:
     # @private
-    def suppress(&blk)
-      Emittance::Dispatcher.suppress(&blk)
+    def suppress(&_blk)
+      raise NotImplementedError, "This isn't working yet!"
+      # Emittance::Dispatcher.suppress(&blk)
     end
+    # :nocov:
   end
 end

data/lib/emittance/action.rb

@@ -122,33 +122,76 @@ module Emittance
 
     # @private
     class << self
+      include Emittance::Helpers::ConstantHelpers
+
       def included(action_klass)
         handler_klass_name = Emittance::Action.handler_klass_name(action_klass)
         handler_klass = Emittance::Action.find_or_create_klass(handler_klass_name)
 
-        action_klass.class_eval do
+        setup_action_klass action_klass
+        setup_handler_klass handler_klass, action_klass
+      end
+
+      # @private
+      def handler_klass_name(action_klass)
+        "#{action_klass}Handler"
+      end
+
+      # @private
+      def emitting_event_identifier(action_klass)
+        Emittance::Event.event_klass_for action_klass
+      end
+
+      # @private
+      def find_or_create_klass(klass_name)
+        unless Object.const_defined? klass_name
+          set_namespaced_constant_by_name klass_name, Class.new
+        end
+
+        Object.const_get klass_name
+      end
+
+      private
+
+      # Class setups
+
+      def setup_action_klass(action_klass)
+        action_klass.class_eval(&action_klass_blk)
+      end
+
+      def setup_handler_klass(handler_klass, action_klass)
+        handler_klass.class_eval(&handler_klass_blk(action_klass))
+      end
+
+      # Blocks
+
+      # rubocop:disable Metrics/MethodLength
+      def action_klass_blk
+        lambda do |_klass|
           extend Emittance::Emitter
 
           class << self
-            # @private
-            def method_added(method_name)
+            define_method :method_added do |method_name|
               emitting_method = Emittance::Action::EMITTING_METHOD
-              emits_on method_name if method_name == emitting_method
-              super
+              identifier = Emittance::Action.emitting_event_identifier(self)
+              emits_on(method_name, identifier: identifier) if method_name == emitting_method
+              super method_name
             end
           end
         end
+      end
 
-        handler_klass.class_eval do
+      def handler_klass_blk(action_klass)
+        lambda do |_klass|
           attr_reader :action
 
           extend Emittance::Watcher
 
-          def initialize(action_obj)
+          define_method :initialize do |action_obj|
             @action = action_obj
           end
 
-          watch Emittance::Action.emitting_event_name(action_klass) do |event|
+          watch Emittance::Action.emitting_event_identifier(action_klass) do |event|
             handler_obj = new(event.emitter)
             handler_method_name = Emittance::Action::HANDLER_METHOD_NAME
 
@@ -158,35 +201,6 @@ module Emittance
           end
         end
       end
-
-      # @private
-      def handler_klass_name(action_klass)
-        "#{action_klass}Handler"
-      end
-
-      # @private
-      def emitting_event_name(action_klass)
-        Emittance::Emitter.emitting_method_event(action_klass, Emittance::Action::EMITTING_METHOD)
-      end
-
-      # @private
-      def find_or_create_klass(klass_name)
-        unless Object.const_defined? klass_name
-          set_namespaced_constant_by_name klass_name, Class.new
-        end
-
-        Object.const_get klass_name
-      end
-
-      private
-
-      def set_namespaced_constant_by_name(const_name, obj)
-        names = const_name.split('::')
-        names.shift if names.size > 1 && names.first.empty?
-
-        namespace = names.size == 1 ? Object : Object.const_get(names[0...-1].join('::'))
-        namespace.const_set names.last, obj
-      end
     end
   end
 end

data/lib/emittance/brokerage.rb

@@ -6,12 +6,17 @@ module Emittance
   # contact for event propagation.
   #
   class Brokerage
+    @enabled = true
+
     class << self
+      # @param event [Emittance::Event] the event object
+      # @param broker_id [Symbol] a symbol that can be used to identify a broker by
       def send_event(event, broker_id)
         broker = registry.fetch(broker_id)
         broker.process_event event
       end
 
+      # @param broker [Emittance::Broker] the broker you would like to register
       def register_broker(broker)
         registry.register broker
       end
@@ -19,6 +24,22 @@ module Emittance
       def registry
         Emittance::Brokerage::Registry
       end
+
+      def enable!
+        @enabled = true
+      end
+
+      def disable!
+        @enabled = false
+      end
+
+      def enabled?
+        @enabled
+      end
+
+      private
+
+      attr_accessor :enabled
     end
 
     # @private
@@ -26,6 +47,8 @@ module Emittance
       @brokers = {}
 
       class << self
+        include Emittance::Helpers::StringHelpers
+
         attr_reader :brokers
 
         def register(broker)
@@ -43,13 +66,6 @@ module Emittance
           camel_case = broker.name.split('::').last
           snake_case(camel_case).to_sym
         end
-
-        def snake_case(str)
-          str.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-            .tr('-', '_')
-            .downcase
-        end
       end
     end
   end

data/lib/emittance/dispatcher.rb

@@ -10,13 +10,23 @@ module Emittance
 
     class << self
       def process_event(event)
-        new.process_event event
+        registrations_for(event).each do |registration|
+          registration.call event
+        end
+      end
+
+      def registrations_for(identifier)
+        event_klass = find_event_klass identifier
+        registrations[event_klass] ||= empty_registration
+        registrations[event_klass]
       end
 
       def register(identifier, &callback)
-        identifier = normalize_identifier identifier
-        registrations[identifier] ||= empty_registration
-        registrations_for(identifier) << Emittance::Registration.new(identifier, &callback)
+        event_klass = find_event_klass identifier
+        registrations[event_klass] ||= empty_registration
+        registrations_for(event_klass) << Emittance::Registration.new(event_klass, &callback)
+
+        callback
       end
 
       def register_method_call(identifier, object, method_name)
@@ -24,92 +34,31 @@ module Emittance
       end
 
       def clear_registrations!
-        registrations.keys.each do |identifier|
-          clear_registrations_for! identifier
+        registrations.each_key do |event_klass|
+          clear_registrations_for! event_klass
         end
       end
 
       def clear_registrations_for!(identifier)
-        identifier = normalize_identifier identifier
-        registrations[identifier].clear
-      end
-
-      def registrations_for(identifier)
-        identifier = normalize_identifier identifier
-        registrations[identifier] || empty_registration
-      end
-
-      def enable!
-        @enabled = true
-      end
-
-      def disable!
-        @enabled = false
-      end
-
-      def enabled?
-        @enabled
+        event_klass = find_event_klass identifier
+        registrations[event_klass].clear
       end
 
       private
 
-      attr_accessor :enabled, :registrations
+      attr_accessor :registrations
 
       def empty_registration
         Set.new
       end
 
-      def normalize_identifier(identifier)
-        if event_klass?(identifier) || event_object?(identifier)
-          identifier.identifier
-        else
-          coerce_identifier_type identifier
-        end
+      def find_event_klass(event)
+        Emittance::EventLookup.find_event_klass(event)
       end
 
       def lambda_for_method_call(object, method_name)
         ->(event) { object.send method_name, event }
       end
-
-      def event_klass?(identifier)
-        identifier.is_a?(Class) && identifier < Emittance::Event
-      end
-
-      def event_object?(identifier)
-        identifier.is_a? Emittance::Event
-      end
-
-      def coerce_identifier_type(identifier)
-        identifier.to_sym
-      end
-    end
-
-    def initialize(suppressed = false)
-      @suppressed = suppressed
-    end
-
-    def process_event(event)
-      return unless enabled?
-
-      registrations_for(event).each do |registration|
-        registration.call event
-      end
-    end
-
-    private
-
-    attr_reader :suppressed
-
-    def registrations_for(event)
-      self.class.registrations_for event
-    end
-
-    def enabled?
-      self.class.enabled? && !suppressed?
-    end
-
-    def suppressed?
-      suppressed
     end
   end
 end