bootstrap3_helper 1.0.1 → 2.0.0

data/lib/bootstrap3_helper/tabs.rb

@@ -1,103 +1,89 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - Used to rapidly generated Bootstrap Tabs Components.
+module Bootstrap3Helper # :nodoc:
+  # Used to rapidly generated Bootstrap Tabs Components.
   #
-  # @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.
+  # @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.
+  #   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 %>
+  # @example Rendering out a Bootstrap Tab components in a view:
+  #   <%= 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 %>
   #
-  #    <% 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>
   class Tabs < Component
-    # @description
-    # - Creates a new Tabs object.
+    # Creates a new Tabs object.
     #
-    # @param [Class] template - Template in which your are binding too.
+    # @param [ActionView] template - Template in which your are binding too.
     # @param [Hash]  args
-    #   <code>
-    #     args = {
-    #       type:   [String|Symbol] - Used to tell the helper which tab version - :tabs|:pills
-    #       id:     [String|nilClass] - The ID, if you want one, for the parent container
-    #       class:  [String|nilClass] - Custom class for the parent container
-    #     }
-    #   </code>
+    # @option args [String|Symbol] :type  Used to tell the helper which tab version - :tabs|:pills
+    # @option args [String]        :id    The ID, if you want one, for the parent container
+    # @option args [String]        :class Custom class for the parent container.
     #
-    def initialize(template, args = {})
+    def initialize(template, args = {}, &block)
       super(template)
-      @type  = args.fetch(:type, :tabs)
-      @id    = args.fetch(:id, nil)
-      @class = args.fetch(:class, '')
 
-      @tab_menu = Tabs::Menu.new(@template, type: @type)
-      @tab_content = Tabs::Content.new(@template)
+      @type    = args.fetch(:type,  :tabs)
+      @id      = args.fetch(:id,    nil)
+      @class   = args.fetch(:class, '')
+      @content = block || proc { '' }
     end
 
-    # @description
-    # - Allows you access the Tabs::Menu object.
+    # Allows you access the Tabs::Menu object.
     #
+    # @see Tabs::Menu
     # @return [Tabs::Menu]
     #
-    def menu
-      @tab_menu
+    def menu(args = {}, &block)
+      Tabs::Menu.new(@template, args.merge(type: @type), &block)
     end
 
-    # @description
-    # - Allows you to access the Tabs::Content object
+    # Allows you to access the Tabs::Content object
     #
+    # @see Tabs::Content
     # @return [Tabs::Content]
     #
-    def content
-      @tab_content
+    def content(args = {}, &block)
+      Tabs::Content.new(@template, args, &block)
     end
 
-    # @description
-    # - Used to render out the HTML of the Tabs Object
+    # Used to render out the HTML of the Tabs Object
     #
     # @return [String]
     #
     def to_s
-      html = content_tag :div, id: @id, class: @class do
-        menu.to_s + content.to_s
+      content_tag :div, id: @id, class: @class do
+        @content.call(self)
       end
-
-      html
     end
   end
 end

data/lib/bootstrap3_helper/tabs/content.rb

@@ -1,45 +1,35 @@
-# @description
-# - Root Object
-#
-module Bootstrap3Helper
+module Bootstrap3Helper # :nodoc:
   class Tabs
-    # @description
-    # - Used to rapidly generated Bootstrap Tabs Content Components.
+    # Used to rapidly generated Bootstrap Tabs Content Components.
+    #
     #
     class Content < Component
-      # @description
-      # - Creates a new Tabs::Menu object.
+      # Creates a new Tabs::Menu object.
       #
-      # @param [Class] template - Template in which your are binding too.
+      # @param [ActionView] template Template in which your are binding too.
       # @param [Hash]  args
-      #   <code>
-      #     args = {
-      #       id:     [String|nilClass] - The ID, if you want one, for the parent container
-      #       class:  [String|nilClass] - Custom class for the parent container
-      #     }
-      #   </code>
+      # @option args [String] :id The ID, if you want one, for the parent container.
+      # @option args [String] :class Custom class for the parent container.
+      # @option args [Hash]   :data Any data attributes you want on the parent element.
       #
-      def initialize(template, args = {})
+      def initialize(template, args = {}, &block)
         super(template)
 
-        @id    = args.fetch(:id, nil)
-        @class = args.fetch(:class, '')
-        @items = []
+        @id      = args.fetch(:id,    nil)
+        @class   = args.fetch(:class, '')
+        @data    = args.fetch(:data,  {})
+        @content = block || proc { '' }
       end
 
-      # @description
-      # - Adds a new tabe-pane item to the object.
+      # Adds a new tabe pane item to the object.
       #
       # @param [String|Symbol] name - Used to link to  the nav menu item.
       # @param [Hash]  args
