twitter-bootstrap-rails 2.1.7 → 2.2.8

data/README.md

@@ -3,11 +3,17 @@ Bootstrap is a toolkit from Twitter designed to kickstart development of webapps
 
 twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails 3.1 Asset Pipeline (Rails 3.2 supported)
 
-[![Build Status](https://secure.travis-ci.org/seyhunak/twitter-bootstrap-rails.png)](http://travis-ci.org/seyhunak/twitter-bootstrap-rails)
-[![Dependency Status](https://gemnasium.com/seyhunak/twitter-bootstrap-rails.png)](https://gemnasium.com/seyhunak/twitter-bootstrap-rails)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails)
-[![Still Maintained](https://a248.e.akamai.net/camo.github.com/9c977523be7fce95c026a1b7d9673903f82e59cd/687474703a2f2f7374696c6c6d61696e7461696e65642e636f6d2f7374696c6c6d61696e7461696e65642f7374696c6c6d61696e7461696e65642e706e67)](http://stillmaintained.com/seyhunak/twitter-bootstrap-rails)
-
+[![Gem Version](https://badge.fury.io/rb/twitter-bootstrap-rails.png)][gem]
+[![Build Status](https://secure.travis-ci.org/seyhunak/twitter-bootstrap-rails.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/seyhunak/twitter-bootstrap-rails.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/twitter-bootstrap-rails
+[travis]: http://travis-ci.org/seyhunak/twitter-bootstrap-rails
+[gemnasium]: https://gemnasium.com/seyhunak/twitter-bootstrap-rails
+[codeclimate]: https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails
+[coveralls]: https://coveralls.io/r/seyhunak/twitter-bootstrap-rails
 
 ## Screencasts
 #### Installing twitter-bootstrap-rails, generators, usage and more
@@ -58,7 +64,7 @@ Then run `bundle install` from the command line:
 
     bundle install
 
-Then run the boostrap generator to add Bootstrap includes into your assets:
+Then run the bootstrap generator to add Bootstrap includes into your assets:
 
     rails generate bootstrap:install less
 
@@ -88,12 +94,18 @@ Usage:
     rails g bootstrap:layout [LAYOUT_NAME] [*fixed or fluid]
 
 
-Example:
+Example of a fixed layout:
 
 
     rails g bootstrap:layout application fixed
 
 
+Example of a responsive layout:
+
+
+    rails g bootstrap:layout application fluid
+
+
 Themed (generates Twitter Bootstrap compatible scaffold views.) - (Haml and Slim supported)
 
 
@@ -154,19 +166,76 @@ To use individual components from bootstrap, your bootstrap_and_overrides.less c
 If you'd like to alter Bootstrap's own variables, or define your LESS
 styles inheriting Bootstrap's mixins, you can do so inside bootstrap_and_overrides.css.less:
 
+
 ```css
 @linkColor: #ff0000;
 ```
 
+### SASS
+
+If you are using SASS to compile your application.css (e.g. your manifest file is application.css.sass or application.css.scss) you may get this:
+
+```
+Invalid CSS after "*": expected "{", was "= require twitt..."
+(in app/assets/stylesheets/application.css)
+(sass)
+```
+
+If this is the case, you **must** use @import instead of `*=` in your manifest file, or don't compile your manifest with SASS.
+
+### Icons
+
+By default, this gem overrides standard Bootstraps's Glyphicons with Font Awesome (http://fortawesome.github.com/Font-Awesome/).
+
+This should appear inside _bootstrap_and_overrides *(based on you twitter-bootstrap-rails version)*
+
+**From 2.2.7**
+
+```css
+// Font Awesome
+@fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
+@fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
+@fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
+@fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
+@fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
+@import "fontawesome/font-awesome";
+```
+
+**Before 2.2.7**
+
+```css
+// Font Awesome
+@fontAwesomeEotPath: "/assets/fontawesome-webfont.eot";
+@fontAwesomeEotPath_iefix: "/assets/fontawesome-webfont.eot?#iefix";
+@fontAwesomeWoffPath: "/assets/fontawesome-webfont.woff";
+@fontAwesomeTtfPath: "/assets/fontawesome-webfont.ttf";
+@fontAwesomeSvgPath: "/assets/fontawesome-webfont.svg#fontawesomeregular";
+@import "fontawesome";
+```
+
+If you would like to restore the default Glyphicons, inside the _bootstrap_and_overrides.css.less_ remove the FontAwesome declaration and uncomment the line:
+
+```less
+// Font Awesome
+// @fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
+// @fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
+// @fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
+// @fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
+// @fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
+// @import "fontawesome/font-awesome";
+
+// Glyphicons
+@import "twitter/bootstrap/sprites.less";
+```
 
 ## Using Javascripts
 
-You have to require Bootstrap JS (bootstrap.js) in your application.js
+Require Bootstrap JS (bootstrap.js) in your application.js
 
 ```js
 //= require twitter/bootstrap
 
-$(document).ready(function(){
+$(function(){
   /* Your javascripts goes here... */
 });
 ```
@@ -193,15 +262,348 @@ to /app/assets/javascripts/ folder.
 
 ```coffee
 jQuery ->
-  $("a[rel=popover]").popover()
-  $(".tooltip").tooltip()
-  $("a[rel=tooltip]").tooltip()
+  $("a[rel~=popover], .has-popover").popover()
+  $("a[rel~=tooltip], .has-tooltip").tooltip()
 ```
 
 ## Using Helpers
 
+### Modal Helper
+You can create modals easily using the following example. The header, body, and footer all accept content_tag or plain html.
+The href of the button to launch the modal must matche the id of the modal dialog.
+
+````
+<%= content_tag :a, "Modal", :href => "#modal", :class => 'btn', :data => {:toggle => 'modal'} %>
+
+<%= modal_dialog :id => "modal",
+         :header => { :show_close => true, :dismiss => 'modal', :title => 'Modal header' },
+                 :body   => 'This is the body',
+                 :footer => content_tag(:button, 'Save', :class => 'btn') %>
+````
+
+### Navbar Helper
+It should let you write things like:
+
+````
+<%= nav_bar :fixed => :top, :brand => "Fashionable Clicheizr 2.0", :responsive => true do %>
+    <%= menu_group do %>
+        <%= menu_item "Home", root_path %>
+        <%= menu_divider %>
+        <%= drop_down "Products" do %>
+            <%= menu_item "Things you can't afford", expensive_products_path %>
+            <%= menu_item "Things that won't suit you anyway", harem_pants_path %>
+            <%= menu_item "Things you're not even cool enough to buy anyway", hipster_products_path %>
+            <% if current_user.lives_in_hackney? %>
+                <%= menu_item "Bikes", fixed_wheel_bikes_path %>
+            <% end %>
+        <% end %>
+        <%= menu_item "About Us", about_us_path %>
+        <%= menu_item "Contact", contact_path %>
+    <% end %>
+    <%= menu_group :pull => :right do %>
+        <% if current_user %>
+            <%= menu_item "Log Out", log_out_path %>
+        <% else %>
+            <%= form_for @user, :url => session_path(:user), html => {:class=> "navbar-form pull-right"} do |f| -%>
+              <p><%= f.text_field :email %></p>
+              <p><%= f.password_field :password %></p>
+              <p><%= f.submit "Sign in" %></p>
+            <% end -%>
+        <% end %>
+    <% end %>
+<% end %>
+````
+
+### Navbar scaffolding
+
+In your view file (most likely application.html.erb) to get a basic navbar set up you need to do this:
+
+````
+<%= nav_bar  %>
+````
+
+Which will render:
+
+    <div class="navbar">
+      <div class="navbar-inner">
+        <div class="container">
+        </div>
+      </div>
+    </div>
+
+
+### Fixed navbar
+
+If you want the navbar to stick to the top of the screen, pass in the option like this:
+
+````
+<%= nav_bar :fixed => :top  %>
+````
+
+To render:
+
+    <div class="navbar navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+        </div>
+      </div>
+    </div>
+
+### Static navbar
+
+If you want a full-width navbar that scrolls away with the page, pass in the option like this:
+
+````
+<%= nav_bar :static => :top  %>
+````
+
+To render:
+
+    <div class="navbar navbar-static-top">
+      <div class="navbar-inner">
+        <div class="container">
+        </div>
+      </div>
+    </div>
+
+
+### Brand name
+
+Add the name of your site on the left hand edge of the navbar. By default, it will link to root_url. Passing a brand_link option will set the url to whatever you want.
+
+````
+<%= nav_bar :brand => "We're sooo web 2.0alizr", :brand_link => account_dashboard_path  %>
+````
+
+Which will render:
+
+    <div class="navbar">
+      <div class="navbar-inner">
+        <div class="container">
+            <a class="brand" href="/accounts/dashboard">
+              We're sooo web 2.0alizr
+            </a>
+        </div>
+      </div>
+    </div>
+
+
+### Optional responsive variation
+
+If you want the responsive version of the navbar to work (One that shrinks down on mobile devices etc.), you need to pass this option:
+
+````
+<%= nav_bar :responsive => true %>
+````
+Which renders the html quite differently:
+
+
+    <div class="navbar">
+      <div class="navbar-inner">
+        <div class="container">
+          <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+          <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>
+          <!-- Everything in here gets hidden at 940px or less -->
+          <div class="nav-collapse">
+            <!-- menu items gets rendered here instead -->
+          </div>
+        </div>
+      </div>
+    </div>
+
+
+### Nav links
+
+This is the 'meat' of the code where you define your menu items.
+
+You can group menu items in theoretical boxes which you can apply logic to - e.g. show different collections for logged in users/logged out users, or simply right align a group.
+
+The active menu item will be inferred from the link for now.
+
+The important methods here are menu_group and menu_item.
+
+menu_group only takes one argument - :pull - this moves the group left or right when passed :left or :right.
+
+menu_item generates a link wrapped in an li tag. It takes two arguments and an options hash. The first argument is the name (the text that will appear in the menu), and the path (which defaults to "#" if left blank). The rest of the options are passed straight through to the link_to helper, so that you can add classes, ids, methods or data tags etc.
+
+````
+<%= nav_bar :fixed => :top, :brand => "Ninety Ten" do %>
+    <% menu_group do %>
+        <%= menu_item "Home", root_path %>
+        <%= menu_item "About Us", about_us_path %>
+        <%= menu_item "Contact", contact_path %>
+    <% end %>
+    <% if current_user %>
+        <%= menu_item "Log Out", log_out_path %>
+    <% else %>
+        <% menu_group :pull => :right do %>
+            <%= menu_item "Sign Up", registration_path %>
+            <% form_for @user, :url => session_path(:user) do |f| -%>
+              <p><%= f.text_field :email %></p>
+              <p><%= f.password_field :password %></p>
+              <p><%= f.submit "Sign in" %></p>
+            <% end -%>
+        <% end %>
+    <% end %>
+<% end %>
+````
+
+### Dropdown menus
+
+For multi-level list options, where it makes logical sense to group menu items, or simply to save space if you have a lot of pages, you can group menu items into drop down lists like this:
+
+````
+<%= nav_bar do %>
+    <%= menu_item "Home", root_path %>
+
+    <%= drop_down "Products" do %>
+        <%= menu_item "Latest", latest_products_path %>
+        <%= menu_item "Top Sellers", popular_products_path %>
+        <%= drop_down_divider %>
+        <%= menu_item "Discount Items", discounted_products_path %>
+    <% end %>
+
+    <%= menu_item "About Us", about_us_path %>
+    <%= menu_item "Contact", contact_path %>
+<% end %>
+````
+
+### Dividers
+
+Dividers are just vertical bars that visually separate logically disparate groups of menu items
+
+````
+<%= nav_bar :fixed => :bottom do %>
+    <%= menu_item "Home", root_path %>
+    <%= menu_item "About Us", about_us_path %>
+    <%= menu_item "Contact", contact_path %>
+
+    <%= menu_divider %>
+
+    <%= menu_item "Edit Profile", edit_user_path(current_user) %>
+    <%= menu_item "Account Settings", edit_user_account_path(current_user, @account) %>
+    <%= menu_item "Log Out", log_out_path %>
+<% end %>
+````
+
+### Forms in navbar
+
+At the moment - this is just a how to...
+
+You need to add this class to the form itself (Different form builders do this in different ways - please check out the relevant docs)
+
+````css
+.navbar-form
+````
+To pull the form left or right, add either of these classes:
+````css
+.pull-left
+.pull-right
+````
+
+If you want the Bootstrap search box (I think it just rounds the corners), use:
+````css
+.navbar-search
+````
+Instead of:
+````css
+.navbar-form
+````
+
+To change the size of the form fields, use .span2 (or however many span widths you want) to the input itself.
+
+### Component alignment
+
+You can shift things to the left or the right across the nav bar. It's easiest to do this on grouped menu items:
+
+````
+<%= nav_bar :fixed => :bottom do %>
+    <% menu_group do %>
+        <%= menu_item "Home", root_path %>
+        <%= menu_item "About Us", about_us_path %>
+        <%= menu_item "Contact", contact_path %>
+    <% end %>
+    <% menu_group :pull => :right do %>
+        <%= menu_item "Edit Profile", edit_user_path(current_user) %>
+        <%= menu_item "Account Settings", edit_user_account_path(current_user, @account) %>
+        <%= menu_item "Log Out", log_out_path %>
+    <% end %>
+<% end %>
+````
+
+### Text in the navbar
+
+If you want to put regular plain text in the navbar anywhere, you do it like this:
+
+````
+<%= nav_bar :brand => "Apple" do %>
+    <%= menu_text "We make shiny things" %>
+    <%= menu_item "Home", root_path %>
+    <%= menu_item "About Us", about_us_path %>
+<% end %>
+````
+It also takes the :pull option to drag it to the left or right.
+
+
 ### Flash helper
-Add flash helper <%= bootstrap_flash %> to your layout (built-in with layout generator)
+
+Add flash helper `<%= bootstrap_flash %>` to your layout (built-in with layout generator)
+
+### Breadcrumbs Helpers
+
+*Notice* If your application is using [breadcrumbs-on-rails](https://github.com/weppos/breadcrumbs_on_rails) you will have a namespace collision with the add_breadcrumb method.
+You do not need to use these breadcrumb gems since this gem provides the same functionality out of the box without the additional dependency.
+
+Add breadcrumbs helper `<%= render_breadcrumbs %>` to your layout.
+
+```ruby
+class ApplicationController
+  add_breadcrumb :index, :root_path
+end
+```
+
+```ruby
+class ExamplesController < ApplicationController
+  add_breadcrumb :index, :examples_path
+
+  def index
+  end
+
+  def show
+    @example = Example.find params[:id]
+    add_breadcrumb @example.name, example_path(@example)
+    # add_breadcrumb :show, example_path(@example)
+  end
+end
+```
+
+### Element utility helpers
+
+Badge:
+```erb
+<%= badge(12, :warning) %> <span class="badge badge-warning">12</span>
+```
+
+Label:
+```erb
+<%= label('Gut!', :success) %> <span class="badge badge-success">Gut!</span>
+```
+
+Glyph:
+```erb
+<%= glyph(:pencil) %> <i class="icon-pencil"></i>
+```
+
+###i18n Internationalization Support
+The installer creates an english translation file for you and copies it to config/locales/en.bootstrap.yml
+
+
+NOTE: If you are using Devise in your project, you must have a devise locale file
+for handling flash messages, even if those messages are blank. See https://github.com/plataformatec/devise/wiki/I18n
 
 ## Changelog
 <ul>
@@ -245,11 +647,23 @@ Add flash helper <%= bootstrap_flash %> to your layout (built-in with layout gen
   <li>Released gem v.2.1.5 (minor fixes, install generator detects javascript template engine, updated to Twitter Bootstrap 2.2.1)</li>
   <li>Released gem v.2.1.6 (minor fixes)</li>
   <li>Added static stylesheets support</li>
+  <li>Released gem v.2.1.8 and updated to Twitter Bootstrap 2.2.2</li>
+  <li>Released gem v.2.1.9</li>
+  <li>Released gem v.2.2.0 (Font Awesome 3)</li>
+  <li>Released gem v.2.2.1 (minor fixes and updates)</li>
+  <li>Released gem v.2.2.2 (Bootstrap 2.3.0)</li>
+  <li>Released gem v.2.2.3 (Minor fixes)</li>
+  <li>Released gem v.2.2.4 (Minor fixes)</li>
+  <li>Released gem v.2.2.5 (Bootstrap 2.3.1)</li>
+  <li>Released gem v.2.2.6</li>
+  <li>Released gem v.2.2.7 (Fixes)</li>
+  <li>Releases gem v.2.2.8</li>
 </ul>
 
 
 ## Contributors & Patches & Forks
 <ul>
+  <li>Ben Lovell</li>
   <li>Daniel Morris</li>
   <li>Bradly Feeley</li>
   <li>Guilherme Moreira</li>
@@ -269,13 +683,6 @@ Add flash helper <%= bootstrap_flash %> to your layout (built-in with layout gen
   <li>Leonid Shevtsov</li>
 </ul>
 
-
-### Future
-<ul>
-  <li>Writing tests (not implemented yet)</li>
-  <li>Markup Helpers (alert, tabs, pagination, breadcrumbs etc.)</li>
-</ul>
-
 ## About Me
 Lead/ Senior Developer - Programmer @useful (Usefulideas) Istanbul / Turkey
 
@@ -307,7 +714,7 @@ http://klout.com/#/seyhunak
 ### Want to donate?
 <img src="https://www.paypalobjects.com/en_US/i/logo/PayPal_mark_50x34.gif"></img>
 
-[Want to donate for my efforts?. Show your love](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8ZLWQBREFP4U
+[Want to donate for my efforts? Show your love](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8ZLWQBREFP4U
  "Donate")
 
 

data/Rakefile

@@ -3,13 +3,17 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 desc "Bundle the gem"
-task :bundle do
-  sh('bundle install')
+task :bundle  => [:bundle_install, :build_static_stylesheets] do
   sh 'gem build *.gemspec'
   sh 'gem install *.gem'
   sh 'rm *.gem'
 end
 
+desc "Runs bundle install"
+task :bundle_install do
+  sh('bundle install')
+end
+
 desc "Build the static precompiled stylesheets from Less sources"
 task :build_static_stylesheets do
   require 'less'
@@ -18,7 +22,7 @@ task :build_static_stylesheets do
 
   parser = Less::Parser.new :paths => [toolkit_path]
 
-  target_directory = File.expand_path('vendor/assets/stylesheets/twitter-bootstrap-static')
+  target_directory = File.expand_path('app/assets/stylesheets/twitter-bootstrap-static')
 
   sh "rm -rf #{target_directory}"
   sh "mkdir -p #{target_directory}"
@@ -32,3 +36,11 @@ end
 
 task(:default).clear
 task :default => :bundle
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/lib/*_test.rb']
+  t.verbose = true
+end