event-bus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0acc21d9d8537e3f35b313333a293649a0c4aeb4
+  data.tar.gz: ba114e08659603bda5d5d0b0be739d0f244be7a2
+SHA512:
+  metadata.gz: 939ddf5539f90fb5298bf4d741408e2a36cf5d6277fd9b30851b602487b1c349090bc84217ef22cba30a2b263f18c340e259b2937f918168814d8a3737f9eece
+  data.tar.gz: 2da980710a514e0bb75f7befccb5f044017cb5e5d85a7a43eb65484bc1c2549ca9b16770bfbb9fa5ee1adee166f033b200ad26e08ce2f768ff5793fa01f177e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--order rand
+--color

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/event/name_resolver.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/event/name_resolver.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/event/name_resolver.rb
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/event/name_resolver.rb

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/spec/"
+  add_filter "/tmp"
+  add_filter "/vendor"
+  
+  add_group "lib", "lib"
+end

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+env:
+  - CI=1
+language: ruby
+bundler_args: --without development debug profile
+rvm:
+  - 2.1.7
+  - 2.2.3
+script: script/test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor 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.
+
+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.
+
+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.
+
+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.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+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/)

data/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing
+
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/cucumber/event-bus/issues
+
+## Submitting an Issue
+
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. 
+
+When submitting a bug report, please include a [Gist][] that includes a *stack
+trace* and any details that may be necessary to reproduce the bug, including
+your *gem version*, *Ruby version*, and *operating system*. Ideally, a bug report
+should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+
+1. [Fork the repository.][fork]
+2. Create a topic [branch]. `git checkout -b local_topic_branch`
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes. To push your topic branch use `git push -u origin local_topic_branch`.
+8. [Submit a pull request.][pr]
+
+Here are some reasons why a pull request may not be merged:
+
+1. It hasn’t been reviewed.
+2. It doesn’t include specs for new functionality.
+3. It doesn’t include documentation for new functionality.
+4. It changes behavior without changing the relevant documentation, comments, or specs.
+5. It changes behavior of an existing public API, breaking backward compatibility.
+6. It breaks the tests on a supported platform.
+7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).
+
+Include this emoji in the top of your ticket to signal to us that you read this
+file: :memo:
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/articles/fork-a-repo#create-branches
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event-bus.gemspec
+gemspec
+
+group :debug do
+  gem 'pry'
+  gem 'byebug'
+  gem 'pry-doc', require: false
+  gem 'pry-byebug', require: false
+end
+
+group :development, :test do
+  gem 'aruba', '~>0.10.0', require: false
+  gem 'awesome_print', require: 'ap'
+  gem 'coveralls', require: false
+  gem 'cucumber', require: false
+  gem 'fuubar', require: false
+  gem 'github-markup'
+  gem 'inch', require: false
+  gem 'license_finder'
+  gem 'rake', '~>10.0.0', require: false
+  gem 'rubocop', require: false
+  gem 'simplecov', require: false
+  gem 'tmrb', require: false
+  gem 'versionomy', require: false
+  gem 'yard', require: false
+  gem 'rspec', require: false
+end
+
+group :profile do
+  gem 'ruby-prof'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dennis Günnewig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dennis Günnewig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Event Bus
+
+[![Build Status](https://travis-ci.org/cucumber/event-bus.svg?branch=master)](https://travis-ci.org/cucumber/event-bus)
+[![Code Climate](https://codeclimate.com/github/cucumber/event-bus.svg)](https://codeclimate.com/github/cucumber/event-bus)
+[![Coverage Status](https://coveralls.io/repos/cucumber/event-bus/badge.svg?branch=master)](https://coveralls.io/r/cucumber/event-bus?branch=master)
+[![Gem Version](https://badge.fury.io/rb/event-bus.svg)](http://badge.fury.io/rb/proxy_pac_rb)
+[![Downloads](http://img.shields.io/gem/dt/event-bus.svg?style=flat)](http://rubygems.org/gems/proxy_pac_rb)
+
+
+This gem helps you to setup an event bus for your library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'event-bus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event-bus
+
+## Usage
+
+Please have a look at [features/bus.feature](https://github.com/cucumber/event-bus/blob/master/features/bus.feature) for an
+example application.
+
+## Development
+
+After checking out the repo, run `script/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `script/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/cucumber/event-bus. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+
+namespace :gem do
+  require 'bundler/gem_tasks'
+end
+
+desc 'Default task'
+task default: :test
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+
+desc 'Run test suite'
+task test: %w(test:rubocop test:rspec test:cucumber)
+
+namespace :test do
+  desc 'Test with coveralls'
+  task coveralls: %w(test coveralls:push)
+
+  desc 'Run rspec'
+  task :rspec do
+    sh 'bundle exec rspec'
+  end
+
+  desc 'Run cucumber'
+  task :cucumber do
+    sh 'bundle exec cucumber'
+  end
+
+  desc 'Run cucumber'
+  task :rubocop do
+    sh 'bundle exec rubocop'
+  end
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+wip: --tags @wip:3 --tags ~@broken --tags ~@broken-external
+default: --tags ~@wip --tags ~@broken --tags ~@broken-external

data/event-bus.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'event/bus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'event-bus'
+  spec.version       = Event::Bus::VERSION
+  spec.authors       = ['Dennis Günnewig']
+  spec.email         = ['dg1@ratiodata.de']
+
+  spec.summary       = 'Notify subscribers about event'
+  spec.description   = 'This gem notifies subscribers about event'
+  spec.homepage      = 'https://github.com/cucumber/event-bus'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+end

data/fixtures/simple_app/bin/simple_app

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'simple_app'
+runner = SimpleApp::Runner.new
+runner.start

data/fixtures/simple_app/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/fixtures/simple_app/lib/simple_app.rb

@@ -0,0 +1,6 @@
+require 'simple_app/version'
+require 'even/bus'
+
+# Simple App
+module SimpleApp
+end

data/fixtures/simple_app/lib/simple_app/version.rb

@@ -0,0 +1,5 @@
+# Simple App
+module SimpleApp
+  # Version
+  VERSION = '0.1.0'
+end

data/fixtures/simple_app/simple_app.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_app/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_app'
+  spec.version       = SimpleApp::VERSION
+  spec.authors       = ['Example Author']
+  spec.email         = ['mail@example.org']
+
+  spec.summary       = 'Simple App'
+  spec.description   = 'This is a simple app'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/fixtures/simple_app/spec/simple_app_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SimpleApp do
+  it 'has a version number' do
+    expect(SimpleApp::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/fixtures/simple_app/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simple_app'

data/lib/event/bus.rb

@@ -0,0 +1,37 @@
+require 'event/name_resolver'
+require 'event/errors'
+
+module Event
+  # Event bus
+  #
+  # Implements and in-process pub-sub events broadcaster allowing multiple observers
+  # to subscribe to different events that fire as your tests are executed.
+  #
+  class Bus
+    def initialize(resolver)
+      @resolver = resolver
+      @handlers = Hash.new { |h, k| h[k] = [] }
+    end
+
+    # Register for an event
+    def register(event_id, handler_object = nil, &handler_proc)
+      handler = handler_proc || handler_object
+
+      fail ArgumentError, 'Please pass either an object#call or a handler block' if handler.nil? || !handler.respond_to?(:call)
+
+      event_class = @resolver.transform(event_id)
+
+      fail EventNameResolveError, %(Transforming "#{event_id}" into an event name failed for unknown reason.) if event_class.nil?
+      @handlers[event_class.to_s] << handler
+
+      nil
+    end
+
+    # Broadcast an event
+    def notify(event)
+      fail NoEventError, 'Please pass an event object, not a class' if event.is_a?(Class)
+
+      @handlers[event.class.to_s].each { |handler| handler.call(event) }
+    end
+  end
+end

data/lib/event/bus/version.rb

@@ -0,0 +1,7 @@
+# Event
+module Event
+  # Bus
+  class Bus
+    VERSION = '0.1.0'
+  end
+end

data/lib/event/errors.rb

@@ -0,0 +1,5 @@
+module Event
+  # Raised if an event name cannot be resolved
+  class EventNameResolveError < StandardError; end
+  class NoEventError < StandardError; end
+end

data/lib/event/name_resolver.rb

@@ -0,0 +1,65 @@
+require 'event/errors'
+
+# Event notification library
+module Event
+  # Resolve name to Event name
+  class NameResolver
+    def initialize(default_namespace)
+      @default_namespace = default_namespace
+    end
+
+    def transform(event_id)
+      case event_id
+      when Class
+        event_id
+      when String
+        constantize(event_id)
+      else
+        constantize("#{@default_namespace}::#{camel_case(event_id)}")
+      end
+    rescue => e
+      raise EventNameResolveError, %(Transforming "#{event_id}" into an event class failed: #{e.message}.)
+    end
+
+    private
+
+    def camel_case(underscored_name)
+      underscored_name.to_s.split('_').map { |word| word.upcase[0] + word[1..-1] }.join
+    end
+
+    # Thanks ActiveSupport
+    # (Only needed to support Ruby 1.9.3 and JRuby)
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split('::')
+
+      # Trigger a built-in NameError exception including the ill-formed constant in the message.
+      Object.const_get(camel_cased_word) if names.empty?
+
+      # Remove the first blank element in case of '::ClassName' notation.
+      names.shift if names.size > 1 && names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check if it is owned directly. The check
+          # stops when we reach Object or the end of ancestors tree.
+          # rubocop:disable Style/EachWithObject
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+            const
+          end
+          # rubocop:enable Style/EachWithObject
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'event/bus'
+
+require 'pry'
+PRY.start

data/script/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/script/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rake test

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: event-bus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Günnewig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: This gem notifies subscribers about event
+email:
+- dg1@ratiodata.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- cucumber.yml
+- event-bus.gemspec
+- fixtures/simple_app/bin/simple_app
+- fixtures/simple_app/features/support/env.rb
+- fixtures/simple_app/lib/simple_app.rb
+- fixtures/simple_app/lib/simple_app/version.rb
+- fixtures/simple_app/simple_app.gemspec
+- fixtures/simple_app/spec/simple_app_spec.rb
+- fixtures/simple_app/spec/spec_helper.rb
+- lib/event/bus.rb
+- lib/event/bus/version.rb
+- lib/event/errors.rb
+- lib/event/name_resolver.rb
+- script/console
+- script/setup
+- script/test
+homepage: https://github.com/cucumber/event-bus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Notify subscribers about event
+test_files: []
+has_rdoc: