bootstrap4_helper 0.0.0 → 1.0.0

data/lib/bootstrap4_helper/initialize.rb

@@ -0,0 +1,24 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - 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.
+    #
+    # @return [Bootstrap4Helper::Configuration]
+    #
+    def config
+      yield @_bs4h_config if block_given?
+
+      @_bs4h_config
+    end
+  end
+end

data/lib/bootstrap4_helper/modal.rb

@@ -0,0 +1,150 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class Modal < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [Hash]
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @id         = opts.fetch(:id,         uuid)
+      @class      = opts.fetch(:class,      '')
+      @data       = opts.fetch(:data,       {})
+      @scrollable = opts.fetch(:scrollable, false)
+      @vcentered  = opts.fetch(:vcentered,  false)
+      @content    = block || proc { '' }
+    end
+
+    # @description
+    # - Build the header component for the modal.
+    #
+    # @param [Hash] opts
+    #
+    def header(opts = {}, &block)
+      build_main_component :header, opts, &block
+    end
+
+    # @description
+    # - Builds the body component.
+    #
+    # @param [Hash] opts
+    #
+    def body(opts = {}, &block)
+      build_main_component :body, opts, &block
+    end
+
+    # @description
+    # - Builds the footer component.
+    #
+    # @param [Hash] opts
+    #
+    def footer(opts = {}, &block)
+      build_main_component :footer, opts, &block
+    end
+
+    # @description
+    # - Builds a title component.
+    #
+    # @param [Hash] opts
+    #
+    def title(opts = {}, &block)
+      build_sub_component :h5, :title, opts, &block
+    end
+
+    # @description
+    # - Builds a close button component.
+    #
+    # @param [Hash] opts
+    #
+    def close_button(opts = {})
+      klass = opts.fetch(:class, '')
+
+      content_tag(
+        :button,
+        type:  'button',
+        class: block_given? ? klass : 'close',
+        data:  { dismiss: 'modal' },
+        aria:  { label: 'Close' }
+      ) do
+        block_given? ? yield : xbutton
+      end
+    end
+
+    # @description
+    # -
+    #
+    def to_s
+      content_tag :div, id: @id, class: "modal #{@class}", tabindex: -1, role: 'dialog', data: @data do
+        content_tag :div, class: "modal-dialog #{scrollable} #{vcentered}", role: 'document' do
+          content_tag(:div, class: 'modal-content') { @content.call(self) }
+        end
+      end
+    end
+
+    private
+
+    # @description
+    # - Used to build main components, usually divs.
+    #
+    # @param [Symbol|String] type
+    # @param [Hash] opts
+    #
+    def build_main_component(type, opts = {}, &block)
+      build_sub_component :div, type, opts, &block
+    end
+
+    # @description
+    # - Used to build more specific components.
+    #
+    # @param [Symbol] tag
+    # @param [Symbol|String] type
+    # @param [Hash] opts
+    #
+    def build_sub_component(tag, type, opts = {}, &block)
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+
+      content_tag(
+        tag,
+        id:    id,
+        class: "modal-#{type} #{klass}",
+        data:  data,
+        &block
+      )
+    end
+
+    # @description
+    # - Builds the `x` button normally used in the header.
+    #
+    def xbutton
+      content_tag :span, '&times;'.html_safe, aria: { hidden: true }
+    end
+
+    # @description
+    # - Gets the scrollable CSS class.
+    #
+    # @return [String]
+    #
+    def scrollable
+      @scrollable ? 'modal-dialog-scrollable' : ''
+    end
+
+    # @description
+    # - Gets the vertical-center CSS class.
+    #
+    # @return [String]
+    #
+    def vcentered
+      @vcentered ? 'modal-dialog-centered' : ''
+    end
+  end
+end

data/lib/bootstrap4_helper/nav.rb

@@ -0,0 +1,100 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # -
+  #
+  class Nav < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [NilClass|String|Symbol|Hash] context_or_options
+    # @param [Hash]
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @id       = opts.fetch(:id,    uuid)
+      @class    = opts.fetch(:class, '')
+      @data     = opts.fetch(:data,  {})
+      @child    = opts.fetch(:child, {})
+      @content  = block || proc { '' }
+
+      @dropdown = Dropdown.new(@template)
+    end
+
+    # @description
+    # - Adds an nav-item to the nav component. this method gets used when the nav-item
+    # links to content in a tab or something.
+    #
+    # @param [Symbol|String] target
+    # @param [Hash] opts
+    #
+    # rubocop:disable Metrics/MethodLength
+    def item(target, opts = {})
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+      aria  = opts.fetch(:aria,  {})
+
+      content_tag :li, id: id, class: 'nav-item', data: data do
+        content_tag(
+          :a,
+          class:    "nav-link #{klass}",
+          href:     "##{target}",
+          tabindex: -1,
+          data:     @child[:data],
+          aria:     aria
+        ) do
+          block_given? ? yield : target.to_s.titleize
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # @description
+    # - Use this when the nav item is nothing more than a hyperlink.
+    #
+    def link(name = nil, options = nil, html_options = nil, &block)
+      html_options = (html_options || {}).merge(class: 'nav-link')
+
+      @template.link_to(name, options, html_options, &block)
+    end
+
+    # @description
+    # - Creates a dropdown menu for the nav.
+    #
+    # @param [NilClass|Symbol|String] name
+    # @param [Hash] opts
+    #
+    def dropdown(name, opts = {}, &block)
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+      aria  = opts.fetch(:aria,  {}).merge(haspopup: true, expanded: false)
+
+      content_tag :li, id: id, class: 'nav-item dropdown', data: data do
+        content_tag(
+          :a,
+          name,
+          class: "nav-link dropdown-toggle #{klass}",
+          href:  '#',
+          data:  { toggle: 'dropdown' },
+          role:  'button',
+          aria:  aria
+        ) + @dropdown.menu(opts, &block).to_s.html_safe
+      end
+    end
+
+    # @description
+    # -
+    #
+    def to_s
+      content_tag :ul, id: @id, class: "nav #{@class}" do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/railtie.rb

@@ -1,4 +1,12 @@
 module Bootstrap4Helper
+  # @description
+  #
+  #
   class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        include Bootstrap4Helper if Bootstrap4Helper.config.autoload_in_views?
+      end
+    end
   end
 end

data/lib/bootstrap4_helper/spinner.rb

@@ -0,0 +1,41 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  # - a simple CSS spinner component.
+  #
+  class Spinner < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @type    = opts.fetch(:type, :border)
+      @id      = opts.fetch(:id,    uuid)
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # -
+    #
+    def to_s
+      content_tag(
+        :span,
+        id:    @id,
+        class: "spinner-#{@type} #{@class}",
+        role:  'status',
+        aria:  { hidden: true },
+        data:  @data
+      ) do
+        content_tag :span, 'Loading', class: 'sr-only'
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/tab.rb

@@ -0,0 +1,66 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  # @description
+  #
+  #
+  class Tab < Component
+    # @description
+    # -
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    # @param [Hash]
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @type    = opts.fetch(:type,  :tabs)
+      @id      = opts.fetch(:id,    uuid)
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - Builds a custom Nav component for the tabs.
+    #
+    # @param [Hash] opts
+    # @return [Nav]
+    #
+    def nav(opts = {}, &block)
+      opts[:class] = (opts[:class] || '') << " nav-#{@type}"
+      opts[:data]  = (opts[:data]  || {}).merge(toggle: 'tab')
+      opts[:child] = {
+        data: {
+          toggle: 'tab'
+        }
+      }
+
+      Nav.new(@template, opts, &block)
+    end
+
+    # @description
+    # - Builds the Content object for the Tab.
+    #
+    # @param [Hash] opts
+    # @return [Tab::Content]
+    #
+    def content(opts = {}, &block)
+      Content.new(@template, opts, &block)
+    end
+
+    # @description
+    # - This has a weird interaction.  Because this object doesn't actually return any wrapping
+    # string or DOM element, we want to return nil, so that only the output buffer on the sub components are returned.
+    # If we return the return value of the block, we will get the last element added to the input
+    # buffer as an unescaped string.
+    #
+    def to_s
+      @content.call(self)
+
+      nil
+    end
+  end
+end

data/lib/bootstrap4_helper/tab/content.rb

@@ -0,0 +1,50 @@
+# @root
+#
+#
+module Bootstrap4Helper
+  #
+  #
+  #
+  class Tab
+    #
+    #
+    #
+    class Content < Component
+      # @description
+      # -
+      #
+      # @param [ActionView] template
+      # @param [NilClass|String|Symbol|Hash] context_or_options
+      # @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
+      # -
+      #
+      def pane(source, opts = {}, &block)
+        id    = opts.fetch(:id,    nil)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {})
+
+        content_tag :div, id: source, class: "tab-pane #{klass}", role: 'tabpanel', &block
+      end
+
+      # @description
+      # -
+      #
+      def to_s
+        content_tag :div, id: @id, class: "tab-content #{@class}" do
+          @content.call(self)
+        end
+      end
+    end
+  end
+end