audible 0.1.0 → 0.2.0

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
 branches:
   only:
     - master
+    - next
 gemfile: Gemfile
 notifications:
   recipients:

data/README.md

@@ -0,0 +1,10 @@
+# Audible
+
+[![Build Status](https://travis-ci.org/ben-biddington/audible.png?branch=master)](https://travis-ci.org/ben-biddington/audible)
+
+A way to configure object communications as an alternative to `Observable`.
+
+## Copyright
+
+Copyright (c) 2013 Ben Biddington. See LICENSE.txt for
+further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/audible.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = "audible"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Biddington"]
-  s.date = "2013-07-11"
+  s.date = "2014-02-06"
   s.description = "Object communications"
   s.email = "ben.biddington@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -22,14 +22,23 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "audible.gemspec",
     "lib/audible.rb",
     "lib/audible/audible.rb",
+    "lib/audible/pidfile.rb",
+    "spec/and_how_it_differs_from_observable_spec.rb",
+    "spec/examples/a_notifying_shell_spec.rb",
+    "spec/examples/logging_as_notifications_spec.rb",
     "spec/listening_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/relaying_notifications/about_the_notifications_spec.rb",
+    "spec/relaying_notifications/can_relay_notifications_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/system.tests/drb/bin/server",
+    "spec/system.tests/drb/drb_observers_spec.rb",
+    "spec/system.tests/drb/support/drb_server.rb"
   ]
   s.homepage = "http://github.com/ben-biddington/audible"
   s.licenses = ["MIT"]

data/lib/audible/audible.rb

@@ -3,6 +3,11 @@ module Audible
     events.each{|e| attach(e, &block)}
   end
 
+  def relay(source, event, opts ={})
+    name = opts[:as] || event
+    source.on(event){|e,args| notify name, args.first}
+  end
+
   protected
 
   def attach(event,&block)

data/lib/audible/pidfile.rb

@@ -0,0 +1,16 @@
+class Pidfile
+  require "fileutils"; extend FileUtils
+
+  class << self
+    def new(pid=$$)
+      File.open path, "w" do |f|
+        f.puts pid
+      end
+    end
+
+    def missing?; false == exists? end
+    def exists?; File.exists? path; end
+    def delete; rm path; end
+    def path; File.join ".", ".pid"; end
+  end
+end

data/spec/and_how_it_differs_from_observable_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+describe "Observable" do
+  let(:an_observable_object) do
+    Class.new do
+      require "observer"; include Observable
+
+      def poke
+        changed
+        notify_observers :poked
+      end
+
+      def tap
+        changed
+        notify_observers :tapped
+      end
+    end.new
+  end
+
+  it "you can register for notifications" do
+    an_observer = Class.new do
+      def update(args)
+        @notified = true
+      end
+      
+      def notified?; @notified === true; end
+    end.new
+    
+    an_observable_object.add_observer(an_observer)
+
+    an_observable_object.poke
+
+    an_observer.must be_notified
+  end
+
+  it "and you can send arguments with your notification" do
+    an_observer = Class.new do
+      def update(args)
+        @args = args
+      end
+      
+      def args; @args; end
+    end.new
+    
+    an_observable_object.add_observer(an_observer)
+
+    an_observable_object.poke
+
+    an_observer.args.must === :poked
+  end
+
+  it "for multiple events the observer must decide for themselves" do
+    an_observer = Class.new do
+      def initialize
+        @poked,@tapped = 0,0
+      end
+
+      def update(args)
+        @poked  = true if args === :poked
+        @tapped = true if args === :tapped
+      end
+      
+      def poked?; @poked === true; end
+      def tapped?; @tapped === true; end
+    end.new
+    
+    an_observable_object.add_observer(an_observer)
+
+    an_observable_object.poke
+    an_observable_object.tap
+
+    an_observer.must be_tapped
+    an_observer.must be_poked
+  end
+
+  it "notifications are not sent if `changed` not called" do
+    a_bung_observable_object_that_does_not_call_changed = Class.new do
+      require "observer"; include Observable
+
+      def poke
+        notify_observers :poked
+      end
+    end.new
+
+    an_observer = Class.new do
+      def update(args)
+        @notified = true
+      end
+      
+      def notified?; @notified === true; end
+    end.new
+
+    a_bung_observable_object_that_does_not_call_changed.add_observer an_observer
+
+    a_bung_observable_object_that_does_not_call_changed.poke
+
+    an_observer.must_not(be_notified, 
+      "Even though `notify_observers` was called, no notification was sent because you have to call `changed` beforehand."
+    )
+  end
+end

data/spec/examples/a_notifying_shell_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+class Shell
+  require "audible"; extend Audible
+  
+  class << self
+    def exec(what)
+      require "open3"
+      Open3.popen2(what, :err => [:child, :out]) do |i,o,t|
+        o.each_line {|line| notify :progress, line}
+      end
+    end
+  end
+end
+
+describe "An audible shell" do
+  it "notifies for each line of output" do
+    result = StringIO.new
+
+    Shell.on :progress do |e, args|
+      result.puts args.first
+    end
+
+    Shell.exec "ls -a"
+
+    result.length.must be > 0
+  end
+end

data/spec/examples/logging_as_notifications_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+class BusyBody
+  require "audible"; include Audible
+  
+  def go
+    step_one
+    step_two
+    step_three
+  end
+  
+  private
+
+  %w{one two three}.each do |name|
+    full_name = "step_#{name}".to_sym
+
+    define_method(full_name){ notify full_name }
+  end 
+end
+
+class LogSpy
+  attr_reader :messages
+
+  def initialize(what)
+    @messages = []
+
+    what.on :step_one do
+      @messages << "Step 1"
+    end
+
+    what.on :step_two do
+      @messages << "Step 2"
+    end
+
+    what.on :step_three do
+      @messages << "Step 3"
+    end
+  end
+end
+
+describe BusyBody, "and notifying instead of logging" do
+  it "attach the log by notification rather than as dependency" do
+    busy_body = BusyBody.new
+    
+    log = LogSpy.new busy_body
+
+    busy_body.go
+
+    log.messages.must == ["Step 1", "Step 2", "Step 3"]
+  end
+end

data/spec/relaying_notifications/about_the_notifications_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe "The relayed notifications" do
+  before :all do
+    an_audible_object = Class.new do
+      require "audible"; include Audible
+
+      def poke; notify :poked, {:a => "1", :b => "2"}; end
+    end.new
+
+    a_relaying_class = Class.new do
+      require "audible"; include Audible
+      
+      def initialize(inner)
+        @inner = inner
+        relay @inner, :poked
+      end 
+    end
+
+    a_relaying_object = a_relaying_class.new(an_audible_object)
+
+    a_relaying_object.on :poked do |e,args| 
+      @relayed_notification,@relayed_args = e,args
+    end
+
+    an_audible_object.poke
+  end
+
+  it ("notifies with the same name")      { expect(@relayed_notification).to eql :poked }
+  it ("notifies with the same arguments") { expect(@relayed_args.first).to eql({:a => "1", :b => "2"}) }
+end
+
+describe "You can rename the relayed notification to something else" do
+  let :an_audible_object do 
+    Class.new do
+      require "audible"; include Audible
+
+      def poke; notify :poked; end
+    end.new
+  end
+  
+  before do
+    a_relaying_class = Class.new do
+      require "audible"; include Audible
+      
+      def initialize(inner)
+        relay inner, :poked, :as => :any_new_name
+      end 
+    end
+
+    @a_relaying_object = a_relaying_class.new(an_audible_object)
+  end
+
+  it "notifies with the new name and suppresses the original" do
+    @a_relaying_object.on :poked do |e,args| 
+      fail "Expected the <:poked> notification to be suppressed"
+    end
+
+    @a_relaying_object.on :any_new_name do |e,args| 
+      notified = true
+    end
+
+    notified = false
+
+    an_audible_object.poke
+    
+    expect(:notified).to be_true, "Expected to be notified with <#{:any_new_name}>"
+  end
+end

data/spec/relaying_notifications/can_relay_notifications_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe "Relaying notifications" do
+  let(:an_audible_object) do
+     an_audible_class = Class.new do
+      require "audible"; include Audible
+
+      def poke; notify :poked ; end
+      def tap ; notify :tapped; end
+
+      protected
+
+      def accepts?(e);
+        [:poked,:tapped].include? e
+      end
+    end.new
+  end
+
+  let(:a_relaying_class) do
+    Class.new do
+      require "audible"; include Audible
+      
+      def initialize(inner)
+        @inner = inner
+        relay @inner, :poked
+      end 
+    end
+  end
+
+  it "can be asked to relay requests" do
+    notified = false
+
+    a_relaying_object = a_relaying_class.new(an_audible_object)
+
+    a_relaying_object.on(:poked){ notified = true } 
+
+    an_audible_object.poke
+
+    expect(notified).to be_true, "Expected the notification to have been relayed"
+  end
+
+  it "can be asked to rename the notification to something else"
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "rspec"
+require File.join ".", "lib", "audible"
 
 Object.class_eval do
   alias :must :should

data/spec/system.tests/drb/bin/server

@@ -0,0 +1,45 @@
+require File.join ".", "lib", "audible"
+
+class TimeServer
+  require 'drb/observer'
+  include DRb::DRbObservable
+  include Audible
+
+  def get_current_time
+    return Time.now
+  end
+
+  def progress
+    3.times do 
+      changed
+      notify_observers Time.now.to_s
+      notify :progress, Time.now.to_s
+    end		    
+  end   
+end
+
+FRONT_OBJECT=TimeServer.new
+
+$SAFE = 0
+
+require 'drb/drb'
+
+port = 9999
+
+uri="druby://127.0.0.1:#{port}"
+
+DRb.start_service(uri, FRONT_OBJECT)
+
+puts "Server has started on port <#{port}>, process <#{$$}>"
+
+Signal.trap("INT") do
+  puts "Stopping..."
+
+  Pidfile.delete
+
+  exit
+end
+
+Pidfile.new $$
+
+DRb.thread.join

data/spec/system.tests/drb/drb_observers_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require_relative File.join 'support', 'drb_server'
+ 
+describe "Basic drb connections" do
+  before :all do
+    @server = DrbServer.new("druby://127.0.0.1:9999").tap {|server| server.start}
+    @timeserver = DRbObject.new_with_uri @server.url 
+  end
+
+  after :all do
+    @server.kill
+  end
+
+  before do
+    @an_observer = Class.new do
+      def update(args)
+        @notified = true
+      end
+      
+      def notified?; @notified === true; end
+
+      def reset; @notified = false; end
+    end.new
+  end
+
+  it "tells me the time" do
+    expect(@timeserver.get_current_time.to_s).to match /^#{Time.now.year}/
+  end
+
+  it "can notify" do
+    @timeserver.add_observer @an_observer
+
+    @timeserver.progress
+    
+    expect(@an_observer).to be_notified
+  end
+
+  it "can detach observer which stops notifications" do
+    @timeserver.add_observer @an_observer
+
+    @timeserver.progress
+    
+    expect(@an_observer).to be_notified
+
+    @an_observer.reset
+
+    @timeserver.delete_observer @an_observer
+
+    @timeserver.progress
+    
+    expect(@an_observer).to_not be_notified
+  end
+
+  it "can also get audible notifications" do
+    notified = false
+
+    @timeserver.on(:progress) do |e,args|
+      notified = true
+    end
+
+    @timeserver.progress
+
+    expect(notified).to be_true
+  end
+end

data/spec/system.tests/drb/support/drb_server.rb

@@ -0,0 +1,26 @@
+class DrbServer
+  attr_reader :url
+
+  def initialize(url)
+    @url = url
+  end
+
+  def start
+    exe = File.join(File.dirname(__FILE__), "..", "bin", "server")
+    
+    @pid = Process.spawn "bundle exec ruby #{exe}", :err=>:out, :out => ".log"
+
+    while Pidfile.missing?
+      sleep 0.25
+    end
+
+    require 'drb/drb'
+
+    DRb.start_service
+  end
+
+  def kill
+    Process.kill("INT", @pid)
+    Process.wait    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audible
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -65,21 +65,30 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - audible.gemspec
 - lib/audible.rb
 - lib/audible/audible.rb
+- lib/audible/pidfile.rb
+- spec/and_how_it_differs_from_observable_spec.rb
+- spec/examples/a_notifying_shell_spec.rb
+- spec/examples/logging_as_notifications_spec.rb
 - spec/listening_spec.rb
+- spec/relaying_notifications/about_the_notifications_spec.rb
+- spec/relaying_notifications/can_relay_notifications_spec.rb
 - spec/spec_helper.rb
+- spec/system.tests/drb/bin/server
+- spec/system.tests/drb/drb_observers_spec.rb
+- spec/system.tests/drb/support/drb_server.rb
 homepage: http://github.com/ben-biddington/audible
 licenses:
 - MIT
@@ -95,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 466976973
+      hash: 492979357
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= audible
-
-Description goes here.
-
-== Contributing to audible
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 Ben Biddington. See LICENSE.txt for
-further details.
-