motion_bindable 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52e8be3ba802d2d3a4a0f1bdddbac59a32eea455
-  data.tar.gz: 6c14152e5fee498b339fe107141b0cf86aa778a3
+  metadata.gz: 28fbdbec6c2d3b77ecad6a2ca7c24b8ea3f87934
+  data.tar.gz: 30d6ce55f370a6a6c39b3cc40ba23d8f2d17480c
 SHA512:
-  metadata.gz: 089f88fb16423348824e9e04d3f5384e7f1cf9ced50c82779cd17cb3d3433783de8a8ec060abe40b4524375e6df3e84aff77da6b2d01db62393ae4f8ddccad89
-  data.tar.gz: ea79259bdcc11b2d20b75f53a4a11b95733b1691b1aab7ab2e77fb18141fd1b7b576655094befe3c3550f4f1faf6463467676f6270bb2f95e65396b042a3773c
+  metadata.gz: 4acbbb6b7e780bf08f12cd655513dc289990b81ac7056e492dca53e16175621b0dcbf67510e3ff8f1d8dc465d0d901c0aa85d1dd81f66b79820b308bcab86bd9
+  data.tar.gz: f5bb69ca4a6aebbaad375b4cb2f2ef5ddd81eb3119887dbb7986846322c863e17318c75aa3564a9e86389e971c2602127885d5ca920679df8d5bba4c3ce47f4d

data/Gemfile

@@ -2,5 +2,6 @@ source 'https://rubygems.org'
 
 gem 'rake'
 # Add your dependencies here:
+gem 'motion_model'
 gem 'webstub'
 gem 'motion-facon'

data/Gemfile.lock

@@ -1,7 +1,14 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    bubble-wrap (1.5.0)
     motion-facon (0.5.0.1)
+    motion-require (0.2.0)
+    motion-support (0.2.6)
+      motion-require (>= 0.0.6)
+    motion_model (0.5.0)
+      bubble-wrap (>= 1.3.0)
+      motion-support (>= 0.1.0)
     rake (10.1.0)
     webstub (1.0.1)
 
@@ -10,5 +17,6 @@ PLATFORMS
 
 DEPENDENCIES
   motion-facon
+  motion_model
   rake
   webstub

data/README.md

@@ -5,6 +5,11 @@
 
 A simple two-way data binding library for RubyMotion.
 
+## NOTICE
+
+Version `0.3.0` introduces breaking changes and deprecations. If you're upgrading, please check the [release
+notes](nathankot/motion-bindable/releases/tag/v0.3.0).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +29,7 @@ this to your `app_delegate.rb`:
 
 ``` ruby
 def application(application, didFinishLaunchingWithOptions: launch_options)
-  MotionBindable::Strategies.use
+  MotionBindable::Strategies.apply
   true
 end
 ```
@@ -75,6 +80,9 @@ class ItemListViewController
     view.addSubview @address_field
 
     @item = Item.new
+  end
+
+  def viewWillAppear(animated)
     @item.bind_attributes({
       name: @name_field,
       location: {
@@ -82,6 +90,11 @@ class ItemListViewController
       }
     })
   end
