bootstrap4_helper 1.0.0 → 1.1.0

data/lib/bootstrap4_helper/nav.rb

@@ -1,17 +1,16 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # -
+  # Builds a Nav Component that can be used in other components.
+  #
   #
   class Nav < Component
-    # @description
-    # -
+    # Class constructor
     #
-    # @param [ActionView] template
-    # @param [NilClass|String|Symbol|Hash] context_or_options
-    # @param [Hash]
+    # @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)
@@ -25,14 +24,19 @@ module Bootstrap4Helper
       @dropdown = Dropdown.new(@template)
     end
 
-    # @description
-    # - Adds an nav-item to the nav component. this method gets used when the nav-item
+    # 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]
     #
-    # rubocop:disable Metrics/MethodLength
     def item(target, opts = {})
       id    = opts.fetch(:id,    nil)
       klass = opts.fetch(:class, '')
@@ -54,8 +58,12 @@ module Bootstrap4Helper
     end
     # rubocop:enable Metrics/MethodLength
 
-    # @description
-    # - Use this when the nav item is nothing more than a hyperlink.
+    # 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')
@@ -63,11 +71,15 @@ module Bootstrap4Helper
       @template.link_to(name, options, html_options, &block)
     end
 
-    # @description
-    # - Creates a dropdown menu for the nav.
+    # 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)
@@ -88,8 +100,9 @@ module Bootstrap4Helper
       end
     end
 
-    # @description
-    # -
+    # String representation of the object.
+    #
+    # @return [String]
     #
     def to_s
       content_tag :ul, id: @id, class: "nav #{@class}" do

data/lib/bootstrap4_helper/page_header.rb

@@ -0,0 +1,38 @@
+module Bootstrap4Helper
+  # Builds a simple CSS spinner component.
+  #
+  #
+  class PageHeader < 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
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag(
+        config(:page_header, :h1),
+        id:    @id,
+        class: "pb-2 mt-4 mb-2 border-bottom #{@class}",
+        data:  @data
+      ) do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap4_helper/railtie.rb

@@ -1,5 +1,5 @@
 module Bootstrap4Helper
-  # @description
+  # Simple Railtie to hook out module into ActionView.
   #
   #
   class Railtie < ::Rails::Railtie

data/lib/bootstrap4_helper/spinner.rb

@@ -1,16 +1,18 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
-  # - a simple CSS spinner component.
+  # Builds a simple CSS spinner component.
+  #
   #
   class Spinner < Component
-    # @description
-    # -
+    # 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)
@@ -22,8 +24,9 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # -
+    # String representation of the object.
+    #
+    # @return [String]
     #
     def to_s
       content_tag(

data/lib/bootstrap4_helper/tab.rb

@@ -1,17 +1,18 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  # @description
+  # Builds a Tab component.
   #
   #
   class Tab < Component
-    # @description
-    # -
+    # Class constructor
+    #
+    # @note The support types are: `:tabs` and `:pills`
     #
     # @param [ActionView] template
     # @param [Hash] opts
-    # @param [Hash]
+    # @option opts [Symbol]  :type
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
     #
     def initialize(template, opts = {}, &block)
       super(template)
@@ -23,10 +24,11 @@ module Bootstrap4Helper
       @content = block || proc { '' }
     end
 
-    # @description
-    # - Builds a custom Nav component for the tabs.
+    # Builds a custom Nav component for the tabs.
     #
-    # @param [Hash] opts
+    # @param  [Hash] opts
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
     # @return [Nav]
     #
     def nav(opts = {}, &block)
@@ -41,19 +43,21 @@ module Bootstrap4Helper
       Nav.new(@template, opts, &block)
     end
 
-    # @description
-    # - Builds the Content object for the Tab.
+    # Builds the Content object for the Tab.
     #
-    # @param [Hash] opts
+    # @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
 
-    # @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.
+    # 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.
     #

data/lib/bootstrap4_helper/tab/content.rb

@@ -1,21 +1,16 @@
-# @root
-#
-#
 module Bootstrap4Helper
-  #
-  #
-  #
   class Tab
-    #
+    # Build a Content component to be used with Tabs
     #
     #
     class Content < Component
-      # @description
-      # -
+      # Class constructor
       #
       # @param [ActionView] template
-      # @param [NilClass|String|Symbol|Hash] context_or_options
-      # @param [Hash]
+      # @param [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
       #
       def initialize(template, opts = {}, &block)
         super(template)
@@ -26,19 +21,32 @@ module Bootstrap4Helper
         @content = block || proc { '' }
       end
 
-      # @description
-      # -
+      # 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,    nil)
+        id    = opts.fetch(:id,    source)
         klass = opts.fetch(:class, '')
         data  = opts.fetch(:data,  {})
 
-        content_tag :div, id: source, class: "tab-pane #{klass}", role: 'tabpanel', &block
+        content_tag(
+          :div,
+          id:    id,
+          class: "tab-pane #{klass}",
+          role:  'tabpanel',
+          data:  data,
+          &block
+        )
       end
 
-      # @description
-      # -
+      # String representation of the object.
+      #
+      # @return [String]
       #
       def to_s
         content_tag :div, id: @id, class: "tab-content #{@class}" do

data/lib/bootstrap4_helper/version.rb

@@ -1,3 +1,3 @@
 module Bootstrap4Helper
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap4_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 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: 4.2.11
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 4.2.11
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: bootstrap
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 5.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        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
@@ -108,6 +156,7 @@ files:
 - lib/bootstrap4_helper/initialize.rb
 - lib/bootstrap4_helper/modal.rb
 - lib/bootstrap4_helper/nav.rb
+- lib/bootstrap4_helper/page_header.rb
 - lib/bootstrap4_helper/railtie.rb
 - lib/bootstrap4_helper/spinner.rb
 - lib/bootstrap4_helper/tab.rb
@@ -133,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Library for rapidly building bootstrap 4 components