form_obj 0.3.0 → 0.4.0

data/README.md

@@ -1,7 +1,18 @@
 # FormObj
 
-Form Object allows to describe complicated data structure (nesting, arrays) and use it with Rails-cmpatible form builders.
-Form Object can serialize and deserialize itself to/from model and hash.
+[![Gem Version](https://badge.fury.io/rb/form_obj.svg)](https://badge.fury.io/rb/form_obj)
+[![Build Status](https://travis-ci.com/akoltun/form_obj.svg?branch=master)](https://travis-ci.com/akoltun/form_obj)
+
+Form Object allows to define a complicated data structure (using nesting, arrays) and use it with Rails-compatible form builders.
+A Form Object can be serialized and deserialized to a model and/or a hash.
+
+## Compatibility and Dependency Requirements
+
+Ruby: 2.2.8+
+ActiveSupport: 3.2+
+ActiveModel: 3.2+
+
+The gem is tested against all ruby versions and all versions of its dependencies.
 
 ## Installation
 
@@ -21,16 +32,19 @@ Or install it yourself as:
 
 ## Usage
 
-**WARNING!!!** The gem is still under development. Expecting braking changes.<br/>
+**WARNING!!!** The gem is still under development. Expect braking changes.<br/>
 
-Form Object `FormObj::Form` is inherited from `TreeStruct` (https://github.com/akoltun/tree_struct).
-So on top of all `TreeStruct` functionality `FormObj::Obj` adds `update_attributes` method for mass update of attributes 
- (similar to ActuveRecord) and syntax sugar to easily use ActiveModel::Validations and ActiveModel::Errors with `TreeStruct`.
+Class `FormObj::Struct` allows to describe complicated data structure.
 
-`Mappable` module included in `FormObj::Form` oblect allows to map form object to a model, 
-load attributes from and attributes to it, represent form object as model hash (similar to `to_hash` method but
-includes only attributes mapped to the model and with model attributes names) and copy errors from the model(s) 
-into a from object. 
+Class `FormObj::Form` inherits from `FormObj::Struct` and adds form builder compatibility and includes ActiveModel validations.
+
+Module `FormObj::ModelMapper` being included into `FormObj::Form` descendants allows to map a form object to a model 
+in order to be able to exchange attributes value between them:
+* load attributes value from the model,
+* sync attributes value to the model, 
+* represent a form object as a model hash (similar to the `to_hash` method but using the
+model attributes name) and 
+* copy errors from the model(s) to the from object. 
 
 ### Table of Contents
 
@@ -68,7 +82,7 @@ class SimpleForm < FormObj::Form
 end
 ```
 
-Use it in form builder.
+Use it in a form builder.
 
 ```erb
 <%= form_for(@simple_form) do |f| %>
@@ -89,7 +103,7 @@ class NestedForm < FormObj::Form
   attribute :name
   attribute :year
   attribute :car do
-    attribute :model
+    attribute :code
     attribute :driver
     attribute :engine do
       attribute :power
@@ -107,7 +121,7 @@ class EngineForm < FormObj::Form
   attribute :volume
 end
 class CarForm < FormObj::Form
-  attribute :model
+  attribute :code
   attribute :driver
   attribute :engine, class: EngineForm
 end
@@ -120,7 +134,7 @@ end
 
 Use nested forms in form builder.
 
-```ruby
+```erb
 <%= form_for(@nested_form) do |f| %>
   <%= f.label :name %>
   <%= f.text_field :name %>
@@ -129,8 +143,8 @@ Use nested forms in form builder.
   <%= f.text_field :year %>
 
   <%= f.fields_for(:car) do |fc| %>
-    <%= fc.label :model %>
-    <%= fc.text_field :model %>
+    <%= fc.label :code %>
+    <%= fc.text_field :code %>
 
     <%= fc.label :driver %>
     <%= fc.text_field :driver %>
@@ -155,7 +169,7 @@ class ArrayForm < FormObj::Form
   attribute :name
   attribute :year
   attribute :cars, array: true do
-    attribute :model
+    attribute :code
     attribute :driver
     attribute :engine do
       attribute :power
@@ -173,7 +187,7 @@ class EngineForm < FormObj::Form
   attribute :volume
 end
 class CarForm < FormObj::Form
-  attribute :model
+  attribute :code
   attribute :driver
   attribute :engine, class: EngineForm
 end
@@ -184,19 +198,55 @@ class ArrayForm < FormObj::Form
 end
 ```
 
-Add new elements in the array by using method :create on which adds a new it.
+Add new elements in the array by using method :create.
 
 ```ruby
-array_form = ArrayForm.new
-array_form.size 				# => 0
-array_form.cars.create
-array_form.size 				# => 1
+@array_form = ArrayForm.new
+@array_form.cars.size 				# => 0
+@array_form.cars.create
+@array_form.cars.size 				# => 1
+```
+
+Use array of nested forms in the form builder.
+
+```erb
+<%= form_for(@array_form) do |f| %>
+  <%= f.label :name %>
+  <%= f.text_field :name %>
+
+  <%= f.label :year %>
+  <%= f.text_field :year %>
+
+  <% f.cars.each do |car| %>
+    <%= f.fields_for(:cars, car, index: '') do |fc| %>
+      <%= fc.label :code %>
+      <%= fc.text_field :code %>
+
+      <%= fc.label :driver %>
+      <%= fc.text_field :driver %>
+
+      <%= fc.field_for(:engine) do |fce| %>
+        <%= fce.label :power %>
+        <%= fce.text_field :power %>
+
+        <%= fce.label :volume %>
+        <%= fce.text_field :volume %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>
 ```
 
 ### 2. Update Attributes
 
 Update form object attributes with the parameter hash received from the browser. 
-Method `update_attributes(new_attrs_hash)` returns self so one can chain calls.
+Method `update_attributes(new_attrs_hash, options)` returns self so one can chain calls.
+
+`options` hash can have `:raise_if_not_found` key which has `true` value by default.
+If `new_attrs_hash` has key that does not correspond to any attributes 
+and `raise_if_not_found` is `true` than `UnknownAttributeError` will be generated.
+`raise_if_not_found` equals to `false` prevents error generation 
+and non existent attribute will be just ignored.
 
 ```ruby
 simple_form = SimpleForm.new
@@ -216,7 +266,7 @@ simple_form.year      # => 1966
 nested_form = NestedForm.new
 nested_form.name = 'Ferrari'
 nested_form.year = 1950
-nested_form.car.model = '340 F1'
+nested_form.car.code = '340 F1'
 nested_form.car.driver = 'Ascari'
 nested_form.car.engine.power = 335
 nested_form.car.engine.volume = 4.1
@@ -224,7 +274,7 @@ nested_form.update_attributes(
                                 name: 'McLaren',
                                 year: 1966,
                                 car: {
-                                  model: 'M2B',
+                                  code: 'M2B',
                                   driver: 'Bruce McLaren',
                                   engine: {
                                     power: 300,
@@ -234,7 +284,7 @@ nested_form.update_attributes(
                              )
 nested_form.name                  # => "McLaren"
 nested_form.year                  # => 1966
-nested_form.car.model             # => "M2B"
+nested_form.car.code              # => "M2B"
 nested_form.car.driver            # => "Bruce McLaren"
 nested_form.car.engine.power      # => 300
 nested_form.car.engine.volume     # => 3.0
@@ -242,20 +292,20 @@ nested_form.car.engine.volume     # => 3.0
 
 #### 2.2. Array of Form Objects
 
-Updating array of form objects will compare the existing array and the new one.
+Updating an array of form objects will compare the existing array with the new one.
 New array elements will be added, existing array elements will be updated, absent array elements will be deleted 
-(deleting behaviour is the subject of changes in future releases - only elements with flag `_destroy == true` will be deleted).
+(deleting behavior is the subject of changes in future releases - only elements with flag `_destroy == true` will be deleted).
 
 In order to compare old and new array its elements have to be identified via the primary key.
 Primary key can be specified either on the attribute level or on the form level.
-If it is not specified the :id field is supposed to be a primary key.
+If it is not specified the :id field is supposed to be the primary key.
 
 ```ruby
 class ArrayForm < FormObj::Form
   attribute :name
   attribute :year
   attribute :cars, array: true do
-    attribute :model, primary_key: true     # <- primary key is specified on attribute level
+    attribute :code, primary_key: true     # <- primary key is specified on attribute level
     attribute :driver
     attribute :engine do
       attribute :power
@@ -269,8 +319,8 @@ end
 class ArrayForm < FormObj::Form
   attribute :name
   attribute :year
-  attribute :cars, array: true, primary_key: :model do     # <- primary key is specified on form level
-    attribute :model
+  attribute :cars, array: true, primary_key: :code do     # <- primary key is specified on form level
+    attribute :code
     attribute :driver
     attribute :engine do
       attribute :power
@@ -286,13 +336,13 @@ array_form.name = 'Ferrari'
 array_form.year = 1950
 
 car1 = array_form.cars.create
-car1.model = '340 F1'
+car1.code = '340 F1'
 car1.driver = 'Ascari'
 car1.engine.power = 335
 car1.engine.volume = 4.1
 
 car2 = array_form.cars.create
-car2.model = 'M2B'
+car2.code = 'M2B'
 car2.driver = 'Villoresi'
 car2.engine.power = 300
 car2.engine.volume = 3.3
@@ -302,13 +352,13 @@ array_form.update_attributes(
                               year: 1966,
                               cars: [
                                   {
-                                      model: 'M2B',
+                                      code: 'M2B',
                                       driver: 'Bruce McLaren',
                                       engine: {
                                           volume: 3.0
                                       }
                                   }, {
-                                      model: 'M7A',
+                                      code: 'M7A',
                                       driver: 'Denis Hulme',
                                       engine: {
                                           power: 415,
@@ -320,12 +370,12 @@ array_form.update_attributes(
 array_form.name                     # => "McLaren"
 array_form.year                     # => 1966
 
-array_form.cars[0].model            # => "M2B"
+array_form.cars[0].code             # => "M2B"
 array_form.cars[0].driver           # => "Bruce McLaren"
 array_form.cars[0].engine.power     # => 300    - this value was not updated in update_attributes
 array_form.cars[0].engine.volume    # => 3.0
 
-array_form.cars[1].model            # => "M7A"
+array_form.cars[1].code             # => "M7A"
 array_form.cars[1].driver           # => "Denis Hulme"
 array_form.cars[1].engine.power     # => 415
 array_form.cars[1].engine.volume    # => nil    - this value is nil because this car was created in updated_attributes
@@ -333,7 +383,7 @@ array_form.cars[1].engine.volume    # => nil    - this value is nil because this
 
 ### 3. Serialize to Hash
 
-Call `to_hash()` method in order to get hash representation of the form object
+Call `to_hash()` method in order to get a hash representation of the form object
 
 ```ruby
 simple_form.to_hash     # => {
@@ -349,7 +399,7 @@ nested_form.to_hash     # => {
                         # =>    :name => "McLaren",
                         # =>    :year => 1966,
                         # =>    :car  => {
-                        # =>      :model => "340 F1",
+                        # =>      :code => "340 F1",
                         # =>      :driver => "Ascari",
                         # =>      :engine => {
                         # =>        :power => 335,
@@ -366,14 +416,14 @@ array_form.to_hash      # => {
                         # =>    :name => "McLaren",
                         # =>    :year => 1966,
                         # =>    :cars => [{
-                        # =>      :model => "M2B",
+                        # =>      :code => "M2B",
                         # =>      :driver => "Bruce McLaren",
                         # =>      :engine => {
                         # =>        :power => 300,
                         # =>        :volume => 3.0
                         # =>      }
                         # =>    }, {
-                        # =>      :model => "M7A",
+                        # =>      :code => "M7A",
                         # =>      :driver => "Denis Hulme",
                         # =>      :engine => {
                         # =>        :power => 415,
@@ -383,16 +433,16 @@ array_form.to_hash      # => {
                         # => }
 ```
 
-### 4. Map Form Object to Models
+### 4. Map Form Object to/from Models
 
-Include `Mappable` mix-in and map form object attributes to one or few models by using `:model` and `:model_attribute` parameters.
+Include `DataMapper` mix-in and map form object attributes to one or more models by using `:model` and `:model_attribute` parameters.
 By default each form object attribute is mapped to the model attribute with the same name of the `:default` model. 
 
-Use dot notation to map model attribute to nested model. Use colon to specify "hash" attribute.
+Use dot notation to map model attribute to a nested model. Use colon to specify a "hash" attribute.
 
 ```ruby
 class SingleForm < FormObj::Form
-  include Mappable
+  include DataMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -412,7 +462,7 @@ Suppose `single_form = SingleForm.new` and `model` to be an instance of a model.
 
 ```ruby
 class MultiForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -434,7 +484,7 @@ Use `model_attribute: false` in order to avoid attribute mapping to the model.
 
 ```ruby
 class SimpleForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
    attribute :name, model_attribute: :team_name
   attribute :year
@@ -452,16 +502,17 @@ Suppose `form = SimpleForm.new` and `model` to be an instance of a model.
 
 ##### 4.2.1. Map Nested Form Object Attribute to Parent Level Model Attribute
 
+TODO: replace `model_attribute` by `model`
 Use `model_attribute: false` for nested form object in order to map its attributes to the parent level of the model.
 
 ```ruby
 class NestedForm < FormObj::Form
-  include Mappable
+  include ModelMapper
     
   attribute :name, model_attribute: :team_name
   attribute :year
   attribute :car, model_attribute: false do   # nesting only in form object but not in a model
-    attribute :model
+    attribute :code
     attribute :driver
     attribute :engine do
       attribute :power
@@ -477,23 +528,23 @@ Suppose `form = NestedForm.new` and `model` to be an instance of a model.
 | --------------------- | --------------- |
 | `form.name` | `model.team_name` |
 | `form.year` | `model.year` |
-| `form.car.model` | `model.model` |
+| `form.car.code` | `model.code` |
 | `form.car.driver` | `model.driver` |
 | `form.car.engine.power` | `model.engine.power` |
 | `form.car.engine.volume` | `model.engine.volume` |
 
 #### 4.3. Map Nested Form Object to A Hash Model
 
-Use `hash: true` in order to map a nested form object to a hash as a model.
+Use `model_hash: true` in order to map a nested form object to a hash as a model.
 
 ```ruby
 class NestedForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
-  attribute :car, hash: true do   # nesting only in form object but not in a model
-    attribute :model
+  attribute :car, model_hash: true do   # nesting only in form object but not in a model
+    attribute :code
     attribute :driver
     attribute :engine do
       attribute :power
@@ -509,7 +560,7 @@ Suppose `form = NestedForm.new` and `model` to be an instance of a model.
 | --------------------- | --------------- |
 | `form.name` | `model.team_name` |
 | `form.year` | `model.year` |
-| `form.car.model` | `model.car[:model]` |
+| `form.car.code` | `model.car[:code]` |
 | `form.car.driver` | `model.car[:driver]` |
 | `form.car.engine.power` | `model.car[:engine].power` |
 | `form.car.engine.volume` | `model.car[:engine].volume` |
@@ -521,7 +572,7 @@ Method returns self so one can chain calls.
 
 ```ruby
 class MultiForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -541,14 +592,14 @@ multi_form.to_hash    # => {
 
 Use `load_from_models(default: model)` or `load_from_model(model)` to load from single model.
 
-### 6. Save Form Object to Models
+### 6. Sync Form Object to Models
 
-Use `save_to_models(models)` to save form object attributes to mapped models.
+Use `sync_to_models(models)` to sync form object attributes to mapped models.
 Method returns self so one can chain calls.
 
 ```ruby
 class MultiForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -560,18 +611,18 @@ car_model = { engine: Struct.new(:power).new(335) }
 
 multi_form = MultiForm.new
 multi_form.update_attributes(name: 'McLaren', year: 1966, engine_power: 415)
-multi_form.save_to_models(default: default_model, car: car_model)
+multi_form.sync_to_models(default: default_model, car: car_model)
 
 default_model.name          # => "McLaren"
 default_model.year          # => 1966
 car_model[:engine].power    # => 415 
 ``` 
 
-Use `save_to_models(default: model)` or `save_to_model(model)` to save to single model.
+Use `sync_to_models(default: model)` or `sync_to_model(model)` to sync to single model.
 
-Neither `save_to_models` nor `save_to_model` calls `save` method on the model(s).
+Neither `sync_to_models` nor `sync_to_model` calls `save` method on the model(s).
 Also they don't call `valid?` method on the model(s). 
-Instead they just assign form object attributes values to mapped model attributes
+Instead they just assign form object attributes value to mapped model attributes
 using `<attribute_name>=` accessors on the model(s).
 
 It is completely up to developer to do any additional validations on the model(s) and save it(them).
@@ -585,12 +636,12 @@ Form object will try to guess the name of the class from the name of the attribu
 
 ```ruby
 class ArrayForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name
   attribute :year
   attribute :cars, array: true, model_class: Car do
-    attribute :model, primary_key: true     # <- primary key is specified on attribute level
+    attribute :code, primary_key: true     # <- primary key is specified on attribute level
     attribute :driver
   end
 end
@@ -601,12 +652,12 @@ nested models the value of `:model_class` parameter should be an array of corres
 
 ```ruby
 class ArrayForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name
   attribute :year
   attribute :cars, array: true, model_attribute: 'equipment.cars', model_class: [Equipment, Car] do
-    attribute :model, primary_key: true     # <- primary key is specified on attribute level
+    attribute :code, primary_key: true     # <- primary key is specified on attribute level
     attribute :driver
   end
 end
@@ -618,7 +669,7 @@ Use `to_model_hash(model = :default)` to get hash representation of the model th
 
 ```ruby
 class MultiForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -646,12 +697,12 @@ If array of form objects mapped to the parent model (`model_attribute: false`) i
 
 ```ruby
 class ArrayForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name
   attribute :year
   attribute :cars, array: true, model_attribute: false do
-    attribute :model, primary_key: true
+    attribute :code, primary_key: true
     attribute :driver
   end
 end
@@ -661,10 +712,10 @@ array_form.update_attributes(
     name: 'McLaren', 
     year: 1966, 
     cars: [{
-      model: 'M2B', 
+      code: 'M2B', 
       driver: 'Bruce McLaren'
     }, {
-      model: 'M7A',
+      code: 'M7A',
       driver: 'Denis Hulme'
     }]
 )
@@ -673,10 +724,10 @@ array_form.to_model_hash    # => {
                             # =>    :team_name => "McLaren", 
                             # =>    :year => 1966,
                             # =>    :self => {
-                            # =>      :model => "M2B",
+                            # =>      :code => "M2B",
                             # =>      :driver => "Bruce McLaren"
                             # =>    }, {    
-                            # =>      :model => "M7A",
+                            # =>      :code => "M7A",
                             # =>      :driver => "Denis Hulme"
                             # =>    }  
                             # => }
@@ -698,7 +749,7 @@ So add ActiveModel validations directly to Form Object class definition.
 
 ```ruby
 class MultiForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :name, model_attribute: :team_name
   attribute :year
@@ -757,7 +808,7 @@ class CreateCar < ActiveRecord::Migration
   def change
     create_table :cars do |t|
       t.references :team    
-      t.string :model
+      t.string :code
       t.text :engine
     end
   end
@@ -774,17 +825,17 @@ end
 ```ruby
 # app/form_objects/team_form.rb
 class TeamForm < FormObj::Form
-  include Mappable
+  include ModelMapper
   
   attribute :id
   attribute :name, model_attribute: :team_name
   attribute :year
   attribute :cars, array: true do
     attribute :id
-    attribute :model
+    attribute :code
     attribute :engine_power, model_attribute: 'engine.:power'
     
-    validates :model, presence: true
+    validates :code, presence: true
   end
   
   validates :name, :year, presence: true
@@ -809,7 +860,7 @@ class TeamsController < ApplicationController
     @team = TeamForm.new.update_attributes(params[:team])
     
     if @team.valid?
-      @team.save_to_model(model = Team.new) 
+      @team.sync_to_model(model = Team.new) 
       if model.save
         return redirect_to team_path(model), notice: 'Team has been created'
       else
@@ -825,7 +876,7 @@ class TeamsController < ApplicationController
     @team.update_attributes(params[:team])
     
     if @team.valid?
-      @team.save_to_model(model)
+      @team.sync_to_model(model)
       if model.save
         return redirect_to team_path(model), notice: 'Team has been updated'
       else
@@ -844,7 +895,7 @@ end
 <p>Cars:</p>
 <ul>
   <% @team.cars.each do |car| %>
-    <li><%= car.model %> (<%= car.engine[:power] %> hp)</li>    
+    <li><%= car.code %> (<%= car.engine[:power] %> hp)</li>    
   <% end %>
 </ul>
 ```
@@ -864,7 +915,7 @@ end
   <%= f.text_field :year %>
   
   <%= f.fields_for :cars do |cf| %>
-    <%= cf.text_field :model %>
+    <%= cf.text_field :code %>
     <%= cf.link_to_remove 'Remove the Car' %> 
   <% end %>
   <%= f.link_to_add 'Add a Car', :cars %>
@@ -877,10 +928,10 @@ end
 | --- |:---:|:---:|:---:| --- |
 | array | block* or `:class`** | `false` | `TreeStruct` | This attribute is an array of form objects. The structure of array element form object is described either in the block or in the separate class referenced by `:class` parameter |
 | class | - | - | `TreeStruct` | This attribute is either nested form object or array of form objects. The value of this parameter is the class of this form object or the name of the class. |
-| hash | block* or `:class`** | `false` | `FormObj::Mappable` | This attribute is either nested form object or array of form objects. This form object is mapped to a model of the class `Hash` so all its attributes should be accessed by `[:<attribute_name>]` instead of `.<attribute_name>` | 
-| model | - | `:default` | `FormObj::Mappable` | The name of the model to which this attribute is mapped |
-| model_attribute | - | `<attribute_name>` | `FormObj::Mappable` | The name of the model attribute to which this form object attribute is mapped. Dot notation is used in order to map to nested model, ex. `"car.engine.power"`. Colon is used in front of the name if the model is hash, ex. `"car.:engine.power"` - means call to `#car` returns `Hash` so the model attribute should be accessed like `car[:engine].power`. `false` value means that attribute is not mapped. If attribute describes nested form object and has `model_attribute: false` the attributes of nested form will be called on the parent (upper level) model. If attribute describes array of form objects and has `model_attribute: false` the methods to access array elements (`:[]` etc.) will be called on the parent (upper level) model. |
-| model_class | block* or `:class`** or dot notation for `:model_attribute`*** | `<attribute_name>.classify` | `FormObj::Mappable` | The class (or the name of the class) of the mapped model. |
+| model_hash | block* or `:class`** | `false` | `FormObj::ModelMapper` | This attribute is either nested form object or array of form objects. This form object is mapped to a model of the class `Hash` so all its attributes should be accessed by `[:<attribute_name>]` instead of `.<attribute_name>` | 
+| model | - | `:default` | `FormObj::ModelMapper` | The name of the model to which this attribute is mapped |
+| model_attribute | - | `<attribute_name>` | `FormObj::ModelMapper` | The name of the model attribute to which this form object attribute is mapped. Dot notation is used in order to map to nested model, ex. `"car.engine.power"`. Colon is used in front of the name if the model is hash, ex. `"car.:engine.power"` - means call to `#car` returns `Hash` so the model attribute should be accessed like `car[:engine].power`. `false` value means that attribute is not mapped. If attribute describes nested form object and has `model_attribute: false` the attributes of nested form will be called on the parent (upper level) model. If attribute describes array of form objects and has `model_attribute: false` the methods to access array elements (`:[]` etc.) will be called on the parent (upper level) model. |
+| model_class | block* or `:class`** or dot notation for `:model_attribute`*** | `<attribute_name>.classify` | `FormObj::ModelMapper` | The class (or the name of the class) of the mapped model. |
 | primary_key | no block* and no `:class`** | `false` | `FormObj::Form` | This attribute is the primary key of the form object. The mapped model attribute is considered to be a primary key for the corresponding model. |
 | primary_key | block* or `:class`** | - | `FormObj::Form` | This attribute is either nested form object or array of form objects. The value of this parameter is the name of the primary key attribute of this form object. |
 \* block - means that there is block definition for the attribute

data/bundle_install.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+set -e
+
+rubies=()
+versions=false
+while read -r line; do
+  if [[ $line == "rvm:" ]]
+  then
+    versions=true
+  elif $versions && [[ $line == -* ]]
+  then
+    rubies+=(${line:2})
+  elif [[ ${line:0:1} != "#" ]]
+  then
+    versions=false
+  fi
+done < ".travis.yml"
+
+for i in "${rubies[@]}"
+do
+  echo "====================================================="
+  echo "$i: Start appraisal install"
+  echo "====================================================="
+  rvm $i exec bundle
+  rvm $i exec appraisal install
+done

data/form_obj.gemspec

@@ -33,7 +33,7 @@ well as serialized to a hash which reflects a model. ActiveModel::Errors could b
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "tree_struct", ">= 1.0.2"
+  spec.add_dependency "typed_array", ">= 1.0.1"
   spec.add_dependency "activemodel", ">= 3.2"
   spec.add_dependency "activesupport", ">= 3.2"
 
@@ -41,4 +41,5 @@ well as serialized to a hash which reflects a model. ActiveModel::Errors could b
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "actionpack", ">= 3.2"
+  spec.add_development_dependency "appraisal"
 end

data/gemfiles/3.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 3.2.0"
+gem "activemodel", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+
+gemspec path: "../"