motion_model 0.4.6 → 0.5.0

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bubble-wrap (1.4.0)
+    motion-stump (0.3.0)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bubble-wrap
+  motion-stump (~> 0.2)
+  rake

data/README.md

@@ -99,8 +99,8 @@ Getting Going
 
 If you are using Bundler, put this in your Gemfile:
 
-```
-gem motion_model
+```ruby
+gem 'motion_model'
 ```
 
 then do:
@@ -178,7 +178,7 @@ class Task
   columns :name        => :string,
           :long_name   => :string,
           :due_date    => :date
-  validates :name => :presence => true
+  validates :name, :presence => true
 end
 
 class MyCoolController
@@ -635,15 +635,38 @@ Core Extensions
   Again, a reversing rule is required for both singularize and
   pluralize to work properly.
 
+Serialization
+----------------------
+
+The `ArrayModelAdapter` does not, by default perform any serialization. That's
+because how often which parts of your object graph are serialized can affect
+application performance. However, you *will* want to use the serialization
+features. Here they are:
+
+    YourModel.deserialize_from_file(file_name = nil)
+
+    YourModel.serialize_to_file(file_name = nil)
+
+What happens here? When you want to save a model, you call `serialize_to_file`.
+Each model's data must be saved to a different file so name them accordingly.
+If you have a model that contains related model objects, you may want to save
+both models. But you have complete say over that and *the responsibility to
+handle it*.
+
+When you call `deserialize_from_file`, your model is populated from the file
+previously serialized.
+
 Formotion Support
 ----------------------
 
-MotionModel now has support for the cool [Formotion gem](https://github.com/clayallsopp/formotion).
+### Background
+
+MotionModel has support for the cool [Formotion gem](https://github.com/clayallsopp/formotion).
 Note that the Formotion project on GitHub appears to be way ahead of the gem on Rubygems, so you
 might want to build it yourself if you want the latest gee-whiz features (like `:picker_type`, as
-I've shown in this example).
+I've shown in the first example).
 
-This feature is extremely experimental, but here's how it works:
+### High-Level View
 
 ```ruby
 class Event
@@ -660,9 +683,57 @@ This declares the class. The only difference is that you include `MotionModel::F
 If you want to pass additional information on to Formotion, simply include it in the
 `:formotion` hash as shown above.
 
+> Note: the `:formation` stuff in the `columns` specification is something I'm still thinking about. Read on to find out about the two alternate syntaxes for `to_formotion`.
+
+### Details About `to_formotion`
+
+There are two alternate syntaxes for calling this. The initial, or "legacy" syntax is as follows:
+
+```
+to_formotion(form_title, expose_auto_date_fields, first_section_title)
+```
+
+In the legacy syntax, all arguments are optional and sensible defaults are chosen. However, when you want to tune how your form is presented, the syntax gets a bit burdensome. The alternate syntax is:
+
+```
+to_formotion(options)
+```
+
+The options hash looks a lot like a Formotion hash might, except without the data. Here is an example:
+
+```
+{title: 'A very fine form',
+ sections: [
+  {title:  'First Section',
+   fields: [:name, :gender]
+  },
+  {title:  'Second Section',
+   fields: [:address, :city, :state]
+  }
+]}
+```
+
+Note that in this syntax, you can specify a button in the fields array:
+
+```
+{title: 'A very fine form',
+ sections: [
+  {title:  'First Section',
+   fields: [:name, :gender]
+  },
+  {title:  'Second Section',
+   fields: [:address, :city, :state, {type: :submit, title: 'Ok'}]
+  }
+]}
+```
+
+This specifies exactly what titles and fields appear where and in what order.
+
+### How Values Are Produced for Formotion
+
 MotionModel has sensible defaults for each type supported, so any field of `:date`
 type will default to a date picker in the Formotion form. However, if you want it
-to be a string for some reason, just pass in:
+to be a string for some reason, just specify this in `columns`:
 
 ```ruby
 :date => {:type => :date, :formotion => {:type => :string}}
