bh 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4f7bca38e930bb3d819bb8eb02c8179cba085ba
-  data.tar.gz: 0f378c9f8ad7a87c3c157a394f22523c725479bf
+  metadata.gz: a5ee96b17731875a1201eb7ec0cf89f1835e44ed
+  data.tar.gz: 538d55809b170aa39b2bf7dc533bf57b601627ed
 SHA512:
-  metadata.gz: 191624fbe875bdbeeaca0c0892371b98982be93c52c371c6fbfb570040965616b8d9cfc59ad87edeb4f39d24f476181ef9674f5773d6e226b7386cf3221c63dc
-  data.tar.gz: 1fbac9bf8bb10d1d3763aedd47e35a569c51211a93b21aa5c7acb25877c1dc9e300db77a8a74495f30f1ebaf5696766504e148bb8a8c802d9df11c191c3d6390
+  metadata.gz: 34dc9102e88461797920f35beb0192c13590dbffab164262a6451be3e2224b276b68826dff4c389a7e06a1606653a74b12417e9c863c26ab269e0867257eaecc
+  data.tar.gz: 63405566998bc759a03dfb472aa7b96976d9c3580fec01f1497bfdb1eac3ea6c4d58a7a9d0e5cb1cb33ce2c7eaf5a7e3ab42658bb4c39e1f0b3b736bd89158a0

data/CHANGELOG.md

@@ -6,6 +6,16 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 1.3.0 - 2014-02-02
+
+* [FEATURE] Extend `form_for` to be wrapped in <li> when inside a `nav`, just like `link_to`
+* [FEATURE] Extend `button_to` to be wrapped in <li> when inside a `nav`, just like `link_to`
+* [BUGFIX] Match default placeholder with label content (therefore supporting localization)
+* [ENHANCEMENT] Bootstrappify forms wrapped in `navbar`, setting their class to "navbar-form"
+* [ENHANCEMENT] Add `:help` option to display a help block after most form fields
+* [ENHANCEMENT] Bump Bootstrap version to 3.3.2
+* [ENHANCEMENT] Bump Font Awesome version to 4.3.0
+
 ## 1.2.0 - 2014-11-13
 
 * [FEATURE] Add support for Middleman and Padrino for all helpers except `form_for`

data/README.md

@@ -1,8 +1,8 @@
 Bh · Bootstrap Helpers
 ======================
 
