bootstrap3_helper 1.0.0

data/lib/bootstrap3_helper/component.rb

@@ -0,0 +1,93 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - This super class is meant to contain commonly used methods that
+  # all sub classes can leverage.
+  #
+  # @note
+  # - Every component that inherits from this class, needs to call the parent
+  # initialization method! In order to properly render erb blocks within the
+  # proper context, we need the template. The only way to get this, is to pass
+  # in the template.
+  #
+  # @note
+  # - the `context` mentioned above, refers to the context of `@template` and
+  # not to be confused with `@context` that can be found in the sub classes.
+  # `@context` refers to the Bootstrap class context of the component.
+  #
+  class Component
+    # @description
+    # - Used to ensure that the helpers always have the propert context for
+    # rendering and bindings.
+    #
+    # @param [Class] template - the context of the bindings
+    #
+    def initialize(template)
+      @template = template
+    end
+
+    # @description
+    # - Used to pass all context of content_tag to the template.  This ensures
+    # proper template binding of variables and methods!
+    #
+    # @return [String]
+    #
+    def content_tag(
+      name,
+      content_or_options_with_block = nil,
+      options = nil,
+      escape = true,
+      &block
+    )
+      @template.content_tag(
+        name,
+        content_or_options_with_block,
+        options,
+        escape,
+        &block
+      )
+    end
+
+    # @description
+    # - Used to pass all concat references to the template.  This ensures proper
+    # binding. Concat adds a String to the template Output buffer.  Useful when
+    # trying to add a String with no block.
+    #
+    # @params [String] text
+    #
+    def concat(text)
+      @template.concat(text)
+    end
+
+    # @description
+    # - Used to parse method arguments.  If the first argument is
+    # a Hash, then it is assumed that the user left off the bootstrap
+    # contectual class.  So we will assign it to `default` and
+    # return the Hash to be used as options.
+    #
+    # @params [Hash|NilClass|String|Symbol] *args
+    # @return [Array]
+    #
+    def parse_arguments(*args)
+      first, second = *args
+      case first
+      when Hash, NilClass
+        ['default', first || second]
+      when Symbol, String
+        [first, second]
+      end
+    end
+
+    # @description
+    # - Used to generate a (hopefully) unique ID for DOM elements.  Used as a
+    # fallback if the user doesn't specify one.
+    #
+    # @return [String]
+    #
+    def uuid
+      (0...10).map { rand(65..90).chr }.join
+    end
+  end
+end

data/lib/bootstrap3_helper/panel.rb

@@ -0,0 +1,107 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - Used to rapidly build Bootstrap Panel Components.
+  #
+  # <code>
+  #   <%= panel_helper class: 'panel-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>
+  #
+  class Panel < Component
+    # @description
+    # - Creates a new Panel object.
+    #
+    # @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|NilClass] - The ID, if you want one, for the element.
+    #       class:  [String|NilClass] - Custom class for the element.
+    #     }
+    #   </code>
+    # @return [Panel]
+    #
+    def initialize(template, context_or_options = nil, opts = {})
+      super(template)
+      @context, args = parse_arguments(context_or_options, opts)
+
+      @id      = args.fetch(:id, '')
+      @class   = args.fetch(:class, '')
+      @data    = args.fetch(:data, nil)
+    end
+
+    # @description
+    # - Used to generate the header component for the panel.
+    #
+    # @param [Hash] args
+    #
+    def header(args = {})
+      id = args.fetch(:id, '')
+      klass = args.fetch(:class, '')
+      @header = content_tag(:div, id: id, class: 'panel-heading ' + klass) do
+        content_tag(:h3, class: 'panel-title') { yield if block_given? }
+      end
+    end
+
+    # @description
+    # - Used to generate the body component for the panel.
+    #
+    # @param [Hash] args
+    #
+    def body(args = {})
+      id = args.fetch(:id, '')
+      klass = args.fetch(:class, '')
+      @body = content_tag(:div, id: id, class: 'panel-body ' + klass) do
+        yield if block_given?
+      end
+    end
+
+    # @description
+    # - Used to generate the footer component for the panel.
+    #
+    # @param [Hash] args
+    #
+    def footer(args = {})
+      id = args.fetch(:id, '')
+      klass = args.fetch(:class, '')
+      @footer = content_tag(:div, id: id, class: 'panel-footer ' + klass) do
+        yield if block_given?
+      end
+    end
+
+    # @description
+    # - Used to render the html for the entire panel object.
+    #
+    # @return [String]
+    #
+    def to_s
+      content = content_tag :div, id: @id, class: container_classes, data: @data do
+        @header + @body + @footer
+      end
+
+      content
+    end
+
+    private
+
+    # @description
+    # - Used to get the container css classes.
+    #
+    # @return [String]
+    #
+    def container_classes
+      "panel panel-#{@context} #{@class}"
+    end
+  end
+end

