bh 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 236887d8267590a9cfaf81696e3b3565e8aa7e0e
-  data.tar.gz: fdf3d185fc9586b453ef27daa4907a48732bc37b
+  metadata.gz: ad17bacb7ffb22fb404857bfce7a63c26b7e182d
+  data.tar.gz: 844812324781c1cd1af6b0fc2baf7d4f7f2dd354
 SHA512:
-  metadata.gz: fd2c01c95a5821d9e1d3f45493a9c0bb29e76eceeb6f508b9e650ca6a567793354c6540eca6277aa36dc4592e3687aeb8746babb42ce54911078df368abad771
-  data.tar.gz: 13f142de14c3ddd20dbba55af3c270a57e49cd23d2379579ea336c63e90e63559656d101df64dffe60f7b7ef9e0a9614fb99ef4c2bac902ad6e3ef374b0bbe53
+  metadata.gz: 1eaa5367a5d7ba4796cb7711a3940f22e1ef1001ce6b430ac1c10cea804edd5c6a19c63a4d0ef4b69cd2f86b9b26ac0460f4dab64ec681199dc01495caa9d8b1
+  data.tar.gz: f4ddda3cd0aa3e7ccd51b4d04dbd1b9ec7450615024927ad7d5af1e0d5ad3c2db3a572ec5243b02a2c048537591224ab748b89afe6bbc1cbdc91409e8961ffab

data/.gitignore

@@ -19,4 +19,5 @@ tmp
 *.so
 *.o
 *.a
+spec/dummy
 mkmf.log

data/CHANGELOG.md

@@ -6,6 +6,10 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.0.5 - 2014-08-22
+
+* [FEATURE] Add `form_for` and form helpers for every type of field
+
 ## 0.0.4 - 2014-08-17
 
 * [FEATURE] Add `modal`

data/README.md

@@ -33,7 +33,7 @@ repetitive, and prone to errors.
 Bh offers a solution to this problem by means of a set of helper methods.
 The example above can be rewritten with just one line of code:
 
-```erb
+```rhtml
 <%= alert_box 'You accepted the Terms of service.', dismissible: true %>
 ```
 
@@ -46,14 +46,14 @@ How to install
 
 Bh is meant to be included in Rails apps by adding this line to the Gemfile:
 
-    gem 'bh', '~> 0.0.4'
+    gem 'bh', '~> 0.0.5'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
 guarantees that your project won’t occur in any error when you `bundle update`
 and a new version of Bh is released.
 
-Adding 'bh' to your Gemfile is all you need!
+Adding `bh` to your Gemfile is all you need!
 From now on, you will be able to use any of the following Bh helpers in your Rails views.
 
 AlertHelper
@@ -66,11 +66,11 @@ Here are some examples.
 Basic alerts
 ------------
 
-```erb
+```rhtml
 <%= alert_box 'You accepted the Terms of service.' %>
 ```
 
-will generate the HTML to render an "info" alert:
+will generate the HTML to render an *info* alert:
 
 ```html
 <div class="alert alert-info" role="alert">You accepted the Terms of service.</div>
@@ -81,11 +81,11 @@ will generate the HTML to render an "info" alert:
 Dismissible alerts
 ------------------
 
-```erb
+```rhtml
 <%= alert_box 'You accepted the Terms of service.', dismissible: true %>
 ```
 
-will generate the HTML to render an alert with an '×' to close it:
+will generate the HTML to render an alert with an `×` to close it:
 
 ```html
 <div class="alert alert-info" role="alert">
@@ -101,11 +101,11 @@ will generate the HTML to render an alert with an '×' to close it:
 Contextual alerts
 -----------------
 
-```erb
+```rhtml
 <%= alert_box 'You accepted the Terms of service.', context: :success %>
 ```
 
