bootstrap4_helper 1.0.0 → 1.0.1

data/lib/bootstrap4_helper/accordion_group.rb

@@ -1,17 +1,15 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - Used to build groups of Accordions, that are all synced with each other.
+  # Used to build groups of Accordions, that are all synced with each other.
+  #
   #
   class AccordionGroup < Component
-    # @description
-    # -
+    # Class constructor
     #
     # @param [ActionView] template
-    # @param [NilClass|String|Symbol|Hash] opts
-    # @param [Hash]
+    # @param [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     #
     def initialize(template, opts = {}, &block)
       super(template)
@@ -22,8 +20,7 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Used to build a `Accordion` for the `AccordionGroup`.
+    # Used to build a `Accordion` for the `AccordionGroup`.
     #
     # @param [Mixed] args
     # @return [Accordion]
@@ -40,8 +37,7 @@ module Bootstrap4Helper
       Accordion.new(self, *opts, &block)
     end
 
-    # @description
-    # - Used to get the HTML markup of the `AccordionGroup`
+    # Used to get the HTML markup of the `AccordionGroup`
     #
     # @return [String]
     #

data/lib/bootstrap4_helper/alert.rb

@@ -1,35 +1,13 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - The Alert helper is meant to help you rapidly build Bootstrap Alert
+  # The Alert helper is meant to help you rapidly build Bootstrap Alert
   # components quickly and easily. The dissmiss button is optional.
   #
-  #   <code>
-  #     <%= alert_helper :warning, dismissable: true do %>
-  #       <% if @model.errors.present? %>
-  #         <p>Some kind of error</p>
-  #       <% end %>
-  #     <% end %>
-  #
-  #     <%= alert_helper(:success, dismissible: true) { "Successful save"}
-  #   </code>
-  #
   class Alert < Component
-    # @description
-    # - Used to generate Bootstrap alert components quickly.
+    # Class constructor
     #
     # @param [Class] template - Template in which your are binding too.
-    # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+    # @param [NilClass|String|Symbol|Hash] context_or_options
     # @param [Hash]  opts
-    #   <code>
-    #     opts = {
-    #       id:     [String] - ID of the alert box
-    #       class:  [String] - Additional classes for the alert box
-    #     }
-    #   </code>
-    # @param [Proc] &block
     # @return [Alert]
     #
     def initialize(template, context_or_options = nil, opts = {}, &block)
@@ -42,8 +20,7 @@ module Bootstrap4Helper
       @content     = block || proc { '' }
     end
 
-    # @description
-    # - The dissmiss button, if the element has one.
+    # The dissmiss button, if the element has one.
     #
     # @return [String]
     #
@@ -53,8 +30,7 @@ module Bootstrap4Helper
       end
     end
 
-    # @description
-    # - Used to render out the Alert component.
+    # Used to render out the Alert component.
     #
     # @return [String]
     #
@@ -67,8 +43,7 @@ module Bootstrap4Helper
 
     private
 
-    # @description
-    # - Used to get the container classes.
+    # Used to get the container classes.
     #
     # @return [String]
     #

data/lib/bootstrap4_helper/badge.rb

@@ -1,17 +1,13 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - Creates Bootstrap badge components that can be used anywhere.
+  # Creates Bootstrap badge components that can be used anywhere.
+  #
   #
   class Badge < Component
-    # @description
-    # -
+    # Class constructor
     #
     # @param [ActionView] template
-    # @param [NilClass|String|Symbol|Hash] context_or_options.
-    # @param [Hash]  opts
+    # @param [NilClass|String|Symbol|Hash] context_or_options
+    # @param [Hash] opts
     #
     def initialize(template, context_or_options = nil, opts = {}, &block)
       super(template)
@@ -22,8 +18,8 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # -
+    # String representation of the object.
+    #
     #
     def to_s
       content_tag(config(:badge, :span), id: @id, class: container_class) { @content.call(self) }
@@ -31,8 +27,7 @@ module Bootstrap4Helper
 
     private
 
-    # @description
-    # - Used to get the container classes.
+    # Used to get the container classes.
     #
     # @return [String]
     #