data/lib/bootstrap3_helper/railtie.rb

@@ -0,0 +1,10 @@
+module Bootstrap3Helper
+  # @description
+  # - Used to tie into the ActionView
+  #
+  class Railtie < Rails::Railtie
+    initializer 'bootsrap3_helper' do
+      ActiveSupport.on_load(:action_view) { include Bootstrap3Helper }
+    end
+  end
+end

data/lib/bootstrap3_helper/tabs/content.rb

@@ -0,0 +1,67 @@
+# @description
+# - Root Object
+#
+module Bootstrap3Helper
+  class Tabs
+    # @description
+    # - Used to rapidly generated Bootstrap Tabs Content Components.
+    #
+    class Content < Component
+      # @description
+      # - Creates a new Tabs::Menu object.
+      #
+      # @param [Class] template - Template in which your are binding too.
+      # @param [Hash]  args
+      #   <code>
+      #     args = {
+      #       id:     [String|nilClass] - The ID, if you want one, for the parent container
+      #       class:  [String|nilClass] - Custom class for the parent container
+      #     }
+      #   </code>
+      #
+      def initialize(template, args = {})
+        super(template)
+
+        @id    = args.fetch(:id, nil)
+        @class = args.fetch(:class, '')
+        @items = []
+      end
+
+      # @description
+      # - Adds a new tabe-pane item to the object.
+      #
+      # @param [String|Symbol] name - Used to link to  the nav menu item.
+      # @param [Hash]  args
+      #   <code>
+      #     args = {
+      #       class:  [String|nilClass] - Custom class for the div element
+      #       data:   [Hash] - Any data attributes you wish to assign to div element.
+      #     }
+      #   </code>
+      #
+      def item(name, args = {})
+        data  = args.fetch(:data, nil)
+        klass = args.fetch(:class, '')
+
+        content = content_tag :div, id: name, class: 'tab-pane ' + klass, data: data, role: 'tabpanel' do
+          yield if block_given?
+        end
+
+        @items.push(content)
+      end
+
+      # @description
+      # - Used to render out the object as HTML
+      #
+      # @return [String]
+      #
+      def to_s
+        html = content_tag :div, id: @id, class: 'tab-content' + @class do
+          @items.collect(&:to_s).join.html_safe
+        end
+
+        html
+      end
+    end
+  end
+end

data/lib/bootstrap3_helper/tabs/dropdown.rb

@@ -0,0 +1,77 @@
+# @description
+# - Root Object
+#
+module Bootstrap3Helper
+  class Tabs
+    # @description
+    #  - Used to rapidly build dropdown menus for Bootstrap tabs.
+    #
+    # <code>
+    #   <% menu.dropdown 'Testing Dropdown' do |dropdown| %>
+    #      <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
+    #      <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
+    #      <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
+    #   <% end %>
+    # </code>
+    #
+    class Dropdown < Component
+      # @description
+      # - Creates a new Tabs::Dropdown object.
+      #
+      # @param [Class] template - Template in which your are binding too.
+      #
+      def initialize(template, name = '')
+        super(template)
+
+        @name  = name
+        @items = []
+      end
+
+      # @description
+      # - Adds a new item to the dropdown object.
+      #
+      # @note
+      # - You can opt out of passing in a block and the li will use the name attribute
+      # for the menu item.
+      #
+      # @param [String|Symbol] name - Used to link nav li to tab-content
+      # @param [Hash]  args
+      #   <code>
+      #     args = {
+      #       id:     [String|Symbol] - Custom ID for li element.
+      #       class:  [String|nilClass] - Custom class for the li element
+      #       data:   [Hash] - Any data attributes you wish to assign to li element.
+      #     }
+      #   </code>
+      #
+      def item(name, args = {})
+        id    = args.fetch(:id, nil)
+        klass = args.fetch(:class, '')
+        data  = args.fetch(:data, nil)
+
+        li = content_tag :li, id: id, class: klass, data: data do
+          content_tag :a, href: "##{name}", role: 'tab', data: { toggle: 'tab' }, aria: { controls: name, expanded: false } do
+            block_given? ? yield : name.to_s.titleize
+          end
+        end
+
+        @items.push(li)
+      end
+
+      # @description
+      # - Used to render out the object and get the HTML representation.
+      #
+      # @return [String]
+      #
+      def to_s
+        content = content_tag :a, @name, href: '#', class: 'dropdown-toggle', data: { toggle: 'dropdown' }, aria: { expanded: false }
+
+        content += content_tag :ul, id: @id, class: 'dropdown-menu ' do
+          @items.collect(&:to_s).join.html_safe
+        end
+
+        content
+      end
+    end
+  end
+end

data/lib/bootstrap3_helper/tabs/menu.rb

