bootstrap-navbar 0.0.13 → 1.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1a8ce95231b5f0e27729be22f6f1c510c7425e4
-  data.tar.gz: 5bff4661ff302e82b4e113daadb54e0b6f33b838
+  metadata.gz: db92ce40b7a8185abc9893f93030a213ab8d8601
+  data.tar.gz: 1d0d60b6f459a56b2bd0c8c1631db31095bf3523
 SHA512:
-  metadata.gz: 71f6ece8a5c288f346e1b195cefd700d4fddc62d9a4d8ded4c2eded71de02732d8c7fce1cfab7879f8df6cddae3d01e6eadab4fe133a00f4806f4a3a2b571423
-  data.tar.gz: 6e0a9f2d3805b95e08570f824efcc488581227084c73f07da188581b118fe7bfc18508bc7d494eef1e41c88291d337352d9e0d887880f6771ab9a5ddaa7644cb
+  metadata.gz: 2930350b4b5b9976adcefda73fc0bafb4f0d197dfc3b7e3bad8608b27e0582a98bc41dabad861f9b6d1c549e0ea2526c34a21fde57e9494c9e6c93f441c2b1b9
+  data.tar.gz: 5b8fcf722a72a1581a1be65ee1c991f5bf277f5d176656f0aa70f5b88a63c201e440f02f2db591c6d36b6968878eecdb35ecfd09acb8b112ebd0391e3a022e11

data/README.md

@@ -16,15 +16,31 @@ This gem only provides a helper module with methods to generate HTML. It can be
 
 In short: __Unless you know what you're doing, do not use this gem directly in your app!__
 
+## Requirements
+
+Only Bootstrap >= 2.1.0 is supported. It might work with earlier versions as well though.
+
 ## Setup
 
+### Set bootstrap_version (required)
+
+BootstrapNavbar needs to know what version of Bootstrap it's dealing with since each version has small changes compared to the previous one.
+
+```ruby
+BootstrapNavbar.configure do |config|
+  config.bootstrap_version = '3.0.0'
+end
+```
+
 ### Set current_url_method (required)
 
 BootstrapNavbar has to be able to query for the current URL when rendering the navbar, e.g. to determine if a menu item is active or not. Since the way the current URL is determined varies depending on whether you use Rails, Sinatra, etc., this has to be set beforehand in some kind of initializer:
 
 ```ruby
 # For Rails >= 3.2
-BootstrapNavbar.current_url_method = 'request.original_url'
+BootstrapNavbar.configure do |config|
+  config.current_url_method = 'request.original_url'
+end
 ```
 
 `current_url_method` should be set to a string which can be `eval`ed later.
@@ -58,8 +74,7 @@ Let's assume you have mixed in the helper in your rendering engine and use Haml.
 ### Full example
 
 ```ruby
-= nav_bar fixed: :top, responsive: true do
-  = brand_link 'My great app'
+= navbar brand: 'My great app', brand_link: '/home', fixed: :top, responsive: true do
   = menu_group class: 'foo', id: 'menu' do
     = menu_text 'Pick an option:'
     = menu_item "Home", root_path
@@ -87,12 +102,12 @@ Let's assume you have mixed in the helper in your rendering engine and use Haml.
 
 ### Methods
 
-#### nav_bar
+#### navbar
 
 This method sets up the basic structure of a navbar.
 
 ```haml
-= nav_bar
+= navbar
 ```
 
 generates:
@@ -109,7 +124,7 @@ generates:
 The content of the navbar is supplied by the block and the available options:
 
 ```haml
-= nav_bar do
+= navbar do
   Yay!
 ```
 
@@ -128,7 +143,7 @@ generates:
 Options `brand` and `brand_link` autogenerate the brand link:
 
 ```haml
-= nav_bar brand: 'My great app', brand_link: '/start'
+= navbar brand: 'My great app', brand_link: '/start'
 ```
 
 generates:
@@ -148,7 +163,7 @@ If only `brand` is defined, `brand_link` defaults to `/`.
 Option `responsive` generates a responsive navbar:
 
 ```haml