-will generate the HTML to render a "success" alert (green background):
+will generate the HTML to render a *success* alert (green background):
 
 ```html
 <div class="alert alert-success" role="alert">You accepted the Terms of service.</div>
@@ -122,11 +122,11 @@ Since a common use of alert boxes in Rails applications is to display
 [flash messages](http://api.rubyonrails.org/classes/ActionDispatch/Flash/FlashHash.html),
 the `alert_box` helper accepts the priority of the flash message as an option.
 
-```erb
+```rhtml
 <%= alert_box 'You accepted the Terms of service.', priority: :notice %>
 ```
 
-will generate the HTML to render a dismissible "success" alert (green background):
+will generate the HTML to render a dismissible *success* alert (green background):
 
 ```html
 <div class="alert alert-success" role="alert">
@@ -144,13 +144,13 @@ Available priorities are `:alert`, `:notice`.
 Complex alerts
 --------------
 
-```erb
+```rhtml
 <%= alert_box context: :success, dismissible: true do %>
   <strong>Thanks!</strong> You accepted the <%= link_to 'Terms of service', '/terms' %>.
 <% end %>
 ```
 
-will generate the HTML to render a dismissible "success" alert that includes
+will generate the HTML to render a dismissible *success* alert that includes
 highlighted text and appropriately styled links:
 
 ```html
@@ -177,7 +177,7 @@ Here are some examples.
 Load the latest Bootstrap assets
 --------------------------------
 
-```erb
+```rhtml
 <%= stylesheet_link_tag bootstrap_css, bootstrap_theme_css, :application %>
 <%= javascript_include_tag bootstrap_js, :application %>
 ```
@@ -197,7 +197,7 @@ Theme CSS and Bootstrap JS from MaxCDN, before your application assets:
 Load a specific version of a Bootstrap asset
 --------------------------------------------
 
-```erb
+```rhtml
 <%= stylesheet_link_tag bootstrap_css(version: '3.1.0', minified: false, scheme: :http) %>
 ```
 
@@ -219,7 +219,7 @@ Here are some examples.
 Display the "zoom in" icon
 --------------------------
 
-```erb
+```rhtml
 <%= glyphicon :ok, title: 'Approved' %>
 ```
 
