bh 1.1.1 → 1.2.0

data/lib/bh/helpers/link_to_helper.rb

@@ -1,48 +1,59 @@
-require 'bh/helpers/base_helper'
+require 'bh/classes/link_to'
+require 'bh/classes/alert_box'
+require 'bh/classes/dropdown'
+require 'bh/classes/nav'
+require 'bh/classes/stack'
+require 'bh/classes/vertical'
 
 module Bh
-  module LinkToHelper
-    include BaseHelper
-
-    # Overrides ActionView +link_to+ to be able to add the 'alert-link' class
-    # to the link in case the link is inside of an alert.
-    # @see http://getbootstrap.com/components/#alerts-links
-    # Overrides ActionView +link_to+ to be able to surround the link in a
-    # '<li>' item in case the link is inside of a nav.
-    # Overrides ActionView +link_to+ to be able to add the 'navbar-brand'
-    # class to the link in case the link is inside of an alert.
+  module Helpers
+    # Overrides `link_to` to display a Bootstrap-styled link.
+    # Can only be used in Ruby frameworks that provide the `link_to` method.
+    # @see http://getbootstrap.com/components/#dropdowns
+    # @see http://getbootstrap.com/components/#nav
+    # @see http://getbootstrap.com/components/#navbar-brand-image
+    # @see http://getbootstrap.com/components/#navbar-links
+    # @see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to
+    # @see http://www.rubydoc.info/github/padrino/padrino-framework/Padrino/Helpers/AssetTagHelpers#link_to-instance_method
+    # @return [String] the HTML to display a Bootstrap-styled link.
+    # @overload link_to(caption, url, options = {})
+    #   @param [#to_s] caption the caption to display in the link.
+    #   @param [#to_s] url the URL to link to.
+    #   @param [Hash] options the options for the original `link_to` method.
+    #   @example Display a plain-text link inside an alert-box.
+    #       alert_box do
+    #         link_to 'Check the terms and conditions', '/#terms'
+    #       end
+    # @overload button_to(url, options = {}, &block)
+    #   @param [#to_s] url the URL to link to (see above).
+    #   @param [Hash] options the options for the original `link_to` method.
+    #   @yieldreturn [#to_s] the caption to display in the link.
+    #   @example Display a link with HTML inside a dropdown.
+    #       dropdown 'Menu' do
+    #         link_to '/#terms' do
+    #           content_tag :strong, 'Check the terms and conditions'
+    #         end
+    #       end
     def link_to(*args, &block)
-      if @alert_link
-        super *add_link_class!('alert-link', *args, &block), &block
-      elsif @navbar_vertical
-        super *add_link_class!('navbar-brand', *args, &block), &block
-      elsif @dropdown_link
-        content_tag :li, role: :presentation do
-          super *add_menu_item_attributes!(*args, &block), &block
-        end
-      elsif @nav_link
-        content_tag :li, super(*args, &block), nav_item_options(*args, &block)
-      else
-        super *args, &block
-      end
-    end
-
-  private
+      link_to = Bh::LinkTo.new self, *args, &block
 
-    def add_link_class!(new_class, *args, &block)
-      append_class_as! :class, new_class, *args, &block
-    end
-
-    def nav_item_options(*args, &block)
-      options = (block_given? ? args[0] : args[1]) || {}
-      {class: 'active'} if current_page? options
-    end
+      link_to.append_class! :'alert-link' if Bh::Stack.find(Bh::AlertBox)
+      link_to.append_class! :'navbar-brand' if Bh::Stack.find(Bh::Vertical)
+      link_to.merge! role: :menuitem if Bh::Stack.find(Bh::Dropdown)
+      link_to.merge! tabindex: -1 if Bh::Stack.find(Bh::Dropdown)
+      html = super link_to.content, link_to.url, link_to.attributes, &nil
 
-    def add_menu_item_attributes!(*args, &block)
-      html_options = (block_given? ? args[1] : args[2]) || {}
-      html_options.reverse_merge! role: 'menuitem', tabindex: '-1'
-      block_given? ? args[1] = html_options : args[2] = html_options
-      args
+      if Bh::Stack.find(Bh::Dropdown)
+        container = Bh::Base.new(self) { html }
+        container.merge! role: :presentation
+        container.render_tag :li
+      elsif Bh::Stack.find(Bh::Nav)
+        container = Bh::Base.new(self) { html }
+        container.append_class! :active if link_to.current_page?
+        container.render_tag :li
+      else
+        html
+      end
     end
   end
-end
+end

data/lib/bh/helpers/modal_helper.rb

@@ -1,85 +1,55 @@
-require 'bh/helpers/base_helper'
+require 'bh/classes/modal'
 
 module Bh
-  # Provides methods to include modals.
-  # @see http://getbootstrap.com/javascript/#modals
-  module ModalHelper
-    include BaseHelper
-
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display *modals*.
-    #
-    # The content of the modal 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 modal with plain-text content passed as the first parameter.
-    #   modal 'Your profile was updated!', context: :info, title: 'Profile'
-    # @example A panel with HTML content passed as a block.
-    #   modal context: :info, title: 'Profile' do
-    #     content_tag :div, "Your profile was updated!", class: 'modal-footer'
-    #   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] :title ('Modal') the title to display inside the modal.
-    # @option options [#to_s] :body if present, the panel will include the
-    #   provided text wrapped in a 'modal-body' block, for proper padding
-    # @option options [#to_s] :size the size of the modal.
-    # @option options [Hash] :button the options for the "toggle" button.
-    #   * :caption (#to_s) ('Modal') the caption for the "toggle" button.
-    #   * :context (#to_s) (:default) the context for the "toggle" button,
-    #     which determines the button color
-    #   * :size (#to_s) the size of the "toggle" button.
+  module Helpers
+    # Displays a Bootstrap-styled modal.
     # @see http://getbootstrap.com/javascript/#modals
-    def modal(content_or_options_with_block = nil, options = nil, &block)
-      if block_given?
-        modal_string content_or_options_with_block, &block
-      elsif content_or_options_with_block.is_a?(Hash) && options.nil?
-        modal_string content_or_options_with_block, &Proc.new { nil }
-      else
-        modal_string options, &Proc.new { content_or_options_with_block }
-      end
-    end
-
-  private
-
-    def modal_string(options = nil, &block)
-      options ||= {}
-      options[:id] ||= "modal-#{rand 10**10}"
-      options[:title] ||= 'Modal'
-      options[:body] = modal_body options[:body]
-      options[:dialog_class] ||= dialog_class options[:size]
-      options[:button] ||= {}
-      options[:button][:caption] ||= options[:title]
-      options[:button][:class] ||= button_class options[:button]
-      render layout: 'bh/modal', locals: options, &block
-    end
-
-    def button_class(options = {})
-      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'
-        when 'sm', 'small' then 'btn-sm'
-        when 'xs', 'extra_small' then 'btn-xs'
-      end
-
-      ['btn', "btn-#{context}", size].compact.join ' '
-    end
-
-    def dialog_class(size = nil)
-      size_class = case size.to_s
-        when 'lg', 'large' then 'modal-lg'
-        when 'sm', 'small' then 'modal-sm'
-      end
-      ['modal-dialog', size_class].compact.join ' '
-    end
-
-    def modal_body(body = nil)
-      content_tag :div, body, class: 'modal-body' if body
+    # @return [String] the HTML to display a Bootstrap-styled modal.
+    # @overload modal(body, options = {})
+    #   @param [#to_s] body the content to display as the modal body.
+    #   @param [Hash] options the options for the modal. Any option not listed
+    #     below is ignored, except for `:id` which is passed as an HTML
+    #     attribute to the modal’s `<div>`.
+    #   @option options [#to_s] :title ('Modal') the title of the modal.
+    #   @option options [#to_s] :body the content to display as the modal body.
+    #     Using this option is equivalent to passing the body as an argument.
+    #   @option options [#to_s] :size the size of the modal. Can be `:large`
+    #     (alias `:lg`) or `:small` (alias `:sm`).
+    #   @option options [Hash] :button the options for the toggle button.
+    #     * :caption (#to_s) ('Modal') the caption of the toggle button.
+    #     * :context (#to_s) (:default) the contextual alternative to apply to
+    #        the toggle button. Can be `:danger`, `:info`, `:link`, `:primary`,
+    #       `:success` or `:warning`.
+    #     * :size (#to_s) the size of the toggle button. Can be `:extra_small`
+    #       (alias `:xs`), `:large` (alias `:lg`) or `:small` (alias `:sm`).
+    #     * :layout (#to_s) if set to `:block`, span the button for the full
+    #       width of the parent.
+    #   @example Display a simple modal toggled by a blue button.
+    #       modal 'You clicked me!', title: 'Click me', button: {context: :info}
+    # @overload modal(options = {}, &block)
+    #   @param [Hash] options the options for the modal (see above).
+    #   @yieldreturn [#to_s] the content to display in the modal.
+    #   @example Display a modal with HTML content.
+    #       modal title: 'Click me' do
+    #         content_tag :div, class: 'modal-body' do
+    #           content_tag :em, 'You clicked me!'
+    #         end
+    #       end
+    def modal(*args, &block)
+      modal = Bh::Modal.new self, *args, &block
+      modal.extract! :button, :size, :body, :title, :id
+
+      modal.extract_from :button, [:context, :size, :layout, :caption]
+      modal.append_class_to! :button, :btn
+      modal.append_class_to! :button, modal.button_context_class
+      modal.append_class_to! :button, modal.button_size_class
+      modal.merge! button: {caption: modal.caption}
+
+      modal.append_class_to! :div, :'modal-dialog'
+      modal.append_class_to! :div, modal.dialog_size_class
+      modal.merge! div: {title: modal.title, id: modal.id}
+
+      modal.render_partial 'modal'
     end
   end
 end

data/lib/bh/helpers/nav_helper.rb

@@ -1,51 +1,36 @@
-require 'bh/helpers/base_helper'
+require 'bh/classes/nav'
+require 'bh/classes/navbar'
 
 module Bh
-  # Provides methods to include navs.
-  # @see http://getbootstrap.com/components/#nav
-  module NavHelper
-    include BaseHelper
-
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display *navs*.
-    #
-    # The skeleton of the nav is an unordered list; its content is passed as a
-    # block as a list of navigation items.
-    # Since the most common use for a nav is to display a menu of links, a
-    # variable is set inside the block so that every call to +link_to+
-    # generates a link *surrounded by a list item*.
-    # @example An justified nav with two links.
-    #   nav layout: :justified do
+  module Helpers
+    # Displays a Bootstrap-styled nav.
+    # @see http://getbootstrap.com/components/#nav
+    # @return [String] the HTML to display a Bootstrap-styled nav.
+    # @param [Hash] options the options for the nav. Any option not listed below
+    #   is passed as an HTML attribute to the alert’s `<ul>`.
+    # @option options [#to_s] :as (:tabs) the style of the nav. Can be `:tabs`
+    #   or `:pills`.
+    # @option options [#to_s] :layout the layout of the nav. Can be
+    #   `:justified` or `:stacked`.
+    # @yieldreturn [#to_s] the content to display in the nav.
+    # @example Display a pills-styled nav with a link.
+    #   nav as: :pills do
     #     link_to 'Home', '/'
-    #     link_to 'Profile', '/profile'
     #   end
-    #
-    # @return [String] an HTML block tag for a nav.
-    # @param [Hash] options the display options for the nav.
-    # @option options [#to_s] :as ('tabs') the style to use for the nav.
-    #   Valid values are: :tabs and :pills.
-    # @option options [#to_s] :layout (nil) if set, the layout of the nav.
-    #   Valid values are: :justified and :stacked.
-    # @yield block the content of the nav
-    # @see http://getbootstrap.com/components/#nav
     def nav(options = {}, &block)
-      @nav_link = true
-      nav = content_tag :ul, nav_options(options), &block
-      nav.tap{ @nav_link = false }
-    end
-
-  private
+      nav = Bh::Nav.new(self, options, &block)
+      nav.extract! :as, :layout
 
-    def nav_options(options = {})
-      append_class! options, 'nav'
-      if @navbar_id
-        append_class! options, 'navbar-nav'
+      nav.append_class! :nav
+      if Bh::Stack.find(Bh::Navbar)
+        nav.append_class! :'navbar-nav'
       else
-        options[:role] = 'tablist'
-        append_class! options, "nav-#{options.fetch :as, 'tabs'}"
-        append_class! options, "nav-#{options[:layout]}" if options[:layout]
+        nav.merge! role: :tablist
+        nav.append_class! nav.style_class
+        nav.append_class! nav.layout_class
       end
-      options.slice :role, :class
+
+      nav.render_tag :ul
     end
   end
 end

data/lib/bh/helpers/navbar_helper.rb

@@ -1,182 +1,48 @@
-require 'bh/helpers/base_helper'
+require 'bh/helpers/horizontal_helper'
+require 'bh/helpers/vertical_helper'
 
 module Bh
-  # Provides methods to include navbars.
-  # @see http://getbootstrap.com/components/#navbar
-  module NavbarHelper
-    include BaseHelper
-
-    # Returns an HTML block tag that follows the Bootstrap documentation
-    # on how to display *navbars*.
-    #
-    # The skeleton of the nav is a <div> container inside a <nav> tag; its
-    # content is passed as a block.
-    #
-    # Bootstrap allows to differentiate between the content of a navtab that
-    # should remain visible even on a mobile (in a 'vertical' layout) and the
-    # content that should only be visible when there is enough horizontal space
-    # (in a 'horizontal') layout.
-    #
-    # The +vertical+ and +horizontal+ helpers can be used inside a navbar to
-    # specify these types of content.
-    # @example An inverted navbar with the company logo and two links.
-    #   navbar inverted: false do
-    #     vertical image_tag('logo')
-    #     horizontal nav do
-    #       link_to 'Home', '/'
-    #       link_to 'Profile', '/profile'
-    #     end
-    #   end
-    #
-    # @return [String] an HTML block tag for a navbar.
-    # @param [Hash] options the display options for the nav.
+  module Helpers
+    # Displays a Bootstrap-styled navbar.
+    # @see http://getbootstrap.com/components/#navbar
+    # @return [String] the HTML to display a Bootstrap-styled navbar.
+    # @param [Hash] options the options for the navbar. Any option not listed
+    #   below is ignored, except for `:id` which is passed as an HTML
+    #   attribute to the navbar’s collapsable `<div>`.
     # @option options [Boolean] :fluid (false) whether to use a fluid container
     #   to surround the navbar content.
     # @option options [Boolean] :inverted (false) whether to use an inverted
     #   palette of colors.
-    # @option options [#to_s] :position (nil) if set, the position of the
-    #   navbar. Valid values are: :top (alias :fixed_top), :bottom
-    #   (alias :fixed_bottom) and :static (alias :static_top).
+    # @option options [#to_s] :position the position of the navbar. Can be
+    #   `:top` (alias `:fixed_top`), `:bottom` (alias `:fixed_bottom`) or
+    #   `:static` (alias `:static_top`).
     # @option options [#to_s] :padding (70) if position is set to :top or
-    #   :bottom, then this padding will be added at the top (or bottom) of
-    #   <body> to prevent the navbar from overlaying the content.
-    # @yield block the content of the nav
-    # @see http://getbootstrap.com/components/#navbar
+    #   :bottom, the padding to at the top (or bottom) of <body> to prevent the
+    #   navbar from overlaying the content.
+    # @yieldreturn [#to_s] the content to display in the navbar.
+    # @example Display an inverted navbar with three links.
+    #   navbar inverted: true do
+    #     vertical do
+    #       image_tag('logo')
+    #     end
+    #     horizontal do
+    #       nav do
+    #         link_to 'Home', '/'
+    #         link_to 'Profile', '/profile'
+    #       end
+    #     end
+    #   end
     def navbar(options = {}, &block)
-      @navbar_id = rand 10**7
-      nav_tag = navbar_string options, &block
-      navbar = safe_join [navbar_style_tag(options), nav_tag].compact, "\n"
-      navbar.tap{ @navbar_id = nil }
-    end
-
-    def vertical(content_or_options_with_block = nil, options = nil, &block)
-      if block_given?
-        vertical_string (content_or_options_with_block || {}), &block
-      else
-        vertical_string (options || {}), &Proc.new { content_or_options_with_block }
-      end
-    end
-
-    def horizontal(content_or_options_with_block = nil, options = nil, &block)
-      if block_given?
-        horizontal_string (content_or_options_with_block || {}), &block
-      else
-        horizontal_string (options || {}), &Proc.new { content_or_options_with_block }
-      end
-    end
-
-  private
-
-    def navbar_string(options = {}, &block)
-      content_tag :nav, role: 'navigation', class: navbar_class(options) do
-        content_tag :div, class: navbar_container_class(options), &block
-      end
-    end
-
-    # @private
-    # The fixed navbar will overlay your other content, unless you add padding
-    # to the top or bottom of the <body>. Try out your own values or use our
-    # snippet below. Tip: By default, the navbar is 50px high.
-    # @see http://getbootstrap.com/components/#navbar-fixed-top
-    def navbar_style_tag(options = {})
-      padding_value = options.fetch :padding, 70
-      if padding_value && padding_type = padding_type_for(options[:position])
-        content_tag :style, "body {padding-#{padding_type}: #{padding_value}px}"
-      end
-    end
-
-    def padding_type_for(position)
-      /fixed-(?<type>top|bottom)$/ =~ navbar_position_class_for(position)
-      type
-    end
+      navbar = Bh::Navbar.new(self, options, &block)
+      navbar.extract! :inverted, :position, :padding, :fluid, :id
 
-    # Yields the block as the vertical part of the navbar and sets a variable
-    # so that every +link_to+ helper called inside the block gets the
-    # "navbar-brand" class added, for links to look better.
-    def vertical_string(options = {}, &block)
-      @navbar_vertical = true
-      append_class! options, 'navbar-header'
-      vertical = content_tag :div, options do
-        safe_join [toggle_button, capture(&block)], "\n"
-      end
-      vertical.tap{ @navbar_vertical = false }
-    end
-
-    def horizontal_string(options = {}, &block)
-      append_class! options, 'collapse navbar-collapse'
-      options[:id] = navbar_id
-      content_tag :div, options, &block
-    end
-
-    def toggle_button(options = {})
-      options['type'] = 'button'
-      options['class'] = 'navbar-toggle'
-      options['data-toggle'] = 'collapse'
-      options['data-target'] =  "##{navbar_id}"
-      content_tag :button, options do
-        safe_join [toggle_text, toggle_bar, toggle_bar, toggle_bar], "\n"
-      end
-    end
-
-    def toggle_text
-      content_tag :span, 'Toggle navigation', class: 'sr-only'
-    end
-
-    def toggle_bar
-      content_tag :span, nil, class: 'icon-bar'
-    end
-
-  private
+      navbar.append_class_to! :navigation, :navbar
+      navbar.append_class_to! :navigation, navbar.style_class
+      navbar.append_class_to! :navigation, navbar.position_class
+      navbar.append_class_to! :div, navbar.layout_class
+      navbar.prepend_html! navbar.body_padding_style
 
-    def navbar_id
-      "navbar-collapse-#{@navbar_id}"
-    end
-
-    def navbar_class(options = {})
-      style = options[:inverted] ? 'inverse' : 'default'
-      position = navbar_position_class_for options[:position]
-      append_class! options, 'navbar'
-      append_class! options, "navbar-#{style}"
-      append_class! options, "navbar-#{position}" if position
-      options[:class]
-    end
-
-    def navbar_position_class_for(position)
-      case position.to_s
-        when 'static', 'static_top' then 'static-top'
-        when 'top', 'fixed_top' then 'fixed-top'
-        when 'bottom', 'fixed_bottom' then 'fixed-bottom'
-      end
-    end
-
-    def navbar_container_class(options = {})
-      options[:fluid] ? 'container-fluid' : 'container'
+      navbar.render_partial 'navbar'
     end
   end
-end
-
-
-# STILL TO DO
-# 2) Add class to form and button and nav and p inside navbar
-
-
-#
-# <%= navbar do %>
-#   <%= vertical do %>
-#     <%= link_to image_tag('/assets/fullscreen-standard-logo-white.png', alt: 'Fullscreen'), root_path %>
-#   <% end %>
-#   <%= horizontal do %>
-#     <%= nav do %>
-#       <%= link_to 'Campaigns', root_path %>
-#       <%= link_to 'Users', users_path if current_user.admin? %>
-#     <% end %>
-#     <%= nav class: 'navbar-right' do %>
-#       <!-- button_to needs to:
-#            * be surrounded in <li> AND use navbar-form inside a navbar
-#            * add navbar-btn is inside a navbar, else add btn
-#       -->
-#       <%= button_to 'Sign out', destroy_user_session_path, class: 'btn-link', method: :delete %>
-#     <% end %>
-#   <% end %>
-# <% end if user_signed_in? %>
-#
+end