brainguy 0.0.1

data/spec/features/idempotent_events_spec.rb

@@ -0,0 +1,69 @@
+require "rspec"
+require "brainguy"
+
+module Brainguy
+  class WebRequest
+    attr_reader :events
+
+    def initialize
+      @events = Brainguy::IdempotentEmitter.new(self)
+    end
+
+    def successful_response
+      events.emit(:data, "Hello, ")
+      events.emit(:data, "World!")
+      events.emit(:success)
+    end
+  end
+
+  RSpec.describe "idempotent events" do
+    it "replays events when a listener subscribes late" do
+      r = WebRequest.new
+      r.successful_response
+      listener = spy("listener")
+      r.events.attach(listener)
+      expect(listener).to have_received(:call)
+                              .with(Event[:data, r, ["Hello, "]])
+                              .ordered
+      expect(listener).to have_received(:call)
+                              .with(Event[:data, r, ["World!"]])
+                              .ordered
+      expect(listener).to have_received(:call)
+                              .with(Event[:success, r])
+                              .ordered
+    end
+
+    it "replays events when a single-event handler subscribes late" do
+      r = WebRequest.new
+      r.successful_response
+      expect do |b|
+        r.events.on(:data, &b)
+      end.to yield_successive_args("Hello, ", "World!")
+    end
+
+    it "passes events on to existing listeners immediately" do
+      r        = WebRequest.new
+      listener = spy("listener")
+      r.events.attach(listener)
+      r.successful_response
+      expect(listener).to have_received(:call)
+                              .with(Event[:data, r, ["Hello, "]])
+                              .ordered
+      expect(listener).to have_received(:call)
+                              .with(Event[:data, r, ["World!"]])
+                              .ordered
+      expect(listener).to have_received(:call)
+                              .with(Event[:success, r])
+                              .ordered
+    end
+
+    it "does not repeat events to preexisting listeners" do
+      r        = WebRequest.new
+      listener = spy("listener")
+      r.events.attach(listener)
+      r.successful_response
+      r.events.attach(spy("new listener"))
+      expect(listener).to have_received(:call).exactly(3).times
+    end
+  end
+end

data/spec/features/method_scoped_events_spec.rb

@@ -0,0 +1,90 @@
+require "rspec"
+
+require "brainguy"
+
+describe "method-scoped subscription set" do
+  class Kitten
+    def play(&block)
+      Brainguy.with_subscription_scope(self, block) do |events|
+        events.emit(:mew)
+        events.emit(:mew)
+        events.emit(:pounce)
+        events.emit(:hiss)
+        events.emit(:purr)
+      end
+    end
+  end
+
+  it "executes handlers hooked up inside a passed block" do
+    kitten = Kitten.new
+    event_log = []
+    kitten.play do |events|
+      events.on(:hiss) do
+        event_log << :hiss
+      end
+      events.on(:pounce) do
+        event_log << :pounce
+      end
+      events.on(:mew) do
+        event_log << :mew
+      end
+    end
+    expect(event_log).to eq([:mew, :mew, :pounce, :hiss])
+  end
+
+  it "executes handlers chained onto the method return value" do
+    kitten = Kitten.new
+    event_log = []
+    listener  = spy("listener")
+    kitten.play.on(:purr) do
+      event_log << :purr
+    end.on(:pounce) do
+      event_log << :pounce
+    end.on(:mew) do
+      event_log << :mew
+    end.attach(listener)
+    expect(event_log).to eq([:purr, :pounce, :mew, :mew])
+    expect(listener).to have_received(:call).with(Brainguy::Event[:mew, kitten]).twice
+    expect(listener).to have_received(:call).with(Brainguy::Event[:pounce, kitten])
+    expect(listener).to have_received(:call).with(Brainguy::Event[:hiss, kitten])
+    expect(listener).to have_received(:call).with(Brainguy::Event[:purr, kitten])
+  end
+
+  it "returns nil when passed a block" do
+    kitten = Kitten.new
+    result = kitten.play do
+    end
+    expect(result).to be_nil
+  end
+
+  class Dog
+    include Brainguy::Observable
+
+    def play_fetch
+      emit(:chase_stick)
+    end
+
+    def play(&block)
+      with_subscription_scope(block) do |events|
+        emit(:bark)
+        play_fetch
+        emit(:pant)
+      end
+    end
+  end
+
+  it "can be used in conjunction with an Observable object" do
+    dog = Dog.new
+    lifetime_listener = spy("lifetime listener")
+    scoped_listener   = spy("scoped listener")
+    dog.events.attach(lifetime_listener)
+    dog.play do |events|
+      events.attach(scoped_listener)
+    end
+    dog.play_fetch
+    expect(lifetime_listener)
+        .to have_received(:call).with(Brainguy::Event[:chase_stick, dog]).twice
+    expect(scoped_listener)
+        .to have_received(:call).with(Brainguy::Event[:chase_stick, dog]).once
+  end
+end

