bootstrap4_helper 0.0.0 → 1.0.4

data/lib/bootstrap4_helper/nav.rb

@@ -0,0 +1,113 @@
+module Bootstrap4Helper
+  # Builds a Nav Component that can be used in other components.
+  #
+  #
+  class Nav < Component
+    # Class constructor
+    #
+    # @param [ActionView]     template
+    # @param [Hash]           opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :child
+    #
+    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
+
+    # rubocop:disable Metrics/MethodLength
+
+    # 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
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :aria
+    # @return [String]
+    #
+    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
+
+    # Use this when the nav item is nothing more than a hyperlink.
+    #
+    # @param [String|NilClass] name
+    # @param [Hash|NilClass]   options
+    # @param [Hash|NilClass]   html_options
+    # @return [String]
+    #
+    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
+
+    # Creates a dropdown menu for the nav.
+    #
+    # @param [NilClass|Symbol|String] name
+    # @param [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :aria
+    # @return [String]
+    #
+    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
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    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
+  # Simple Railtie to hook out module into ActionView.
+  #
+  #
   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,44 @@
+module Bootstrap4Helper
+  # Builds a simple CSS spinner component.
+  #
+  #
+  class Spinner < Component
+    # Class constructor
+    #
+    # @note The different support types are: `:border` and `:grow`
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    # @option opts [Symbol]  :type
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    #
+    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
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    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,70 @@
+module Bootstrap4Helper
+  # Builds a Tab component.
+  #
+  #
+  class Tab < Component
+    # Class constructor
+    #
+    # @note The support types are: `:tabs` and `:pills`
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    # @option opts [Symbol]  :type
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    #
+    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
+
+    # Builds a custom Nav component for the tabs.
+    #
+    # @param  [Hash] opts
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @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
+
+    # Builds the Content object for the Tab.
+    #
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [Tab::Content]
+    #
+    def content(opts = {}, &block)
+      Content.new(@template, opts, &block)
+    end
+
+    # 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,58 @@
+module Bootstrap4Helper
+  class Tab
+    # Build a Content component to be used with Tabs
+    #
+    #
+    class Content < Component
+      # Class constructor
+      #
+      # @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)
+
+        @id      = opts.fetch(:id,    uuid)
+        @class   = opts.fetch(:class, '')
+        @data    = opts.fetch(:data,  {})
+        @content = block || proc { '' }
+      end
+
+      # Builds the pane for the tab.
+      #
+      # @param [Symbol] source
+      # @param [Hash]   opts
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @return [String]
+      #
+      def pane(source, opts = {}, &block)
+        id    = opts.fetch(:id,    source)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {})
+
+        content_tag(
+          :div,
+          id:    id,
+          class: "tab-pane #{klass}",
+          role:  'tabpanel',
+          data:  data,
+          &block
+        )
+      end
+
+      # String representation of the object.
+      #
+      # @return [String]
+      #
+      def to_s
+        content_tag :div, id: @id, class: "tab-content #{@class}" do
+          @content.call(self)
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/version.rb

@@ -1,3 +1,3 @@
 module Bootstrap4Helper
-  VERSION = '0.0.0'.freeze
+  VERSION = '1.0.4'.freeze
 end

metadata

@@ -1,29 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap4_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Robert David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 7.0.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -49,7 +139,27 @@ files:
 - README.md
 - Rakefile
 - lib/bootstrap4_helper.rb
+- lib/bootstrap4_helper/accordion.rb
+- lib/bootstrap4_helper/accordion_group.rb
+- lib/bootstrap4_helper/alert.rb
+- lib/bootstrap4_helper/badge.rb
+- lib/bootstrap4_helper/card.rb
+- lib/bootstrap4_helper/card_column.rb
+- lib/bootstrap4_helper/card_deck.rb
+- lib/bootstrap4_helper/card_group.rb
+- lib/bootstrap4_helper/card_grouping.rb
+- lib/bootstrap4_helper/component.rb
+- lib/bootstrap4_helper/configuration.rb
+- lib/bootstrap4_helper/constants.rb
+- lib/bootstrap4_helper/dropdown.rb
+- lib/bootstrap4_helper/dropdown/menu.rb
+- lib/bootstrap4_helper/initialize.rb
+- lib/bootstrap4_helper/modal.rb
+- lib/bootstrap4_helper/nav.rb
 - lib/bootstrap4_helper/railtie.rb
+- lib/bootstrap4_helper/spinner.rb
+- lib/bootstrap4_helper/tab.rb
+- lib/bootstrap4_helper/tab/content.rb
 - lib/bootstrap4_helper/version.rb
 - lib/tasks/bootstrap4_helper_tasks.rake
 homepage: https://github.com/rdavid369/bootstrap4-helper
@@ -71,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Library for rapidly building bootstrap 4 components