Dependency 1.0.0

data/lib/dependency.rb

@@ -0,0 +1,141 @@
+# Just a namespace.
+module Dependency
+  # This is the module you need to include in your classes (or Object).
+  module Methods
+    # Dependents can be any type of object, but must
+    # have the <tt>update</tt> method defined as follows:
+    #
+    #   def update(aspect)
+    #   end
+    #
+    # or:
+    #
+    #   def update(aspect, message)
+    #     # message[:from] always defined
+    #     # message[:with] usually defined
+    #   end
+    #
+    # Adding a dependent:
+    #
+    #   object.dependents.add dependent
+    #   object.dependents << dependent
+    #
+    # Removing a dependent:
+    #
+    #   object.dependents.remove dependent
+    #
+    def dependents
+      @dependents ||= Proxy.new
+    end
+    # Call this method to notify of a change, e.g.
+    #
+    #   def name=(new_name)
+    #     old_name = self.name
+    #     self.name = new_name
+    #     changed :name, :with => old_name
+    #   end
+    #
+    def changed(aspect = nil, message = nil)
+      args = [:update, aspect]
+      unless message.nil?
+        message[:from] = self
+        args << message
+      end
+      flexi = FlexiCaller.new(*args)
+      dependents.each { |dependent| flexi.call_on dependent }
+    end
+    # Register a dependent that's only interested in a particular aspect.
+    #
+    #   object.express_interest_in :name, :for => dependent
+    #
+    # Use the :send_back option to specify what message (method call) should
+    # be sent back (defaults to :update).
+    #
+    #   object.express_interest_in :name, :for => dependent, :send_back => :name_changed
+    #
+    # Note: the method called on the dependents has a different (simpler!)
+    # signature to that when just using `dependents.add`:
+    #
+    #   def update(old_name)
+    #   def update(old_name, object)
+    #
+    def express_interest_in(aspect, options)
+      dependents.add Transformer.new(self, aspect, options[:for], options[:send_back] || :update)
+    end
+    # Remove a dependency:
+    #
+    #   object.retract_interest_in :name, :for => dependent
+    #
+    def retract_interest_in(aspect, options)
+      dependents.delete_if do |dependent|
+        dependent.respond_to?(:for?) && dependent.for?(aspect, options[:for])
+      end
+    end
+  end
+
+  # Include this module in your classes (or Object),
+  # if you want to use the dependency_attr class method.
+  module ClassMethod
+    # Shorthand for the following pattern:
+    #
+    #   def name=(new_name)
+    #     old_name = self.name
+    #     self.name = new_name
+    #     changed :name, :with => old_name
+    #   end
+    #
+    # Use it as you would `attr`, e.g.
+    #
+    #   dependency_attr :name, :age
+    #
+    def dependency_attr(*names)
+      for attribute in names
+        attr_reader attribute
+        class_eval %{
+          def #{attribute}=(new_value)
+            old_value = self.#{attribute}
+            instance_variable_set '@#{attribute}', new_value
+            changed :#{attribute}, :with => old_value
+          end
+        }
+      end
+    end
+  end
+
+  private # keep oot!
+
+  class Proxy < Array # :nodoc:
+    def remove(dependent)
+      delete_if { |d| d === dependent }
+    end
+    alias :add :<<
+  end
+
+  class FlexiCaller # :nodoc:
+    def initialize(method_name, *args)
+      @method_name, @args = method_name, args
+    end
+    def call_on(dependent)
+      case arity = dependent.method(@method_name).arity
+        when 0
+          dependent.send @method_name
+        when -1
+          dependent.send @method_name, *@args
+        else
+          dependent.send @method_name, *@args[0, arity]
+      end
+    end
+  end
+
+  class Transformer # :nodoc:
+    def initialize(parent, aspect, dependent, method_name)
+      @parent, @aspect, @dependent, @method_name = parent, aspect, dependent, method_name
+    end
+    def update(aspect = nil, message = {})
+      FlexiCaller.new(@method_name, message[:with], @parent).call_on(@dependent) if @aspect == aspect
+    end
+    def for?(aspect, dependent)
+      @aspect == aspect && @dependent.equal?(dependent)
+    end
+  end
+end

data/rakefile.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rcov/rcovtask'
+require 'rake/rdoctask'
+
+module Dependency
+  VERSION = '1.0.0'
+  PACK = ['readme.txt', 'rakefile.rb', '{lib,spec}/*.rb']
+  SPEC = ['spec/*_spec.rb']
+  RDOC = ['readme.txt', 'lib/*.rb']
+end
+
+gemspec = Gem::Specification.new do |s|
+  s.name = 'Dependency'
+  s.summary ='Smalltalk-inspired dependency mechanism.'
+  s.version = Dependency::VERSION
+  s.files = FileList[*Dependency::PACK]
+  s.require_path = 'lib'
+  s.autorequire = 'dependency'
+  s.has_rdoc = true
+  s.extra_rdoc_files << Dependency::RDOC.first
+  s.rdoc_options << '--main' << Dependency::RDOC.first
+  s.rubyforge_project = s.name.downcase
+  s.homepage = "http://#{s.rubyforge_project}.rubyforge.org/"
+  s.author = 'Tim Fletcher'
+  s.email = 'twoggle@gmail.com'
+end
+
+Rake::GemPackageTask.new(gemspec) { |t| t.package_dir = 'pkg' }
+
+Rake::PackageTask.new(gemspec.name, Dependency::VERSION) do |p|
+  p.need_tar_gz = true
+  p.package_files.include *Dependency::PACK
+end
+
+Rake::TestTask.new :spec do |t|
+  t.test_files = Dependency::SPEC
+end
+
+Rcov::RcovTask.new do |t|
+  t.test_files = Dependency::SPEC
+  t.output_dir = 'coverage'
+  t.rcov_opts = []
+end
+
+Rake::RDocTask.new do |t|
+  t.main = Dependency::RDOC.first
+  t.rdoc_files.include *Dependency::RDOC
+end