-= nav_bar responsive: true
+= navbar responsive: true
 ```
 
 generates:
@@ -158,18 +173,38 @@ generates:
   <div class="navbar-inner">
     <div class="container">
       <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
-      <span class='icon-bar'></span>
-      <span class='icon-bar'></span>
-      <span class='icon-bar'></span>
+        <span class='icon-bar'></span>
+        <span class='icon-bar'></span>
+        <span class='icon-bar'></span>
+      </a>
+      <div class="nav-collapse collapse">
+      </div>
     </div>
   </div>
 </div>
 ```
 
+**Attention: when using the `responsive` option, the brand link should not be added through the `brand_link` method but directly supplied to the `navbar` call.**
+
+Don't do this:
+
+```haml
+= navbar responsive: true do
+  = brand_link 'My great app', '/home'
+```
+
+Do this:
+
+```haml
+= navbar responsive: true, brand: 'My great app', brand_link: '/home'
+```
+
+Otherwise the brand link will be nested incorrectly and will disappear when resizing the window to a smaller size.
+
 Option `fluid` changes the grid system to be [fluid](http://twitter.github.io/bootstrap/scaffolding.html#fluidGridSystem):
 
 ```haml
-= nav_bar fluid: true
+= navbar fluid: true
 ```
 
 generates:
@@ -185,7 +220,7 @@ generates:
 
 #### brand_link
 
-This method generates a menu divider, to be used in a `nav_bar`.
+This method generates a menu divider, to be used in a `navbar`.
 
 ```haml
 = brand_link 'My App', '/home'
@@ -201,7 +236,7 @@ If the path (`/home` in this case) is not specified, it defaults to `/`.
 
 #### menu_text
 
-This method generates some menu text, to be used in a `nav_bar`.
+This method generates some menu text, to be used in a `navbar`.
 
 ```haml
 = menu_text 'Select a option:'
@@ -248,7 +283,7 @@ generates:
 
 #### menu_group
 
-This method generates a menu group, to be used in a `nav_bar`.
+This method generates a menu group, to be used in a `navbar`.
 
 ```haml
 = menu_group
@@ -344,7 +379,7 @@ generates:
 </li>
 ```
 
-If the specified path/URL is the [current url](#set-current_url_method-required), it will be marked as `active`. Note that it doesn't matter if you link to a full URL or just the path, or if `BootstrapNavbar.current_url_method` returns a full URL or just the path, it will work regardless.
+If the specified path/URL is the [current url](#set-current_url_method-required), it will be marked as `active`. Note that it doesn't matter if you link to a full URL or just the path, or if `BootstrapNavbar.configuration.current_url_method` returns a full URL or just the path, it will work regardless.
 
 ```haml
 = menu_item 'Home', '/home'

data/bootstrap-navbar.gemspec

@@ -26,4 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-html-matchers', '~> 0.4.3'
   gem.add_development_dependency 'guard-rspec', '~> 3.0'
   gem.add_development_dependency 'padrino-helpers', '~> 0.11.2'
+  # Listen >= 2.0.0 only works with Ruby >= 1.9.3
+  gem.add_development_dependency 'listen', '< 2.0.0' if RUBY_VERSION < '1.9.3'
+  gem.add_runtime_dependency 'gem_config', '~> 0.2.4'
 end

data/lib/bootstrap-navbar.rb

@@ -1,13 +1,17 @@
-require 'bootstrap-navbar/version'
+require 'gem_config'
 
 module BootstrapNavbar
-  def self.current_url_method=(value)
-    @current_url_method = value
-  end
+  include GemConfig::Base
+
+  BOOTSTRAP_VERSIONS = %w(3.0.1 3.0.0 2.3.1 2.3.0 2.2.2 2.2.1 2.2.0 2.1.1 2.1.0 2.0.4 2.0.3 2.0.2 2.0.1 2.0.0)
 
-  def self.current_url_method
-    @current_url_method
+  with_configuration do
+    has :bootstrap_version, classes: String, values: BOOTSTRAP_VERSIONS
+    has :current_url_method, classes: String
   end
 end
 
-require 'bootstrap-navbar/helpers'
+require_relative 'bootstrap-navbar/version'
+require_relative 'bootstrap-navbar/helpers'
+require_relative 'bootstrap-navbar/helpers/bootstrap2'
+require_relative 'bootstrap-navbar/helpers/bootstrap3'

data/lib/bootstrap-navbar/helpers.rb

@@ -1,178 +1,7 @@
-require 'uri'
-
 module BootstrapNavbar::Helpers
-  def nav_bar(options = {}, &block)
-    nav_bar_div options do
-      navbar_inner_div do
-        container_div options[:brand], options[:brand_link], options[:responsive], options[:fluid], &block
-      end
-    end
-  end
-
-  def menu_group(options = {}, &block)
-    css_classes = %w(nav).tap do |css_classes|
-      css_classes << "pull-#{options.delete(:pull)}" if options.has_key?(:pull)
-      css_classes << options.delete(:class) if options.has_key?(:class)
-    end
-    attributes = attribute_hash_to_string({ class: css_classes.join(' ') }.merge(options))
-    prepare_html <<-HTML.chomp!
-<ul#{with_preceding_space attributes}>
-  #{capture(&block) if block_given?}
-</ul>
-HTML
-  end
-
-  def menu_item(name = nil, path = nil, list_item_options = nil, link_options = nil, &block)
-    name, path, list_item_options, link_options = capture(&block), name, path, list_item_options if block_given?
-    path              ||= '#'
-    list_item_options ||= {}
-    link_options      ||= {}
-
-    list_item_css_classes = [].tap do |css_classes|
-      css_classes << 'active' if current_url?(path)
-      css_classes << list_item_options.delete(:class) if list_item_options.has_key?(:class)
-    end
-    list_item_attributes = attribute_hash_to_string(
-      { class: list_item_css_classes.join(' ') }
-        .delete_if { |k, v| v.empty? }
-        .merge(list_item_options)
-    )
-    link_attributes = attribute_hash_to_string(link_options)
-    prepare_html <<-HTML.chomp!
-<li#{with_preceding_space list_item_attributes}>
-  <a href="#{path}"#{with_preceding_space link_attributes}>
-    #{name}
-  </a>
-</li>
-HTML
-  end
-
-  def drop_down(name, &block)
-    prepare_html <<-HTML.chomp!
-<li class="dropdown">
-  <a href="#" class="dropdown-toggle" data-toggle="dropdown">
-    #{name} <b class="caret"></b>
-  </a>
-  #{drop_down_menu(&block)}
-</li>
-HTML
-  end
-
-  def sub_drop_down(name, list_item_options = {}, link_options = {}, &block)
-    list_item_css_classes = %w(dropdown-submenu).tap do |css_classes|
-      css_classes << list_item_options.delete(:class) if list_item_options.has_key?(:class)
-    end
-    list_item_attributes = attribute_hash_to_string({ class: list_item_css_classes.join(' ') }.merge(list_item_options))
-    link_attributes = attribute_hash_to_string(link_options)
-    prepare_html <<-HTML.chomp!
-<li#{with_preceding_space list_item_attributes}>
-  <a href="#"#{with_preceding_space link_attributes}>
-    #{name}
-  </a>
-  #{drop_down_menu(&block)}
-</li>
-HTML
-  end
-
-  def drop_down_divider
-    prepare_html %(<li class="divider"></li>)
-  end
-
-  def drop_down_header(text)
-    prepare_html %(<li class="nav-header">#{text}</li>)
-  end
-
-  def menu_divider
-    prepare_html %(<li class="divider-vertical"></li>)
-  end
-
-  def menu_text(text = nil, pull = nil, &block)
-    css_classes = %w(navbar-text).tap do |css_classes|
-      css_classes << "pull-#{pull}" if pull
-    end
-    prepare_html <<-HTML.chomp!
-<p class="#{css_classes.join(' ')}">
-  #{block_given? ? capture(&block) : text}
-</p>
-HTML
-  end
-
-  def brand_link(name, url = nil)
-    prepare_html %(<a href="#{url || '/'}" class="brand">#{name}</a>)
-  end
-
-  private
-
-  def nav_bar_div(options, &block)
-    position = case
-    when options.has_key?(:static)
-      "static-#{options[:static]}"
-    when options.has_key?(:fixed)
-      "fixed-#{options[:fixed]}"
-    end
-
-    css_classes = %w(navbar).tap do |css_classes|
-      css_classes << "navbar-#{position}" if position
-      css_classes << 'navbar-inverse' if options[:inverse]
-    end
-
-    prepare_html <<-HTML.chomp!
-<div class="#{css_classes.join(' ')}">
-  #{capture(&block) if block_given?}
-</div>
-HTML
-  end
-
-  def navbar_inner_div(&block)
-    prepare_html <<-HTML.chomp!
-<div class="navbar-inner">
-  #{capture(&block) if block_given?}
-</div>
-HTML
-  end
-
-  def container_div(brand, brand_link, responsive, fluid, &block)
-    css_class = fluid ? 'container-fluid' : 'container'
-    content = [].tap do |content|
-      content << responsive_button if responsive
-      content << brand_link(brand, brand_link) if brand || brand_link
-      content << if responsive
-        responsive_wrapper(&block)
-      else
-        capture(&block) if block_given?
-      end
-    end
-    prepare_html <<-HTML.chomp!
-<div class="#{css_class}">
-  #{content.join("\n")}
-</div>
-HTML
-  end
-
-  def responsive_wrapper(&block)
-    prepare_html <<-HTML.chomp!
-<div class="nav-collapse collapse">
-  #{capture(&block) if block_given?}
-</div>
-HTML
-  end
-
-  def responsive_button
-    prepare_html <<-HTML.chomp!
-<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
-  <span class='icon-bar'></span>
-  <span class='icon-bar'></span>
-  <span class='icon-bar'></span>
-</a>
-HTML
-  end
-
-  def drop_down_menu(&block)
-    prepare_html <<-HTML.chomp!
-<ul class="dropdown-menu">
-  #{capture(&block) if block_given?}
-</ul>
-HTML
+  def self.included(base)
+    helper_version = BootstrapNavbar.configuration.bootstrap_version.split('.').first
+    base.send :include, const_get("BootstrapNavbar::Helpers::Bootstrap#{helper_version}")
   end
 
   def with_preceding_space(attributes)
@@ -191,8 +20,8 @@ HTML
   end
 
   def current_url
-    raise StandardError, 'current_url_method is not defined.' if BootstrapNavbar.current_url_method.nil?
-    eval BootstrapNavbar.current_url_method
+    raise StandardError, 'current_url_method is not defined.' if BootstrapNavbar.configuration.current_url_method.nil?
+    eval BootstrapNavbar.configuration.current_url_method
   end
 
   def prepare_html(html)

data/lib/bootstrap-navbar/helpers/bootstrap2.rb

@@ -0,0 +1,181 @@
+module BootstrapNavbar::Helpers::Bootstrap2
+  def navbar(options = {}, &block)
+    navbar_wrapper options do
+      navbar_inner_div do
+        container_div options[:brand], options[:brand_link], options[:responsive], options[:fluid], &block
+      end
+    end
+  end
+
+  def menu_group(options = {}, &block)
+    css_classes = %w(nav).tap do |css_classes|
+      css_classes << "pull-#{options.delete(:pull)}" if options.has_key?(:pull)
+      css_classes << options.delete(:class) if options.has_key?(:class)
+    end
+    attributes = attribute_hash_to_string({ class: css_classes.join(' ') }.merge(options))
+    prepare_html <<-HTML.chomp!
+<ul#{with_preceding_space attributes}>
+  #{capture(&block) if block_given?}
+</ul>
+HTML
+  end
+
+  def menu_item(name = nil, path = nil, list_item_options = nil, link_options = nil, &block)
+    name, path, list_item_options, link_options = capture(&block), name, path, list_item_options if block_given?
+    path              ||= '#'
+    list_item_options ||= {}
+    link_options      ||= {}
+
+    list_item_css_classes = [].tap do |css_classes|
+      css_classes << 'active' if current_url?(path)
+      css_classes << list_item_options.delete(:class) if list_item_options.has_key?(:class)
+    end
+    list_item_attributes = attribute_hash_to_string(
+      { class: list_item_css_classes.join(' ') }
+        .delete_if { |k, v| v.empty? }
+        .merge(list_item_options)
+    )
+    link_attributes = attribute_hash_to_string(link_options)
+    prepare_html <<-HTML.chomp!
+<li#{with_preceding_space list_item_attributes}>
+  <a href="#{path}"#{with_preceding_space link_attributes}>
+    #{name}
+  </a>
+</li>
+HTML
+  end
+
+  def drop_down(name, &block)
+    prepare_html <<-HTML.chomp!
+<li class="dropdown">
+  <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+    #{name} <b class="caret"></b>
+  </a>
+  #{drop_down_menu(&block)}
+</li>
+HTML
+  end
+
+  def sub_drop_down(name, list_item_options = {}, link_options = {}, &block)
+    list_item_css_classes = %w(dropdown-submenu).tap do |css_classes|
+      css_classes << list_item_options.delete(:class) if list_item_options.has_key?(:class)
+    end
+    list_item_attributes = attribute_hash_to_string({ class: list_item_css_classes.join(' ') }.merge(list_item_options))
+    link_attributes = attribute_hash_to_string(link_options)
+    prepare_html <<-HTML.chomp!
+<li#{with_preceding_space list_item_attributes}>
+  <a href="#"#{with_preceding_space link_attributes}>
+    #{name}
+  </a>
+  #{drop_down_menu(&block)}
+</li>
+HTML
+  end
+
+  def drop_down_divider
+    prepare_html %(<li class="divider"></li>)
+  end
+
+  def drop_down_header(text)
+    prepare_html %(<li class="nav-header">#{text}</li>)
+  end
+
+  def menu_divider
+    prepare_html %(<li class="divider-vertical"></li>)
+  end
+
+  def menu_text(text = nil, pull = nil, &block)
+    css_classes = %w(navbar-text).tap do |css_classes|
+      css_classes << "pull-#{pull}" if pull
+    end
+    prepare_html <<-HTML.chomp!
+<p class="#{css_classes.join(' ')}">
+  #{block_given? ? capture(&block) : text}
+</p>
+HTML
+  end
+
+  def brand_link(name, url = nil)
+    prepare_html %(<a href="#{url || '/'}" class="brand">#{name}</a>)
+  end
+
+  private
+
+  def navbar_wrapper(options, &block)
+    position = case
+    when options.has_key?(:static)
+      "static-#{options[:static]}"
+    when options.has_key?(:fixed)
+      "fixed-#{options[:fixed]}"
+    end
+
+    css_classes = %w(navbar).tap do |css_classes|
+      css_classes << "navbar-#{position}" if position
+      css_classes << 'navbar-inverse' if options[:inverse]
+    end
+    attribute_hash = { class: css_classes.join(' ') }
+    attributes = attribute_hash_to_string(attribute_hash)
+
+    prepare_html <<-HTML.chomp!
+<div#{with_preceding_space attributes}>
+  #{capture(&block) if block_given?}
+</div>
+HTML
+  end
+
+  def navbar_inner_div(&block)
+    prepare_html <<-HTML.chomp!
+<div class="navbar-inner">
+  #{capture(&block) if block_given?}
+</div>
+HTML
+  end
+
+  def container_div(brand, brand_link, responsive, fluid, &block)
+    css_class = fluid ? 'container-fluid' : 'container'
+    content = [].tap do |content|
+      content << responsive_button if responsive
+      content << brand_link(brand, brand_link) if brand || brand_link
+      content << if responsive
+        responsive_wrapper(&block)
+      else
+        capture(&block) if block_given?
+      end
+    end
+    prepare_html <<-HTML.chomp!
+<div class="#{css_class}">
+  #{content.join("\n")}
+</div>
+HTML
+  end
+
+  def responsive_wrapper(&block)
+    css_classes = %w(nav-collapse).tap do |css_classes|
+      css_classes << 'collapse' if BootstrapNavbar.configuration.bootstrap_version >= '2.2.0'
+    end
+    attributes = attribute_hash_to_string({ class: css_classes.join(' ') })
+    prepare_html <<-HTML.chomp!
+<div#{with_preceding_space attributes}>
+  #{capture(&block) if block_given?}
+</div>
+HTML
+  end
+
+  def responsive_button
+    prepare_html <<-HTML.chomp!
+<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+  <span class='icon-bar'></span>
+  <span class='icon-bar'></span>
+  <span class='icon-bar'></span>
+</a>
+HTML
+  end
+
+  def drop_down_menu(&block)
+    prepare_html <<-HTML.chomp!
+<ul class="dropdown-menu">
+  #{capture(&block) if block_given?}
+</ul>
+HTML
+  end
+end