koine-event_manager 1.1 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 775de95f0d2768e1147c12eea5a66dd28fd23fee
-  data.tar.gz: 6bb2f1ef07c98614d119a615769f67e318f32e77
+SHA256:
+  metadata.gz: 264cee5964fb227323548961304f0a9110abb63da35ab855917a5b51076bd7b8
+  data.tar.gz: f664cfc5d29d7a21e7ffaae1b8888416e98cc7cde592b5074cf017bb7612d330
 SHA512:
-  metadata.gz: 0c6b9922bd907cd760a065bb74a564142b6817881a213e52b0674535beb223b954eda7e418e389c101b71a29ffbde0ab7d3b98329318453a59d2e57e9d5896dc
-  data.tar.gz: 7c653751ff81a31f53ec7267aa952225b61de01f50b9e1181a3b506cdd18e22270c3131e043ae25383e7c3a3a95b32bfacee96c317b1c077930711bd793b7ccd
+  metadata.gz: 8a4bb7a37ef2eea3783aacc8800e609888bfaa0c481d86696b85d952b3a5180f0a5875b9c66c4a5eb23f67057b1cecddd003ab7a125fe90f31b2f1ba39d97477
+  data.tar.gz: 1f60e42695cae9fa481d0ca6faa469c6bc59b0dd538a47d7987d9b01e7c016081672a436ef9cbba71db436b02b2f269a6962cbf0905fc87f0d8c8a6541eec91d

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,81 @@
+require: rubocop-rspec
+
+# https://github.com/rubocop-hq/rubocop/blob/36404b40cbdac743b596c8520877c4ca3eee5691/manual/cops.md
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - config/environment.rb
+    - apps/web/application.rb
+Layout/AlignParameters:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false
+
+Layout/IndentArray:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/LineLength:
+  Max: 100
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# rubocop-rspec cops
+
+Capybara/FeatureMethods:
+  Enabled: false
+
+FactoryBot/CreateList:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 cache: bundle
+script:
+  - COVERALLS=1 bundle exec rake
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.4.4
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,74 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+## Our Standards
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+Examples of behavior that contributes to creating a positive environment
+include:
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marcelo.jacobus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Marcelo Jacobus
+Copyright (c) 2015-2018 Marcelo Jacobus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,10 +3,8 @@
 Event manager for ruby.
 
 [![Build Status](https://travis-ci.org/mjacobus/koine-event-manager.svg)](https://travis-ci.org/mjacobus/koine-event-manager)
-[![Code Coverage](https://scrutinizer-ci.com/g/mjacobus/koine-event-manager/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-event-manager/?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/mjacobus/koine-event-manager/badge.svg?branch=master)](https://coveralls.io/github/mjacobus/koine-event-manager?branch=master)
 [![Code Climate](https://codeclimate.com/github/mjacobus/koine-event-manager/badges/gpa.svg)](https://codeclimate.com/github/mjacobus/koine-event-manager)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mjacobus/koine-event-manager/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-event-manager/?branch=master)
-[![Dependency Status](https://gemnasium.com/mjacobus/koine-event-manager.svg)](https://gemnasium.com/mjacobus/koine-event-manager)
 [![Gem Version](https://badge.fury.io/rb/koine-event_manager.svg)](https://badge.fury.io/rb/koine-event_manager)
 
 ## Installation
@@ -83,36 +81,21 @@ And trigger the event on the event manager
 event_manager.trigger(UserSignedIn.new(some_user))
 ```
 
-## Adding event manager awareness to your classes
+### Subscribers
 
-**CAUTION**: This make use of the singleton instance of event manager.
-Singletons are usually a bad idea, so prefer dependency injection over
-singleton instances.
+You can add and remove subscribers as follows:
 
 ```ruby
-require "koine/event_manager/event_manager_aware"
-
-class MyModel
-  include Koine::EventManager::EventManagerAware
-
-  def some_method
-    event_manager.trigger(SomeEvent.new(foo: :bar))
+class MySubscriber
+  def publish(event)
+    # do something
   end
 end
-```
-
-The above is the same as:
 
-```ruby
-class MyModel
-  def some_method
-    event_manager.trigger(SomeEvent.new(foo: :bar))
-  end
+subscriber = MySubscriber.new
 
-  def event_manager
-    Koine::EventManager::EventManager.instance
-  end
-end
+event_manager.subscribe(subscriber, to: UserListener)
+event_manager.unsubscribe(subscriber, from: UserListener)
 ```
 
 ## Development

data/Rakefile

@@ -1,27 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "spec"
-  t.libs << "lib"
-  t.test_files = FileList['spec/**/*_spec.rb']
-end
-
-namespace :test do
-  task :coveralls do
-    ENV["COVERALLS"] = "true"
-    Rake::Task["test:coverage"].invoke
-  end
+require 'bundler/gem_tasks'
 
-  task :coverage do
-    ENV["COVERAGE"] = "true"
-    Rake::Task["test"].invoke
-  end
-
-  task :scrutinizer do
-    ENV["SCRUTINIZER"] = "true"
-    Rake::Task["test"].invoke
-  end
+# rubocop:disable Lint/HandleExceptions
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
 end
-
-task :default => :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "koine/event_manager"
+require 'bundler/setup'
+require 'koine/event_manager'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "koine/event_manager"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
+set -vx
 
 bundle install
 

data/koine-event_manager.gemspec

@@ -1,36 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'koine/event_manager/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
-  spec.name          = "koine-event_manager"
+  spec.name          = 'koine-event_manager'
   spec.version       = Koine::EventManager::VERSION
-  spec.authors       = ["Marcelo Jacobus"]
-  spec.email         = ["marcelo.jacobus@gmail.com"]
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
 
-  spec.summary       = %q{Event Manager for ruby}
-  spec.description   = %q{Event Manager for ruby}
-  spec.homepage      = "https://github.com/mjacobus/koine-event-manager"
-  spec.license       = "MIT"
+  spec.summary       = 'Event Manager for ruby'
+  spec.description   = 'Event Manager for ruby'
+  spec.homepage      = 'https://github.com/mjacobus/koine-event-manager'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
+  # 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'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "scrutinizer-ocular"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.58'
+  spec.add_development_dependency 'rubocop-rspec', '~>1.30'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/koine/event_manager.rb

@@ -1,6 +1,8 @@
-require "koine/event_manager/version"
-require "koine/event_manager/event_manager"
-require "koine/event_manager/event_listener"
+# frozen_string_literal: true
+
+require 'koine/event_manager/version'
+require 'koine/event_manager/event_manager'
+require 'koine/event_manager/event_listener'
 
 module Koine
   module EventManager

data/lib/koine/event_manager/event_listener.rb

@@ -1,30 +1,64 @@
+# frozen_string_literal: true
+
 module Koine
   module EventManager
     class EventListener
-      def listen_to(event_name, &block)
-        raise ArgumentError, "block not given" unless block_given?
-        listeners_for(event_name) << block
+      def initialize
+        @listeners = {}
+        @subscribers = {}
+      end
+
+      def listen_to(event_type, &block)
+        raise ArgumentError, 'block not given' unless block_given?
+        add_listener(event_type, &block)
+      end
+
+      def subscribe(subscriber, to:)
+        @subscribers[subscriber] ||= []
+        @subscribers[subscriber] << to
+      end
+
+      def unsubscribe(subscriber, from:)
+        all = Array(subscribers[subscriber])
+        filtered = all.reject do |object_type|
+          object_type.to_s == from.to_s
+        end
+        subscribers[subscriber] = filtered
       end
 
       def trigger(event_object)
         listeners_for(event_object.class).each do |block|
           block.call(event_object)
         end
+
+        subscribers.each do |subscriber, events|
+          events.each do |event|
+            if event_object.class.ancestors.map(&:to_s).include?(event.to_s)
+              subscriber.publish(event_object)
+            end
+          end
+        end
       end
 
-      def listeners_for(event)
-        listeners[key_for(event)] ||= []
+      def listeners_for(event_type)
+        listeners.select do |class_or_object, _collection|
+          event_type.ancestors.map(&:to_s).include?(class_or_object.to_s)
+        end.values.flatten
       end
 
       private
 
+      def add_listener(event_type, &block)
+        listeners[event_type.to_s] ||= []
+        listeners[event_type.to_s] << block
+      end
+
       def key_for(object_or_class)
         object_or_class.to_s
       end
 
-      def listeners
-        @listeners ||= {}
-      end
+      attr_reader :listeners
+      attr_reader :subscribers
     end
   end
 end

data/lib/koine/event_manager/event_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Koine
   module EventManager
     class EventManager
@@ -9,6 +11,14 @@ module Koine
         @internal_listener.listen_to(event, &block)
       end
 
+      def subscribe(subscriber, to:)
+        @internal_listener.subscribe(subscriber, to: to)
+      end
+
+      def unsubscribe(subscriber, from:)
+        @internal_listener.unsubscribe(subscriber, from: from)
+      end
+
       def attach_listener(listener)
         listeners << listener
       end
@@ -26,11 +36,7 @@ module Koine
       end
 
       def listeners
-        @listners ||= []
-      end
-
-      def self.instance
-        @@instance ||= new
+        @listeners ||= []
       end
     end
   end

data/lib/koine/event_manager/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Koine
   module EventManager
-    VERSION = "1.1"
+    VERSION = '2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koine-event_manager
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '2.1'
 platform: ruby
 authors:
 - Marcelo Jacobus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2018-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,47 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: scrutinizer-ocular
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.58'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.58'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - ".scrutinizer.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -115,7 +131,6 @@ files:
 - lib/koine/event_manager.rb
 - lib/koine/event_manager/event_listener.rb
 - lib/koine/event_manager/event_manager.rb
-- lib/koine/event_manager/event_manager_aware.rb
 - lib/koine/event_manager/version.rb
 homepage: https://github.com/mjacobus/koine-event-manager
 licenses:
@@ -138,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Event Manager for ruby

data/lib/koine/event_manager/event_manager_aware.rb

@@ -1,13 +0,0 @@
-module Koine
-  module EventManager
-    module EventManagerAware
-      def self.included(klass)
-        klass.instance_eval do
-          define_method "event_manager" do
-            Koine::EventManager::EventManager.instance
-          end
-        end
-      end
-    end
-  end
-end