bootstrap-view-helpers 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= BootstrapViewHelpers
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BootstrapViewHelpers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/helpers/bootstrap/accordion_helper.rb

@@ -0,0 +1,63 @@
+module Bootstrap::AccordionHelper
+  
+  def accordion(options={})
+    options = ensure_accordion_id(options)
+    @accordion_id = options[:id]
+    options = ensure_class(options, 'accordion')
+    
+    content_tag(:div, options) do
+      yield
+    end
+  end
+  
+  def accordion_group(text, options={})
+    options = ensure_accordion_group_id(options)
+    @accordion_group_id = options[:id]
+    open = options.delete(:open)
+    
+    content_tag(:div, class: 'accordion-group') do
+      accordion_group_heading(text) + accordion_group_body(open) { yield }
+    end
+  end
+  
+  private
+  
+  def accordion_group_heading(text)
+    content_tag(:div, class: 'accordion-heading') do
+      content_tag(:a, text, class: %(accordion-toggle), href: "##{@accordion_group_id}", data: {toggle: 'collapse', parent: "##{@accordion_id}" })
+    end
+  end
+  
+  def accordion_group_body(open)
+    classes = %w(accordion-body collapse)
+    classes << 'in' if open
+    
+    content_tag(:div, id: @accordion_group_id, class: classes) do
+      content_tag(:div, class: 'accordion-inner') do
+        yield
+      end
+    end
+  end
+  
+  def ensure_accordion_id(options)
+    if options.has_key?(:id)
+      options
+    else
+      @accordion_number = @accordion_number.to_i + 1
+      options.dup.tap do |h|
+        h[:id] = "accordion-#{@accordion_number}"
+      end
+    end
+  end
+
+  def ensure_accordion_group_id(options)
+    if options.has_key?(:id)
+      options
+    else
+      @accordion_group_number = @accordion_group_number.to_i + 1
+      options.dup.tap do |h|
+        h[:id] = "#{@accordion_id}-group-#{@accordion_group_number}"
+      end
+    end
+  end
+end

data/app/helpers/bootstrap/badge_helper.rb

@@ -0,0 +1,41 @@
+# See: http://twitter.github.io/bootstrap/components.html#labels-badges
+# 
+# Helper for producing Twitter Bootstrap badges
+#
+# Default badge:
+#
+#   badge('Default')
+#
+# Other badges (see BADGE_TYPES):
+#
+#   badge('Info', :info)
+#
+# Options passed through to <span> tag:
+#
+#   badge('Warning', :warning, id: 'warn-id', class: 'more-class', my_key: 'my_value')
+#
+module Bootstrap::BadgeHelper
+  InvalidBadgeTypeError = Class.new(StandardError)
+  
+  BADGE_TYPES = %w(default success warning important info inverse)
+  
+  def badge(*args)
+    text = args.shift
+    options = add_badge_classes(*args)
+    content_tag(:span, text, options)
+  end
+
+  private
+  
+  def add_badge_classes(*args)
+    options = args.extract_options!
+    validate_badge_types(args)
+    classes = ['badge'] + args.map { |arg| "badge-#{arg}" }
+    ensure_class(options, classes)
+  end
+  
+  def validate_badge_types(badge_types)
+    badge_types.each { |e| raise(InvalidBadgeTypeError, e.inspect) unless BADGE_TYPES.include?(e.to_s) }
+  end
+  
+end

data/app/helpers/bootstrap/button_helper.rb

