keyvalue 0.1.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Melchior Brislinger
+
+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

@@ -0,0 +1,27 @@
+Key Value Coding, Key Value Observing & Bindings for Ruby.
+
+Bindings
+--------
+
+    class A
+      include KeyValue::KVC
+      include KeyValue::KVO::Dynamic
+      include KeyValue::Binding
+
+      attr_kvo_accessor :value
+    end
+
+    class B
+      attr_accessor :value
+    end
+
+    a = A.new
+    b = B.new
+
+    a.bind :value, b, :value
+
+    a.value = 5
+    b.value # => 5
+
+    a.value = 10
+    b.value # => 10

data/lib/keyvalue.rb

@@ -0,0 +1,130 @@
+module KeyValue
+  module KVC
+    def value_for_key key
+      instance_variable_get '@' + key.to_s
+    end
+    
+    def set_value_for_key key, value
+      instance_variable_set '@' + key.to_s, value
+    end
+    
+    def value_for_key_path path
+      obj = self
+      
+      path.split('.').each do |component|
+        if component == '@sum'
+          obj = obj.inject(nil) { |sum,x| sum ? sum+x : x }
+        elsif component == '@avg'
+          obj = obj.inject(nil) { |sum,x| sum ? sum+x : x } / obj.size
+        elsif component == '@max'
+          obj = obj.max
+        elsif component == '@min'
+          obj = obj.min
+        else
+          if obj.is_a? Array
+            obj = obj.map { |o| o.instance_variable_get '@' + component }
+          else
+            obj = obj.instance_variable_get '@' + component
+          end
+        end
+      end
+      
+      obj
+    end
+  end
+  
+  module KVO
+    module Static
+      def add_observer key, obs, func=:update
+        unless obs.respond_to? func
+          raise NoMethodError, "observer does not respond to `#{func.to_s}'"
+        end
+        @kvo_observers ||= {}
+        @kvo_observers[key] ||= []
+        @kvo_observers[key] << {:obs => obs, :func => func}
+      end
+      
+      def remove_observer key, obs
+        @kvo_observers[key].delete_if { |o| o[:obs] == obs }
+      end
+
+      def set_value_for_key key, value
+        instance_variable_set '@' + key.to_s, value
+
+        @kvo_observers[key].each do |obs|
+          obs[:obs].send obs[:func], self, key, value
+        end if @kvo_observers and @kvo_observers[key]
+      end
+
+      module ClassMethods
+        def attr_kvo_accessor *accessors
+          accessors.each do |m|
+            define_method(m) do  
+              value_for_key m
+            end
+
+            define_method("#{m}=") do |val| 
+              set_value_for_key m, val
+            end
+          end
+        end
+      end
+
+      def self.included base
+        base.extend ClassMethods
+      end
+    end
+    
+    module Dynamic
+      def add_observer key, obs, &block
+        @kvo_observers ||= {}
+        @kvo_observers[key] ||= []
+        @kvo_observers[key] << {:obs => obs, :block => block}
+      end
+      
+      def remove_observer key, obs
+        @kvo_observers[key].delete_if { |o| o[:obs] == obs }
+      end
+
+      def set_value_for_key key, value
+        instance_variable_set '@' + key.to_s, value
+
+        @kvo_observers[key].each do |obs|
+          obs[:block].call self, key, value
+        end if @kvo_observers and @kvo_observers[key]
+      end
+
+      module ClassMethods
+        def attr_kvo_accessor *accessors
+          accessors.each do |m|
+            define_method(m) do  
+              value_for_key m
+            end
+
+            define_method("#{m}=") do |val| 
+              set_value_for_key m, val
+            end
+          end
+        end
+      end
+
+      def self.included base
+        base.extend ClassMethods
+      end
+    end
+  end
+  
+  module Binding
+    def bind key, obs, target, transformer=nil
+      self.add_observer key, obs do |source, k, value|
+        method = target.to_s + '='
+        value = transformer.nil? ? value : transformer.call(value)
+        obs.send method.to_sym, value
+      end
+    end
+    
+    def unbind key, obs
+      self.remove_observer key, obs
+    end
+  end
+end

data/test/keyvalue-test.rb

