bootstrap3_helper 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e356782b2f424f78b9bd3731009d7ba7a1492a392e782c5cade487ea765a26
-  data.tar.gz: 7a8fb76f39fa53b9bdcebf6542239c58448e8caa88b725b5f47c4255ad31d80f
+  metadata.gz: fa4a4982f3b39160bbef89613d224a4445460f48f7c57493f13b2e716a762c27
+  data.tar.gz: d896ed4c7700a1d4be61432c016790de7774a8fef92b3942a5c9e43f8b45531e
 SHA512:
-  metadata.gz: 71bad603e6cf3834f68c6f216e1dcc3c0b0e88f76ef4a44c05bc9f101d4eba4271a9312caee0500ae2e317e35485ee9fdd214dc807c4d42422eb9a4acc090c20
-  data.tar.gz: 8f062f014b468ba1b8fb916666556a69b3ddb03cfa9e024738babe7480ffcb4ad55f3507672d69b98abcb55251c4d3ae664f6055bbca1cf2c7de9d21440fb632
+  metadata.gz: a69b36f433d89b6003e8b7662dc3b2c0eae7b1d2e2241eb87aa8b168f3cd15cd48acf0b55e893c44366ba311bb48ce5e20ceb3595b4b57ebce58e64d52f5d2f6
+  data.tar.gz: bfb6e3bb9c1472159609be87b92aff76e7bc28c40249a2b721610acbb3a002d8118b290f2bc006e2b595a0bf0cfdf86616795318cab1dd47070abb51c456262f

data/README.md

@@ -1,4 +1,4 @@
-# Bootstrap3Helper
+# Bootstrap 3 Helper
 
 This gem was designed to help you rapidly build common Bootstrap 3 Components. They where designed to very flexible and reduce a lot of boiler plate HTML.
 
@@ -79,7 +79,7 @@ end
         <%= accordion.body do %>
             <p>This is accordion 1</p>
         <% end %>
-    <%end %>
+    <% end %>
     <% g.accordion :info do |accordion| %>
         <%= accordion.header { "Accordion 2" } %>
         <%= accordion.body do %>
@@ -91,7 +91,7 @@ end
         <%= accordion.body do %>
             <p>This is accordion 3</p>
         <% end %>
-    <%end %>
+    <% end %>
 <% end %>
 ```
 
@@ -99,7 +99,7 @@ end
 
 ---
 
-`Panel Helper`
+`Tab Helper`
 
 ```erb
 <%= tabs_helper type: :pills do |menu, content| %>

data/lib/bootstrap3_helper.rb

@@ -13,15 +13,13 @@ require 'bootstrap3_helper/tabs/dropdown'
 require 'bootstrap3_helper/tabs/menu'
 require 'bootstrap3_helper/railtie'
 
-# @description
-# - This helper module includes UI helpers that will help generate
+# This helper module includes UI helpers that will help generate
 # common Bootstrap components.
 #
 module Bootstrap3Helper
-  # @description
-  # - Allows you to rapidly build Panel components.
+  # Allows you to rapidly build Panel components.
   #
-  # <code>
+  # @example Bootstrap Panel Component:
   #   <%= panel_helper :primary do |p| %>
   #     <%= p.header { "Some Title" }
   #     <%= p.body class: 'custom-class', id: 'custom-id' do %>
@@ -31,53 +29,46 @@ module Bootstrap3Helper
   #       //HTML or Ruby
   #     <% end %>
   #   <% end %>
-  # </code>
   #
-  # @params [Symbol|String|Hash|NilClass] *args
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldparam [Panel] panel
   # @return [String]
   #
-  def panel_helper(*args)
-    panel = Panel.new(self, *args)
-    capture { yield(panel) if block_given? }
-    panel
+  def panel_helper(*args, &block)
+    Panel.new(self, *args, &block)
   end
 
-  # @description
-  # - Creates an Alert component.
+  # Creates an Alert component.
   #
-  # <code>
+  # @example Bootstrap Alert Component:
   #   <%= alert_helper :danger, dismissble: true do %>
   #     Something went wrong with your model data...
   #   <% end %>
-  # </code>
   #
-  # @params [Symbol|String|Hash|NilClass] *args
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldreturn [String]
   # @return [String]
   #
   def alert_helper(*args, &block)
-    alert = Alert.new(self, *args, &block)
-    alert
+    Alert.new(self, *args, &block)
   end
 
-  # @description
-  # - Creates an Callout component.
+  # Creates an Callout component.
   #
-  # <code>
+  # @example Bootstrap Callout Component:
   #   <%= callout_helper :danger %>
   #     Some information that needs your attention...
   #   <% end %>
-  # </code>
   #
-  # @params [Symbol|String|Hash|NilClass] *args
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldreturn [String]
   # @return [String]
   #
   def callout_helper(*args, &block)
-    callout = Callout.new(self, *args, &block)
-    callout
+    Callout.new(self, *args, &block)
   end
 
-  # @description
-  # - Just a easy way of checking if the environment is a devbox
+  # Just a easy way of checking if the environment is a devbox
   # or a server.
   #
   # @return [Boolean]
@@ -86,79 +77,68 @@ module Bootstrap3Helper
     Rails.root.to_s.include?('home')
   end
 
-  # @description
-  # - Easily build a bootstrap accordion group component.
+  # Easily build a bootstrap accordion group component.
   #
-  # @note
-  # - All the element ids and data attributes needed to make the javascript
-  # function, are all synced up in the AccordionGroup and Accordion classes.
-  # You don't need to worry about them :)
+  # @note All the element ids and data attributes needed to make the javascript
+  #   function, are all synced up in the AccordionGroup and Accordion classes.
+  #   You don't need to worry about them.
   #
-  # <code>
+  # @example Bootstrap Accordion Group Component:
   #   <%= accordion_group_helper do |group| %>
   #     <% group.accordion class: 'primary' do |accordion| %>
   #         <%= accordion.header { "accordion 1" } %>
   #         <%= accordion.body do %>
   #             <p>This is accordion 1</p>
   #         <% end %>
-  #     <%end %>
+  #     <% end %>
   #     <% group.accordion class: 'info' do |accordion| %>
   #         <%= accordion.header { "accordion 2" } %>
   #         <%= accordion.body do %>
   #             <p>This is accordion 2</p>
   #         <% end %>
-  #     <%end %>
+  #     <% end %>
   #     <% group.accordion class: 'danger' do |accordion| %>
   #         <%= accordion.header { "accordion 3" } %>
   #         <%= accordion.body do %>
   #             <p>This is accordion 3</p>
   #         <% end %>
-  #     <%end %>
+  #     <% end %>
   #   <% end %>
-  # </code>
   #
-  # @yields [AccordionGroup] group
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldparam [AccordionGroup] group
   # @return [String]
   #
-  def accordion_group_helper(*args)
-    group = AccordionGroup.new(self, *args)
-    capture { yield group if block_given? }
-    group
+  def accordion_group_helper(*args, &block)
+    AccordionGroup.new(self, *args, &block)
   end
 
-  # @description
-  # - Easily build a bootstrap accordion component
-  #
-  #   <code>
-  #     <%= accordion_helper class: 'primary' do |accordion| %>
-  #         <%= accordion.header do %>
-  #             <span class="something">This is the heading....</span>
-  #         <% end %>
-  #         <%= accordion.body do %>
-  #             <p>This is the body of the accordion....</p>
-  #         <% end %>
-  #     <% end %>
-  #   </code>
+  # Easily build a bootstrap accordion component
+  #
+  # @example Bootstrap Panel Component:
+  #   <%= accordion_helper class: 'primary' do |accordion| %>
+  #       <%= accordion.header do %>
+  #           <span class="something">This is the heading....</span>
+  #       <% end %>
+  #       <%= accordion.body do %>
+  #           <p>This is the body of the accordion....</p>
+  #       <% end %>
+  #   <% end %>
   #
-  # @params [Symbol|String|Hash|NilClass] *args
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldparam [Accordion] accordion
   # @return [String]
   #
-  def accordion_helper(*args)
-    accordion = Accordion.new(self, *args)
-    capture { yield accordion if block_given? }
-    accordion
+  def accordion_helper(*args, &block)
+    Accordion.new(self, *args, &block)
   end
 
-  # @description
-  # - Allows you to rapidly build bootstrap glyphs.
+  # Allows you to rapidly build bootstrap glyphs.
   #
-  # @note
-  # - Only supply the last part of the glyph makrup.
+  # @note Only supply the last part of the glyph makrup.
   #
-  # <code>
-  #   <span class"glyphicon glyphicon-pencil"></span>
+  # @example Bootstrap Glyphicon Component:
   #   <%= icon_helper('pencil') %>
-  # </code>
   #
   # @param [String|Symbol] name
   #
@@ -166,54 +146,52 @@ module Bootstrap3Helper
     content_tag :span, '', class: "glyphicon glyphicon-#{name}"
   end
 
-  # @description
-  # - Used to rapidly build Tabs.
-  #
-  # @note
-  # - On menu items - you can pass in either symbol or string for the link. If
-  # you pass in a block, it will use the block for the title of the li.  If no
-  # block is present, then it will titleize the symbol or string.
-  #
-  # Tabs::Menu will respond to <code>item</code> and <code>dropdown</code>
-  # Each method will yield the corresponding component, either a Tabs::Menu
-  # or a Tabs::Dropdown.
-  #
-  # <code>
-  #  <%= tabs_helper type: :pills do |menu, content| %>
-  #    <% menu.item(:testing1, class: 'active') { ' Testing 1' } %>
-  #    <% menu.item :testing2 %>
-  #    <% menu.item(:testing3) { ' Testing 3' } %>
-  #    <% menu.dropdown 'Testing Dropdown' do |dropdown| %>
-  #        <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
-  #        <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
-  #        <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
-  #    <% end %>
-  #
-  #
-  #    <% content.item :testing1, class: 'active' do %>
-  #        Testing 1 content
-  #    <% end %>
-  #    <% content.item :testing2 do %>
-  #        Testing 2 content
-  #    <% end %>
-  #    <% content.item :testing3 do %>
-  #        Testing 3 content
-  #    <% end %>
-  #    <% content.item :testing5 do %>
-  #        Testing 5 content
-  #    <% end %>
-  #    <% content.item :testing6 do %>
-  #        Testing 6 content
-  #    <% end %>
-  #    <% content.item :testing7 do %>
-  #        Testing 7 content
-  #    <% end %>
-  #  <% end %>
-  # </code>
-  #
-  def tabs_helper(args = {})
-    tabs = Tabs.new(self, args)
-    capture { yield(tabs.menu, tabs.content) if block_given? }
-    tabs
+  # Used to rapidly build Tabs.
+  #
+  # @note On menu items - you can pass in either symbol or string for the link. If
+  #   you pass in a block, it will use the block for the title of the li.  If no
+  #   block is present, then it will titleize the symbol or string.
+  #   Tabs::Menu will respond to <code>item</code> and <code>dropdown</code>
+  #   Each method will yield the corresponding component, either a Tabs::Menu
+  #   or a Tabs::Dropdown.
+  #
+  # @example Bootstrap Tabs Component:
+  #   <%= tabs_helper type: :pills do |menu, content| %>
+  #     <%= menu.item(:testing1, class: 'active') { ' Testing 1' } %>
+  #     <%= menu.item :testing2 %>
+  #     <%= menu.item(:testing3) { ' Testing 3' } %>
+  #     <%= menu.dropdown 'Testing Dropdown' do |dropdown| %>
+  #         <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
+  #         <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
+  #         <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
+  #     <% end %>
+  # 
+  # 
+  #     <%= content.item :testing1, class: 'active' do %>
+  #         Testing 1 content
+  #     <% end %>
+  #     <%= content.item :testing2 do %>
+  #         Testing 2 content
+  #     <% end %>
+  #     <%= content.item :testing3 do %>
+  #         Testing 3 content
+  #     <% end %>
+  #     <%= content.item :testing5 do %>
+  #         Testing 5 content
+  #     <% end %>
+  #     <%= content.item :testing6 do %>
+  #         Testing 6 content
+  #     <% end %>
+  #     <%= content.item :testing7 do %>
+  #         Testing 7 content
+  #     <% end %>
+  #   <% end %>
+  #
+  # @param  [Symbol|String|Hash|NilClass] args
+  # @yieldparam [Tabs] tabs
+  # @return [String]
+  #
+  def tabs_helper(args = {}, &block)
+    Tabs.new(self, args, &block)
   end
 end

data/lib/bootstrap3_helper/accordion.rb

@@ -1,42 +1,34 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - Used to generate Bootstrap Accordion objects.
+module Bootstrap3Helper # :nodoc:
+  # Used to generate Bootstrap Accordion objects.
   #
-  #  <code>
-  #    <%= accordion_helper :primary do |accordion| %>
-  #        <%= accordion.header do %>
-  #            <span class="something">This is the heading....</span>
-  #        <% end %>
-  #        <%= accordion.body do %>
-  #            <p>This is the body of the accordion....</p>
-  #        <% end %>
-  #    <% end %>
-  #  </code>
+  # @example Render out an Accordion component in a template:
+  #   <code>
+  #     <%= accordion_helper :primary do |accordion| %>
+  #         <%= accordion.header do %>
+  #             <span class="something">This is the heading....</span>
+  #         <% end %>
+  #         <%= accordion.body do %>
+  #             <p>This is the body of the accordion....</p>
+  #         <% end %>
+  #     <% end %>
+  #   </code>
   #
   class Accordion < Component
-    # @description
-    # - Initlize a new accordion object.  If this part of a parent element, i.e
+    # Initlize a new accordion object.  If this part of a parent element, i.e
     # AccordionGroup, we need to keep track of the parent element id, so we can
     # pass it down to the other components.
     #
     # @param [Class] template - Template in which your are binding too.
     # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
     # @param [Hash] opts
-    #   <code>
-    #      args = {
-    #        parent_id:   [String]
-    #        id:          [String]
-    #        class:       [String]
-    #        collapse_id: [String]
-    #        expanded:    Boolean
-    #      }
-    #   </code>
+    # @option opts [String]  :parent_id   The parent element ID if this accordion is part of a group.
+    # @option opts [String]  :id          The ID of the element
+    # @option opts [String]  :class       Custom class for the component.
+    # @option opts [String]  :collapse_id The ID of the element to collapse when clicked.
+    # @option opts [Boolean] :expanded    Initial state of the accordion.
     # @return [Accordion]
     #
-    def initialize(template, context_or_options = nil, opts = {})
+    def initialize(template, context_or_options = nil, opts = {}, &block)
       super(template)
       @context, args = parse_arguments(context_or_options, opts)
 
@@ -45,127 +37,81 @@ module Bootstrap3Helper
       @class       = args.fetch(:class, '')
       @collapse_id = args.fetch(:collapse_id, uuid)
       @expanded    = args.fetch(:expanded, false)
+      @content     = block || proc { '' }
+      @panel       = Panel.new(@template, context_or_options, opts)
     end
 
-    # @description
-    # - Creates the header element for the accordion
+    # rubocop:disable Metrics/MethodLength
+
+    # Creates the header element for the accordion
     #
-    # @note
-    # - NilClass :to_s  returns an empty String
+    # @note NilClass :to_s  returns an empty String
     #
     # @params [Hash] args
-    #   <code>
-    #      args = {
-    #        id:      [String]
-    #        class:   [String]
-    #        data:    [Hash]
-    #      }
-    #   </code>
-    #
-    # @yields [Accordion] self
-    # @return [NilClass]
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @yieldreturn [String]
     #
-    # rubocop:disable Metrics/MethodLength
-    def header(args = {})
-      id     = args.fetch(:id, nil)
-      klass  = args.fetch(:class, '')
-      data   = args.fetch(:data, {})
-
+    def header(args = {}, &block)
+      data          = args.fetch(:data, {})
       data[:toggle] = 'collapse'
-      data[:parent] = "##{@parent_id}"
+      data[:parent] = "##{@parent_id}" if @parent_id.present?
 
-      @header = content_tag(
-        :div,
-        id:    id,
-        role:  'tab',
-        class: 'panel-heading ' + klass
-      ) do
-        content_tag :h3, class: 'panel-title' do
-          content_tag(
-            :a,
-            href: "##{@collapse_id}",
-            role: 'button',
-            data: data,
-            aria: { expanded: @expanded, controls: "##{@collapse_id}" }
-          ) do
-            content = yield if block_given?
-            content.to_s.html_safe
-          end
-        end
+      @panel.header(args) do
+        content_tag(
+          :a,
+          href: "##{@collapse_id}",
+          role: 'button',
+          data: data,
+          aria: { expanded: @expanded, controls: "##{@collapse_id}" },
+          &block
+        )
       end
     end
     # rubocop:enable Metrics/MethodLength
 
-    # @description
-    # - Creates the body element for the accordion.
+    # rubocop:disable Metrics/MethodLength
+
+    # Creates the body element for the accordion.
     #
-    # @note
-    # - NilClass :to_s  returns an empty String
+    # @note NilClass :to_s  returns an empty String
     #
     # @params [Hash] args
-    #   <code>
-    #      args = {
-    #        id:      [String]
-    #        class:   [String]
-    #        data:    [Hash]
-    #      }
-    #   </code>
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @yieldreturn [String]
     #
-    # @yields [Accordion] self
-    # @return [nilClass]
-    #
-    #
-    # rubocop:disable Metrics/MethodLength
-    def body(args = {})
+    def body(args = {}, &block)
       klass = 'panel-collapse collapse '
-      data  = args.fetch(:data, {})
-      klass += args.fetch(:class, '')
       klass += ' in' if @expanded
 
-      @body = content_tag(
+      content_tag(
         :div,
         id:    @collapse_id,
         role:  'tabpanel',
         class: klass,
         aria:  { labelledby: "##{@collapse_id}" }
       ) do
-        content_tag :div, class: 'panel-body', data: data do
-          content = yield if block_given?
-          content.to_s.html_safe
-        end
+        @panel.body(args, &block)
       end
     end
     # rubocop:enable Metrics/MethodLength
 
-    # @description
-    # - Creates the footer element for the accordion
+    # Creates the footer element for the accordion
     #
     # @params [Hash] args
-    #   <code>
-    #      args = {
-    #        id:      [String]
-    #        class:   [String]
-    #        data:    [Hash]
-    #      }
-    #   </code>
-    #
-    # @yields [Accordion] self
-    # @return [nilClass]
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @yieldreturn [String]
     #
-    #
-    def footer(args = {})
-      id    = args.fetch(:id, nil)
-      klass = args.fetch(:class, '')
-      data  = args.fetch(:data, {})
-
-      @footer = content_tag :div, id: id, class: 'panel-footer ' + klass, data: data do
-        content = yield if block_given?
-        content.to_s.html_safe
-      end
+    def footer(args = {}, &block)
+      @panel.footer(args, &block)
     end
 
-    # @description
-    # - The to string method here is what is responsible for rendering out the
+    # The to string method here is what is responsible for rendering out the
     # accordion element.  As long as the main method is rendered out in the
     # helper, you will get the entire accordion.
     #
@@ -173,16 +119,13 @@ module Bootstrap3Helper
     #
     def to_s
       content = content_tag :div, id: @id, class: container_classes do
-        @header + @body + @footer
+        @content.call(self)
       end
-
-      content
     end
 
     private
 
-    # @description
-    # - Used to get the container element classes
+    # Used to get the container element classes
     #
     # @return [String]
     #