@@ -0,0 +1,87 @@
+# Helper for producing Twitter Bootstrap buttons OR links that look like buttons.
+# See: http://twitter.github.io/bootstrap/base-css.html#buttons
+#
+# Default button:
+#
+#   button('Default') #=> <button class="btn">Default</button>
+#
+# Pass in a url to make a link that looks like a button:
+#
+#   button('Home', url: '/home')    #=> <a href="/home" class="btn">Home</a>
+#
+# Or make a <button> look like a link:
+#
+#   button('Home', :link)
+#
+# Specify the type (see BUTTON_TYPES):
+#
+#   button('Info', :info)
+#
+# Specify the size (see BUTTON_SIZES)
+#
+#   button('Small', :small)
+#
+# Options passed through to <span> tag:
+#
+#   button('Warning', :warning, :large id: 'warn-id', class: 'more-class', my_key: 'my_value')
+#
+# Button groups/toolbars: http://twitter.github.io/bootstrap/components.html#buttonGroups
+#
+#   = button_group do
+#     = button("Left", "/left")
+#     = button("Right", "/right")
+#
+#   = button_toolbar do
+#     = button('Single Button', '/single')
+#     = button_group
+#       = button('Group Button 1')
+#       = button('Group Button 2')
+#     = button('Another Single')
+#
+module Bootstrap::ButtonHelper
+  InvalidButtonModifierError = Class.new(StandardError)
+
+  BUTTON_TYPES = %w(default primary info success warning danger inverse link)
+  BUTTON_SIZES = %w(default large small mini)
+  BUTTON_OTHERS = %w(block)
+  
+  BUTTON_ALL = BUTTON_TYPES + BUTTON_SIZES + BUTTON_OTHERS
+  
+  def button(*args)
+    text = args.shift
+    options = args.extract_options!
+    href = options.delete(:url)
+    options = add_button_classes(options, args)
+
+    if href.present?
+      link_to(text, href, options)
+    else
+      content_tag(:button, text, options)
+    end
+  end
+    
+  def button_toolbar
+    content_tag(:div, class: 'btn-toolbar') do
+      yield
+    end
+  end
+  
+  def button_group
+    content_tag(:div, class: 'btn-group') do
+      yield
+    end
+  end
+    
+  private
+  
+  def add_button_classes(options, button_types_and_sizes)
+    validate_types_and_sizes(button_types_and_sizes)
+    classes = ['btn'] + button_types_and_sizes.map { |e| "btn-#{e}" }
+    ensure_class(options, classes)
+  end
+  
+  def validate_types_and_sizes(types_and_sizes)
+    types_and_sizes.each { |e| raise(InvalidButtonModifierError, e.inspect) unless BUTTON_ALL.include?(e.to_s) }
+  end
+  
+end

data/app/helpers/bootstrap/common_helper.rb

@@ -0,0 +1,56 @@
+module Bootstrap::CommonHelper
+  ArgumentError = Class.new(::ArgumentError)
+  
+  # Returns a new hash with the :class key's value converted to an
+  # Array with each element converted to a String.
+  # 
+  #   arrayify_class({})                       #=> {:class=>[]} 
+  #   arrayify_class(:class => 'foo')          #=> {:class=>["foo"]}
+  #   arrayify_class(:class => [:foo, 'bar'])  #=> {:class=>["foo", "bar"]} 
+  def arrayify_class(hash)
+    raise ArgumentError.new("expected a Hash, got #{hash.inspect}") unless hash.is_a?(Hash)
+    
+    return hash if hash[:class] == false
+    
+    hash.dup.tap do |h|
+      classes = h[:class]
+      h[:class] = case
+        when classes.blank? then []
+        when classes.is_a?(Array) then classes.dup
+        else classes.to_s.split(/\s/)
+        end
+      h[:class].map!(&:to_s)
+    end
+  end
+  
+  # Returns down-caret character used in various dropdown menus.
+  def caret(options={})
+    options = ensure_class(options, 'caret')
+    content_tag(:span, nil, options)
+  end
+  
+  # Ensures that _hash_ has key of :class that includes _klass_.
+  #
+  #   ensure_class({}, 'foo')                            #=> {class: 'foo'}
+  #   ensure_class({class: 'bar', id: 'my-id'}, 'foo')   #=> {:class=>["bar", "foo"], :id=>"my-id"}
+  def ensure_class(hash, klass)
+    arrayify_class(hash).tap do |h|
+      klasses = Array(klass).map(&:to_s)
+      klasses.each do |k|
+        h[:class] << k unless h[:class].include?(k)
+      end
+    end
+  end
+
+  # Returns extra arguments that are Bootstrap modifiers.  Basically 2nd argument
+  # up to (not including) the last (hash) argument.
+  #
+  #   extract_extras('text')  #=> []
+  #   extract_extras('text', :small, :info, id: 'foo')  #=> [:small, :info]
+  def extract_extras(*args)
+    args.extract_options!
+    args.shift
+    args
+  end
+  
+end

