rails-bootstrap-helpers 0.0.1 → 0.1.0

data/lib/rails-bootstrap-helpers/helpers/accordion_helper.rb

@@ -0,0 +1,8 @@
+module RailsBootstrapHelpers::Helpers::AccordionHelper
+  # Renders a Bootstrap accordion.
+  #
+  # @param [String] an ID that is unique for the page
+  def accordion (id, &block)
+    RailsBootstrapHelpers::Renderers::AccordionRenderer.new(self, id, &block).render
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/alert_helper.rb

@@ -5,31 +5,41 @@ module RailsBootstrapHelpers::Helpers::AlertHelper
   #
   # @param text [String] the text to render in the alert
   #
-  # ==== Options
-  # @param :type [String] the type of alert to render
-  # @param :block [Boolean] indicates if the alert should render with block style
-  # @param :dismiss_button [Boolean] indicates if an dismiss button should be
-  #        added to the alert
+  # @option options [String] :style the style of alert to render
+  #
+  # @option options [Boolean] :block (false) indicates if the alert should
+  #         render with block style
+  #
+  # @options options [Boolean] :dismiss_button (false) indicates if an dismiss
+  #          button should be added to the alert
   def bs_alert (text, options = {})
+    options = options.deep_dup
     cls = "alert"
+    type = options.delete(:type)
 
-    if type = options[:type]
-      type = type.to_s
+    if type
+      ActiveSupport::Deprecation.warn "Usage of the option `:type` is deprecated. Please use the `:style` option instead"
+    end
 
-      if type == "notice"
-        type = "success"
+    if style = options.delete(:style) || type
+      style = style.to_s
+
+      if style == "notice"
+        style = "success"
       end
 
-      unless type == "warning" || type == "default"
-        cls << " alert-#{type}"
+      unless style == "warning" || style == "default"
+        cls << " alert-#{style}"
       end
     end
 
-    if type = options[:block]
+    if style = options.delete(:block)
       cls << " alert-block"
     end
 
-    if dismiss_button = options[:dismiss_button]
+    append_class!(options, cls)
+
+    if options.delete(:dismiss_button)
       content_tag :div, class: cls do
         button = content_tag :button, "×",
           type: "button",
@@ -39,7 +49,7 @@ module RailsBootstrapHelpers::Helpers::AlertHelper
         button + text
       end
     else
-      content_tag :div, text, class: cls
+      content_tag :div, text, options
     end
   end
 end

data/lib/rails-bootstrap-helpers/helpers/base_helper.rb

@@ -1,32 +1,44 @@
 module RailsBootstrapHelpers::Helpers::BaseHelper
+  include RailsBootstrapHelpers::Helpers::OptionsHelper
+
   # Renders the given icon
   #
   # Renders an <tt>i</tt> tag with the class "icon-#{icon}"
   #
   # @param icon [String, Symbol] the kind of icon to render
   #
-  # ==== Options
-  # @param :invert [Boolean] if the color of the icon should be inverted
-  def self.icon (icon, options = {})
+  # @option options [Boolean] :invert (false) if the color of the icon should be inverted
+  def icon (icon, options = {})
+    options = options.dup
+
     icon = ERB::Util.html_escape(icon.to_s)
-    cls = "icon-" + icon
+    append_class!(options, "icon-" + icon)
 
-    if invert = options.delete(:invert)
-      cls << " icon-white"
+    if options.delete(:invert)
+      append_class!(options, "icon-white")
     end
 
+    cls = options[:class]
+
     "<i class=\"#{cls}\"></i>".html_safe
   end
 
-  # Renders the given icon
-  #
-  # Renders an <tt>i</tt> tag with the class "icon-#{icon}"
+  # Renders the given Iconic icon.
+  # 
+  # This is the Iconic icons from Jasny Bootstrap.
+  # Renders an <tt>i</tt> tag with the class "iconic-#{icon}"
   #
   # @param icon [String, Symbol] the kind of icon to render
   #
-  # ==== Options
-  # @param :invert [Boolean] if the color of the icon should be inverted
-  def icon (icon, options = {})
-    RailsBootstrapHelpers::Helpers::BaseHelper.icon(icon, options)
+  # @option options [String, Symbol] :color the CSS color of the icon
+  # @option options [String, Symbol, Number] :size the CSS font size of the icon
+  #
+  # @option options [:warning, :error, :info, :success, :muted] :bs_style
+  #         the Bootstrap style to render the icon in
+  #
+  # @option options [:primary, :info, :success, :warning, :danger] :action_style
+  #         renders the icon with this action link style
+  def iconic_icon (icon, options = {})
+    RailsBootstrapHelpers::Renderers::IconicIconRenderer.new(self, icon, options).render
   end
 end

data/lib/rails-bootstrap-helpers/helpers/button_helper.rb

@@ -1,17 +1,20 @@
 module RailsBootstrapHelpers::Helpers::ButtonHelper
+  include RailsBootstrapHelpers::Helpers::OptionsHelper
+  include RailsBootstrapHelpers::Helpers::FormTagHelper
+
   # Renders a Bootstrap button. This method behaves just as "link_to" but will
   # render a Bootstrap button instead of a regular link. Note that this is still
   # an "a" tag and not an "input" tag. In addition to the options "link_to"
   # handles this method also handles the following options:
   #
-  # ==== Options
-  # @param :style [String, Symbol] the style of the button
-  # @param :size ["large", "small", "mini"] the size of the button
-  # @param :disabled [Boolean] if the button should be disabled or not
-  # @param :icon [String] the name of an icon to render on the button
-  # @param :icon_position ["left", "right"] the position of the icon, if present
-  # @present :icon_invert [Boolean] if the color of the icon should be inverted
-  #   or not
+  # @option options [String, Symbol] :style the style of the button
+  # @option options ["large", "small", "mini"] :size the size of the button
+  # @option options [Boolean] :disabled (false) if the button should be disabled or not
+  # @option options [String] :icon the name of an icon to render on the button
+  # @option options ["left", "right"] :icon_position (left) the position of the icon, if present
+  #
+  # @option options [Boolean] :icon_invert (false) if the color of the icon
+  #         should be inverted or not
   def bs_button_to (*args, &block)
     RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :link, *args, &block).render
   end
@@ -21,11 +24,12 @@ module RailsBootstrapHelpers::Helpers::ButtonHelper
   #
   # @param url [String] the URL the button should link to
   # @param icon [String] the icon of the button
-  # @param options [Hash] a hash of options. See bs_button_to
+  # @param options [Hash] a hash of options. See {#bs_button_to}
   #
   # @see #bs_button_to
   def bs_inline_button_to (url, icon, options = {})
     options = options.reverse_merge icon: icon, size: "mini"
+    append_class!(options, "inline")
     RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :link, nil, url, options).render
   end
 
@@ -37,19 +41,87 @@ module RailsBootstrapHelpers::Helpers::ButtonHelper
   #
   # @param block [block] a block rendering the content of the popover
   #
-  # ==== Options
-  # @param :placement [String, "bottom", "top", "left", "right"]
+  # @option options [String, "bottom", "top", "left", "right"] :position the
+  #         position of the popover
+  #
+  # @see #bs_button_to
   def bs_popover_button (name, content_or_options = nil, options = {}, &block)
     if block_given?
       bs_popover_button(name, capture(&block).gsub("\n", ""), content_or_options || {})
     else
-      placement = options.delete(:placement) || "bottom"
+      options = options.deep_dup
+      placement = options.delete(:placement)
+
+      if placement
+        ActiveSupport::Deprecation.warn "Usage of the option `:placement` is deprecated. Please use the `:position` option instead"
+      end
+
+      position = options.delete(:position) || placement || "bottom"
 
       options = options.reverse_merge :"data-content" => content_or_options,
         :"data-toggle" => "popover",
-        :"data-placement" => placement
+        :"data-placement" => position
 
       bs_button_to(name, '#', options)
     end
   end
+
+  # Renders a collapsible Bootstrap button. That is, a button when clicked opens
+  # a collapsible section.
+  #
+  # @param text [String] the text of the button
+  # @param target [String] a selector matching the
+  # @param options [Hash] a hash of options. All options are passed straight
+  #        through to the underlying bs_button_to method.
+  #
+  # @see #bs_button_to
+  def bs_collapsible_button (text, target, options = {})
+    options = options.dup.reverse_merge :"data-toggle" => "collapse",
+      :"data-target" => target
+
+    bs_button_tag text, :button, options
+  end
+
+  # Returns a button group. That is, a div tag with the "btn-group" class.
+  #
+  # @param options [Hash] a hash of options.
+  #
+  # @option options [Boolean] :vertical (false) if true, appends
+  #         the "btn-group-vertical" class
+  #
+  # @option options [Boolean] :toolbar (false) if true, wraps the group in an
+  #         another group with the "btn-toolbar" class
+  #
+  # All other options are passed to the button group div.
+  def button_group (options = {}, &block)
+    if toolbar = options.delete(:toolbar)
+      append_class!(options, "btn-toolbar")
+    else
+      append_class!(options, "btn-group")
+      append_class!(options, "btn-group-vertical") if options.delete(:vertical)
+    end
+
+    content_tag(:div, options, &block)
+  end
+
+  # Renders a dropdown button.
+  #
+  # All options are passed to the underlying button.
+  #
+  # @param text [String] the text of the button
+  #
+  # @param url_or_options [String, Hash] if a string, the button will be rendered
+  #        as split dropdown button. This argument will be interpreted as the
+  #        URL of the button. If an Hash, it will be interpreted as the options
+  #        for the button an a normal dropdown button will be rendered.
+  #
+  # @param options [Hash] if the an URL is passed as the "url_or_options"
+  #        argument this will will be interpreted a hash of options. Otherwise
+  #        it will be ignored.
+  #
+  # @param block [Proc] the block should render a the dropdown menu items in the
+  #        form of list items with links.
+  def bs_dropdown_button_to (text, url_or_options = nil, options = {}, &block)
+    RailsBootstrapHelpers::Renderers::DropdownButtonRenderer.new(self, text, url_or_options, options, &block).render
+  end
 end

data/lib/rails-bootstrap-helpers/helpers/form_tag_helper.rb

@@ -2,21 +2,53 @@ module RailsBootstrapHelpers::Helpers::FormTagHelper
   # Renders a Bootstrap button tag. This method behaves just as
   # <tt>button_tag</tt> but will render a Bootstrap styled button tag instead.
   #
-  # @params text [String] the text of the button
+  # @params value [String] the text of the button
   # @params type [String, Symbol] the type of the button. Adds a "type"
   #         attribute to the tag
   #
   # @params options [Hash] a hash of options
   #
-  # ==== Options
-  # @param :style [String, Symbol] the style of the button
-  # @param :size ["large", "small", "mini"] the size of the button
-  # @param :disabled [Boolean] if the button should be disabled or not
-  # @param :icon [String] the name of an icon to render on the button
-  # @param :icon_position ["left", "right"] the post of the icon, if present
-  # @param :icon_invert [Boolean] if the color of the icon should be inverted
-  def bs_button_tag (value, type, options = {})
+  # @option options [String, Symbol] :style the style of the button
+  # @option options ["large", "small", "mini"] :size the size of the button
+  # @option options [Boolean] :disabled (false) if the button should be disabled or not
+  # @option options [String] :icon the name of an icon to render on the button
+  # @option options ["left", "right"] :icon_position ("left") the post of the icon, if present
+  # @option options [Boolean] :icon_invert (left) if the color of the icon should be inverted
+  def bs_button_tag (value, type, options = {}, &block)
     options = options.merge type: type
-    RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :button, value, options).render
+    RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :button, value, options, &block).render
+  end
+
+  # Renders a Boolean submit tag. This method behaves just as
+  # <tt>submit_tag</tt> but will render a Bootstrap styled submit tag instead.
+  #
+  # @param value [String] the text of the submit tag
+  # @param options [Hash] a hash of options
+  #
+  # @option options [String, Symbol] :style the style of the button
+  # @option options ["large", "small", "mini"] :size the size of the button
+  #
+  # All the other options are passed straight through to the underlying
+  # <tt>submit_tag</tt> method.
+  def bs_submit_tag (value, options = {})
+    options = options.dup
+
+    if options[:class].present?
+      options[:class] << " "
+    else
+      options[:class] = ""
+    end
+
+    options[:class] << "btn"
+
+    if style = options.delete(:style)
+      options[:class] << " btn-" + style.to_s
+    end
+
+    if size = options.delete(:size)
+      options[:class] << " btn-" + size.to_s
+    end
+
+    submit_tag value, options
   end
 end

data/lib/rails-bootstrap-helpers/helpers/navigation_helper.rb

@@ -0,0 +1,17 @@
+module RailsBootstrapHelpers::Helpers::NavigationHelper
+  include RailsBootstrapHelpers::Helpers::OptionsHelper
+
+  # Renders a Bootstrap tabbable navigation.
+  #
+  # @param args [Array<String>, Hash] an array of the names of the tab items.
+  #        If the last item is a Hash it's considered to be the options.
+  #
+  # @option options [Boolean] :bordered (false) if true, will render the tab
+  #         container with a border. This option requires the Jasny Bootstrap extensions.
+  #
+  # @option option [Bootstrap] :fade (false) if true, will add the "fade in"
+  #         class to all tab panes. This requires the bootstrap-transition.js file.
+  def tabbable (*args, &block)
+    RailsBootstrapHelpers::Renderers::TabbableRenderer.new(self, *args, &block).render
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/options_helper.rb

@@ -6,12 +6,11 @@ module RailsBootstrapHelpers::Helpers::OptionsHelper
   # @param options [Hash] a hash of options
   # @param html_options [Hash] a hash of HTML options/attributes
   #
-  # ==== Options
-  # @param :tooltip [String] the text of the tooltip. IF present adds attributes
+  # @option option [String] :tooltip the text of the tooltip. If present adds attributes
   #        for a Bootstrap tooltip. This will add the <tt>data-toggle="tooltip"</tt>
   #        and <tt>title="#{tooltip}" </tt> HTML attributes if not already present
   #
-  # @param :tooltip_location ["left", "right", "top", "bottom"] the position of
+  # @option options ["left", "right", "top", "bottom"] :tooltip_location the position of
   #        the tooltip if <tt>:tooltip</tt> is present. Adds the
   #        <tt>data-placement="#{tooltip_position}"</tt> HTML attribute if not
   #        already present.
@@ -29,4 +28,26 @@ module RailsBootstrapHelpers::Helpers::OptionsHelper
 
     options
   end
+
+  # Appends the given classes on the given options hash.
+  #
+  # It will look for both the "class" and :class key. This will create a new
+  # :class key in the given hash if neither exist.
+  #
+  # @param options [Hash] hash of options to append the classes to
+  # @param new_classes [Array<String>] the classes to append
+  # @return options
+  def append_class! (options, *new_classes)
+    return options if new_classes.empty?
+    key = options.key?("class") ? "class" : :class
+    cls = options[key].to_s || ""
+
+    if cls.present? && new_classes.first.present?
+      cls << " "
+    end
+
+    cls << new_classes.join(" ")
+    options[key] = cls
+    options
+  end
 end

data/lib/rails-bootstrap-helpers/helpers/tag_helper.rb

@@ -0,0 +1,26 @@
+module RailsBootstrapHelpers::Helpers::TagHelper
+  # Returns an HTML block tag. Properly adds indentation and newlines for the
+  # returned HTML.
+  #
+  # ==== Example
+  #   bs_content_tag "div", id: "foo" do
+  #     bs_content_tag "div"
+  #       append "foo"
+  #     end
+  #
+  #     append "bar"
+  #   end 
+  #
+  # <div id="foo">
+  #   <div>
+  #     foo
+  #   </div>
+  #   bar
+  # </div>
+  #
+  # @param [String] the name of the tag to render
+  # @param [Hash] a hash of HTML attributes
+  def bs_content_tag (name, options = {}, &block)
+    RailsBootstrapHelpers::Renderers::ContentTagRenderer.new(self, name, options, &block).render
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/url_helper.rb

@@ -0,0 +1,17 @@
+module RailsBootstrapHelpers::Helpers::UrlHelper
+  # Renders a Jasny Bootstrap action link. This method behaves just as "link_to"
+  # but will render a Jasny Bootstrap action link instead of a regular link.
+  # In addition to the options "link_to" handles, this method also handles the
+  # following options:
+  #
+  # @option options [String, Symbol] :style the style of the link
+  def action_link_to (*args, &block)
+    RailsBootstrapHelpers::Renderers::ActionLinkRenderer.new(self, *args, &block).render
+  end
+
+  # Renders a Jasny Bootstrap row link. This method behaves just as "link_to"
+  # but will render a Jasny Bootstrap row link instead of a regular link.
+  def row_link_to (*args, &block)
+    RailsBootstrapHelpers::Renderers::RowLinkRenderer.new(self, *args, &block).render
+  end
+end

data/lib/rails-bootstrap-helpers/rails/engine.rb

@@ -1,14 +1,16 @@
-#require "action"
-
 module RailsBootstrapHelpers
   module Rails
     class Engine < ::Rails::Engine
       initializer "rails-bootstrap-helpers.helpers" do
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::AccordionHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::UrlHelper
         ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::AlertHelper
         ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::BaseHelper
         ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::ButtonHelper
         ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::FormTagHelper
         ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::LabelHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::TagHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::NavigationHelper
       end
     end
   end