bootstrap3_helper 1.0.0 → 3.0.0

data/lib/bootstrap3_helper.rb

@@ -1,4 +1,6 @@
 require 'bootstrap3_helper/version'
+require 'bootstrap3_helper/configuration'
+require 'bootstrap3_helper/initialize'
 
 # Implementation files
 require 'bootstrap3_helper/component'
@@ -13,207 +15,236 @@ require 'bootstrap3_helper/tabs/dropdown'
 require 'bootstrap3_helper/tabs/menu'
 require 'bootstrap3_helper/railtie'
 
-# @description
-# - This helper module includes UI helpers that will help generate
+# This helper module includes UI helpers that will help generate
 # common Bootstrap components.
 #
 module Bootstrap3Helper
-  # @description
-  # - Allows you to rapidly build Panel components.
-  #
-  # <code>
-  #   <%= panel_helper :primary do |p| %>
-  #     <%= p.header { "Some Title" }
-  #     <%= p.body class: 'custom-class', id: 'custom-id' do %>
-  #       //HTML or Ruby code here...
+  # Easily build a bootstrap accordion group component.
+  #
+  # @note All the element ids and data attributes needed to make the javascript
+  #   function, are all synced up in the AccordionGroup and Accordion classes.
+  #   You don't need to worry about them.
+  #
+  # @example Bootstrap Accordion Group Component:
+  #   ```erb
+  #   <%= accordion_group_helper do |group| %>
+  #     <% group.accordion class: 'primary' do |accordion| %>
+  #         <%= accordion.header { "accordion 1" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 1</p>
+  #         <% end %>
   #     <% end %>
-  #     <%= p.footer do %>
-  #       //HTML or Ruby
+  #     <% group.accordion class: 'info' do |accordion| %>
+  #         <%= accordion.header { "accordion 2" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 2</p>
+  #         <% end %>
+  #     <% end %>
+  #     <% group.accordion class: 'danger' do |accordion| %>
+  #         <%= accordion.header { "accordion 3" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 3</p>
+  #         <% end %>
   #     <% end %>
   #   <% end %>
-  # </code>
+  #   ```
+  #
+  # @param  [Hash] opts
+  # @option opts [String] :id
+  # @option opts [String] :class
+  # @yieldparam [AccordionGroup] group
+  # @return [String]
+  #
+  def accordion_group_helper(opts = {}, &block)
+    AccordionGroup.new(self, opts, &block)
+  end
+
+  # Easily build a bootstrap accordion component
+  #
+  # @example Bootstrap Panel Component:
+  #   ```erb
+  #   <%= accordion_helper class: 'primary' do |accordion| %>
+  #       <%= accordion.header do %>
+  #           <span class="something">This is the heading....</span>
+  #       <% end %>
+  #       <%= accordion.body do %>
+  #           <p>This is the body of the accordion....</p>
+  #       <% end %>
+  #   <% end %>
+  #   ```
+  #
+  # @overload accordion_helper(context, opts)
+  #   @param  [Symbol|String] context - :primary, :danger etc
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
+  #
+  # @overload accordion_helper(opts)
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
   #
-  # @params [Symbol|String|Hash|NilClass] *args
+  # @yieldparam [Accordion] accordion
   # @return [String]
   #
-  def panel_helper(*args)
-    panel = Panel.new(self, *args)
-    capture { yield(panel) if block_given? }
-    panel
+  def accordion_helper(*args, &block)
+    Accordion.new(self, *args, &block)
   end
 
-  # @description
-  # - Creates an Alert component.
+  # Creates an Alert component.
   #
-  # <code>
+  # @example Bootstrap Alert Component:
+  #   ```erb
   #   <%= alert_helper :danger, dismissble: true do %>
   #     Something went wrong with your model data...
   #   <% end %>
-  # </code>
+  #   ```
+  #
+  # @overload alert_helper(context, opts)
+  #   @param  [Symbol|String] context - :primary, :danger etc
+  #   @param  [Hash] opts
+  #   @option opts [String]  :id
+  #   @option opts [String]  :class
+  #   @option opts [Boolean] :dismissible
+  #
+  # @overload alert_helper(opts)
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
   #
-  # @params [Symbol|String|Hash|NilClass] *args
   # @return [String]
   #
   def alert_helper(*args, &block)
-    alert = Alert.new(self, *args, &block)
-    alert
+    Alert.new(self, *args, &block)
   end
 
-  # @description
-  # - Creates an Callout component.
+  # Creates an Callout component.
   #
-  # <code>
+  # @example Bootstrap Callout Component:
+  #   ```erb
   #   <%= callout_helper :danger %>
   #     Some information that needs your attention...
   #   <% end %>
-  # </code>
+  #   ```
   #
-  # @params [Symbol|String|Hash|NilClass] *args
-  # @return [String]
+  # @overload callout_helper(context, opts)
+  #   @param  [Symbol|String] context - :primary, :danger etc
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
   #
-  def callout_helper(*args, &block)
-    callout = Callout.new(self, *args, &block)
-    callout
-  end
-
-  # @description
-  # - Just a easy way of checking if the environment is a devbox
-  # or a server.
+  # @overload callout_helper(opts)
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
   #
-  # @return [Boolean]
+  # @return [String]
   #
-  def host_is_dev_pc?
-    Rails.root.to_s.include?('home')
+  def callout_helper(*args, &block)
+    Callout.new(self, *args, &block)
   end
 
-  # @description
-  # - Easily build a bootstrap accordion group component.
+  # Allows you to rapidly build bootstrap glyphs.
   #
-  # @note
-  # - All the element ids and data attributes needed to make the javascript
-  # function, are all synced up in the AccordionGroup and Accordion classes.
-  # You don't need to worry about them :)
+  # @note Only supply the last part of the glyph makrup.
   #
-  # <code>
-  #   <%= accordion_group_helper do |group| %>
-  #     <% group.accordion class: 'primary' do |accordion| %>
-  #         <%= accordion.header { "accordion 1" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 1</p>
-  #         <% end %>
-  #     <%end %>
-  #     <% group.accordion class: 'info' do |accordion| %>
-  #         <%= accordion.header { "accordion 2" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 2</p>
-  #         <% end %>
-  #     <%end %>
-  #     <% group.accordion class: 'danger' do |accordion| %>
-  #         <%= accordion.header { "accordion 3" } %>
-  #         <%= accordion.body do %>
-  #             <p>This is accordion 3</p>
-  #         <% end %>
-  #     <%end %>
-  #   <% end %>
-  # </code>
+  # @example Bootstrap Glyphicon Component:
+  #   <%= icon_helper('pencil') %>
   #
-  # @yields [AccordionGroup] group
-  # @return [String]
+  # @param [String|Symbol] name
   #
-  def accordion_group_helper(*args)
-    group = AccordionGroup.new(self, *args)
-    capture { yield group if block_given? }
-    group
+  def icon_helper(name)
+    content_tag :span, '', class: "glyphicon glyphicon-#{name}"
   end
 
-  # @description
-  # - Easily build a bootstrap accordion component
+  # Allows you to rapidly build Panel components.
   #
-  #   <code>
-  #     <%= accordion_helper class: 'primary' do |accordion| %>
-  #         <%= accordion.header do %>
-  #             <span class="something">This is the heading....</span>
-  #         <% end %>
-  #         <%= accordion.body do %>
-  #             <p>This is the body of the accordion....</p>
-  #         <% end %>
+  # @example Bootstrap Panel Component:
+  #   ```erb
+  #   <%= panel_helper :default do |p| %>
+  #     <%= p.header do %>
+  #       <%= p.title { 'Some random text here' } %>
   #     <% end %>
-  #   </code>
-  #
-  # @params [Symbol|String|Hash|NilClass] *args
+  #     <%= p.body do %>
+  #       //HTML & Ruby
+  #     <% end %>
+  #   <% end %>
+  #   ```
+  #
+  # @overload panel_helper(context, opts)
+  #   @param  [String|Symbol] context - :primary, :danger etc
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
+  #   @option opts [Hash]   :data
+  #   @option opts [Hash]   :aria
+  #
+  # @overload panel_helper(opts)
+  #   @param  [Hash] opts
+  #   @option opts [String] :id
+  #   @option opts [String] :class
+  #   @option opts [Hash]   :data
+  #   @option opts [Hash]   :aria
+  #
+  # @yieldparam [Panel] panel
   # @return [String]
   #
-  def accordion_helper(*args)
-    accordion = Accordion.new(self, *args)
-    capture { yield accordion if block_given? }
-    accordion
+  def panel_helper(*args, &block)
+    Panel.new(self, *args, &block)
   end
 
-  # @description
-  # - Allows you to rapidly build bootstrap glyphs.
-  #
-  # @note
-  # - Only supply the last part of the glyph makrup.
+  # Used to rapidly build Tabs.
+  #
+  # @note On menu items - you can pass in either symbol or string for the link. If
+  #   you pass in a block, it will use the block for the title of the li.  If no
+  #   block is present, then it will titleize the symbol or string.
+  #   Tabs::Menu will respond to <code>item</code> and <code>dropdown</code>
+  #   Each method will yield the corresponding component, either a Tabs::Menu
+  #   or a Tabs::Dropdown.
+  #
+  # @example Bootstrap Tabs Component:
+  #   <%= tabs_helper type: :pills do |tabs| %>
+  #     <%= tabs.menu do |menu| %>
+  #       <%= menu.item(:testing1, class: 'active') { ' Testing 1' } %>
+  #       <%= menu.item :testing2 %>
+  #       <%= menu.item(:testing3) { ' Testing 3' } %>
+  #       <%= menu.dropdown 'Testing Dropdown' do |dropdown| %>
+  #           <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
+  #           <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
+  #           <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
+  #       <% end %>
+  #     <% end %>
   #
-  # <code>
-  #   <span class"glyphicon glyphicon-pencil"></span>
-  #   <%= icon_helper('pencil') %>
-  # </code>
+  #     <%= tabs.content do |content| %>
+  #       <%= content.pane :testing1, class: 'active' do %>
+  #           Testing 1 content
+  #       <% end %>
+  #       <%= content.pane :testing2 do %>
+  #           Testing 2 content
+  #       <% end %>
+  #       <%= content.pane :testing3 do %>
+  #           Testing 3 content
+  #       <% end %>
+  #       <%= content.pane :testing5 do %>
+  #           Testing 5 content
+  #       <% end %>
+  #       <%= content.pane :testing6 do %>
+  #           Testing 6 content
+  #       <% end %>
+  #       <%= content.pane :testing7 do %>
+  #           Testing 7 content
+  #       <% end %>
+  #     <% end %>
+  #   <% end %>
   #
-  # @param [String|Symbol] name
+  # @param  [Hash] opts
+  # @option args [String|Symbol] :type
+  # @option args [String]        :id
+  # @option args [String]        :class
+  # @yieldparam [Tabs] tabs
+  # @return [String]
   #
-  def icon_helper(name = '')
-    content_tag :span, '', class: 'glyphicon glyphicon-' + name.to_s
-  end
-
-  # @description
-  # - Used to rapidly build Tabs.
-  #
-  # @note
-  # - On menu items - you can pass in either symbol or string for the link. If
-  # you pass in a block, it will use the block for the title of the li.  If no
-  # block is present, then it will titleize the symbol or string.
-  #
-  # Tabs::Menu will respond to <code>item</code> and <code>dropdown</code>
-  # Each method will yield the corresponding component, either a Tabs::Menu
-  # or a Tabs::Dropdown.
-  #
-  # <code>
-  #  <%= tabs_helper type: :pills do |menu, content| %>
-  #    <% menu.item(:testing1, class: 'active') { ' Testing 1' } %>
-  #    <% menu.item :testing2 %>
-  #    <% menu.item(:testing3) { ' Testing 3' } %>
-  #    <% menu.dropdown 'Testing Dropdown' do |dropdown| %>
-  #        <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
-  #        <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
-  #        <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
-  #    <% end %>
-  #
-  #
-  #    <% content.item :testing1, class: 'active' do %>
-  #        Testing 1 content
-  #    <% end %>
-  #    <% content.item :testing2 do %>
-  #        Testing 2 content
-  #    <% end %>
-  #    <% content.item :testing3 do %>
-  #        Testing 3 content
-  #    <% end %>
-  #    <% content.item :testing5 do %>
-  #        Testing 5 content
-  #    <% end %>
-  #    <% content.item :testing6 do %>
-  #        Testing 6 content
-  #    <% end %>
-  #    <% content.item :testing7 do %>
-  #        Testing 7 content
-  #    <% end %>
-  #  <% end %>
-  # </code>
-  #
-  def tabs_helper(args = {})
-    tabs = Tabs.new(self, args)
-    capture { yield(tabs.menu, tabs.content) if block_given? }
-    tabs
+  def tabs_helper(opts = {}, &block)
+    Tabs.new(self, opts, &block)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap3_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Robert David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,14 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.6
+        version: 5.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.6
+        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: 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: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +138,8 @@ files:
 - lib/bootstrap3_helper/alert.rb
 - lib/bootstrap3_helper/callout.rb
 - lib/bootstrap3_helper/component.rb
+- lib/bootstrap3_helper/configuration.rb
+- lib/bootstrap3_helper/initialize.rb
 - lib/bootstrap3_helper/panel.rb
 - lib/bootstrap3_helper/railtie.rb
 - lib/bootstrap3_helper/tabs.rb
@@ -118,7 +148,7 @@ files:
 - lib/bootstrap3_helper/tabs/menu.rb
 - lib/bootstrap3_helper/version.rb
 - lib/tasks/bootstrap3_helper_tasks.rake
-homepage: https://github.com/rdavid369/bootstrap3-helper/blob/master/lib/bootstrap3_helper.rb
+homepage: https://github.com/rdavid369/bootstrap3-helper
 licenses:
 - MIT
 metadata: {}
@@ -137,8 +167,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.6
 signing_key: 
 specification_version: 4
 summary: Simple gem for rapidly building bootstrap 3 components