data/app/helpers/bootstrap/dropdown_helper.rb

@@ -0,0 +1,100 @@
+# Helper methods for various Bootstrap dropdown menus
+#
+# * http://twitter.github.io/bootstrap/components.html#buttonDropdowns
+# * http://twitter.github.io/bootstrap/components.html#navbar
+#
+# All of the *_dropdown methods should have dropdown_item() or dropdown_divider()
+# as children.
+#
+#   = nav_dropdown('Admin') do
+#     = dropdown_item('Users', admin_users_path)
+#     = dropdown_item('Logs', admin_logs_path)
+#     = dropdown_divider
+#     = dropdown_item('Exceptions', admin_exceptions_path)
+#
+#   = button_dropdown('Actions') do
+#     / dropdown_items
+#
+#   = split_button_dropdown('Edit', edit_user_path(@user)) do
+#     / dropdown_items
+#
+module Bootstrap::DropdownHelper
+  
+  # should be nested within a <ul class='nav'> tag
+  def nav_dropdown(text)
+    content_tag(:li, class: 'dropdown') do
+      nav_dropdown_link(text) + dropdown_ul { yield }
+    end
+  end
+  
+  # likely nested within button_toolbar
+  def button_dropdown(*args)
+    content_tag(:div, class: 'btn-group') do
+      button_dropdown_link(*args) + dropdown_ul { yield }
+    end
+  end
+  
+  # likely nested within button_toolbar
+  def split_button_dropdown(*args)
+    extras = extract_extras(*args)
+    
+    content_tag(:div, class: 'btn-group') do
+      split_button_dropdown_default(*args) + split_button_dropdown_toggle(extras) + dropdown_ul { yield }
+    end
+  end
+  
+  # Must be nested under one of the *_dropdown methods:
+  #
+  #  dropdown_item('Action', '/action')
+  #  dropdown_item('Action')              # href set to 'javascript:void(0)'
+  #  dropdown_item('Action', id: 'foo')   # options passed to <a> tag
+  #
+  def dropdown_item(*args)
+    options = args.extract_options!
+    text = args.shift or raise "Need text to link to"
+    url = args.shift || 'javascript:void(0)'
+    
+    content_tag(:li) do
+      link_to(text, url, options)
+    end
+  end
+  
+  # Produces a line to divide sections of a dropdown menu
+  def dropdown_divider
+    content_tag(:li, nil, class: 'divider')
+  end
+
+  private
+  
+  def nav_dropdown_link(text)
+    content_tag(:a, class: "dropdown-toggle", data: {toggle: "dropdown"}, href: "#") do
+      safe_join( [ h(text), caret ], ' ' )
+    end    
+  end
+
+  def button_dropdown_link(*args)
+    text = args.shift
+    classes = %w(btn dropdown-toggle) + args.map { |e| "btn-#{e}" }
+    content_tag(:a, class: classes, data: {toggle: "dropdown"}, href: "#") do
+      safe_join( [ h(text), caret ], ' ' )
+    end
+  end
+  
+  def split_button_dropdown_default(*args)
+    button(*args)
+  end
+  
+  def split_button_dropdown_toggle(extras)
+    classes = %w(btn dropdown-toggle) + extras.map { |e| "btn-#{e}" }
+    content_tag(:button, class: classes, data: {toggle: 'dropdown'}) do
+      caret
+    end
+  end
+  
+  def dropdown_ul
+    content_tag(:ul, class: "dropdown-menu") do
+      yield
+    end
+  end
+  
+end

data/app/helpers/bootstrap/form_helper.rb

@@ -0,0 +1,19 @@
+module Bootstrap::FormHelper
+  
+  def submit_tag(value = "Save changes", options = {})
+    options = arrayify_class(options.symbolize_keys)
+    
+    class_arg = Array(options.delete(:class)).map(&:to_s)
+    classes = []
+    classes << 'btn-primary' unless options.delete(:bootstrap) == false ||
+       class_arg.detect { |e| e.starts_with?('btn-') }
+    class_arg.each { |e| classes << e }
+    classes << 'btn' if classes.detect { |e| e.starts_with?('btn-') }
+    options = ensure_class(options, classes)
+    
+    options[:disable_with] = "Processing ..." unless options.has_key?(:disable_with)
+
+    super(value, options)
+  end
+  
+end

data/app/helpers/bootstrap/stamp_helper.rb

@@ -0,0 +1,45 @@
+# See: http://twitter.github.io/bootstrap/components.html#labels-badges
+# 
+# Helper for producing Twitter Bootstrap labels.  We call them stamps because #label() is
+# a Rails helper method.
+#
+# Default label:
+#
+#   stamp('Default')
+#
+# Other labels (see LABEL_TYPES):
+#
+#   stamp('Info', :info)
+#
+# Options passed through to <span> tag:
+#
+#   stamp('Warning', :warning, id: 'warn-id', class: 'more-class', my_key: 'my_value')
+#
+module Bootstrap::StampHelper
+  InvalidStampTypeError = Class.new(StandardError)
+  
+  LABEL_TYPES = %w(default success warning important info inverse)
+  
+  # stamp('Text')
+  # stamp('Text', :success)            # see LABEL_TYPES
+  # stamp('Text', :info, id: 'my-id')  # options passed thru to <span>
+  def stamp(*args)
+    text = args.shift
+    options = add_label_classes(*args)
+    content_tag(:span, text, options)
+  end
+
+  private
+  
+  def add_label_classes(*args)
+    options = args.extract_options!
+    validate_label_types(args)
+    classes = ['label'] + args.map { |arg| "label-#{arg}" }
+    ensure_class(options, classes)
+  end
+  
+  def validate_label_types(label_types)
+    label_types.each { |e| raise(InvalidStampTypeError, e.inspect) unless LABEL_TYPES.include?(e.to_s) }
+  end
+  
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bootstrap-view-helpers.rb

@@ -0,0 +1,4 @@
+require "bootstrap-view-helpers/engine"
+
+module BootstrapViewHelpers
+end

data/lib/bootstrap-view-helpers/engine.rb

@@ -0,0 +1,6 @@
+module BootstrapViewHelpers
+  class Engine < ::Rails::Engine
+    config.generators.integration_tool :rspec
+    config.generators.test_framework :rspec
+  end
+end

data/lib/bootstrap-view-helpers/version.rb

@@ -0,0 +1,3 @@
+module BootstrapViewHelpers
+  VERSION = "0.0.1"
+end

data/lib/tasks/bootstrap-view-helpers_tasks.rake

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

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap-view-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Downey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails view helpers for Bootstrap
+email:
+- steve.downtown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/bootstrap/accordion_helper.rb
+- app/helpers/bootstrap/badge_helper.rb
+- app/helpers/bootstrap/button_helper.rb
+- app/helpers/bootstrap/common_helper.rb
+- app/helpers/bootstrap/dropdown_helper.rb
+- app/helpers/bootstrap/form_helper.rb
+- app/helpers/bootstrap/stamp_helper.rb
+- config/routes.rb
+- lib/bootstrap-view-helpers/engine.rb
+- lib/bootstrap-view-helpers/version.rb
+- lib/bootstrap-view-helpers.rb
+- lib/tasks/bootstrap-view-helpers_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/stevedowney/bootstrap_view_helpers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3576308479683783950
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3576308479683783950
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails view helpers for Bootstrap
+test_files: []