rectify 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d078cea0461b65b902da31291260082c39abf97e
-  data.tar.gz: 725a7ddeb4fcce8395b2b9b101ae4c3ff7ea29a5
+  metadata.gz: 9cd2e0e074614674af4e91e02a6024a635c23b9a
+  data.tar.gz: 4eac998668975b9a58266c3ff900bf8bd424a75c
 SHA512:
-  metadata.gz: 594da9a6e14242b9c637a4bd4946f7f0182ec3983330cbc82ae340a7feab081d471d1cc7467c66152052039c28b690fdb3ba86e87901a5d2cfe5bdf5a247f319
-  data.tar.gz: bc79820e8625dc68a8dc934331a04127010e93b341b5a6870ec5a3861faf4087e20ae3da940f43f8c3828f12db4e540d0355a2bf9af94468f88c7e25146225fc
+  metadata.gz: 627070d61b3225e26466faa7a92786afac970d23a8a0648d325a282cbc2b77fdc5be65dbb6e6d9afc9fa35992ec1f6c3da3188623cede7632de38d1b15deb4de
+  data.tar.gz: 6c91917d08347230e38d117f76e820cded4037e5ca971499b6d5438d69770cfb084c257ecf8fc3f173ecd73f5c67d6e61d67cfd781643598eb3adf2610fabb68

data/lib/rectify/build_form_from_model.rb

@@ -11,6 +11,8 @@ module Rectify
           model_value = model.public_send(a.name)
           form.public_send("#{a.name}=", a.value_from(model_value))
         end
+
+        form.map_model(model)
       end
     end
 

data/lib/rectify/form.rb

@@ -70,6 +70,12 @@ module Rectify
       super.except(:id)
     end
 
+    def map_model(model)
+      # Implement this in your form object for custom mapping from model to form
+      # object as part of the `.from_model` call after matching attributes are
+      # populated (optional).
+    end
+
     private
 
     def form_attributes_valid?

data/lib/rectify/version.rb

@@ -1,3 +1,3 @@
 module Rectify
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/readme.md

@@ -282,8 +282,9 @@ form.ip_address # => "1.2.3.4"
 
 **Model**
 
-The final way is to pass an ActiveModel to the form to populate it's attribute
-values. This is useful when editing a model:
+The final way is to pass a Ruby object instance (which is normally an ActiveModel
+but can be any PORO) to the form to populate it's attribute values. This is useful
+when editing a model:
 
 ```ruby
 user = User.create(:first_name => "Andy", :last_name => "Pike")
@@ -295,8 +296,29 @@ form.first_name # => "Andy"
 form.last_name  # => "Pike"
 ```
 
+This works by trying to match (deeply) the attributes of the form object with the
+passed in object. If there is matching attribute or method in the model, then
+whatever it returns will be assigned to the form attribute.
+
+This works great for most cases, but sometimes you need more control and need the
+ability to do custom mapping from the model to the form. When this is required,
+you just need to implement the `#map_model` method in your form object:
+
+```ruby
+class UserForm < Rectify::Form
+  attribute :full_name, String
+
+  def map_model(model)
+    self.full_name = "#{model.first_name} #{model.last_name}"
+  end
+end
+```
+
+The `#map_model` method is called as part of `.from_model` after all the automatic
+attribute assignment is complete.
+
 One important thing that is different about Rectify forms is that they are not
-bound by a model. You can use a model to populate the forms attributes but that
+bound to a model. You can use a model to populate the form's attributes but that
 is all it will do. It does not keep a reference to the model or interact with
 it.
 
@@ -1021,7 +1043,7 @@ using normal(ish) commands from Rails:
 ```
 rake db:migrate   # => Migrates the test database
 rake db:schema    # => Dumps database schema
-rake g:migration  # => Create a new migration file
+rake g:migration  # => Create a new migration file (use snake_case name)
 ```
 
 ### Releasing a new version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rectify
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Pike
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus