bootstrap4_helper 0.0.0 → 1.0.0

data/lib/bootstrap4_helper/accordion.rb

@@ -0,0 +1,106 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - Builds a Accordion out of the collapse component of Bootstrap 4.
+  #
+  class Accordion < Component
+    CARD_METHODS = %i[
+      title
+      text
+      image_overlay
+    ].freeze
+
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @id      = opts.fetch(:id,      uuid)
+      @class   = opts.fetch(:class,   '')
+      @data    = opts.fetch(:data,    {})
+      @parent  = opts.fetch(:parent,  nil)
+      @target  = @data.fetch(:target, uuid)
+      @content = block || proc { '' }
+      @card    = Card.new(@template)
+    end
+
+    # @description
+    # - Builds a header component for the accordion, which is actually the header
+    # of a Card.
+    #
+    # @param [Hash] opts
+    # @return [String]
+    #
+    def header(opts = {}, &block)
+      @card.header(opts) do
+        content_tag(config(:accordion_header, :h5)) do
+          content_tag(
+            :a,
+            data: { toggle: 'collapse', target: "##{@target}" },
+            &block
+          )
+        end
+      end
+    end
+
+    # @description
+    # - Builds the body component for the accordion, which is actually the body
+    # of a Card.
+    #
+    # @note
+    # - The `@parent` gets used to set the parent element for the accordion. This
+    # gets used primarily in the `AccordionGroup`.
+    #
+    # @param [Hash] opts
+    # @return [String]
+    #
+    def body(opts = {}, &block)
+      data = { parent: "##{@parent}" } if @parent.present?
+
+      content_tag :div, id: @target, class: 'collapse', data: data do
+        @card.body(opts, &block)
+      end
+    end
+
+    # @description
+    # - Because Accordions are basically `Cards` with a wrapper, we might as
+    # well catch common `Card` methods and send them to the card object.  No
+    # point in creating similar methods for `Accordions`.
+    #
+    # @param [Symbol|String] method
+    # @param [Mixed] args
+    #
+    def method_missing(method, *args, &block)
+      if CARD_METHODS.include?(method)
+        @card.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    # @description
+    # -
+    #
+    def respond_to_missing?(method, include_private = false)
+      CARD_METHODS.include?(method) || super
+    end
+
+    # @description
+    # - Leaving off the the default `accordion` class because with only 1 accordion,
+    # there is no bottom.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag :div, class: "card #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/accordion_group.rb

@@ -0,0 +1,54 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - Used to build groups of Accordions, that are all synced with each other.
+  #
+  class AccordionGroup < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [NilClass|String|Symbol|Hash] opts
+    # @param [Hash]
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @id      = opts.fetch(:id,      uuid)
+      @class   = opts.fetch(:class,   '')
+      @data    = opts.fetch(:data,    {})
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - Used to build a `Accordion` for the `AccordionGroup`.
+    #
+    # @param [Mixed] args
+    # @return [Accordion]
+    #
+    def accordion(*args, &block)
+      opts = *args
+
+      if opts.any? { |opt| opt.is_a?(Hash) }
+        opts.collect! { |opt| opt[:parent] = @id if opt.is_a?(Hash) }
+      else
+        opts << { parent: @id }
+      end
+
+      Accordion.new(self, *opts, &block)
+    end
+
+    # @description
+    # - Used to get the HTML markup of the `AccordionGroup`
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag :div, id: @id, class: "accordion #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/alert.rb

@@ -0,0 +1,79 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - 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.
+    #
+    # @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 [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 { '' }
+    end
+
+    # @description
+    # - 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(:span, aria: { hidden: true }) { '&times;'.html_safe }
+      end
+    end
+
+    # @description
+    # - Used to render out the Alert component.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag :div, id: @id, class: container_class do
+        concat(@dismissible ? close_button : '')
+        @content.call(self)
+      end
+    end
+
+    private
+
+    # @description
+    # - Used to get the container classes.
+    #
+    # @return [String]
+    #
+    def container_class
+      "alert alert-#{@context} #{@class}"
+    end
+  end
+end

data/lib/bootstrap4_helper/badge.rb

@@ -0,0 +1,46 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - Creates Bootstrap badge components that can be used anywhere.
+  #
+  class Badge < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [NilClass|String|Symbol|Hash] context_or_options.
+    # @param [Hash]  opts
+    #
+    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, '')
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # -
+    #
+    def to_s
+      content_tag(config(:badge, :span), id: @id, class: container_class) { @content.call(self) }
+    end
+
+    private
+
+    # @description
+    # - Used to get the container classes.
+    #
+    # @return [String]
+    #
+    def container_class
+      string = 'badge '
+      string += @context == 'secondary' ? 'badge-secondary' : "badge-#{@context}"
+      string += " #{@class}"
+      string
+    end
+  end
+end

data/lib/bootstrap4_helper/card.rb

@@ -0,0 +1,129 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - Used to build Bootstrap Card components.  Cards are wildly used through Bootstrap 4.
+  #
+  class Card < Component
+    # @description
+    # - Used to initialize a new Card component.
+    #
+    # @param [ActionView] template
+    # @param [Hash]  opts
+    # @return [Card]
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @id      = opts.fetch(:id,    '')
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  nil)
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - Builds the Header component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def header(args = {}, &block)
+      build_base_component :header, args, &block
+    end
+
+    # @description
+    # - Builds the Body component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def body(args = {}, &block)
+      build_base_component :body, args, &block
+    end
+
+    # @description
+    # - Builds the Footer component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def footer(args = {}, &block)
+      build_base_component :footer, args, &block
+    end
+
+    # @description
+    # - Builds a Title component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def title(args = {}, &block)
+      build_sub_component config(:card_title, :h5), :title, args, &block
+    end
+
+    # @description
+    # - Builds a Text component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def text(args = {}, &block)
+      build_sub_component config(:card_text, :p), :text, args, &block
+    end
+
+    # @description
+    # - Builds a Img Overlay component.
+    #
+    # @param [Hash] args
+    # @return [String]
+    #
+    def image_overlay(args = {}, &block)
+      build_base_component 'img-overlay', args, &block
+    end
+
+    # @description
+    # - Outputs the Object in its String representation.
+    #
+    def to_s
+      content_tag :div, id: @id, class: "card #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+
+    private
+
+    # @description
+    # - Used to build basic DIV components.
+    #
+    # @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
+    # @return [String]
+    #
+    def build_sub_component(tag, type, args, &block)
+      id    = args.fetch(:id,    '')
+      klass = args.fetch(:class, '')
+      data  = args.fetch(:data,  {})
+
+      content_tag(
+        tag,
+        id:    id,
+        class: "card-#{type} #{klass}",
+        data:  data,
+        &block
+      )
+    end
+  end
+end

data/lib/bootstrap4_helper/card_column.rb

@@ -0,0 +1,18 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class CardColumn < CardGrouping
+    # @description
+    # -
+    #
+    def to_s
+      content_tag :div, id: @id, class: "card-columns #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/card_deck.rb

@@ -0,0 +1,18 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class CardDeck < CardGrouping
+    # @description
+    # -
+    #
+    def to_s
+      content_tag :div, id: @id, class: "card-deck #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+  end
+end