observables 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nathan Stults
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,117 @@
+ = Observables
+
+ Observables implements observable arrays and hashes by way of the ActiveModel::Notifier, the same mechanism
+ underlying the instrumentation API in Rails3. Observables collections broadcast detailed change information for
+ any state-modifying operations, including specific elements added or removed, when that information is practically
+ obtainable.
+
+ == Installation
+
+ Observables is available as a RubyGem:
+
+     gem install observables
+
+ == Observing the Observables
+
+ === Example:
+
+     #Getting an observable array
+
+     ary = [1,2,3] #or, ary = Observables::Array.new([1,2,3]), or, hsh = Observables::Hash
+     ary.observable? # => false
+     ary.can_be_observable? # => true
+     ary.make_observable => #<Class:#<Array:0x56a84a8>>
+
+     #Setting up a subscription
+
+     subscription = ary.subscribe do |change_type,args|
+         puts "Change type: #{change_type}"
+         puts "Trigger: #{args.trigger}"
+         puts "Changes: #{args.changes.inspect}"
+         puts "---"
+     end
+
+     #Do stuff
+
+     ary << 3
+     #   Change type: before_added
+     #   Trigger: <<
+     #   Changes: {:added=>[3]}
+     #   ---
+     #   Change type: after_added
+     #   Trigger: <<
+     #   Changes: {:added=>[3]}
+     #   => [1,2,3,3]
+
+     #Clean up
+
+     ary.unsubscribe(subscription)
+     ary << 4 # => [1,2,3,3,4]
+
+     #Only listen to after_xxx
+
+     subscription = ary.subscribe(/after/) do |change_type,_|
+     puts "Change type:#{change_type}"
+     end
+
+     ary.concat([9,10,11])
+
+     #   Change type: after_added, changes: {:added=>[9,10,11]}
+     #   => [1,2,3,3,4,9,10,11]
+
+ 	ary.replace([3,2,1])
+
+ 	#   Change type: after_modified, changed: {:added=>[3,2,1], :removed=>[1,2,3,3,4,9,10,11]}
+ 	#	=> [3,2,1]
+
+     #Hashes work too
+
+     hsh = {:a=>:b}
+     hsh.can_be_observable? # => true
+     hsh.make_observable
+     hsh.subscribe { |type,args| ... }
+
+ == Special case: ownership
+
+ Observables was created to assist in the implementation of proper dirty tracking for in-place modifications
+ to embedded collections in ORM's, particularly for documented oriented databases, where
+ this is a common situation. In this scenario and similar scenarios, observable collections
+ will only be subscribed to by the object that owns them. However, the parent object
+ may own any number of child collections. To avoid having to manage myriad subscription
+ objects, each observable collection can have a single 'observer' - and will manage the
+ subscription to that observer like so:
+
+ 	class Owner
+ 		def my_array
+ 			@my_array
+ 		end
+
+ 		def my_array=(new_array)
+ 			@my_array.clear_observer if @my_array
+ 			@my_array = new_array.tap {|a|a.make_observable}
+ 			@my_array.set_observer(self, :pattern=>/before/, :callback_method=>:my_array_before_change)
+ 			#Acceptable alernatives are:
+ 			#  @my_array.set_observer { |type,args| ... }
+ 			#  @my_array.set_observer(self, :pattern=>/before/) { |sender,type,args| ... }
+ 		end
+
+ 		def my_array_before_change(sender,type,args)
+ 			#sender = @my_array
+ 			#do something interesting, like, say, attribute_will_change!(:my_array)
+ 		end
+
+ 	end
+
+ == Note on Patches/Pull Requests
+
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history.
+   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+ == Copyright
+
+ Copyright (c) 2010 Nathan Stults. See LICENSE for details.

data/lib/observables.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+base_dir = File.dirname(__FILE__)
+[
+  'base',
+  'array_watcher',
+  'hash_watcher',
+  'collections',
+  'version'
+].each {|req| require File.join(base_dir,'observables',req)}
+
+Dir[File.join(base_dir,"observables","extensions","*.rb")].each {|ext|require ext}
+
+module Observables
+end

data/lib/observables/array_watcher.rb

@@ -0,0 +1,50 @@
+
+module Observables
+  module ArrayWatcher
+    include Observables::Base
+
+    ADD_METHODS =       :<<, :push, :concat, :insert, :unshift
+    MODIFIER_METHODS =  :collect!, :map!, :flatten!, :replace, :reverse!, :sort!, :fill
+    REMOVE_METHODS =    :clear, :compact!, :delete, :delete_at, :delete_if, :pop, :reject!, :shift, :slice!, :uniq!
+
+    #[]= can either be an add method or a modifier method depending on
+    #if the previous key exists
+    def []=(*args)
+      change_type = args[0] >= length ? :added : :modified
+      changes = changes_for(change_type,:"[]=",*args)
+      changing(change_type,:trigger=>:"[]=", :changes=>changes) {super}
+    end
+
+    override_mutators :added=>    ADD_METHODS,
+                      :modified=> MODIFIER_METHODS,
+                      :removed=>  REMOVE_METHODS
+
+    def changes_for(change_type, trigger_method, *args, &block)
+      prev = self.dup.to_a
+      if change_type == :added
+        case trigger_method
+          when :"[]=" then lambda {{:added=>args[-1]}}
+          when :<<, :push, :unshift then lambda {{:added=>args}}
+          when :concat then lambda {{:added=>args[0]}}
+          when :insert then lambda {{:added=>args[1..-1]}}
+          else lambda { |cur| {:added=>(cur - prev).uniq }}
+        end
+      elsif change_type == :removed
+        case trigger_method
+          when :delete then lambda {{:removed=>args}}
+          when :delete_at then lambda {{:removed=>[prev[args[0]]]}}
+          when :delete_if, :reject! then lambda {{:removed=>prev.select(&block)}}
+          when :pop then lambda {{:removed=>[prev[-1]]}}
+          when :shift then lambda {{:removed=>[prev[0]]}}
+          else lambda { |cur| {:removed=>(prev - cur).uniq }}
+        end
+      else
+        case trigger_method
+          when :replace then lambda {{:removed=>prev, :added=>args[0]}}
+          when :"[]=" then lambda {{:removed=>[prev[*args[0..-2]]].flatten, :added=>[args[-1]].flatten}}
+          else lambda {|cur|{:removed=>prev.uniq, :added=>cur}}
+        end
+      end
+    end
+  end
+end

data/lib/observables/base.rb

@@ -0,0 +1,94 @@
+require 'active_support/concern'
+require "active_support/notifications/fanout"
+require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/array/extract_options'
+
+module Observables
+  module Base
+    extend ActiveSupport::Concern
+
+    module InstanceMethods
+      def notifier
+        @notifier ||= ActiveSupport::Notifications::Fanout.new
+      end
+
+      def subscribe(pattern=nil,&block)
+        notifier.subscribe(pattern,&block)
+      end
+
+      def unsubscribe(subscriber)
+        notifier.unsubscribe(subscriber)
+      end
+
+      def dup
+        super.tap {|s|s.make_observable}
+      end
+
+      def set_observer(*args,&block)
+        clear_observer
+        opts = args.extract_options!
+        @_observer_owner = args.pop
+        pattern = opts[:pattern] || /.*/
+        callback_method = opts[:callback_method] || :child_changed
+        @_owner_subscription = subscribe(pattern) do |*args|
+          block ? block.call(self,*args) :
+                  (@_observer_owner.send(callback_method,self,*args) if @_observer_owner && @_observer_owner.respond_to?(callback_method))
+        end
+      end
+
+      def clear_observer
+        unsubscribe(@_owner_subscription) if @_owner_subscription
+        @_owner_subscription = nil
+      end
+
+      protected
+
+      def changing(change_type,opts={})
+        args = create_event_args(change_type,opts)
+        notifier.publish "before_#{change_type}".to_sym, args
+        yield.tap do
+          notifier.publish "after_#{change_type}".to_sym, args
+        end
+      end
+
+      def create_event_args(change_type,opts={})
+        args = {:change_type=>change_type, :current_values=>self}.merge(opts)
+        class << args
+          def changes
+            chgs, cur_values = self[:changes], self[:current_values]
+            chgs && chgs.respond_to?(:call) ? chgs.call(cur_values) : chgs
+          end
+
+          def method_missing(method)
+            self.keys.include?(method) ? self[method] : super
+          end
+        end
+        args.delete(:current)
+        args
+      end
+
+      def changes_for(change_type,trigger_method,*args,&block)
+        #This method should return a lambda that takes the current
+        #value of the collection as an argument, and returns
+        #the expected changes that will result from trigger_method
+        nil
+      end
+    end
+
+    module ClassMethods
+      def override_mutators(change_groups)
+        change_groups.each_pair do |change_type,methods|
+          methods.each do |method|
+            class_eval <<-EOS
+              def #{method}(*args,&block)
+                changes = changes_for(:#{change_type},:#{method},*args,&block)
+                changing(:#{change_type},:trigger=>:#{method}, :changes=>changes){super}
+              end
+            EOS
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/observables/collections.rb

@@ -0,0 +1,15 @@
+module Observables
+  class Array < ::Array
+    include ArrayWatcher
+    def initialize(*args)
+      super(*args)
+    end
+  end
+
+  class Hash < ::Hash
+    include HashWatcher
+    def initialize(*args)
+      super(*args)
+    end
+  end
+end

data/lib/observables/extensions/array.rb

@@ -0,0 +1,5 @@
+class ::Array
+  def make_observable
+    class << self; include Observables::ArrayWatcher; end unless observable?
+  end
+end

data/lib/observables/extensions/hash.rb

@@ -0,0 +1,5 @@
+class ::Hash
+  def make_observable
+    class << self; include Observables::HashWatcher; end unless observable?
+  end
+end

data/lib/observables/extensions/object.rb

@@ -0,0 +1,10 @@
+class ::Object
+  def can_be_observable?
+    respond_to?(:make_observable)
+  end
+
+  def observable?
+    kind_of?(Observables::Base)
+  end
+
+end

data/lib/observables/hash_watcher.rb

@@ -0,0 +1,40 @@
+module Observables
+  module HashWatcher
+    include Observables::Base
+
+    MODIFIER_METHODS = :replace, :merge!, :update
+    REMOVE_METHODS =   :clear, :delete, :delete_if, :reject!, :shift
+
+    #[]= can either be an add method or a modifier method depending on
+    #if the previous key exists
+    def []=(key,val)
+      change_type = keys.include?(key) ? :modified : :added
+      changes = changes_for(change_type,:[]=,key,val)
+      changing(change_type,:trigger=>:[]=, :changes=>changes) {super}
+    end
+    alias :store :[]=
+
+    override_mutators :modified=>MODIFIER_METHODS,
+                      :removed=>REMOVE_METHODS
+
+    def changes_for(change_type, trigger_method, *args, &block)
+      prev = self.dup
+      if change_type == :added
+        lambda {{:added=>[args]}}
+      elsif change_type == :removed
+        case trigger_method
+          when :clear then lambda{{:removed=>prev.to_a}}
+          when :delete then lambda{{:removed=>[[args[0],prev[args[0]]]]}}
+          when :delete_if, :reject! then lambda{{:removed=>prev.select(&block)}}
+          when :shift then lambda { {:removed=>[prev.keys[0],prev.values[0]]}}
+        end
+      else
+        case trigger_method
+          when :[]= then lambda{{:removed=>[[args[0],prev[args[0]]]],:added=>[args]}}
+          when :replace then lambda{{:removed=>prev.to_a, :added=>args[0].to_a}}
+          when :merge!, :update then lambda{{:removed=>prev.select{|k,_|args[0].keys.include?(k)},:added=>args[0].to_a}}
+        end
+      end
+    end
+  end
+end

data/lib/observables/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module Observables
+  Version = '0.1.1'
+end

data/test/extensions/test_extensions.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+class TestExtensions < Test::Unit::TestCase
+  context "Array" do
+    context "#make_observable" do
+
+      should "detect an observable array" do
+        x, y = [], [].tap{|a|a.make_observable}
+        assert_equal false, x.observable?
+        assert y.observable?
+      end
+
+      should "make an instance of an array observable" do
+        x = []
+        assert_equal false, x.observable?
+        x.make_observable
+        assert x.observable?
+      end
+    end
+  end
+end

data/test/test_array_watcher.rb

@@ -0,0 +1,137 @@
+require "test_helper"
+
+class TestArrayWatcher < Test::Unit::TestCase
+  context "An array which has included Observables::ArrayWatcher" do
+    setup do
+      @ary = Array.new([1,2,3]).tap do |a|
+         a.make_observable
+      end
+    end
+
+    should "notify observers of any change that adds elements to itself" do
+      before_methods, after_methods = [],[]
+      method_list = Observables::ArrayWatcher::ADD_METHODS
+      @ary.subscribe(/before_added/){|_,args|before_methods<<args[:trigger]}
+      @ary.subscribe(/after_added/) {|_,args|after_methods<<args[:trigger]}
+      method_list.each do |method|
+        @ary.send(method,*args_for(method))
+      end
+
+      assert_equal method_list, before_methods
+      assert_equal method_list, after_methods
+    end
+
+    should "notify observers of any change that modifies elements" do
+      before_methods, after_methods = [],[]
+      method_list = Observables::ArrayWatcher::MODIFIER_METHODS
+      @ary.subscribe(/before_modified/){|_,args|before_methods<<args[:trigger]}
+      @ary.subscribe(/after_modified/) {|_,args|after_methods<<args[:trigger]}
+      method_list.each do |method|
+        args = args_for(method)
+        args ? @ary.send(method,*args) : @ary.send(method)
+      end
+      assert_equal method_list, before_methods
+      assert_equal method_list, after_methods
+    end
+
+    should "notify observers of any change that removes elements" do
+      before_methods, after_methods = [],[]
+      method_list = Observables::ArrayWatcher::REMOVE_METHODS
+      @ary.subscribe(/before_removed/){|_,args|before_methods<<args[:trigger]}
+      @ary.subscribe(/after_removed/) {|_,args|after_methods<<args[:trigger]}
+      method_list.each do |method|
+        args = args_for(method)
+        args ? @ary.send(method,*args) : @ary.send(method)
+      end
+      assert_equal method_list, before_methods
+      assert_equal method_list, after_methods
+    end
+
+    context "Calling #changes on the event args" do
+      should "calculate changes for #<<" do
+        assert_equal [9],get_changes(@ary){ @ary << 9}[:added]
+      end
+      should "calculate changes for #push, #unshift" do
+        [:push,:unshift].each do|method|
+          ary = @ary.dup
+          assert_equal [1,2,3],get_changes(ary){ary.send(method,1,2,3)}[:added]
+        end
+      end
+      should "calculate changes for #concat" do
+        assert_equal [1,2,3],get_changes(@ary){@ary.concat([1,2,3])}[:added]
+      end
+      should "calculate changes for insert" do
+        assert_equal [3,4,5],get_changes(@ary){@ary.insert(2,3,4,5)}[:added]
+      end
+      should "calculate changes for delete" do
+        assert_equal [2],get_changes(@ary){@ary.delete(2)}[:removed]
+      end
+      should "calculate changes for delete_at" do
+        assert_equal [2],get_changes(@ary){@ary.delete_at(1)}[:removed]
+      end
+      should "calculate changes for delete_if, reject!" do
+        [:delete_if, :reject!].each do |method|
+          ary = @ary.dup
+          assert_equal [2], get_changes(ary){ary.send(method){|i|i%2==0}}[:removed]
+        end
+      end
+      should "calculate changes for pop" do
+        assert_equal [3], get_changes(@ary){@ary.pop}[:removed]
+      end
+      should "calculate changes for shift" do
+        assert_equal [1], get_changes(@ary){@ary.shift}[:removed]
+      end
+      should "calculate changes for clear" do
+        assert_equal [1,2,3], get_changes(@ary){@ary.clear}[:removed]
+      end
+      should "calculate changes for compact!" do
+        @ary = [1,2,nil,3,nil,4].tap{|a|a.make_observable}
+        assert_equal [nil], get_changes(@ary){@ary.compact!}[:removed]
+      end
+      should "calculate changes for slice!" do
+        assert_equal [2,3], get_changes(@ary){@ary.slice!(1,2)}[:removed]
+      end
+      should "calculate changes for uniq!" do
+        @ary = [1,2,2,3,3,4,4,5].tap{|a|a.make_observable}
+        assert_equal [], get_changes(@ary){@ary.uniq!}[:removed]
+      end
+      should "calculate changes for replace" do
+        assert_equal({:removed=>@ary.dup,:added=>[4,5,6,7]}, get_changes(@ary){@ary.replace([4,5,6,7])})
+      end
+      should "calculate changes for []=" do
+        assert_equal [6,7,8,9], get_changes(@ary){@ary[3,4]=[6,7,8,9]}[:added]
+      end
+      should "calculated changes for []= when []= is a modification method" do
+        assert_equal({:removed=>[1],:added=>[9]},get_changes(@ary){@ary[0]=9})
+      end
+      should "return the original array as changes for other modification methods of array" do
+        [:collect!, :map!, :flatten!, :reverse!, :sort!].each do |method|
+          ary = @ary.dup
+          assert_equal({:removed=>ary.dup, :added=>ary.dup.tap{|a|a.send(method)}}, get_changes(ary){ary.send(method)})
+        end
+      end
+      should "return the original array as changes for fill" do
+        assert_equal({:removed=>@ary.dup, :added=>@ary.dup.fill("*")}, get_changes(@ary){@ary.fill("*")})
+      end
+    end
+  end
+
+  def args_for(method)
+    case method
+      when :<<, :push, :unshift, :delete, :delete_at  then [1]
+      when :concat, :replace then [[1,2]]
+      when :fill then ["*"]
+      when :insert, :"[]=", :slice! then [1,1]
+      when :flatten!, :collect!, :map!, :reverse!, :sort!,
+           :clear, :compact!, :pop, :reject!, :uniq!, :delete_if, :shift then nil
+    end
+  end
+
+  def get_changes(ary)
+    changes = []
+    sub = ary.subscribe(/after/){|_,args|changes << args.changes}
+    yield
+    ary.unsubscribe(sub)
+    changes.pop
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+
+class TestBase < Test::Unit::TestCase
+
+  context "An instance of a class that include Observables:Base" do
+    setup do
+      @obs = Class.new{include Observables::Base}.new
+    end
+
+    should "have a notifier" do
+      assert @obs.notifier.is_a?(ActiveSupport::Notifications::Fanout)
+    end
+
+    should "allow subscriptions with just a block" do
+      assert @obs.subscribe{}.is_a?(ActiveSupport::Notifications::Fanout::Subscriber)
+    end
+
+    should "allow subscriptions with a pattern and a block" do
+      assert @obs.subscribe(/whatever/){}.is_a?(ActiveSupport::Notifications::Fanout::Subscriber)
+    end
+
+    should "allow unsubscribing" do
+      sub = @obs.subscribe(/hi/){}
+      assert @obs.notifier.listening?("hi")
+      @obs.unsubscribe(sub)
+      assert_equal false, @obs.notifier.listening?("hi")
+    end
+
+    should "publish a before notification prior to executing a change" do
+      vals = []
+      x = 0
+      @obs.subscribe(/before/){|c,a|vals << c << a << x}
+      @obs.send(:changing,:a_change,:this=>:that){x+=1}
+      assert_equal :before_a_change, vals[0]
+      assert_equal @obs.send(:create_event_args,:a_change,:this=>:that),vals[1]
+      assert_equal 0, vals[2]
+      assert_equal 1, x
+    end
+
+    should "publish an after notification after executing a change" do
+      vals = []
+      x = 0
+      @obs.subscribe(/after/){|c,a|vals << c << a << x}
+      @obs.send(:changing,:a_change,:this=>:that){x+=1}
+      assert_equal :after_a_change, vals[0]
+      assert_equal @obs.send(:create_event_args,:a_change,:this=>:that),vals[1]
+      assert_equal 1, vals[2]
+      assert_equal 1, x
+    end
+
+    should "execute a proc passed in as changes to the event args" do
+      vals = []
+      @obs.subscribe(/after/){|_,a|vals << a.changes}
+      @obs.send(:changing, :a_change, :changes=>lambda {[1,2,3]}){1==1}
+      assert_equal [1,2,3], vals[0]
+    end
+
+    should "provide method level access to change args" do
+      vals = []
+      @obs.subscribe(/after/){|_,a|vals << a.haha}
+      @obs.send(:changing, :a_change, :haha=>"hoho"){1==1}
+      assert_equal "hoho", vals[0]
+    end
+
+    context "Taking ownership of an observable collection" do
+      setup do
+        @owner = Class.new do
+          def child_changed(*args)
+            @changed_args = args
+          end
+          def another_child_changed(*args)
+            @changed_args = args
+          end
+          def changed_args; @changed_args; end
+        end
+        @parent = @owner.new
+      end
+      should "notify the parent via standard callback method" do
+        @obs.set_observer @parent
+        @obs.send(:changing, :a_change){1==1}
+        assert_equal @obs, @parent.changed_args[0]
+      end
+      should "notify the parent via custom callback method when specified" do
+        @obs.set_observer @parent, :callback_method=>:another_child_changed
+        @obs.send(:changing, :a_change) {1==1}
+        assert_equal @obs, @parent.changed_args[0]
+      end
+      should "notify the parent via a block if provided" do
+        changed_args = []
+        @obs.set_observer(@parent) { |obs,*_| changed_args << obs }
+        @obs.send(:changing, :a_change) {1==1}
+        assert_equal @obs, changed_args.pop
+      end
+      should "respect a subscription pattern when notifying the parent" do
+        events = []
+        @obs.set_observer(@parent, :pattern=>/before/){|_,evt,*_| events << evt}
+        @obs.send(:changing,:a_change){1==1}
+        assert_equal 1, events.length
+        assert_equal :before_a_change, events.pop
+      end
+      should "notify the parent via argless block" do
+        events = []
+        @obs.set_observer(@parent, :pattern=>/before/){events << 1}
+        @obs.send(:changing, :a_change){1==1}
+        assert_equal 1, events.length
+      end
+      should "notify via block when no owner is given" do
+        events = []
+        my_ary = [1,2,3]
+        my_ary.make_observable
+        my_ary.set_observer(:pattern=>/before/){events << 1}
+        my_ary << 1
+        assert_equal 1, events.length
+      end
+      should "stop notifying the parent after clear_observer is called" do
+        events = []
+        @obs.set_observer(@parent){|*args|events << args}
+        @obs.send(:changing,:a_change){1==1}
+        assert_equal 2, events.length
+        @obs.clear_observer
+        @obs.send(:changing,:a_change){1==1}
+        assert_equal 2, events.length
+      end
+
+    end
+  end
+end

data/test/test_hash_watcher.rb

@@ -0,0 +1,88 @@
+require "test_helper"
+
+class TestHashWatcher < Test::Unit::TestCase
+  context "A hash which has included Observables::HashWatcher" do
+    setup do
+      @hash = {:a=>1,:b=>2,:c=>"3"}.tap do |h|
+         class << h
+           include Observables::HashWatcher
+         end
+      end
+    end
+
+    should "notify observers of any change that modifies elements" do
+      before_methods, after_methods = [],[]
+      method_list = Observables::HashWatcher::MODIFIER_METHODS
+      @hash.subscribe(/before_modified/){|_,args|before_methods<<args[:trigger]}
+      @hash.subscribe(/after_modified/) {|_,args|after_methods<<args[:trigger]}
+      method_list.each do |method|
+        args = args_for(method)
+        args ? @hash.send(method,args) : @hash.send(method)
+      end
+      assert_equal method_list, before_methods
+      assert_equal method_list, after_methods
+    end
+
+    should "notify observers of any change that removes elements" do
+      before_methods, after_methods = [],[]
+      method_list = Observables::HashWatcher::REMOVE_METHODS
+      @hash.subscribe(/before_removed/){|_,args|before_methods<<args[:trigger]}
+      @hash.subscribe(/after_removed/) {|_,args|after_methods<<args[:trigger]}
+      method_list.each do |method|
+        args = args_for(method)
+        args ? @hash.send(method,*args) : @hash.send(method)
+      end
+      assert_equal method_list, before_methods
+      assert_equal method_list, after_methods
+    end
+
+    context "Calling #changes on the event args" do
+      should "calculate changes for #[]= as an addition" do
+        assert_equal [[:f,9]],get_changes(@hash){ @hash[:f] = 9}[:added]
+      end
+      should "calculate changes for #[]= as a modification" do
+        assert_equal({:removed=>[[:a,1]],:added=>[[:a,9]]}, get_changes(@hash){@hash[:a]=9})
+      end
+      should "calculate changes for #replace" do
+        assert_equal({:removed=>@hash.dup.to_a,:added=>{:t=>9,:u=>10}.to_a},get_changes(@hash){@hash.replace(:t=>9,:u=>10)})
+      end
+      should "calculate changes for #merge!, #update" do
+        [:merge!, :update].each do |method|
+          hash = @hash.dup
+          assert_equal({:removed=>{:c=>"3"}.to_a, :added=>{:c=>"4",:d=>5}.to_a},get_changes(hash){hash.send(method,{:c=>"4",:d=>5})})
+        end
+      end
+      should "calculate changes for #clear" do
+        assert_equal @hash.to_a, get_changes(@hash){@hash.clear}[:removed]
+      end
+      should "calculate changes for #delete" do
+        assert_equal({:a=>1}.to_a, get_changes(@hash){@hash.delete(:a)}[:removed])
+      end
+      should "calculate changes for #delete_if, #reject!" do
+        [:delete_if,:reject!].each do |method|
+          hash = @hash.dup
+          assert_equal({:a=>1,:c=>"3"}.to_a,get_changes(hash){hash.send(method){|k,v|[:a,:c].include?(k)}}[:removed])
+        end
+      end
+      should "calculate changes for #shift" do
+        assert_equal(@hash.dup.shift,get_changes(@hash){@hash.shift}[:removed])
+      end
+    end
+  end
+
+  def args_for(method)
+    case method
+      when :replace, :merge!, :update then {:e=>5}
+      when :delete then :a
+      else nil
+    end
+  end
+
+  def get_changes(hash)
+    changes = []
+    sub = hash.subscribe(/after/){|_,args|changes << args.changes}
+    yield
+    hash.unsubscribe(sub)
+    changes.pop
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'observables'
+
+require 'shoulda'
+
+class Test::Unit::TestCase
+
+end
+

data/test/test_observable_array.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class TestObservablesArray < Test::Unit::TestCase
+  context "An Observables::Array" do
+    should "be observable" do
+      assert Observables::Array.new.observable?
+    end
+    should "be an array" do
+      assert Observables::Array.new.kind_of?(::Array)
+    end
+
+  end
+end

data/test/test_observables.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class TestObservables < Test::Unit::TestCase
+  context "including observables" do
+    should "include something or other" do
+      assert_equal defined?(Observables), "constant"
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: observables
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nathan Stults
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+  prerelease: false
+  name: activesupport
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  name: i18n
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rake
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  requirement: *id004
+  prerelease: false
+  name: shoulda
+  type: :development
+description: 
+email: 
+- hereiam@sonic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/observables/array_watcher.rb
+- lib/observables/base.rb
+- lib/observables/collections.rb
+- lib/observables/extensions/array.rb
+- lib/observables/extensions/hash.rb
+- lib/observables/extensions/object.rb
+- lib/observables/hash_watcher.rb
+- lib/observables/version.rb
+- lib/observables.rb
+- test/extensions/test_extensions.rb
+- test/test_array_watcher.rb
+- test/test_base.rb
+- test/test_hash_watcher.rb
+- test/test_helper.rb
+- test/test_observables.rb
+- test/test_observable_array.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/PlasticLizard/observables
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Observable arrays and hashes
+test_files: []
+