projectile 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+.repl_history
+build
+tags
+app/pixate_code.rb
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+.DS_Store
+nbproject
+.redcar
+#*#
+*~
+*.sw[po]
+.eprj
+.sass-cache
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    projectile (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  projectile!

data/README.md

@@ -0,0 +1,95 @@
+Projectile
+==========
+
+JSON model layer for RubyMotion applications. Inspired by [Mantle](https://github.com/github/Mantle).
+
+# Example
+
+Using the classic blog example, where we have posts and comments, here's how you could define your subclasses:
+
+    class Post < Model
+      set_attribute name: :id,
+        type: :integer,
+        key_path: "post.id"
+
+      set_attribute name: :title,
+        type: :string,
+        default: "",
+        key_path: "post.title"
+
+      set_attribute name: :body,
+       type: :string,
+       default: "",
+       key_path: "post.body"
+
+      set_attribute name: :created_at,
+        type: :date,
+        key_path: "post.created_at"
+
+      set_relationship name: :comments,
+        class_name: :Comment,
+        default: [],
+        key_path: "post.comments"
+    end
+
+    class Comment < Model
+      set_attribute name: :id,
+        type: :integer,
+        key_path: "comment.id"
+
+      set_attribute name: :text,
+        type: :string,
+        default: "",
+        key_path: "comment.text"
+    end
+
+A `Post` has attributes `id`, `title`, `body`, `created_at`, and a to-many relationship to `Comment`.
+A `Comment` has attributes `id` and `text`.
+
+Default values are set during object initialization. i.e, `Model#new`.
+
+Key paths define where the values are located in a JSON `Hash`. This is so we know where the value exists during `#new`, and also helps us recreate the `Hash` in `#to_hash`.
+
+# Types
+
+- `integer`
+- `float`
+- `boolean`
+- `date`, only supports `yyyy-MM-dd'T'HH:mm:ssZZZZZ` right now.
+- `url`, just turns the string into a `NSURL`
+- `string`
+
+# Identity Map
+
+To use an identity map, put these lines at the top of a class definition:
+
+    include IdentityMap
+    establish_identity_on :id
+
+What this means:
+
+1. Defines equivalence based on the `id` attribute
+2. Holds all instances of class, keyed by `id`, in a class instance variable `@@identity_map`.
+
+Use `#merge_or_insert` instead of `#new` from now on:
+
+    # this will either create a brand new post object, or merge with an existing one.
+    json = {
+      "post" => {
+        "id" => 1,
+        "title" => "Hehehoho",
+        "body" => "La Li Lu Le Lo",
+        "created_at" => "2013-08-02T16:44:34-08:00"
+      }
+    }
+    @post = Post.merge_or_insert json
+
+You can use `Post[1]` to fetch the above object from anywhere. Kind of useful in the REPL.
+
+# Misc
+
+I'm very open to ideas, please create issues, fork, whatever. Oh yeah, MIT.
+
+
+
+

data/Rakefile

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

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/app/comment.rb

@@ -0,0 +1,14 @@
+class Comment < Model
+  include IdentityMap
+  establish_identity_on :id
+
+  set_attribute name: :id,
+    type: :integer,
+    default: -1,
+    key_path: "comment.id"
+
+  set_attribute name: :text,
+    type: :string,
+    default: "",
+    key_path: "comment.text"
+end

data/app/post.rb

@@ -0,0 +1,28 @@
+class Post < Model
+  include IdentityMap
+  establish_identity_on :id
+
+  set_attribute name: :id,
+    type: :integer,
+    default: -1,
+    key_path: "post.id"
+
+  set_attribute name: :title,
+    type: :string,
+    default: "",
+    key_path: "post.title"
+
+  set_attribute name: :body,
+   type: :string,
+   default: "",
+   key_path: "post.body"
+
+  set_attribute name: :created_at,
+    type: :date,
+    key_path: "post.created_at"
+
+  set_relationship name: :comments,
+    class_name: :Comment,
+    default: [],
+    key_path: "post.comments"
+end

data/lib/projectile.rb

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

data/lib/projectile/identity_map.rb

@@ -0,0 +1,84 @@
+module IdentityMap
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def [](x)
+      self.identity_map[x]
+    end
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def establish_identity_on(attr_name)
+      define_method("==") do |other|
+        return false unless self.is_a?(other.class)
+        self.send(attr_name) == other.send(attr_name)
+      end
+
+      metaclass.instance_eval do
+        define_method("merge_or_insert") do |json|
+          return nil unless json
+          attribute = self.get_attributes.find {|a| a[:name] == attr_name}
+          key_path = attribute[:key_path]
+          identity_key = json.valueForKeyPath(key_path)
+          return nil unless identity_key
+          new_model = self.new json
+          old_model = self.identity_map[identity_key]
+          if old_model
+            old_model.merge_with_model(new_model)
+          else
+            self.identity_map[identity_key] = new_model
+          end
+          (old_model || new_model)
+        end
+      end
+
+    end
+
+    def identity_map
+      @identity_map ||= Hash.new
+    end
+  end
+
+  def merge_with_model(model)
+    return unless self.is_a?(model.class)
+
+    self.class.get_relationships.each do |relationship|
+      name = relationship[:name]
+      model_value = model.send("#{name}")
+      self.send("#{name}=", model_value) unless model_value.nil?
+    end
+
+    self.class.get_attributes.each do |attribute|
+      name = attribute[:name]
+      model_value = model.send("#{name}")
+      default = attribute[:default]
+      self.send("#{name}=", model_value) unless model_value.nil? || model_value == default
+    end
+  end
+
+  def merge_with_json(json)
+    self.class.get_relationships.each do |relationship|
+      name = relationship[:name]
+      default = relationship[:default]
+      key_path = relationship[:key_path]
+      json_value = json.valueForKeyPath(key_path)
+      self.send("#{name}=", json_value) unless json_value.nil?
+    end
+
+    self.class.get_attributes.each do |attribute|
+      name = attribute[:name]
+      default = attribute[:default]
+      key_path = attribute[:key_path]
+      default = attribute[:default]
+      json_value = json.valueForKeyPath(key_path)
+      self.send("#{name}=", json_value) unless json_value.nil? || json_value == default
+    end
+  end
+
+end

data/lib/projectile/model.rb

@@ -0,0 +1,189 @@
+class Model
+  include ValueTransformer
+
+  # All objects are instances of NSString, NSNumber, NSArray, NSDictionary, or NSNull.
+  register_value_transformer :type => :boolean,
+                             :to => (lambda {|value| !!value}),
+                             :from => (lambda {|value| value})
+
+  register_value_transformer :type => :integer,
+                             :to => (lambda {|value| value.to_i}),
+                             :from => (lambda {|value| value})
+
+  register_value_transformer :type => :float,
+                             :to => (lambda {|value| value.to_f}),
+                             :from => (lambda {|value| value})
+
+  register_value_transformer :type => :date,
+                             :to => (lambda {|value| value.is_a?(Time) ? value : date_formatter.dateFromString(value.to_s)}),
+                             :from => (lambda {|value| date_formatter.stringFromDate(value)})
+
+  register_value_transformer :type => :url,
+                             :to => (lambda {|value| value.is_a?(NSURL) ? value : NSURL.URLWithString(value.to_s)}),
+                             :from => (lambda {|value| value.to_s})
+
+  register_value_transformer :type => :string,
+                             :to => (lambda {|value| value.to_s}),
+                             :from => (lambda {|value| value})
+
+  class << self
+
+    # these methods are needed because subclasses do not inherit class instance variables
+    def get_attributes
+      attributes = []
+      klass = self
+      while klass.respond_to? :attributes
+        attributes += klass.attributes
+        klass = klass.superclass
+      end
+      attributes
+    end
+
+    def get_relationships
+      relationships = []
+      klass = self
+      while klass.respond_to? :relationships
+        relationships += klass.relationships
+        klass = klass.superclass
+      end
+      relationships
+    end
+
+    def attributes
+      @attributes ||= []
+    end
+
+    def set_attribute(attribute)
+      name = attribute[:name]
+      type = attribute[:type]
+      default = attribute[:default]
+      attribute[:key_path] ||= name
+
+      attr_accessor name
+
+      # setter
+      define_method("#{name}=") do |value|
+        transformer = self.class.value_transformers[type][:to]
+        new_value = transformer.call(value) if transformer
+        self.willChangeValueForKey name
+        self.instance_variable_set("@#{name}", new_value)
+        self.didChangeValueForKey name
+      end
+
+      self.attributes << attribute
+    end
+
+    def relationships
+      @relationships ||= []
+    end
+
+    def set_relationship(relationship)
+      name = relationship[:name]
+      class_name = relationship[:class_name]
+      default = relationship[:default]
+      relationship[:key_path] ||= name
+
+      attr_accessor name
+
+      # setter
+      define_method("#{name}=") do |value|
+        cls = Kernel.const_get(class_name.capitalize)
+        new_value = case value
+        when Hash
+          cls.include?(IdentityMap) ? cls.merge_or_insert(value) : cls.new(value)
+        when Array
+          value.map {|e| (e.is_a?(cls) ? e : (cls.include?(IdentityMap) ? cls.merge_or_insert(e) : cls.new(e)))}
+        when cls
+          value
+        else
+          nil
+        end if value
+
+        self.willChangeValueForKey name
+        self.instance_variable_set("@#{name}", new_value)
+        self.didChangeValueForKey name
+      end
+
+      self.relationships << relationship
+    end
+  end
+
+  def to_hash(serialized_hash_by_model={})
+    hash = {}
+    serialized_hash_by_model[self] = hash
+
+    self.class.get_attributes.each do |attribute|
+      name = attribute[:name]
+      key_path = attribute[:key_path]
+      type = attribute[:type]
+      default = attribute[:default]
+
+      # grab value
+      model_value = self.send("#{name}")
+      next unless model_value
+
+      # create intermediate hashes
+      components = key_path.split(".")
+      inner_hash = hash
+      components.each_with_index do |component, index|
+        if index == components.count-1
+          transformer = self.class.value_transformers[type][:from]
+          inner_hash[component] = transformer.call(model_value)
+        else
+          hash[component] ||= Hash.new
+          inner_hash = hash[component]
+        end
+      end
+    end
+
+    self.class.get_relationships.each do |relationship|
+      name = relationship[:name]
+      key_path = relationship[:key_path]
+      class_name = relationship[:class_name]
+
+      model_value = self.send("#{name}")
+      next unless model_value
+
+      components = key_path.split(".")
+      inner_hash = hash
+      components.each_with_index do |component, index|
+        if index == components.count-1
+          inner_hash[component] = case model_value
+          when Array
+            model_value.compact.map do |e|
+              serialized_hash_by_model[e] ? serialized_hash_by_model[e].clone : e.to_hash(serialized_hash_by_model)
+            end
+          when Model
+            serialized_hash_by_model[model_value] ? serialized_hash_by_model[model_value].clone : model_value.to_hash(serialized_hash_by_model)
+          else
+          end
+        else
+          hash[component] ||= Hash.new
+          inner_hash = hash[component]
+        end
+      end
+    end
+
+    hash
+  end
+
+  def initialize(json={})
+    self.class.get_relationships.each do |relationship|
+      name = relationship[:name]
+      default = relationship[:default]
+      key_path = relationship[:key_path]
+      json_value = json.valueForKeyPath(key_path)
+      value_to_send = json_value.nil? ? default : json_value
+      self.send("#{name}=", value_to_send) unless value_to_send.nil?
+    end
+
+    self.class.get_attributes.each do |attribute|
+      name = attribute[:name]
+      default = attribute[:default]
+      key_path = attribute[:key_path]
+      json_value = json.valueForKeyPath(key_path)
+      value_to_send = json_value.nil? ? default : json_value
+      self.send("#{name}=", value_to_send) unless value_to_send.nil?
+    end
+  end
+end

data/lib/projectile/value_transformer.rb

@@ -0,0 +1,25 @@
+module ValueTransformer
+  module ClassMethods
+    def date_formatter
+      @@date_formatter ||= NSDateFormatter.alloc.init.tap do |date_formatter|
+        date_formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
+      end
+    end
+
+    def value_transformers
+      @@value_transformers ||= {}
+    end
+
+    def register_value_transformer(options)
+      type = options[:type]
+      to = options[:to]
+      from = options[:from]
+      return if self.value_transformers.has_key? type
+      self.value_transformers[type] = {to: to, from: from}
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/projectile.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Z Wu"]
+  gem.email         = ["bogardon@gmail.com"]
+  gem.description   = "Simple RubyMotion JSON model layer"
+  gem.summary       = "Simple RubyMotion JSON model layer"
+  gem.homepage      = "https://github.com/bogardon/projectile"
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = "projectile"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+  gem.license       = 'MIT'
+end

data/spec/identity_map_spec.rb

@@ -0,0 +1,55 @@
+describe "Identity Map" do
+  before do
+    @json1 = {
+      "post" => {
+        "id" => 1,
+        "title" => "Old Title",
+        "body" => "Old Body"
+      }
+    }
+    @post1 = Post.merge_or_insert @json1
+
+    @json2 = {
+      "post" => {
+        "id" => 1,
+        "title" => "New Title",
+        "comments" => [
+          {
+            "comment" => {
+              "id" => 1,
+              "text" => "Cool story bro."
+            }
+          },
+          {
+            "comment" => {
+              "id" => 2,
+              "text" => "La Li Lu Le Lo"
+            }
+          }
+        ]
+      }
+    }
+    @post2 = Post.merge_or_insert @json2
+    @comments2 = @post2.comments
+  end
+
+  describe "merging" do
+    it "should have correct values in identity map" do
+      Post.identity_map.count.should == 1
+      Comment.identity_map.count.should == 2
+      @post1.should == @post2
+    end
+
+    it "should merge in new value" do
+      @post1.title.should == @json2['post']['title']
+    end
+
+    it "should not merge in nil value" do
+      @post1.body.should == @json1['post']['body']
+    end
+
+    it "should replace relationships" do
+      @post1.comments.should == @comments2
+    end
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,61 @@
+describe "Model" do
+  before do
+    @json = {
+      "post" => {
+        "id" => 1,
+        "title" => "Projectile",
+        "body" => "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+        "created_at" => "2013-08-10T07:00:00-07:00",
+        "comments" => [
+          {
+            "comment" => {
+              "id" => 1,
+              "text" => "Cool story bro."
+            }
+          },
+          {
+            "comment" => {
+              "id" => 2,
+              "text" => "La Li Lu Le Lo"
+            }
+          }
+        ]
+      }
+    }
+    @post = Post.new @json
+    @comments = @post.comments
+    @empty_post = Post.new
+  end
+
+  describe "populating attributes" do
+    it "has correct attributes" do
+      @post.id.should == 1
+      @post.title.should == @json['post']['title']
+      @post.body.should == @json['post']['body']
+    end
+
+    it "has correct defaults" do
+      @empty_post.id.should == -1
+      @empty_post.title.should == ""
+      @empty_post.body.should == ""
+      @empty_post.comments.should == []
+    end
+  end
+
+  describe "populating relationships" do
+    it "has correct relationships" do
+      @comments.count.should == 2
+      @comments.first.id.should == 1
+      @comments.last.id.should == 2
+      @comments.first.text.should == "Cool story bro."
+      @comments.last.text.should == "La Li Lu Le Lo"
+    end
+  end
+
+  describe "generating hash" do
+    it "should be the same as json" do
+      @post.to_hash.should == @json
+    end
+  end
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: projectile
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Z Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies: []
+description: Simple RubyMotion JSON model layer
+email:
+- bogardon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- app/comment.rb
+- app/post.rb
+- lib/projectile.rb
+- lib/projectile/identity_map.rb
+- lib/projectile/model.rb
+- lib/projectile/value_transformer.rb
+- projectile.gemspec
+- spec/identity_map_spec.rb
+- spec/model_spec.rb
+homepage: https://github.com/bogardon/projectile
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple RubyMotion JSON model layer
+test_files:
+- spec/identity_map_spec.rb
+- spec/model_spec.rb