bootstrap3_helper 1.0.1 → 2.0.0

data/lib/bootstrap3_helper/accordion_group.rb

@@ -1,77 +1,70 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - This class is used to general groups of accordions.
+module Bootstrap3Helper # :nodoc:
+  # This class is used to general groups of accordions.
   #
-  # <code>
-  #   <%= accordion_group_helper do |group| %>
-  #     <%= group.accordion :primary do |accordion| %>
-  #         <%= accordion.header { "accordion 1" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 1</p>
-  #         <% end %>
+  # @eample Rendering out an Accordion Group in template:
+  #   <code>
+  #     <%= accordion_group_helper do |group| %>
+  #       <%= group.accordion :primary do |accordion| %>
+  #           <%= accordion.header { "accordion 1" } %>
+  #           <%= accordion.body do %>
+  #               <p>This is accordion 1</p>
+  #           <% end %>
+  #       <% end %>
+  #       <%= group.accordion :info do |accordion| %>
+  #           <%= accordion.header { "accordion 2" } %>
+  #           <%= accordion.body do %>
+  #               <p>This is accordion 2</p>
+  #           <% end %>
+  #       <% end %>
+  #       <%= group.accordion :danger do |accordion| %>
+  #           <%= accordion.header { "accordion 3" } %>
+  #           <%= accordion.body do %>
+  #               <p>This is accordion 3</p>
+  #           <% end %>
+  #       <% end %>
   #     <% end %>
-  #     <%= group.accordion :info do |accordion| %>
-  #         <%= accordion.header { "accordion 2" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 2</p>
-  #         <% end %>
-  #     <% end %>
-  #     <%= group.accordion :danger do |accordion| %>
-  #         <%= accordion.header { "accordion 3" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 3</p>
-  #         <% end %>
-  #     <% end %>
-  #   <% end %>
-  # </code>
+  #   </code>
   #
   class AccordionGroup < Component
-    # @description
-    # - Used to initialize the main object.  This objects sole purpose is to
+    # Used to initialize the main object.  This objects sole purpose is to
     # generate a wrapper element with a distinct id and pass that id down to
     # all the child elements.
     #
-    def initialize(template, opts = {})
+    # @param [ActionView] template
+    # @param [Hash]       opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    #
+    def initialize(template, opts = {}, &block)
       super(template)
-      @accordions = []
-      @id = opts.fetch(:id, uuid)
-      @class = opts.fetch(:class, '')
+
+      @id      = opts.fetch(:id,    uuid)
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  {})
+      @content = block || proc { '' }
     end
 
-    # @description
-    # - This method is the main method for generating individual accordions.
+    # This method is the main method for generating individual accordions.
     # This is where you would pass in the html attributes.
     #
     # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
     # @param [Hash] opts
-    # <code>
-    #    args = {
-    #      id:      [String]
-    #      class:   [String]
-    #    }
-    # </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
+    # @yieldparam accordion [Accordion]
     #
-    # @yields [Accordion] accordion
-    # @return [nilClass]
-    #
-    def accordion(context_or_options = nil, opts = {})
+    def accordion(context_or_options = nil, opts = {}, &block)
       if context_or_options.is_a?(Hash)
         context_or_options[:parent_id] = @id
       else
         opts[:parent_id] = @id
       end
 
