aform 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b539a689687d10ce372376c984749ac30cbe65cc
-  data.tar.gz: addef8dbcb1055f19ce403ae320c4e37532d6ee3
+  metadata.gz: d9df2b57aeb8971ff9e39d745dcd5eff638dda62
+  data.tar.gz: e571e37db8431d9058396d5ffa2400ead9ccb501
 SHA512:
-  metadata.gz: 5b6c8024ce914f97a27845459d2003c18d949974a86703a0e75949d38b1588aeb70da76533464eda580563396bea4942d36e9c6d7d37a7e679ea94a01d4e7f4b
-  data.tar.gz: 95fb5e0da238837daf95f78ca910f098b984d700b46d049873571ff20ca2f4214ca98a077fbdd90640a75a3e6d8a7f3df4edfd1273af0d64b1de770dc19b1e83
+  metadata.gz: 6179f8685ab941adbe1bae32685857787978c7931cb47698968aee0d51e82915132526205afe2ec28e3eff30d276e35f7adab6fa4ead45811f184f74b80a6749
+  data.tar.gz: 07d14ba691df39bc0f35f0ad77f6a2d8caddfebe36146f5ea9f8400cf8bb0c9da9970095d2f81db77f78f714cdad1b649e159d932e2aabe27169209f66c9b60a

data/README.md

@@ -1,15 +1,14 @@
-# Aform
-[![Build Status](https://travis-ci.org/antonversal/aform.svg?branch=master)](https://travis-ci.org/antonversal/aform)
+# Aform [![Build Status](https://travis-ci.org/antonversal/aform.svg?branch=master)](https://travis-ci.org/antonversal/aform) [![Code Quality](https://codeclimate.com/github/antonversal/aform.png)](https://codeclimate.com/github/antonversal/aform)
 
-[![Code Quality](https://codeclimate.com/github/antonversal/aform.png)](https://codeclimate.com/github/antonversal/aform)
+Aform lets you define Form Object with validatins and ability save difficult `jsons` or `form params` to models. You can create Form object with nested forms for storing `has_many` associations with parent model.
 
-TODO: Write a gem description
+It was developed for [rails-api](https://github.com/rails-api/rails-api) and ActiveRecord. 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'aform'
+    gem 'aform', '~>0.0.7'
 
 And then execute:
 
@@ -20,12 +19,103 @@ Or install it yourself as:
     $ gem install aform
 
 ## Usage
+### Define Form
 
-TODO: Write usage instructions here
+Definning form is pretty simple, for instance you have posts wich have comments and comments have likes:
+
+```ruby
+class PostForm < Aform::Form
+  param :title, :author
+  validates_presence_of :title, :author
+
+  has_many :comments do
+    param :message, :author
+    validates_presence_of :message, :author
+
+    has_many :likes do
+      param :author
+      validates_presence_of :author
+    end
+  end
+end
+```
+Method `param` is used for adding params wich will be used for saving models. You can add any validation you need for each param. 
+
+### Setup controller
+``` ruby
+class PostsController < ApplicationController
+
+  def create
+    form = PostForm.new(Post.new, params[:post])
+    if form.save
+      render json: form.model, status: :created
+    else
+      render json: {errors: form.errors}, status: :unprocessable_entity
+    end
+  end
+  
+  def update
+    post = Post.find(params[:id])
+    form = PostForm.new(post, params[:post])
+    if form.save
+      render json: form.model
+    else
+      render json: {errors: form.errors}, status: :unprocessable_entity
+    end
+  end
+
+end
+```
+
+### Delete nested records
+
+For deleting nested records you should set `_destroy` key to `true` in nested params:
+```ruby
+post = {
+  title: "Very Cool Post", 
+  author: "John Doe",
+  comments: [ {id: comment.id, _destroy: true}]
+ }
+```
+
+### Params
+Before looking up the param in a given hash, a form object will check for the presence of a method with the name of the param:
+```ruby
+post = {
+  title: "Cool Post", 
+  first_author: "John Doe", 
+  second_author: "Mr. Author"
+}
+```
+Form Object:
+``` ruby
+class OtherPostForm < Aform::Form
+  param :title, :author
+
+  def author(attributes)
+    "#{attributes[:first_author]} and #{attributes[:second_author]}"
+  end
+end
+```
+
+When you need just save method with other name you can use `:model_field` option:
+
+``` ruby
+param :first_author, model_field: :author
+```
+
+### Validations
+Aform curruntly support standart ActiveModel validations like:
+```ruby
+validates_presence_of :title
+validates :count, presence: true, inclusion: [1..100]
+```
+And ActiveRecord uniqueness validation `validates_uniqueness_of` or `validates :title, uniqueness: true`
+But it doesn't support yet validation with block and a symbol pointing to a method, supporting will be added in short future.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/aform/fork )
+1. Fork it ( https://github.com/antonversal/aform )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/aform/builder.rb

@@ -12,7 +12,11 @@ class Aform::Builder
       self.params = params
 
       validations.each do |v|
-        send(v[:method], *v[:options])
+        if v[:block]
+          send(v[:method], v[:block])
+        else
+          send(v[:method], *v[:options])
+        end
       end if validations
 
       params.each do |p|

data/lib/aform/model.rb

@@ -52,7 +52,7 @@ class Aform::Model
       if @form.respond_to?(p[:field])
         memo.merge(field_name => @form.public_send(p[:field], attrs))
       else
-        if attrs[p[:field]]
+        if !attrs[p[:field]].nil?
           memo.merge(field_name => attrs[p[:field]])
         else
           memo

data/lib/aform/version.rb

@@ -1,3 +1,3 @@
 module Aform
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/model_test.rb

@@ -48,8 +48,15 @@ describe Aform::Model do
         [{method: :validate, block: ->{errors.add(:base, "must be foo")}}]
       end
 
+      let(:model) {subject.new(mock_ar_model, mock_form, {})}
+
       it "is not valid" do
-        skip("not implemented")
+        model.wont_be :valid?
+      end
+
+      it "adds errors" do
+        model.valid?
+        model.errors.messages.must_equal(base: ["must be foo"])
       end
     end
   end
@@ -82,6 +89,15 @@ describe Aform::Model do
       end
     end
 
+    context "when field with boolean false value" do
+      let(:form_model) { subject.new(model, mock_form, name: "name", count: false)}
+
+      it "calls assigns attributes" do
+        form_model.save
+        model.attributes.must_equal(name: "name", count: false)
+      end
+    end
+
     context "when fields with model_field option" do
       let(:fields){ [{field: :name}, {field: :count, options: {model_field: :size}}] }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aform
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Anton Versal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport