observables 0.1.1 → 0.1.2

data/lib/observables/collections.rb

@@ -1,15 +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
+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

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

data/lib/observables/extensions/hash.rb

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

data/lib/observables/extensions/object.rb

@@ -1,10 +1,10 @@
-class ::Object
-  def can_be_observable?
-    respond_to?(:make_observable)
-  end
-
-  def observable?
-    kind_of?(Observables::Base)
-  end
-
+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

@@ -1,40 +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
+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

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

data/test/extensions/test_extensions.rb

@@ -1,21 +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
+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_observables.rb → test_Observables.rb}

@@ -1,9 +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
+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

data/test/test_array_watcher.rb

@@ -1,137 +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
+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