booties 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26c9342f582bef04df2c91615687875cb6b1cc8e
-  data.tar.gz: ce82e3caf2e664fa0a2c3b0c70323948ad547e25
+SHA256:
+  metadata.gz: 5301ae79aa1fa1d914f905c50fb2e378ec891bef1376c4254b64a5cb67e7b541
+  data.tar.gz: dcd9a510e73b48ce9f2eff4278108542be15519f40be8be87f77f1d869cd89d9
 SHA512:
-  metadata.gz: 695beda958a1627ba5bab7cf35c8305fce7990895931c6fc13ada1cf050af21043be34ab7a2f055f7ec88cefc99f7b8c75d63bdf27df59441dd01306258b7891
-  data.tar.gz: b223bdd46a3ce55f2a40b5b80e85aa46401f4e440756e24565518a1bb21220da81feb198ed95904dfa84201d7fae48b7fdbff2a63e58a2d89ea828bb983aa5d1
+  metadata.gz: 1fdffebb63f6b3f80eb4fe7cc221af4373c3834f3e37d9e387f1a79703ebea4613eb0ae66555bcb65cdfaccf8b4dc152a78fb7b12129802842846386fb3bf078
+  data.tar.gz: 16e301945dde99932e76659185ca81093d6c16a48779aad1400f6476386b4e69f6d1a83436103ce1281a8743112aaf6a71eae5db3f0f4761d585dfcda564489c

data/README.md

