kvo 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 *.lock
+tags

data/README.md

@@ -1,7 +1,7 @@
 Description
 ===========
 
-Key-Value Observing in ruby
+Key-Value Observing and Binding in ruby
 
 ### Synopsis
 
@@ -9,16 +9,34 @@ Fires a [Publisher](http://atomicobject.github.com/publisher/) event whenever th
 
 ### How do I use it?
 
+```ruby
+    # kvo example 
     class Foo
       include Kvo
       kvo_attr_accessor :bar, :baz
     end
-        
+
     f = Foo.new
     f.when :bar_changed do |oldVal, newVal|
       puts "bar was changed from #{oldVal} to #{newVal}"
     end
 
+
+    # kvb example 
+    class Baz
+      attr_accessor :bar
+    end
+        
+    b = Bar.new
+    # b's bar will be updated whenever f's is
+    f.kvo_bind_attr :bar, b
+
+    # optional transforms
+    f.kvo_bind_attr :bar, b do |val|
+      val + 5
+    end
+```
+
 Authors
 =======
 * Shawn Anderson (shawn.anderson@atomicobject.com)

data/lib/kvo.rb

@@ -3,21 +3,42 @@ module Kvo
   module ClassMethods
     def kvo_attr_accessor(*kvo_symbols)
       kvo_symbols.each do |kvo|
+
+        raise "the method #{kvo} already exists" if self.instance_methods.include? kvo
+        raise "the method #{kvo}= already exists" if self.instance_methods.include? "#{kvo}=".to_sym
+
         class_eval <<-METHODS
           can_fire :#{kvo}_changed unless published_events == :any_event_is_ok
           def #{kvo}
             @kvo_#{kvo}
           end
-          def #{kvo}=(newVal)
+          def #{kvo}=(new_val)
             old = @kvo_#{kvo}
-            @kvo_#{kvo}=newVal
-            fire :#{kvo}_changed, old, newVal
+            @kvo_#{kvo}=new_val
+            fire :#{kvo}_changed, old, new_val
           end
         METHODS
       end
     end
   end
 
+  def kvo_bind_attr(attr_sym, target, opts={})
+    target_attr = opts[:to] || attr_sym
+    change_event = "#{attr_sym}_changed".to_sym
+
+    unless self.class.published_events.include? change_event
+      raise "#{attr_sym} is not a kvo attr; use #{self.class}.kvo_attr_accessor #{attr_sym}" 
+    end
+    
+    self.when change_event do |old, new_val|
+      val = new_val
+      # transform
+      val = yield(new_val) if block_given?
+
+      target.send "#{target_attr}=", val
+    end
+  end
+
   def self.included(receiver)
     receiver.extend         Publisher
     receiver.extend         ClassMethods

data/lib/kvo/version.rb

@@ -1,3 +1,3 @@
 module Kvo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/kvo_spec.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__),'helper')
 
-describe 'kvo' do
+describe '.kvo_attr_accessor' do
   before do
     @target = Foo.new
     @target.bar = :old
@@ -32,6 +32,21 @@ describe 'kvo' do
     @target.instance_variable_get("@bar").should be_nil
   end
 
+  it 'can call back a block of arity 0' do
+    @baz_fired = nil
+    @target.when :baz_changed do @baz_fired = true end
+    @target.baz = :something
+    @baz_fired.should be
+  end
+
+  it 'raises an error if attr setter is already defined' do
+    lambda{ ThingOne.kvo_attr_accessor :one }.should raise_exception(RuntimeError, /one= already exists/)
+  end
+
+  it 'raises an error if attr getter is already defined' do
+    lambda{ ThingTwo.kvo_attr_accessor :two }.should raise_exception(RuntimeError, /two already exists/)
+  end
+
   describe "inheritance" do
     before do
       @target = SubFoo.new
@@ -66,6 +81,44 @@ describe 'kvo' do
   end
 end
 
+describe '#kvo_bind_attr' do
+  let(:peter_pan) { 
+    peter = PeterPan.new 
+    peter.location = "OVER THERE"
+    peter.flying = false
+    peter
+  }
+  let(:shadow) { Shadow.new }
+
+  it 'modifies attr when bound objects attr changes' do
+    peter_pan.kvo_bind_attr :location, shadow
+    peter_pan.location = "NEVERLAND"
+
+    shadow.location.should == "NEVERLAND"
+  end
+
+  it 'can use a different method name on target' do
+    peter_pan.kvo_bind_attr :location, shadow, to: :place
+
+    peter_pan.location = "NEVERLAND"
+
+    shadow.location.should be_nil
+    shadow.place.should == "NEVERLAND"
+  end
+
+  it 'can transform new value with a block' do
+    peter_pan.kvo_bind_attr :location, shadow do |new_value|
+      new_value.downcase
+    end
+    peter_pan.location = "NEVERLAND"
+    shadow.location.should == "neverland"
+  end
+
+  it 'can bind to non-kvo attrs (by making them kvo)' do
+    lambda{ peter_pan.kvo_bind_attr :flying, shadow}.should raise_exception(RuntimeError, /flying is not a kvo attr/)
+  end
+end
+
 class Foo
   include Kvo
   kvo_attr_accessor :bar, :baz
@@ -74,3 +127,26 @@ end
 class SubFoo < Foo
   kvo_attr_accessor :qux
 end
+
+class PeterPan
+  include Kvo
+  kvo_attr_accessor :location
+  attr_accessor :flying
+end
+
+class Shadow
+  attr_accessor :location, :place, :flying
+end
+
+class ThingOne
+  include Kvo
+  attr_writer :one
+end
+
+class ThingTwo
+  include Kvo
+  attr_reader :two
+end
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: publisher
-  requirement: &2157009500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157009500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157008500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157008500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2157007540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157007540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: KVO in ruby.
 email:
 - shawn42@gmail.com
@@ -80,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: kvo
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: KVO in ruby