motion_model 0.3.1 → 0.3.2

data/CHANGELOG

@@ -1,3 +1,11 @@
+2012-12-30: Added Formotion module. This allows for tighter integration with Formotion
+            Changed options for columns such that any arbitrary values can be inserted
+            allowing for future expansion.
+
+2012-12-14: Added lots of framework to validations
+            Added validations for length, format, email, presence
+            Added array type (thanks justinmcp)
+
 2012-12-07: Added MIT license file.
             InputHelpers: Whitespace cleanup. Fixed keyboard show/hide to scroll to correct position.
             MotionModel::Column: Whitespace cleanup, added code to support cascading delete (:dependent => :destroy)

data/README.md

@@ -19,15 +19,12 @@ are:
   counting.
   
 - validatable.rb: Provides a basic validation framework for any
-  arbitrary class. Right now, it can only validate for presence,
-  but expect that to change soon.
+  arbitrary class. You can also create custom validations to suit
+  your app's unique needs.
   
-- input_helpers: Hooking an array up to a data form, populating
-  it, and retrieving the data afterwards can be a bunch of code.
-  Not something I'd like to write more often that I have to. These
-  helpers are certainly not the focus of this release, but
-  I am using these in an app to create Apple-like input forms in
-  static tables.
+- input_helpers: Hooking a collection up to a data form, populating
+  the form, and retrieving the data afterwards can be a bunch of code.
+  Not something I'd like to write more often that I have to.
 
 MotionModel is MIT licensed, which means you can pretty much do whatever
 you like with it. See the LICENSE file in this project.
@@ -94,12 +91,12 @@ class Task
 end
 ```          
 
-You can also include the `Validations` module to get field validation. For example:
+You can also include the `Validatable` module to get field validation. For example:
 
 ```ruby
 class Task
   include MotionModel::Model
-  include MotionModel::Validations
+  include MotionModel::Validatable
 
   columns :name        => :string,
           :description => :string,
@@ -131,6 +128,7 @@ a_task.due_date = '2012-09-19'    # due_date is cast to NSDate
 Currently supported types are:
 
 * `:string`
+* `text`
 * `:boolean`, `:bool`
 * `:int`, `:integer`
 * `:float`, `:double`
@@ -452,10 +450,56 @@ Core Extensions
   Again, a reversing rule is required for both singularize and 
   pluralize to work properly.
 
-Things In The Pipeline
+Experimental: Formotion Support
 ----------------------
 
-- Adding validations and custom validations
+MotionModel now 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).
+
+This feature is extremely experimental, but here's how it works:
+
+```ruby
+class Event
+  include MotionModel::Model
+  include MotionModel::Formotion  # <== Formotion support
+
+  columns :name => :string,
+          :date => {:type => :date, :formotion => {:picker_type => :date_time}},
+          :location => :string
+end
+```
+
+This declares the class. The only difference is that you include `MotionModel::Formotion`.
+If you want to pass additional information on to Formotion, simply include it in the
+`:formotion` hash as shown above.
+
+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:
+
+```ruby
+:date => {:type => :date, :formotion => {:type => :string}}
+```
+
+To initialize a form from a model in your controller:
+
+```ruby
+@form = Formotion::Form.new(@event.to_formotion('event details'))
+@form_controller = MyFormController.alloc.initWithForm(@form)
+```
+
+The magic is in: `MotionModel::Model#to_formotion(section_header)`.
+
+and on the flip side you do something like this in your submit handler:
+
+```ruby
+@event.from_formotion!(data)
+```
+
+This performs sets on each field. You'll, of course, want to check your
+validations before dismissing the form.
 
 Problems/Comments
 ------------------

data/lib/motion_model/model/column.rb

@@ -9,8 +9,14 @@ module MotionModel
       def initialize(name = nil, type = nil, options = {})
         @name = name
         @type = type
-        @default = options[:default]
-        @destroy = options[:dependent]
+        raise RuntimeError.new "columns need a type declared." if type.nil?
+        @default = options.delete :default
+        @destroy = options.delete :dependent
+        @options = options
+      end
+
+      def options
+        @options
       end
 
       def classify

data/lib/motion_model/model/model.rb

@@ -264,7 +264,7 @@ module MotionModel
           when Symbol, String
             add_field(name, options)
           when Hash
-            add_field(name, options[:type], :default => options[:default])
+            add_field(name, options.delete(:type), options)
           else
             raise ArgumentError.new("arguments to `columns' must be a symbol, a hash, or a hash of hashes.")
           end
@@ -485,6 +485,18 @@ module MotionModel
       self.class.type(column_name)
     end
 
+    # Options hash for column, excluding the core
+    # options such as type, default, etc.
+    #
+    # Options are completely arbitrary so you can
+    # stuff anything in this hash you want. For
+    # example:
+    #
+    #    columns :date => {:type => :date, :formotion => {:picker_type => :date_time}}
+    def options(column_name)
+      column_named(column_name).options
+    end
+
     # True if this object responds to the method or
     # property, otherwise false.
     alias_method :old_respond_to?, :respond_to?
@@ -513,9 +525,7 @@ module MotionModel
     end
 
     def initialize_data_columns(column, options) #nodoc
-      options[column] ||= self.class.default(column)
-      cast_value = cast_to_type(column, options[column])
-      @data[column] = cast_value
+       self.send("#{column}=".to_sym, options[column] || self.class.default(column))
     end
 
     def collection #nodoc

data/lib/motion_model/model/model_casts.rb

@@ -19,7 +19,14 @@ module MotionModel
     end
 
     def cast_to_date(arg)
-      arg.is_a?(NSDate) ? arg : NSDate.dateWithNaturalLanguageString(arg, locale:NSUserDefaults.standardUserDefaults.dictionaryRepresentation)
+      case arg
+        when String
+          return NSDate.dateWithNaturalLanguageString(arg.gsub('-','/'), locale:NSUserDefaults.standardUserDefaults.dictionaryRepresentation)
+        when Time
+          return NSDate.dateWithNaturalLanguageString(arg.strftime('%Y/%m/%d %H:%M'), locale:NSUserDefaults.standardUserDefaults.dictionaryRepresentation)
+        else
+          return arg
+      end
     end
 
     def cast_to_array(arg)
@@ -35,6 +42,7 @@ module MotionModel
       when :int, :integer, :belongs_to_id then cast_to_integer(arg)
       when :float, :double then cast_to_float(arg)
       when :date then cast_to_date(arg)
+      when :text then arg.to_s
       when :array then cast_to_array(arg)
       else
         raise ArgumentError.new("type #{column_name} : #{type(column_name)} is not possible to cast.")

data/lib/motion_model/version.rb

@@ -1,3 +1,3 @@
 module MotionModel
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/column_options_spec.rb

@@ -0,0 +1,22 @@
+class ModelWithOptions
+  include MotionModel::Model
+
+  columns :date => {:type => :date, :formotion => {:picker_type => :date_time}}
+end
+
+describe "column options" do
+  it "accepts the hash form of column declaration" do
+    lambda{ModelWithOptions.new}.should.not.raise
+  end
+
+  it "retrieves non-nil options for a column declaration" do
+    instance = ModelWithOptions.new
+    instance.options(:date).should.not.be.nil
+  end
+
+  it "retrieves correct options for a column declaration" do
+    instance = ModelWithOptions.new
+    instance.options(:date)[:formotion].should.not.be.nil
+    instance.options(:date)[:formotion][:picker_type].should == :date_time
+  end
+end

data/spec/date_spec.rb

@@ -0,0 +1,13 @@
+describe "time conversions" do
+  it "NSDate and Time should agreee on minutes since epoch" do
+    t = Time.new
+    d = NSDate.dateWithTimeIntervalSince1970(t.to_f)
+    t.to_f.should == d.timeIntervalSince1970
+  end
+
+  it "Parsing '3/18/12 @ 7:00 PM' With Natural Language should work right" do
+    NSDate.dateWithNaturalLanguageString('3/18/12 @ 7:00 PM'.gsub('-','/'), locale:NSUserDefaults.standardUserDefaults.dictionaryRepresentation).
+      strftime("%m-%d-%Y | %I:%M %p").
+      should == "03-18-2012 | 07:00 PM"
+  end
+end

data/spec/formotion_spec.rb

@@ -0,0 +1,33 @@
+class ModelWithOptions
+  include MotionModel::Model
+  include MotionModel::Formotion
+
+  columns :name => :string,
+          :date => {:type => :date, :formotion => {:picker_type => :date_time}},
+          :location => :string
+end
+
+describe "formotion" do
+  before do
+    @subject = ModelWithOptions.create(:name => 'get together', :date => '12-11-13 @ 9:00 PM', :location => 'my house')
+  end
+
+  it "generates a formotion hash" do
+    @subject.to_formotion.should.not.be.nil
+  end
+
+  it "has the correct section title" do
+    @subject.to_formotion('test section')[:sections].first[:title].should == 'test section'
+  end
+
+  it "has 3 rows" do
+    @subject.to_formotion('test section')[:sections].first[:rows].length.should == 3
+  end
+
+  it "binds data from rendered form into model fields" do
+    @subject.from_formotion!({:name => '007 Reunion', :date => '3-3-13', :location => "Q's Lab"})
+    @subject.name.should == '007 Reunion'
+    @subject.date.strftime("%Y-%d-%d %H:%M:%S").should == '2013-03-03 12:00:00'
+    @subject.location.should == "Q's Lab"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion_model
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -52,8 +52,11 @@ files:
 - lib/motion_model/version.rb
 - motion_model.gemspec
 - spec/cascading_delete_spec.rb
+- spec/column_options_spec.rb
+- spec/date_spec.rb
 - spec/ext_spec.rb
 - spec/finder_spec.rb
+- spec/formotion_spec.rb
 - spec/model_casting_spec.rb
 - spec/model_hook_spec.rb
 - spec/model_spec.rb
@@ -87,8 +90,11 @@ specification_version: 3
 summary: Simple model and validation mixins for RubyMotion
 test_files:
 - spec/cascading_delete_spec.rb
+- spec/column_options_spec.rb
+- spec/date_spec.rb
 - spec/ext_spec.rb
 - spec/finder_spec.rb
+- spec/formotion_spec.rb
 - spec/model_casting_spec.rb
 - spec/model_hook_spec.rb
 - spec/model_spec.rb