yeller 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9633a2d2494f3275f605be0b883e85d37e74d4ef
+  data.tar.gz: 54abda822f7917adbd7c9223b73dc54bd002597e
+SHA512:
+  metadata.gz: 1e68fc86c720bec01d42aa4970391f51f0c070757503b4a66c064b1d9bc9cfff2fc1b9c2093cc42cf15f2b6fdf44cf52ba481ccb3546d88d4b450aba7faf6cfa
+  data.tar.gz: 17142e23a6d3b8f7ba5cec6c4a4ba154aa506eca2b52c708fa623ac04ca514a7ab44bd25d3a07b3c910c34b70cb0f9702e1262ed0ffff236f17551fc34245ad6

data/.gitignore

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

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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yeller.gemspec
+gemspec
+
+gem 'simplecov', :group => :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Greg
+
+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,82 @@
+# Yeller
+
+Simple in-process pub sub notifier for ruby. Everything runs inside the process with no queue. All the listeners get notified about events in real time with no repeats. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yeller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yeller
+
+## Usage
+
+There's 2 actions, as you would expect:
+
+### Broadcast
+
+To broadcast a message, just specify the message and the keys (they will be joined into one; this is for complex keys, so that you don't have to build them yourself)
+
+```ruby
+class MyLoudClass
+  def yell!
+    Yeller.broadcast "HELLO, EVERYONE!", "my", "many", "keys"
+  end
+end
+```
+
+and it will publish `"HELLO, EVERYONE!"` to everyone who is subscribed to any of those keys.
+
+The keys can be a string, symbol, array, or hash. The Boradcaster will normalize them. This means that the key `[:a, :b, :c]` is the same as the key `[:c, :a, :b]`
+
+__NOTE__: strings will strip out non-symbolizable characters, so "a@example.com" and "a/example.com" will be the same key: "a_example_com"
+
+### Subscribe
+
+The subscribers define what they listen to and how to respond. 
+
+```ruby
+class MyListenerClass
+  include Yeller::Subscribable
+
+  # the subscribable module provides this method
+  subscribe :react, "keys", "my"
+
+  def self.react( message )
+    puts "received #{message}"
+  end
+end
+```
+
+which will print "received HELLO, EVERYONE!" when `MyLoudClass.yell!` is called.
+
+You can also subscribe on the insance level with 
+
+```ruby
+Yeller.subscribe( MyListenerClass.new, :instance_level_react, "key", "other key" )
+```
+
+## 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/gaorlov/yeller.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yeller"
+
+# 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/lib/yeller/broadcaster.rb

@@ -0,0 +1,25 @@
+module Yeller
+  class Broadcaster
+    
+    def initialize( )
+      @subscribers = SubscriberCollection.new
+    end
+
+    def broadcast( message, *keys )
+      keys.each do |key|
+        normalized_key = Key.normalize(key)
+        @subscribers.find( normalized_key ).each do |subscriber|
+          subscriber.notify( message )
+        end
+      end
+    end
+
+    def subscribe( subscriber_class, method, *keys )
+      keys.each do |key|
+        normalized_key = Key.normalize(key)
+        subscriber = Subscriber.new( subscriber_class, method, normalized_key )
+        @subscribers.add( subscriber )
+      end
+    end
+  end
+end

data/lib/yeller/key.rb

@@ -0,0 +1,16 @@
+module Yeller
+  class Key
+    class << self
+      def normalize( key )
+        if key.is_a? Array
+          string = key.map{|el| el.to_sym }.sort.join("_")
+        elsif key.is_a? Hash
+          string = key.symbolize_keys.sort.flatten.join("_")
+        else
+          string = key.to_s
+        end
+        string.gsub(/[ \\|\/\[\]\{\}.,-:;'"@?<>`~!#$%^&*()+=-]/, "_").to_sym
+      end
+    end
+  end
+end

data/lib/yeller/subscribable.rb

@@ -0,0 +1,13 @@
+module Yeller
+  module Subscribable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self 
+        def subscribe( method, *keys )
+          Yeller.subscribe( self, method, *keys)
+        end
+      end
+    end
+  end
+end

data/lib/yeller/subscriber.rb

@@ -0,0 +1,24 @@
+module Yeller
+  class Subscriber
+    attr_accessor :subscriber_class, :method, :key
+
+    def initialize( subscriber_class, method, key )
+      @subscriber_class = subscriber_class
+      @method           = method
+      @key              = key
+    end
+
+    def ==( comparison_object )
+      comparison_object.equal?(self) ||
+      ( comparison_object.instance_of?(self.class) &&
+        comparison_object.method == method &&
+        comparison_object.key == key )
+    end
+
+    def notify( message )
+      Thread.new do
+        subscriber_class.send( method, message )
+      end
+    end
+  end
+end

data/lib/yeller/subscriber_collection.rb

@@ -0,0 +1,26 @@
+module Yeller
+  class SubscriberCollection
+    def initialize( )
+      @subscribers = {}
+    end
+
+    def add( subscriber )
+      key = subscriber.key
+
+      @subscribers[key] ||= []
+      
+      @subscribers[key] << subscriber
+    end
+
+    def remove( subscriber )
+      key = subscriber.key
+      @subscribers[key] = @subscribers[key].delete_if do |sub|
+        sub == subscriber
+      end 
+    end
+
+    def find( key )
+      @subscribers[key] || []
+    end
+  end
+end

data/lib/yeller/version.rb

@@ -0,0 +1,3 @@
+module Yeller
+  VERSION = "0.1.1"
+end

data/lib/yeller.rb

@@ -0,0 +1,20 @@
+require "yeller/version"
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Yeller
+  autoload :Broadcaster,            "yeller/broadcaster"
+  autoload :Key,                    "yeller/key"
+  autoload :Subscribable,           "yeller/subscribable"
+  autoload :Subscriber,             "yeller/subscriber"
+  autoload :SubscriberCollection,   "yeller/subscriber_collection"
+
+  mattr_accessor :_broadcaster
+  self._broadcaster ||= Broadcaster.new
+
+  delegate :broadcast, :subscribe, to: :_broadcaster
+  
+  module_function :broadcast, :subscribe
+end

data/yeller.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yeller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yeller"
+  spec.version       = Yeller::VERSION
+  spec.authors       = ["Greg"]
+  spec.email         = ["greg@avvo.com"]
+
+  spec.summary       = "Simple in-process pub sub notifier for ruby."
+  spec.homepage      = "https://github.com/gaorlov/yeller"
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: yeller
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Greg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- greg@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yeller.rb
+- lib/yeller/broadcaster.rb
+- lib/yeller/key.rb
+- lib/yeller/subscribable.rb
+- lib/yeller/subscriber.rb
+- lib/yeller/subscriber_collection.rb
+- lib/yeller/version.rb
+- yeller.gemspec
+homepage: https://github.com/gaorlov/yeller
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple in-process pub sub notifier for ruby.
+test_files: []
+has_rdoc: