emittr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2ad0daaae0870209d4e8de5c55bd2f50aec7a3e
+  data.tar.gz: 851f7d38270aec17ee2ce9bb27c4c0818c8266aa
+SHA512:
+  metadata.gz: 4258429a3e7719cbc92585cdcbbf11ba2cf138a1254a779a50b7d27ef400349958a54f0ca7f45e81b18a30f03ae44b4ed387eaf6b6bd6afa7680e269bf282ba6
+  data.tar.gz: d9dfe7936794f27e139d22c85817ef7bf4388b33539e38de57b334dc3ea71627b6e7a0efe9ef8b13b1057356745658dfbf845a6d3aa87b9e60da1fada7702a54

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry', group: :development
+
+gem 'simplecov', require: false, group: :test
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Talysson
+
+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,120 @@
+# Emittr
+
+Emittr is a event emitter for Ruby.
+
+[![Build Status](https://travis-ci.org/talyssonoc/emittr.svg?branch=master)](https://travis-ci.org/talyssonoc/emittr) [![Coverage Status](https://coveralls.io/repos/github/talyssonoc/emittr/badge.svg?branch=master)](https://coveralls.io/github/talyssonoc/emittr?branch=master)
+
+Installation
+------------
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'emittr'
+```
+
+Or install it yourself as:
+
+    $ gem install emittr
+
+Usage
+-----
+
+Emittr can be used in two ways. You can just create an `Emittr::Emitter` instance and use it to emit and listen to events, like this:
+
+```ruby
+emitter = Emittr::Emitter.new
+
+emitter.on :user_connected do |user_name|
+  puts "Hello, #{user_name}"
+end
+
+emitter.emit :user_connected, 'Mr. Anderson'
+```
+
+Or you can include the `Emittr::Events` module into an existent class to make it an event emitter:
+
+```ruby
+class Server
+  include Emittr::Events
+
+  def initialize
+    on(:user_connected) do |user_data|
+      handle_new_connection(user_data)
+    end
+  end
+
+  def handle_new_connection(user_data)
+    # do something clever here
+  end
+end
+
+server = Server.new
+
+server.emit :user_connected, { name: 'Somebody', ip: '127.0.0.1' }
+```
+
+## Add event listeners
+
+### #on(event, callback)
+
+Call `callback` when `event` is emitted.
+
+### #once(event, callback)
+
+Call `callback` when `event` is emitted for the first time, then the `callback` is removed from the listeners list of the given `event`.
+
+### #on_any(callback)
+
+Call `callback` whenever an event is emitted.
+
+### #once_any(callback)
+
+Call `callback` the first time any event is emitted then removes it from list.
+
+## Remove event listeners
+
+### #off(event, callback)
+
+Remove `callback` from `event` callbacks list.
+
+### #off(event)
+
+Removes all callbacks for `event`.
+
+### #off
+
+Removes all callbacks for all events.
+
+### #off_any(callback)
+
+Remove `callback` from list to be run after any event is emitted.
+
+## Emitting events
+
+### #emit(type, *args)
+
+Emit an `event` with all passed `args` as params.
+
+## Retrieving added events
+
+### #listeners_for(event)
+
+Return all callbacks for `event`. Callbacks added with `#on_any` or `#once_any` will not be included.
+
+### #listeners_for_any
+
+Return all callbacks added with `#on_any` or `#once_any`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emittr"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/emittr.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emittr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "emittr"
+  spec.version       = Emittr::VERSION
+  spec.authors       = ["Reynaldo", "Talysson"]
+  spec.email         = ["r.scardinho@gmail.com", "talyssonoc@gmail.com"]
+
+  spec.summary       = %q{A Ruby event emitter implementation.}
+  spec.homepage      = "https://github.com/talyssonoc/emittr"
+  spec.license       = "MIT"
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/emittr.rb

@@ -0,0 +1,7 @@
+require "emittr/version"
+require "emittr/events"
+require "emittr/emitter"
+require "emittr/callback"
+
+module Emittr
+end

data/lib/emittr/callback.rb

@@ -0,0 +1,17 @@
+module Emittr
+  class Callback
+    attr_accessor :wrapper, :callback
+
+    def initialize(&callback)
+      @callback = callback
+    end
+
+    def call(*args)
+      callback.call(*args)
+    end
+
+    def ==(block)
+      callback == block || wrapper == block
+    end
+  end
+end

data/lib/emittr/emitter.rb

@@ -0,0 +1,5 @@
+module Emittr
+  class Emitter
+    include Emittr::Events
+  end
+end

data/lib/emittr/events.rb

@@ -0,0 +1,98 @@
+module Emittr
+  module Events
+    def self.included(klass)
+      klass.__send__ :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def on(event, &block)
+        raise_no_block_error unless block_given?
+
+        listeners[event.to_sym] << ::Emittr::Callback.new(&block)
+        self
+      end
+
+      def off(event=nil, &block)
+        unless event
+          listeners.clear
+          return self
+        end
+
+        if block_given?
+          listeners[event].reject! { |l| l == block }
+        else
+          listeners.delete event
+        end
+
+        self
+      end
+
+      def once(event, &block)
+        raise_no_block_error unless block_given?
+
+        callback = ::Emittr::Callback.new &block
+
+        off_block = Proc.new do |args|
+          callback.call(*args)
+          block_to_send = callback.wrapper || callback.callback
+
+          off(event, &block_to_send)
+        end
+
+        callback.wrapper = off_block
+
+        on(event, &off_block)
+      end
+
+      def on_any(&block)
+        raise_no_block_error unless block_given?
+        on(:*, &block)
+      end
+
+      def off_any(&block)
+        raise_no_block_error unless block_given?
+        off(:*, &block)
+      end
+
+      def once_any(&block)
+        raise_no_block_error unless block_given?
+        once(:*, &block)
+      end
+
+      def emit(event, *payload)
+        emit_any(event, *payload)
+
+        return unless listeners.key? event
+
+        listeners[event].each do |l|
+          l.call(*payload)
+        end
+
+        self
+      end
+
+      def listeners_for(event)
+        listeners[event.to_sym].dup
+      end
+
+      def listeners_for_any
+        listeners[:*].dup
+      end
+
+      private
+
+      def listeners
+        @listeners ||= Hash.new { |h,k| h[k] = [] }
+      end
+
+      def emit_any(event, *payload)
+        any_listeners = listeners[:*]
+        any_listeners.each { |l| l.call(event, *payload) } if any_listeners.any?
+      end
+
+      def raise_no_block_error
+        raise ArgumentError, 'required block not passed'
+      end
+    end
+  end
+end

data/lib/emittr/version.rb

@@ -0,0 +1,3 @@
+module Emittr
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: emittr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Reynaldo
+- Talysson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- r.scardinho@gmail.com
+- talyssonoc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- emittr.gemspec
+- lib/emittr.rb
+- lib/emittr/callback.rb
+- lib/emittr/emitter.rb
+- lib/emittr/events.rb
+- lib/emittr/version.rb
+homepage: https://github.com/talyssonoc/emittr
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby event emitter implementation.
+test_files: []
+has_rdoc: