wisper 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'guard'
+gem 'guard-rspec'
+gem 'rb-fsevent', '~>0.9.1'
+
+gem 'flay'

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,100 @@
+# Wisper
+
+Simple pub/sub for Ruby objects
+
+While this is not dependent on Rails in any way it was extracted from a Rails
+project and is used as an alternative to ActiveRecord callbacks and Observers.
+
+The problem with callbacks and Observers is that they always happen. How many
+times have you wanted to do `User.create` without firing off a welcome email?
+
+It is also super useful for integrating web socket notifications, statistics
+and activity streams in to your controller layer without coupling them to your 
+models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wisper'
+
+## Usage
+
+```
+class CreateThing
+  include Wisper
+
+  def execute(attributes)
+    thing = Thing.new(attributes)
+    if thing.valid?
+      thing.save!
+      broadcast(:create_thing_successful, thing)
+    else
+      broadcast(:create_thing_failed, thing)
+    end
+  end
+end
+
+class ThingsController < ApplicationController
+  def create
+    command = CreateThing.new
+
+    command.add_listener(PusherListener.new)
+    command.add_listener(ActivityListener.new)
+    command.add_listener(StatisticsListener.new)
+
+    command.respond_to(:create_thing_successful) do |thing|
+      redirect_to thing
+    end
+
+    command.respond_to(:create_thing_failed) do |thing|
+      @thing = thing
+      render :action => :new
+    end
+
+    command.execute(params[:thing])
+  end
+end
+
+class PusherListener
+  def create_thing_successful(thing)
+    # ...
+  end
+end
+
+class ActivityListener
+  def create_thing_successful(thing)
+    # ...
+  end
+end
+
+class StatisticsListener
+  def create_thing_successful(thing)
+    # ...
+  end
+end
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Kris Leech
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/wisper.rb

@@ -0,0 +1,65 @@
+require "wisper/version"
+
+module Wisper
+  include ActiveSupport::Concern
+
+  def listeners
+    @listeners ||= Set.new
+  end
+
+  def add_listener(listener, options = {})
+    listeners << ObjectRegistration.new(listener, options)
+  end
+
+  def add_block_listener(options = {}, &block)
+    listeners << BlockRegistration.new(block, options)
+  end
+
+  # sugar
+  def respond_to(event, &block)
+    listeners << BlockRegistration.new(block, :on => event)
+  end
+
+  class BlockRegistration
+    attr_reader :on, :listener
+
+    def initialize(block, options)
+      @listener   = block
+      @on = Array(options.fetch(:on) { 'all' }).map(&:to_s)
+    end
+
+    def broadcast(event, *args)
+      if on.include?(event) || on.include?('all')
+        listener.call(*args)
+      end
+    end
+  end
+
+  class ObjectRegistration
+    attr_reader :on, :listener
+
+    def initialize(listener, options)
+      @listener   = listener
+      @method     = options[:method]
+      @on = Array(options.fetch(:on) { 'all' }).map(&:to_s)
+    end
+
+    def broadcast(event, *args)
+      if (on.include?(event) || on.include?('all')) && listener.respond_to?(event)
+        listener.public_send(event, *args) 
+      end
+    end
+  end
+
+  private
+
+  def broadcast(event, *args)
+    listeners.each do | listener |
+      listener.broadcast(clean_event(event), *args) 
+    end
+  end
+
+  def clean_event(event)
+    event.to_s.gsub('-', '_')
+  end
+end

data/lib/wisper/version.rb

@@ -0,0 +1,3 @@
+module Wisper
+  VERSION = "0.0.1"
+end

data/spec/lib/integration_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+# Example
+class MyCommand
+  include Wisper
+
+  def execute(be_successful)
+    if be_successful
+      broadcast('success', 'hello')
+    else
+      broadcast('failure', 'world')
+    end
+  end
+end
+
+describe Wisper do
+
+  it 'subscribes object to all published events' do
+    listener = double('listener')
+    listener.should_receive(:success).with('hello')
+
+    command = MyCommand.new
+
+    command.add_listener(listener)
+
+    command.execute(true)
+  end
+
+  it 'subscribes block to all published events' do
+    insider = double('Insider')
+    insider.should_receive(:render).with('hello')
+
+    command = MyCommand.new
+
+    command.add_block_listener do |message|
+      insider.render(message)
+    end
+
+    command.execute(true)
+  end
+end

data/spec/lib/wisper_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Wisper do
+  let(:listener)  { double('listener') }
+  let(:publisher) { Object.new.extend(Wisper) }
+
+  describe '.add_listener' do
+    it 'subscribes listener to all published events' do
+      listener.should_receive(:this_happened)
+      listener.should_receive(:so_did_this)
+
+      publisher.add_listener(listener)
+
+      publisher.send(:broadcast, 'this_happened')
+      publisher.send(:broadcast, 'so_did_this')
+    end
+
+    it 'subscribes listener to selected events' do
+      listener.should_receive(:this_happened)
+      listener.stub(:so_did_this)
+      listener.should_not_receive(:so_did_this)
+
+      listener.respond_to?(:so_did_this).should be_true
+
+      publisher.add_listener(listener, :on => 'this_happened')
+
+      publisher.send(:broadcast, 'this_happened')
+      publisher.send(:broadcast, 'so_did_this')
+    end
+
+    it 'does not receive events it can not respond to' do
+      listener.should_not_receive(:so_did_this)
+      listener.stub(:respond_to?, false)
+
+      listener.respond_to?(:so_did_this).should be_false
+
+      publisher.add_listener(listener, :on => 'so_did_this')
+
+      publisher.send(:broadcast, 'so_did_this')
+    end
+  end
+
+  describe 'Block listeners' do
+    it 'subscribes block to all events' do
+      insider = double('insider')
+      insider.should_receive(:it_happened)
+
+      publisher.add_block_listener do
+        insider.it_happened
+      end
+
+      publisher.send(:broadcast, 'something_happened')
+    end
+
+    it 'subscribes block to selected events' do
+      insider = double('insider')
+      insider.should_not_receive(:it_happened)
+
+      publisher.add_block_listener(:on => 'this_thing_happened') do
+        insider.it_happened
+      end
+
+      publisher.send(:broadcast, 'something_happened')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'active_support'
+require 'wisper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/wisper.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "wisper"
+  gem.version       = Wisper::VERSION
+  gem.authors       = ["Kris Leech"]
+  gem.email         = ["kris.leech@gmail.com"]
+  gem.description   = %q{pub/sub for Ruby objects}
+  gem.summary       = %q{pub/sub for Ruby objects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'active_support'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: wisper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: pub/sub for Ruby objects
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/wisper.rb
+- lib/wisper/version.rb
+- spec/lib/integration_spec.rb
+- spec/lib/wisper_spec.rb
+- spec/spec_helper.rb
+- wisper.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -961177691427387453
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -961177691427387453
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: pub/sub for Ruby objects
+test_files:
+- spec/lib/integration_spec.rb
+- spec/lib/wisper_spec.rb
+- spec/spec_helper.rb