bh 1.1.1 → 1.2.0

data/lib/bh/helpers/panel_helper.rb

@@ -1,80 +1,53 @@
-require 'bh/helpers/base_helper'
+require 'bh/classes/panel'
+require 'bh/classes/panel_row'
+require 'bh/classes/stack'
 
 module Bh
-  # Provides methods to include panels.
-  # @see http://getbootstrap.com/components/#panels
-  module PanelHelper
-    include BaseHelper
+  module Helpers
+    # Displays a Bootstrap-styled panel.
+    # @see http://getbootstrap.com/components/#panels
+    # @return [String] the HTML to display a Bootstrap-styled panel.
+    # @overload panel(body, options = {})
+    #   @param [#to_s] body the content to display as the panel body.
+    #   @param [Hash] options the options for the panel. Any option not
+    #     listed below is passed as an HTML attribute to the panel’s `<div>`.
+    #   @option options [#to_s] :title the text to display as the panel title.
+    #   @option options [#to_s] :heading the text to display as the panel 
+    #     heading.
+    #   @option options [#to_s] :body the text to display as the panel body.
+    #     Using this option is equivalent to passing the body as an argument.
+    #   @option options [#to_s] :context (#to_s) (:default) the contextual
+    #     alternative to apply to the panel heading and border. Can be
+    #     `:danger`, `:info`, `:primary`, `:success` or `:warning`.
+    #   @option options [#to_s] :tag (#to_s) (:div) the HTML tag to wrap the
+    #     panel into.
+    #   @example Display an informative panel with plain-text content.
+    #       panel 'You accepted the Terms of service.', context: :success
+    # @overload panel(options = {}, &block)
+    #   @param [Hash] options the options for the panel (see above).
+    #   @yieldreturn [#to_s] the content to display in the panel.
+    #   @example Display a panel with HTML content.
+    #       panel title: 'Thanks' do
+    #         content_tag :div, class: 'panel-body' do
+    #           content_tag :em, 'ou accepted the Terms of service.'
+    #         end
+    #       end
+    def panel(*args, &block)
+      panel = Bh::Panel.new self, *args, &block
+      panel.extract! :body, :context, :title, :heading, :tag
 
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display *panels*.
-    #
-    # The content of the panel can either be passed as the first parameter (in
-    # which case, the options are the second parameter), or as a block (in
-    # which case, the options are the first paramter).
-    # @example An panel with plain-text content passed as the first parameter.
-    #   panel 'Your profile was updated!', context: :info, title: 'Profile'
-    # @example A panel with HTML content passed as a block.
-    #   panel context: :info, title: 'Profile'
-    #     content_tag :strong, "Your profile was updated!"
-    #   end
-    #
-    # @return [String] an HTML block tag for a panel.
-    # @param [String] content_or_options_with_block the content to display in
-    #   the panel.
-    # @param [Hash] options the display options for the panel.
-    # @option options [#to_s] :context (:default) the contextual alternative to
-    #   apply to the panel depending on its importance. Can be :default,
-    #   :primary, :success, :info, :warning  or :danger.
-    # @option options [#to_s] :body if present, the panel will include the
-    #   provided text wrapped in a 'panel-body' block, for proper padding
-    # @see http://getbootstrap.com/components/#panels-basic
-    # @option options [#to_s] :heading if present, the panel will include a
-    #   heading with the provided text.
-    # @option options [#to_s] :title if present, the panel will include a
-    #   heading with the provided text wrapped in a 'panel-title' block, for
-    #   proper title styling and link coloring.
-    # @option options [#to_s] :tag (:div) the HTML tag to wrap the panel in.
-    # @see http://getbootstrap.com/components/#panels-heading
-    def panel(content_or_options_with_block = nil, options = nil, &block)
-      if block_given?
-        panel_string capture(&block), content_or_options_with_block || {}
-      elsif content_or_options_with_block.is_a?(Hash) && options.nil?
-        panel_string nil, content_or_options_with_block
-      else
-        panel_string content_or_options_with_block, options || {}
-      end
-    end
-
-  private
-
-    def panel_string(content = nil, options = {})
-      content = prepend_optional_body_to content, options
-      content = prepend_optional_heading_to content, options
-      tag = options.fetch :tag, :div
-      content_tag tag, content, class: panel_class(options[:context])
-    end
+      panel.append_class! :panel
+      panel.append_class! panel.context_class
+      panel.merge_html! panel.body
+      panel.prepend_html! panel.heading
 
-    def panel_class(context = nil)
-      valid_contexts = %w(primary success info warning danger)
-      context = context_for context, valid: valid_contexts
-      "panel panel-#{context}"
-    end
-
-    def prepend_optional_body_to(content, options = {})
-      body = options[:body]
-      body = content_tag :div, body, class: 'panel-body' if body
-      safe_join [body, content].compact
-    end
-
-    def prepend_optional_heading_to(content, options = {})
-      title = if options[:title]
-        content_tag :h3, options[:title], class: 'panel-title'
-      elsif options[:heading]
-        options[:heading]
+      if panel_row = Bh::Stack.find(Bh::PanelRow)
+        container = Bh::Base.new(self) { panel.content_tag panel.tag }
+        container.append_class! panel_row.column_class
+        container.render_tag :div
+      else
+        panel.render_tag panel.tag
       end
-      heading = content_tag :div, title, class: 'panel-heading' if title
-      safe_join [heading, content].compact
     end
   end
 end

data/lib/bh/helpers/panel_row_helper.rb

@@ -1,46 +1,28 @@
-require 'bh/helpers/panel_helper'
+require 'bh/classes/panel_row'
 
 module Bh
-  # Provides methods to include multiple panels in a row.
-  # @see http://getbootstrap.com/css/#grid
-  # @see http://getbootstrap.com/components/#panels
-  module PanelRowHelper
-    include PanelHelper # for panel
-
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display a *row*, passing column options to each panel in
-    # the row.
-    #
-    # @return [String] an HTML block tag for a row of panels.
-    # @param [Hash] options the display options for the row of panels.
-    # @option options [#to_s] :column_class the class to apply to the column
-    #   <div> that wraps every panel in the row. Useful to specify a grid size
-    #   for the column such as 'col-sm-4' to indicate how many columns of the
-    #   row each panel should occupy.
-    # @see http://getbootstrap.com/css/#grid
+  module Helpers
+    # Wraps a set of Bootstrap-styled panels in a row.
     # @see http://getbootstrap.com/components/#panels
+    # @see http://getbootstrap.com/css/#grid
+    # @return [String] the HTML to display a row of Bootstrap-styled panels.
+    # @param [Hash] options the options for the row. Any option not
+    #   listed below is passed as an HTML attribute to the row’s `<div>`.
+    # @option options [#to_s] :column_class the class to wrap each panel with.
+    #   Useful to specify a grid size for the column such as 'col-sm-4' to
+    #   indicate how many columns of the row each panel should occupy.
+    # @yieldreturn [#to_s] the panels to display in a row.
+    # @example Display a row of two panels with the same width.
+    #   panel_row column_class: 'col-sm-6' do
+    #     panel 'Panel #1', context: :success
+    #     panel 'Panel #2', context: :info
+    #   end
     def panel_row(options = {}, &block)
-      content_tag :div, class: 'row' do
-        capture_panel_row(options, &block) if block_given?
-      end
-    end
-
-  private
-
-    # Overrides PanelHelper +panel+ to be able to add a column <div> around
-    # each panel in a row, to make it fit inside the panel row.
-    def panel(*args, &block)
-      panel = super *args, &block
-      if @panel_column_class
-        content_tag :div, panel, class: @panel_column_class
-      else
-        panel
-      end
-    end
+      panel_row = Bh::PanelRow.new self, options, &block
+      panel_row.extract! :column_class
 
-    def capture_panel_row(options = {}, &block)
-      @panel_column_class = options[:column_class]
-      capture(&block).tap{ @panel_column_class = nil }
+      panel_row.append_class! :row
+      panel_row.render_tag :div
     end
   end
 end

data/lib/bh/helpers/progress_bar_helper.rb

@@ -1,66 +1,55 @@
-require 'bh/helpers/base_helper'
+require 'bh/classes/progress_bar'
 
 module Bh
-  # Provides methods to include progress bars.
-  # @see http://getbootstrap.com/components/#progress
-  module ProgressBarHelper
-    include BaseHelper
-
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display *progress bars*.
-    # @param [Hash, Array<Hash>] options the display options for the progress
-    #   bar(s). When options is an Array, a group of stacked progress bars
-    #   is displayed, with the options specified in each item of the array.
-    # @option options [Boolean, #to_s] :label (false) the label to display
-    #   on top of the progress bar. If set to false, the label is hidden. If
-    #   set to true, the label is generated from the percentage value. Any
-    #   other provided value is used directly as the label.
-    # @option options [Boolean] :striped (false) whether to display a striped
-    #   version of the progress bar (rather than solid color).
-    # @option options [Boolean] :animated (false) whether to display an
-    #   animated version of the progress bar (rather than solid color).
-    # @option options [#to_s] :context (:default) the contextual alternative to
-    #   apply to the progress bar depending on its importance. Can be
-    #   `:success`, `:info`, `:warning` or `:danger`.
-    def progress_bar(options = {})
-      content_tag :div, class: :progress do
-        safe_join Array.wrap(options).map{|bar| progress_bar_string bar}, "\n"
-      end
-    end
-
-  private
-
-    def progress_bar_string(options = {})
-      percentage = options.fetch :percentage, 0
-
-      attributes = {}.tap do |attrs|
-        attrs[:class] = progress_bar_class(options)
-        attrs[:role] = 'progressbar'
-        attrs[:style] = "width: #{percentage}%"
-        attrs['aria-valuenow'] = percentage
-        attrs['aria-valuemin'] = 0
-        attrs['aria-valuemax'] = 100
+  module Helpers
+    # Displays one or more Bootstrap-styled progress bars.
+    # @see http://getbootstrap.com/components/#progress
+    # @return [String] the HTML to display Bootstrap-styled progress bars.
+    # @overload progress_bar(bar_options = {}, container_options = {})
+    #   @param [Hash] bar_options the options to display a single progress bar.
+    #     Any option not listed below is passed as an HTML attribute to the
+    #     bar’s `<div>`.
+    #   @option bar_options [Boolean, #to_s] :label (false) the label to display
+    #     on top of the progress bar. If set to false, the label is hidden. If
+    #     set to true, the label is generated from the percentage value. Any
+    #     other provided value is used directly as the label.
+    #   @option bar_options [Boolean] :striped (false) whether to display a
+    #     striped version of the progress bar (rather than solid color).
+    #   @option bar_options [Boolean] :animated (false) whether to display an
+    #     animated version of the progress bar (rather than solid color).
+    #   @option bar_options [#to_s] :context (:default) the contextual
+    #     alternative to apply to the progress bar. Can be `:success`, `:info`,
+    #     `:warning` or `:danger`.
+    #   @param [Hash] container_options the options to pass as HTML attributes
+    #     to the container’s `<div>`.
+    #   @example Display a 30% warning progress bar.
+    #       progress_bar percentage: 30, context: :warning
+    # @overload progress_bar(stacked_bars_options = [], container_options = {})
+    #   @param [Hash] stacked_bars_options an array of bar_options (see above).
+    #     When an array is provided, a group of stacked progress bars is 
+    #     displayed, each one matching the corresponding bar options.
+    #   @param [Hash] container_options the options to pass as HTML attributes
+    #     to the container’s `<div>`.
+    #   @example Display two stacked progress bars.
+    #       progress_bar [{percentage: 30, context: :warning}, {percentage: 20}]
+    def progress_bar(args = nil, container_options = {})
+      progress_bars = Array.wrap(args).map do |options|
+        progress_bar = Bh::ProgressBar.new self, nil, options
+        progress_bar.extract! :percentage, :context, :striped, :animated, :label
+
+        progress_bar.merge! progress_bar.aria_values
+        progress_bar.append_class! :'progress-bar'
+        progress_bar.append_class! progress_bar.context_class
+        progress_bar.append_class! progress_bar.striped_class
+        progress_bar.append_class! progress_bar.animated_class
+        progress_bar.merge! progress_bar.values
+        progress_bar.prepend_html! progress_bar.label
+        progress_bar
       end
 
-      content_tag :div, progress_bar_label(percentage, options), attributes
-    end
-
-    def progress_bar_label(percentage, options = {})
-      text = "#{percentage}%#{" (#{options[:context]})" if options[:context]}"
-      case options.fetch(:label, false)
-        when true then text
-        when false then content_tag(:span, text, class: 'sr-only')
-        else options[:label]
-      end
-    end
-
-    def progress_bar_class(options = {})
-      valid_contexts = %w(success info warning danger)
-      context = context_for options[:context], valid: valid_contexts
-      context = context.in?(valid_contexts) ? "progress-bar-#{context}" : nil
-      striped = 'progress-bar-striped' if options[:striped]
-      animated = 'progress-bar-striped active' if options[:animated]
-      ['progress-bar', context, striped, animated].compact.join ' '
+      container = Bh::Base.new self, progress_bars, container_options
+      container.append_class! :progress
+      container.render_tag :div
     end
   end
 end

data/lib/bh/helpers/vertical_helper.rb

@@ -0,0 +1,33 @@
+require 'bh/classes/navbar'
+require 'bh/classes/vertical'
+
+module Bh
+  module Helpers
+    # Displays the non-collapsable portion of a Bootstrap-styled navbar.
+    # @see http://getbootstrap.com/components/#navbar
+    # @return [String] the HTML to display the non-collapsable portion of a
+    #   Bootstrap-styled navbar.
+    # @overload vertical(content, options = {})
+    #   @param [#to_s] content the non-collapsable content to display in the
+    #     navbar.
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    # @overload vertical(options = {}, &block)
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    #   @yieldreturn [#to_s] the non-collapsable content to display in the
+    #     navbar.
+    # @example Display a navbar a non-collapsable links.
+    #   navbar do
+    #     vertical do
+    #       link_to 'Home', '/'
+    #     end
+    #   end
+    def vertical(*args, &block)
+      if navbar = Bh::Stack.find(Bh::Navbar)
+        vertical = Bh::Vertical.new self, *args, &block
+        vertical.append_class! :'navbar-header'
+        vertical.prepend_html! vertical.toggle_button(navbar.id)
+        vertical.render_tag :div
+      end
+    end
+  end
+end

data/lib/bh/version.rb

@@ -1,3 +1,3 @@
 module Bh
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/bh/views/bh/_alert_dismiss_button.html

@@ -0,0 +1,4 @@
+<button type="button" class="close" data-dismiss="alert">
+  <span aria-hidden="true">&times;</span>
+  <span class="sr-only">Close</span>
+</button>

data/lib/bh/views/bh/_dropdown.html.erb

@@ -1,9 +1,9 @@
-<div class="<%= div_class %>">
-  <button class="dropdown-toggle <%= button_class %>" type="button" id="label-<%= id %>" data-toggle="dropdown">
-    <%= caption %>
+<div class="<%= div[:class] %>">
+  <button class="dropdown-toggle <%= button[:class] %>" type="button" id="<%= button[:id] %>" data-toggle="dropdown">
+    <%= button[:caption] %>
     <span class="caret"></span>
   </button>
-  <ul class="<%= list_class %>" role="menu" aria-labelledby="label-<%= id %>">
-    <%= yield %>
+  <ul class="<%= ul[:class] %>" role="menu" aria-labelledby="<%= button[:id] %>">
+    <%= content %>
   </ul>
 </div>

data/lib/bh/views/bh/_dropdown_split.html.erb

@@ -1,10 +1,10 @@
-<div class="<%= div_class %>">
-  <button type="button" class="<%= button_class %>"><%= caption %></button>
-  <button class="dropdown-toggle <%= button_class %>" type="button" id="label-<%= id %>" data-toggle="dropdown">
+<div class="<%= div[:class] %>">
+  <button type="button" class="<%= button[:class] %>"><%= button[:caption] %></button>
+  <button class="dropdown-toggle <%= button[:class] %>" type="button" id="<%= button[:id] %>" data-toggle="dropdown">
     <span class="caret"></span>
     <span class="sr-only">Toggle Dropdown</span>
   </button>
-  <ul class="<%= list_class %>" role="menu" aria-labelledby="label-<%= id %>">
-    <%= yield %>
+  <ul class="<%= ul[:class] %>" role="menu" aria-labelledby="<%= button[:id] %>">
+    <%= content %>
   </ul>
 </div>

data/lib/bh/views/bh/_modal.html.erb

@@ -1,17 +1,14 @@
-<button class="<%= button[:class] %>" data-toggle="modal" data-target="#<%= id %>">
-  <%= button[:caption] %>
-</button>
-<div class="modal fade" id="<%= id %>" tabindex="-1" role="dialog" aria-labelledby="label-<%= id %>" aria-hidden="true">
-  <div class="<%= dialog_class %>">
+<button class="<%= button[:class] %>" data-toggle="modal" data-target="#<%= div[:id] %>"><%= button[:caption] %></button>
+<div class="modal fade" id="<%= div[:id] %>" tabindex="-1" role="dialog" aria-labelledby="label-<%= div[:id] %>" aria-hidden="true">
+  <div class="<%= div[:class] %>">
     <div class="modal-content">
       <div class="modal-header">
         <button type="button" class="close" data-dismiss="modal">
           <span aria-hidden="true">&times;</span><span class="sr-only">Close</span>
         </button>
-        <h4 class="modal-title" id="label-<%= id %>"><%= title %></h4>
+        <h4 class="modal-title" id="label-<%= div[:id] %>"><%= div[:title] %></h4>
       </div>
-      <%= body %>
-      <%= yield %>
+      <%= content %>
     </div>
   </div>
 </div>

data/lib/bh/views/bh/_navbar.html.erb

@@ -0,0 +1,5 @@
+<nav class="<%= navigation[:class] %>" role="navigation">
+  <div class="<%= div[:class] %>">
+    <%= content %>
+  </div>
+</nav>

data/spec/padrino/button_to_helper.rb

@@ -0,0 +1,35 @@
+shared_examples_for 'the button_to helper (Padrino)' do
+  all_tests_pass_with 'no button_to options (Padrino)'
+  all_tests_pass_with 'only extra button_to options (Padrino)'
+  all_tests_pass_with 'extra button_to options (Padrino)'
+  all_tests_pass_for 'the button_to helper'
+end
+
+#--
+
+shared_examples_for 'no button_to options (Padrino)' do
+  specify 'uses the original button_to helper' do
+    html = '<form action="/" accept-charset="UTF-8" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" /></form>'
+    expect(:button_to).to generate html
+
+    # @note: Only Padrino >= 0.13.0 renders the content of the block as a
+    #        <button> so the exact content is only partially tested here.
+    expect(bh.button_to('/'){ 'content' }).to include 'content'
+  end
+end
+
+shared_examples_for 'only extra button_to options (Padrino)' do
+  specify 'uses the original button_to helper' do
+    options = {class: 'big', id: 'my-form', submit_options: {class: 'important', data: {value: 1}, id: 'my-button_to'}}
+    html = '<form action="/" accept-charset="UTF-8" class="big" id="my-form" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" class="important" data-value="1" id="my-button_to" /></form>'
+    expect(button_to: options).to generate html
+  end
+end
+
+shared_examples_for 'extra button_to options (Padrino)' do
+  specify 'passes the options to the form and the submit_options to the button' do
+    options = {context: :default, class: 'big', id: 'my-form', submit_options: {class: 'important', data: {value: 1}, id: 'my-button_to'}}
+    html = '<form action="/" accept-charset="UTF-8" class="big" id="my-form" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" class="important btn btn-default" data-value="1" id="my-button_to" /></form>'
+    expect(button_to: options).to generate html
+  end
+end