booties 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fcf7ffcb28fe2eda72a78078eacab0f5d4e46bc
-  data.tar.gz: 01b4199a6284230d495d67d12813c28ef228300e
+  metadata.gz: a66be60fe90b8f933b1069cd95547a3cf65c2aee
+  data.tar.gz: d7aa68425b199de2861dd327db7b4df785181f37
 SHA512:
-  metadata.gz: 7d47f0151b0b117e0ef04c46b7d9456ef0f841210aba716979655e41085fc5a8886acb2259d5bae5e09e7a15c272edf2b032d278d53a174fac5512e3211431fe
-  data.tar.gz: 2565c2da18b7282c646a07ed2fec8fdbaea91aa8d9bae5993cb5738c787d23a395e65ab7a2c25d433b3d0c9a57a71a199dd29d755f6ebd75741d087cd5347d7b
+  metadata.gz: bfc5aaa93a099d58ae25b1cdfe6a595615df279e36cb7d1b1abdace7099aeb56c12d96222d1b1fd92d6b95603f7f343eb51d9dbabd824d4b8628f1c0257aef94
+  data.tar.gz: 17d92569754f99df5a0e8276a20905ff3d7069bba910a39d889bc35d1d6a882330851eee2209bd419d421e758d5e51d8534e85cb5999c4dc585f959933916ca4

data/Rakefile

@@ -14,11 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-load 'rails/tasks/statistics.rake'
-
-
+# load 'rails/tasks/statistics.rake'
 
 Bundler::GemHelper.install_tasks
 

data/app/helpers/booties/application_helper.rb

@@ -1,5 +1,7 @@
 module Booties
   module ApplicationHelper
+    include Utils
+
     ##
     # Renders an ol tag with the "breadcrumb" class and fills it with the
     # content of the block. The following:
@@ -23,155 +25,5 @@ module Booties
     def render_breadcrumbs(&block) # :nodoc:
       content_tag :ol, class: 'breadcrumb', &block
     end
-
-    ##
-    # Renders a span tag with the "label" class and a contextual label class
-    # derived from +context+. Defaults to "label-default". The content of the
-    # tag is passed in as +content+. The following:
-    #
-    #   <%= flag 'foo' %>
-    #
-    # will produce:
-    #
-    #   <span class="label label-default">foo</span>
-    #
-    # Alternatively, you can pass the content in as a block. The following:
-    #
-    #   <%= flag do %>
-    #     foo
-    #   <% end %>
-    #
-    # will produce:
-    #
-    #   <span class="label label-default">foo</span>
-    #
-    # You can provide a different context for the label as +context+. The
-    # following:
-    #
-    #   <%= flag 'foo', context: :primary %>
-    #
-    # will produce:
-    #
-    #   <span class="label label-primary">foo</span>
-    #
-    # Additional options passed in through +options+ will be passed to
-    # #content_tag to be added as attributes to the span tag. The following:
-    #
-    #   <%= flag 'foo', id: 'bar' %>
-    #
-    # will produce:
-    #
-    #   <span class="label label-default" id="bar">foo</span>
-    #
-    # If the +:class+ option is passed in the contents will be merged with the
-    # classes required by Bootstrap labels. The following:
-    #
-    #   <%= flag 'foo', class: 'bar' %>
-    #
-    # will produce:
-    #
-    #   <span class="label label-default bar">foo</span>
-    def flag(content = nil, context: :default, **options, &block)
-      content ||= capture &block
-      classes = Booties.merge_classes %W[label label-#{context}],
-        options.delete(:class)
-      content_tag :span, content, class: classes, **options
-    end
-
-    ##
-    # Renders a span tag with the "badge" class. The content of the tag is
-    # passed in as +content+. The following:
-    #
-    #   <%= badge 'foo' %>
-    #
-    # will produce:
-    #
-    #   <span class="badge">foo</span>
-    #
-    # Alternatively, you can pass the content in as a block. The following:
-    #
-    #   <%= badge do %> foo <% end %>
-    #
-    # will produce:
-    #
-    #   <span class="badge">foo</span>
-    #
-    # Any options passed in through +options+ will be passed to #content_tag to
-    # be added as attributes to the span tag. The following:
-    #
-    #   <%= badge 'foo', id: 'bar' %>
-    #
-    # will produce:
-    #
-    #   <span class="badge" id="bar">foo</span>
-    #
-    # If the +:class+ option is passed in, the contents will be merged with the
-    # classes required by Bootstrap badges. The following:
-    #
-    #   <%= badge 'foo', class: 'bar' %>
-    #
-    # will produce:
-    #
-    #   <span class="badge bar">foo</span>
-    def badge(content = nil, **options, &block)
-      content ||= capture &block
-      classes = Booties.merge_classes ['badge'], options.delete(:class)
-      content_tag :span, content, class: classes, **options
-    end
-
-    ##
-    # 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.
-    #
-    # The contents of the dialog are passed in as a block. An instance of
-    # Booties::Modal will be yielded as a parameter to the block (similar to
-    # the way a FormBuilder works in Rails).
-    #
-    #   <%= 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 %>
-    def modal(id, fade: true, with: Modal, &block)
-      with.new(self, id: id, fade: fade).render &block
-    end
-
-    ##
-    # Renders a panel. The defult panel context is +:default+ but can be
-    # specified through +options+. The contents of the panel should be passed
-    # in as a block. An instance of the Booties::Panel will be yielded as a
-    # parameter to the block (similar to the way a FormBuilder works in Rails).
-    #
-    #   <%= 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 %>
-    def panel(with: Panel, **options, &block)
-      with.new(self, **options).render &block
-    end
   end
 end

data/app/helpers/booties/badge_helper.rb

@@ -0,0 +1,46 @@
+module Booties
+  module BadgeHelper
+    include Utils
+
+    ##
+    # Renders a span tag with the "badge" class. The content of the tag is
+    # passed in as +content+. The following:
+    #
+    #   <%= badge 'foo' %>
+    #
+    # will produce:
+    #
+    #   <span class="badge">foo</span>
+    #
+    # Alternatively, you can pass the content in as a block. The following:
+    #
+    #   <%= badge do %> foo <% end %>
+    #
+    # will produce:
+    #
+    #   <span class="badge">foo</span>
+    #
+    # Any options passed in through +options+ will be passed to #content_tag to
+    # be added as attributes to the span tag. The following:
+    #
+    #   <%= badge 'foo', id: 'bar' %>
+    #
+    # will produce:
+    #
+    #   <span class="badge" id="bar">foo</span>
+    #
+    # If the +:class+ option is passed in, the contents will be merged with the
+    # classes required by Bootstrap badges. The following:
+    #
+    #   <%= badge 'foo', class: 'bar' %>
+    #
+    # will produce:
+    #
+    #   <span class="badge bar">foo</span>
+    def badge(content = nil, **options, &block)
+      content ||= capture &block
+      classes = merge_classes ['badge'], options.delete(:class)
+      content_tag :span, content, class: classes, **options
+    end
+  end
+end

data/app/helpers/booties/button_helper.rb

@@ -0,0 +1,33 @@
+module Booties
+  module ButtonHelper
+    include Utils
+
+    ##
+    # Renders a link as a Bootstrap button. The default behavior is to add the
+    # .btn and btn-default classes to the rendered tag. The button context can
+    # be overridden to something other than .btn-default such as .btn-primary
+    # using the +context+ parameter. The +name+, +options+, +html_options+, and
+    # +block+ paramters are passed through to #link_to.
+    #
+    # If +html_options+ includes a +:class+ option, the classes will be merged
+    # with the required .btn classes.
+    #
+    # Examples:
+    #
+    #   <%= btn_link_to 'View', thingies_path %>
+    #
+    #   <a href="/thingies" class="btn btn-default">View</a>
+    #
+    #   <%= 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
+    end
+  end
+end

data/app/helpers/booties/flag_helper.rb

@@ -0,0 +1,59 @@
+module Booties
+  module FlagHelper
+    include Utils
+
+    ##
+    # Renders a span tag with the "label" class and a contextual label class
+    # derived from +context+. Defaults to "label-default". The content of the
+    # tag is passed in as +content+. The following:
+    #
+    #   <%= flag 'foo' %>
+    #
+    # will produce:
+    #
+    #   <span class="label label-default">foo</span>
+    #
+    # Alternatively, you can pass the content in as a block. The following:
+    #
+    #   <%= flag do %>
+    #     foo
+    #   <% end %>
+    #
+    # will produce:
+    #
+    #   <span class="label label-default">foo</span>
+    #
+    # You can provide a different context for the label as +context+. The
+    # following:
+    #
+    #   <%= flag 'foo', context: :primary %>
+    #
+    # will produce:
+    #
+    #   <span class="label label-primary">foo</span>
+    #
+    # Additional options passed in through +options+ will be passed to
+    # #content_tag to be added as attributes to the span tag. The following:
+    #
+    #   <%= flag 'foo', id: 'bar' %>
+    #
+    # will produce:
+    #
+    #   <span class="label label-default" id="bar">foo</span>
+    #
+    # If the +:class+ option is passed in the contents will be merged with the
+    # classes required by Bootstrap labels. The following:
+    #
+    #   <%= flag 'foo', class: 'bar' %>
+    #
+    # will produce:
+    #
+    #   <span class="label label-default bar">foo</span>
+    def flag(content = nil, context: :default, **options, &block)
+      content ||= capture &block
+      classes = merge_classes %W[label label-#{context}],
+        options.delete(:class)
+      content_tag :span, content, class: classes, **options
+    end
+  end
+end

data/app/helpers/booties/modal_helper.rb

@@ -0,0 +1,34 @@
+module Booties
+  module ModalHelper
+    ##
+    # 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.
+    #
+    # The contents of the dialog are passed in as a block. An instance of
+    # Booties::Modal will be yielded as a parameter to the block (similar to
+    # the way a FormBuilder works in Rails).
+    #
+    #   <%= 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 %>
+    def modal(id, fade: true, with: Modal, &block)
+      with.new(self, id: id, fade: fade).render &block
+    end
+  end
+end

data/app/helpers/booties/panel_helper.rb

@@ -0,0 +1,27 @@
+module Booties
+  module PanelHelper
+    ##
+    # Renders a panel. The defult panel context is +:default+ but can be
+    # specified through +options+. The contents of the panel should be passed
+    # in as a block. An instance of the Booties::Panel will be yielded as a
+    # parameter to the block (similar to the way a FormBuilder works in Rails).
+    #
+    #   <%= 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 %>
+    def panel(with: Panel, **options, &block)
+      with.new(self, **options).render &block
+    end
+  end
+end

data/app/helpers/booties/tooltip_helper.rb

@@ -0,0 +1,48 @@
+module Booties
+  module TooltipHelper
+    ##
+    # Wraps the content provided by +block+ with a Bootstrap tooltip. The text
+    # of the tooltip is passed in through the required +title+ parameter. The
+    # optional +placement+ parameter can be used to control alignment of the
+    # tooltip. Valid placements are :top, :bottom, :left, and :right.
+    # Additional paramters given in +options+ are passed through to
+    # #content_tag to be placed on the resulting tag.
+    #
+    # A caveat: Bootstrap tooltips are opt-in. You must initialize them
+    # yourself. One way to do this is to include the following Javascript
+    # snippet on the page:
+    #
+    #   $(function() { $('[data-toggle="tooltip"]').tooltip() }
+    #
+    # Examples:
+    #
+    #   <%= tooltip title: 'This is a tooltip' do %>
+    #     This has a tooltip.
+    #   <% end %>
+    #
+    #   <span data-toggle="tooltip" title="This is a tooltip">This has a tooltip.</span>
+    #
+    #   <%= tooltip title: 'This is a tooltip', placement: :bottom %>
+    #     This has a tooltip.
+    #   <% end %>
+    #
+    #   <span data-toggle="tooltip" data-placement="bottom" title="This is a tooltip">This has a tooltip.</span>
+    #
+    #   <%= tooltip title: 'This is a tooltip', class: 'tooltip' %>
+    #     This has a tooltip.
+    #   <% end %>
+    #
+    #   <span data-toggle="tooltip" title="This is a tooltip" class="tooltip">This has a tooltip.</span>
+    def tooltip(title:, placement: nil, **options, &block)
+      unless [nil, :top, :bottom, :right, :left].include? placement
+        raise ArgumentError, "invalid placement: #{placement.inspect}," \
+          ' valid placements are: :top, :bottom, :right, :left'
+      end
+
+      data = { toggle: 'tooltip' }
+      data[:placement] = placement if placement
+
+      content_tag :span, data: data, title: title, **options, &block
+    end
+  end
+end

data/lib/booties.rb

@@ -1,9 +1,7 @@
 require 'booties/engine'
+require 'booties/utils'
 require 'booties/modal'
 require 'booties/panel'
 
 module Booties
-  def self.merge_classes(a, b)
-    Array(a).flat_map(&:split) | Array(b).flat_map(&:split)
-  end
 end