motion-loco 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDUzNjAyZjM3YWVhYzM3ZjgyZTJlYjkzZmE2NjY2ODI0NTc3ZjU5YQ==
+    NzdjMjhmYjA5ZTgzNjEzMTg2ZTQ1ZjcxZjYyOGEwMWRjM2I3NWI2MA==
   data.tar.gz: !binary |-
-    ZTI3YTRjMDEwNzQ5M2FjZjQyYjU2MWU2YWIyY2FlOTI5MTRhOGZiZQ==
+    NTVkY2JlMmE0MzE1NTI0OTk2YmI5YjJiZmJiNmRlZGZlYmEyZDI3Mg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTA2ODIxODZkY2M0NzgyMTMxZGM2YmM0NDAzYTQ1MGJlNzA5ZmNjNzEzOTJj
-    ZjM2NWU3NmZkM2Y0ZTQ4ZDUwY2ZlZWZlMTg2ZTI5YjRjYzNhNzJiY2Q2ODA5
-    Njk3MThkZGY4MzNiNTUzMjYwMmQ0N2E3ODEzMzZlNDg1ZTZiMmU=
+    MzQ5YTcyNjAxODRlYTU5NGVlMmE1YWU2OTc5MTcxYzVjZmVhNzkxNTk2NmQ3
+    ZDQxMzQ3ZTJlNzczYjYxYWI2OTQ2NTlmY2JlZGUzNzI4ODNiNTI2YjMxNTll
+    ZGZhNDI5MGFhZGM2MzM3ZTYwNWU4Y2NlMDYyODlmYTk2NGQxYTg=
   data.tar.gz: !binary |-
-    MWFiNzQ4MmZlYzA2ZGFhYTcwZmM0ODA3MjdjOGFlZGUwY2FlNWEwNmNjMGI2
-    NzM1ODU4NmY5ZGRlNTUyYWJiMDAyOGIzYTBhN2I3ZDYzNWFlMzEzZjVkM2E1
-    Mzk1MDg0NzVjZjY0ODQxZmQzOWQwNDhmZTQ2Zjg3MzZjN2JiOGI=
+    MzlhNDI5ODUzODczZDZlNzgzMDIxOGNkYjkyMGU5YTZiY2M3YWM2NDg3YTNm
+    YWZiZjE2NzE3NWNiZTExNTZkYTAwOGYzY2NmZTlmYTY3MmUxOWVkZjU4NTVk
+    NTVlYzlkMWRkOTRmNWFhNWQxMTU4ZDZjMzQwY2JkODY0NmZhNTQ=

data/README.md

