rubysl-observer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d688ce9f9a7f41c345eb041aaab60e3da171af7
+  data.tar.gz: 1a636e1298a86954dbd1da417863537a1fcd4de4
+SHA512:
+  metadata.gz: ddd59dbc50a5c515f3307c20d89af59c0f59a609be912f3736c230874ecfc237947eb307f65e9a82d746640263094a4b8a320a01cbabe08503562d5127e636de
+  data.tar.gz: 22cf3263b3cc9b1e9e784678bb2dea310ddaed40e79c0360098cad5087b049d12ec3944d7a5eb1bb293a84ecae7fb5487a5f6f95196edc1e236bf0d08b8322ef

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install rubysl-bundler
+script: bundle exec mspec spec
+rvm:
+  - rbx-nightly-18mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2013, Brian Shirai
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the library nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+# Rubysl::Observer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubysl-observer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysl-observer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/observer.rb

@@ -0,0 +1 @@
+require "rubysl/observer"

data/lib/rubysl/observer.rb

@@ -0,0 +1,2 @@
+require "rubysl/observer/observer"
+require "rubysl/observer/version"

data/lib/rubysl/observer/observer.rb

@@ -0,0 +1,192 @@
+#
+# observer.rb implements 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.
+#
+# == About
+#
+# 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+
+# module, which provides the methods for managing the associated observer
+# objects.
+#
+# The observers must implement the +update+ method to receive notifications.
+#
+# The observable object must:
+# * assert that it has +changed+
+# * call +notify_observers+
+#
+# == 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.
+#
+# 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
+# observers do their duty without the top-level code having to interfere.
+#
+# Note that the contract between publisher and subscriber (observable and
+# observer) is not declared or enforced.  The +Ticker+ publishes a time and a
+# price, and the warners receive that.  But if you don't ensure that your
+# contracts are correct, nothing else can warn you.
+#
+#   require "observer"
+#
+#   class Ticker          ### Periodically fetch a stock price.
+#     include Observable
+#
+#     def initialize(symbol)
+#       @symbol = symbol
+#     end
+#
+#     def run
+#       lastPrice = nil
+#       loop do
+#         price = Price.fetch(@symbol)
+#         print "Current price: #{price}\n"
+#         if price != lastPrice
+#           changed                 # notify observers
+#           lastPrice = price
+#           notify_observers(Time.now, price)
+#         end
+#         sleep 1
+#       end
+#     end
+#   end
+#
+#   class Price           ### A mock class to fetch a stock price (60 - 140).
+#     def Price.fetch(symbol)
+#       60 + rand(80)
+#     end
+#   end
+#
+#   class Warner          ### An abstract observer of Ticker objects.
+#     def initialize(ticker, limit)
+#       @limit = limit
+#       ticker.add_observer(self)
+#     end
+#   end
+#
+#   class WarnLow < Warner
+#     def update(time, price)       # callback for observer
+#       if price < @limit
+#         print "--- #{time.to_s}: Price below #@limit: #{price}\n"
+#       end
+#     end
+#   end
+#
+#   class WarnHigh < Warner
+#     def update(time, price)       # callback for observer
+#       if price > @limit
+#         print "+++ #{time.to_s}: Price above #@limit: #{price}\n"
+#       end
+#     end
+#   end
+#
+#   ticker = Ticker.new("MSFT")
+#   WarnLow.new(ticker, 80)
+#   WarnHigh.new(ticker, 120)
+#   ticker.run
+#
+# Produces:
+#
+#   Current price: 83
+#   Current price: 75
+#   --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 75
+#   Current price: 90
+#   Current price: 134
+#   +++ Sun Jun 09 00:10:25 CDT 2002: Price above 120: 134
+#   Current price: 134
+#   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
+  # notifications.
+  #
+  def add_observer(observer)
+    @observer_peers = [] unless defined? @observer_peers
+    unless observer.respond_to? :update
+      raise NoMethodError, "observer needs to respond to `update'"
+    end
+    @observer_peers.push observer
+  end
+
+  #
+  # Delete +observer+ as an observer on this object. It will no longer receive
+  # notifications.
+  #
+  def delete_observer(observer)
+    @observer_peers.delete observer if defined? @observer_peers
+  end
+
+  #
+  # Delete all observers associated with this object.
+  #
+  def delete_observers
+    @observer_peers.clear if defined? @observer_peers
+  end
+
+  #
+  # Return the number of observers associated with this object.
+  #
+  def count_observers
+    if defined? @observer_peers
+      @observer_peers.size
+    else
+      0
+    end
+  end
+
+  #
+  # Set the changed state of this object.  Notifications will be sent only if
+  # the changed +state+ is +true+.
+  #
+  def changed(state=true)
+    @observer_state = state
+  end
+
+  #
+  # Query the changed state of this object.
+  #
+  def changed?
+    if defined? @observer_state and @observer_state
+      true
+    else
+      false
+    end
+  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+.
+  #
+  def notify_observers(*arg)
+    if defined? @observer_state and @observer_state
+      if defined? @observer_peers
+        @observer_peers.dup.each do |i|
+          i.update(*arg)
+        end
+      end
+      @observer_state = false
+    end
+  end
+
+end

data/lib/rubysl/observer/version.rb

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

data/rubysl-observer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require './lib/rubysl/observer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-observer"
+  spec.version       = Rubysl::Observable::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library observer.}
+  spec.summary       = %q{Ruby standard library observer.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-observer"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end

data/spec/add_observer_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Observer#add_observer" do
+
+  before(:each) do
+    @observable = ObservableSpecs.new
+    @observer = ObserverCallbackSpecs.new
+    @custom_observer = ObserverCustomCallbackSpecs.new
+  end
+
+  it "adds the observer" do
+    @observer.value.should == nil
+    @observable.changed
+    @observable.notify_observers("test")
+    @observer.value.should == nil
+
+    @observable.add_observer(@observer)
+    @observable.changed
+    @observable.notify_observers("test2")
+    @observer.value.should == "test2"
+  end
+
+  it "supports custom method on observer" do
+    @observable.add_observer(@custom_observer, :custom)
+    @observable.changed
+    @observable.notify_observers("test2")
+    @custom_observer.value.should == "test2"
+  end
+
+end

data/spec/count_observers_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Observer#count_observers" do
+  before(:each) do
+    @observable = ObservableSpecs.new
+    @observer   = ObserverCallbackSpecs.new
+    @observer2  = ObserverCallbackSpecs.new
+  end
+
+  it "returns the number of observers" do
+    @observable.count_observers.should == 0
+    @observable.add_observer(@observer)
+    @observable.count_observers.should == 1
+    @observable.add_observer(@observer2)
+    @observable.count_observers.should == 2
+  end
+
+  ruby_version_is "" ... "1.9" do
+    it "returns the number observers including duplicates" do
+      2.times { @observable.add_observer(@observer) }
+      @observable.count_observers.should == 2
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "returns the number of unique observers" do
+      2.times { @observable.add_observer(@observer) }
+      @observable.count_observers.should == 1
+    end
+  end
+
+end

data/spec/delete_observer_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Observer#delete_observer" do
+  before(:each) do
+    @observable = ObservableSpecs.new
+    @observer = ObserverCallbackSpecs.new
+  end
+
+  it "deletes the observer" do
+    @observable.add_observer(@observer)
+    @observable.delete_observer(@observer)
+
+    @observable.changed
+    @observable.notify_observers("test")
+    @observer.value.should == nil
+  end
+
+end

data/spec/delete_observers_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Observer#delete_observers" do
+  before(:each) do
+    @observable = ObservableSpecs.new
+    @observer = ObserverCallbackSpecs.new
+  end
+
+  it "deletes the observers" do
+    @observable.add_observer(@observer)
+    @observable.delete_observers
+
+    @observable.changed
+    @observable.notify_observers("test")
+    @observer.value.should == nil
+  end
+
+end

data/spec/fixtures/classes.rb

@@ -0,0 +1,25 @@
+require 'observer'
+
+class ObserverCallbackSpecs
+  attr_reader :value
+
+  def initialize
+    @value = nil
+  end
+
+  def update(value)
+    @value = value
+  end
+end
+
+class ObserverCustomCallbackSpecs < ObserverCallbackSpecs
+  def update ; end
+
+  def custom(value)
+    @value = value
+  end
+end
+
+class ObservableSpecs
+  include Observable
+end

data/spec/notify_observers_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Observer#notify_observers" do
+
+  before(:each) do
+    @observable = ObservableSpecs.new
+    @observer = ObserverCallbackSpecs.new
+    @observable.add_observer(@observer)
+  end
+
+  it "must call changed before notifying observers" do
+    @observer.value.should == nil
+    @observable.notify_observers("test")
+    @observer.value.should == nil
+  end
+
+  it "verifies observer responds to update" do
+    lambda {
+      @observable.add_observer(@observable)
+    }.should raise_error(NoMethodError)
+  end
+
+  it "receives the callback" do
+    @observer.value.should == nil
+    @observable.changed
+    @observable.notify_observers("test")
+    @observer.value.should == "test"
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rubysl-observer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Shirai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/observer.rb
+- lib/rubysl/observer.rb
+- lib/rubysl/observer/observer.rb
+- lib/rubysl/observer/version.rb
+- rubysl-observer.gemspec
+- spec/add_observer_spec.rb
+- spec/count_observers_spec.rb
+- spec/delete_observer_spec.rb
+- spec/delete_observers_spec.rb
+- spec/fixtures/classes.rb
+- spec/notify_observers_spec.rb
+homepage: https://github.com/rubysl/rubysl-observer
+licenses:
+- BSD
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Ruby standard library observer.
+test_files:
+- spec/add_observer_spec.rb
+- spec/count_observers_spec.rb
+- spec/delete_observer_spec.rb
+- spec/delete_observers_spec.rb
+- spec/fixtures/classes.rb
+- spec/notify_observers_spec.rb