data/lib/bootstrap4_helper/card.rb

@@ -1,16 +1,15 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - Used to build Bootstrap Card components.  Cards are wildly used through Bootstrap 4.
+  # Used to build Bootstrap Card components.  Cards are wildly used through Bootstrap 4.
+  #
   #
   class Card < Component
-    # @description
-    # - Used to initialize a new Card component.
+    # Used to initialize a new Card component.
     #
-    # @param [ActionView] template
-    # @param [Hash]  opts
+    # @param  [ActionView] template
+    # @param  [Hash]  opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     # @return [Card]
     #
     def initialize(template, opts = {}, &block)
@@ -22,68 +21,81 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Builds the Header component.
+    # Builds the Header component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def header(args = {}, &block)
       build_base_component :header, args, &block
     end
 
-    # @description
-    # - Builds the Body component.
+    # Builds the Body component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def body(args = {}, &block)
       build_base_component :body, args, &block
     end
 
-    # @description
-    # - Builds the Footer component.
+    # Builds the Footer component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def footer(args = {}, &block)
       build_base_component :footer, args, &block
     end
 
-    # @description
-    # - Builds a Title component.
+    # Builds a Title component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def title(args = {}, &block)
       build_sub_component config(:card_title, :h5), :title, args, &block
     end
 
-    # @description
-    # - Builds a Text component.
+    # Builds a Text component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def text(args = {}, &block)
       build_sub_component config(:card_text, :p), :text, args, &block
     end
 
-    # @description
-    # - Builds a Img Overlay component.
+    # Builds a Img Overlay component.
     #
-    # @param [Hash] args
+    # @param  [Hash] args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def image_overlay(args = {}, &block)
       build_base_component 'img-overlay', args, &block
     end
 
-    # @description
-    # - Outputs the Object in its String representation.
+    # Outputs the Object in its String representation.
+    #
+    # @return [String]
     #
     def to_s
       content_tag :div, id: @id, class: "card #{@class}", data: @data do
@@ -93,23 +105,24 @@ module Bootstrap4Helper
 
     private
 
-    # @description
-    # - Used to build basic DIV components.
+    # Used to build basic DIV components.
     #
-    # @param [String] type
-    # @param [Mixed] args
+    # @param  [String] type
+    # @param  [Mixed] args
     # @return [String]
     #
     def build_base_component(type, args, &block)
       build_sub_component :div, type, args, &block
     end
 
-    # @description
-    # - Used to build various DOM components.
-    #
-    # @param [Symbol] tag
-    # @param [String] type
-    # @param [Mixed] args
+    # Used to build various DOM components.
+    #
+    # @param  [Symbol] tag
+    # @param  [String] type
+    # @param  [Hash]   args
+    # @option args [String] :id
+    # @option args [String] :class
+    # @option args [Hash]   :data
     # @return [String]
     #
     def build_sub_component(tag, type, args, &block)

data/lib/bootstrap4_helper/card_column.rb

@@ -1,13 +1,10 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Creates a Card Column Component.
   #
   #
   class CardColumn < CardGrouping
-    # @description
-    # -
+    # String representation of the object.
+    #
     #
     def to_s
       content_tag :div, id: @id, class: "card-columns #{@class}", data: @data do

data/lib/bootstrap4_helper/card_deck.rb

@@ -1,13 +1,10 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Creates a Card Deck component
   #
   #
   class CardDeck < CardGrouping
-    # @description
-    # -
+    # String representation of the object.
+    #
     #
     def to_s
       content_tag :div, id: @id, class: "card-deck #{@class}", data: @data do

data/lib/bootstrap4_helper/card_group.rb

@@ -1,13 +1,10 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Creates a Card Group component
   #
   #
   class CardGroup < CardGrouping
-    # @description
-    # -
+    # String representation of the object
+    #
     #
     def to_s
       content_tag :div, id: @id, class: "card-group #{@class}", data: @data do

data/lib/bootstrap4_helper/card_grouping.rb

@@ -1,16 +1,15 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Class for other Card group type components to inherit from.
   #
   #
   class CardGrouping < Component