@@ -2,20 +2,19 @@
 
 Motion-Loco is a library for [RubyMotion](http://rubymotion.com) 
 that includes [Ember.js](http://emberjs.com) inspired bindings, 
-computed properties, and observers.
+computed properties, and observers. **And Ember-Data inspired [data](#locofixtureadapter) [adapters](#locorestadapter)!**
 
-Also included is a set of views that are easier to position and size.
+## What's New!
 
-**I'm not using this in production yet. It might be ready, 
-but I feel like it needs some more features to really be useful.**
+### June 23th, 2013
 
-## What's New!
+#### SQLiteAdapter and Relationships!
 
-### June 7th, 2013
+I need to write up some better documentation, but be sure to check out the [Loco::SQLiteAdapter](locosqliteadapter) and the new `has_many` and `belongs_to` relationships in `Loco::Model`.
 
-#### Data Adapters
+The relationship stuff needs some major code clean up, so don't copy my code if you're doing anything similar for loading/saving relationship data. :)
 
-These are still a bit of a work in progress, but [worth](#locofixtureadapter) [checking out](#locorestadapter)!
+The [tests](https://github.com/brianpattison/motion-loco/tree/master/spec) all pass though... so that's something, right?
 
 ## Installation
 
@@ -40,8 +39,8 @@ They beat out using a method because they can be observed like any other propert
 
 ```ruby
 class Person < Loco::Model
-  property :first_name
-  property :last_name
+  property :first_name, :string
+  property :last_name, :string
   
   # Computed property for full name that watches for changes
   # in the object's first_name and last_name properties.
@@ -64,8 +63,8 @@ Bindings are used to link the property of an object to a property of another obj
 
 ```ruby
 class Person < Loco::Model
-  property :first_name
-  property :last_name
+  property :first_name, :string
+  property :last_name, :string
   property :full_name, lambda{|object|
     "#{object.first_name} #{object.last_name}"
   }.property(:first_name, :last_name)
@@ -76,7 +75,7 @@ end
   last_name:  'Pattison'
 )
 
-@label = Loco::Label.alloc.initWithFrame(
+@label = Loco::UI::Label.alloc.initWithFrame(
   textBinding: [@person, 'full_name'],
   height: 30,
   top: 20,
@@ -96,7 +95,7 @@ class PersonController < Loco::Controller
   property :content
 end
 
-@label = Loco::Label.alloc.initWithFrame(
+@label = Loco::UI::Label.alloc.initWithFrame(
   textBinding: 'PersonController.content.full_name',
   height: 30,
   top: 20,
@@ -113,18 +112,18 @@ PersonController.content = @person
 @label.text # "Brian Pattison"
 ```
 
-### Loco::TableView
+### Loco::UI::TableView
 
-A `Loco::TableView` is used for to easily bind a collection of objects
+A `Loco::UI::TableView` is used for to easily bind a collection of objects
 to a `UITableView` and each item in the collection to a reusable `UITableViewCell`.
 
 ```ruby
-class MyTableViewCell < Loco::TableViewCell
+class MyTableViewCell < Loco::UI::TableViewCell
   # The `view_setup` method is called the first time the cell is created.
   # Bindings can be made to the item assigned to the cell
   # by binding to `parentView.content`.
   def view_setup
-    @label = Loco::Label.alloc.initWithFrame(
+    @label = Loco::UI::Label.alloc.initWithFrame(
       textBinding: 'parentView.content.first_name',
       height: 30,
       left: 60,
@@ -135,7 +134,7 @@ class MyTableViewCell < Loco::TableViewCell
   end
 end
 
-class MyTableView < Loco::TableView
+class MyTableView < Loco::UI::TableView
   item_view_class MyTableViewCell
 end
 
@@ -153,7 +152,7 @@ end
 ```ruby
 class Show < Loco::Model
   adapter 'Loco::FixtureAdapter'
-  property :title
+  property :title, :string
 end
 
 @show = Show.find(2) # Loads from `resources/fixtures/plural_class_name.json`
@@ -165,8 +164,8 @@ end
 ```ruby
 class Post < Loco::Model
   adapter 'Loco::RESTAdapter', 'http://localhost:3000'
-  property :title
-  property :body
+  property :title, :string
+  property :body, :string
 end
 
 # GET http://localhost:3000/posts/1.json
@@ -211,13 +210,42 @@ end
 end
 ```
 
-## Todo
+### Loco::SQLiteAdapter
+```ruby
+class Player < Loco::Model
+  adapter 'Loco::SQLiteAdapter'
+  property :name, :string
+  has_many :scores
+end
+
+class Score < Loco::Model
+  adapter 'Loco::SQLiteAdapter'
+  property :rank, :integer
+  property :value, :integer
+  belongs_to :player
+end
+
+@player = Player.new(name: 'Kirsten Pattison')
+@player.save
+
+@score = Score.new(rank: 1, value: 50000, player: @player)
+@score.save
+
+@player.scores.length # 1
+@score.player.name    # Kirsten Pattison
+```
+
+## TODO
 
+- RESTAdapter
+    - Sideload belongs_to/has_many
+- SQLiteAdapter
+    - Data migrations?
 - State Manager
-- Relationships
-- More Adapters
-    - Core Data (Are SQLite and iCloud also part of this adapter??)
-- Lots of stuff
+    - Pretty big challenge, so it might be a while
+    - Limit transitions between states
+    - Rollback dirty/unsaved records
+- Improve everything! :)
 
 ## Contributing
 

data/lib/motion-loco.rb

@@ -8,4 +8,8 @@ require 'bubble-wrap/http'
 require 'motion-require'
 require 'motion-support/inflector'
 
-Motion::Require.all(Dir.glob(File.expand_path('../motion-loco/**/*.rb', __FILE__)))
+Motion::Require.all(Dir.glob(File.expand_path('../motion-loco/**/*.rb', __FILE__)))
+
+Motion::Project::App.setup do |app|
+  app.frameworks += ['CoreData']
+end

data/lib/motion-loco/adapter.rb

@@ -1,3 +1,5 @@
+motion_require 'convenience_methods'
+
 module Loco
   
   class Adapter
@@ -6,6 +8,10 @@ module Loco
       raise NoMethodError, "Loco::Adapter subclasses must implement #create_record(record, &block)."
     end
     
+    def delete_record(record, &block)
+      raise NoMethodError, "Loco::Adapter subclasses must implement #delete_record(record, &block)."
+    end
+    
     def find(record, id, &block)
       raise NoMethodError, "Loco::Adapter subclasses must implement #find(record, id, &block)."
     end
@@ -22,14 +28,172 @@ module Loco
       raise NoMethodError, "Loco::Adapter subclasses must implement #find_query(type, records, params, &block)."
     end
     
-    def save_record(record, &block)
-      raise NoMethodError, "Loco::Adapter subclasses must implement #save_record(record, &block)."
+    def update_record(record, &block)
+      raise NoMethodError, "Loco::Adapter subclasses must implement #update_record(record, &block)."
     end
     
-    def delete_record(record, &block)
-      raise NoMethodError, "Loco::Adapter subclasses must implement #delete_record(record, &block)."
+    def serialize(record, options={}, json={})
+      properties = record.class.get_class_properties.select{|prop| 
+        if prop[:type]
+          if prop[:name] == :id
+            options[:include_id] || options[:includeId]
+          else
+            true
+          end
+        end
+      }
+      
+      transforms = self.class.get_transforms
+      
+      properties.each do |property|
+        key = property[:name].to_sym
+        transform = transforms[property[:type]]
+        if transform
+          json[key] = transform[:serialize].call(record.valueForKey(key))
+        else
+          json[key] = record.valueForKey(key)
+        end
+      end
+      
+      if options[:root] != false
+        if options[:root].nil? || options[:root] == true
+          root = record.class.to_s.underscore.to_sym
+        else
+          root = options[:root].to_sym
+        end
+        temp = {}
+        temp[root] = json
+        json = temp
+      end
+      json
+    end
+    
+    class << self
+      
+      def get_transforms
+        if @transforms.nil?
+          @transforms = {}
+          if self.superclass.respond_to? :get_transforms
+            @transforms.merge!(self.superclass.get_transforms)
+          end
+        end
+        @transforms
+      end
+      
+      def register_transform(name, transforms={})
+        @transforms = get_transforms
+        @transforms[name.to_sym] = transforms
+      end
+      alias_method :registerTransform, :register_transform
+      
     end
     
+  private
+    
+    def load(type, records, data)
+      if records.is_a? Array
+        if data.is_a? Hash
+          data = data[type.to_s.underscore.pluralize]
+        end
+        records.load(type, transform_data(type, data))
+      else
+        if data.is_a?(Hash) && data.has_key?(type.to_s.underscore)
+          data = data[type.to_s.underscore] 
+        end
+        records.load(data.valueForKey(:id), transform_data(type, data))
+      end
+    end
+    
+    def transform_data_item(type, data)
+      json = {}
+      transforms = self.class.get_transforms
+      
+      type.get_class_properties.each do |property|
+        key = property[:name].to_sym
+        transform = transforms[property[:type]]
+        if transform
+          json[key] = transform[:deserialize].call(data.valueForKey(key))
+        else
+          json[key] = data.valueForKey(key)
+        end
+      end
+      
+      type.get_class_relationships.each do |relationship|
+        if relationship[:belongs_to]
+          key = "#{relationship[:belongs_to]}_id".to_sym
+        elsif relationship[:has_many]
+          key = "#{relationship[:has_many].to_s.singularize}_ids".to_sym
+        end
+        json[key] = data.valueForKey(key)
+      end
+      
+      json
+    end
+    
+    def transform_data(type, data)
+      if data.is_a? Array
+        json = []
+        data.each do |data_item|
+          json << transform_data_item(type, data_item)
+        end
+        json
+      else
+        transform_data_item(type, data)
+      end
+    end
   end
   
+  Adapter.register_transform(:date, {
+    serialize: lambda{|value|
+      dateFormatter = NSDateFormatter.alloc.init
+      dateFormatter.setDateFormat('yyyy-MM-dd')
+      value = dateFormatter.stringFromDate(value)
+    },
+    deserialize: lambda{|value|
+      if value.is_a? NSDate
+        value
+      else
+        dateFormatter = NSDateFormatter.alloc.init
+        dateFormatter.setDateFormat('yyyy-MM-dd')
+        dateFormatter.dateFromString(value.to_s)
+      end
+    }
+  })
+  
+  Adapter.register_transform(:array, {
+    serialize: lambda{|value|
+      value.to_a
+    },
+    deserialize: lambda{|value|
+      value.to_a
+    }
+  })
+  
+  Adapter.register_transform(:integer, {
+    serialize: lambda{|value|
+      value.to_i
+    },
+    deserialize: lambda{|value|
+      value.to_i
+    }
+  })
+  
+  Adapter.register_transform(:float, {
+    serialize: lambda{|value|
+      value.to_f
+    },
+    deserialize: lambda{|value|
+      value.to_f
+    }
+  })
+  
+  Adapter.register_transform(:string, {
+    serialize: lambda{|value|
+      value.to_s
+    },
+    deserialize: lambda{|value|
+      value.to_s
+    }
+  })
+  
 end

data/lib/motion-loco/fixture_adapter.rb

@@ -11,15 +11,16 @@ module Loco
     end
     
     def find(record, id, &block)
+      type = record.class
       error = Pointer.new(:id)
-      file = File.read(File.join(NSBundle.mainBundle.resourcePath, "fixtures", "#{record.class.to_s.underscore.pluralize}.json"))
+      file = File.read(File.join(NSBundle.mainBundle.resourcePath, "fixtures", "#{type.to_s.underscore.pluralize}.json"))
       data = NSJSONSerialization.JSONObjectWithData(file.to_data, options:JSON_OPTIONS, error:error).find{|obj| obj[:id] == id }
       if data
-        record.load(id, data)
+        load(type, record, data)
         block.call(record) if block.is_a? Proc
         record
       else
-        raise Loco::FixtureAdapter::RecordNotFound, "#{record.class} with the id `#{id}' could not be loaded."
+        raise Loco::FixtureAdapter::RecordNotFound, "#{type} with the id `#{id}' could not be loaded."
       end
     end
     
@@ -27,7 +28,7 @@ module Loco
       error = Pointer.new(:id)
       file = File.read(File.join(NSBundle.mainBundle.resourcePath, "fixtures", "#{type.to_s.underscore.pluralize}.json"))
       data = NSJSONSerialization.JSONObjectWithData(file.to_data, options:JSON_OPTIONS, error:error)
-      records.load(type, data)
+      load(type, records, data)
       block.call(records) if block.is_a? Proc
       records
     end
@@ -38,7 +39,7 @@ module Loco
       data = NSJSONSerialization.JSONObjectWithData(file.to_data, options:JSON_OPTIONS, error:error).select{|obj| 
         ids.map(&:to_s).include?(obj[:id].to_s) 
       }
-      records.load(type, data)
+      load(type, records, data)
       block.call(records) if block.is_a? Proc
       records
     end
@@ -53,13 +54,13 @@ module Loco
         end
         match
       }
-      records.load(type, data)
+      load(type, records, data)
       block.call(records) if block.is_a? Proc
       records
     end
     
-    def save_record(record, &block)
-      raise NoMethodError, "Loco::FixtureAdapter cannot save records."
+    def update_record(record, &block)
+      raise NoMethodError, "Loco::FixtureAdapter cannot update records."
     end
     
     def delete_record(record, &block)

data/lib/motion-loco/model.rb

@@ -1,12 +1,181 @@
 motion_require 'observable'
-motion_require 'savable'
+motion_require 'record_array'
 
 module Loco
   
   class Model
     include Observable
-    include Savable
-    property :id
+    property :id, :integer
+    
+    def destroy(&block)
+      adapter = self.class.get_class_adapter
+      unless self.new?
+        adapter.delete_record(self) do |record|
+          block.call(record) if block.is_a? Proc
+        end
+      end
+    end
+    
+    def load(id, data)
+      data.merge!({ id: id })
+      self.set_properties(data)
+      self
+    end
+    
+    def new?
+      self.id.nil?
+    end
+    
+    def save(&block)
+      adapter = self.class.get_class_adapter
+      if self.new?
+        adapter.create_record(self) do |record|
+          block.call(record) if block.is_a? Proc
+        end
+      else
+        adapter.update_record(self) do |record|
+          block.call(record) if block.is_a? Proc
+        end
+      end
+    end
+    
+    def serialize(options={})
+      self.class.get_class_adapter.serialize(self, options)
+    end
+    
+    class << self
+      
+      def adapter(adapter_class, *args)
+        if adapter_class.is_a? String
+          @adapter = adapter_class.constantize.new(*args)
+        else
+          @adapter = adapter_class.new(*args)
+        end
+      end
+      
+      def belongs_to(model)
+        attr_accessor model
+        attr_accessor "#{model}_id"
+        
+        belongs_to_class_name = model.to_s.classify
+        
+        define_method "#{model}" do |&block|
+          record = instance_variable_get("@#{model}")
+          if record
+            block.call(record) if block.is_a? Proc
+            record
+          else
+            belongs_to_id = self.send("#{model}_id")
+            if belongs_to_id
+              belongs_to_class_name.constantize.find(belongs_to_id) do |record|
+                instance_variable_set("@#{model}", record)
+                block.call(record) if block.is_a? Proc
+              end
+            else
+              block.call(record) if block.is_a? Proc
+              record
+            end
+          end
+        end
+        
+        define_method "#{model}=" do |record|
+          raise TypeError, "Expecting a #{belongs_to_class_name} as defined by #belongs_to :#{model}" unless record.is_a? belongs_to_class_name.constantize
+          self.send("#{model}_id=", (record.nil? ? nil : record.id))
+          instance_variable_set("@#{model}", record)
+          record
+        end
+        
+        relationships = get_class_relationships
+        relationships << { belongs_to: model }
+      end
+      
+      def has_many(model)
+        attr_accessor model
+        attr_accessor "#{model.to_s.singularize}_ids"
+        
+        has_many_class_name = model.to_s.singularize.classify
+        
+        define_method "#{model}" do |&block|
+          has_many_class = has_many_class_name.constantize
+          records = instance_variable_get("@#{model}")
+          if records
+            block.call(records) if block.is_a? Proc
+            records
+          else
+            has_many_ids = self.send("#{model.to_s.singularize}_ids")
+            if has_many_ids
+              has_many_class.find(has_many_ids) do |records|
+                block.call(records) if block.is_a? Proc
+              end
+            else
+              query = {}
+              query["#{self.class.to_s.underscore.singularize}_id"] = self.id
+              has_many_class.find(query) do |records|
+                block.call(records) if block.is_a? Proc
+              end
+            end
+          end
+        end
+        
+        define_method "#{model}=" do |records|
+          has_many_class = has_many_class_name.constantize
+          if (records.is_a?(RecordArray) || records.is_a?(Array)) && (records.length == 0 || (records.length > 0 && records.first.class == has_many_class))
+            unless records.is_a?(RecordArray)
+              record_array = RecordArray.new
+              record_array.addObjectsFromArray(records)
+              records = record_array
+            end
+          else
+            raise TypeError, "Expecting a Loco::RecordArray of #{has_many_class_name} objects as defined by #has_many :#{model}"
+          end
+          
+          self.send("#{model.to_s.singularize}_ids=", records.map(&:id))
+          instance_variable_set("@#{model}", records)
+        end
+        
+        relationships = get_class_relationships
+        relationships << { has_many: model }
+      end
+      
+      def find(id=nil, &block)
+        adapter = self.get_class_adapter
+        if id.nil?
+          # Return all records
+          records = RecordArray.new
+          adapter.find_all(self, records) do |records|
+            block.call(records) if block.is_a? Proc
+          end
+        elsif id.is_a? Array
+          # Return records with given ids
+          records = RecordArray.new
+          id.each do |i|
+            records << self.new(id: i)
+          end
+          adapter.find_many(self, records, id) do |records|
+            block.call(records) if block.is_a? Proc
+          end
+        elsif id.is_a? Hash
+          # Return records matching query
+          records = RecordArray.new
+          adapter.find_query(self, records, id) do |records|
+            block.call(records) if block.is_a? Proc
+          end
+        else
+          record = self.new(id: id)
+          adapter.find(record, id) do |record|
+            block.call(record) if block.is_a? Proc
+          end
+        end
+      end
+      alias_method :all, :find
+      alias_method :where, :find
+      
+      def get_class_adapter
+        @adapter ||= Adapter.new
+      end
+        
+    end
+    
   end
   
 end