wisper_subscription 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 912d8f12cd963ba1e732752590ca8c86022fae28
+  data.tar.gz: 71b57abd56add0f8163f9757d17589893844fdcd
+SHA512:
+  metadata.gz: 5dc155254a0c2aebc81902f451be952d8d3cd2b4c4b54a3218be998dcd4bc6c1d5861fa36cd8669f8dee5556ebc979abdf329cf809f62ce43855362889e95580
+  data.tar.gz: 36759f7dad409e02d1d1713bf8f293603a60f11e1e01373885e92f02242802edcac2d6b115c215b39f6374ff6dbe1350c87ca991a4e4839627ce8e14700f3bc8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff Dickey
+
+MIT License
+
+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 @@
+# WisperSubscription
+
+[![Join the chat at https://gitter.im/jdickey/wisper_subscription](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jdickey/wisper_subscription?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Gem Version](https://badge.fury.io/rb/wisper_subscription.svg)](http://badge.fury.io/rb/wisper_subscription)
+[![Code Climate](https://codeclimate.com/github/jdickey/wisper_subscription.png)](https://codeclimate.com/github/jdickey/wisper_subscription)
+[ ![Codeship Status for jdickey/wisper_subscription](https://codeship.com/projects/2e3dfaa0-8950-0132-3d83-4e5a44c3ddcb/status?branch=master)](https://codeship.com/projects/59675)
+[![security](https://hakiri.io/github/jdickey/wisper_subscription/master.svg)](https://hakiri.io/github/jdickey/wisper_subscription/master)
+[![Dependency Status](https://gemnasium.com/jdickey/wisper_subscription.svg)](https://gemnasium.com/jdickey/wisper_subscription)
+
+This Gem contains a class, `WisperSubscription`, which encapsulates an extremly
+simple container to record call parameters for messages, and query methods for
+whether a defined message was sent. This is a refinement of a class
+[originally developed](https://github.com/jdickey/new_poc/blob/c255cbd/spec/support/broadcast_success_tester.rb)
+to record results of very specific [Wisper](https://github.com/krisleech/wisper)
+broadcast messages to support testing of broadcasters of such messages. While
+[restructuring that app](https://github.com/jdickey/new_poc/issues/54), the
+existing `BroadcastSuccessTester` was identified as a dependency of the testing
+for [*multiple*](https://github.com/jdickey/new_poc/issues/173) to-be-decoupled
+classes. Including that test-support class in so many redundant places would have
+been an engraved invitation to sync-related bugs (and egregious waste), and so
+this `WisperSubscription` class/Gem was created.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wisper_subscription'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wisper_subscription
+
+## Usage
+
+Remember that this was originally developed to support testing Wisper message
+broadcast from an object. So you might have an RSpec file (Minitest would be
+similar) that had excerpts [similar to](https://github.com/jdickey/new_poc/blob/c255cbd/spec/actions/index_users_spec.rb):
+
+```ruby
+describe SomeWisperPublishingClass do
+  let(:subscriber) { WisperSubscription.new }
+  let(:command_params) do
+    # ...
+  end
+  let(:command) { described_class.new command_params }
+
+  before :each do
+    # some setup
+    subscriber.define_message :success
+    subscriber.define_Message :failure
+    command.subscribe subscriber
+    command.do_something_that_broadcasts_a_success
+  end
+
+  it 'was successful' do
+    payload = subscriber.payload_for(:success).to_a.first
+    expect(payload).to be_a WhatYouExpectOnSuccess # as opposed to nil
+  end
+
+  # ...
+end
+```
+
+You get the idea. If not, open an issue or ask on our Gitter channel.
+
+## Contributing
+
+1. Fork it ( https://github.com/jdickey/wisper_subscription/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Ensure that your changes are completely covered by *passing* specs, and comply with the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) as enforced by [RuboCop](https://github.com/bbatsov/rubocop). To verify this, run `bundle exec rake`, noting and repairing any lapses in coverage or style violations;
+1. Commit your changes (`git commit -a`). Please *do not* use a single-line commit message (`git commit -am "some message"`). A good commit message notes what was changed and why in sufficient detail that a relative newcomer to the code can understand your reasoning and your code;
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request. Describe at some length the rationale for your new feature; your implementation strategy at a higher level than each individual commit message; anything future maintainers should be aware of; and so on. *If this is a modification to existing code, reference the open issue being addressed*.
+1. Don't be discouraged if the PR generates a discussion that leads to further refinement of your PR through additional commits. These should *generally* be discussed in comments on the PR itself; discussion in the Gitter room (see below) may also be useful;
+1. If you've comments, questions, or just want to talk through your ideas, come hang out in the project's [room on Gitter](https://gitter.im/jdickey/wisper_subscription). Ask away!

data/Rakefile

@@ -0,0 +1,20 @@
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = [
+    'lib/**/*.rb',
+    'spec/spec_helper.rb',
+    'spec/**/*_spec.rb'
+  ]
+  task.formatters = ['simple', 'd']
+  task.fail_on_error = true
+  # task.options << '--rails'
+end
+
+RSpec::Core::RakeTask.new :spec
+
+task(:default).clear
+task default: [:spec, :rubocop]

data/lib/wisper_subscription/version.rb

@@ -0,0 +1,5 @@
+
+# Collects and reports on messages sent to an instance.
+class WisperSubscription
+  VERSION = '0.1.1'
+end

data/lib/wisper_subscription.rb

@@ -0,0 +1,60 @@
+
+require 'wisper_subscription/version'
+
+# Collects and reports on messages sent to an instance.
+class WisperSubscription
+  def initialize
+    @internals = {}
+    @empty_payload = []
+    @query_pattern = /^.*\?$/
+  end
+
+  def define_message(message)
+    @message = message
+    add_internals_entry
+    add_query_method
+    add_responder_method
+    self
+  end
+
+  def payload_for(message)
+    return empty_payload unless @internals.key? message
+    @internals[message]
+  end
+
+  def method_missing(method_sym, *arguments, &block)
+    return false if method_sym.to_s =~ query_pattern
+    super
+  end
+
+  def respond_to?(symbol, include_all = false)
+    return true if symbol.to_s =~ query_pattern
+    super
+  end
+
+  private
+
+  attr_reader :empty_payload, :query_pattern
+
+  def add_internals_entry
+    @internals[@message.to_sym] = []
+    self
+  end
+
+  def add_query_method
+    message = @message
+    define_singleton_method "#{@message}?".to_sym do
+      !@internals[message].to_a.empty?
+    end
+    self
+  end
+
+  def add_responder_method
+    message = @message
+    define_singleton_method @message.to_sym do |*params|
+      @internals[message].push params
+      self
+    end
+    self
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+
+require 'simplecov'
+SimpleCov.start do # 'rails'
+  add_filter '/spec/'
+  add_filter '/vendor/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'wisper_subscription'

data/spec/wisper_subscription_spec.rb

@@ -0,0 +1,132 @@
+
+require 'spec_helper'
+
+describe WisperSubscription do
+  let(:obj) { described_class.new }
+  let(:message) { :foo }
+  let(:other_message) { :bar }
+
+  it 'has a version number' do
+    expect(WisperSubscription::VERSION).not_to be nil
+  end
+
+  describe '#initialize' do
+    it 'can be called without parameters' do
+      expect { described_class.new }.not_to raise_error
+    end
+  end # describe '#initialize'
+
+  describe '#define_message' do
+    it 'can be called with a symbol as the single paremter' do
+      expect { obj.define_message message }.not_to raise_error
+    end
+
+    it 'requires a single parameter (only)' do
+      expect(obj.method(:define_message).arity).to eq 1
+    end
+
+    it 'adds a new entry to the internal store' do
+      expect(obj.instance_variable_get(:@internals)).to be_empty
+      obj.define_message message
+      internals = obj.instance_variable_get :@internals
+      expect(internals.keys.length).to eq 1
+    end
+
+    describe 'adds a new' do
+      before :each do
+        obj.define_message message
+        @internals = obj.instance_variable_get :@internals
+      end
+
+      describe 'entry to the internal store that is' do
+        it 'Array-like' do
+          # Reminder: Array#to_ary is the IMPLICIT convert-to-Array method
+          expect(@internals[message]).to respond_to :to_ary
+        end
+
+        it 'initially empty' do
+          expect(@internals[message]).to be_empty
+        end
+
+        it 'keyed to the parameter-specified message' do
+          expect(@internals.keys).to include message
+        end
+      end # describe 'entry to the internal store that is'
+
+      it 'public query method to the class instance' do
+        query = "#{message}?".to_sym
+        expect { obj.method query }.not_to raise_error
+        method = obj.method query
+        expect(method.arity).to eq 0
+      end
+
+      it 'message-responder method to the class instance' do
+        expect { obj.method message }.not_to raise_error
+        method = obj.method message
+        expect(method.arity).to eq(-1)
+      end
+    end # describe 'adds a new'
+  end # describe '#define_message'
+
+  describe '#payload_for' do
+    it 'takes a single parameter' do
+      method = obj.method :payload_for
+      expect(method.arity).to eq 1
+    end
+
+    describe 'returns a no-payloads-received indicator when' do
+      let(:none_received) { [] }
+
+      after :each do
+        expect(obj.payload_for message).to eq none_received
+      end
+
+      it 'no messages have been defined' do
+      end
+
+      it 'other messages have been defined but this message has not been' do
+        obj.define_message other_message
+      end
+
+      it 'the specified message has been defined but not received' do
+        obj.define_message message
+      end
+    end # describe 'returns a no-payloads-received indicator when'
+
+    describe 'returns the payload(s) received for the specified message when' do
+      it 'payloads for that message have been stored' do
+        obj.define_message message
+        expected = 'testing'
+        obj.instance_variable_get(:@internals)[message].push expected
+        expect(obj.payload_for message).to eq Array.new([expected])
+      end
+    end # describe 'returns the payload(s) received for the ... message when'
+  end # describe '#payload_for'
+
+  describe '#respond_to?' do
+    it 'returns true for any query method' do
+      expect(obj).to respond_to :is_that_right?
+      expect(obj).to respond_to :you_dont_say?
+      expect(obj).to respond_to :all_tone_here?
+    end
+
+    it 'returns false for any other undefined method' do
+      expect(obj).not_to respond_to :taunts
+      expect(obj).not_to respond_to :threats
+      expect(obj).not_to respond_to :anything
+    end
+  end # describe '#respond_to?'
+
+  describe '.method_missing' do
+    it 'causes an unknown query method to return false' do
+      expect(obj).not_to be_success
+      expect(obj).not_to be_real
+      expect(obj).not_to be_anything_in_particular
+    end
+
+    it 'raises a NoMethodError for any other undefined method' do
+      message = Regexp.new 'undefined method `bogus\' for'
+      expect { obj.bogus }.to raise_error NoMethodError, message
+    end
+  end # describe '.method_missing'
+end

data/wisper_subscription.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper_subscription/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper_subscription"
+  spec.version       = WisperSubscription::VERSION
+  spec.authors       = ["Jeff Dickey"]
+  spec.email         = ["jdickey@seven-sigma.com"]
+  spec.summary       = %q{Records and reports messages sent using Wisper conventions.}
+  spec.homepage      = "https://github.com/jdickey/wisper_subscription"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_development_dependency 'rubocop', '>= 0.28.0'
+  spec.add_development_dependency 'simplecov', '>= 0.9.1'
+  # spec.add_development_dependency 'awesome_print'
+  # spec.add_development_dependency 'pry-byebug'
+  # spec.add_development_dependency 'pry-doc'
+
+  spec.description   = %q{May be used to subscribe to Wisper broadcasts, or other
+similar mechanisms. Define what messages you want an instance to respond to and,
+when those messages are received, any parameters or "payload" associated with
+each single message is saved for later querying and retrieval. See the README for
+more information.}
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: wisper_subscription
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeff Dickey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: |-
+  May be used to subscribe to Wisper broadcasts, or other
+  similar mechanisms. Define what messages you want an instance to respond to and,
+  when those messages are received, any parameters or "payload" associated with
+  each single message is saved for later querying and retrieval. See the README for
+  more information.
+email:
+- jdickey@seven-sigma.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wisper_subscription.rb
+- lib/wisper_subscription/version.rb
+- spec/spec_helper.rb
+- spec/wisper_subscription_spec.rb
+- wisper_subscription.gemspec
+homepage: https://github.com/jdickey/wisper_subscription
+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
+signing_key: 
+specification_version: 4
+summary: Records and reports messages sent using Wisper conventions.
+test_files:
+- spec/spec_helper.rb
+- spec/wisper_subscription_spec.rb