-      #   <code>
-      #     args = {
-      #       class:  [String|nilClass] - Custom class for the div element
-      #       data:   [Hash] - Any data attributes you wish to assign to div element.
-      #     }
-      #   </code>
+      # @option args [String] :class Custom class for the pane.
+      # @option args [Hash]   :data Any data attributes you want on the pane element.
+      # @yieldreturn [String]
       #
-      def item(name, args = {})
+      def pane(name, args = {})
         data   = args.fetch(:data, nil)
         klass  = args.fetch(:class, '')
         active = klass.include? 'active'
@@ -55,21 +45,16 @@ module Bootstrap3Helper
         ) do
           yield if block_given?
         end
-
-        @items.push(content)
       end
 
-      # @description
-      # - Used to render out the object as HTML
+      # Used to render out the object as HTML
       #
       # @return [String]
       #
       def to_s
-        html = content_tag :div, id: @id, class: 'tab-content' + @class do
-          @items.collect(&:to_s).join.html_safe
+        content_tag :div, id: @id, class: 'tab-content' + @class do
+          @content.call(self)
         end
-
-        html
       end
     end
   end

data/lib/bootstrap3_helper/tabs/dropdown.rb

@@ -1,57 +1,50 @@
-# @description
-# - Root Object
-#
-module Bootstrap3Helper
+module Bootstrap3Helper # :nodoc:
   class Tabs
-    # @description
-    #  - Used to rapidly build dropdown menus for Bootstrap tabs.
+    # Used to rapidly build dropdown menus for Bootstrap tabs.
     #
-    # <code>
-    #   <% menu.dropdown 'Testing Dropdown' do |dropdown| %>
-    #      <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
-    #      <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
-    #      <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
-    #   <% end %>
-    # </code>
+    # @example Rendering a Dropdown menu component:
+    #   <code>
+    #     <%= menu.dropdown 'Testing Dropdown' do |dropdown| %>
+    #         <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
+    #         <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
+    #         <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
+    #     <% end %>
+    #   </code>
     #
     class Dropdown < Component
-      # @description
-      # - Creates a new Tabs::Dropdown object.
+      # Creates a new Tabs::Dropdown object.
       #
-      # @param [Class] template - Template in which your are binding too.
+      # @param [ActionView] template Template in which your are binding too.
+      # @param [String]     name
       #
-      def initialize(template, name = '')
+      def initialize(template, name = '', &block)
         super(template)
 
-        @name  = name
-        @items = []
+        @name    = name
+        @content = block || proc { '' } 
       end
 
-      # @description
-      # - Adds a new item to the dropdown object.
+      # rubocop:disable Metrics/MethodLength
+
+      # Adds a new item to the dropdown object.
       #
-      # @note
-      # - You can opt out of passing in a block and the li will use the name attribute
-      # for the menu item.
+      # @note You can opt out of passing in a block and the li will use the name attribute
+      #   for the menu item.
       #
       # @param [String|Symbol] name - Used to link nav li to tab-content
       # @param [Hash]  args
-      #   <code>
-      #     args = {
-      #       id:     [String|Symbol] - Custom ID for li element.
-      #       class:  [String|nilClass] - Custom class for the li element
-      #       data:   [Hash] - Any data attributes you wish to assign to li element.
-      #     }
-      #   </code>
+      # @option args [String] :id The ID, if you want one, for the li element.
+      # @option args [String] :class Custom class for the li element.
+      # @option args [Hash]   :data Any data attributes you want on the li element.
+      # @yieldreturn [String]
       #
-      # rubocop:disable Metrics/MethodLength
       def item(name, args = {})
         id     = args.fetch(:id, nil)
         klass  = args.fetch(:class, '')
         data   = args.fetch(:data, nil)
         active = klass.include? 'active'
 
-        li = content_tag(
+        content_tag(
           :li,
           id:    id,
           class: klass,
@@ -67,24 +60,25 @@ module Bootstrap3Helper
             block_given? ? yield : name.to_s.titleize
           end
         end
-
-        @items.push(li)
       end
       # rubocop:enable Metrics/MethodLength
 
-      # @description
-      # - Used to render out the object and get the HTML representation.
+      # Used to render out the object and get the HTML representation.
       #
       # @return [String]
       #
       def to_s
-        content = content_tag :a, @name, href: '#', class: 'dropdown-toggle', data: { toggle: 'dropdown' }, aria: { expanded: false }
+        content = content_tag(
+          :a,
+          @name,
+          href:  '#',
+          class: 'dropdown-toggle',
+          data: { toggle: 'dropdown' }, aria: { expanded: false }
+        )
 
         content += content_tag :ul, id: @id, class: 'dropdown-menu ' do
-          @items.collect(&:to_s).join.html_safe
+          @content.call(self)
         end
-
-        content
       end
     end
   end

data/lib/bootstrap3_helper/tabs/menu.rb

@@ -1,56 +1,44 @@
-# @description
-# - Root Object
-#
-module Bootstrap3Helper
+module Bootstrap3Helper # :nodoc:
   class Tabs
-    # @description
-    # - Used to rapidly generated Bootstrap Tabs Menu Components.
+    # Used to rapidly generated Bootstrap Tabs Menu Components.
     #
-    # <code>
-    #   <% menu.item(:testing3) { ' Testing 3' } %>
-    # </code>
+    # @example Rendering out a Tabs::Menu component:
+    #   <code>
+    #     <% menu.item(:testing3) { ' Testing 3' } %>
+    #   </code>
     #
     class Menu < Component
-      # @description
-      # - Creates a new Tabs::Menu object.
+      # Creates a new Tabs::Menu object.
       #
-      # @param [Class] template - Template in which your are binding too.
+      # @param [ActionView] template - Template in which your are binding too.
       # @param [Hash]  args
-      #   <code>
-      #     args = {
-      #       type:   [String|Symbol] - Used to tell the helper which tab version - :tabs|:pills
-      #       id:     [String|nilClass] - The ID, if you want one, for the parent container
-      #       class:  [String|nilClass] - Custom class for the parent container
-      #     }
-      #   </code>
+      # @option args [Symbol] type  Used to tell the helper which tab version :tabs|:pills
+      # @option args [String] id    The ID, if you want one, for the parent container
+      # @option args [String] class Custom class for the parent container
       #
-      def initialize(template, args = {})
+      def initialize(template, args = {}, &block)
         super(template)
 
-        @id    = args.fetch(:id, nil)
-        @class = args.fetch(:class, '')
-        @type  = args.fetch(:type, :tabs)
-        @items = []
+        @id      = args.fetch(:id, nil)
+        @class   = args.fetch(:class, '')
+        @type    = args.fetch(:type, :tabs)
+        @content = block || proc { '' }
       end
 
-      # @description
-      # - Adds a new menu item to the object.
+      # rubocop:disable Metrics/MethodLength
+
+      # Adds a new menu item to the object.
       #
-      # @note
-      # - You can opt out of passing in a block and the li will use the name attribute
-      # for the menu item.
+      # @note You can opt out of passing in a block and the li will use
+      #   the name attribute for the menu item.
       #
-      # @param [String|Symbol] name - Used to link nav li to tab-content
+      # @param [String|Symbol] name Used to link nav li to tab-content
       # @param [Hash]  args
-      #   <code>
-      #     args = {
-      #       id:     [String|Symbol] - Custom ID for li element.
-      #       class:  [String|nilClass] - Custom class for the li element
-      #       data:   [Hash] - Any data attributes you wish to assign to li element.
-      #     }
-      #   </code>
+      # @option args [String] :id
+      # @option args [String] :class
+      # @option args [Hash]   :data
+      # @yieldreturn [String]
       #
-      # rubocop:disable Metrics/MethodLength
       def item(name, args = {})
         id     = args.fetch(:id, nil)
         data   = args.fetch(:data, nil)
@@ -75,42 +63,37 @@ module Bootstrap3Helper
             block_given? ? yield : name.to_s.titleize
           end
         end
-
-        @items.push(li)
       end
       # rubocop:enable Metrics/MethodLength
 
-      # @description
-      # - Used to create menu items that are Dropdowns
+      # Used to create menu items that are Dropdowns
       #
-      # @param [String|Symbol] name - 
+      # @param [String|Symbol] name
+      # @param [Hash] args
+      # @option args [String] :id
+      # @option args [String] :class
+      # @option args [Hash]   :data
+      # @yieldparam dropdown [Tabs::Dropdown]
       #
-      def dropdown(name, args = {})
-        id    = args.fetch(:id, nil)
-        data  = args.fetch(:data, nil)
-        klass = args.fetch(:class, '')
-
-        dropdown = Tabs::Dropdown.new(@template, name)
-        yield dropdown if block_given?
+      def dropdown(name, args = {}, &block)
+        id       = args.fetch(:id, nil)
+        data     = args.fetch(:data, nil)
+        klass    = args.fetch(:class, '')
+        dropdown = Tabs::Dropdown.new(@template, name, &block)
 
         content = content_tag :li, id: id, class: 'dropdown' + klass, data: data do
-          dropdown.to_s
+          dropdown.to_s.html_safe
         end
-
-        @items.push(content)
       end
 
-      # @description
-      # - Used to render out the contents of the menu.
+      # Used to render out the contents of the menu.
       #
       # @return [String]
       #
       def to_s
-        html = content_tag :ul, id: @id, class: "nav nav-#{@type} " + @class, role: 'tablist' do
-          @items.collect(&:to_s).join.html_safe
+        content_tag :ul, id: @id, class: "nav nav-#{@type} " + @class, role: 'tablist' do
+          @content.call(self)
         end
-
-        html
       end
     end
   end