comfy_bootstrap_form 4.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a09e9d913da0ef2be8595d43d33aec6e368bdbed
+  data.tar.gz: 81fc1495505df95e49938884d6160556f2acdc01
+SHA512:
+  metadata.gz: 24d38af509aba51aa3d21b18320f56cf181d3a17f684031cafcefecb45e31585eaa474763876ac56447147592221ae2a6670d4de79c5cb92019ccf53dba7953b
+  data.tar.gz: 938caf3f08d42199219f4279280c4f99365681d9d680b0505248148f165326a610eaf657b710b9a277c6816dcaec870e538c87a2664a1f722a75bdfa39cfa9ea

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012-2014 Stephen Potenza <potenza@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,621 @@
+[![Build Status](https://travis-ci.org/comfy/comfy-bootstrap-form.svg?branch=master)](https://travis-ci.org/comfy/comfy-bootstrap-form)
+[![Gem Version](https://badge.fury.io/rb/comfy_bootstrap_form.svg)](http://badge.fury.io/rb/comfy_bootstrap_form)
+
+# Rails Bootstrap Forms
+
+**Rails Bootstrap Forms** is a rails form builder that makes it super easy to integrate
+twitter bootstrap-style forms into your rails application.
+
+## Requirements
+
+* Ruby 1.9+
+* Rails 4.0+
+* Twitter Bootstrap 4.0+
+
+## Installation
+
+Add it to your Gemfile:
+
+`gem 'comfy_bootstrap_form'`
+
+Then:
+
+`bundle`
+
+Then require the CSS in your `application.css` file:
+
+```css
+/*
+ *= require rails_bootstrap_forms
+ */
+```
+
+## Usage
+
+To get started, just use the `bootstrap_form_for` helper. Here's an example:
+
+```erb
+<%= bootstrap_form_for(@user) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.check_box :remember_me %>
+  <%= f.submit "Log In" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+```html
+<form accept-charset="UTF-8" action="/users" class="new_user" id="new_user" method="post">
+  <div class="form-group">
+    <label for="user_email">Email</label>
+    <input class="form-control" id="user_email" name="user[email]" type="email">
+  </div>
+  <div class="form-group">
+    <label for="user_password">Password</label>
+    <input class="form-control" id="user_password" name="user[password]" type="password">
+  </div>
+  <div class="form-check">
+    <label for="user_remember_me">
+      <input name="user[remember_me]" type="hidden" value="0">
+      <input id="user_remember_me" name="user[remember_me]" type="checkbox" value="1"> Remember me
+    </label>
+  </div>
+  <input class="btn btn-secondary" name="commit" type="submit" value="Log In">
+</form>
+```
+
+### Nested Forms
+
+In order to active [nested_form](https://github.com/ryanb/nested_form) support,
+use `bootstrap_nested_form_for` instead of `bootstrap_form_for`.
+
+### bootstrap_form_tag
+
+If your form is not backed by a model, use the `bootstrap_form_tag`. Usage of this helper is the same as `bootstrap_form_for`, except no model object is passed in as the first argument. Here's an example:
+
+```erb
+<%= bootstrap_form_tag url: '/subscribe' do |f| %>
+  <%= f.email_field :email, value: 'name@example.com' %>
+  <%= f.submit %>
+<% end %>
+```
+
+## Form Helpers
+
+This gem wraps the following Rails form helpers:
+
+* check_box
+* collection_check_boxes
+* collection_select
+* color_field
+* date_field
+* date_select
+* datetime_field
+* datetime_local_field
+* datetime_select
+* email_field
+* file_field
+* grouped_collection_select
+* hidden_field (not wrapped, but supported)
+* month_field
+* number_field
+* password_field
+* phone_field
+* radio_button
+* collection_radio_buttons
+* range_field
+* search_field
+* select
+* telephone_field
+* text_area
+* text_field
+* time_field
+* time_select
+* time_zone_select
+* url_field
+* week_field
+
+These helpers accept the same options as the standard Rails form helpers, with
+a few extra options:
+
+### Labels
+
+Use the `label` option if you want to specify the field's label text:
+
+```erb
+<%= f.password_field :password_confirmation, label: "Confirm Password" %>
+```
+
+To hide a label, use the `hide_label: true` option. This adds the `sr-only`
+class, which keeps your labels accessible to those using screen readers.
+
+```erb
+<%= f.text_area :comment, hide_label: true, placeholder: "Leave a comment..." %>
+```
+
+To add custom classes to the field's label:
+
+```erb
+<%= f.text_field :email, label_class: "custom-class" %>
+```
+
+#### Required Fields
+
+A label that is associated with a required field is automatically annotated with
+a `required` CSS class. You are free to add any appropriate CSS to style
+required fields as desired.  One example would be to automatically add an
+asterisk to the end of the label:
+
+```css
+label.required:after {
+  content:" *";
+}
+```
+
+The label `required` class is determined based on the definition of a presence
+validator with the associated model attribute. Presently this is one of:
+ActiveRecord::Validations::PresenceValidator or
+ActiveModel::Validations::PresenceValidator.
+
+In cases where this behavior is undesirable, use the `skip_required` option:
+
+```erb
+<%= f.password_field :password, label: "New Password", skip_required: true %>
+```
+
+### Input Elements / Controls
+
+To specify the class of the generated input, use the `control_class` option:
+
+```erb
+<%= f.text_field :email, control_class: "custom-class" %>
+```
+
+### Help Text
+
+To add help text, use the `help` option:
+
+```erb
+<%= f.password_field :password, help: "Must be at least 6 characters long" %>
+```
+
+This gem is also aware of help messages in locale translation files (i18n):
+
+```yml
+en:
+  activerecord:
+    help:
+      user:
+        password: "A good password should be at least six characters long"
+```
+
+If your model name has multiple words (like `SuperUser`), the key on the
+translation file should be underscored (`super_user`).
+
+You can override help translations for a particular field by passing the `help`
+option or turn them off completely by passing `help: false`.
+
+### Icons
+
+To add an icon to a field, use the `icon` option and pass the icon name
+*without* the 'glyphicon' prefix:
+
+```erb
+<%= f.text_field :login, icon: "user" %>
+```
+
+This automatically adds the `has-feedback` class to the `form-group`:
+
+```html
+<div class="form-group has-feedback">
+  <label class="form-control-label" for="user_login">Login</label>
+  <input class="form-control" id="user_login" name="user[login]" type="text" />
+  <span class="glyphicon glyphicon-user form-control-feedback"></span>
+</div>
+```
+
+### Prepending and Appending Inputs
+
+You can pass `prepend` and/or `append` options to input fields:
+
+```erb
+<%= f.text_field :price, prepend: "$", append: ".00" %>
+```
+
+You can also prepend and append buttons. Note: The buttons must contain the
+`btn` class to generate the correct markup.
+
+```erb
+<%= f.text_field :search, append: link_to("Go", "#", class: "btn btn-secondary") %>
+```
+
+To add a class to the input group wrapper, use `:input_group_class` option.
+
+```erb
+<%= f.email_field :email, append: f.primary('Subscribe'), input_group_class: 'input-group-lg' %>
+```
+
+### Additional Form Group Attributes
+
+If you want to add an additional css class or any other attribute to the form group div, you can use
+the `wrapper: { class: 'additional-class', data: { foo: 'bar' } }` option.
+
+```erb
+<%= f.text_field :name, wrapper: { class: 'has-warning', data: { foo: 'bar' } } %>
+```
+
+Which produces the following output:
+
+```erb
+<div class="form-group has-warning" data-foo="bar">
+  <label class="form-control-label" for="user_name">Id</label>
+  <input class="form-control" id="user_name" name="user[name]" type="text">
+</div>
+```
+
+You still can use `wrapper_class` option to set only a css class. This is just a short form of `wrapper: { class: 'additional-class' }`.
+
+### Selects
+
+Our select helper accepts the same arguments as the [default Rails helper](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select). Here's an example of how you pass both options and html_options hashes:
+
+```erb
+<%= f.select :product, [[1, "Apple"], [2, "Grape"]], { label: "Choose your favorite fruit:" }, { class: "selectpicker" } %>
+```
+
+### Checkboxes and Radios
+
+Checkboxes and radios should be placed inside of a `form_group` to render
+properly. The following example ensures that the entire form group will display
+an error if an associated validations fails:
+
+```erb
+<%= f.form_group :skill_level, label: { text: "Skill" }, help: "Optional Help Text" do %>
+  <%= f.radio_button :skill_level, 0, label: "Novice", checked: true %>
+  <%= f.radio_button :skill_level, 1, label: "Intermediate" %>
+  <%= f.radio_button :skill_level, 2, label: "Advanced" %>
+<% end %>
+
+<%= f.form_group :terms do %>
+  <%= f.check_box :terms, label: "I agree to the Terms of Service" %>
+<% end %>
+```
+
+You can also create a checkbox using a block:
+
+```erb
+<%= f.form_group :terms, label: { text: "Optional Label" } do %>
+  <%= f.check_box :terms do %>
+    You need to check this box to accept our terms of service and privacy policy
+  <% end %>
+<% end %>
+```
+
+To display checkboxes and radios inline, pass the `inline: true` option:
+
+```erb
+<%= f.form_group :skill_level, label: { text: "Skill" } do %>
+  <%= f.radio_button :skill_level, 0, label: "Novice", inline: true %>
+  <%= f.radio_button :skill_level, 1, label: "Intermediate", inline: true %>
+  <%= f.radio_button :skill_level, 2, label: "Advanced", inline: true %>
+<% end %>
+```
+
+#### Collections
+
+BootstrapForms also provides helpers that automatically creates the
+`form_group` and the `radio_button`s or `check_box`es for you:
+
+```erb
+<%= f.collection_radio_buttons :skill_level, Skill.all, :id, :name %>
+<%= f.collection_check_boxes :skills, Skill.all, :id, :name %>
+```
+
+Collection methods accept these options:
+* `:label`: Customize the `form_group`'s label
+* `:hide_label`: Pass true to hide the `form_group`'s label
+* `:help`: Add a help span to the `form_group`
+* Other options will be forwarded to the `radio_button`/`check_box` method
+
+### Static Controls
+
+You can create a static control like this:
+
+```erb
+<%= f.static_control :email %>
+```
+
+Here's the output:
+
+```html
+<div class="form-group">
+  <label class="col-sm-2 form-control-label" for="user_email">Email</label>
+  <div class="col-sm-10">
+    <p class="form-control-static">test@email.com</p>
+  </div>
+</div>
+```
+
+You can also create a static control that isn't based on a model attribute:
+
+```erb
+<%= f.static_control label: "Custom Static Control" do %>
+  Content Here
+<% end %>
+```
+
+### Date Helpers
+
+The multiple selects that the date and time helpers (`date_select`,
+`time_select`, `datetime_select`) generate are wrapped inside a
+`div.rails-bootstrap-forms-[date|time|datetime]-select` tag. This is because
+Bootstrap automatically stylizes ours controls as `block`s. This wrapper fix
+this defining these selects as `inline-block` and a width of `auto`.
+
+### Submit Buttons
+
+The `btn btn-secondary` css classes are automatically added to your submit
+buttons.
+
+```erb
+<%= f.submit %>
+```
+
+You can also use the `primary` helper, which adds `btn btn-primary` to your
+submit button:
+
+```erb
+<%= f.primary "Optional Label" %>
+```
+
+You can specify your own classes like this:
+
+```erb
+<%= f.submit "Log In", class: "btn btn-success" %>
+```
+
+### Accessing Rails Form Helpers
+
+If you want to use the original Rails form helpers for a particular field,
+append `_without_bootstrap` to the helper:
+
+```erb
+<%= f.text_field_without_bootstrap :email %>
+```
+
+## Form Styles
+
+By default, your forms will stack labels on top of controls and your controls
+will grow to 100% of the available width.
+
+### Inline Forms
+
+To use an inline-layout form, use the `layout: :inline` option. To hide labels,
+use the `hide_label: true` option, which keeps your labels accessible to those
+using screen readers.
+
+```erb
+<%= bootstrap_form_for(@user, layout: :inline) do |f| %>
+  <%= f.email_field :email, hide_label: true %>
+  <%= f.password_field :password, hide_label: true %>
+  <%= f.check_box :remember_me %>
+  <%= f.submit %>
+<% end %>
+```
+
+To skip label rendering at all, use `skip_label: true` option.
+
+```erb
+<%= f.password_field :password, skip_label: true %>
+```
+
+### Horizontal Forms
+
+To use a horizontal-layout form with labels to the left of the control, use the
+`layout: :horizontal` option. You should specify both `label_col` and
+`control_col` css classes as well (they default to `col-sm-2` and `col-sm-10`).
+
+In the example below, the checkbox and submit button have been wrapped in a
+`form_group` to keep them properly aligned.
+
+```erb
+<%= bootstrap_form_for(@user, layout: :horizontal, label_col: "col-sm-2", control_col: "col-sm-10") do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.form_group do %>
+    <%= f.check_box :remember_me %>
+  <% end %>
+  <%= f.form_group do %>
+    <%= f.submit %>
+  <% end %>
+<% end %>
+```
+
+The `label_col` and `control_col` css classes can also be changed per control:
+
+```erb
+<%= bootstrap_form_for(@user, layout: :horizontal) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.text_field :age, control_col: "col-sm-3" %>
+  <%= f.form_group do %>
+    <%= f.submit %>
+  <% end %>
+<% end %>
+```
+
+### Custom Field Layout
+
+The `layout` can be overridden per field:
+
+```erb
+<%= bootstrap_form_for(@user, layout: :horizontal) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.text_field :feet, layout: :default %>
+  <%= f.text_field :inches, layout: :default %>
+  <%= f.form_group do %>
+    <%= f.submit %>
+  <% end %>
+<% end %>
+```
+
+## Validation & Errors
+
+### Inline Errors
+
+By default, fields that have validation errors will outlined in red and the
+error will be displayed below the field. Rails normally wraps the fields in a
+div (field_with_errors), but this behavior is suppressed. Here's an example:
+
+```html
+<div class="form-group has-danger">
+  <label class="form-control-label" for="user_email">Email</label>
+  <input class="form-control" id="user_email" name="user[email]" type="email" value="">
+  <span class="form-control-feedback">can't be blank</span>
+</div>
+```
+
+You can turn off inline errors for the entire form like this:
+
+```erb
+<%= bootstrap_form_for(@user, inline_errors: false) do |f| %>
+  ...
+<% end %>
+```
+
+### Label Errors
+
+You can also display validation errors in the field's label; just turn
+on the `:label_errors` option. Here's an example:
+
+```
+<%= bootstrap_form_for(@user, label_errors: true) do |f| %>
+  ...
+<% end %>
+```
+
+By default, turning on `:label_errors` will also turn off
+`:inline_errors`. If you want both turned on, you can do that too:
+
+```
+<%= bootstrap_form_for(@user, label_errors: true, inline_errors: true) do |f| %>
+  ...
+<% end %>
+```
+
+### Alert Messages
+
+To display an error message with an error summary, you can use the
+`alert_message` helper. This won't output anything unless a model validation
+has failed.
+
+```erb
+<%= f.alert_message "Please fix the errors below." %>
+```
+
+Which outputs:
+
+```html
+<div class="alert alert-danger">
+  <p>Please fix the errors below.</p>
+  <ul class="rails-bootstrap-forms-error-summary">
+    <li>Email can't be blank</li>
+  </ul>
+</div>
+```
+
+You can turn off the error summary like this:
+
+```erb
+<%= f.alert_message "Please fix the errors below.", error_summary: false %>
+```
+
+To output a simple unordered list of errors, use the `error_summary` helper.
+
+```erb
+<%= f.error_summary %>
+```
+
+Which outputs:
+
+```html
+<ul class="rails-bootstrap-forms-error-summary">
+  <li>Email can't be blank</li>
+</ul>
+```
+
+### Errors On
+
+If you want to display a custom inline error for a specific attribute not
+represented by a form field, use the `errors_on` helper.
+
+```erb
+<%= f.errors_on :tasks %>
+```
+
+Which outputs:
+
+```html
+<div class="alert alert-danger">Tasks can't be blank.</div>
+```
+
+You can hide the attribute name like this:
+
+```erb
+<%= f.errors_on :tasks, hide_attribute_name: true %>
+```
+
+Which outputs:
+
+```html
+<div class="alert alert-danger">can't be blank.</div>
+```
+
+## Internationalization
+
+bootstrap_form follows standard rails conventions so it's i18n-ready. See more
+here: http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models
+
+## Code Triage page
+
+http://www.codetriage.com/potenza/bootstrap_form
+
+## Contributing
+
+We love pull requests! Here's a quick guide for contributing:
+
+1. Fork the repo.
+
+2. Install the required dependencies.
+
+```
+bundle install
+bundle exec appraisal install
+```
+
+3. Run the existing test suite:
+
+```
+$ bundle exec rake -f test/dummy/Rakefile db:create db:migrate RAILS_ENV=test
+$ bundle exec appraisal rake test
+```
+
+4. Add tests for your change.
+
+5. Add your changes and make your test(s) pass. Following the conventions you
+see used in the source will increase the chance that your pull request is
+accepted right away.
+
+6. Update the README if necessary.
+
+7. Add a line to the CHANGELOG for your bug fix or feature.
+
+8. Push to your fork and submit a pull request.
+
+## Contributors
+
+https://github.com/bootstrap-ruby/rails-bootstrap-forms/graphs/contributors
+
+## License
+
+MIT License. Copyright 2012-2014 Stephen Potenza (https://github.com/potenza)