bh 1.0.1 → 1.1.0

data/lib/bh/helpers/modal_helper.rb

@@ -58,15 +58,8 @@ module Bh
     end
 
     def button_class(options = {})
-      context = case options[:context].to_s
-        when 'primary' then :primary
-        when 'success' then :success
-        when 'info' then :info
-        when 'warning' then :warning
-        when 'danger' then :danger
-        when 'link' then :link
-        else 'default'
-      end
+      valid_contexts = %w(primary success info warning danger link)
+      context = context_for options[:context], valid: valid_contexts
 
       size = case options[:size].to_s
         when 'lg', 'large' then 'btn-lg'

data/lib/bh/helpers/panel_helper.rb

@@ -56,14 +56,8 @@ module Bh
     end
 
     def panel_class(context = nil)
-      context = case context.to_s
-        when 'primary' then :primary
-        when 'success' then :success
-        when 'info' then :info
-        when 'warning' then :warning
-        when 'danger' then :danger
-        else 'default'
-      end
+      valid_contexts = %w(primary success info warning danger)
+      context = context_for context, valid: valid_contexts
       "panel panel-#{context}"
     end
 

data/lib/bh/helpers/progress_bar_helper.rb

@@ -0,0 +1,66 @@
+require 'bh/helpers/base_helper'
+
+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
+      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 ' '
+    end
+  end
+end

data/lib/bh/middleman.rb

@@ -0,0 +1,39 @@
+require 'bh/helpers/alert_helper'
+require 'bh/helpers/button_helper'
+require 'bh/helpers/button_to_helper'
+require 'bh/helpers/cdn_helper'
+require 'bh/helpers/dropdown_helper'
+require 'bh/helpers/form_for_helper'
+require 'bh/helpers/glyphicon_helper'
+require 'bh/helpers/icon_helper'
+require 'bh/helpers/link_to_helper'
+require 'bh/helpers/modal_helper'
+require 'bh/helpers/nav_helper'
+require 'bh/helpers/navbar_helper'
+require 'bh/helpers/panel_helper'
+require 'bh/helpers/panel_row_helper'
+require 'bh/helpers/progress_bar_helper'
+
+module Bh
+  class MiddlemanExtension < Middleman::Extension
+    helpers do
+      include AlertHelper
+      include ButtonHelper
+      include ButtonToHelper
+      include CdnHelper
+      include DropdownHelper
+      include FormForHelper
+      include GlyphiconHelper
+      include IconHelper
+      include LinkToHelper
+      include ModalHelper
+      include NavHelper
+      include NavbarHelper
+      include PanelHelper
+      include PanelRowHelper
+      include ProgressBarHelper
+    end
+  end
+end
+
+::Middleman::Extensions.register(:bh, Bh::MiddlemanExtension)

data/lib/bh/railtie.rb

@@ -1,29 +1,37 @@
 require 'bh/helpers/alert_helper'
+require 'bh/helpers/button_helper'
 require 'bh/helpers/button_to_helper'
 require 'bh/helpers/cdn_helper'
+require 'bh/helpers/dropdown_helper'
 require 'bh/helpers/form_for_helper'
 require 'bh/helpers/glyphicon_helper'
+require 'bh/helpers/icon_helper'
 require 'bh/helpers/link_to_helper'
 require 'bh/helpers/modal_helper'
 require 'bh/helpers/nav_helper'
 require 'bh/helpers/navbar_helper'
 require 'bh/helpers/panel_helper'
 require 'bh/helpers/panel_row_helper'
+require 'bh/helpers/progress_bar_helper'
 
 module Bh
   class Railtie < Rails::Railtie
     initializer 'bh.add_helpers' do
       ActionView::Base.send :include, AlertHelper
+      ActionView::Base.send :include, ButtonHelper
       ActionView::Base.send :include, ButtonToHelper
       ActionView::Base.send :include, CdnHelper
+      ActionView::Base.send :include, DropdownHelper
       ActionView::Base.send :include, FormForHelper
       ActionView::Base.send :include, GlyphiconHelper
+      ActionView::Base.send :include, IconHelper
       ActionView::Base.send :include, LinkToHelper
       ActionView::Base.send :include, ModalHelper
       ActionView::Base.send :include, NavHelper
       ActionView::Base.send :include, NavbarHelper
       ActionView::Base.send :include, PanelHelper
       ActionView::Base.send :include, PanelRowHelper
+      ActionView::Base.send :include, ProgressBarHelper
     end
 
     initializer 'bh.add_views' do |app|

data/lib/bh/version.rb

@@ -1,3 +1,3 @@
 module Bh
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

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

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

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

@@ -0,0 +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">
+    <span class="caret"></span>
+    <span class="sr-only">Toggle Dropdown</span>
+  </button>
+  <ul class="<%= list_class %>" role="menu" aria-labelledby="label-<%= id %>">
+    <%= yield %>
+  </ul>
+</div>

data/spec/dummy/index.html.erb

@@ -0,0 +1,60 @@
+---
+layout: default
+---
+<!-- Edit the code below to see how code looks in a browser -->
+<!-- Note that only *a few* helpers are currently supported by Bh+Middleman,
+     so the use of this dummy file is currently limited to the helpers
+     listed below. The plan is to make all the helpers look in Middleman
+     in the future, as they do in Rails. -->
+<h1>Alerts</h1>
+
+<%= alert_box 'You accepted the Terms of service.', context: :success, dismissible: true %>
+<%= alert_box 'You accepted the Terms of service.', context: :info, dismissible: true %>
+<%= alert_box 'You accepted the Terms of service.', context: :warning, dismissible: true %>
+<%= alert_box 'You accepted the Terms of service.', context: :danger, dismissible: true %>
+<%= alert_box 'You accepted the Terms of service.', dismissible: true %>
+
+
+<p>Alert boxes with HTML content currently not supported in Middleman.</p>
+
+<h1>Panels</h1>
+
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks', context: :primary %>
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks', context: :success %>
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks', context: :info %>
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks', context: :warning %>
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks', context: :danger %>
+<%= panel body: 'You accepted the Terms of service.', title: 'Thanks' %>
+
+
+<p>Panels with HTML content currently not supported in Middleman.</p>
+
+<h1>Panel rows</h1>
+
+<p>Panel rows currently not supported in Middleman.</p>
+
+<h1>Modals</h1>
+
+<p>Modals currently not supported in Middleman.</p>
+
+<h1>Navs</h1>
+
+<p>Navs currently not supported in Middleman.</p>
+
+<h1>Navbars</h1>
+
+<p>Navbars currently not supported in Middleman.</p>
+
+<h1>Forms</h1>
+
+<p>Forms currently not supported in Middleman.</p>
+
+<h1>Glyphicons</h1>
+
+<%= icon :zoom_in %>
+
+<h1>Icons</h1>
+
+<%= icon :heart %>
+<%= stylesheet_link_tag font_awesome_css %>
+<%= icon :heart, library: :font_awesome, class: 'fa-5x' %>

data/spec/dummy/layouts/default.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta content="IE=edge" http-equiv="X-UA-Compatible" />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <%= stylesheet_link_tag font_awesome_css, bootstrap_css, bootstrap_theme_css %>
+    <title>Bh test page</title>
+  </head>
+  <body>
+    <div class='container'>
+      <%= yield %>
+    </div>
+    <%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js' %>
+    <%= javascript_include_tag bootstrap_js %>
+  </body>
+</html>

data/spec/helpers/button_helper_spec.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'bh/helpers/button_helper'
+include Bh::ButtonHelper
+
+describe 'button' do
+  describe 'accepts as parameters:' do
+    let(:behave) { match %r{^<button class="btn.+?">content</button>} }
+
+    specify 'a string (content)' do
+      expect(button 'content').to behave
+    end
+
+    specify 'a block (content)' do
+      expect(button { 'content' }).to behave
+    end
+
+    specify 'a string (content) + a hash (options)' do
+      expect(button 'content', context: :danger).to behave
+    end
+
+    specify 'a hash (options) + a block (content)' do
+      expect(button(context: :danger) { 'content' }).to behave
+    end
+  end
+
+  describe 'with the :context option' do
+    let(:html) { button 'content', context: context }
+
+    describe 'set to :primary, shows a "primary" button' do
+      let(:context) { :primary }
+      it { expect(html).to include 'btn-primary' }
+    end
+
+    describe 'set to :success, shows a "success" button' do
+      let(:context) { :success }
+      it { expect(html).to include 'btn-success' }
+    end
+
+    describe 'set to :info, shows a "info" button' do
+      let(:context) { :info }
+      it { expect(html).to include 'btn-info' }
+    end
+
+    describe 'set to :warning, shows a "warning" button' do
+      let(:context) { :warning }
+      it { expect(html).to include 'btn-warning' }
+    end
+
+    describe 'set to :danger, shows a "danger" button' do
+      let(:context) { :danger }
+      it { expect(html).to include 'btn-danger' }
+    end
+
+    describe 'set to :link, shows a "link" button' do
+      let(:context) { :link }
+      it { expect(html).to include 'btn-link' }
+    end
+
+    describe 'set to any other value, shows a "default" button' do
+      let(:context) { :unknown }
+      it { expect(html).to include 'btn-default' }
+    end
+  end
+
+  describe 'without the :context option, shows a "default" button' do
+    let(:html) { button 'content' }
+    it { expect(html).to include 'btn-default' }
+  end
+
+  describe 'with the :size option' do
+    let(:html) { button 'content', size: size }
+
+    describe 'set to :large, shows a large button' do
+      let(:size) { :large }
+      it { expect(html).to include 'btn-lg' }
+    end
+
+    describe 'set to :small, shows a small button' do
+      let(:size) { :small }
+      it { expect(html).to include 'btn-sm' }
+    end
+
+    describe 'set to :extra_small, shows an extra-small button' do
+      let(:size) { :extra_small }
+      it { expect(html).to include 'btn-xs' }
+    end
+  end
+
+
+  describe 'with the :layout option' do
+    let(:html) { button 'content', layout: layout }
+
+    describe 'set to :block, shows a "block" button' do
+      let(:layout) { :block }
+      it { expect(html).to include 'btn-block' }
+    end
+  end
+end

data/spec/helpers/cdn_helper_spec.rb

@@ -73,4 +73,28 @@ describe 'bootstrap_js' do
     let(:options) { {scheme: :https, version: '3.1.0'} }
     it{ expect(file).to be }
   end
-end
+end
+
+describe 'font_awesome_css' do
+  let(:file) { open font_awesome_css(options), ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE }
+
+  describe 'with the HTTP scheme, links to an existing file' do
+    let(:options) { {scheme: :http} }
+    it{ expect(file).to be }
+  end
+
+  describe 'with the HTTPS scheme, links to an existing file' do
+    let(:options) { {scheme: :https} }
+    it{ expect(file).to be }
+  end
+
+  describe 'non-minified, links to an existing file' do
+    let(:options) { {scheme: :http, minified: false} }
+    it{ expect(file).to be }
+  end
+
+  describe 'given a legacy version, links to an existing file' do
+    let(:options) { {scheme: :https, version: '3.1.0'} }
+    it{ expect(file).to be }
+  end
+end

data/spec/helpers/dropdown_helper_spec.rb

@@ -0,0 +1,146 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'action_dispatch'
+require 'bh/helpers/dropdown_helper'
+include Bh::DropdownHelper
+
+describe 'dropdown' do
+  let(:views_folder) { File.expand_path('../../../lib/bh/views', __FILE__) }
+  let(:lookup_context) { ActionView::LookupContext.new views_folder }
+  let(:view_renderer) { ActionView::Renderer.new lookup_context }
+  let(:caption) { 'Menu' }
+  let(:options) { {} }
+  let(:html) { dropdown(caption, options) {} }
+
+  specify 'uses the caption with a caret as the button caption' do
+    expect(html).to match %r{<button .+>.+Menu.+<span class="caret"></span>.+</button>}m
+  end
+
+  describe 'with the :groupable option' do
+    specify 'not set, wraps the dropdown in a "btn-group" div' do
+      expect(html).to include '<div class="btn-group">'
+    end
+
+    describe 'set to true, wraps the dropdown in a "btn-group" div' do
+      let(:options) { {groupable: true} }
+      it { expect(html).to include '<div class="btn-group">' }
+    end
+
+    describe 'set to false, wraps the dropdown in a "dropdown" div' do
+      let(:options) { {groupable: false} }
+      it { expect(html).to include '<div class="dropdown">' }
+    end
+  end
+
+  describe 'with the :align option' do
+    specify 'not set, wraps the list in a "dropdown-menu" ul' do
+      expect(html).to include '<ul class="dropdown-menu"'
+    end
+
+    describe 'set to :left, wraps the dropdown in a dropdown-menu" ul' do
+      let(:options) { {align: :left} }
+      it { expect(html).to include '<ul class="dropdown-menu"' }
+    end
+
+    describe 'set to :right, adds the dropdown-menu-right class to the ul' do
+      let(:options) { {align: :right} }
+      it { expect(html).to include '<ul class="dropdown-menu dropdown-menu-right"' }
+    end
+  end
+
+  describe 'with the :direction option' do
+    specify 'not set, uses the default dropdown direction' do
+      expect(html).not_to include 'dropup'
+    end
+
+    describe 'set to :down, uses the default dropdown direction' do
+      let(:options) { {direction: :down} }
+      it { expect(html).not_to include 'dropup' }
+    end
+
+    describe 'set to :up, adds the dropup class to the div' do
+      let(:options) { {direction: :up} }
+      it { expect(html).to include 'dropup' }
+    end
+  end
+
+  describe 'with the :split option' do
+    specify 'not set, uses a single dropdown button' do
+      expect(html).not_to match %r{</button>.+</button}m
+    end
+
+    describe 'set to false, uses a single dropdown button' do
+      let(:options) { {split: false} }
+      it { expect(html).not_to match %r{</button>.+</button}m }
+    end
+
+    describe 'set to true, uses a split dropdown button' do
+      let(:options) { {split: true} }
+      it { expect(html).to match %r{</button>.+</button}m }
+    end
+  end
+
+  describe 'with the :context option' do
+    let(:options) { {context: context} }
+
+    describe 'set to :primary, shows a "primary" dropdown button' do
+      let(:context) { :primary }
+      it { expect(html).to include 'btn-primary' }
+    end
+
+    describe 'set to :success, shows a "success" dropdown button' do
+      let(:context) { :success }
+      it { expect(html).to include 'btn-success' }
+    end
+
+    describe 'set to :info, shows a "info" dropdown button' do
+      let(:context) { :info }
+      it { expect(html).to include 'btn-info' }
+    end
+
+    describe 'set to :warning, shows a "warning" dropdown button' do
+      let(:context) { :warning }
+      it { expect(html).to include 'btn-warning' }
+    end
+
+    describe 'set to :danger, shows a "danger" dropdown button' do
+      let(:context) { :danger }
+      it { expect(html).to include 'btn-danger' }
+    end
+
+    describe 'set to :link, shows a "link" dropdown button' do
+      let(:context) { :link }
+      it { expect(html).to include 'btn-link' }
+    end
+
+    describe 'set to any other value, shows a "default" dropdown button' do
+      let(:context) { :unknown }
+      it { expect(html).to include 'btn-default' }
+    end
+  end
+
+  describe 'without the :context option, shows a "default" dropdown button' do
+    let(:options) { {} }
+    it { expect(html).to include 'btn-default' }
+  end
+
+  describe 'with the :size option' do
+    let(:options) { {size: size} }
+
+    describe 'set to :large, shows a large dropdown button' do
+      let(:size) { :large }
+      it { expect(html).to include 'btn-lg' }
+    end
+
+    describe 'set to :small, shows a small dropdown button' do
+      let(:size) { :small }
+      it { expect(html).to include 'btn-sm' }
+    end
+
+    describe 'set to :extra_small, shows an extra-small dropdown button' do
+      let(:size) { :extra_small }
+      it { expect(html).to include 'btn-xs' }
+    end
+  end
+end