bootstrap3_helper 1.0.0 → 3.0.0

data/lib/bootstrap3_helper/alert.rb

@@ -1,80 +1,62 @@
-# @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.
   #
-  #   <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.
+    # 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  [ActionView] template Template in which your are binding too.
+    # @param  [NilClass|String|Symbol|Hash] context_or_options 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, '')
-      @dismissible = args.fetch(:dismissible, false)
-      @content = block || proc { '' }
+      @context, args = parse_context_or_options(context_or_options, opts)
+      @id            = args.fetch(:id, nil)
+      @class         = args.fetch(:class, '')
+      @dismissible   = args.fetch(:dismissible, false)
+      @content       = block || proc { '' }
     end
 
-    # @description
-    # - The dissmiss button, if the element has one.
+    # The dissmiss button, if the element has one.
     #
     # @return [String]
     #
     def close_button
-      content_tag(:button, class: 'close', data: { dismiss: 'alert' }, aria: { label: 'Close' }) do
+      content_tag(
+        :button,
+        class: 'close',
+        data:  { dismiss: 'alert' },
+        aria:  { label: 'Close' }
+      ) do
         content_tag(:span, aria: { hidden: true }) { '&times;'.html_safe }
       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  [ActionView] template Template in which your are binding too.
+    # @param  [NilClass|String|Symbol|Hash] context_or_options 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)
+      @context, args = parse_context_or_options(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,35 +1,27 @@
-# @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
+    # @param [ActionView] template the context of the bindings
     #
     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!
     #
     # @return [String]
@@ -50,38 +42,67 @@ 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.
     #
-    # @params [String] text
+    # @param [String] text
     #
     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 `default` 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)
+    def parse_context_or_options(*args)
+      parse_arguments(*args, 'default')
+    end
+
+    # Used to parse method arguments.  If the first argument is
+    # a Hash, then it is assumed that the user left off the tag
+    # element.  So we will assign it to <tt>NilClass</tt> and
+    # return the Hash to be used as options.
+    #
+    # @param  [Hash|NilClass|String|Symbol] args
+    # @return [Array]
+    #
+    def parse_tag_or_options(*args)
+      parse_arguments(*args, nil)
+    end
+
+    # 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.
+    #
+    # @overload parse_arguments(param_or_options, options, default)
+    #   @param [NilClass|Hash|Symbol|String] param_or_options
+    #   @param [Hash] options
+    #   @param [NilClass|String|Symbol] default
+    #
+    # @overload parse_arguments(options, default)
+    #   @param [Hash] options
+    #   @param [NilClass|String|Symbol] default
+    #
+    # @return [Array]
+    #
+    def parse_arguments(*args, default)
       first, second = *args
       case first
       when Hash, NilClass
-        ['default', first || second]
+        [default, first || second]
       when Symbol, String
         [first, second]
       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]
@@ -89,5 +110,25 @@ module Bootstrap3Helper
     def uuid
       (0...10).map { rand(65..90).chr }.join
     end
+
+    # Used to get config settings inside of components quicker.
+    #
+    # @param  [Symbol|String|Hash] setting
+    # @return [Mixed]
+    #
+    def config(setting, fallback)
+      object = Bootstrap3Helper.config
+
+      value  = (
+        case setting
+        when Hash
+          object.send(setting.keys[0])[setting.values[0]] if object.send(setting.keys[0])
+        when Symbol, String
+          object.send(setting) if object.respond_to?(setting)
+        end
+      )
+
+      value || fallback
+    end
   end
 end

data/lib/bootstrap3_helper/configuration.rb

@@ -0,0 +1,36 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  #
+  #
+  class Configuration
+    DEFAULT_SETTINGS = {
+      autoload_in_all_views: true,
+      accodions:             {
+        header: :div,
+        body:   :div,
+        footer: :div,
+        title:  :h4
+      },
+      panels:                {
+        header: :div,
+        body:   :div,
+        footer: :div,
+        title:  :h3
+      }
+    }.freeze
+
+    attr_accessor(*DEFAULT_SETTINGS.keys)
+
+    # Class constructor
+    #
+    # @param  [Hash] _args
+    # @return [ClassName]
+    #
+    def initialize(_args = {})
+      @autoload_in_all_views = true
+    end
+  end
+end

data/lib/bootstrap3_helper/initialize.rb

@@ -0,0 +1,19 @@
+module Bootstrap3Helper # :nodoc:
+  # 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.
+  #
+  @_bs3h_config = Configuration.new
+
+  class << self
+    # Simple interface for exposing the configuration object.
+    #
+    # @return [Bootstrap5Helper::Configuration]
+    #
+    def config
+      yield @_bs3h_config if block_given?
+
+      @_bs3h_config
+    end
+  end
+end

data/lib/bootstrap3_helper/panel.rb

@@ -1,102 +1,155 @@
-# @root
-#
-#
-module Bootstrap3Helper
-  # @description
-  # - Used to rapidly build Bootstrap Panel Components.
+module Bootstrap3Helper # :nodoc:
+  # Used to rapidly build Bootstrap Panel Components.
   #
-  # <code>
-  #   <%= panel_helper class: 'panel-primary' do |p| %>
-  #     <%= p.header { "Some Title" }
-  #     <%= p.body class: 'custom-class', id: 'custom-id' do %>
-  #       //HTML or Ruby code here...
-  #     <% end %>
-  #     <%= p.footer do %>
-  #       //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 [ActionView] template - Template in which your are binding too.
+    # @param [NilClass|String|Symbol|Hash] context_or_options - 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.
+    # @option opts [Symbol]  :config_type - Used to change config from Panel to Accordion.
     # @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)
+      @context, args = parse_context_or_options(context_or_options, opts)
 
-      @id      = args.fetch(:id, '')
-      @class   = args.fetch(:class, '')
-      @data    = args.fetch(:data, nil)
+      @id          = args.fetch(:id,          '')
+      @class       = args.fetch(:class,       '')
+      @data        = args.fetch(:data,        nil)
+      @config_type = args.fetch(:config_type, :panels)
+      @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
+    # @param  [Symbol|String|Hash|NilClass] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
     #
-    def header(args = {})
-      id = args.fetch(:id, '')
+    def header(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
       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? }
-      end
+      data  = args.fetch(:data,  {})
+      aria  = args.fetch(:aria,  {})
+
+      content_tag(
+        tag || config({ @config_type => :header }, :div),
+        id:    id,
+        class: "panel-heading #{klass}",
+        data:  data,
+        aria:  aria,
+        &block
+      )
     end
 
-    # @description
-    # - Used to generate the body component for the panel.
+    # Builds a title component for the panel.
     #
-    # @param [Hash] args
+    # @param  [Symbol|String|Hash|NilClass] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
     #
-    def body(args = {})
-      id = args.fetch(:id, '')
+    def title(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
       klass = args.fetch(:class, '')
-      @body = content_tag(:div, id: id, class: 'panel-body ' + klass) do
-        yield if block_given?
-      end
+      data  = args.fetch(:data,  {})
+      aria  = args.fetch(:aria,  {})
+
+      content_tag(
+        tag || config({ @config_type => :title }, :h3),
+        id:    id,
+        class: "panel-title #{klass}",
+        data:  data,
+        aria:  aria,
+        &block
+      )
     end
 
-    # @description
-    # - Used to generate the footer component for the panel.
+    # Used to generate the body component for the panel.
     #
-    # @param [Hash] args
+    # @param  [Symbol|String|Hash|NilClass] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
     #
-    def footer(args = {})
-      id = args.fetch(:id, '')
+    def body(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
       klass = args.fetch(:class, '')
-      @footer = content_tag(:div, id: id, class: 'panel-footer ' + klass) do
-        yield if block_given?
-      end
+      data  = args.fetch(:data,  {})
+      aria  = args.fetch(:aria,  {})
+
+      content_tag(
+        tag || config({ @config_type => :body }, :div),
+        id:    id,
+        class: "panel-body #{klass}",
+        data:  data,
+        aria:  aria,
+        &block
+      )
+    end
+
+    # Used to generate the footer component for the panel.
+    #
+    # @param  [Symbol|String|Hash|NilClass] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
+    #
+    def footer(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
+      klass = args.fetch(:class, '')
+      data  = args.fetch(:data,  {})
+      aria  = args.fetch(:aria,  {})
+
+      content_tag(
+        tag || config({ @config_type => :footer }, :div),
+        id:    id,
+        class: "panel-footer #{klass}",
+        data:  data,
+        aria:  aria,
+        &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]
     #