data/readme.txt

@@ -0,0 +1,39 @@
+= Dependency
+
+Smalltalk-inspired dependency mechanism.
+
+
+== Basic HOWTO
+
+In your classes (or Object):
+
+  include Dependency::Methods
+
+Register dependencies:
+
+  object.dependents.add dependent
+
+Notify of changes like so:
+
+  changed :attr_name, :with => old_value
+
+The update method will then be called on all the object's dependents.
+  
+Remove dependencies:
+
+  object.dependents.remove dependent
+
+For more insight, take a look at the source, the spec, or Chapter 19 of
+Smalltalk by Example, upon which this code was based.
+
+Smalltalk by Example: http://www.iam.unibe.ch/~ducasse/FreeBooks/ByExample
+
+
+== License
+
+Same as Ruby.
+
+
+== Contact
+
+Tim Fletcher <mailto:twoggle@gmail.com>

data/spec/dependency_spec.rb

@@ -0,0 +1,48 @@
+#
+# Needs [test/spec](http://chneukirchen.org/repos/testspec)
+
+$:.unshift File.dirname(__FILE__)
+
+require 'test/spec'
+require 'preamble'
+
+$stock = Stock.new('DEPCO')
+$simple_watcher = SimpleStockWatcher.new($stock)
+$selective_watcher = SelectiveStockWatcher.new($stock)
+$selective_watcher_with_send_back = SelectiveStockWatcherWithSendBack.new($stock)
+
+$stock.traded 200, :price => 20
+$stock.traded 100, :price => 30
+$stock.name = 'NEWCO'
+$stock.dependents.remove $simple_watcher
+$stock.retract_interest_in :price, :for => $selective_watcher
+$stock.retract_interest_in :price, :for => $selective_watcher_with_send_back
+$stock.traded 150, :price => 25
+
+
+context 'Simple Stock Watcher' do
+  specify 'should receive 3 calls to #update' do
+    $simple_watcher.method_calls.should.equal :update => 3
+  end
+  specify 'should receive correct price changes' do
+    $simple_watcher.price_changes.should.equal [[0, 20], [20, 30]]
+  end
+end
+
+context 'Selective Stock Watcher' do
+  specify 'should receive 2 calls to #update' do
+    $selective_watcher.method_calls.should.equal :update => 2
+  end
+  specify 'should receive correct price changes' do
+    $selective_watcher.price_changes.should.equal [[0, 20], [20, 30]]
+  end
+end
+
+context 'Selective Stock Watcher w/ Send Back' do
+  specify 'should receive 2 calls to #price_changed' do
+    $selective_watcher_with_send_back.method_calls.should.equal :price_changed => 2
+  end
+  specify 'should receive correct price changes' do
+    $selective_watcher.price_changes.should.equal [[0, 20], [20, 30]]
+  end
+end

data/spec/preamble.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'dependency')
+
+Object.send :include, Dependency::Methods
+Class.send :include, Dependency::ClassMethod
+
+class Stock
+  dependency_attr :price, :name
+  def initialize(name, price = 0)
+    @name, @price = name, price
+  end
+  def traded(count, args)
+    self.price = args[:price]
+  end
+end
+
+class StockWatcher
+  def method_calls
+    @method_calls ||= Hash.new { |calls, meth| calls[meth] = 0 }
+  end
+  def price_changes
+    @price_changes ||= []
+  end
+end
+
+class SimpleStockWatcher < StockWatcher
+  def initialize(stock)
+    stock.dependents.add self
+  end
+  def update(aspect, message)
+    method_calls[:update] += 1
+    price_changes << [message[:with], message[:from].price] if :price == aspect
+  end
+end
+
+class SelectiveStockWatcher < StockWatcher
+  def initialize(stock)
+    stock.express_interest_in :price, :for => self
+  end
+  def update(old_price, stock)
+    method_calls[:update] += 1
+    price_changes << [old_price, stock.price]
+  end
+end
+
+class SelectiveStockWatcherWithSendBack < StockWatcher
+  def initialize(stock)
+    stock.express_interest_in :price, :for => self, :send_back => :price_changed
+  end
+  def price_changed(old_price, stock)
+    method_calls[:price_changed] += 1
+    price_changes << [old_price, stock.price]
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: Dependency
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-10-20 00:00:00 +01:00
+summary: Smalltalk-inspired dependency mechanism.
+require_paths: 
+- lib
+email: twoggle@gmail.com
+homepage: http://dependency.rubyforge.org/
+rubyforge_project: dependency
+description: 
+autorequire: dependency
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Tim Fletcher
+files: 
+- readme.txt
+- rakefile.rb
+- lib/dependency.rb
+- spec/dependency_spec.rb
+- spec/preamble.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- readme.txt
+extra_rdoc_files: 
+- readme.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+