bootstrap-shoehorn 1.0.0

data/lib/shoehorn/components/progress_bar.rb

@@ -0,0 +1,51 @@
+module Shoehorn::Components
+  class ProgressBar < Base
+    attr_accessor :width
+
+    def initialize(width, options = {})
+      super
+      @width = width
+    end
+
+    def to_s
+      output_buffer << content_tag(:div, build_div_options) do
+        build_bar_tag.html_safe
+      end.html_safe
+      super
+    end
+
+    private
+
+    def default_options
+      {
+        :class        => nil,
+        :bootstrap_class_prefix => "progress",
+        :striped      => false,
+        :animated     => false,
+        :type          => nil,
+        :html_options => {}
+      }
+    end
+
+    def build_class
+      classes = [ options[:class] ]
+      classes << options[:bootstrap_class_prefix]
+      classes << "#{options[:bootstrap_class_prefix]}-#{options[:type]}" if options[:type]
+      classes << "#{options[:bootstrap_class_prefix]}-striped" if options[:striped]
+      classes << "active" if options[:animated]
+      classes.join(" ")
+    end
+
+    def build_bar_tag
+      ops = { :class => 'bar', :style => "width: #{@width}%;" }
+      content_tag(:div, nil, ops)
+    end
+
+    def build_div_options
+      ops = { :class => build_class }
+      ops.reverse_merge(options[:html_options])
+    end
+
+
+  end
+end

data/lib/shoehorn/engine.rb

@@ -0,0 +1,19 @@
+require 'rails'
+
+module Shoehorn
+  class Engine < ::Rails::Engine
+    initializer 'shoehorn.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Shoehorn::Helpers::AlertHelpers
+        include Shoehorn::Helpers::LabelHelpers
+        include Shoehorn::Helpers::IconHelpers
+        include Shoehorn::Helpers::BadgeHelpers
+        #include Shoehors::Helpers::FormHelpers
+        include Shoehorn::Helpers::ButtonHelpers
+        include Shoehorn::Helpers::NavigationHelpers
+        include Shoehorn::Helpers::ModalHelpers
+        include Shoehorn::Helpers::ProgressBarHelpers
+      end
+    end
+  end
+end

data/lib/shoehorn/helper_collection.rb

@@ -0,0 +1,58 @@
+module Shoehorn
+  class HelperCollection
+    attr_accessor :calls, :view
+
+    def initialize(view)
+      @view = view
+      @calls = []
+    end
+
+    def method_missing(symbol, *args, &block)
+      @calls << HelperMethodCall.new(@view, symbol, args, block)
+    end
+
+    def each
+      @calls.each do |c|
+        yield c
+      end
+    end
+
+    def [](x)
+      @calls[x]
+    end
+
+    def size
+      @calls.size
+    end
+
+    def shift
+      @calls.shift
+    end
+  end
+
+  class HelperMethodCall
+    attr_accessor :method, :options, :args
+
+    def initialize(view, symbol, args, block)
+      @view    = view
+      @method  = symbol
+      @options = args.extract_options!
+      @args    = args
+      @block   = block
+    end
+
+    def to_s
+      args = @args
+      args << @options
+
+      if @block
+        output = @view.send(@method, *args, &@block)
+      else
+        output = @view.send(@method, *args)
+      end
+
+      output.blank? ? nil : output.html_safe
+    end
+
+  end
+end

data/lib/shoehorn/helper_collection_set.rb

@@ -0,0 +1,18 @@
+module Shoehorn
+  class HelperCollectionSet
+    attr_accessor :collections
+
+    def initialize(view, items)
+      @collections = {}
+      items.each do |item|
+        @collections[item] = Shoehorn::HelperCollection.new(view)
+        instance_eval <<-EOF
+          def#{item}
+            yield @collections[#{item.inspect} ]
+          end
+        EOF
+      end
+    end
+    
+  end
+end

data/lib/shoehorn/helpers.rb

@@ -0,0 +1,14 @@
+module Shoehorn
+  module Helpers
+    autoload :AlertHelpers, 'shoehorn/helpers/alert_helpers'
+    autoload :LabelHelpers, 'shoehorn/helpers/label_helpers'
+    autoload :BadgeHelpers, 'shoehorn/helpers/badge_helpers'
+    autoload :IconHelpers, 'shoehorn/helpers/icon_helpers'
+    #autoload :FormHelpers, 'shoehorn/helpers/form_helpers'
+    autoload :ButtonHelpers, 'shoehorn/helpers/button_helpers'
+    autoload :NavigationHelpers, 'shoehorn/helpers/navigation_helpers'
+    autoload :ModalHelpers, 'shoehorn/helpers/modal_helpers'
+    autoload :ProgressBarHelpers, 'shoehorn/helpers/progress_bar_helpers'
+  end
+end
+

data/lib/shoehorn/helpers/alert_helpers.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Shoehorn::Helpers
+  module AlertHelpers
+    # Renders alert message
+    #
+    # @param [String] message message to be displayed
+    # @param [Hash] options hash containing options (default: {}):
+    #           :block        - The Boolean whether to display as a block (optional)
+    #           :close        - The Boolean whether to render close button
+    #           :heading      - The String heading message to render
+    #           :dismiss      - The Boolean whether to add dismiss attribute
+    #           :type         - The String type of alert to display: error, success or info
+    #           :html_options - Any additional HTML options desired on the alert DIV.
+    #
+    # Examples
+    #
+    #   bootstrap_alert("Hello!")
+    #   # => '<div class="alert"><a class="close">×</a>Hello!</div>'
+    #
+    #   bootstrap_alert("Hello!", type: 'error', close: false)
+    #   # => '<div class="alert alert-error">Hello!</div>'
+    #
+    #   bootstrap_alert("Content of alert", heading: "WARNING!", type: 'info')
+    #   # => '<div class="alert alert-info"><a class="close">×</a>
+    #            <h4 class="alert-heading">WARNING!</h4>Content of alert</div>'
+    #
+    # Returns HTML String for the alert
+    def bootstrap_alert(message, options = {})
+      Shoehorn::Components::Alert.new(
+        message,
+        options
+      ).to_s
+    end
+  end
+end
+

data/lib/shoehorn/helpers/badge_helpers.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Shoehorn::Helpers
+  module BadgeHelpers
+    # Renders badge
+    #
+    # @param [String] message message to be displayed
+    # @param [Hash] options hash containing options (default: {}):
+    #           :type         - The String type of alert to display: info, success, warning, important or inverse
+    #           :class        - The String additional CSS classes of the object
+    #           :bootstrap_class_prefix - The String CSS class prefix from Twitter Bootstrap for the object
+    #           :html_options - Any additional options you'd like to pass to the span tag that will be created
+    #                           for this label (for instance :"data-whatever" can be specified in :html_options).
+    #
+    # Examples
+    #
+    #   bootstrap_badge("Hello!")
+    #   # => '<span class="badge">Hello!</span>'
+    #
+    #   bootstrap_badge("Hello!", type: 'success')
+    #   # => '<span class="badge badge-success">Hello!</span>'
+    #
+    #   bootstrap_badge("Hello!", type: 'warning', class: "my_awesome_class")
+    #   # => '<span class="my_awesome_class badge badge-warning">Hello!</span>'
+    #
+    #   bootstrap_badge("Hello!", type: 'info', bootstrap_class_prefix: "my_badge")
+    #   # => '<span class="my_badge my_badge-warning">Hello!</span>'
+    #
+    # Returns HTML String for the badge
+    def bootstrap_badge(message, options = {})
+      Shoehorn::Components::Badge.new(
+        message,
+        options
+      ).to_s
+    end
+
+  end
+end
+

data/lib/shoehorn/helpers/button_helpers.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+module Shoehorn::Helpers
+  module ButtonHelpers
+    # Render a bootstrap button
+    #
+    # @param [String] text for the button face
+    # @param [String] link for the button href
+    # @param [Hash] options hash containing options (default: {}):
+    #           :type         - The String type of button to display: primary, info, success, warning, danger or inverse
+    #           :size          - The String size of button to display: large, small or mini
+    #           :disabled     - Will disable the button if set to true
+    #           :class        - The String additional CSS classes of the object
+    #           :bootstrap_class_prefix - The String CSS class prefix from Twitter Bootstrap for the object
+    #           :icon_name    - Specify an icon name from bootstrap to prepend
+    #           :icon_white   - Specify true if you want the icon to be white
+    #           :id            - Assign an ID to the button
+    #           :html_options - Any additional options you'd like to pass to the content_tag that will be created
+    #                           for this button's a tag (for instance :target can be specified in :html_options).
+    #
+    # NOTE:  If you have to create a link to a resource#show you have to specify the full path as second param.
+    #        Example: to create an anchor to the user#show path you have to write:
+    #                 bootstrap_button "Show", user_path(@user)
+    #        instead of:
+    #                 bootstrap_button "Show", @user
+    #
+    # Examples
+    #
+    #   bootstrap_button "Show", user_path(@user)
+    #
+    #   bootstrap_button t('commons.search'), user_path(@user)
+    #
+    #   bootstrap_button 'Search', search_path, type: 'primary', icon_name: 'search'
+    #
+    #   bootstrap_button 'Show details', user_path(@user), icon_name: 'user', size: 'large'
+    #
+    #   bootstrap_button 'Edit request', edit_request_path(@request), :type => 'primary', class: 'foo', id: 'bar'
+    #
+    #   bootstrap_button 'Show details', user_path(@user), disabled: true
+    #
+    def bootstrap_button(text, link, options = {})
+      Shoehorn::Components::Button.new(
+        text,
+        link,
+        options
+      ).to_s
+    end
+
+    # Render a dropdown button
+    #
+    # @param [Hash] options hash containing options (default: {}):
+    #
+    # Examples
+    #
+    #   bootstrap_button_dropdown do |b|
+    #     b.bootstrap_button "Actions', "#", type: 'primary'
+    #     b.bootstrap_link_to "Show", request_path(@request), icon_name: 'zoom-in'
+    #     b.bootstrap_link_to_if(can?(:reject, @request),  t('.refuse'),
+    #                            reject_request_path(@request), icon_name: 'remove',
+    #                            html_options: {  method: :put, data: { confirm: "Are you sure?" } }) { nil }
+    #     b.bootstrap_link_to_if(can?(:accept, @request),  "Accept",
+    #                            "#acceptModal_#{@request.id}", icon_name: 'ok',
+    #                            html_options: {  data: { toggle: "modal" } }) { nil }
+    #     b.link_to "Help", help_path
+    #   end
+    #
+    # Returns HTML String for the dropdown
+    def bootstrap_dropdown(options = {})
+      # Elements will hold every call made to this block. Self is passed in so the
+      # elements can be sent to it in order to be evaluated
+      elements = Shoehorn::HelperCollection.new(self)
+
+      yield elements
+
+      Shoehorn::Components::Dropdown.new(
+        elements,
+        options
+      ).to_s
+    end
+
+    # Render a bootstrap link_to.
+    #
+    # They are a shortcut to bootstrap_button with bootstrap_class_prefix => nil .
+    # In this way they are rendered as normal links, without being styled.
+    #
+    def bootstrap_link_to(text, link, options = {})
+      options[:bootstrap_class_prefix] = nil
+      Shoehorn::Components::Button.new(
+          text,
+          link,
+          options
+      ).to_s
+    end
+
+    # Render a bootstrap link_to_unless.
+    #
+    # They are a shortcut to conditional bootstrap_button_link_to.
+    # In this way they are rendered as normal links, without being styled.
+    #
+    def bootstrap_link_to_unless(condition, text, link, options = {}, &block)
+      if condition
+        if block_given?
+          block.arity <= 1 ? capture(text, &block) : capture(text, link, options, &block)
+        else
+          text
+        end
+      else
+        bootstrap_link_to(text, link, options)
+      end
+    end
+
+    # Render a bootstrap link_to_unless.
+    #
+    # They are a shortcut to conditional bootstrap_button_link_to.
+    # In this way they are rendered as normal links, without being styled.
+    #
+    def bootstrap_link_to_if(condition, text, link, options = {}, &block)
+      bootstrap_link_to_unless !condition, text, link, options, &block
+    end
+
+  end
+end
+

data/lib/shoehorn/helpers/form_helpers.rb

@@ -0,0 +1,11 @@
+module Shoehorn::Helpers
+  module FormHelpers
+    # Form builder
+    # TODO add documentation
+    def bootstrap_form_for(*args, &block)
+      options = args.extract_options!
+      options.reverse_merge!(:builder => Shoehorn::Components::FormBuilder)
+      form_for(*(args + [options]), &block)
+    end
+  end
+end

data/lib/shoehorn/helpers/icon_helpers.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Shoehorn::Helpers
+  module IconHelpers
+    # Renders icons
+    #
+    # @param [Hash] options hash containing options (default: {}):
+    #           :name         - The String type of alert to display: success warning important notice
+    #           :text         - The String of a text to show inline with the icon
+    #           :class        - The String additional CSS classes of the object
+    #           :bootstrap_class_prefix - The String CSS class prefix from Twitter Bootstrap for the object
+    #           :html_options - Any additional options you'd like to pass to the span tag that will be created
+    #                           for this label (for instance :"data-whatever" can be specified in :html_options).
+    #
+    # Examples
+    #
+    #   bootstrap_icon(name: 'user', icon_white: true)
+    #   # => '<i class="icon-user icon-white"></i>'
+    #
+    #   bootstrap_icon(text: "Current time", name: 'time')
+    #   # => '<i class="icon-time"></i> Current time'
+    #
+    #   bootstrap_icon(class: "my_awesome_class", name: 'glass')
+    #   # => '<i class="icon-glass my_awesome_class"></i>'
+    #
+    # Returns HTML String for the icons
+    def bootstrap_icon(options = {})
+      Shoehorn::Components::Icon.new(
+        options
+      ).to_s
+    end
+
+  end
+end
+

data/lib/shoehorn/helpers/label_helpers.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module Shoehorn::Helpers
+  module LabelHelpers
+    # Renders inline label
+    #
+    # @param [String] message message to be displayed
+    # @param [Hash] options hash containing options (default: {}):
+    #           :type         - The String type of alert to display: info, success, warning, important or inverse
+    #           :class        - The String additional CSS classes of the object
+    #           :bootstrap_class_prefix - The String CSS class prefix from Twitter Bootstrap for the object
+    #           :html_options - Any additional options you'd like to pass to the span tag that will be created
+    #                           for this label (for instance :"data-whatever" can be specified in :html_options).
+    #
+    # Examples
+    #
+    #   bootstrap_label("Hello!")
+    #   # => '<span class="label">Hello!</span>'
+    #
+    #   bootstrap_label("Hello!", type: 'warning')
+    #   # => '<span class="label label-warning">Hello!</span>'
+    #
+    #   bootstrap_label("Hello!", type: 'important', class: "my_awesome_class")
+    #   # => '<span class="my_awesome_class label label-important">Hello!</span>'
+    #
+    #   bootstrap_label("Hello!", type: 'info', bootstrap_class_prefix: "my_label")
+    #   # => '<span class="my_label my_label-info">Hello!</span>'
+    #
+    # Returns HTML String for the label
+    def bootstrap_label(message, options = {})
+      Shoehorn::Components::Label.new(
+        message,
+        options
+      ).to_s
+    end
+  end
+end
+