@@ -0,0 +1,172 @@
+# [![Gem Version](https://badge.fury.io/rb/booties.svg)](http://badge.fury.io/rb/booties) [![Build Status](https://travis-ci.org/jparker/booties.svg?branch=master)](https://travis-ci.org/jparker/booties)
+
+# Booties
+
+Booties provides a variety of helpers for using
+[Twitter Bootstrap](http://getbootstrap.com/) within a Rails application.
+
+NB: This is the Rails 5 development branch. There will likely be no visible
+change in syntax or behavior, but some of the tests had to be rewritten.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'booties'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+You also need to make sure you include Bootstrap in your application. The way
+you accomplish this is left up to you, but one easy way to do this is to
+include the [bootstrap-sass](https://github.com/twbs/bootstrap-sass) gem.
+
+## Helpers
+
+Booties provides helpers for a variety of Bootstrap components. Below is an
+overview of the available helpers. Examples of how to use them can be found in
+<tt>test/dummy/app/views/samples</tt>.
+
+### Badges
+
+Booties::BadgeHelper#badge provides Bootstrap
+[Badges](http://getbootstrap.com/components/#badges).
+
+```erb
+<%= badge '42' %>
+```
+
+### Breadcrumbs
+
+Booties::ApplicationHelper#breadcrumbs facilitates adding
+[Breadcrumbs](http://getbootstrap.com/components/#breadcrumbs) to your pages.
+The breadcrumb content is saved as `:breadcrumbs` and can be rendered with
+`yield :breadcrumbs`.
+
+```erb
+<%= breadcrumbs do %>
+  <li><%= link_to 'Books', :books %></li>
+  <li><%= link_to truncate(@book.title), [:edit, @book] %></li>
+  <li class="active">Edit</li>
+<% end %>
+```
+
+### Buttons
+
+Booties::ButtonHelper#btn_link_to renders links configured to be displayed as
+Bootstrap [Buttons](http://getbootstrap.com/css/#buttons).
+
+```erb
+<%= btn_link_to 'New', [:new, :widget] %>
+<%= btn_link_to sign_out_path, class: 'btn-xs', context: :danger, method: :delete do %>
+  Sign out
+<% end %>
+```
+
+### Labels
+
+Booties::FlagHelper#flag provides Bootstrap
+[Labels](http://getbootstrap.com/components/#labels).
+
+```erb
+<%= flag 'PENDING' %>
+<%= flag 'OPEN', context: :primary %>
+<%= flag 'CLOSED', context: :danger %>
+```
+
+### Modals
+
+Booties::ModalHelper#modal and Booties::Modal provide Bootstrap
+[Modals](http://getbootstrap.com/javascript/#modals).
+
+```erb
+<%= modal 'foo' do |m| %>
+  <%= m.header do %>
+    Nesciunt qui iste vel a.
+  <% end %>
+  <%= m.body do %>
+    <p>
+      Autem atque perferendis veritatis. Molestiae aliquid nam reiciendis
+      recusandae facere. Aut non nemo dicta.
+    </p>
+  <% end %>
+  <%= m.footer do %>
+    <%= m.dismiss class: 'btn btn-default' do %>
+      Dismiss
+    <% end %>
+    <%= link_to @widget, class: 'btn btn-danger', method: :delete do %>
+      Really Delete
+    <% end %>
+  <% end %>
+<% end %>
+```
+### Panel
+
+Booties::PanelHelper#panel and Booties::Modal provide Bootstrap
+[Panels](http://getbootstrap.com/components/#panels).
+
+```erb
+<%= panel do |p| %>
+  <%= p.heading do %>
+    <%= p.title 'Consequatur quibusdam quia vel et sed in.' %>
+  <% end %>
+  <%= p.body do %>
+    <p>
+      Est fuga iste reiciendis laudantium dicta. Perspiciatis vero ut autem
+      quod vel modi. Ea error omnis aliquam aut est.
+    </p>
+  <% end %>
+  <%= p.footer do %>
+    Voluptatibus rerum et est quo dicta perspiciatis.
+  <% end %>
+<% end %>
+```
+
+### Tooltips
+
+Booties::TooltipHelper#tooltip provides Bootstrap
+[Tooltips](http://getbootstrap.com/javascript/#tooltips).
+
+```erb
+<%= tooltip title: 'This is a tooltip', placement: :bottom do %>
+  This has a tooltip.
+<% end %>
+```
+
+Tooltip behavior is opt-in. The helper will render the necessary tag, but you
+must activate them yourself. One way of doing this is to run the following
+Javascript snippet:
+
+```javascript
+$(function() {
+  $('[data-toggle="tooltip"]').tooltip();
+}
+```
+
+### Popovers
+
+Booties::PopoverHelper#popover provides Bootstrap
+[Popovers](http://getbootstrap.com/javascript/#popovers).
+
+```erb
+<%= popover content: 'Lorem ipsum dolor sit amet.', class: 'btn btn-default' do %>
+  Button text
+<% end %>
+```
+
+Popover behavior is opt-in. The helper will render the necessary tag, but you
+must activate them yourself. One way of doing this is to run the following
+Javascript snippet:
+
+```javascript
+$(function() {
+  $('[data-toggle="popover"]').popover();
+}
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -10,13 +12,13 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Booties'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# load 'rails/tasks/statistics.rake'
+load 'rails/tasks/statistics.rake'
 
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
@@ -27,5 +29,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/controllers/booties/application_controller.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ActionController::Base # :nodoc:
+    protect_from_forgery with: :exception
   end
 end

data/app/helpers/booties/application_helper.rb

@@ -1,29 +1,6 @@
-module Booties
-  module ApplicationHelper
-    include Utils
-
-    ##
-    # Renders an ol tag with the "breadcrumb" class and fills it with the
-    # content of the block.
-    #
-    # Example:
-    #
-    #   <% breadcrumbs do %>
-    #     <li>Foo</li>
-    #     <li class="active">Bar</li>
-    #   <% end %>
-    #   <%= yield :breadcrumb %>
-    #
-    #   <ol class="breadcrumb">
-    #     <li>Foo</li>
-    #     <li class="active">Bar</li>
-    #   </ol>
-    def breadcrumbs(&block)
-      content_for :breadcrumbs, render_breadcrumbs(&block)
-    end
+# frozen_string_literal: true
 
-    def render_breadcrumbs(&block) # :nodoc:
-      content_tag :ol, class: 'breadcrumb', &block
-    end
+module Booties
+  module ApplicationHelper # :nodoc:
   end
 end

data/app/helpers/booties/badge_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module BadgeHelper
+  module BadgeHelper # :nodoc:
     include Utils
 
     ##
@@ -23,9 +25,10 @@ module Booties
     #   <%= badge 'foo', class: 'bar' %>
     #   <span class="badge bar">foo</span>
     def badge(content = nil, class: nil, **options, &block)
-      content ||= capture(&block) if block_given?
       classes = merge_classes ['badge'], binding.local_variable_get(:class)
-      content_tag :span, content, class: classes, **options
+      options = { class: classes, **options }
+
+      content_tag :span, content, options, &block
     end
   end
 end

data/app/helpers/booties/breadcrumb_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Booties
+  module BreadcrumbHelper # :nodoc:
+    ##
+    # Renders an ol tag with the "breadcrumb" class and fills it with the
+    # content of the block.
+    #
+    # Example:
+    #
+    #   <% breadcrumbs do %>
+    #     <li>Foo</li>
+    #     <li class="active">Bar</li>
+    #   <% end %>
+    #   <%= yield :breadcrumb %>
+    #
+    #   <ol class="breadcrumb">
+    #     <li>Foo</li>
+    #     <li class="active">Bar</li>
+    #   </ol>
+    def breadcrumbs(&block)
+      content_for :breadcrumbs, render_breadcrumbs(&block)
+    end
+
+    def render_breadcrumbs(&block) # :nodoc:
+      content_tag :ol, class: 'breadcrumb', &block
+    end
+  end
+end

data/app/helpers/booties/button_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module ButtonHelper
+  module ButtonHelper # :nodoc:
     include Utils
 
     ##
@@ -21,13 +23,13 @@ module Booties
     #   <%= btn_link_to 'Sign out', destroy_user_session_path, context: :danger, class: 'btn-xs', method: :delete %>
     #
     #   <a href="/users/sign_out" class="btn btn-danger btn-xs" data-method="delete">Sign out</a>
-    def btn_link_to(name = nil, options = nil, html_options = nil, &block)
-      name, options, html_options = capture(&block), name, options if block_given?
-      html_options ||= {}
-      context = html_options.delete(:context) { :default }
-      html_options[:class] = \
-        merge_classes %W[btn btn-#{context}], html_options[:class]
-      link_to name, options, html_options
+    def btn_link_to(name_or_path, path = nil, context: :default, **opts, &block)
+      opts[:class] = merge_classes %W[btn btn-#{context}], opts[:class]
+      if block_given?
+        link_to name_or_path, opts, &block
+      else
+        link_to name_or_path, path, opts
+      end
     end
   end
 end

data/app/helpers/booties/dropdown_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Booties
+  module DropdownHelper # :nodoc:
+    include Utils
+
+    ##
+    # Renders a link to toggle a dropdown menu.
+    #
+    # Examples:
+    #
+    #   <%= link_to_dropdown do %>
+    #     Foo
+    #   <% end %>
+    #
+    #   <%= link_to_dropdown class: 'foo' do %>
+    #     Foo
+    #   <% end %>
+    def link_to_dropdown(class: nil, &block)
+      classes = merge_classes binding.local_variable_get(:class),
+                              'dropdown-toggle'
+      text = capture(&block) + caret
+      link_to text, '#',
+              class: classes,
+              data: { toggle: 'dropdown' },
+              role: 'button'
+    end
+
+    ##
+    # Renders a button to toggle a dropdown menu.
+    #
+    # Examples:
+    #
+    #   <%= button_to_dropdown do %>
+    #     Foo
+    #   <% end %>
+    #
+    #   <%= button_to_dropdown context: :primary, class: 'btn-xs' do %>
+    #     Foo
+    #   <% end %>
+    def button_to_dropdown(context: :default, class: nil, &block)
+      classes = merge_classes binding.local_variable_get(:class),
+                              %W[btn btn-#{context} dropdown-toggle]
+      text = capture(&block) + caret
+      button_tag text,
+                 name: nil,
+                 class: classes,
+                 data: { toggle: 'dropdown' },
+                 type: 'button'
+    end
+
+    ##
+    # Wraps a block in a dropdown menu list.
+    #
+    # Examples:
+    #
+    #   <%= dropdown_menu do %>
+    #     <li><%= link_to 'Foo', foos_path %></li>
+    #     <li><%= link_to 'Bar', bars_path %></li>
+    #   <% end %>
+    def dropdown_menu(&block)
+      content_tag :ul, class: 'dropdown-menu', &block
+    end
+
+    ##
+    # Renders caret for dropdown menu.
+    def caret
+      content_tag :span, '', class: 'caret'
+    end
+  end
+end

data/app/helpers/booties/flag_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module FlagHelper
+  module FlagHelper # :nodoc:
     include Utils
 
     ##
@@ -27,10 +29,11 @@ module Booties
     #   <%= flag 'foo', class: 'bar' %>
     #   <span class="label label-default bar">foo</span>
     def flag(content = nil, context: :default, class: nil, **options, &block)
-      content ||= capture(&block)
       classes = merge_classes %W[label label-#{context}],
-        binding.local_variable_get(:class)
-      content_tag :span, content, class: classes, **options
+                              binding.local_variable_get(:class)
+      options = { class: classes, **options }
+
+      content_tag :span, content, options, &block
     end
   end
 end

data/app/helpers/booties/modal_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module ModalHelper
+  module ModalHelper # :nodoc:
     ##
     # Renders a modal dialog. The CSS id is provided by +id+. The fade effect
     # will be enabled by default, but it will be disabled if +fade+ is falsey.
@@ -29,6 +31,7 @@ module Booties
     #       <% end %>
     #     <% end %>
     #   <% end %>
+
     def modal(id, fade: true, size: nil, with: Modal, **options, &block)
       with.new(self, id: id, fade: fade, size: size).render(**options, &block)
     end