@@ -231,6 +231,7 @@ will generate the HTML to render an "ok" icon with the "Approved" title:
 
 ![glyphicon](https://cloud.githubusercontent.com/assets/7408595/3941608/64219c82-2537-11e4-8e86-27d4a62b1c06.png)
 
+Available glyphicons are listed in [Boostrap documentation](http://getbootstrap.com/components/#glyphicons).
 
 PanelHelper
 ===========
@@ -243,7 +244,7 @@ Here are some examples.
 Basic panel
 -----------
 
-```erb
+```rhtml
 <%= panel body: 'You accepted the Terms of service.' %>
 ```
 
@@ -259,7 +260,7 @@ will generate the HTML to render a basic panel:
 Panel with heading
 ------------------
 
-```erb
+```rhtml
 <%= panel body: 'You accepted the Terms of service.', heading: 'Congratulations' %>
 ```
 
@@ -277,7 +278,7 @@ will generate the HTML to render a panel with a heading:
 Panel with title
 ------------------
 
-```erb
+```rhtml
 <%= panel body: 'You accepted the Terms of service.', title: 'Congratulations' %>
 ```
 
@@ -297,11 +298,11 @@ will generate the HTML to render a panel with a title:
 Contextual panel
 -----------------
 
-```erb
+```rhtml
 <%= panel body: 'You accepted the Terms of service.', title: 'Congratulations', context: :success %>
 ```
 
-will generate the HTML to render a "success" panel (green background):
+will generate the HTML to render a *success* panel (green background):
 
 ```html
 <div class="panel panel-success">
@@ -320,23 +321,23 @@ Available contexts are `:default` (default), `:primary`, `:success`, `:info`,
 Complex panels
 --------------
 
-```erb
-<%= panel do %>
+```rhtml
+<%= panel tag: :aside do %>
   <div class='panel-body'>You accepted the Terms of service. <%= glyphicon :ok %></div>
   <div class='panel-footer'><h4>Thanks</h4></div>
 <% end %>
 ```
 
-will generate the HTML to render a panel with HTML body and footer:
+will generate the HTML to render an aside panel with HTML body and footer:
 
 ```html
-<div class="panel panel-default">
+<aside class="panel panel-default">
   <div class="panel-body">
     You accepted the Terms of service.
     <span class="glyphicon glyphicon-ok"></span>
   </div>
   <div class="panel-footer"><h4>Thanks</h4></div>
-</div>
+</aside>
 ```
 
 ![panel-complex](https://cloud.githubusercontent.com/assets/7408595/3941819/da569586-2543-11e4-8640-3f0a72077aca.png)
@@ -353,7 +354,7 @@ Here are some examples.
 Basic row of panels
 -------------------
 
-```erb
+```rhtml
 <%= panel_row column_class: 'col-sm-4' do %>
   <%= panel body: 'Panel #1' %>
   <%= panel body: 'Panel #2' %>
@@ -382,7 +383,7 @@ will generate the HTML to render a row of three basic panels:
 Complex row of panels
 ---------------------
 
-```erb
+```rhtml
 <%= panel_row column_class: 'col-sm-4' do %>
   <%= panel title: 'User', context: :info do %>
     <div class='panel-body'><%= glyphicon :user %> John Smith</div>
@@ -428,7 +429,7 @@ Here are some examples.
 Basic modal
 -----------
 
-```erb
+```rhtml
 <%= modal title: 'Terms of service', body: 'Do what you want!' %>
 ```
 
@@ -458,14 +459,14 @@ will generate the HTML to render a button that toggles a model when clicked:
 Complex modal
 -------------
 
-```erb
+```rhtml
 <%= modal title: 'Terms of service', size: :small, button: {caption: 'Continue', size: :large, context: :info} do %>
   Please accept the Terms of service.
   <div class="modal-footer"><button type="button" class="btn btn-primary">Accept</button></div>
 <% end %>
 ```
 
-will generate the HTML to render a large, "info" button (blue background) with
+will generate the HTML to render a large, *info* button (blue background) with
 the caption "Continue" that toggles a small modal with a title and HTML content:
 
 ```html
@@ -490,6 +491,51 @@ the caption "Continue" that toggles a small modal with a title and HTML content:
 
 ![modal-complex](https://cloud.githubusercontent.com/assets/7408595/3943922/b47620a8-25d8-11e4-9e0c-803d8a104bff.png)
 
+FormForHelper
+=============
+
+To include [Boostrap forms](http://getbootstrap.com/css/#forms)
+in your Rails views, you can use the
+[form_for](http://rubydoc.info/github/Fullscreen/bh/master/Bh/FormForHelper)
+helper.
+
+By default, Bh does not override the `form_for` method provided by [ActionView](http://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_for).
+To apply Bootstrap classes and attributes, you **must** set the `:layout` option to
+
+* `:basic`, in order to get a [Basic form](http://getbootstrap.com/css/#forms-example)
+* `:horizontal`, in order to get a [Horizontal form](http://getbootstrap.com/css/#forms-horizontal)
+* `:inline`, in order to get an [Inline form](http://getbootstrap.com/css/#forms-inline)
+
+Here is how a form with a text field and a submit button looks like with each layout:
+
+```rhtml
+<%= form_for @user, layout: :basic do |f| %>
+  <%= f.text_field :name %>
+  <%= f.submit %>
+<% end %>
+```
+
+![form-for-basic](https://cloud.githubusercontent.com/assets/7408595/4015592/30611478-2a2c-11e4-8e62-b60e2151ff12.png)
+
+
+```rhtml
+<%= form_for @user, layout: :horizontal do |f| %>
+  <%= f.text_field :name %>
+  <%= f.submit %>
+<% end %>
+```
+
+![form-for-horizontal](https://cloud.githubusercontent.com/assets/7408595/4015593/30620ba8-2a2c-11e4-90c9-8340b5ddc113.png)
+
+```rhtml
+<%= form_for @user, layout: :inline do |f| %>
+  <%= f.text_field :name %>
+  <%= f.submit %>
+<% end %>
+```
+
+![form-for-inline](https://cloud.githubusercontent.com/assets/7408595/4015591/30609b74-2a2c-11e4-989e-e509d72ed224.png)
+
 
 How to release new versions
 ===========================

data/bh.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake' #, '~> 10.0'
   spec.add_development_dependency 'yard' #, '~> 0.8.0'
   spec.add_development_dependency 'coveralls' #, '~> 0.7.0'
+  spec.add_development_dependency 'activemodel'
 end

data/gemfiles/Gemfile.rails-3.x

@@ -2,4 +2,5 @@ source 'http://rubygems.org'
 
 gem 'activesupport', '~> 3.0'
 gem 'actionpack', '~> 3.0'
+gem 'activemodel', '~> 3.0'
 gemspec path: '../'

data/gemfiles/Gemfile.rails-4.x

@@ -2,4 +2,5 @@ source 'http://rubygems.org'
 
 gem 'activesupport', '~> 4.0'
 gem 'actionpack', '~> 4.0'
+gem 'activemodel', '~> 4.0'
 gemspec path: '../'

data/lib/bh/form_builders/form_builder.rb

@@ -0,0 +1,41 @@
+require 'bh/helpers/form/check_box_helper'
+require 'bh/helpers/form/field_helper'
+require 'bh/helpers/form/fieldset_helper'
+require 'bh/helpers/form/fields_for_helper'
+require 'bh/helpers/form/legend_helper'
+require 'bh/helpers/form/radio_button_helper'
+require 'bh/helpers/form/select_helper'
+require 'bh/helpers/form/static_control_helper'
+require 'bh/helpers/form/submit_helper'
+
+module Bh
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include Form::CheckBoxHelper
+    include Form::FieldHelper
+    include Form::FieldsetHelper
+    include Form::FieldsForHelper
+    include Form::LegendHelper
+    include Form::RadioButtonHelper
+    include Form::SelectHelper
+    include Form::StaticControlHelper
+    include Form::SubmitHelper
+
+    # @note: field_helpers are returned as symbols in ActionView 4 and as
+    #   strings in ActionView 3
+    def self.textual_field_helpers
+      non_textual_field_helpers = %w(label hidden_field range_field check_box
+        radio_button select submit fields_for label)
+      field_helpers.map(&:to_s) - non_textual_field_helpers
+    end
+
+    # Use the same template for all the textual field helpers such as
+    # email_field, password_field, etc.
+    # Exclude the ones that should not have additional styles.
+    # Do not show error icons on number_field not to cover the sliders.
+    textual_field_helpers.each do |field_type|
+      define_method field_type do |method, options = {}|
+        field(method, field_type, options) { super method, options }
+      end
+    end
+  end
+end

data/lib/bh/helpers/alert_helper.rb

@@ -1,11 +1,8 @@
-require 'action_view'
+require 'bh/helpers/base_helper'
 
 module Bh
   module AlertHelper
-    include ActionView::Helpers::TagHelper # for content_tag
-    include ActionView::Context # for capture
-    include ActionView::Helpers::OutputSafetyHelper # for safe_join
-
+    include BaseHelper
     # Returns an HTML block tag that follows the Bootstrap documentation
     # on how to display *alert boxes*.
     # Alert boxes provide contextual feedback messages for typical user

data/lib/bh/helpers/base_helper.rb

@@ -0,0 +1,17 @@
+require 'action_view'
+
+module Bh
+  module BaseHelper
+    include ActionView::Helpers::TagHelper # for content_tag
+    include ActionView::Context # for capture
+    include ActionView::Helpers::OutputSafetyHelper # for safe_join
+    include ActionView::Helpers::RenderingHelper # for render
+
+  private
+
+    def append_class!(hash, new_class)
+      existing_class = hash[:class]
+      hash[:class] = [existing_class, new_class].compact.join ' '
+    end
+  end
+end

data/lib/bh/helpers/form/base_helper.rb

@@ -0,0 +1,112 @@
+require 'bh/helpers/glyphicon_helper'
+
+module Bh
+  module Form
+    module BaseHelper
+      include GlyphiconHelper # for glyphicon
+
+    private
+
+      def base_field(method, field_type, options = {}, &block)
+        errors = (object.errors.get method if object) || {}
+        label = label_for method, errors, options
+        field = field_container(options) do
+          field_tags errors, field_type, &block
+        end
+        label_and_field = safe_join [label, field].compact
+        label_and_field_container label_and_field, field_type, errors
+      end
+
+
+      def field_container(options = {}, &block)
+        if horizontal_form?
+          klass = [('col-sm-offset-3' if options[:offset]), 'col-sm-9']
+          content_tag :div, class: klass.compact.join(' '), &block
+        else
+          yield
+        end
+      end
+
+      def field_tags(errors, field_type, &block)
+        tags = [@template.capture(&block)]
+        tags << error_icon_tag if errors.any? && show_error_icon?(field_type)
+        tags << error_help_tag(errors) if errors.any? && show_error_help?
+        safe_join tags
+      end
+
+      def label_and_field_container(label_and_field, field_type, errors = {})
+        klass = ['form-group']
+        if errors.any?
+          klass << 'has-error'
+          klass << 'has-feedback' if show_error_icon?(field_type)
+        end
+        content_tag :div, label_and_field, class: klass.join(' ')
+      end
+
+
+      def show_error_icon?(field_type)
+        hide = [:checkbox, :number_field, :radio_button, :select, :legend].include? field_type
+        @options.fetch(:errors, {}).fetch(:icons, true) && !hide
+      end
+
+
+      def error_icon_tag
+        glyphicon :remove, class: 'form-control-feedback'
+      end
+
+      def error_help_tag(errors)
+        klass = ['help-block', 'text-left']
+        klass << 'sr-only' if inline_form?
+        content_tag :span, errors.to_sentence, class: klass.join(' ')
+      end
+
+      def label_for(method, errors, options)
+        if options.delete(:use_label) { true }
+           args = [method, options.delete(:label), label_options(errors)]
+           label *args.compact
+        end
+      end
+
+      def label_options(errors = {})
+        klass = []
+        klass << 'sr-only' if inline_form?
+        klass << 'col-sm-3' if horizontal_form?
+        klass << 'control-label' if horizontal_form?
+        klass << 'control-label' if basic_form? && errors.any?
+        {class: klass.join(' ')} if klass.any?
+      end
+
+      # Rails adds <div class='field_with_errors'> which messes up
+      # Bootstrap inline form unless the label is inserted within
+      # the div itself.
+      def label_and_field(container_class, method, options = {}, &block)
+        label_and_field = @template.capture(&block)
+        label = options.delete(:label)
+        if index = label_and_field =~ %r{</div>$}
+          label_and_field.insert index, " #{label}"
+        else
+          label_and_field.concat " #{label}"
+        end
+        content_tag :div, class: container_class do
+          content_tag :label, label_and_field
+        end
+      end
+
+      def show_error_help?
+        @options.fetch(:errors, {}).fetch(:messages, :inline).to_s == 'inline'
+      end
+
+      def inline_form?
+        @options[:layout].to_s == 'inline'
+      end
+
+      def horizontal_form?
+        @options[:layout].to_s == 'horizontal'
+      end
+
+      def basic_form?
+        !inline_form? && !horizontal_form?
+      end
+    end
+  end
+end