bh 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2efc7f83e6175dbda16f557b14d18d6889748c35
-  data.tar.gz: d8f958fb28c28731a4fe32587b00f2767f1fc441
+  metadata.gz: 6522abb89dd53d34215f678b086d1e9414181039
+  data.tar.gz: ce5a63947bd03e86eef43b9ea3801d8692605447
 SHA512:
-  metadata.gz: 16df29192db7253cda1592a8bdb3d0cad6272fe0eb6c5b6393f44dbd61b70fc1bba2117ee571b65d8283107fe4f9a91a546c41bb0894c950f94d95a03c9092dc
-  data.tar.gz: 43106b14b0e3741cb56b2165d0babe1241056e2e23189efd2ed42dead693b3283e5c6d2afc013af415c36eece5c1acb072fd7895b9ef8ada27a6a7159c3e8355
+  metadata.gz: 154e1ec61fee0870b2513f76ec23d7c4be8dc7c8dba2b4a2d8cc1ef3be493eebeb9f405c8f6e9e1557908d8d871df66e6e426b01d6b5f9c06e6128c6f7223e30
+  data.tar.gz: 85e4fe4953a9cc6a6a1b221c76af892aecd330c22e4a499627298f748be4b0d7d938d831e815738e65154424b34a4a96ea977716816efa0e8cc0cd182a36f7ad

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.7 - 2014-08-25
+
+* [FEATURE] Add `nav` helper
+
 ## 0.0.6 - 2014-08-22
 
 * [FEATURE] Add `:prefix`, `:suffix` options to form field helpers

data/README.md

@@ -46,7 +46,7 @@ How to install
 
 Bh is meant to be included in Rails apps by adding this line to the Gemfile:
 