@@ -0,0 +1,101 @@
+# @description
+# - Root Object
+#
+module Bootstrap3Helper
+  class Tabs
+    # @description
+    # - Used to rapidly generated Bootstrap Tabs Menu Components.
+    #
+    # <code>
+    #   <% menu.item(:testing3) { ' Testing 3' } %>
+    # </code>
+    #
+    class Menu < Component
+      # @description
+      # - Creates a new Tabs::Menu object.
+      #
+      # @param [Class] template - Template in which your are binding too.
+      # @param [Hash]  args
+      #   <code>
+      #     args = {
+      #       type:   [String|Symbol] - Used to tell the helper which tab version - :tabs|:pills
+      #       id:     [String|nilClass] - The ID, if you want one, for the parent container
+      #       class:  [String|nilClass] - Custom class for the parent container
+      #     }
+      #   </code>
+      #
+      def initialize(template, args = {})
+        super(template)
+
+        @id    = args.fetch(:id, nil)
+        @class = args.fetch(:class, '')
+        @type  = args.fetch(:type, :tabs)
+        @items = []
+      end
+
+      # @description
+      # - Adds a new menu item to the object.
+      #
+      # @note
+      # - You can opt out of passing in a block and the li will use the name attribute
+      # for the menu item.
+      #
+      # @param [String|Symbol] name - Used to link nav li to tab-content
+      # @param [Hash]  args
+      #   <code>
+      #     args = {
+      #       id:     [String|Symbol] - Custom ID for li element.
+      #       class:  [String|nilClass] - Custom class for the li element
+      #       data:   [Hash] - Any data attributes you wish to assign to li element.
+      #     }
+      #   </code>
+      #
+      def item(name, args = {})
+        id    = args.fetch(:id, nil)
+        data  = args.fetch(:data, nil)
+        klass = args.fetch(:class, '')
+
+        li = content_tag :li, id: id, class: klass, data: data, role: 'presentation' do
+          content_tag :a, href: "##{name}", data: { toggle: 'tab' }, aria: { controls: '' } do
+            block_given? ? yield : name.to_s.titleize
+          end
+        end
+
+        @items.push(li)
+      end
+
+      # @description
+      # - Used to create menu items that are Dropdowns
+      #
+      # @param [String|Symbol] name - 
+      #
+      def dropdown(name, args = {})
+        id    = args.fetch(:id, nil)
+        data  = args.fetch(:data, nil)
+        klass = args.fetch(:class, '')
+
+        dropdown = Tabs::Dropdown.new(@template, name)
+        yield dropdown if block_given?
+
+        content = content_tag :li, id: id, class: 'dropdown' + klass, data: data do
+          dropdown.to_s
+        end
+
+        @items.push(content)
+      end
+
+      # @description
+      # - Used to render out the contents of the menu.
+      #
+      # @return [String]
+      #
+      def to_s
+        html = content_tag :ul, id: @id, class: "nav nav-#{@type} " + @class, role: 'tablist' do
+          @items.collect(&:to_s).join.html_safe
+        end
+
+        html
+      end
+    end
+  end
+end

data/lib/bootstrap3_helper/tabs.rb

@@ -0,0 +1,103 @@
+# @root
+#
+#
+module Bootstrap3Helper
+  # @description
+  # - Used to rapidly generated Bootstrap Tabs Components.
+  #
+  # @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>
+  class Tabs < Component
+    # @description
+    # - Creates a new Tabs object.
+    #
+    # @param [Class] template - Template in which your are binding too.
+    # @param [Hash]  args
+    #   <code>
+    #     args = {
+    #       type:   [String|Symbol] - Used to tell the helper which tab version - :tabs|:pills
+    #       id:     [String|nilClass] - The ID, if you want one, for the parent container
+    #       class:  [String|nilClass] - Custom class for the parent container
+    #     }
+    #   </code>
+    #
+    def initialize(template, args = {})
+      super(template)
+      @type  = args.fetch(:type, :tabs)
+      @id    = args.fetch(:id, nil)
+      @class = args.fetch(:class, '')
+
+      @tab_menu = Tabs::Menu.new(@template, type: @type)
+      @tab_content = Tabs::Content.new(@template)
+    end
+
+    # @description
+    # - Allows you access the Tabs::Menu object.
+    #
+    # @return [Tabs::Menu]
+    #
+    def menu
+      @tab_menu
+    end
+
+    # @description
+    # - Allows you to access the Tabs::Content object
+    #
+    # @return [Tabs::Content]
+    #
+    def content
+      @tab_content
+    end
+
+    # @description
+    # - Used to render out the HTML of the Tabs Object
+    #
+    # @return [String]
+    #
+    def to_s
+      html = content_tag :div, id: @id, class: @class do
+        menu.to_s + content.to_s
+      end
+
+      html
+    end
+  end
+end

data/lib/bootstrap3_helper/version.rb

@@ -0,0 +1,3 @@
+module Bootstrap3Helper
+  VERSION = '1.0.0'.freeze
+end