simple_form_object 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a69baf840092290a6fa0f0a87af33bbab2755dac
-  data.tar.gz: a751158509221fbd5a1dd3b360d7302da29739fa
+  metadata.gz: 2c5b1bb8877957e9dece06a0ea28f2eddb48c744
+  data.tar.gz: b1d5870ddc177dad61b1ec5f313f37a378cb2565
 SHA512:
-  metadata.gz: d81bc3300e0d973e84162f87264c29c6169375940d0e2f126a4a82a1504439dcde181b645075f1678de26bf3e1075caed2542aa081ad7e511f2afff1ffa06387
-  data.tar.gz: 7ec09e6a3d97b8ad39df15e2d42a22d38f9443502b7f1f34f203de29221e78151bd147bdd99916f9319b4a31d2a16fce73e8bc28bfb96a6d62a61922c340ceac
+  metadata.gz: 5cbbbde1b4d58ed0374267535412fb76375e172dd2ec02f16692357dab90844a2cc697a676b16d85235365fa0075c9c70ca80331dc115db70175b9ec326bb389
+  data.tar.gz: 97b625f72a2bdec29e3e97d2aabeb3364d6a33e47d0f1751fdd5e1015ed0d6f6d4a06dfc7f39ffab8c4a76847e62d28b7d4eb7eac8f04c9546ccd83eafa411cf

data/README.md

@@ -1,28 +1,72 @@
-# SimpleFormObjects
+# SimpleFormObject
 
-TODO: Write a gem description
+Allows you to make really simple non-persisted form objects or models.
+
+**Only suitable for Rails 4 applications.**
+
+You don't need to remember to:
+
+1. `include ActiveModel::Model`
+2. Set the class `model_name` so Rails url generation works for forms.
+
+It gives you:
+
+1. Default values for your form attributes.
+2. Integration with simple_form so you don't need to specify the field type on the form.
+3. Thanks to `ActiveModel::Model` you can use standard Rails validations on your attributes.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'simple_form_objects'
+```ruby
+gem 'simple_form_object'
+```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install simple_form_objects
+Create a form class. I like to put them inside `app/forms/`. If you
+prefer to create models then that will work too.
 
-## Usage
+```ruby
+class PostForm
+  include SimpleFormObject
+
+  attribute :body, :text
+  attribute :title, :string
+  attribute :publish_date, :datetime, default: Time.now
+
+  validates_presence_of :body
+  validates_presence_of :title
+end
+```
+
+`SimpleFormObject` includes `ActiveModel::Model` so you don't need to.
+It also intelligently sets the `model_name` on the class so that Rails
+routing works as expected. As an example:
+
+```erb
+<%= simple_form_for @post_form do |f| %>
+  <%= f.input :title        # renders a simple string input %>
+  <%= f.input :body         # renders a textarea %>
+  <%= f.input :publish_date # renders a datetime select html element %>
+<% end %>
+```
+
+Will create a HTML form which will `POST` to `posts_path`.
+
+## Todo:
 
-TODO: Write usage instructions here
+1. Automatically add good validations for types.
+2. It's tested in `spec` but better tests wouldn't hurt.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/simple_form_objects/fork )
+1. Fork it ( http://github.com/reInteractive-open/simple_form_objects/fork )
 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/simple_form_object/version.rb

@@ -1,3 +1,3 @@
 module SimpleFormObject
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_form_object
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Leonard Garvey