rubysl-observer 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d688ce9f9a7f41c345eb041aaab60e3da171af7
-  data.tar.gz: 1a636e1298a86954dbd1da417863537a1fcd4de4
+  metadata.gz: 93ace3722a7a1a31ff19eb6dd3f274df55e79d58
+  data.tar.gz: 43cb458919cfc1c7a05ff8be99f1c68220600eaf
 SHA512:
-  metadata.gz: ddd59dbc50a5c515f3307c20d89af59c0f59a609be912f3736c230874ecfc237947eb307f65e9a82d746640263094a4b8a320a01cbabe08503562d5127e636de
-  data.tar.gz: 22cf3263b3cc9b1e9e784678bb2dea310ddaed40e79c0360098cad5087b049d12ec3944d7a5eb1bb293a84ecae7fb5487a5f6f95196edc1e236bf0d08b8322ef
+  metadata.gz: 4058fc818ee2aa041614451d122199d1b93d03ef4bf361e1215ef2f3dd697172edb2bc640f22d0f920f5b750190221772886a559881e3071f54a3eb4d4c84546
+  data.tar.gz: a7e30103766f5d712f93292b58576f95bce33394a296dfb3f2bb4b496ddb300080ac51e9f5539163c2d87401463ec93edb7217814fa5013236a442ff46e7cca2

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
-before_install:
-  - gem update --system
-  - gem --version
-  - gem install rubysl-bundler
-script: bundle exec mspec spec
+env:
+  - RUBYLIB=lib
+script: bundle exec mspec
 rvm:
-  - rbx-nightly-18mode
+  - 1.9.3
+  - rbx-nightly-19mode

data/lib/rubysl/observer/observer.rb

@@ -1,33 +1,34 @@
 #
-# observer.rb implements the _Observer_ object-oriented design pattern.  The
+# Implementation of the _Observer_ object-oriented design pattern.  The
 # following documentation is copied, with modifications, from "Programming
-# Ruby", by Hunt and Thomas; http://www.rubycentral.com/book/lib_patterns.html.
+# Ruby", by Hunt and Thomas; http://www.ruby-doc.org/docs/ProgrammingRuby/html/lib_patterns.html.
 #
-# == About
-#
-# The Observer pattern, also known as Publish/Subscribe, provides a simple
+# See Observable for more info.
+
+# The Observer pattern (also known as publish/subscribe) provides a simple
 # mechanism for one object to inform a set of interested third-party objects
 # when its state changes.
 #
 # == Mechanism
 #
-# In the Ruby implementation, the notifying class mixes in the +Observable+
+# The notifying class mixes in the +Observable+
 # module, which provides the methods for managing the associated observer
 # objects.
 #
-# The observers must implement the +update+ method to receive notifications.
+# The observers must implement a method called +update+ to receive
+# notifications.
 #
 # The observable object must:
-# * assert that it has +changed+
-# * call +notify_observers+
+# * assert that it has +#changed+
+# * call +#notify_observers+
 #
-# == Example
+# === Example
 #
 # The following example demonstrates this nicely.  A +Ticker+, when run,
-# continually receives the stock +Price+ for its +@symbol+.  A +Warner+ is a
-# general observer of the price, and two warners are demonstrated, a +WarnLow+
-# and a +WarnHigh+, which print a warning if the price is below or above their
-# set limits, respectively.
+# continually receives the stock +Price+ for its <tt>@symbol</tt>.  A +Warner+
+# is a general observer of the price, and two warners are demonstrated, a
+# +WarnLow+ and a +WarnHigh+, which print a warning if the price is below or
+# above their set limits, respectively.
 #
 # The +update+ callback allows the warners to run without being explicitly
 # called.  The system is set up with the +Ticker+ and several observers, and the
@@ -108,36 +109,39 @@
 #   Current price: 112
 #   Current price: 79
 #   --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 79
-
-
-#
-# Implements the Observable design pattern as a mixin so that other objects can
-# be notified of changes in state.  See observer.rb for details and an example.
-#
 module Observable
 
   #
-  # Add +observer+ as an observer on this object. +observer+ will now receive
+  # Add +observer+ as an observer on this object. so that it will receive
   # notifications.
   #
-  def add_observer(observer)
-    @observer_peers = [] unless defined? @observer_peers
-    unless observer.respond_to? :update
-      raise NoMethodError, "observer needs to respond to `update'"
+  # +observer+:: the object that will be notified of changes.
+  # +func+:: Symbol naming the method that will be called when this Observable
+  #          has changes.
+  #
+  #          This method must return true for +observer.respond_to?+ and will
+  #          receive <tt>*arg</tt> when #notify_observers is called, where
+  #          <tt>*arg</tt> is the value passed to #notify_observers by this
+  #          Observable
+  def add_observer(observer, func=:update)
+    @observer_peers = {} unless defined? @observer_peers
+    unless observer.respond_to? func
+      raise NoMethodError, "observer does not respond to `#{func.to_s}'"
     end
-    @observer_peers.push observer
+    @observer_peers[observer] = func
   end
 
   #
-  # Delete +observer+ as an observer on this object. It will no longer receive
-  # notifications.
+  # Remove +observer+ as an observer on this object so that it will no longer
+  # receive notifications.
   #
+  # +observer+:: An observer of this Observable
   def delete_observer(observer)
     @observer_peers.delete observer if defined? @observer_peers
   end
 
   #
-  # Delete all observers associated with this object.
+  # Remove all observers associated with this object.
   #
   def delete_observers
     @observer_peers.clear if defined? @observer_peers
@@ -158,12 +162,15 @@ module Observable
   # Set the changed state of this object.  Notifications will be sent only if
   # the changed +state+ is +true+.
   #
+  # +state+:: Boolean indicating the changed state of this Observable.
+  #
   def changed(state=true)
     @observer_state = state
   end
 
   #
-  # Query the changed state of this object.
+  # Returns true if this object's state has been changed since the last
+  # #notify_observers call.
   #
   def changed?
     if defined? @observer_state and @observer_state
@@ -174,15 +181,18 @@ module Observable
   end
 
   #
-  # If this object's changed state is +true+, invoke the update method in each
-  # currently associated observer in turn, passing it the given arguments. The
-  # changed state is then set to +false+.
+  # Notify observers of a change in state *if* this object's changed state is
+  # +true+.
+  #
+  # This will invoke the method named in #add_observer, passing <tt>*arg</tt>.
+  # The changed state is then set to +false+.
   #
+  # <tt>*arg</tt>:: Any arguments to pass to the observers.
   def notify_observers(*arg)
     if defined? @observer_state and @observer_state
       if defined? @observer_peers
-        @observer_peers.dup.each do |i|
-          i.update(*arg)
+        @observer_peers.each do |k, v|
+          k.send v, *arg
         end
       end
       @observer_state = false

data/lib/rubysl/observer/version.rb

@@ -1,5 +1,5 @@
 module Rubysl
   module Observable
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/rubysl-observer.gemspec

@@ -19,5 +19,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
-  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-observer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubysl-prettyprint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Ruby standard library observer.
 email:
 - brixen@gmail.com