@@ -671,7 +742,7 @@ to be a string for some reason, just pass in:
 To initialize a form from a model in your controller:
 
 ```ruby
-@form = Formotion::Form.new(@event.to_formotion('event details'))
+@form = Formotion::Form.new(@event.to_formotion('event details')) # Legacy syntax
 @form_controller = MyFormController.alloc.initWithForm(@form)
 ```
 

data/motion/adapters/array_finder_query.rb

@@ -70,7 +70,7 @@ module MotionModel
     
     # performs a set-inclusion test.
     #
-    # Task.find(:id).id([3, 5, 9])
+    # Task.find(:id).in([3, 5, 9])
     def in(set)
       @collection = @collection.collect do |item|
         item if set.include?(item.send(@field_name.to_sym))

data/motion/adapters/array_model_persistence.rb

@@ -128,7 +128,7 @@ module MotionModel
     def encodeWithCoder(coder)
       columns.each do |attr|
         # Serialize attributes except the proxy has_many and belongs_to ones.
-        unless [:belongs_to, :has_many].include? column(attr).type
+        unless [:belongs_to, :has_many, :has_one].include? column(attr).type
           value = self.send(attr)
           unless value.nil?
             coder.encodeObject(value, forKey: attr.to_s)

data/motion/date_parser.rb

@@ -5,12 +5,18 @@ module DateParser
   #
   # => 2013-02-20 09:00:00 -0800
   def self.parse_date(date_string)
+    if date_string.match(/\d{2}T\d{2}/)
+      # Discards fractional seconds.
+      date_string = date_string.split('.').first if date_string =~ /\.\d{3}Z$/
+      return Time.iso8601(date_string)
+    end
+
     detect(date_string).first.date
   end
 
   # Parse time zone from date
   #
-  # ateParser.parse_date "There is a date in here tomorrow at 9:00 AM EDT"
+  # DateParser.parse_date "There is a date in here tomorrow at 9:00 AM EDT"
   #
   # Caveat: This is implemented per Apple documentation. I've never really
   #         seen it work.

data/motion/model/formotion.rb

@@ -66,6 +66,8 @@ module MotionModel
     # If you want a title for your Formotion form, set the <tt>form_title</tt>
     # argument to a string that will become that title.
     def to_formotion(form_title = nil, expose_auto_date_fields = false, first_section_title = nil)
