koine-event_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b203d892bc234ce8366802859308e8c9656da9e
+  data.tar.gz: fd4a6216c688e50ac46ec059cd7cf0c8e1bb9a77
+SHA512:
+  metadata.gz: fbdc01af9f5a357354aadae2fc8350fc5023dd8add92148ac3ffba7dd229519e7ddc8b81656cd347fa919c02e2e4f9f3b06bacdcd355ba327cbc4d8fa40c9ae2
+  data.tar.gz: e175d834d2aa00b61b561996d231d340f3345224ca4f7e09c4f67a8854c2d5b003dc2f57c9eef34da0d86b1cd286b64b1a4f93039a998c62d8809ccaf8edb0db

data/.gitignore

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

data/.scrutinizer.yml

@@ -0,0 +1,15 @@
+checks:
+  ruby:
+    code_rating: true
+    duplicate_code: true
+
+build:
+  tests:
+    override:
+      -
+        command: 'bundle exec rake test:scrutinizer'
+        environment:
+          'SCRUTINIZER_CC_FILE': 'my-coverage'
+        coverage:
+          file: 'my-coverage'
+          format: 'rb-cc'

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundle
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.2
+before_install: gem install bundler -v 1.10.6

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koine-event_manager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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
+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,100 @@
+# Koine::EventManager
+
+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)
+[![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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-event_manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koine-event_manager
+
+## Usage
+
+Here follows a simple example
+
+```ruby
+event_manager = Koine::EventManager::EventManager.new
+
+event_manager.listen_to(UserSignedIn) do |event|
+  WelcomeEmail.new(event.user).send
+end
+```
+
+In your controller, or service:
+
+```ruby
+class UserController < ApplicationController
+  def create
+    @user = User.create(user_params)
+
+    event_manager.trigger(UserSignedIn.new(@user))
+
+    respond_with(@user)
+  end
+end
+```
+
+You can also create event listeners:
+
+```ruby
+class UserListener < Koine::EventManager::EventListener
+  def initializer
+    listen_to(UserSignedIn) do |event|
+      WelcomeEmail.new(event.user).send
+    end
+
+    listen_to(UserRemovedAccount) do |event|
+      PleaseComeBackEmail.new(event.user).send
+    end
+  end
+end
+```
+
+And attach to the event manager:
+
+```ruby
+event_manager = Koine::EventManager::EventManager.new
+event_manager.attach_listener(UserListener.new)
+
+# and of course later, you can detach listeners, if you want
+event_manager.detach_listener(event_manager.listeners.last)
+```
+
+And trigger the event on the event manager
+
+```ruby
+event_manager.trigger(UserSignedIn.new(some_user))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/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/mjacobus/koine-event-manager. 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,27 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+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
+
+  task :coverage do
+    ENV["COVERAGE"] = "true"
+    Rake::Task["test"].invoke
+  end
+
+  task :scrutinizer do
+    ENV["SCRUTINIZER"] = "true"
+    Rake::Task["test"].invoke
+  end
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/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/koine-event_manager.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koine/event_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "koine-event_manager"
+  spec.version       = Koine::EventManager::VERSION
+  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"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    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"
+  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 "minitest"
+  spec.add_development_dependency "scrutinizer-ocular"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+end

data/lib/koine/event_manager/event_listener.rb

@@ -0,0 +1,30 @@
+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
+      end
+
+      def trigger(event_object)
+        listeners_for(event_object.class).each do |block|
+          block.call(event_object)
+        end
+      end
+
+      def listeners_for(event)
+        listeners[key_for(event)] ||= []
+      end
+
+      private
+
+      def key_for(object_or_class)
+        object_or_class.to_s
+      end
+
+      def listeners
+        @listeners ||= {}
+      end
+    end
+  end
+end

data/lib/koine/event_manager/event_manager.rb

@@ -0,0 +1,33 @@
+module Koine
+  module EventManager
+    class EventManager
+      def initialize
+        @internal_listener = EventListener.new
+      end
+
+      def listen_to(event, &block)
+        @internal_listener.listen_to(event, &block)
+      end
+
+      def attach_listener(listener)
+        listeners << listener
+      end
+
+      def detach_listener(listener)
+        listeners.delete(listener)
+      end
+
+      def trigger(event)
+        @internal_listener.trigger(event)
+
+        listeners.each do |listener|
+          listener.trigger(event)
+        end
+      end
+
+      def listeners
+        @listners ||= []
+      end
+    end
+  end
+end

data/lib/koine/event_manager/version.rb

@@ -0,0 +1,5 @@
+module Koine
+  module EventManager
+    VERSION = "1.0.0"
+  end
+end

data/lib/koine/event_manager.rb

@@ -0,0 +1,9 @@
+require "koine/event_manager/version"
+require "koine/event_manager/event_manager"
+require "koine/event_manager/event_listener"
+
+module Koine
+  module EventManager
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: koine-event_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-14 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: scrutinizer-ocular
+  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: 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: simplecov
+  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'
+description: Event Manager for ruby
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".scrutinizer.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koine-event_manager.gemspec
+- lib/koine/event_manager.rb
+- lib/koine/event_manager/event_listener.rb
+- lib/koine/event_manager/event_manager.rb
+- lib/koine/event_manager/version.rb
+homepage: https://github.com/mjacobus/koine-event-manager
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Event Manager for ruby
+test_files: []