-      accordion = Accordion.new(@template, context_or_options, opts)
-      yield accordion if block_given?
-
-      @accordions.push(accordion)
+      Accordion.new(@template, context_or_options, opts, &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
     # entire accordion.  As long as the main method is rendered out in the helper,
     # you will get all the contents.
     #
@@ -79,10 +72,8 @@ module Bootstrap3Helper
     #
     def to_s
       content = content_tag :div, id: @id, class: "panel-group #{@class}" do
-        @accordions.map(&:to_s).join.html_safe
+        @content.call(self)
       end
-
-      content
     end
   end
 end

data/lib/bootstrap3_helper/alert.rb

@@ -1,11 +1,8 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - The Alert helper is meant to help you rapidly build Bootstrap Alert
+module Bootstrap3Helper # :nodoc:
+  # The Alert helper is meant to help you rapidly build Bootstrap Alert
   # components quickly and easily. The dissmiss button is optional.
   #
+  # @example Rendering a Bootstrap Alert Component in a view:
   #   <code>
   #     <%= alert_helper :warning, dismissable: true do %>
   #       <% if @model.errors.present? %>
@@ -17,33 +14,26 @@ module Bootstrap3Helper
   #   </code>
   #
   class Alert < Component
-    # @description
-    # - Used to generate Bootstrap alert components quickly.
+    # Used to generate Bootstrap alert components quickly.
     #
-    # @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>
-    #     opts = {
-    #       id:     [String] - ID of the alert box
-    #       class:  [String] - Additional classes for the alert box
-    #     }
-    #   </code>
-    # @param [Proc] &block
+    # @param  [Class] template Template in which your are binding too.
+    # @param  [NilClass|String|Symbol|Hash] Bootstrap class context, or options hash.
+    # @param  [Hash]  opts
+    # @option opts [String]  :id    The ID of the element
+    # @option opts [String]  :class Custom class for the component.
     # @return [Alert]
     #
     def initialize(template, context_or_options = nil, opts = {}, &block)
       super(template)
       @context, args = parse_arguments(context_or_options, opts)
 
-      @id = args.fetch(:id, nil)
-      @class = args.fetch(:class, '')
+      @id          = args.fetch(:id, nil)
+      @class       = args.fetch(:class, '')
       @dismissible = args.fetch(:dismissible, false)
-      @content = block || proc { '' }
+      @content     = block || proc { '' }
     end
 
-    # @description
-    # - The dissmiss button, if the element has one.
+    # The dissmiss button, if the element has one.
     #
     # @return [String]
     #
@@ -53,28 +43,26 @@ module Bootstrap3Helper
       end
     end
 
-    # @description
-    # - Used to render out the Alert component.
+    # Used to render out the Alert component.
     #
-    # @note
-    # - concat needs to be used to add the content of the button to the output
-    # buffer.  For some reason, if though the block returns a String, trying to
-    # add that string to the dismiss button string, returns with the dismiss
-    # button missing.  Was forced to caoncat the button to the current output
-    # buffer in order to get it to persist after the block call.
+    # @note Concat needs to be used to add the content of the button to the output
+    #   buffer.  For some reason, if though the block returns a String, trying to
+    #   add that string to the dismiss button string, returns with the dismiss
+    #   button missing.  Was forced to caoncat the button to the current output
+    #   buffer in order to get it to persist after the block call.
     #
     # @return [String]
     #
     def to_s
       content_tag :div, id: @id, class: container_class do
-        concat(@dismissible ? close_button : '') + @content.call
+        concat(@dismissible ? close_button : '')
+        @content.call(self)
       end
     end
 
     private
 
-    # @description
-    # - Used to get the container classes.
+    # Used to get the container classes.
     #
     # @return [String]
     #

data/lib/bootstrap3_helper/callout.rb

@@ -1,47 +1,37 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - Used to generate Bootstrap callout component quickly.
+module Bootstrap3Helper # :nodoc:
+  # Used to generate Bootstrap callout component quickly.
   #
-  # @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>
-  #     opts = {
-  #       id:     [String] - ID of the alert box
-  #       class:  [String] - Additional classes for the alert box
-  #     }
-  #   </code>
-  # @param [Proc] &block
-  # @return [Callout]
   #
   class Callout < Component
+    # @param  [Class] template - Template in which your are binding too.
+    # @param  [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+    # @param  [Hash]  opts
+    # @option opts [String]  :id    The ID of the element
+    # @option opts [String]  :class Custom class for the component.
+    # @return [Callout]
+    #
     def initialize(template, context_or_options = nil, opts = {}, &block)
       super(template)
       @context, args = parse_arguments(context_or_options, opts)
 
-      @id = args.fetch(:id, nil)
-      @class = args.fetch(:class, '')
+      @id      = args.fetch(:id, nil)
+      @class   = args.fetch(:class, '')
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Returns a string representation of the component.
+    # Returns a string representation of the component.
     #
     # @return [String]
     #
     def to_s
       content_tag :div, id: @id, class: container_class do
-        @content.call
+        @content.call(self)
       end
     end
 
     private
 
-    # @description
-    # - Used to get the container classes.
+    # Used to get the container classes.
     #
     # @return [String]
     #

data/lib/bootstrap3_helper/component.rb

@@ -1,25 +1,18 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - This super class is meant to contain commonly used methods that
+module Bootstrap3Helper # :nodoc
+  # 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
@@ -28,8 +21,7 @@ module Bootstrap3Helper
       @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!
     #
     # @return [String]
@@ -50,8 +42,7 @@ module Bootstrap3Helper
       )
     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.
     #
@@ -61,8 +52,7 @@ module Bootstrap3Helper
       @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 `default` and
     # return the Hash to be used as options.
@@ -80,8 +70,7 @@ module Bootstrap3Helper
       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]

data/lib/bootstrap3_helper/configuration.rb

@@ -0,0 +1,25 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  #
+  #
+  class Configuration
+    SETTINGS = %i[
+      autoload_in_all_views
+    ].freeze
+
+    attr_accessor(*SETTINGS)
+
+    # @description
+    # -
+    #
+    # @params [Hash] args
+    # @return [ClassName]
+    #
+    def initialize(args = {})
+      @autoload_in_all_views = true
+    end
+  end
+end

data/lib/bootstrap3_helper/panel.rb

@@ -1,11 +1,7 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - Used to rapidly build Bootstrap Panel Components.
+module Bootstrap3Helper # :nodoc:
+  # Used to rapidly build Bootstrap Panel Components.
   #
-  # <code>
+  # @example Rendering a Bootstrap Panel Component in a view:
   #   <%= panel_helper class: 'panel-primary' do |p| %>
   #     <%= p.header { "Some Title" }
   #     <%= p.body class: 'custom-class', id: 'custom-id' do %>
@@ -15,88 +11,85 @@ module Bootstrap3Helper
   #       //HTML or Ruby
   #     <% end %>
   #   <% end %>
-  # </code>
   #
   class Panel < Component
-    # @description
-    # - Creates a new Panel object.
+    # Creates a new Panel object.
     #
     # @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>
-    #     opts = {
-    #       id:     [String|NilClass] - The ID, if you want one, for the element.
-    #       class:  [String|NilClass] - Custom class for the element.
-    #     }
-    #   </code>
+    # @option opts [String]  :id    The ID of the element
+    # @option opts [String]  :class Custom class for the component.
+    # @option opts [Hash]    :data  Any data attributes for the element.
     # @return [Panel]
     #
-    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)
 
       @id      = args.fetch(:id, '')
       @class   = args.fetch(:class, '')
       @data    = args.fetch(:data, nil)
+      @content = block || proc { '' }
     end
 
-    # @description
-    # - Used to generate the header component for the panel.
+    # Used to generate the header component for the panel.
     #
     # @param [Hash] args
+    # @option args [String]  :id    The ID of the element
+    # @option args [String]  :class Custom class for the component.
+    # @yieldreturn [String]
     #
-    def header(args = {})
-      id = args.fetch(:id, '')
+    def header(args = {}, &block)
+      id    = args.fetch(:id, '')
       klass = args.fetch(:class, '')
-      @header = content_tag(:div, id: id, class: 'panel-heading ' + klass) do
-        content_tag(:h3, class: 'panel-title') { yield if block_given? }
+
+      content_tag(:div, id: id, class: 'panel-heading ' + klass) do
+        content_tag(:h3, class: 'panel-title', &block)
       end
     end
 
-    # @description
-    # - Used to generate the body component for the panel.
+    # Used to generate the body component for the panel.
     #
     # @param [Hash] args
+    # @option args [String]  :id    The ID of the element
+    # @option args [String]  :class Custom class for the component.
+    # @yieldreturn [String]
     #
-    def body(args = {})
-      id = args.fetch(:id, '')
+    def body(args = {}, &block)
+      id    = args.fetch(:id, '')
       klass = args.fetch(:class, '')
-      @body = content_tag(:div, id: id, class: 'panel-body ' + klass) do
-        yield if block_given?
-      end
+
+      content_tag(:div, id: id, class: 'panel-body ' + klass, &block)
     end
 
-    # @description
-    # - Used to generate the footer component for the panel.
+    # Used to generate the footer component for the panel.
     #
     # @param [Hash] args
+    # @option args [String]  :id    The ID of the element
+    # @option args [String]  :class Custom class for the component.
+    # @yieldreturn [String]
     #
-    def footer(args = {})
-      id = args.fetch(:id, '')
+    def footer(args = {}, &block)
+      id    = args.fetch(:id, '')
       klass = args.fetch(:class, '')
-      @footer = content_tag(:div, id: id, class: 'panel-footer ' + klass) do
-        yield if block_given?
-      end
+
+      content_tag(:div, id: id, class: 'panel-footer ' + klass, &block)
     end
 
-    # @description
-    # - Used to render the html for the entire panel object.
+    # Used to render the html for the entire panel object.
     #
     # @return [String]
     #
     def to_s
-      content = content_tag :div, id: @id, class: container_classes, data: @data do
-        @header + @body + @footer
+      content_tag :div, id: @id, class: container_classes, data: @data do
+        @content.call(self)
       end
-
-      content
     end
 
     private
 
-    # @description
-    # - Used to get the container css classes.
+    # Used to get the container css classes.
     #
     # @return [String]
     #