+
+  # Recommended: Clean everything up when the view leaves
+  def viewWillDisappear(animated)
+    @item.unbind_all
+  end
 end
 ```
 
@@ -101,9 +114,9 @@ The following strategies come with motion-bindable and are setup when
 
 | Name                                      | Object Candidates | Direction           |
 | ----------------------------------------- | ----------------- | ------------------- |
-| `MotionBindable::Strategies::UITextField` | Any `UITextField` | Bound >-< Attribute |
-| `MotionBindable::Strategies::Proc`        | Any `Proc`        | Bound >-- Attribute |
-| `MotionBindable::Strategies::UILabel`     | Any `UILabel`     | Bound --< Attribute |
+| `MotionBindable::Strategies::UITextField` | Any `UITextField` | Bound <-> Attribute |
+| `MotionBindable::Strategies::Proc`        | Any `Proc`        | Bound --> Attribute |
+| `MotionBindable::Strategies::UILabel`     | Any `UILabel`     | Bound <-- Attribute |
 
 ## Contributing
 

data/lib/motion_bindable/bindable.rb

@@ -11,8 +11,11 @@ module MotionBindable
     def bind_attributes(attrs, object = self)
       attrs.each_pair do |k, v|
         case v
+        # Recurse if another hash
         when Hash then bind_attributes(v, object.send(k))
+        # Allow binding multiple bound if an array
         when Array then v.each { |v| bind strategy_for(v).new(object, k).bind(v) }
+        # Otherwise bind
         else bind strategy_for(v).new(object, k).bind(v)
         end
       end

data/lib/motion_bindable/strategy.rb

@@ -1,9 +1,5 @@
 module MotionBindable
-
   class Strategy
-
-    WATCH_TICK = 0.2
-
     @strategies_map = [{ class: Strategy, candidates: [Object] }]
 
     def self.register_strategy(strategy, *objects)
@@ -25,14 +21,20 @@ module MotionBindable
       self.object = object
     end
 
-    public # Methods to override
+    public # (Optional) Methods to override
 
+    # def start_observing; end
     # def start_observing_bound; end
     # def start_observing_object; end
-    # def refresh_bound; end
     # def on_object_change; end
     # def on_bound_change; end
 
+    def bound_value
+    end
+
+    def object_value
+    end
+
     def bind(bound)
       self.bound = bound
       initial_state
@@ -41,9 +43,12 @@ module MotionBindable
     end
 
     def unbind
-      @watching = false
     end
 
+    # Deprecation support purposes
+    alias_method :refresh_bound, :bound_value
+    alias_method :refresh_object, :object_value
+
     private # Methods to leave alone
 
     def attribute
@@ -55,51 +60,18 @@ module MotionBindable
     end
 
     def initial_state
+      # We try to find an existing value and fill it up
       if attribute.nil? && respond_to?(:on_bound_change)
-        if respond_to?(:refresh_bound) then on_bound_change(refresh_bound)
-        else on_bound_change
-        end
+        on_bound_change(bound_value)
       elsif respond_to?(:on_object_change)
-        if respond_to?(:refresh_object) then on_object_change(refresh_object)
-        else on_object_change(attribute)
-        end
+        on_object_change(object_value)
       end
     end
 
     def start_listen
-      sides = []
-
-      if respond_to?(:start_observing_bound) then start_observing_bound
-      elsif respond_to?(:refresh_bound) && respond_to?(:on_bound_change)
-        sides << :bound
-      end
-      if respond_to?(:start_observing_object) then start_observing_object
-      elsif respond_to?(:refresh_object) && respond_to?(:on_object_change)
-        sides << :object
-      end
-
-      @watching = true
-      watch(sides)
-    end
-
-    def watch(sides)
-      dispatcher.async do
-        if @watching
-          bound_result = refresh_bound if sides.include?(:bound)
-          object_result = refresh_object if sides.include?(:object)
-          on_bound_change(bound_result) if bound_result
-          on_object_change(object_result) if object_result
-          dispatcher.after(WATCH_TICK) { watch(sides) }
-        end
-      end
+      start_observing if respond_to?(:start_observing)
+      start_observing_bound if respond_to?(:start_observing_bound)
+      start_observing_object if respond_to?(:start_observing_object)
     end
-
-    def dispatcher
-      @dispatcher ||= begin
-        Dispatch::Queue.concurrent 'motion.bindable'
-      end
-    end
-
   end
-
 end

data/lib/motion_bindable/strategy_helpers.rb

@@ -0,0 +1,72 @@
+module MotionBindable::StrategyHelpers
+  # A generic method for observing an object's attribute that is
+  # being bound to.
+  #
+  # Where strategies deal with observing a large variety of possible bound
+  # objects, this method will only have to worry about a small set of possible
+  # objects being binded to, KVO should actually cover most cases.
+  def observe_object(&block)
+    @_observe_object_cb = block
+
+    if defined?(MotionModel::Model) && object.is_a?(MotionModel::Model)
+      @_observe_object_mode = :motion_model
+      start_observing_motion_model
+    else
+      @_observe_object_mode = :kvo
+      start_observing_kvo
+    end
+  end
+
+  def stop_observe_object
+    case @_observe_object_mode
+    when :kvo then stop_observing_kvo
+    end
+
+    @_observe_object_mode,
+    @_observe_object_block = nil
+  end
+
+  # NSKeyValueObserving Protocol
+
+  def observeValueForKeyPath(_, ofObject: _, change: change, context: _)
+    @_observe_object_cb.call(change[:old], change[:new])
+  end
+
+  private
+
+  def start_observing_motion_model
+    @_observe_object_old_value = object.send(attr_name)
+    NSNotificationCenter.defaultCenter.addObserverForName(
+      'MotionModelDataDidChangeNotification',
+      object: object,
+      queue: nil,
+      usingBlock: proc do |notification|
+        new = notification.object.send(attr_name)
+        @_observe_object_cb.call(
+          @_observe_object_old_value,
+          new
+        ) if @_observe_object_cb
+        @_observe_object_old_value = new
+      end
+    )
+  end
+
+  def start_observing_kvo
+    object.addObserver(
+      self,
+      forKeyPath: attr_name,
+      options: NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld,
+      context: nil
+    )
+  end
+
+  def stop_observing_kvo
+    object.removeObserver(
+      self,
+      forKeyPath: attr_name
+    )
+  rescue
+    # See: http://nshipster.com/key-value-observing/
+    true
+  end
+end

data/lib/motion_bindable/version.rb

@@ -1,3 +1,3 @@
 module MotionBindable
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/lib/strategies/proc.rb

@@ -1,12 +1,12 @@
 module MotionBindable::Strategies
-
   class Proc < ::MotionBindable::Strategy
+    WATCH_TICK = 0.2
 
-    def refresh_bound
+    def bound_value
       bound.call
     end
 
-    def refresh_object
+    def object_value
       attribute
     end
 
@@ -19,6 +19,28 @@ module MotionBindable::Strategies
       super
     end
 
-  end
+    def start_observing
+      @watching = true
+      watch
+    end
+
+    private
 
+    def watch
+      dispatcher.async do
+        if @watching
+          new = bound_value
+          on_bound_change(new) if new != @old_bound_value
+          @old_bound_value = nil
+          dispatcher.after(WATCH_TICK) { watch }
+        end
+      end
+    end
+
+    def dispatcher
+      @dispatcher ||= begin
+        Dispatch::Queue.concurrent 'org.motion.bindable'
+      end
+    end
+  end
 end

data/lib/strategies/ui_label.rb

@@ -1,15 +1,9 @@
 module MotionBindable::Strategies
-
   class UILabel < ::MotionBindable::Strategy
+    include MotionBindable::StrategyHelpers
 
     def start_observing_object
-      # Observe the attribute
-      object.addObserver(
-        self,
-        forKeyPath: attr_name,
-        options: NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld,
-        context: nil
-      )
+      observe_object { |_, new| on_object_change(new) }
     end
 
     def on_object_change(new = nil)
@@ -22,10 +16,8 @@ module MotionBindable::Strategies
     end
 
     def unbind
-      object.removeObserver(self, forKeyPath: attr_name)
+      stop_observe_object
       super
     end
-
   end
-
 end

data/lib/strategies/ui_text_field.rb

@@ -1,6 +1,6 @@
 module MotionBindable::Strategies
-
   class UITextField < ::MotionBindable::Strategy
+    include MotionBindable::StrategyHelpers
 
     def start_observing_bound
       @bound_observer = NSNotificationCenter.defaultCenter.addObserverForName(
@@ -12,13 +12,7 @@ module MotionBindable::Strategies
     end
 
     def start_observing_object
-      # Observe the attribute
-      object.addObserver(
-        self,
-        forKeyPath: @attr_name,
-        options: NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld,
-        context: nil
-      )
+      observe_object { |_, new| on_object_change(new) }
     end
 
     def on_bound_change(new = nil)
@@ -31,16 +25,8 @@ module MotionBindable::Strategies
 
     def unbind
       NSNotificationCenter.defaultCenter.removeObserver(@bound_observer)
-      object.removeObserver(self, forKeyPath: @attr_name)
+      stop_observe_object
       super
     end
-
-    # NSKeyValueObserving Protocol
-
-    def observeValueForKeyPath(_, ofObject: _, change: _, context: _)
-      on_object_change
-    end
-
   end
-
 end

data/spec/strategy_helpers_spec.rb

@@ -0,0 +1,57 @@
+describe 'MotionBindable::StrategyHelpers' do
+  class TestObject
+    attr_accessor :prop
+  end
+
+  class TestModel
+    include MotionModel::Model
+    include MotionModel::ArrayModelAdapter
+    columns :prop
+  end
+
+  class TestStrategy < MotionBindable::Strategy
+    include MotionBindable::StrategyHelpers
+
+    def observe(&block)
+      observe_object(&block)
+    end
+  end
+
+  describe '#observe_object' do
+    describe 'normal object' do
+      before do
+        @object = TestObject.new
+        @response = nil
+        @strategy = TestStrategy.new(@object, :prop)
+      end
+
+      it 'should call the cb for changes' do
+        @strategy.observe { |old, new| @response = new }
+        @object.prop = 'updated'
+        wait(0.5) do
+          @response.should.equal 'updated'
+        end
+      end
+    end
+
+    describe 'MotionModel' do
+      before do
+        @object = TestModel.new
+        @response = nil
+        @strategy = TestStrategy.new(@object, :prop)
+      end
+
+      it 'should call the cb for changes' do
+        @strategy.observe { |old, new| @response = new }
+        @object.prop = 'updated'
+        @object.save
+        wait(0.5) { @response.should.equal 'updated' }
+      end
+
+      it 'should not turn the model.class into a KVO thingy' do
+        @strategy.observe { |old, new| @response = new }
+        @object.is_a?(MotionModel::Model).should.equal true
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion_bindable
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Nathan Kot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-19 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies: []
 description: A simple data binding library for RubyMotion.
 email:
@@ -29,6 +29,7 @@ files:
 - lib/motion_bindable.rb
 - lib/motion_bindable/bindable.rb
 - lib/motion_bindable/strategy.rb
+- lib/motion_bindable/strategy_helpers.rb
 - lib/motion_bindable/version.rb
 - lib/strategies/proc.rb
 - lib/strategies/strategies.rb
@@ -45,6 +46,7 @@ files:
 - spec/strategies/ui_label_spec.rb
 - spec/strategies/ui_label_x_ui_text_field_spec.rb
 - spec/strategies/ui_text_field_spec.rb
+- spec/strategy_helpers_spec.rb
 homepage: https://github.com/nathankot/motion-bindable
 licenses:
 - MIT
@@ -79,3 +81,4 @@ test_files:
 - spec/strategies/ui_label_spec.rb
 - spec/strategies/ui_label_x_ui_text_field_spec.rb
 - spec/strategies/ui_text_field_spec.rb
+- spec/strategy_helpers_spec.rb