bootstrap4_helper 1.0.0 → 1.0.1

data/lib/bootstrap4_helper/configuration.rb

@@ -1,9 +1,7 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Simple configuration object for setting options for the gem.
   #
+  # @todo Build a better, more comprehensive system.
   #
   class Configuration
     DEFAULT_SETTINGS = {
@@ -16,18 +14,18 @@ module Bootstrap4Helper
 
     attr_accessor(*DEFAULT_SETTINGS.keys)
 
-    # @description
-    # -
+    # Class constructor
     #
-    # @params [Hash] args
+    # @param  [Hash] _args
     # @return [ClassName]
     #
     def initialize(_args = {})
       DEFAULT_SETTINGS.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # @description
-    # - Simple predicate method
+    # Simple predicate method
+    #
+    # @return [Boolean]
     #
     def autoload_in_views?
       @autoload_in_views

data/lib/bootstrap4_helper/constants.rb

@@ -1,9 +1,6 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - Simple class for storing constants
+  # Simple class for storing constants
+  #
   #
   class Constants
     COMPONENTS = %i[

data/lib/bootstrap4_helper/dropdown.rb

@@ -1,18 +1,16 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Builds a Dropdown component that can be used in other components.
   #
   #
   class Dropdown < Component
-    # @description
-    # -
+    # Class constructor
     #
-    # @param [ActionView] template
+    # @param [ActionView]    template
     # @param [Symbol|String] type
-    # @param [Hash] opts
-    # @param [Hash]
+    # @param [Hash]          opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     #
     def initialize(template, type = :dropdown, opts = {}, &block)
       super(template)
@@ -24,13 +22,16 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Used to generate a button for the dropdown.  The buttons default as just
+    # Used to generate a button for the dropdown.  The buttons default as just
     # a button that opens the coresponding dropdown menu.  The `split: true` option
     # make the button just the arrow indicator that open the menu.
     #
-    # @param [Symbol] context
-    # @param [Hash] opts
+    # @param  [Symbol] context
+    # @param  [Hash]   opts
+    # @option opts [Boolean] :split
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
     # @return [String]
     #
     def button(context = :primary, opts = {})
@@ -52,18 +53,21 @@ module Bootstrap4Helper
       end
     end
 
-    # @description
-    # - Used to create a new `Dropdown::Menu`
+    # Used to create a new `Dropdown::Menu`
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     # @return [Dropdown::Menu]
     #
     def menu(opts = {}, &block)
       Menu.new(@template, opts, &block)
     end
 
-    # @description
-    # -
+    # String reprentation of the object.
+    #
+    # @return [String]
     #
     def to_s
       content_tag :div, id: @id, class: "#{container_class} #{@class}", data: @data do
@@ -73,8 +77,7 @@ module Bootstrap4Helper
 
     private
 
-    # @description
-    # - Returns the container class for the dropdown component.
+    # Returns the container class for the dropdown component.
     #
     # @return [String]
     #

data/lib/bootstrap4_helper/dropdown/menu.rb

@@ -1,18 +1,16 @@
-# @root
-#
-#
 module Bootstrap4Helper
   class Dropdown
-    # @description
+    # Builds a menu component for use in dropdowns.
     #
     #
     class Menu < Component
-      # @description
-      # -
+      # Class constructor
       #
       # @param [ActionView] template
       # @param [Hash] opts
-      # @param [Hash]
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
       #
       def initialize(template, opts = {}, &block)
         super(template)
@@ -23,22 +21,30 @@ module Bootstrap4Helper
         @content = block || proc { '' }
       end
 
-      # @description
-      # - Use this method when the `item`, `link` in the item in the menu  is nothing
+      # Use this method when the `item`, `link` in the item in the menu  is nothing
       # more than a hyperlink.
       #
+      # @param  [String] name
+      # @param  [Hash]   options
+      # @param  [Hash]   html_options
+      # @return [String]
+      #
       def link(name = nil, options = nil, html_options = nil, &block)
         html_options = (html_options || {}).merge(class: 'dropdown-item')
 
         @template.link_to(name, options, html_options, &block)
       end
 
-      # @description
-      # - Use this method when you are using the item in the menu as trigger for tab
+      # Use this method when you are using the item in the menu as trigger for tab
       # content.
       #
       # @param [Symbol|String] target
       # @param [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @option opts [Hash]    :aria
+      # @return [String]
       #
       def item(target, opts = {})
         id    = opts.fetch(:id,    nil)
@@ -58,35 +64,43 @@ module Bootstrap4Helper
         end
       end
 
-      # @description
-      # - Builds a Text component
+      # Builds a Text component
       #
-      # @param [Symbol|String] text
-      # @param [Hash] opts
+      # @param  [Symbol|String] text
+      # @param  [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @return [String]
       #
       def text(text, opts = {}, &block)
         build_sub_component :span, text, 'item-text', opts, &block
       end
 
-      # @description
-      # - Builds a Header component
+      # Builds a Header component
       #
-      # @param [Symbol|String] text
-      # @param [Hash] opts
+      # @param  [Symbol|String] text
+      # @param  [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @return [String]
       #
       def header(text, opts = {}, &block)
         build_sub_component :h6, text, 'header', opts, &block
       end
 
-      # @description
-      # - Builds a divider element
+      # Builds a divider element
+      #
+      # @return [String]
       #
       def divider
         content_tag :div, '', class: 'dropdown-divider'
       end
 
-      # @description
-      # -
+      # String representation of the object.
+      #
+      # @return [String]
       #
       def to_s
         content_tag :div, id: @id, class: "dropdown-menu #{@class}", data: @data do
@@ -96,13 +110,16 @@ module Bootstrap4Helper
 
       private
 
-      # @description
-      # - Used to build specific components.
+      # Used to build specific components.
       #
       # @param [Symbol] tag
       # @param [Symbol|String] text
       # @param [Symbol|String] type
       # @param [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @return [String]
       #
       def build_sub_component(tag, text, type, opts)
         id    = opts.fetch(:id,    nil)

data/lib/bootstrap4_helper/initialize.rb

@@ -1,17 +1,12 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - Naming convention used as to not pollute views where the module is
+  # Naming convention used as to not pollute views where the module is
   # included.  @config is a common instance variable name.  We don't want
   # to risk overriding another developers variable.
   #
   @_bs4h_config = Configuration.new
 
   class << self
-    # @description
-    # - Simple interface for exposing the configuration object.
+    # Simple interface for exposing the configuration object.
     #
     # @return [Bootstrap4Helper::Configuration]
     #

data/lib/bootstrap4_helper/modal.rb

@@ -1,16 +1,17 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Builds a Modal window component.
   #
   #
   class Modal < Component
-    # @description
-    # -
+    # Class constructor
     #
-    # @param [ActionView] template
-    # @param [Hash]
+    # @param  [ActionView] template
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Boolean] :scrollable
+    # @option opts [Boolean] :vcentered
     #
     def initialize(template, opts = {}, &block)
       super(template)
@@ -23,46 +24,59 @@ module Bootstrap4Helper
       @content    = block || proc { '' }
     end
 
-    # @description
-    # - Build the header component for the modal.
+    # Build the header component for the modal.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [String]
     #
     def header(opts = {}, &block)
       build_main_component :header, opts, &block
     end
 
-    # @description
-    # - Builds the body component.
+    # Builds the body component.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [String]
     #
     def body(opts = {}, &block)
       build_main_component :body, opts, &block
     end
 
-    # @description
-    # - Builds the footer component.
+    # Builds the footer component.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [String]
     #
     def footer(opts = {}, &block)
       build_main_component :footer, opts, &block
     end
 
-    # @description
-    # - Builds a title component.
+    # Builds a title component.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [String]
     #
     def title(opts = {}, &block)
       build_sub_component :h5, :title, opts, &block
     end
 
-    # @description
-    # - Builds a close button component.
+    # Builds a close button component.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String] :class
+    # @return [String]
     #
     def close_button(opts = {})
       klass = opts.fetch(:class, '')
@@ -78,8 +92,9 @@ module Bootstrap4Helper
       end
     end
 
-    # @description
-    # -
+    # String representation of the object.
+    #
+    # @return [String]
     #
     def to_s
       content_tag :div, id: @id, class: "modal #{@class}", tabindex: -1, role: 'dialog', data: @data do
@@ -91,22 +106,25 @@ module Bootstrap4Helper
 
     private
 
-    # @description
-    # - Used to build main components, usually divs.
+    # Used to build main components, usually divs.
     #
-    # @param [Symbol|String] type
-    # @param [Hash] opts
+    # @param  [Symbol|String] type
+    # @param  [Hash] opts
+    # @return [String]
     #
     def build_main_component(type, opts = {}, &block)
       build_sub_component :div, type, opts, &block
     end
 
-    # @description
-    # - Used to build more specific components.
+    # Used to build more specific components.
     #
     # @param [Symbol] tag
     # @param [Symbol|String] type
     # @param [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [String]
     #
     def build_sub_component(tag, type, opts = {}, &block)
       id    = opts.fetch(:id,    nil)
@@ -122,15 +140,15 @@ module Bootstrap4Helper
       )
     end
 
-    # @description
-    # - Builds the `x` button normally used in the header.
+    # Builds the `x` button normally used in the header.
+    #
+    # @return [String]
     #
     def xbutton
       content_tag :span, '&times;'.html_safe, aria: { hidden: true }
     end
 
-    # @description
-    # - Gets the scrollable CSS class.
+    # Gets the scrollable CSS class.
     #
     # @return [String]
     #
@@ -138,8 +156,7 @@ module Bootstrap4Helper
       @scrollable ? 'modal-dialog-scrollable' : ''
     end
 
-    # @description
-    # - Gets the vertical-center CSS class.
+    # Gets the vertical-center CSS class.
     #
     # @return [String]
     #