-Bh provides a set of helpers that streamlines the use of
-[Bootstrap 3 components](http://getbootstrap.com/components) in Ruby views.
+A set of Ruby helpers that streamlines the use of
+[Bootstrap 3 components](http://getbootstrap.com/components) in HTML views.
 
 The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/github/Fullscreen/bh/master/Bh/Helpers).
 

data/lib/bh/classes/cdn.rb

@@ -7,14 +7,14 @@ module Bh
       # @note if unspecified, the version should match the latest available
       #   version. If that's not the case, it's a bug and should be fixed.
       def self.bootstrap(options = {})
-        options[:version] ||= '3.3.0'
+        options[:version] ||= '3.3.2'
         cdn_asset options.merge(library: 'bootstrap')
       end
 
       # @note if unspecified, the version should match the latest available
       #   version. If that's not the case, it's a bug and should be fixed.
       def self.font_awesome(options = {})
-        options[:version] ||= '4.2.0'
+        options[:version] ||= '4.3.0'
         cdn_asset options.merge(library: 'font-awesome')
       end
 

data/lib/bh/core_ext/rails/form/base_helper.rb

@@ -31,10 +31,15 @@ module Bh
 
       def field_tags(errors, field_type, options = {}, &block)
         prefix, suffix = options.delete(:prefix), options.delete(:suffix)
+        help_text = options.delete(:help)
         field = @template.capture(&block)
         tags = [field_in_group(field, prefix, suffix)]
         tags << error_icon_tag if show_error_icon?(field_type, errors, suffix)
-        tags << error_help_tag(errors) if errors.any? && show_error_help?
+        if errors.any? && show_error_help?
+          tags << help_tag(errors.to_sentence)
+        elsif help_text
+          tags << help_tag(help_text)
+        end
         safe_join tags
       end
 
@@ -74,10 +79,10 @@ module Bh
         glyphicon :remove, class: 'form-control-feedback'
       end
 
-      def error_help_tag(errors)
+      def help_tag(help_text)
         klass = ['help-block', 'text-left']
         klass << 'sr-only' if inline_form?
-        content_tag :span, errors.to_sentence, class: klass.join(' ')
+        content_tag :span, help_text, class: klass.join(' ')
       end
 
       def label_for(method, errors, options)
@@ -117,7 +122,7 @@ module Bh
       end
 
       def inline_form?
-        @options[:layout].to_s == 'inline'
+        ['inline', 'navbar'].include? @options[:layout].to_s
       end
 
       def horizontal_form?

data/lib/bh/core_ext/rails/form/field_helper.rb

@@ -6,7 +6,7 @@ module Bh
       include BaseHelper
 
       def field(method, field_type, options = {}, &block)
-        options[:placeholder] ||= method.to_s.humanize
+        options[:placeholder] ||= strip_tags(label method)
         append_class! options, 'form-control'
         base_field method, field_type, options, &block
       end

data/lib/bh/core_ext/rails/form_builder.rb

@@ -12,6 +12,8 @@ require 'bh/core_ext/rails/form/submit_helper'
 module Bh
   # @api private
   class FormBuilder < ActionView::Helpers::FormBuilder
+    include ActionView::Helpers::SanitizeHelper
+    extend ActionView::Helpers::SanitizeHelper::ClassMethods
     include Form::CheckBoxHelper
     include Form::FieldHelper
     include Form::FieldsetHelper

data/lib/bh/core_ext/rails/form_for_helper.rb

@@ -8,8 +8,16 @@ module Bh
       include ActionView::Helpers::FormHelper # for form_for
 
       def form_for(record, options = {}, &block)
+        options[:layout] ||= 'navbar' if Bh::Stack.find(Bh::Navbar)
         add_form_options!(options) if options[:layout]
-        super record, options, &block
+        html = super record, options, &block
+
+        if Bh::Stack.find(Bh::Nav)
+          container = Bh::Base.new(self) { html }
+          container.render_tag :li
+        else
+          html
+        end
       end
 
     private
@@ -23,6 +31,7 @@ module Bh
 
       def class_for(layout)
         case layout.to_s
+          when 'navbar' then 'navbar-form'
           when 'inline' then 'form-inline'
           when 'horizontal' then 'form-horizontal'
         end

data/lib/bh/helpers/button_to_helper.rb

@@ -9,6 +9,7 @@ module Bh
     # Only overrides the original method if called with any of the `:context`,
     # `:size` or `:layout` option, otherwise calls the original method.
     # @see http://getbootstrap.com/css/#buttons
+    # @see http://getbootstrap.com/components/#nav
     # @see http://getbootstrap.com/components/#navbar-buttons
     # @see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to
     # @see http://rubydoc.info/gems/padrino-helpers/Padrino/Helpers/FormHelpers#button_to-instance_method
@@ -47,11 +48,18 @@ module Bh
         button_to.append_form_class! 'navbar-form' if Bh::Stack.find(Bh::Navbar)
       end
 
-      if block_given? && button_to.accepts_block?
+      html = if block_given? && button_to.accepts_block?
         super button_to.url, button_to.attributes, &-> { button_to.content }
       else
         super button_to.content, button_to.url, button_to.attributes, &nil
       end
+
+      if Bh::Stack.find(Bh::Nav)
+        container = Bh::Base.new(self) { html }
+        container.render_tag :li
+      else
+        html
+      end
     end
   end
 end

data/lib/bh/version.rb

@@ -1,3 +1,3 @@
 module Bh
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/rails/form/check_box_helper_spec.rb

@@ -23,6 +23,15 @@ describe 'check_box' do
       it { expect(form).to include 'Given name</label>' }
     end
 
+    context 'not given a help option, does not display a help box' do
+      it { expect(form).not_to include 'help-block' }
+    end
+
+    context 'given a help option, displays a help box' do
+      let(:options) { {help: 'Please select an option'} }
+      it { expect(form).to include '<span class="help-block text-left">Please select an option</span>' }
+    end
+
     specify 'not given an error, does not apply has-error to the form group' do
       expect(form).not_to include 'has-error'
     end
@@ -83,6 +92,14 @@ describe 'check_box' do
       end
     end
 
+    context 'given a help message' do
+      let(:options) { {help: 'Please select an option'} }
+
+      specify 'applies sr-only to the help message' do
+        expect(form).to include '<span class="help-block text-left sr-only">Please select an option</span>'
+      end
+    end
+
     context 'given the inline_label: false option' do
       let(:options) { {inline_label: false} }
 

data/spec/rails/form/field_helper_spec.rb

@@ -42,6 +42,15 @@ field_helpers_to_test.each do |form_field|
         it { expect(form).to include 'Given name</label>' }
       end
 
+      context 'not given a help option, does not display a help box' do
+        it { expect(form).not_to include 'help-block' }
+      end
+
+      context 'given a help option, displays a help box' do
+        let(:options) { {help: 'Please write the given name'} }
+        it { expect(form).to include '<span class="help-block text-left">Please write the given name</span>' }
+      end
+
       specify 'not given a prefix or suffix option, does not use an input group' do
         expect(form).not_to include 'input-group'
       end
@@ -109,6 +118,14 @@ field_helpers_to_test.each do |form_field|
         expect(form).to match %r{<div class="form-group"><label class="sr-only".+?>Name</label><(input|textarea) class="form-control"}
       end
 
+      context 'given a help message' do
+        let(:options) { {help: 'Please write the given name'} }
+
+        specify 'applies sr-only to the help message' do
+          expect(form).to include '<span class="help-block text-left sr-only">Please write the given name</span>'
+        end
+      end
+
       context 'given an error' do
         before { user.errors.add :name, 'cannot be nil' }
 

data/spec/rails/form/file_field_helper_spec.rb

@@ -7,7 +7,21 @@ describe 'file_field' do
   let(:form) { form_for user, layout: layout, errors: errors, url: '/', &block }
   let(:user) { User.new }
   let(:errors) { {} }
-  let(:block) { Proc.new {|f| f.file_field :name, accept: 'text/html'} }
+  let(:block) { Proc.new {|f| f.file_field :name, options.merge(accept: 'text/html')} }
+  let(:options) { {} }
+
+  context 'given any layout' do
+    let(:layout) { :whatever }
+
+    context 'not given a help option, does not display a help box' do
+      it { expect(form).not_to include 'help-block' }
+    end
+
+    context 'given a help option, displays a help box' do
+      let(:options) { {help: 'Please upload a file'} }
+      it { expect(form).to include '<span class="help-block text-left">Please upload a file</span>' }
+    end
+  end
 
   describe 'given a basic layout' do
     let(:layout) { :basic }
@@ -41,6 +55,14 @@ describe 'file_field' do
       expect(form).not_to match 'form-control'
     end
 
+    context 'given a help message' do
+      let(:options) { {help: 'Please select a file'} }
+
+      specify 'applies sr-only to the help message' do
+        expect(form).to include '<span class="help-block text-left sr-only">Please select a file</span>'
+      end
+    end
+
     context 'given an error' do
       before { user.errors.add :name, 'cannot be nil' }
 

data/spec/rails/form/radio_button_helper_spec.rb

@@ -22,6 +22,15 @@ describe 'radio_button' do
       it { expect(form).to include '> Jerry</label>' }
     end
 
+    context 'not given a help option, does not display a help box' do
+      it { expect(form).not_to include 'help-block' }
+    end
+
+    context 'given a help option, displays a help box' do
+      let(:options) { {help: 'Please select an option'} }
+      it { expect(form).to include '<span class="help-block text-left">Please select an option</span>' }
+    end
+
     specify 'not given an error, does not apply has-error to the form group' do
       expect(form).not_to include 'has-error'
     end
@@ -56,6 +65,14 @@ describe 'radio_button' do
       expect(form).to match %r{<div class="radio"><label><input.+? /> Jeremy</label></div>}
     end
 
+    context 'given a help message' do
+      let(:options) { {help: 'Please select an option'} }
+
+      specify 'applies sr-only to the help message' do
+        expect(form).to include '<span class="help-block text-left sr-only">Please select an option</span>'
+      end
+    end
+
     context 'given an error' do
       before { user.errors.add :name, 'cannot be nil' }
 

data/spec/rails/form/select_helper_spec.rb

@@ -22,6 +22,15 @@ describe 'select' do
       it { expect(form).to include 'Given name</label>' }
     end
 
+    context 'not given a help option, does not display a help box' do
+      it { expect(form).not_to include 'help-block' }
+    end
+
+    context 'given a help option, displays a help box' do
+      let(:options) { {help: 'Please select an option'} }
+      it { expect(form).to include '<span class="help-block text-left">Please select an option</span>' }
+    end
+
     specify 'not given an error, does not apply has-error to the form group' do
       expect(form).not_to include 'has-error'
     end
@@ -60,6 +69,14 @@ describe 'select' do
       expect(form).to match %r{<div class="form-group"><label class="sr-only".+?>Name</label><select class="form-control"}
     end
 
+    context 'given a help message' do
+      let(:options) { {help: 'Please select an option'} }
+
+      specify 'applies sr-only to the help message' do
+        expect(form).to include '<span class="help-block text-left sr-only">Please select an option</span>'
+      end
+    end
+
     context 'given an error' do
       before { user.errors.add :name, 'cannot be nil' }
 

data/spec/rails/form_for_helper_spec.rb

@@ -3,16 +3,23 @@ require 'bh/core_ext/rails/form_for_helper'
 include Bh::Rails::Helpers
 
 describe 'form_for' do
+  let(:bh) { RailsView.new }
   let(:protect_against_forgery?) { false }
   attr_accessor :output_buffer
   let(:form) { form_for(:object, options.merge(url: '/')) {} }
+  let(:options) { {} }
 
-  describe 'without a :layout option' do
-    let(:options) { {} }
+  specify 'by default, does not apply Bootstrap attributes to the form' do
+    expect(form).not_to include 'role="form"'
+  end
 
-    specify 'does not apply Bootstrap attributes to the form' do
-      expect(form).not_to include 'role="form"'
-    end
+  specify 'wrapped in navbar, applies Bootstrap attributes of a navbar form' do
+    bh.navbar { expect(form).to include 'role="form"' }
+    bh.navbar { expect(form).to include 'class="navbar-form"' }
+  end
+
+  specify 'wrapped in nav, surrounds the form in a <li> item' do
+    bh.nav { expect(form).to match %r{^<li><form.+?</form></li>$} }
   end
 
   describe 'with layout: :horizontal' do

data/spec/shared/button_to_helper.rb

@@ -3,6 +3,7 @@ shared_examples_for 'the button_to helper' do
   all_tests_pass_with 'the :size button_to option'
   all_tests_pass_with 'the :layout button_to option'
   all_tests_pass_with 'the button wrapped in navbar'
+  all_tests_pass_with 'the button wrapped in nav'
 end
 
 #--
@@ -39,4 +40,12 @@ shared_examples_for 'the button wrapped in navbar' do
     html = %r{^<form.+class="navbar-form"}
     bh.navbar { expect(button_to: {context: :default}).to generate html }
   end
-end
+end
+
+
+shared_examples_for 'the button wrapped in nav' do
+  specify 'surrounds the form in a <li> item' do
+    html = %r{^<li><form.+?</form></li>}
+    bh.nav { expect(:button_to).to generate html }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bh
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Bh provides a set of powerful helpers that streamlines the use of Bootstrap