bootstrap3_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7690ea3af6632902048f7f389e97a9c2317e007c6dab849b754fabe805a7357e
+  data.tar.gz: 2c8234630ce566f379f1d1a46d9ab7e47e958c3b1059df4aa41a0003a27700bc
+SHA512:
+  metadata.gz: d54b3740ae4f7bd45adcea82506ebe65fae16dcca0837c42e83ada33480c67053acaee9112ffe7029283d2d4babe71d0cfbe9183e97b8d30e886527fd2cf70e5
+  data.tar.gz: 5e42f3ff987c0e32aa5f2b5dd94c744abc7d4afbadeb41ee17da5b1cfd64b5975a123aa4d3d135e9dd2871fa9abd1ee3ec7d6862cd41d53a8bc41ece2e9a6ea8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Robert David
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# Bootstrap3Helper
+
+This gem was designed to help you rapidly build common Bootstrap 3 Components. They where designed to very flexible and reduce a lot of boiler plate HTML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bootstrap3_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bootstrap3_helper
+
+## Usage
+
+`Panel Helper`
+
+```erb
+<%= panel_helper :primary do |p| %>
+  <%= p.header id: 'optional-id', class: 'any-optional-extra-classes' do %>
+    Some Header for your panel
+  <% end %>
+  <%= p.body id: 'optional-id', class: 'any-optional-extra-classes' do %>
+     All your custom HTML or Ruby.  You can render blocks here, whatever
+  <% end%>
+  <% p.footer id: 'optional-id', class: 'any-optional-extra-classes' do %>
+    You don't need to have a footer but if you do, you can put your
+    HTML and Ruby in here as well.
+  <% end %>
+end
+```
+
+---
+
+`Alert Helper`
+
+```erb
+<%= alert_helper :success { 'Some success message' } %>
+
+<!-- or -->
+
+<%= alert_helper :danger, dismissable: true do %>
+    HTML and/or Ruby
+<% end %>
+```
+
+---
+
+`Accordion Helper`
+
+```erb
+<%= accordion_helper :primary, { class: 'optional-class', id: 'optional_id', collapse_id: 'optional_collapse_id', expanded: true } 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 %>
+```
+
+**Note:** the accordion helper handles all the attributes and data attributes needed to sync up the javascript in order to give the component its functionality. You just worry about about the class or state of the component. The helper does the rest. But if you do want to control the collapse ID and syncing, `collapse_id` is the attribute you are looking for.
+
+---
+
+`AccordionGroup Helper`
+
+```erb
+<%= accordion_group_helper do |g| %>
+    <% g.accordion :primary do |accordion| %>
+        <%= accordion.header { "Accordion 1" } %>
+        <%= accordion.body do %>
+            <p>This is accordion 1</p>
+        <% end %>
+    <%end %>
+    <% g.accordion :info do |accordion| %>
+        <%= accordion.header { "Accordion 2" } %>
+        <%= accordion.body do %>
+            <p>This is accordion 2</p>
+        <% end %>
+    <% end %>
+    <% g.accordion :danger do |accordion| %>
+        <%= accordion.header { "Accordion 3" } %>
+        <%= accordion.body do %>
+            <p>This is accordion 3</p>
+        <% end %>
+    <%end %>
+<% end %>
+```
+
+**Note:** the accordion_group helper handles all the attributes and data attributes needed to sync up the javascript in order to give the component its functionality. You just worry about about the class or state of the individual accordions. The helper does the rest.
+
+---
+
+`Panel Helper`
+
+```erb
+<%= 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 %>
+```
+
+---
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rdavid369/bootstrap3-helper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bootstrap3Helper'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/bootstrap3_helper/accordion.rb

@@ -0,0 +1,174 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - Used to generate Bootstrap Accordion objects.
+  #
+  #  <code>
+  #    <%= accordion_helper :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 %>
+  #  </code>
+  #
+  class Accordion < Component
+    # @description
+    # - Initlize a new accordion object.  If this part of a parent element, i.e
+    # AccordionGroup, we need to keep track of the parent element id, so we can
+    # pass it down to the other components.
+    #
+    # @param [Class] template - Template in which your are binding too.
+    # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+    # @param [Hash] opts
+    #   <code>
+    #      args = {
+    #        parent_id:   [String]
+    #        id:          [String]
+    #        class:       [String]
+    #        collapse_id: [String]
+    #        expanded:    Boolean
+    #      }
+    #   </code>
+    # @return [Accordion]
+    #
+    def initialize(template, context_or_options = nil, opts = {})
+      super(template)
+      @context, args = parse_arguments(context_or_options, opts)
+
+      @parent_id   = args.fetch(:parent_id, nil)
+      @id          = args.fetch(:id, nil)
+      @class       = args.fetch(:class, '')
+      @collapse_id = args.fetch(:collapse_id, uuid)
+      @expanded    = args.fetch(:expanded, false)
+    end
+
+    # @description
+    # - Creates the header element for the accordion
+    #
+    # @note
+    # - NilClass :to_s  returns an empty String
+    #
+    # @params [Hash] args
+    #   <code>
+    #      args = {
+    #        id:      [String]
+    #        class:   [String]
+    #        data:    [Hash]
+    #      }
+    #   </code>
+    #
+    # @yields [Accordion] self
+    # @return [NilClass]
+    #
+    # rubocop:disable Metrics/MethodLength
+    def header(args = {})
+      id    = args.fetch(:id, nil)
+      klass = args.fetch(:class, '')
+      data  = args.fetch(:data, {})
+
+      data[:toggle] = 'collapse'
+      data[:parent] = "##{@parent_id}"
+
+      @header = content_tag :div, id: id, class: 'panel-heading ' + klass do
+        content_tag :h3, class: 'panel-title' do
+          content_tag :a, href: "##{@collapse_id}", data: data do
+            content = yield if block_given?
+            content.to_s.html_safe
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # @description
+    # - Creates the body element for the accordion.
+    #
+    # @note
+    # - NilClass :to_s  returns an empty String
+    #
+    # @params [Hash] args
+    #   <code>
+    #      args = {
+    #        id:      [String]
+    #        class:   [String]
+    #        data:    [Hash]
+    #      }
+    #   </code>
+    #
+    # @yields [Accordion] self
+    # @return [nilClass]
+    #
+    #
+    def body(args = {})
+      klass = 'panel-collapse collapse '
+      data  = args.fetch(:data, {})
+      klass += args.fetch(:class, '')
+      klass += ' in' if @expanded
+
+      @body = content_tag :div, id: @collapse_id, class: klass do
+        content_tag :div, class: 'panel-body', data: data do
+          content = yield if block_given?
+          content.to_s.html_safe
+        end
+      end
+    end
+
+    # @description
+    # - Creates the footer element for the accordion
+    #
+    # @params [Hash] args
+    #   <code>
+    #      args = {
+    #        id:      [String]
+    #        class:   [String]
+    #        data:    [Hash]
+    #      }
+    #   </code>
+    #
+    # @yields [Accordion] self
+    # @return [nilClass]
+    #
+    #
+    def footer(args = {})
+      id    = args.fetch(:id, nil)
+      klass = args.fetch(:class, '')
+      data  = args.fetch(:data, {})
+
+      @footer = content_tag :div, id: id, class: 'panel-footer ' + klass, data: data do
+        content = yield if block_given?
+        content.to_s.html_safe
+      end
+    end
+
+    # @description
+    # - The to string method here is what is responsible for rendering out the
+    # accordion element.  As long as the main method is rendered out in the
+    # helper, you will get the entire accordion.
+    #
+    # @return [String]
+    #
+    def to_s
+      content = content_tag :div, id: @id, class: container_classes do
+        @header + @body + @footer
+      end
+
+      content
+    end
+
+    private
+
+    # @description
+    # - Used to get the container element classes
+    #
+    # @return [String]
+    #
+    def container_classes
+      "panel panel-#{@context} #{@class}"
+    end
+  end
+end

data/lib/bootstrap3_helper/accordion_group.rb

@@ -0,0 +1,88 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - This class is used to general groups of accordions.
+  #
+  # <code>
+  #   <%= accordion_group_helper do |group| %>
+  #     <%= group.accordion :primary do |accordion| %>
+  #         <%= accordion.header { "accordion 1" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 1</p>
+  #         <% end %>
+  #     <% end %>
+  #     <%= group.accordion :info do |accordion| %>
+  #         <%= accordion.header { "accordion 2" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 2</p>
+  #         <% end %>
+  #     <% end %>
+  #     <%= group.accordion :danger do |accordion| %>
+  #         <%= accordion.header { "accordion 3" } %>
+  #         <%= accordion.body do %>
+  #             <p>This is accordion 3</p>
+  #         <% end %>
+  #     <% end %>
+  #   <% end %>
+  # </code>
+  #
+  class AccordionGroup < Component
+    # @description
+    # - Used to initialize the main object.  This objects sole purpose is to
+    # generate a wrapper element with a distinct id and pass that id down to
+    # all the child elements.
+    #
+    def initialize(template, opts = {})
+      super(template)
+      @accordions = []
+      @id = opts.fetch(:id, uuid)
+      @class = opts.fetch(:class, '')
+    end
+
+    # @description
+    # - This method is the main method for generating individual accordions.
+    # This is where you would pass in the html attributes.
+    #
+    # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+    # @param [Hash] opts
+    # <code>
+    #    args = {
+    #      id:      [String]
+    #      class:   [String]
+    #    }
+    # </code>
+    #
+    # @yields [Accordion] accordion
+    # @return [nilClass]
+    #
+    def accordion(context_or_options = nil, opts = {})
+      if context_or_options.is_a?(Hash)
+        context_or_options[:parent_id] = @id
+      else
+        opts[:parent_id] = @id
+      end
+
+      accordion = Accordion.new(@template, context_or_options, opts)
+      yield accordion if block_given?
+
+      @accordions.push(accordion)
+    end
+
+    # @description
+    # - The to string method here is what is responsible for rendering out the
+    # entire accordion.  As long as the main method is rendered out in the helper,
+    # you will get all the contents.
+    #
+    # @return [String]
+    #
+    def to_s
+      content = content_tag :div, id: @id, class: "panel-group #{@class}" do
+        @accordions.map(&:to_s).join.html_safe
+      end
+
+      content
+    end
+  end
+end

data/lib/bootstrap3_helper/alert.rb

@@ -0,0 +1,88 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - The Alert helper is meant to help you rapidly build Bootstrap Alert
+  # components quickly and easily. The dissmiss button is optional.
+  #
+  #   <code>
+  #     <%= alert_helper :warning, dismissable: true do %>
+  #       <% if @model.errors.present? %>
+  #         <p>Some kind of error</p>
+  #       <% end %>
+  #     <% end %>
+  #
+  #     <%= alert_helper(:success, dismissible: true) { "Successful save"}
+  #   </code>
+  #
+  class Alert < Component
+    # @description
+    # - Used to generate Bootstrap alert components quickly.
+    #
+    # @param [Class] template - Template in which your are binding too.
+    # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+    # @param [Hash]  opts
+    #   <code>
+    #     opts = {
+    #       id:     [String] - ID of the alert box
+    #       class:  [String] - Additional classes for the alert box
+    #     }
+    #   </code>
+    # @param [Proc] &block
+    # @return [Alert]
+    #
+    def initialize(template, context_or_options = nil, opts = {}, &block)
+      super(template)
+      @context, args = parse_arguments(context_or_options, opts)
+
+      @id = args.fetch(:id, nil)
+      @class = args.fetch(:class, '')
+      @dismissible = args.fetch(:dismissible, false)
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - The dissmiss button, if the element has one.
+    #
+    # @return [String]
+    #
+    def close_button
+      content_tag(:button, class: 'close', data: { dismiss: 'alert' }, aria: { label: 'Close' }) do
+        content_tag(:span, aria: { hidden: true }) { '&times;'.html_safe }
+      end
+    end
+
+    # @description
+    # - Used to render out the Alert component.
+    #
+    # @note
+    # - concat needs to be used to add the content of the button to the output
+    # buffer.  For some reason, if though the block returns a String, trying to
+    # add that string to the dismiss button string, returns with the dismiss
+    # button missing.  Was forced to caoncat the button to the current output
+    # buffer in order to get it to persist after the block call.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag :div, id: @id, class: container_class do
+        concat(@dismissible ? close_button : '') + @content.call
+      end
+    end
+
+    private
+
+    # @description
+    # - Used to get the container classes.
+    #
+    # @return [String]
+    #
+    def container_class
+      string = 'alert '
+      string += @context == 'default' ? 'alert-info' : "alert-#{@context}"
+      string += " #{@class}"
+      string
+    end
+  end
+end

data/lib/bootstrap3_helper/callout.rb

@@ -0,0 +1,55 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - Used to generate Bootstrap callout component quickly.
+  #
+  # @param [Class] template - Template in which your are binding too.
+  # @param [NilClass|String|Symbol|Hash] - Bootstrap class context, or options hash.
+  # @param [Hash]  opts
+  #   <code>
+  #     opts = {
+  #       id:     [String] - ID of the alert box
+  #       class:  [String] - Additional classes for the alert box
+  #     }
+  #   </code>
+  # @param [Proc] &block
+  # @return [Callout]
+  #
+  class Callout < Component
+    def initialize(template, context_or_options = nil, opts = {}, &block)
+      super(template)
+      @context, args = parse_arguments(context_or_options, opts)
+
+      @id = args.fetch(:id, nil)
+      @class = args.fetch(:class, '')
+      @content = block || proc { '' }
+    end
+
+    # @description
+    # - Returns a string representation of the component.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag :div, id: @id, class: container_class do
+        @content.call
+      end
+    end
+
+    private
+
+    # @description
+    # - Used to get the container classes.
+    #
+    # @return [String]
+    #
+    def container_class
+      string = 'callout '
+      string += "callout-#{@context}"
+      string += " #{@class}"
+      string
+    end
+  end
+end