twitter-bootstrap-for-rails 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62db7fe57ee026bf081a2544227be6cfe4c80a2a
+  data.tar.gz: 1f00188dabe3b5285eaec9e204d5c30405d8f7a5
+SHA512:
+  metadata.gz: 85eb725cc2f34b3b06ec7922a00b09d53674e0f5c4bed8904dee6ea0dda625a22c353d8003975855fe0ec96400e68b4b66c1bae3b62c73ace8aad69afde2e1ff
+  data.tar.gz: 1bfc4f7fe8c913eba7af979c50e9307ae7dcabf8ee12b93b8eb13edc4d50128e7befb0e4868e3b4e80d3fb8963986afad1a60b822b7e7e5e7d5f41b0750753ae

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitter-bootstrap-for-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,694 @@
+# Twitter Bootstrap For Rails
+
+This gem allow you to use <a href="http://getbootstrap.com/">Twitter Bootstrap 3</a> in ruby on rails application.
+
+Current using version of Twitter Bootstrap is 3.0.2
+
+Feedback: khrapach_ivan@mail.ru
+
+## Installing the gem
+
+Inset to the `gemfile` of your RoR application:
+
+```ruby
+gem 'twitter-bootstrap-for-rails', git: 'https://github.com/Xp-Apache/twitter-bootstrap-for-rails'
+```
+
+Run `bundle install`:
+
+Include stylesheets and javascript of Twitter Bootstrap in you `application.css` and `application.js`.
+
+`assets/stylesheets/application.css`:
+
+```css
+/*
+*= require bootstrap
+*/
+```
+
+`assets/javascripts/application.js`:
+
+```js
+//
+//= require bootstrap
+//
+```
+
+If you want use minified script and stylesheets, replase `require bootstrap` on `require bootstrap.min`
+in `application.css` and `application.js` files.
+
+## Glyphicons
+
+<a href="http://glyphicons.com/">Glyphicons</a> Halflings are normally not available for free, but their creator has made them available
+for Bootstrap free of cost. As a thank you, we only ask that you to include a link back to
+<a href="http://glyphicons.com/">Glyphicons</a>
+whenever possible.
+
+### Using
+```erb
+<%= glyph :search %>
+```
+
+## Form group
+
+### Basic usage
+
+```erb
+<%= form_for @o do |f| %>
+  <%= form_group class: 'has-error' do %>
+    <%= f.label :some_field %>
+    <%= f.text_field :some_field %>
+  <% end %>
+<% end %>
+```
+
+### Usage as form builder helper
+
+```erb
+<%= form_for @o do |f| %>
+  <%= f.form_group class: :some_field do |fg| %>
+    <%= fg.label %>
+    <%= fg.text_field %>
+  <% end %>
+<% end %>
+```
+
+### Submit button
+```erb
+<%= form_for @o do |f| %>
+    <%= f.form_group do |fg| %>
+      <%= fg.submit %>
+    <% end %>
+<% end %>
+```
+
+### Check boxes
+
+```erb
+<%= form_for @o do |f| %>
+  <%= f.form_group :boolean_field do |fg| %>
+    <%= fg.check_box %>
+  <% end %>
+<% end %>
+```
+
+```erb
+<%= form_for @o do |f| %>
+  <%= f.form_group :boolean_field do |fg| %>
+    <%= fg.check_box 'Custom text for label' %>
+  <% end %>
+<% end %>
+```
+
+### Disable render validation error
+
+Rendering of validation error for field disabled for `.form-inline` and `.form-horizontal`.
+
+Use `validation_error` method of `form_group` for rendering validation error in needed place.
+
+```erb
+<%= form_for @o, html: { class: 'form-horizontal' } do |f| %>
+  <%= form_group :field do |fg| %>
+    <%= fg.label class: 'col-md-2' %>
+    <div class="col-md-10">
+      <%= fg.text_field %>
+      <%= fg.validation_error %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+If you want disable rendering validation error for vertical form, use `render_validation_error`
+option with value `false` in `form_for` method:
+
+```erb
+<%= form_form @o, render_validation_error: false do |f| %>
+  ...
+<% end %>
+```
+
+If you want disable rendering validation error for specific form group, use `render_validation_error`
+option with value `false` in `form_group` method:
+
+```erb
+<%= form_for @o do |f| %>
+  <%= form_group :field, render_validation_error: false %>
+    ...
+  <% end %>
+<% end %>
+```
+
+### Static control
+
+```erb
+<%= form_for @o, html: { class: 'form-horizontal' } do |f| %>
+  <%= form_group :field do |fg| %>
+    <%= fg.label class="col-md-2" %>
+
+    <div class="col-md-10">
+      <%= fg.static %>
+      <%= fg.validation_error %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+## Placeholders and Titles for form controllers
+
+Gem using I18n API for set placeholders and titles in form controls.
+
+```yml
+en:
+  activerecord:
+    placeholders:
+      model_name:
+        field_name: 'Placeholder text'
+```
+
+You make use globall placeholder keys. Just use option `placeholder` with specific key:
+`f.text_field :x, placeholder: :some_symbol` and add in you l10n file:
+
+```yml
+en:
+  activerecord:
+    placeholders:
+      some_symbol: 'Some text'
+```
+
+You may use the `placeholder` option with string. Use empty string for disabling placeholder.
+
+```erb
+<%= f.text_field :x, placeholder: '' %>
+```
+
+## Required fields (and labels for him)
+
+`app/models/example_model.rb`:
+
+```ruby
+class ExampleModel < ActiveRecord::Base
+    validates example_field, presence: true
+end
+```
+
+`app/controllers/example_controller.rb`:
+
+```ruby
+class ExampleController < ApplicationController
+  def new
+    @o = ExampleModel.new
+  end
+end
+```
+
+`app/views/example/new.html.erb`:
+
+```erb
+<%= form_for @o do |f| %>
+  <%= f.label :example_field %>
+  <%= f.text_field :example_field %>
+  <%= f.text_field :example_field required = false %>
+<% end %>
+```
+
+`http://localhost:3000/examples/new`:
+
+```html
+<form accept-charset="UTF-8" action="/example" id="new_example_model" method="post" role="form">
+  <label class="required-label" for="example_model_example_field">Example field</label>
+  <input id="example_model_example_field" name="example_model[example_field]" required="required" type="text" />
+  <input id="example_model_example_field" name="example_model[example_field]" type="text" />
+</form>
+```
+
+## Quick creating tables for collection of models
+
+```erb
+<%= resource_table Model, @collection, [field1, field2, [field3, field_for_field3]] %>
+```
+
+Helper `resource_table` creating table for collection of models.
+
+The first parameter is the model class
+
+The second parameter is the collection of models.
+
+The third parameter is the collection of model fields or methods.
+Nesting arrays using for sequience invoking of methods. For example, `[[:field, :subdield, :method]]`
+invoke `item.field.subfield.method`.
+
+Table including buttons for actions with model. For control of rendering this buttons, use boolean options:
+* `can_remove`;
+* `can_show`;
+* `can_create`;
+* `can_edit`.
+
+<%= resource_table Model, @collection, [field1, field2, [field3, field_for_field3]], can_remove: false %>
+
+### Remove confirmation
+
+User I18n API for set default confirmation text:
+
+```yml
+en:
+  bootstrap:
+    resource_table:
+      remove_confirmation: 'Your remove confirmation text`
+```
+
+Use custom string with option `remove_confirmation`:
+
+```erb
+<%= resource_table Model, @collection, [fields], remove_confirmation: 'Your remove confrimation' %>
+```
+
+Use string for eval:
+
+```erb
+<%= resource_table Model, @collection, [fields], remove_confirmation: '"Remove #{item.name}?"' %>
+```
+
+User Proc:
+
+```erb
+<%= resource_table Model, @collection, [fields], remove_confirmation: Proc.new {|item| "Remove #{item.name}?"} %>
+```
+
+## Button dropdowns
+
+```erb
+<%= dropdown 'Actions' do |dd| %>
+  <%= dd.item 'Home', root_path # Menu item with link %>
+  <%= dd.item 'Disabled', class: 'disabled' # disabled menu item, without link %>
+  <%= dd.divider # Menu divider %>
+  <%= dd.header 'Text' # Menu header %>
+<% end %>
+```
+
+### Customizing
+#### Dropup
+
+```erb
+<%= dropdown 'Actions', drop_direction: :up do |dd| %>
+  ...
+<% end %>
+```
+
+#### Split button dropdown
+
+```erb
+<%= dropdown 'Actions', button: {split: true} do |dd| %>
+  ...
+<% end %>
+```
+
+#### Customize buttons
+
+```erb
+<%= dropdown 'Actions', button: {class: 'btn-primary', split: {class: 'btn-default'}} do |dd| %>
+  ...
+<% end %>
+```
+
+## Bootstrap confirmation dialog
+`app/assets/javascripts/application.js`:
+
+```js
+//
+//= require bootstrap.min
+//= require bs-confirmation-dialog
+//
+```
+
+### I18n
+
+```yml
+en:
+  bootstrap:
+    confirm_dialog_title: 'Confirm action'
+    confirm_button: 'Yes'
+    dismiss_button: 'No'
+```
+
+## Navbar
+### Default navbar
+
+```erb
+<%= navbar brand: 'Brand' do |nav| %>
+  <%= nav.group do |ng| %>
+    <%= ng.item 'Link', root_path %>
+    <%= ng.item 'Link', '#' %>
+
+    <%= ng.dropdown 'Dropdown' do |dd| %>
+      <%= dd.item 'Action', '#' %>
+      <%= dd.item 'Another action', '#' %>
+      <%= dd.item 'Something else here', '#' %>
+      <%= dd.divider %>
+      <%= dd.item 'Separated link', '#' %>
+      <%= dd.divider %>
+      <%= dd.item 'One more separated link', '#' %>
+    <% end %>
+  <% end %>
+
+  <form class="navbar-form navbar-left" role="search">
+    <div class="form-group">
+      <input type="text" class="form-control" placeholder="Search">
+    </div>
+    <button type="submit" class="btn btn-default">Submit</button>
+  </form>
+
+  <%= nav.group pull: :right do |ng| %>
+    <%= ng.item 'Link', '#' %>
+
+    <%= ng.dropdown 'Dropdown' do |dd| %>
+      <%= dd.item 'Action', '#' %>
+      <%= dd.item 'Another action', '#' %>
+      <%= dd.item 'Something else here', '#' %>
+      <%= dd.divider %>
+      <%= dd.item 'Separated link', '#' %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+### Buttons
+
+```erb
+<%= navbar do |nav| %>
+  <%= nav.button 'Sign in' %>
+<% end %>
+```
+
+### Text
+
+```erb
+<%= navbar do |nav| %>
+  <%= nav.text 'Signed in as Mark Otto' %>
+<% end %>
+```
+
+### Non-nav links
+
+```erb
+<%= navbar do |nav| %>
+  <%= nav.text "Signed in as #{nav.link 'Mark Otto', '#'}".html_safe, pull: :right %>
+<% end %>
+```
+
+### Fixed to top
+
+```erb
+<%= navbar fixed: :top do |nav| %>
+  ...
+<% end %>
+```
+
+### Fixed to bottom
+
+```erb
+<%= navbar fixed: :bottom do |nav| %>
+  ...
+<% end %>
+```
+
+### Static top
+
+```erb
+<%= navbar static: :top do |nav| %>
+  ...
+<% end %>
+```
+
+### Inverted navbar
+
+```erb
+<%= navbar inverse: true do |nav| %>
+  ...
+<% end %>
+```
+
+## Breadcrumbs
+
+`/app/controllers/application_controller.rb`:
+
+```ruby
+class ApplicationController < ActionController::Base
+	add_breadcrumb :root # root_path will be used as url
+end
+```
+
+`/app/controllers/examples_controller.rb`:
+
+```ruby
+class ExamplesController < ApplicationController
+	add_breadcrumb :index, :examples_path
+
+	def edit
+    @example = Example.find params[:id]
+    add_breadcrumb @example # @example.to_s as name, example_path(@example) as url
+    add_breadcrumb :edit, edit_example_path(@example)
+  end
+end
+```
+
+`/app/views/layouts/application.html.erb`:
+
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    ...
+  </head>
+  <body>
+    ...
+
+    <%= render_breadcrumbs %>
+
+    <%= yield %>
+  </body>
+</html>
+```
+
+`/config/locales/en.yml`:
+
+```yml
+en:
+  breadcrumbs:
+    root: 'Home'
+    edit: `Edit`
+
+    examples:
+      index: 'Examples'
+      edit: 'Edit example'
+```
+
+## Pagination
+
+### Default pagination
+
+```erb
+<%= paginator @current_page, @total_pages %>
+```
+
+### Disabled and active states
+
+Disabled and active states set automatically
+
+### Sizing
+
+```erb
+<%= paginator @current_page, @total_pages, size: :large
+```
+
+```erb
+<%= paginator @current_page, @total_pages, size: :small
+```
+
+### Page param name
+
+```erb
+<%= paginator @current_page, @total_pages, param: :p
+```
+
+## Alerts
+
+```erb
+<%= bs_alert :success, 'Message' %>
+```
+
+Render rules:
+
+- `:success` render as `.alert-success`;
+- `:info` render as `.alert-info`;
+- `:warning` render as `.alert-warning`;
+- `:danger` render as `.alert-danger`;
+- `:notice` render as `.alert-success`;
+- `:alert` render as `.alert-danger`;
+- another keys render as `alert-info`.
+
+### Flash block
+
+```erb
+<%= flash_block %>
+```
+
+Each flash message render as `bs_alert(flash_message_key, flash_message)`.
+
+## Modal dialog
+
+```erb
+<%= modal_dialog id: 'myModal',
+                 header: content_tag(:h4, 'Modal dialog header'),
+                 body: 'Modal body',
+                 footer: 'Dialog footer' %>
+```
+
+### Complex content
+
+```erb
+<% dialog_footer = capture do %>
+  <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+  <button type="button" class="btn btn-primary">Save changes</button>
+<% end %>
+
+<%= modal_dialog id: 'myModal',
+                 header: content_tag(:h4, 'Modal dialog header'),
+                 body: 'Modal body',
+                 footer: dialog_footer %>
+```
+
+### Dismiss button
+
+```erb
+<%= modal_dialog id: 'myModal',
+                 header: content_tag(:h4, 'Modal dialog header'),
+                 body: 'Modal body',
+                 footer: dismiss_button('Ok') %>
+```
+
+## Panels
+
+### Basic example
+
+```erb
+<%= panel do %>
+  Basic panel example
+<% end %>
+```
+
+### Panel with heading
+
+```erb
+<%= panel header: 'Panel heading without title' do %>
+  Panel content
+<% end %>
+```
+
+```erb
+<%= panel title: {level: 3, content: 'Panel title'} do %>
+  Panel content
+<% end %>
+```
+
+### Panel with footer
+
+```erb
+<%= panel footer: 'Panel footer' do %>
+  Panel content
+<% end %>
+```
+
+### Contextual alternatives
+
+```erb
+<%= panel header: 'Panel header', context: :primary do %>
+  Panel content
+<% end %>
+```
+
+```erb
+<%= panel header: 'Panel header', context: :info do %>
+  Panel content
+<% end %>
+```
+
+```erb
+<%= panel header: 'Panel header', context: :success do %>
+  Panel content
+<% end %>
+```
+
+```erb
+<%= panel header: 'Panel header', context: :warning do %>
+  Panel content
+<% end %>
+```
+
+```erb
+<%= panel header: 'Panel header', context: :danger do %>
+  Panel content
+<% end %>
+```
+
+## Global settings
+
+`config/initializers/bootstrap.rb`:
+
+```ruby
+Twitter::Bootstrap::For::Rails.setup do |config|
+  # Globally disable or enable rendering validation errors inside form groups
+  config.render_validation_error = true
+end
+```
+
+## Page header helper
+
+`app/views/layouts/application.html.erb`:
+
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= page_title @title %>
+    <!-- Another content for head section -->
+  </head>
+
+  <body>
+    <%= yield :title %>
+    <!-- Another content for body section -->
+  </body>
+</html>
+```
+
+Text fo title get from `page_titles.controller_name.action_name` of you i18n hash.
+
+### User another key for page title
+
+In action of some controller, for example:
+
+```ruby
+...
+  @title = :i_found_it
+...
+```
+
+Text tot title get from `page_titles.controller_name.i_found_it` in this case.
+
+### Custom title text
+
+In action of some controller, for example:
+
+```ruby
+...
+  @title = 'Some custom text'
+...
+```
+
+## Change log
+
+v1.3.3 - Available manually set required option for form controls
+v1.3.2 - Added required labels
+v1.3.1 - Added page_title helper
+v1.2.1 - Fix trouble with disabling create button in resource table
+v1.2.0 - Added check_box for form_group
+v1.1.0 - Added bootstrap panel helper