foundation_form_builder 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0477eb9127716358d4bb9fe34dca77dc996d838
-  data.tar.gz: e31b456af9bc42d175f74c5e79144903ceb13f45
+  metadata.gz: ece24c8e1a79705694ac2d5695e29a54640772e7
+  data.tar.gz: a3faad3150a6b81023e7c96b9b4fc1ab4ebccc70
 SHA512:
-  metadata.gz: b8521e19fa073984d097a3a11d85e8cd56dc6814adce66c9a8a60d77e9475cb0bb18718e9e0d4f6306727421dae7155633d181d99b5d5d57c63cd9fb93ee944b
-  data.tar.gz: 543aa62b08148003fa49e45f3c94c1fbae57f954ae4a4856ebcacbe4a7498ee096d596866626e2fea129b965b2c5b6cf303003fd1ce2fde89cdf8b615448b52d
+  metadata.gz: 6f01f5f4bf5e68adfc81b52741c4ccea267c062f1ba2f6993b90bc5b6f7b15da2fd0c2d6b2373b36b38e4db0f718ffd28eca50d44c476bd51dfd2021720da85d
+  data.tar.gz: 39110cabc23398f732511fce73733985b7304503309a8c5d5c894fe6c5c241d02e1409d7100072a0de0640ddeefad5bd76d4d679f61b9777e7ea4d7484b52dbe

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # FoundationFormBuilder changelog
 
+# 0.3.0
+
+27 Feb 2015
+
+Explicitly depend on Ruby 2 (since we were already using Ruby 2 syntax). [#1]
+
 # 0.2.1
 
 26 Feb 2015

data/README.md

@@ -8,15 +8,15 @@
 
 [Foundation](http://foundation.zurb.com) is an excellent CSS framework, and provides some [lovely components](http://foundation.zurb.com/docs/components/forms.html) for working with forms. Unfortunately, using them with Rails can be a bit of a hassle, as Foundation wants each form input to be wrapped in a `<div>`, with another `<div>` for errors.
 
-In addition, I wanted to use something like [Formtastic](http://github.com/justinfrench/formtastic) to DRY up my form field markup, but writing new renderers for Formtastic is non-trivial, and I wanted something a bit simpler anyway, so I rolled my own.
+In addition, I wanted to use something like [Formtastic](http://github.com/justinfrench/formtastic) to DRY up my form field markup, but writing new renderers for Formtastic is non-trivial, and I wanted something a bit simpler anyway, so I rolled my own. If you want to build pretty forms with a simple `FormBuilder` interface and all the Foundation goodness, this gem is for you!
 
-This gem is a work in progress. I welcome bug reports and pull requests! It's only tested on Rails 4.2 and Ruby 2.2 so far, but I'd love to support older versions of both Rails and Ruby if it's not too difficult to do so.
+FoundationFormBuilder is a work in progress. I welcome bug reports and pull requests! It's only tested on Rails 4.2 and Ruby 2.2 so far, but I'd love to support older versions of both Rails and Ruby if it's not too difficult to do so.
 
 ## Sounds great! How do I use it?
 
-Install the gem:
+Install the gem in the usual way:
 ```ruby
-gem install foundation_form_builder
+gem 'foundation_form_builder'
 ```
 Then put the following in your `application.rb` file:
 ```ruby
@@ -43,22 +43,37 @@ will create something like
 </form>
 ```
 
-Note that `FoundationFormBuilder::Rails` uses the Rails form helper functions to render the fields, and that it is somewhat smart in its choice of helpers. It uses `email_field` automatically if the name of the field is `email`; similarly, it uses `password_field` for any field whose name *contains* `password`. If the name of the field is `time_zone`, it renders a Rails `time_zone_select`. If the field corresponds to a `text` column in the database, it calls `text_area`; for a `date` column, it uses `date_field`. Otherwise, a plain `text_field` is used.
+Note that `FoundationFormBuilder::Rails` uses the Rails form helper functions to render the fields, and that it tries to infer the most appropriate form helper type, as follows.
 
+| Condition                               | Default form helper |
+| ----                                    | ----                |
+| Field name is `email`                   | `email_field`       |
+| Field name is `time_zone`               | `time_zone_select`  |
+| Field name contains the word `password` | `password_field`    |
+| Field maps to `date` column in DB       | `date_field`        |
+| Field maps to `text` column in DB       | `text_area`         |
+| Otherwise                               | `text_field`        |
 
-Since `FoundationFormBuilder` is a subclass of the standard Rails `ActionView::Helpers::FormBuilder`, all the usual Rails `FormBuilder` helpers are also available. You'll probably need to use `f.submit` at least; we're not doing anything special with submit buttons at the moment.
+Since `FoundationFormBuilder::Rails` is a subclass of the standard Rails `ActionView::Helpers::FormBuilder`, all the usual Rails `FormBuilder` helpers are also available. You'll probably need to use `f.submit` at least; we're not doing anything special with submit buttons at the moment.
 
 ### Advanced usage
 
-`input_div` takes several options if you want to override its defaults. `:label` overrides the label text, while `:type` overrides the inferred type (known values are `:date`, `:email`, `:password`, `:select`, `:textarea`, and `:time_zone`; anything else is understood as a text field). `:field` takes a hash of options which are passed through to the underlying Rails form helper.
+`input_div` takes several options if you want to override its defaults.
 
-If `type: :select` is specified, then the values for the `select`options must be specified in `:values`, like this:
+| Option    | Value                                                                                                                                                                                                                  |
+| ------    | ------                                                                                                                                                                                                                 |
+| `:field`  | Hash of options to pass through to the underlying Rails form helper                                                                                                                                                    |
+| `:label`  | Text for label                                                                                                                                                                                                         |
+| `:type`   | Explicit form helper type; overrides inferred types (see above). Significant values are `:date`, `:email`, `:password`, `:select`, `:textarea`, and `:time_zone`; `:text` or anything else will generate a text field. |
+| `:values` | Values for `<option>` elements; only meaningful with `type: :select`.                                                                                                                                                  |
+
+The following example shows all of these options in use.
 
 ```ruby
 f.input_div :size, label: 'My size is:', type: :select, values: [['Small', 1], ['Large', 2]], field: {prompt: 'Choose a size'}
 ```
 
-which produces:
+It renders as:
 ```html
 <div class='size'>
   <label for='product_size'>My size is:</label>

data/foundation_form_builder.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0'
 
   [
     ['actionview', '>= 4.2.0'],

data/lib/foundation_form_builder/version.rb

@@ -1,3 +1,3 @@
 module FoundationFormBuilder
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foundation_form_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Marnen Laibow-Koser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -170,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="