bootstrap4_helper 0.0.0 → 1.0.0

data/lib/bootstrap4_helper/card_group.rb

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

data/lib/bootstrap4_helper/card_grouping.rb

@@ -0,0 +1,35 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class CardGrouping < Component
+    # @description
+    # - Used to initialize a new Card Group.
+    #
+    # @param [Class] 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 a `Card` for the grouping class.
+    #
+    # @param [Hash] opts
+    # @return [Card]
+    #
+    def card(opts = {}, &block)
+      Card.new(@template, opts, &block)
+    end
+  end
+end

data/lib/bootstrap4_helper/component.rb

@@ -0,0 +1,110 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - 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
+  # - 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
+    # rendering and bindings.
+    #
+    # @param [Class] 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
+    # proper template binding of variables and methods!
+    #
+    # @return [String]
+    #
+    def content_tag(
+      name,
+      content_or_options_with_block = nil,
+      options = nil,
+      escape = true,
+      &block
+    )
+      @template.content_tag(
+        name,
+        content_or_options_with_block,
+        options,
+        escape,
+        &block
+      )
+    end
+
+    # @description
+    # -
+    #
+    def capture(*args)
+      @template.capture(*args)
+    end
+
+    # @description
+    # - 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
+    #
+    def concat(text)
+      @template.concat(text)
+    end
+
+    # @description
+    # - 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
+    # @return [Array]
+    #
+    def parse_arguments(*args)
+      first, second = *args
+      case first
+      when Hash, NilClass
+        ['secondary', first || second]
+      when Symbol, String
+        [first, second]
+      end
+    end
+
+    # @description
+    # - Used to generate a (hopefully) unique ID for DOM elements.  Used as a
+    # fallback if the user doesn't specify one.
+    #
+    # @return [String]
+    #
+    def uuid
+      (0...10).map { rand(65..90).chr }.join
+    end
+
+    # @description
+    # - Used to get config settings inside of components quicker.
+    #
+    # @param [Symbol] setting
+    # @return [Mixed]
+    #
+    def config(setting, fallback)
+      Bootstrap4Helper.config.send(setting) || fallback
+    end
+  end
+end

data/lib/bootstrap4_helper/configuration.rb

@@ -0,0 +1,36 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class Configuration
+    DEFAULT_SETTINGS = {
+      autoload_in_views: true,
+      card_title:        :h5,
+      card_text:         :p,
+      accordion_header:  :h5,
+      badge:             :span
+    }.freeze
+
+    attr_accessor(*DEFAULT_SETTINGS.keys)
+
+    # @description
+    # -
+    #
+    # @params [Hash] args
+    # @return [ClassName]
+    #
+    def initialize(_args = {})
+      DEFAULT_SETTINGS.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    # @description
+    # - Simple predicate method
+    #
+    def autoload_in_views?
+      @autoload_in_views
+    end
+  end
+end

data/lib/bootstrap4_helper/constants.rb

@@ -0,0 +1,30 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - Simple class for storing constants
+  #
+  class Constants
+    COMPONENTS = %i[
+      component
+      alert
+      accordion
+      accordion_group
+      badge
+      card
+      card_grouping
+      card_group
+      card_deck
+      card_column
+      configuration
+      dropdown
+      dropdown/menu
+      modal
+      nav
+      spinner
+      tab
+      tab/content
+    ].freeze
+  end
+end

data/lib/bootstrap4_helper/dropdown.rb

@@ -0,0 +1,92 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class Dropdown < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [Symbol|String] type
+    # @param [Hash] opts
+    # @param [Hash]
+    #
+    def initialize(template, type = :dropdown, opts = {}, &block)
+      super(template)
+
+      @type    = type
+      @id      = opts.fetch(:id,    uuid)
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - 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
+    # @return [String]
+    #
+    def button(context = :primary, opts = {})
+      split = opts.fetch(:split, false)
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {}).merge(toggle: 'dropdown')
+      extra = split ? 'dropdown-toggle-split' : ''
+
+      content_tag(
+        :button,
+        id:    id,
+        type:  'button',
+        class: "dropdown-toggle btn btn-#{context} #{klass} #{extra}",
+        data:  data,
+        aria:  { haspopup: true, expanded: false }
+      ) do
+        split ? content_tag(:span, 'Toggle Dropdwon', class: 'sr-only') : yield
+      end
+    end
+
+    # @description
+    # - Used to create a new `Dropdown::Menu`
+    #
+    # @param [Hash] opts
+    # @return [Dropdown::Menu]
+    #
+    def menu(opts = {}, &block)
+      Menu.new(@template, opts, &block)
+    end
+
+    # @description
+    # -
+    #
+    def to_s
+      content_tag :div, id: @id, class: "#{container_class} #{@class}", data: @data do
+        @content.call(self)
+      end
+    end
+
+    private
+
+    # @description
+    # - Returns the container class for the dropdown component.
+    #
+    # @return [String]
+    #
+    def container_class
+      case @type
+      when :dropdown
+        'dropdown'
+      when :group
+        'btn-group'
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/dropdown/menu.rb

@@ -0,0 +1,123 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  class Dropdown
+    # @description
+    #
+    #
+    class Menu < Component
+      # @description
+      # -
+      #
+      # @param [ActionView] template
+      # @param [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
+      # - Use this method when the `item`, `link` in the item in the menu  is nothing
+      # more than a hyperlink.
+      #
+      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
+      # content.
+      #
+      # @param [Symbol|String] target
+      # @param [Hash] opts
+      #
+      def item(target, opts = {})
+        id    = opts.fetch(:id,    nil)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {}).merge(toggle: 'tab')
+        aria  = opts.fetch(:aria,  {})
+
+        content_tag(
+          :a,
+          id:    id,
+          class: "dropdown-item #{klass}",
+          href:  "##{target}",
+          aria:  aria,
+          data:  data
+        ) do
+          block_given? ? yield : target.to_s.titleize
+        end
+      end
+
+      # @description
+      # - Builds a Text component
+      #
+      # @param [Symbol|String] text
+      # @param [Hash] opts
+      #
+      def text(text, opts = {}, &block)
+        build_sub_component :span, text, 'item-text', opts, &block
+      end
+
+      # @description
+      # - Builds a Header component
+      #
+      # @param [Symbol|String] text
+      # @param [Hash] opts
+      #
+      def header(text, opts = {}, &block)
+        build_sub_component :h6, text, 'header', opts, &block
+      end
+
+      # @description
+      # - Builds a divider element
+      #
+      def divider
+        content_tag :div, '', class: 'dropdown-divider'
+      end
+
+      # @description
+      # -
+      #
+      def to_s
+        content_tag :div, id: @id, class: "dropdown-menu #{@class}", data: @data do
+          @content.call(self)
+        end
+      end
+
+      private
+
+      # @description
+      # - Used to build specific components.
+      #
+      # @param [Symbol] tag
+      # @param [Symbol|String] text
+      # @param [Symbol|String] type
+      # @param [Hash] opts
+      #
+      def build_sub_component(tag, text, type, opts)
+        id    = opts.fetch(:id,    nil)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {})
+
+        content_tag(
+          tag,
+          id:    id,
+          class: "dropdown-#{type} #{klass}",
+          data:  data
+        ) do
+          block_given? ? yield : text || ''
+        end
+      end
+    end
+  end
+end