data/spec/support/shared_examples_for_eventful_modules.rb

@@ -0,0 +1,36 @@
+module Brainguy
+  RSpec.shared_examples "an eventful module" do |the_module|
+    let(:coffee_maker_class) {
+      Class.new do
+
+        include the_module
+
+        def make_coffee
+          emit(:heat)
+          emit(:drip)
+          emit(:done)
+        end
+      end
+    }
+
+    it "adds an #events attribute" do
+      cm = coffee_maker_class.new
+      cm.respond_to?(:events)
+    end
+
+    it "adds an #on method for attaching listeners" do
+      cm    = coffee_maker_class.new
+      probe = spy
+      cm.on(:done) do
+        probe.coffee_done
+      end
+      cm.make_coffee
+      expect(probe).to have_received(:coffee_done)
+    end
+
+    it "provides the #emit helper privately" do
+      cm = coffee_maker_class.new
+      expect { cm.emit(:foo) }.to raise_error(NoMethodError)
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: brainguy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Avdi Grimm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: seeing_is_believing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: |-
+  A somewhat fancy observer pattern library with
+  features like named events and scoped subscriptions.
+email:
+- avdi@avdi.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.erb
+- README.markdown
+- Rakefile
+- brainguy.gemspec
+- examples/include_manifestly_observable.rb
+- examples/include_observable.rb
+- examples/include_observer.rb
+- examples/manual_observable.rb
+- examples/open_observer.rb
+- examples/proc_observer.rb
+- examples/scoped_subscription.rb
+- examples/synopsis.rb
+- lib/brainguy.rb
+- lib/brainguy/basic_notifier.rb
+- lib/brainguy/emitter.rb
+- lib/brainguy/error_collecting_notifier.rb
+- lib/brainguy/error_handling_notifier.rb
+- lib/brainguy/event.rb
+- lib/brainguy/fluent_emitter.rb
+- lib/brainguy/full_subscription.rb
+- lib/brainguy/idempotent_emitter.rb
+- lib/brainguy/manifest_emitter.rb
+- lib/brainguy/manifestly_observable.rb
+- lib/brainguy/observable.rb
+- lib/brainguy/observer.rb
+- lib/brainguy/open_observer.rb
+- lib/brainguy/single_event_subscription.rb
+- lib/brainguy/subscription.rb
+- lib/brainguy/subscription_scope.rb
+- lib/brainguy/version.rb
+- scripts/benchmark_listener_dispatch.rb
+- spec/brainguy/emitter_spec.rb
+- spec/brainguy/error_collecting_notifier_spec.rb
+- spec/brainguy/error_handling_notifier_spec.rb
+- spec/brainguy/manifest_emitter_spec.rb
+- spec/brainguy/manifestly_observable_spec.rb
+- spec/brainguy/observable_spec.rb
+- spec/brainguy/observer_spec.rb
+- spec/brainguy/open_observer_spec.rb
+- spec/brainguy/single_event_subscription_spec.rb
+- spec/brainguy/subscription_scope_spec.rb
+- spec/brainguy/subscription_spec.rb
+- spec/features/basics_spec.rb
+- spec/features/idempotent_events_spec.rb
+- spec/features/method_scoped_events_spec.rb
+- spec/support/shared_examples_for_eventful_modules.rb
+homepage: https://github.com/avdi/brainguy
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An Observer pattern library
+test_files:
+- spec/brainguy/emitter_spec.rb
+- spec/brainguy/error_collecting_notifier_spec.rb
+- spec/brainguy/error_handling_notifier_spec.rb
+- spec/brainguy/manifest_emitter_spec.rb
+- spec/brainguy/manifestly_observable_spec.rb
+- spec/brainguy/observable_spec.rb
+- spec/brainguy/observer_spec.rb
+- spec/brainguy/open_observer_spec.rb
+- spec/brainguy/single_event_subscription_spec.rb
+- spec/brainguy/subscription_scope_spec.rb
+- spec/brainguy/subscription_spec.rb
+- spec/features/basics_spec.rb
+- spec/features/idempotent_events_spec.rb
+- spec/features/method_scoped_events_spec.rb
+- spec/support/shared_examples_for_eventful_modules.rb
+has_rdoc: