bootstrap-shoehorn 1.0.0

data/lib/shoehorn/helpers/modal_helpers.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Shoehorn::Helpers
+  module ModalHelpers
+
+    # Render a modal popup
+    #
+    # @param [Hash] options hash containing options (default: { :dom_id => 'twitter-bootstrap-modal', :fade => false, :header_title => '' }):
+    #            :id       - DOM ID of the modal element (mandatory).
+    #            :fade     - if true, add the fade class to the modal DOM element so the modal will be animated when shown.
+    #            :title    - modal title.
+    #
+    # @example
+    #   bootstrap_modal(id: "a_dom_id", fade: true, title: "Modal title!") do |modal|
+    #     modal.body do |c|
+    #       c.render partial: 'disclamer'
+    #     end
+    #     modal.footer do |c|
+    #       c.bootstrap_button "Close", "#", type: 'danger', html_options: { data: { dismiss: "modal" } }
+    #       c.bootstrap_button "Accept",  accept_request_path(@request),
+    #                          icon_name: 'ok', type: 'success',
+    #                          html_options: { data: { dismiss: "modal" }, method: :put }
+    #     end
+    #   end
+    #
+    # @example To render the button to show the modal use:
+    #   bootstrap_button "Show Modal", "#a_dom_id", :html_options => { data: { toggle: "modal" }}
+    #
+    # Returns HTML String for the modal popup
+    def bootstrap_modal(options = {})
+      elements = Shoehorn::HelperCollectionSet.new(self, [:body, :footer])
+      
+      yield elements
+
+      Shoehorn::Components::Modal.new(
+        elements.collections[:body],
+        elements.collections[:footer],
+        options
+      ).to_s
+    end
+    
+  end
+end

data/lib/shoehorn/helpers/navigation_helpers.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Shoehorn::Helpers
+  module NavigationHelpers
+
+    # Render a navigation list
+    #
+    # @param [Hash] options hash containing options (default: {}):
+    #            :type    - could be either 'tabs' or 'pills'. Default is 'tabs'.
+    #            :stacked - if true, renders the navigation list in stacked mode.
+    #
+    # Examples
+    #
+    #   bootstrap_navigation(:type => "tabs", :stacked => true) do |nav|
+    #     nav.link_to "Nav1", "/link1", :active_nav => true
+    #     nav.link_to "Nav2", "/link2"
+    #   end
+    #
+    # Returns HTML String for the navigation list
+    def bootstrap_navigation(options = {})
+      elements = Shoehorn::HelperCollection.new(self)
+
+      yield elements
+
+      Shoehorn::Components::Navigation.new(
+        elements,
+        options
+      ).to_s
+    end
+
+  end
+end
+

data/lib/shoehorn/helpers/progress_bar_helpers.rb

@@ -0,0 +1,25 @@
+module Shoehorn::Helpers
+  module ProgressBarHelpers
+    # Render a bootstrap progress bar
+    #
+    # @param [Integer] width percent out of 100 progress on bar
+    # @param [Hash] options hash containing options (default: {}):
+    #           :type         - Additional progress type(s). For one, just specify a string, but
+    #                           you can also pass an array (of sym or str) for multiple classes
+    #           :striped [Boolean]       - Additional progress type(s). For one, just specify a string, but
+    #                           you can also pass an array (of sym or str) for multiple classes
+    #           :html_options - Any additional options you'd like to pass to the content_tag that will be created
+    #                           for this button's a tag (for instance :target can be specified in :html_options).
+    #
+    # Examples
+    #
+    #   bootstrap_progress_bar(40, type: 'success', striped: true, animated: true)
+    #
+    def bootstrap_progress_bar(width, options = {})
+      Shoehorn::Components::ProgressBar.new(
+        width,
+        options
+      ).to_s
+    end
+  end
+end

data/lib/shoehorn/plugins.rb

@@ -0,0 +1,6 @@
+module Shoehorn
+  module Plugins
+    require "shoehorn/plugins/simple_navigation/renderer/bootstrap_topbar_list" if defined?(::SimpleNavigation)
+  end
+end
+

data/lib/shoehorn/plugins/simple_navigation/renderer/bootstrap_topbar_list.rb

@@ -0,0 +1,72 @@
+# Renders an ItemContainer as a <ul> element and its containing items as <li> elements.
+# Prepared to use inside the topbar of Twitter Bootstrap http://twitter.github.com/bootstrap/#navigation
+#
+# Examples
+#
+#   render_navigation(level: 1..2, renderer: :bootstrap_topbar_list, expand_all: true)
+class SimpleNavigation::Renderer::BootstrapTopbarList < SimpleNavigation::Renderer::Base
+
+  def render(item_container)
+    if options[:is_subnavigation]
+      ul_class = "dropdown-menu"
+    else
+      ul_class = "nav"
+    end
+
+    list_content = item_container.items.inject([]) do |list, item|
+      li_options = item.html_options.reject {|k, v| k == :link}
+      if include_sub_navigation?(item)
+        li_options[:class] = [li_options[:class], "dropdown"].flatten.compact.join(' ')
+      end
+      li_content = tag_for(item)
+      if include_sub_navigation?(item)
+        li_content << render_sub_navigation_for(item)
+      end
+      list << content_tag(:li, li_content, li_options)
+    end.join
+    if skip_if_empty? && item_container.empty?
+      ''
+    else
+      content_tag(:ul, list_content, { :id => item_container.dom_id, :class => [item_container.dom_class, ul_class].flatten.compact.join(' ') })
+    end
+  end
+
+  def render_sub_navigation_for(item)
+    item.sub_navigation.render(self.options.merge(:is_subnavigation => true))
+  end
+
+  protected
+
+  def tag_for(item)
+    if item.url.nil?
+      content_tag('span', item.name, link_options_for(item).except(:method))
+    else
+      name = item.name
+      name += ' <span class="caret"></span>' if include_sub_navigation?(item)
+      link_to(name, item.url, link_options_for(item))
+    end
+  end
+
+  # Extracts the options relevant for the generated link
+  #
+  def link_options_for(item)
+    special_options = {:method => item.method}.reject {|k, v| v.nil? }
+    link_options = item.html_options[:link] || {}
+    opts = special_options.merge(link_options)
+    opts[:class] = [link_options[:class], item.selected_class, dropdown_link_class(item)].flatten.compact.join(' ')
+    if include_sub_navigation?(item) && !options[:is_subnavigation]
+      opts['data-toggle'] = 'dropdown'
+    end
+    opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
+    opts
+  end
+
+  def dropdown_link_class(item)
+    if include_sub_navigation?(item) && !options[:is_subnavigation]
+      "dropdown-toggle"
+    end
+  end
+end
+
+SimpleNavigation.register_renderer :bootstrap_topbar_list => SimpleNavigation::Renderer::BootstrapTopbarList
+

data/lib/shoehorn/version.rb

@@ -0,0 +1,3 @@
+module Shoehorn
+  VERSION = "1.0.0"
+end

data/shoehorn.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shoehorn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matteo Canato"]
+  gem.email         = ["mcanato@gmail.com"]
+  gem.description   = %q{Shoehorn: a Twitter Bootstrap 2.0 helper library for Rails - HTML, CSS, and JS toolkit from Twitter}
+  gem.summary       = %q{Shoehorn: a Twitter Bootstrap 2.0 helper library for Rails - HTML, CSS, and JS toolkit from Twitter}
+  gem.homepage      = "https://www.github.com/mcanato/shoehorn"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "bootstrap-shoehorn"
+  gem.require_paths = ["lib"]
+  gem.version       = Shoehorn::VERSION
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.add_dependency "railties", "~> 3.0"
+  gem.add_development_dependency "rails",              "~> 3.0"
+  gem.add_development_dependency "rspec-rails",        "~> 2.10"
+  gem.add_development_dependency "rspec_tag_matchers", ">= 1.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'yard-tomdoc'
+  gem.add_development_dependency 'simple-navigation'
+
+  if !defined?(RUBY_ENGINE) || RUBY_ENGINE != 'rbx'
+    gem.add_development_dependency RUBY_VERSION =~ /^1\.9/ ? "simplecov" : "rcov"
+  end
+end
+

data/spec/helpers/alert_helpers_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Twitter::Bootstrap::Markup::Rails::Helpers::AlertHelpers do
+  include BootstrapSpecHelper
+
+  describe "#bootstrap_alert_tag" do
+    before do
+      @output_buffer = ''
+    end
+
+    it "has no heading by default" do
+      concat bootstrap_alert_tag("Message", :heading => nil)
+      output_buffer.should_not have_tag('div strong')
+      output_buffer.should_not have_tag('div h4.alert-heading')
+    end
+
+    it "has alert class" do
+      concat bootstrap_alert_tag("Message")
+      output_buffer.should have_tag("div.alert")
+    end
+
+    it "has a message" do
+      concat bootstrap_alert_tag("Message")
+      output_buffer.should have_tag('div', /Message/)
+    end
+
+    it "has a close button when :close is true" do
+      concat bootstrap_alert_tag("Message", :close => true)
+      output_buffer.should have_tag('div a.close', /×/)
+    end
+
+    it "has no close button when :close is false" do
+      concat bootstrap_alert_tag("Message", :close => false)
+      output_buffer.should_not have_tag('div a.close')
+    end
+
+    it "has a dismiss tag" do
+      concat bootstrap_alert_tag("Message")
+      output_buffer.should have_tag('div a[data-dismiss="alert"]')
+    end
+
+    it "has a h4 heading when :block is true" do
+      concat bootstrap_alert_tag("message", :heading => "heading1", :block => true)
+      output_buffer.should have_tag('div h4.alert-heading', /heading1/)
+    end
+
+    it "has a strong heading when :block is false" do
+      concat bootstrap_alert_tag("Message", :heading => "Heading1", :block => false)
+      output_buffer.should have_tag('div strong', /Heading1/)
+    end
+
+    it "should add html_options to the resulting DIV tag when specified" do
+      concat bootstrap_alert_tag("Message", :html_options => {:"data-test" => "42"})
+      output_buffer.should have_tag("div[data-test='42']")
+    end
+  end
+
+  %w(error success info).each do |type|
+    describe "#bootstrap_alert_#{type}_block_tag" do
+      before do
+        @output_buffer = ''
+      end
+
+      it "has alert class" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag("div.alert")
+      end
+
+      it "has alert-block class" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag("div.alert-block")
+      end
+
+      it "has alert-#{type} class" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag("div.alert-#{type}")
+      end
+
+      it "has a message" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag('div', /Message/)
+      end
+
+      it "has close button" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag('div a.close', /×/)
+      end
+
+      it "has dismiss tag" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message")
+        output_buffer.should have_tag('div a[data-dismiss="alert"]')
+      end
+
+      it "has a heading" do
+        concat send("bootstrap_alert_#{type}_block_tag", "Message", :heading => "Heading1")
+        output_buffer.should have_tag('div h4.alert-heading', /Heading1/)
+      end
+    end
+
+    describe "#bootstrap_alert_#{type}_tag" do
+      before do
+        @output_buffer = ''
+      end
+
+      it "has alert class" do
+        concat send("bootstrap_alert_#{type}_tag", "Message")
+        output_buffer.should have_tag("div.alert")
+      end
+
+      it "has alert-#{type} class" do
+        concat send("bootstrap_alert_#{type}_tag", "Message")
+        output_buffer.should have_tag("div.alert-#{type}")
+      end
+
+      it "has a message" do
+        concat send("bootstrap_alert_#{type}_tag", "Message")
+        output_buffer.should have_tag('div', /Message/)
+      end
+
+      it "has close button" do
+        concat send("bootstrap_alert_#{type}_tag", "Message")
+        output_buffer.should have_tag('div a.close', /×/)
+      end
+
+      it "has dismiss tag" do
+        concat send("bootstrap_alert_#{type}_tag", "Message")
+        output_buffer.should have_tag('div a[data-dismiss="alert"]')
+      end
+
+      it "has a heading" do
+        concat send("bootstrap_alert_#{type}_tag", "Message", :heading => "Heading1")
+        output_buffer.should have_tag('div strong', /Heading1/)
+      end
+    end
+  end
+end
+

data/spec/helpers/button_helpers_spec.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Twitter::Bootstrap::Markup::Rails::Helpers::ButtonHelpers do
+  include BootstrapSpecHelper
+  include BootstrapButtonMacros
+
+  describe "#bootstrap_button" do
+    before do
+      @output_buffer = ''
+    end
+
+    it "should create a button with the btn class" do
+      concat bootstrap_button("Text", "#")
+      output_buffer.should have_tag('a.btn')
+    end
+
+    it "should have text" do
+      concat bootstrap_button("Text", "#")
+      output_buffer.should have_tag('a', /Text/)
+    end
+
+    it "should link to the specified url" do
+      concat bootstrap_button("Text", "http://example.test")
+      output_buffer.should have_tag("a[href='http://example.test']")
+    end
+
+    it "should have disabled class when :disabled is true" do
+      concat bootstrap_button("Text", "#", :disabled => true)
+      output_buffer.should have_tag("a.disabled")
+    end
+
+    it "should add an additional class when :type is a string" do
+      concat bootstrap_button("Text", "#", :type => 'test')
+      output_buffer.should have_tag("a.test")
+    end
+
+    it "should add additional classes when :type is an array" do
+      concat bootstrap_button("Text", "#", :type => ['test1', 'test2'])
+      output_buffer.should have_tag("a.test1")
+      output_buffer.should have_tag("a.test2")
+    end
+
+    it "should add an icon when :icon is specified" do
+      concat bootstrap_button("Text", "#", :icon => 'icon-search')
+      output_buffer.should have_tag("a.btn i.icon-search")
+    end
+
+    it "should add a white icon when :icon_white is true" do
+      concat bootstrap_button("Text", "#", :icon => 'icon-search', :icon_white => true)
+      output_buffer.should have_tag("a.btn i.icon-search")
+      output_buffer.should have_tag("a.btn i.icon-white")
+    end
+
+    it "should add an id when :id is specified" do
+      concat bootstrap_button("Text", "#", :id => "foo")
+      output_buffer.should have_tag("a#foo")
+    end
+
+    it "should add html_options to the resulting a tag when specified" do
+      concat bootstrap_button("Text", "#", :html_options => {:target => "_top"})
+      output_buffer.should have_tag("a[target='_top']")
+    end
+  end
+
+
+  describe "#bootstrap_button_dropdown" do
+    before do
+      @output_buffer = ''
+    end
+
+    it "should create a dropdown button when called with a button and one (or more) links" do
+      build_bootstrap_button_dropdown do |d|
+        d.bootstrap_button "Button Text", "#"
+        d.link_to "Link Text", "#"
+      end
+
+      output_buffer.should have_tag('div.btn-group') do |div|
+        div.should have_tag('a.btn')
+        div.should have_tag('ul.dropdown-menu a')
+      end
+    end
+
+    it "should properly merge html_options into the container div" do
+      build_bootstrap_button_dropdown(:html_options => {:id => "foo"}) do |d|
+        d.bootstrap_button "Button Text", "#"
+        d.link_to "This", "#"
+      end
+
+      output_buffer.should have_tag('div.btn-group#foo')
+    end
+
+    it "should properly add classes from html_options onto the container div" do
+      build_bootstrap_button_dropdown(:html_options => {:class => "foo"}) do |d|
+        d.bootstrap_button "Button Text", "#"
+        d.link_to "This", "#"
+      end
+
+      output_buffer.should have_tag('div.btn-group.foo')
+    end
+  end
+end