+      return new_to_formotion(form_title) if form_title.is_a? Hash
+
       @expose_auto_date_fields = expose_auto_date_fields
 
       sections = {
@@ -101,6 +103,74 @@ module MotionModel
       form
     end
 
+    # <tt>new_to_formotion</tt> maps a MotionModel into a hash in a user-definable
+    # manner, according to options.
+    #
+    # form_title:    String for form title
+    # sections:      Array of sections
+    #
+    # Within sections, use these keys:
+    #
+    # title:         String for section title
+    # field:         Name of field in your model (Symbol)
+    #
+    # Hash looks something like this:
+    #
+    # {sections: [
+    #   {title:  'First Section',           # First section
+    #    fields: [:name, :gender]           # contains name and gender
+    #   },
+    #   {title:  'Second Section',
+    #    fields: [:address, :city, :state],  # Second section, address
+    #    {title: 'Submit', type: :submit}    # city, state add submit button
+    #   }
+    # ]}
+    def new_to_formotion(options = {form_title: nil, sections: []})
+      form = {}
+
+      @expose_auto_date_fields = options[:auto_date_fields]
+
+      fields = returnable_columns
+      form[:title] = options[:form_title] unless options[:form_title].nil?
+      fill_from_options(form, options) if options[:sections]
+      form
+    end
+
+    def fill_from_options(form, options)
+      form[:sections] ||= []
+
+      options[:sections].each do |section|
+        form[:sections] << fill_section(section)
+      end
+      form
+    end
+
+    def fill_section(section)
+      new_section = {}
+
+      section.each_pair do |key, value|
+        case key
+        when :title
+          new_section[:title] = value unless value.nil?
+        when :fields
+          new_section[:rows] ||= []
+          value.each do |field_or_hash|
+            new_section[:rows].push(fill_row(field_or_hash))
+          end
+        end
+      end
+      new_section
+    end
+
+    def fill_row(field_or_hash)
+      case field_or_hash
+        when Hash
+          return field_or_hash unless field_or_hash.keys.detect{|key| key =~ /^formotion_/}
+        else
+          combine_options field_or_hash, default_hash_for(field_or_hash, self.send(field_or_hash))
+      end
+    end
+
     # <tt>from_formotion</tt> takes the information rendered from a Formotion
     # form and stuffs it back into a MotionModel. This data is not saved until
     # you say so, offering you the opportunity to validate your form data.

data/motion/model/model_casts.rb

@@ -32,7 +32,8 @@ module MotionModel
     end
 
     def cast_to_array(arg)
-      Array(arg)
+      array=*arg
+      array
     end
 
     def cast_to_hash(arg)

data/motion/version.rb

@@ -4,5 +4,5 @@
 # or forward port their code to take advantage
 # of adapters.
 module MotionModel
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

data/motion_model.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "motion_model"
   gem.require_paths = ["lib"]
-  gem.add_dependency 'bubble-wrap', '1.3.0'
+  gem.add_dependency 'bubble-wrap', '>= 1.3.0'
   gem.add_dependency 'motion-support', '>=0.1.0'
   gem.version       = MotionModel::VERSION
 end

data/spec/array_model_persistence_spec.rb

@@ -193,6 +193,7 @@ class Parent
   include MotionModel::ArrayModelAdapter
   columns   :name
   has_many  :children
+  has_one  :dog
 end
 
 class Child
@@ -202,28 +203,41 @@ class Child
   belongs_to  :parent
 end
 
+class Dog
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+  columns     :name
+  belongs_to  :parent
+end
+
 describe "serialization of relations" do
   before do
     parent = Parent.create(:name => 'BoB')
     parent.children.create :name => 'Fergie'
     parent.children.create :name => 'Will I Am'
+    parent.dog.create :name => 'Fluffy'
   end
 
   it "is wired up right" do
     Parent.first.name.should == 'BoB'
     Parent.first.children.count.should == 2
+    Parent.first.dog.count.should == 1
   end
 
   it "serializes and deserializes properly" do
     Parent.serialize_to_file('parents.dat')
     Child.serialize_to_file('children.dat')
+    Dog.serialize_to_file('dogs.dat')
     Parent.delete_all
     Child.delete_all
+    Dog.delete_all
     Parent.deserialize_from_file('parents.dat')
     Child.deserialize_from_file('children.dat')
+    Dog.deserialize_from_file('dogs.dat')
     Parent.first.name.should == 'BoB'
     Parent.first.children.count.should == 2
     Parent.first.children.first.name.should == 'Fergie'
+    Parent.first.dog.first.name.should == 'Fluffy'
   end
 end
 

data/spec/date_spec.rb

@@ -52,5 +52,27 @@ describe "time conversions" do
 
   end
 
+  describe "parsing ISO8601 date formats" do
+    class Model
+      include MotionModel::Model
+      include MotionModel::ArrayModelAdapter
+      columns :test_date => :date,
+    end
+
+    it 'parses ISO8601 format variant #1 (RoR  default)' do
+      m = Model.new(test_date: '2012-04-23T18:25:43Z')
+      m.test_date.should.not.be.nil
+    end
 
+    it 'parses ISO8601 variant #2, 3DP Accuracy (RoR4), JavaScript built-in JSON object' do
+      m = Model.new(test_date: '2012-04-23T18:25:43.511Z')
+      m.test_date.should.not.be.nil
+    end
+
+    it 'parses ISO8601 variant #3' do
+      m = Model.new(test_date: '2012-04-23 18:25:43 +0000')
+      m.test_date.should.not.be.nil
+      m.test_date.utc.to_s.should.eql '2012-04-23 18:25:43 UTC'
+    end
+  end
 end

data/spec/formotion_spec.rb

@@ -97,4 +97,88 @@ describe "formotion" do
   it "does not include related columns in the collection" do
     result = @subject.to_formotion[:sections].first[:rows].has_hash_value?(:related_models).should == false
   end
+
+  describe "new syntax" do
+    it "generates a formotion hash" do
+      @subject.new_to_formotion.should.not.be.nil
+    end
+
+    it "has the correct form title" do
+      @subject.new_to_formotion(form_title: 'test form')[:title].should == 'test form'
+    end
+
+    it "has two sections" do
+      s = @subject.new_to_formotion(
+        sections: [
+          {title: 'one'},
+          {title: 'two'}
+          ]
+          )[:sections].length.should == 2
+    end
+
+    it "does not include title in the default section" do
+      @subject.new_to_formotion(
+        sections: [
+          {fields: [:name]},
+          {title: 'two'}
+          ]
+          )[:sections].first[:title].should == nil
+    end
+
+    it "does include address in the second section" do
+      @subject.new_to_formotion(
+        sections: [
+          {fields: [:name]},
+          {title: 'two'}
+          ]
+          )[:sections][1][:title].should.not == nil
+    end
+
+    it "has two rows in the first section" do
+      @subject.new_to_formotion(
+        sections: [
+          {fields: [:name, :date]},
+          {title: 'two'}
+          ]
+          )[:sections][0][:rows].length.should == 2
+    end
+
+    it "has two rows in the first section" do
+      @subject.new_to_formotion(
+        sections: [
+          {fields: [:name, :date]},
+          {title: 'two'}
+          ]
+          )[:sections][0][:rows].length.should == 2
+    end
+
+    it "value of location row in :address section is 'my house'" do
+      @subject.new_to_formotion(
+        sections: [
+          {title: 'name', fields: [:name, :date]},
+          {title: 'address', fields: [:location]}
+          ]
+          )[:sections][1][:rows].first[:value].should == 'my house'
+    end
+    it "value of name row is 'get together'" do
+        @subject.new_to_formotion(
+        sections: [
+          {title: 'name', fields: [:name, :date]},
+          {title: 'address', fields: [:location]}
+          ]
+          )[:sections][1][:rows].first[:value].should == 'my house'
+    end
+    it "allows you to place buttons in your form" do
+        result = @subject.new_to_formotion(
+        sections: [
+          {title: 'name', fields: [:name, :date, {title: 'Submit', type: :submit}]},
+          {title: 'address', fields: [:location]}
+          ]
+          )
+
+        result[:sections][0][:rows][2].should.is_a? Hash
+        result[:sections][0][:rows][2].should.has_key?(:type)
+        result[:sections][0][:rows][2][:type].should == :submit
+    end
+  end
 end

data/spec/model_casting_spec.rb

@@ -116,7 +116,12 @@ describe 'Type casting' do
   it 'returns an Array for an array field' do
     @convertible.an_array.should.is_a(Array)
   end
-
+  it 'returns proper array for parsed json data using bubble wrap' do
+    parsed_json = BW::JSON.parse('{"menu_categories":["Lunch"]}')
+    @convertible.an_array = parsed_json["menu_categories"]
+    @convertible.an_array.count.should == 1
+    @convertible.an_array.include?("Lunch").should == true
+  end
   it 'the array field should be the same as the range form' do
     (@convertible.an_array.first..@convertible.an_array.last).should.equal(1..10)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion_model
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
@@ -54,6 +54,7 @@ files:
 - .travis.yml
 - CHANGELOG
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile