bootstrap3_helper 1.0.0

data/lib/bootstrap3_helper.rb

@@ -0,0 +1,219 @@
+require 'bootstrap3_helper/version'
+
+# Implementation files
+require 'bootstrap3_helper/component'
+require 'bootstrap3_helper/accordion'
+require 'bootstrap3_helper/accordion_group'
+require 'bootstrap3_helper/alert'
+require 'bootstrap3_helper/callout'
+require 'bootstrap3_helper/panel'
+require 'bootstrap3_helper/tabs'
+require 'bootstrap3_helper/tabs/content'
+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
+# 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...
+  #     <% end %>
+  #     <%= p.footer do %>
+  #       //HTML or Ruby
+  #     <% end %>
+  #   <% end %>
+  # </code>
+  #
+  # @params [Symbol|String|Hash|NilClass] *args
+  # @return [String]
+  #
+  def panel_helper(*args)
+    panel = Panel.new(self, *args)
+    capture { yield(panel) if block_given? }
+    panel
+  end
+
+  # @description
+  # - Creates an Alert component.
+  #
+  # <code>
+  #   <%= alert_helper :danger, dismissble: true do %>
+  #     Something went wrong with your model data...
+  #   <% end %>
+  # </code>
+  #
+  # @params [Symbol|String|Hash|NilClass] *args
+  # @return [String]
+  #
+  def alert_helper(*args, &block)
+    alert = Alert.new(self, *args, &block)
+    alert
+  end
+
+  # @description
+  # - Creates an Callout component.
+  #
+  # <code>
+  #   <%= callout_helper :danger %>
+  #     Some information that needs your attention...
+  #   <% end %>
+  # </code>
+  #
+  # @params [Symbol|String|Hash|NilClass] *args
+  # @return [String]
+  #
+  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.
+  #
+  # @return [Boolean]
+  #
+  def host_is_dev_pc?
+    Rails.root.to_s.include?('home')
+  end
+
+  # @description
+  # - 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 :)
+  #
+  # <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>
+  #
+  # @yields [AccordionGroup] group
+  # @return [String]
+  #
+  def accordion_group_helper(*args)
+    group = AccordionGroup.new(self, *args)
+    capture { yield group if block_given? }
+    group
+  end
+
+  # @description
+  # - Easily build a bootstrap accordion component
+  #
+  #   <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 %>
+  #     <% end %>
+  #   </code>
+  #
+  # @params [Symbol|String|Hash|NilClass] *args
+  # @return [String]
+  #
+  def accordion_helper(*args)
+    accordion = Accordion.new(self, *args)
+    capture { yield accordion if block_given? }
+    accordion
+  end
+
+  # @description
+  # - Allows you to rapidly build bootstrap glyphs.
+  #
+  # @note
+  # - Only supply the last part of the glyph makrup.
+  #
+  # <code>
+  #   <span class"glyphicon glyphicon-pencil"></span>
+  #   <%= icon_helper('pencil') %>
+  # </code>
+  #
+  # @param [String|Symbol] name
+  #
+  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
+  end
+end

data/lib/tasks/bootstrap3_helper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bootstrap3_helper do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap3_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Simple gem for rapidly building bootstrap 3 components
+email:
+- rdavid369@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/bootstrap3_helper.rb
+- lib/bootstrap3_helper/accordion.rb
+- lib/bootstrap3_helper/accordion_group.rb
+- lib/bootstrap3_helper/alert.rb
+- lib/bootstrap3_helper/callout.rb
+- lib/bootstrap3_helper/component.rb
+- lib/bootstrap3_helper/panel.rb
+- lib/bootstrap3_helper/railtie.rb
+- lib/bootstrap3_helper/tabs.rb
+- lib/bootstrap3_helper/tabs/content.rb
+- lib/bootstrap3_helper/tabs/dropdown.rb
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple gem for rapidly building bootstrap 3 components
+test_files: []