block_registry 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0368cee336a9e621f5ca76133d3fbac94b78ce79
+  data.tar.gz: 14be337ed79624ec9c4bd267ca44eacf82a1b7ef
+SHA512:
+  metadata.gz: fcfa395825ef64785556969a7854cba56111a21af831ef36cd7e04443b1b58d622fc13b01623d14061c5b026f7e6b5a5dedfa93e8461ee97eb1f8c52d3be0b52
+  data.tar.gz: 0bebe41bfb48455d7893359a26bd6556862ddb44c5de0e3c74489f37b4dad4ddfd75d490d0282316d1133cf7e5729ae44b3cf9fb9807e674a4a6b8597f9bd5d5

data/.codeclimate.yml

@@ -0,0 +1,9 @@
+---
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.idea/
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+block_registry

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 mhuggins
+
+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,126 @@
+# BlockRegistry
+
+Register event handlers to key lookups.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'block_registry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install block_registry
+
+## Usage
+
+Create a `BlockRegistry` instance:
+
+```ruby
+registry = BlockRegistry.new
+```
+
+Register keys with a processing block:
+
+```ruby
+registry.register('user-login') do |email|
+  user = User.find_by(email: email)
+  puts "User #{user.email} logged in" if user
+end
+
+registry.register('user-register') do |email, password|
+  user = User.create(email: email, password: password)
+  puts "User #{user.email} registered" if user.persisted?
+end
+```
+
+Call the handler with appropriate arguments:
+
+```ruby
+registry.handle('user-register', 'joe@example.com', 'MyPassword123')
+registry.handle('user-login', 'joe@example.com')
+```
+
+### `BlockRegistry#register`
+
+Registers a handler to a key.  Expects a key name and a block whose arity matches that used by
+`BlockRegistry#handle`.  Multiple handlers can be defined for a single key.
+
+```ruby
+registry.register('private-message') do |sender_id, recipient_id, message|
+  Message.create!(sender_id: sender_id, recipient_id: recipient_id, message: message)
+end
+
+registry.register('private-message') do |sender_id, recipient_id, message|
+  NewRelic::Agent.notify('private-message', sender_id: sender_id, recipient_id: recipient_id, message: message)
+end
+```
+
+### `BlockRegistry#registered?`
+
+Returns true or false to signify whether any handlers exist for a given key.
+
+```ruby
+registry.register('user-register', &block)
+registry.registered?('user-register')  # => true
+registry.registered?('user-login')     # => false
+```
+
+### `BlockRegistry#unregister`
+
+Unregisters one or all handlers for a key.  If a block is given, the matching handler is
+unregistered.  If no block is given, then all handlers for the key are unregistered.
+
+```ruby
+block = ->(email) do
+  puts "#{email} signed up"
+end
+
+registry.register('user-register', &block)
+registry.register('user-register') do |email|
+  puts 'another handler'
+end
+
+registry.unregister('user-register', &block)
+registry.registered?('user-register')  # => true
+
+registry.unregister('user-register')
+registry.registered?('user-register')  # => false
+```
+
+### `BlockRegistry#handles?`
+
+Alias for [`BlockRegistry#registered?`](#BlockRegistry_registered)
+
+### `BlockRegistry#handle`
+
+Processes a message across all handlers for the given key.
+
+```ruby
+registry.register('user-register') { |email| puts "#{email} signed up" }
+registry.register('user-register') { |email| puts "hi, #{email}" }
+
+registry.handle('user-register', 'joe@example.com')
+# => joe@example.com signed up
+# => hi, joe@example.com
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/kapost/block_registry.
+
+## 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 'block_registry'
+
+# 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/block_registry.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'block_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'block_registry'
+  spec.version       = BlockRegistry::VERSION
+  spec.authors       = ['Matt Huggins']
+  spec.email         = ['matt.huggins@kapost.com']
+
+  spec.summary       = 'Simple event handler registry'
+  spec.description   = 'Register event handlers to key lookups.'
+  spec.homepage      = 'https://github.com/kapost/block_registry'
+  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/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.2.3
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.10.6

data/lib/block_registry.rb

@@ -0,0 +1,42 @@
+require 'block_registry/errors'
+require 'block_registry/version'
+require 'set'
+
+class BlockRegistry
+  def initialize
+    self.mappings = {}
+  end
+
+  def register(key, &block)
+    mappings[key] ||= Set.new
+    mappings[key] << block
+  end
+
+  def unregister(key, &block)
+    raise UnregisteredError, "\"#{key}\" is not registered" unless registered?(key)
+
+    if block_given?
+      mappings[key].delete?(block)
+      mappings.delete(key) if mappings[key].empty?
+    else
+      mappings.delete(key)
+    end
+  end
+
+  def registered?(key)
+    mappings.has_key?(key)
+  end
+  alias_method :handles?, :registered?
+
+  def handle(key, *args)
+    raise UnregisteredError, "\"#{key}\" is not registered" unless registered?(key)
+
+    mappings[key].each do |mapping|
+      mapping.call(*args)
+    end
+  end
+
+  private
+
+  attr_accessor :mappings
+end

data/lib/block_registry/errors.rb

@@ -0,0 +1,4 @@
+class BlockRegistry
+  class Error < StandardError; end
+  class UnregisteredError < Error; end
+end

data/lib/block_registry/version.rb

@@ -0,0 +1,3 @@
+class BlockRegistry
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: block_registry
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Huggins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-02 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: rspec
+  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: Register event handlers to key lookups.
+email:
+- matt.huggins@kapost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- block_registry.gemspec
+- circle.yml
+- lib/block_registry.rb
+- lib/block_registry/errors.rb
+- lib/block_registry/version.rb
+homepage: https://github.com/kapost/block_registry
+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: Simple event handler registry
+test_files: []