motion_bindable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ef10a54e768eb79857d0bd5539519a6b90932e0
+  data.tar.gz: cf500b93047492d2fb8dfbeba5c9b70e386c6f29
+SHA512:
+  metadata.gz: 3ff1166dc058c57b9fa4adaea29eef1a328e0061c49a6d831edf0986a5aed0486066988471f17f5581f658ee58489c927b6c7381643bfc1b101f57df765edd1e
+  data.tar.gz: bda1bc7c69f24ca5fe4046cf4cc4dce45a66cc3a8160d76459f445eea30448d63d4954b32c1c75f1c7fb6339a61a4e63155e7d1ae3432654be23a00dec036fae

data/.gitignore

@@ -0,0 +1,32 @@
+.repl_history
+build
+tags
+app/pixate_code.rb
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+.DS_Store
+nbproject
+.redcar
+#*#
+*~
+*.sw[po]
+.eprj
+.sass-cache
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+# Add your dependencies here:
+gem 'webstub'
+gem 'motion-stump'

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    motion-stump (0.3.0)
+    rake (10.1.0)
+    webstub (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  motion-stump
+  rake
+  webstub

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathan Kot
+
+MIT License
+
+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.md

@@ -0,0 +1,94 @@
+# Motion Bindable
+
+A simple data binding library for RubyMotion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'motion_bindable'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+If you want to use the default strategies that come with MotionBindable add
+this to your `app_delegate.rb`:
+
+``` ruby
+def application(application, didFinishLaunchingWithOptions: launch_options)
+  MotionBindable::Strategies.use
+  true
+end
+```
+
+## Usage
+
+Add `include MotionBindable::Bindable` to make an object bindable:
+
+```ruby
+# Models
+
+class Item
+  include MotionBindable::Bindable
+  attr_accessor :name
+  attr_accessor :location
+
+  def location
+    @address ||= Address.new
+  end
+end
+
+class Address
+  attr_accessor :address
+end
+```
+
+In your view controller, you can bind the object to a set of Views or any
+other object:
+
+```ruby
+class ItemListViewController
+  def viewDidLoad
+    super
+    @name_field = UITextField.alloc.initWithFrame [[110, 60], [100, 26]]
+    @name_field.placeholder = "Name"
+    view.addSubview @name_field
+
+    @address_field = UITextField.alloc.initWithFrame [[110, 100], [100, 26]]
+    @address_field.placeholder = "Address"
+    view.addSubview @address_field
+
+    @item = Item.new
+    @item.bind_attributes({
+      name: @name_field,
+      location: {
+        address: @address_field
+      }
+    })
+  end
+end
+```
+
+When `@name_field.text` or `@address_field.text` changes, so will your model!
+
+### Strategies
+
+The above example uses the `MotionBindable::Strategies::UITextField`.
+which comes with MotionBindable. Take a look in
+`lib/motion_bindable/strategies` for the available defaults. You can implement
+your own strategies by extending `MotionBindable::Strategy` like so:
+
+**TODO**
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift('/Library/RubyMotion/lib')
+require 'motion/project/template/ios'
+
+require './lib/motion_bindable'
+require 'bundler'
+Bundler.require
+
+Motion::Project::App.setup do |app|
+  # Use `rake config' to see complete project settings.
+  app.name = 'motion_bindable'
+end

data/app/app_delegate.rb

@@ -0,0 +1,2 @@
+class AppDelegate
+end

data/lib/motion_bindable/bindable.rb

@@ -0,0 +1,50 @@
+module MotionBindable
+
+  #
+  # # Bindable Module
+  #
+  # Allow attributes of an object to be bound to other arbitrary objects
+  # through unique strategies.
+  #
+  # ## One-way binding
+  #
+  # Currently bindings are only one-way, i.e change in the arbitrary object
+  # affects the bindable object but not vice-versa.
+  #
+  module Bindable
+
+    def bind_attributes(attrs, object = self)
+      attrs.each_pair do |k, v|
+        if v.is_a?(Hash) then bind_attributes(v, object.send(k)) 
+        else bind strategy_for(v).new(object, k).bind(v)
+        end
+      end
+    end
+
+    def bind(strategy)
+      @bindings ||= []
+      @bindings << strategy
+      self
+    end
+
+    def refresh
+      @bindings.each { |b| b.refresh }
+    end
+
+    private
+
+    def strategy_for(reference)
+      Strategy.find_by_reference(reference)
+    end
+
+    def underscore(str)
+      str.gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+      .tr("-", "_")
+      .downcase
+    end
+
+  end
+
+end

data/lib/motion_bindable/delegate_proxy.rb

@@ -0,0 +1,23 @@
+module MotionBindable
+
+  # This allows objects to register multiple delegates
+  class DelegateProxy
+
+    attr_accessor :delegates
+
+    def initialize(*initial_delegates)
+      self.delegates = initial_delegates
+    end
+
+    def method_missing(name, *args, &block)
+      responses = []
+      delegates.each do |delegate|
+        responses << delegate.send(name, *args, &block) if delegate.respond_to?(name)
+      end
+
+      responses.first
+    end
+
+  end
+
+end

data/lib/motion_bindable/strategy.rb

@@ -0,0 +1,53 @@
+module MotionBindable
+
+  #
+  # Represents a binding strategy. Designed to be as flexible as possible.
+  #
+  class Strategy
+
+    @strategies_map = [{ class: Strategy, candidates: [Object] }]
+
+    def self.register_strategy(strategy, *objects)
+      @strategies_map << { class: strategy, candidates: objects }
+    end
+
+    def self.find_by_reference(object)
+      @strategies_map.reverse.find do |h|
+        h[:candidates].include? object.class
+      end.fetch(:class)
+    end
+
+    attr_accessor :object
+    attr_accessor :bound
+
+    def initialize(object, attribute)
+      @attribute = attribute.to_sym
+      self.object = object
+    end
+
+    def bind(bound)
+      self.bound = bound
+      on_bind
+
+      self
+    end
+
+    # You can either choose to just override `#refresh` for objects that can't
+    # be bound with callbacks. Or override `#on_bind` for objects that can be
+    # bound with a callback.
+    def refresh; end
+    def on_bind
+      refresh
+    end
+
+    def attribute
+      object.send(@attribute)
+    end
+
+    def attribute=(value)
+      object.send(:"#{@attribute.to_s}=", value)
+    end
+
+  end
+
+end

data/lib/motion_bindable/version.rb

@@ -0,0 +1,3 @@
+module MotionBindable
+  VERSION = "0.0.1"
+end

data/lib/motion_bindable.rb

@@ -0,0 +1,19 @@
+unless defined?(Motion::Project::Config)
+  raise "The motion_bindable gem must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+
+  Dir.glob(
+    File.join(File.dirname(__FILE__), 'motion_bindable/**/*.rb')
+  ).each do |file|
+    app.files.unshift(file)
+  end
+
+  Dir.glob(
+    File.join(File.dirname(__FILE__), 'strategies/**/*.rb')
+  ).each do |file|
+    app.files.unshift(file)
+  end
+
+end

data/lib/strategies/strategies.rb

@@ -0,0 +1,10 @@
+module MotionBindable::Strategies
+
+  def self.apply
+    ::MotionBindable::Strategy.register_strategy(
+      MotionBindable::Strategies::UITextField,
+      ::UITextField
+    )
+  end
+
+end

data/lib/strategies/ui_text_field.rb

@@ -0,0 +1,30 @@
+module MotionBindable::Strategies
+
+  class UITextField < ::MotionBindable::Strategy
+
+    def on_bind
+      if bound.delegate.is_a? ::MotionBindable::DelegateProxy
+        bound.delegate.delegates << self
+      else
+        bound.delegate = ::MotionBindable::DelegateProxy.new(
+          bound.delegate,
+          self
+        )
+      end
+
+      update_attribute
+    end
+
+    def textFieldDidEndEditing(_)
+      update_attribute
+    end
+
+    private
+
+    def update_attribute
+      self.attribute = bound.text
+    end
+
+  end
+
+end

data/motion_bindable.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/motion_bindable/version.rb', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "motion_bindable"
+  spec.version       = MotionBindable::VERSION
+  spec.authors       = ["Nathan Kot"]
+  spec.email         = ["nk@nathankot.com"]
+  spec.description   = 'A simple data binding library for RubyMotion.'
+  spec.summary       = 'Inspired by RivetsJS'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/spec/bindable_spec.rb

@@ -0,0 +1,59 @@
+describe 'MotionBindable::Bindable' do
+
+  class FakeStrategy < MotionBindable::Strategy
+  end
+
+  class FakeBindable
+    include MotionBindable::Bindable
+    attr_accessor :attribute
+    attr_accessor :nested
+  end
+
+  before do
+    @object = FakeBindable.new
+    @bound = Object.new
+    @object.stub!(:strategy_for) { |_| FakeStrategy }
+  end
+
+  describe '#bind_attributes' do
+    before do
+      @object.nested = FakeBindable.new
+    end
+
+    it 'accepts nested attributes' do
+      FakeStrategy.stub!(:bind) do |attribute|
+        @attribute = attribute
+      end
+
+      @object.bind_attributes({
+        attribute: @bound,
+        nested: {
+          attribute: @bound
+        }
+      })
+
+      @attribute.should.equal @object.nested.attribute
+    end
+
+    it 'passes the strategy to bind' do
+      @called = false
+      @object.stub!(:bind) { |_| @called = true }
+      @object.bind_attributes({ attribute: @bound })
+      @called.should.equal true
+    end
+
+  end
+
+  describe '#bind' do
+
+    before do
+      @strategy = FakeStrategy.new(@object, :attribute)
+    end
+
+    it 'should be chainable' do
+      @object.bind(@strategy).should.equal @object
+    end
+
+  end
+
+end

data/spec/strategy_spec.rb

@@ -0,0 +1,67 @@
+Strategy = MotionBindable::Strategy
+
+class ObjectOne; attr_accessor :attribute end
+class ObjectTwo; attr_accessor :attribute end
+
+class FakeStrategyOne < Strategy; end
+class FakeStrategyTwo < Strategy; end
+
+describe 'MotionBindable::Strategy' do
+
+  before do
+    Strategy.register_strategy(FakeStrategyOne, ObjectOne)
+    Strategy.register_strategy(FakeStrategyTwo, ObjectTwo)
+  end
+
+  describe 'class methods' do
+
+    describe 'self#find_by_reference' do
+
+      it 'returns a strategy that specifies the object as a candidate' do
+        Strategy.find_by_reference(ObjectOne.new).should.equal FakeStrategyOne
+        Strategy.find_by_reference(ObjectTwo.new).should.equal FakeStrategyTwo
+      end
+
+    end
+
+  end
+
+  describe 'instance methods' do
+
+    before do
+      @object = ObjectOne.new
+      @bound = Object.new
+      @strategy = Strategy.new(@object, :attribute)
+    end
+
+    describe '#bind' do
+      it 'should respond' do
+        @strategy.respond_to?(:bind).should.equal true
+      end
+
+      it 'should set the bound object' do
+        @strategy.bind(@bound)
+        @strategy.bound.should.equal @bound
+      end
+
+      it 'should return self' do
+        @strategy.bind(@bound).should.equal @strategy
+      end
+    end
+
+    describe '#refresh' do
+      it 'should respond' do
+        @strategy.respond_to?(:refresh).should.equal true
+      end
+    end
+
+    describe '#attribute=' do
+      it 'should be a proxy to set the attribute on the bound object' do
+        @strategy.attribute = 'test'
+        @object.attribute.should.equal 'test'
+      end
+    end
+
+  end
+
+end

data/spec/ui_text_field_strategy_spec.rb

@@ -0,0 +1,68 @@
+class FakeModel
+  include MotionBindable::Bindable
+  attr_accessor :attribute
+  attr_accessor :nested
+end
+
+describe 'MotionBindable::Strategies::UITextField' do
+
+  before do
+    MotionBindable::Strategy.register_strategy(
+      MotionBindable::Strategies::UITextField,
+      UITextField
+    )
+
+    @app = UIApplication.sharedApplication
+    @text_field = UITextField.alloc.initWithFrame [[110, 60], [100, 26]]
+  end
+
+  context 'nested model' do
+
+    before do
+      @object = FakeModel.new
+      @object.nested = FakeModel.new
+    end
+
+    context 'text set and then bound' do
+
+      before do
+        @text_field.text = 'Just testing.'
+        @object.bind_attributes({
+          attribute: @text_field,
+          nested: {
+            attribute: @text_field
+          }
+        })
+      end
+
+      it 'should update the root attribute' do
+        @object.attribute.should.equal 'Just testing.'
+      end
+
+      it 'should update the nested attribute' do
+        @object.nested.attribute.should.equal 'Just testing.'
+      end
+
+      context 'text field is updated' do
+
+        before do
+          @text_field.text = 'Updated.'
+          @text_field.delegate.textFieldDidEndEditing(self)
+        end
+
+        it 'should update the root attribute' do
+          @object.attribute.should.equal 'Updated.'
+        end
+
+        it 'should update the nested attribute' do
+          @object.nested.attribute.should.equal 'Updated.'
+        end
+
+      end
+
+    end
+
+  end
+
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: motion_bindable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Kot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies: []
+description: A simple data binding library for RubyMotion.
+email:
+- nk@nathankot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion_bindable.rb
+- lib/motion_bindable/bindable.rb
+- lib/motion_bindable/delegate_proxy.rb
+- lib/motion_bindable/strategy.rb
+- lib/motion_bindable/version.rb
+- lib/strategies/strategies.rb
+- lib/strategies/ui_text_field.rb
+- motion_bindable.gemspec
+- resources/Default-568h@2x.png
+- spec/bindable_spec.rb
+- spec/strategy_spec.rb
+- spec/ui_text_field_strategy_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Inspired by RivetsJS
+test_files:
+- spec/bindable_spec.rb
+- spec/strategy_spec.rb
+- spec/ui_text_field_strategy_spec.rb