-    gem 'bh', '~> 0.0.6'
+    gem 'bh', '~> 0.0.7'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -276,7 +276,7 @@ will generate the HTML to render a panel with a heading:
 ![panel-heading](https://cloud.githubusercontent.com/assets/7408595/3941820/da58db3e-2543-11e4-811f-f7da4ffce77d.png)
 
 Panel with title
-------------------
+----------------
 
 ```rhtml
 <%= panel body: 'You accepted the Terms of service.', title: 'Congratulations' %>
@@ -296,7 +296,7 @@ will generate the HTML to render a panel with a title:
 ![panel-title](https://cloud.githubusercontent.com/assets/7408595/3941816/da52b894-2543-11e4-99b8-4b6ffd47c167.png)
 
 Contextual panel
------------------
+----------------
 
 ```rhtml
 <%= panel body: 'You accepted the Terms of service.', title: 'Congratulations', context: :success %>
@@ -537,6 +537,59 @@ Here is how a form with a text field and a submit button looks like with each la
 ![form-for-inline](https://cloud.githubusercontent.com/assets/7408595/4015591/30609b74-2a2c-11e4-989e-e509d72ed224.png)
 
 
+NavHelper
+===========
+
+To include [Boostrap navs](http://getbootstrap.com/components/#nav)
+in your Rails views, you can use the
+[nav](http://rubydoc.info/github/Fullscreen/bh/master/Bh/NavHelper) helper.
+Here are some examples.
+
+Justified tabs nav
+------------------
+
+```rhtml
+<%= nav layout: :justified do %>
+  <%= link_to 'Home', root_path %>
+  <%= link_to 'Profile', profile_path %>
+<% end %>
+```
+
+will generate the HTML to render a nav with two links (wrapped in the
+appropriate list items, as specified by Bootstrap documentation):
+
+```html
+<ul class="nav nav-tabs nav-justified" role="tablist">
+    <li class="active"><a href="/">Home</a></li>
+    <li><a href="/profile">Profile</a></li>
+</ul>
+```
+
+![nav-tabs](https://cloud.githubusercontent.com/assets/7408595/4038705/9dede620-2cba-11e4-9543-6384e8ac9ace.png)
+
+Stacked pills nav
+-----------------
+
+```rhtml
+<%= nav as: :pills, layout: :stacked do %>
+  <%= link_to 'Home', root_path %>
+  <%= link_to 'Profile', profile_path %>
+<% end %>
+
+```
+
+will generate the HTML to render a stacked *pills* nav:
+
+```html
+<ul class="nav nav-pills nav-stacked" role="tablist">
+  <li class="active"><a href="/">Home</a></li>
+  <li><a href="/profile">Profile</a></li>
+</ul>
+```
+
+![nav-pills](https://cloud.githubusercontent.com/assets/7408595/4038706/9df29ad0-2cba-11e4-83de-cd31b6659c78.png)
+
+
 How to release new versions
 ===========================
 

data/lib/bh/helpers/base_helper.rb

@@ -6,6 +6,7 @@ module Bh
     include ActionView::Context # for capture
     include ActionView::Helpers::OutputSafetyHelper # for safe_join
     include ActionView::Helpers::RenderingHelper # for render
+    include ActionView::Helpers::UrlHelper # for link_to
 
   private
 

data/lib/bh/helpers/nav_helper.rb

@@ -0,0 +1,58 @@
+require 'bh/helpers/base_helper'
+
+module Bh
+  # Provides methods to include navs.
+  # @see http://getbootstrap.com/components/#nav
+  module NavHelper
+    include BaseHelper
+
+    # Returns an HTML block tag that follows the Bootstrap documentation
+    # on how to display *navs*.
+    #
+    # The skeleton of the nav is an unordered list; its content is passed as a
+    # block as a list of navigation items.
+    # Since the most common use for a nav is to display a menu of links, a
+    # variable is set inside the block so that every call to +link_to+
+    # generates a link *surrounded by a list item*.
+    # @example An justified nav with two links.
+    #   nav layout: :justified do
+    #     link_to 'Home', '/'
+    #     link_to 'Profile', '/profile'
+    #   end
+    #
+    # @return [String] an HTML block tag for a nav.
+    # @param [Hash] options the display options for the nav.
+    # @option options [#to_s] :as ('tabs') the style to use for the nav.
+    #   Valid values are: :tabs and :pills.
+    # @option options [#to_s] :layout (nil) if set, the layout of the nav.
+    #   Valid values are: :justified and :stacked.
+    # @yield block the content of the nav
+    # @see http://getbootstrap.com/components/#nav
+    def nav(options = {}, &block)
+      @nav_link = true
+      nav = content_tag :ul, role: 'tablist', class: nav_class(options), &block
+      nav.tap{ @nav_link = false }
+    end
+
+    # Overrides ActionView +link_to+ to be able to surround the link in a
+    # '<li>' item in case the link is inside of a nav.
+    def link_to(*args, &block)
+      link = super *args, &block
+      @nav_link ? content_tag(:li, link, nav_list_item_options(*args)) : link
+    end
+
+  private
+
+    def nav_list_item_options(*args)
+      options = (block_given? ? args[0] : args[1]) || {}
+      {class: 'active'} if current_page? options
+    end
+
+    def nav_class(options = {})
+      append_class! options, 'nav'
+      append_class! options, "nav-#{options.fetch :as, 'tabs'}"
+      append_class! options, "nav-#{options[:layout]}" if options[:layout]
+      options[:class]
+    end
+  end
+end

data/lib/bh/helpers/url_helper.rb

@@ -2,8 +2,6 @@ require 'action_view'
 
 module Bh
   module UrlHelper
-    include ActionView::Helpers::UrlHelper # for link_to
-
     # Overrides ActionView +link_to+ to be able to add the 'alert_link' class
     # to the link in case the link is inside of an alert.
     # @see http://getbootstrap.com/components/#alerts-links

data/lib/bh/railtie.rb

@@ -3,6 +3,7 @@ require 'bh/helpers/cdn_helper'
 require 'bh/helpers/form_for_helper'
 require 'bh/helpers/glyphicon_helper'
 require 'bh/helpers/modal_helper'
+require 'bh/helpers/nav_helper'
 require 'bh/helpers/panel_helper'
 require 'bh/helpers/panel_row_helper'
 require 'bh/helpers/url_helper'
@@ -15,6 +16,7 @@ module Bh
       ActionView::Base.send :include, FormForHelper
       ActionView::Base.send :include, GlyphiconHelper
       ActionView::Base.send :include, ModalHelper
+      ActionView::Base.send :include, NavHelper
       ActionView::Base.send :include, PanelHelper
       ActionView::Base.send :include, PanelRowHelper
       ActionView::Base.send :include, UrlHelper

data/lib/bh/version.rb

@@ -1,3 +1,3 @@
 module Bh
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/helpers/nav_helper_spec.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'action_dispatch'
+require 'bh/helpers/nav_helper'
+
+include Bh::NavHelper
+
+describe 'nav' do
+  let(:html) { nav options, &block }
+  let(:block) { Proc.new {} }
+  let(:options) { {} }
+
+  describe 'with the :as option' do
+    specify 'not set, shows a "tabs" nav' do
+      expect(html).to include 'ul class="nav nav-tabs" role="tablist"'
+    end
+
+    context 'set to :tabs, shows a "tabs" nav' do
+      let(:options) { {as: :tabs} }
+      it { expect(html).to include 'ul class="nav nav-tabs"' }
+    end
+
+    context 'set to :pills, shows a "tabs" nav' do
+      let(:options) { {as: :pills} }
+      it { expect(html).to include 'ul class="nav nav-pills"' }
+    end
+  end
+
+  describe 'with the :layout option' do
+    specify 'not set, does not set a layout' do
+      expect(html).to include 'ul class="nav nav-tabs" role="tablist"'
+    end
+
+    context 'set to :justified, shows a "justified" nav' do
+      let(:options) { {layout: :justified} }
+      it { expect(html).to include 'nav-justified' }
+    end
+
+    context 'set to :stacked, shows a "stacked" nav' do
+      let(:options) { {layout: :stacked} }
+      it { expect(html).to include 'nav-stacked' }
+    end
+  end
+
+  describe 'given a +link_to+ in the content' do
+    let(:block) { Proc.new { link_to 'Home', url} }
+    let(:url) { '/any-page' }
+    let(:request) { ActionDispatch::Request.new request_options }
+    let(:request_options) { {'REQUEST_METHOD' => 'GET'} }
+
+    specify 'surrounds the link in a list item' do
+      expect(html).to include '<li><a href="/any-page">Home</a></li>'
+    end
+
+    context 'sets the "active" class if the link points to the same page' do
+      let(:url) { '' }
+      it { expect(html).to include 'li class="active"' }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bh
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,6 +159,7 @@ files:
 - lib/bh/helpers/form_for_helper.rb
 - lib/bh/helpers/glyphicon_helper.rb
 - lib/bh/helpers/modal_helper.rb
+- lib/bh/helpers/nav_helper.rb
 - lib/bh/helpers/panel_helper.rb
 - lib/bh/helpers/panel_row_helper.rb
 - lib/bh/helpers/url_helper.rb
@@ -179,6 +180,7 @@ files:
 - spec/helpers/form_for_helper_spec.rb
 - spec/helpers/glyphicon_helper_spec.rb
 - spec/helpers/modal_helper_spec.rb
+- spec/helpers/nav_helper_spec.rb
 - spec/helpers/panel_helper_spec.rb
 - spec/helpers/panel_row_helper_spec.rb
 - spec/helpers/url_helper_spec.rb
@@ -223,6 +225,7 @@ test_files:
 - spec/helpers/form_for_helper_spec.rb
 - spec/helpers/glyphicon_helper_spec.rb
 - spec/helpers/modal_helper_spec.rb
+- spec/helpers/nav_helper_spec.rb
 - spec/helpers/panel_helper_spec.rb
 - spec/helpers/panel_row_helper_spec.rb
 - spec/helpers/url_helper_spec.rb