foundation_form_builder 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ece24c8e1a79705694ac2d5695e29a54640772e7
-  data.tar.gz: a3faad3150a6b81023e7c96b9b4fc1ab4ebccc70
+  metadata.gz: 51e1b678cf9389ebdd4be33ea71ddef5a9060b66
+  data.tar.gz: f6707a233e7a6c7e74f12b0f270e56078c03d5d9
 SHA512:
-  metadata.gz: 6f01f5f4bf5e68adfc81b52741c4ccea267c062f1ba2f6993b90bc5b6f7b15da2fd0c2d6b2373b36b38e4db0f718ffd28eca50d44c476bd51dfd2021720da85d
-  data.tar.gz: 39110cabc23398f732511fce73733985b7304503309a8c5d5c894fe6c5c241d02e1409d7100072a0de0640ddeefad5bd76d4d679f61b9777e7ea4d7484b52dbe
+  metadata.gz: 565073d1aef0d0142078b520b70327cb2dcede9f529f90f1c17c4b3b5abe24592bcc5b33c82fa4443873a1156ec73c48a07fbc0768e02caae2d5abd1431c9485
+  data.tar.gz: 22bb845a176c546359a60adf955bc46981306263bf5c852fd9d0fae44135414a0710cc5af5624f026682aa2d3d709a13446f353a389beeedb84bd0840ae052b9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # FoundationFormBuilder changelog
 
+# 0.3.1
+
+27 Feb 2015
+
+Add some docstrings. [#2]
+
 # 0.3.0
 
 27 Feb 2015

data/lib/foundation_form_builder/rails.rb

@@ -4,6 +4,16 @@ require 'active_support/time_with_zone'
 
 module FoundationFormBuilder
   class Rails < ActionView::Helpers::FormBuilder
+
+    # Renders a form field with label wrapped in an appropriate +<div>+, with another +<div>+ for errors if necessary.
+    #
+    # @param field_name [String, Symbol] Name of the field to render
+    # @option options [Hash] :field Options to pass through to the underlying Rails form helper. For +type: :time_zone+, +:priority_zones+ is also understood.
+    # @option options [String, Symbol] :label (human-readable version of +field_name+) Text for the +<label>+ element
+    # @option options [Symbol] :type (type inferred by #infer_type) Type of field to render.
+    #   Known values are +:date+, +:email+, +:password+, +:select+, +:textarea+, and +:time_zone+. Anything else is rendered as a text field.
+    # @option options [Array] :values Name-value pairs for +<option>+ elements. Only meaningful with +type: :select+.
+    # @return [SafeBuffer] The rendered HTML
     def input_div(field_name, label: nil, type: nil, values: nil, field: {})
       raise ArgumentError, ':values is only meaningful with type: :select' if values && type != :select
       @template.content_tag :div, class: field_name do
@@ -17,6 +27,10 @@ module FoundationFormBuilder
 
     private
 
+    # Renders a +<div>+ with errors if there are any for the specified field, or returns +nil+ if not.
+    #
+    # @param field_name [String, Symbol] Name of the field to check for errors
+    # @return [SafeBuffer, nil] The rendered HTML or nil
     def error_div(field_name)
       error_messages = errors[field_name]
       if error_messages.present?
@@ -55,6 +69,10 @@ module FoundationFormBuilder
       end
     end
 
+    # Infers the type of field to render based on the field name.
+    #
+    # @param [String, Symbol] the name of the field
+    # @return [Symbol] the inferred type
     def infer_type(field_name)
       case field_name
       when :email, :time_zone

data/lib/foundation_form_builder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foundation_form_builder
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marnen Laibow-Koser