@@ -0,0 +1,172 @@
+require 'keyvalue'
+require 'test/unit'
+
+class Member
+  attr_accessor :value
+  
+  def initialize x
+    @value = x
+  end
+end
+
+class DynamicObservee
+  include KeyValue::KVC
+  include KeyValue::KVO::Dynamic
+  include KeyValue::Binding
+  
+  attr_kvo_accessor :variable, :variable2
+  attr_accessor :member
+  
+  def initialize
+    @variable = 'original value'
+    @member   = [Member.new(1), Member.new(2), Member.new(3)]
+  end
+end
+
+class StaticObservee
+  include KeyValue::KVC
+  include KeyValue::KVO::Static
+  
+  attr_kvo_accessor :variable, :variable2
+  attr_accessor :member
+  
+  def initialize
+    @variable = 'original value'
+    @member   = [Member.new(1), Member.new(2), Member.new(3)]
+  end
+end
+
+class Observing
+  attr_accessor :target
+  
+  def initialize
+    @target = nil
+  end
+  
+  def update source, key, value
+    @target = value if key == :variable
+  end
+end
+
+class TestKeyValue < Test::Unit::TestCase
+  def test_static_kvc
+    observee = StaticObservee.new
+    
+    assert_equal [1, 2, 3], observee.value_for_key_path('member.value')
+    assert_equal 6, observee.value_for_key_path('member.value.@sum')
+    assert_equal 2, observee.value_for_key_path('member.value.@avg')
+    assert_equal 3, observee.value_for_key_path('member.value.@max')
+    assert_equal 1, observee.value_for_key_path('member.value.@min')
+  end
+  
+  def test_dynamic_kvc
+    observee = DynamicObservee.new
+    
+    assert_equal [1, 2, 3], observee.value_for_key_path('member.value')
+    assert_equal 6, observee.value_for_key_path('member.value.@sum')
+    assert_equal 2, observee.value_for_key_path('member.value.@avg')
+    assert_equal 3, observee.value_for_key_path('member.value.@max')
+    assert_equal 1, observee.value_for_key_path('member.value.@min')
+  end
+  
+  def test_static_kvo
+    observee = StaticObservee.new
+    observer = Observing.new
+    
+    assert_equal 'original value', observee.variable
+    
+    observee.variable = 'test'
+    observee.variable = 'original value'
+    
+    observee.add_observer :variable, observer
+    
+    observee.variable = 'new value'
+    
+    assert_equal 'new value', observee.variable
+    assert_equal observee.variable, observer.target
+    
+    observee.remove_observer :variable, observer
+    
+    observee.variable = 'another new value'
+    
+    assert_equal 'another new value', observee.variable
+    assert_equal 'new value', observer.target
+  end
+  
+  def test_dynamic_kvo
+    observee = DynamicObservee.new
+    
+    assert_equal 'original value', observee.variable
+    
+    observee.variable = 'test'
+    observee.variable = 'original value'
+    
+    observee.add_observer :variable, :obs do |source,key,value|
+      assert_equal observee, source
+      assert_equal :variable, key
+      assert_equal 'new value', value
+    end
+    
+    observee.variable = 'new value'
+    
+    assert_equal 'new value', observee.variable
+  end
+  
+  def test_static_kvo_accessors
+    observee = DynamicObservee.new
+    
+    assert_respond_to observee, :variable
+    assert_respond_to observee, :variable=
+  end
+  
+  def test_dynamic_kvo_accessors
+    observee = DynamicObservee.new
+    
+    assert_respond_to observee, :variable
+    assert_respond_to observee, :variable=
+  end
+  
+  def test_bindings
+    observee  = DynamicObservee.new
+    observing = Observing.new
+    
+    observee.bind :variable, observing, :target
+    
+    assert_respond_to observee, :variable
+    assert_respond_to observee, :variable=
+    
+    assert_equal 'original value', observee.variable
+    assert_equal nil, observing.target
+    
+    observee.variable = 'new value'
+    
+    assert_equal 'new value', observee.variable
+    assert_equal observee.variable, observing.target
+    
+    observee.unbind :variable, observing
+    
+    observee.variable = 'another new value'
+    
+    assert_equal 'another new value', observee.variable
+    assert_equal 'new value', observing.target
+  end
+  
+  def test_transformer
+    observee  = DynamicObservee.new
+    observing = Observing.new
+    
+    observee.bind :variable, observing, :target, Proc.new { |value| value.upcase }
+    
+    assert_respond_to observee, :variable
+    assert_respond_to observee, :variable=
+    
+    assert_equal 'original value', observee.variable
+    assert_equal nil, observing.target
+    
+    observee.variable = 'new value'
+    
+    assert_equal 'new value', observee.variable
+    assert_equal 'NEW VALUE', observing.target
+    assert_equal observee.variable.upcase, observing.target
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: keyvalue
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Melchior Brislinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Key-Value Coding, Key-Value Observing & Bindings for Ruby.
+email: mb@ultravague.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/keyvalue.rb
+- test/keyvalue-test.rb
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/melchior-b/KeyValue
+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: keyvalue
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: KVC, KVO & Bindings for Ruby.
+test_files: 
+- test/keyvalue-test.rb