bootstrap-view-helpers 0.0.7 → 0.0.8

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## v 0.0.8
+
+* added `:with_environment_option` to `brand`
+
+## v 0.0.7
+
+* fixed bug that prevented accordions from working
+* examples page at `/bootstrap_view_helpers`

data/README.md

@@ -1,5 +1,10 @@
 # bootstrap-view-helpers
 
+[![Gem Version](https://badge.fury.io/rb/bootstrap-view-helpers.png)](http://badge.fury.io/rb/bootstrap-view-helpers)
+[![Build Status](https://travis-ci.org/stevedowney/bootstrap-view-helpers.png)](https://travis-ci.org/stevedowney/bootstrap-view-helpers)
+[![Code Climate](https://codeclimate.com/github/stevedowney/bootstrap-view-helpers.png)](https://codeclimate.com/github/stevedowney/bootstrap-view-helpers)
+[![Coverage Status](https://coveralls.io/repos/stevedowney/bootstrap-view-helpers/badge.png?branch=master)](https://coveralls.io/r/stevedowney/bootstrap-view-helpers?branch=master)
+
 This gem provides helper methods for various Bootstrap components.
 
 Includes support for:
@@ -70,8 +75,9 @@ Complete [API documentation](http://rubydoc.info/gems/bootstrap-view-helpers/fra
 ```
 <%= nav_bar do %>      
 
-  <%= brand('Span Brand')%>
-  <%= brand('Link Brand', url: '#')%>
+  <%= brand('Span Brand') %>
+  <%= brand('Link Brand', url: '#') %>
+  <%= brand('MyApp', with_environment: true) %>
 
   <%= nav_bar_links do %>
 

data/app/controllers/bootstrap_view_helpers_controller.rb

@@ -1,3 +1,9 @@
+# This controller displays working examples of the helpers.
+#
+# After installation, restart your rails server and point your browser to:
+#
+#   http://<app_name>/bootstrap_view_helpers
+#
 class BootstrapViewHelpersController < ApplicationController
   layout 'bootstrap_view_helpers'
   

data/app/helpers/bootstrap/accordion_helper.rb

@@ -16,10 +16,10 @@
 #
 module Bootstrap::AccordionHelper
   
-  # Returns the outer html for a Bootstrap accordion.
+  # Returns the html for a Bootstrap accordion.
   #
   # @param [Hash] options html attributes for accordion <div>
-  # @return [String] accordion html
+  # @return [String] <div class="accordion"> plus results of yielded block
   # @yield Should contain calls to {Bootstrap::AccordionHelper#accordion_group}
   # @yieldreturn [String] Html from {Bootstrap::AccordionHelper#accordion_group} calls
   def accordion(options={})

data/app/helpers/bootstrap/button_helper.rb

@@ -119,7 +119,11 @@ module Bootstrap::ButtonHelper
       yield
     end
   end
-    
+  
+  # Ensures each entry in _types_and_sizes_ is a valid button modifier.
+  #
+  # @raise InvalidButtonModifierError if one of the args isn't a valid button modifier.
+  # @private
   def validate_button_types_and_sizes(types_and_sizes)
     types_and_sizes.each { |e| raise(InvalidButtonModifierError, e.inspect) unless BUTTON_ALL.include?(e.to_s) }
   end

data/app/helpers/bootstrap/nav_helper.rb

@@ -46,10 +46,19 @@ module Bootstrap::NavHelper
   # @param [String] text text of the brand
   # @param [Hash] options except for +:url+, becomes html attributes of returned tag
   # @option options [String] :url if present, returned tag is an <a> (else <span>)
+  # @option options [Boolean] :with_environment if present, environment is appended to _text_ and
+  #   and a class of "rails-<Rails.env>" is added to the returned tag.
   # @return [String] <a> if +:url+ option present, else <span>
   def brand(text, options = {})
     options = canonicalize_options(options)
     options = ensure_class(options, 'brand')
+
+    with_environment = options.delete(:with_environment)
+    if with_environment && Rails.env != 'production'
+      text = "#{text} - #{Rails.env}"
+      options = ensure_class(options, "rails-#{Rails.env}") 
+    end
+
     url = options.delete(:url)
     
     if url.present?
@@ -117,8 +126,9 @@ module Bootstrap::NavHelper
   end
   
   # Returns header for nav_list
-  # @param [String] text text of header
-  # @return [String]
+  #
+  # @param text [String] text of header
+  # @return [String] <li.nav-header>text</li>
   def nav_list_header(text)
     content_tag(:li, text, class: 'nav-header')
   end

data/app/helpers/bootstrap_examples/application_helper.rb

@@ -1,5 +1,11 @@
 module BootstrapExamples::ApplicationHelper
 
+  def bvh_app_home_link
+    root_path
+  rescue NameError
+    '/'
+  end
+  
   def bvh_show_source(path)
     erb = IO.read(bvh_view_dir.join("#{path}.html.erb"))
     content_tag(:pre, erb)

data/app/views/application/_bootstrap_view_helper_nav_bar.html.erb

@@ -1,8 +1,9 @@
 <%= nav_bar do %>      
 
-  <%= brand('Bootstrap View Helpers', url: bvh_path)%>
+  <%= brand('Bootstrap View Helpers', url: bvh_path) %>
 
   <%= nav_bar_links do %>
+    <%= nav_bar_link('Application Home', bvh_app_home_link) %>
     <%= nav_bar_link('Active', '#', active: true) %>
     <%= nav_bar_link('Link1', '/link1') %>
     <%= nav_bar_divider %>

data/app/views/bootstrap_view_helpers/_icons.html.erb

@@ -1,5 +1,5 @@
 <p>
-  <%= icon(:heart)%>
+  <%= icon(:heart) %>
 </p>
 
 <p>

data/config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
-  
+
   match 'bootstrap_view_helpers(/:action)' => 'bootstrap_view_helpers', :as => :bvh
+  
 end

data/lib/bootstrap-view-helpers/version.rb

@@ -1,3 +1,3 @@
 module BootstrapViewHelpers
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-view-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +188,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -188,7 +204,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -235,7 +251,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails view helpers for Bootstrap
+description: Produce Bootstrap html with semantic helper methods.
 email:
 - steve.downtown@gmail.com
 executables: []
@@ -272,6 +288,7 @@ files:
 - lib/bootstrap-view-helpers/version.rb
 - lib/bootstrap-view-helpers.rb
 - lib/tasks/bootstrap-view-helpers_tasks.rake
+- CHANGELOG.md
 - MIT-LICENSE
 - Rakefile
 - README.md