-    # @description
-    # - Used to initialize a new Card Group.
+    # Used to initialize a new Card Grouping.
     #
     # @param [Class] template
     # @param [Hash]  opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     # @return [Card]
     #
     def initialize(template, opts = {}, &block)
@@ -22,8 +21,7 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Builds a `Card` for the grouping class.
+    # Builds a `Card` for the grouping class.
     #
     # @param [Hash] opts
     # @return [Card]

data/lib/bootstrap4_helper/component.rb

@@ -1,37 +1,33 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - This super class is meant to contain commonly used methods that
+  # This super class is meant to contain commonly used methods that
   # all sub classes can leverage.
   #
-  # @note
-  # - Every component that inherits from this class, needs to call the parent
-  # initialization method! In order to properly render erb blocks within the
-  # proper context, we need the template. The only way to get this, is to pass
-  # in the template.
+  # @note Every component that inherits from this class, needs to call the parent
+  #   initialization method! In order to properly render erb blocks within the
+  #   proper context, we need the template. The only way to get this, is to pass
+  #   in the template.
   #
-  # @note
-  # - the `context` mentioned above, refers to the context of `@template` and
-  # not to be confused with `@context` that can be found in the sub classes.
-  # `@context` refers to the Bootstrap class context of the component.
+  # @note the `context` mentioned above, refers to the context of `@template` and
+  #   not to be confused with `@context` that can be found in the sub classes.
+  #   `@context` refers to the Bootstrap class context of the component.
   #
   class Component
-    # @description
-    # - Used to ensure that the helpers always have the propert context for
+    # Used to ensure that the helpers always have the propert context for
     # rendering and bindings.
     #
-    # @param [Class] template - the context of the bindings
+    # @param [Class] template
     #
     def initialize(template)
       @template = template
     end
 
-    # @description
-    # - Used to pass all context of content_tag to the template.  This ensures
+    # Used to pass all context of content_tag to the template.  This ensures
     # proper template binding of variables and methods!
     #
+    # @param  [String]        name
+    # @param  [Hash|NilClass] content_or_options_with_block
+    # @param  [Hash|NilClass] options
+    # @param  [Boolean]       escape
     # @return [String]
     #
     def content_tag(
@@ -50,31 +46,33 @@ module Bootstrap4Helper
       )
     end
 
-    # @description
-    # -
+    # Used to pass all context of the capture tag to then template.  This ensures
+    # proper template binding of variables and methods!
+    #
+    # @param  [Mixed] args
+    # @return [String]
     #
     def capture(*args)
       @template.capture(*args)
     end
 
-    # @description
-    # - Used to pass all concat references to the template.  This ensures proper
+    # Used to pass all concat references to the template.  This ensures proper
     # binding. Concat adds a String to the template Output buffer.  Useful when
     # trying to add a String with no block.
     #
-    # @params [String] text
+    # @param  [String] text
+    # @return [String]
     #
     def concat(text)
       @template.concat(text)
     end
 
-    # @description
-    # - Used to parse method arguments.  If the first argument is
+    # Used to parse method arguments.  If the first argument is
     # a Hash, then it is assumed that the user left off the bootstrap
     # contectual class.  So we will assign it to `secondary` and
     # return the Hash to be used as options.
     #
-    # @params [Hash|NilClass|String|Symbol] *args
+    # @param  [Hash|NilClass|String|Symbol] args
     # @return [Array]
     #
     def parse_arguments(*args)
@@ -87,8 +85,7 @@ module Bootstrap4Helper
       end
     end
 
-    # @description
-    # - Used to generate a (hopefully) unique ID for DOM elements.  Used as a
+    # Used to generate a (hopefully) unique ID for DOM elements.  Used as a
     # fallback if the user doesn't specify one.
     #
     # @return [String]
@@ -97,10 +94,9 @@ module Bootstrap4Helper
       (0...10).map { rand(65..90).chr }.join
     end
 
-    # @description
-    # - Used to get config settings inside of components quicker.
+    # Used to get config settings inside of components quicker.
     #
-    # @param [Symbol] setting
+    # @param  [Symbol] setting
     # @return [Mixed]
     #
     def config(setting, fallback)