bootstrap-shoehorn 1.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.bundle
+Gemfile.lock
+.yardoc
+doc
+pkg
+.idea
+.rvmrc
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--order rand
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  #- ree
+  - 1.9.2
+  - 1.9.3
+  #- jruby
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bootstrap-rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,336 @@
+# Shoehorn: a Twitter Bootstrap 2.0 helper library for Rails
+
+This gem focuses on making it easier to use Twitter's Bootstrap 2.0.
+It's a collection of helpers which should make it faster to use all the components provided by Twitter Bootstrap.
+
+The gem started as a fork of pusewicz's twitter-bootstrap-markup-rails gem (https://github.com/pusewicz/twitter-bootstrap-markup-rails),
+but I need more customization. So I borrowed the gem structure and some code for developing Shoehorn.
+
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'shoehorn'
+```
+
+## Currently Supported
+
+* Alert messages
+* Inline labels
+* Buttons
+* Button dropdowns
+* link_to
+* Badges
+* Modal windows
+* Navigation (tabs, pills)
+* Progress bars
+
+
+Examples
+---
+
+### Rendering Alert
+
+```ruby
+bootstrap_alert("Hello!")
+# => '<div class="alert"><a class="close">×</a>Hello!</div>'
+```
+
+Rendering Info Block Alert
+
+```ruby
+bootstrap_alert("Hello!", type: 'info', block: true)
+# => '<div class="alert alert-block alert-info"><a class="close">×</a>Hello!</div>'
+```
+
+Add Alert heading:
+
+```ruby
+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>'
+```
+
+Remove closing button
+
+```ruby
+bootstrap_alert("Hello!", type: 'error', close: false)
+# => '<div class="alert alert-error">Hello!</div>'
+```
+
+
+### Notice Inline Label
+
+Normal label
+
+```ruby
+bootstrap_label("Hello!")
+# => '<span class="label">Hello!</span>'
+```
+
+Change type (available values are: info, success, warning, important or inverse)
+
+```ruby
+bootstrap_label("Hello!", type: 'warning')
+# => '<span class="label label-warning">Hello!</span>'
+```
+
+Add custom CSS class
+
+```ruby
+bootstrap_label("Hello!", type: 'important', class: "my_awesome_class")
+# => '<span class="my_awesome_class label label-important">Hello!</span>'
+```
+
+Customize Bootstrap CSS class prefix (really needed???)
+
+```ruby
+bootstrap_label("Hello!", type: 'info', bootstrap_class_prefix: "my_label")
+# => '<span class="my_label my_label-info">Hello!</span>'
+```
+
+### Notice Badge
+
+Normal badge
+
+```ruby
+bootstrap_badge("Hello!")
+# => '<span class="badge">Hello!</span>'
+```
+
+Change type (available values are: info, success, warning, important or inverse)
+
+```ruby
+bootstrap_badge("Hello!", type: 'success')
+# => '<span class="badge badge-success">Hello!</span>'
+```
+
+Add custom CSS class
+
+```ruby
+bootstrap_badge("Hello!", type: 'warning', class: "my_awesome_class")
+# => '<span class="my_awesome_class badge badge-warning">Hello!</span>'
+```
+
+Customize Bootstrap CSS class prefix (really needed???)
+
+```ruby
+bootstrap_label("Hello!", type: 'info', bootstrap_class_prefix: "my_label")
+# => '<span class="my_label my_label-info">Hello!</span>'
+```
+
+### Icon inline
+
+```ruby
+bootstrap_icon(name: 'user', icon_white: true)
+#   # => '<i class="icon-user icon-white"></i>'
+```
+
+```ruby
+bootstrap_icon(text: "Current time", name: 'time')
+# => '<i class="icon-time"></i> Current time'
+```
+
+```ruby
+bootstrap_icon(class: "my_awesome_class", name: 'glass')
+# => '<i class="icon-glass my_awesome_class"></i>'
+```
+
+### Buttons
+
+```ruby
+bootstrap_button("Button Text", "#")
+# => '<a class="btn" href="#">Button Text</a>'
+```
+
+### Link_to, link_to_if, link_to_unless
+
+They are a shortcut to bootstrap_button with bootstrap_class_prefix => nil .
+In this way they are rendered as normal bootstrap_button, without being styled.
+
+```ruby
+bootstrap_link_to 'Search', "#", type: 'primary', icon_name: 'search'
+# => '<a href="#"><i class="icon-search"></i> Search</a>'
+```
+
+```ruby
+bootstrap_link_to_if condition, 'Search', "#", type: 'primary', icon_name: 'search' { nil }
+# => '<a href="#"><i class="icon-search"></i> Search</a>'
+```
+
+```ruby
+bootstrap_link_to_unless !condition, 'Search', "#", type: 'primary', icon_name: 'search' { nil }
+# => '<a href="#"><i class="icon-search"></i> Search</a>'
+```
+
+### Dropdown Buttons
+
+```ruby
+bootstrap_button_dropdown do |b|
+    b.bootstrap_button "Button Title", "#"
+    b.bootstrap_link_to "First Dropdown Item", item_path(@item)
+    b.link_to "Second Dropdown Item", @item2
+end
+#  => '<div class="btn-group">
+#        <a class="btn dropdown-toggle" data-toggle="dropdown" href="#">
+#          Button Title
+#          <span class="caret"></span>
+#        </a>
+#        <ul class="dropdown-menu">
+#          <!-- dropdown menu links -->
+#        </ul>
+#      </div>'
+```
+
+### Navigation lists
+
+### Basic tabs example
+
+```ruby
+bootstrap_navigation do |nav|
+  nav.link_to "Nav1", "/link1", :active_nav => true
+  nav.link_to "Nav2", "/link2"
+end
+# => '<ul class="nav nav-tabs">
+#       <li class="active">
+#         <a href="/link1">Nav1</a>
+#       </li>
+#       <li>
+#         <a href="/link2">Nav2</a>
+#       </li>
+#     </ul>'
+```
+
+### Basic pills example
+
+```ruby
+bootstrap_navigation(:type => "pills") do |nav|
+  nav.link_to "Nav1", "/link1"
+  nav.link_to "Nav2", "/link2", :active_nav => true
+end
+# => '<ul class="nav nav-pills">
+#       <li>
+#         <a href="/link1">Nav1</a>
+#       </li>
+#       <li class="active">
+#         <a href="/link2">Nav2</a>
+#       </li>
+#     </ul>'
+```
+
+### Stacked tabs example
+
+```ruby
+bootstrap_navigation(:type => "tabs", :stacked => true) do |nav|
+  nav.link_to "Nav1", "/link1", :active_nav => true
+  nav.link_to "Nav2", "/link2"
+end
+# => '<ul class="nav nav-tabs nav-stacked">
+#       <li class="active">
+#         <a href="/link1">Nav1</a>
+#       </li>
+#       <li>
+#         <a href="/link2">Nav2</a>
+#       </li>
+#     </ul>'
+```
+
+### Stacked pills example
+
+```ruby
+bootstrap_navigation(:type => "pills", :stacked => true) do |nav|
+  nav.link_to "Nav1", "/link1"
+  nav.link_to "Nav2", "/link2", :active_nav => true
+end
+# => '<ul class="nav nav-pills nav-stacked">
+#       <li>
+#         <a href="/link1">Nav1</a>
+#       </li>
+#       <li class="active">
+#         <a href="/link2">Nav2</a>
+#       </li>
+#     </ul>'
+```
+
+### Modal popup example
+
+```ruby
+bootstrap_modal(id: "a_dom_id", fade: true, title: "Modal title!") do |modal|
+  modal.body do |c|
+    c.render partial: 'body'
+  end
+  modal.footer do |c|
+    c.bootstrap_button "Close", "#", type: 'danger', html_options: { data: { dismiss: "modal" } }
+    c.bootstrap_button "Accept",  accept_request_path(@request),
+                       icon_name: 'ok', type: 'success',
+                       html_options: { data: { dismiss: "modal" }, method: :put }
+  end
+end
+# => '<div class="modal fade" id="a_dom_id">
+#       <div class="modal-header">
+#         <a class="close" data-dismiss="modal">&times</a>
+#         <h3>Modal title!</h3>
+#       </div>
+#       <div class="modal-body">
+#         <div>partial content</div>
+#       </div>
+#       <div class="modal-footer">
+#         <a href="#" data-dismiss="modal" class=" btn btn-danger">Close</a>
+#         <a method="put" href="/request/1/accept" data-dismiss="modal" class=" btn btn-success"><i class=" icon icon-ok icon-white"></i> Accept</a>
+#       </div>
+#     </div>'
+```
+
+Plugins
+---
+
+### For [SimpleNavigation](https://github.com/andi/simple-navigation)
+
+If you are using `simple-navigation` gem you can use the navigation renderer like this:
+
+In your initializer:
+
+```ruby
+SimpleNavigation.register_renderer :bootstrap_topbar_list => SimpleNavigation::Renderer::BootstrapTopbarList
+```
+
+```ruby
+render_navigation(level: 1..2, renderer: :bootstrap_topbar_list, expand_all: true)
+```
+
+Contributing
+---
+
+In the spirit of free software, everyone is encouraged to help improve this project.
+
+Here are some ways you can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
+* by writing tests
+* by refactoring code
+* by closing [issues](https://github.com/mcanato/shoehorn/issues)
+* by reviewing patches
+
+Submitting an Issue
+---
+
+We use the [GitHub issue tracker](https://github.com/mcanato/shoehorn/issues) to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a [gist](https://gist.github.com/) that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+---
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run `bundle exec rake yard`. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rake/testtask'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+task :default => :spec
+
+desc 'Test the plugin.'
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate docs'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  #t.options = ['--plugin', 'yard-tomdoc']
+end
+
+if RUBY_VERSION =~ /^1\.9/
+  desc "Code coverage detail"
+  task :simplecov do
+    ENV['COVERAGE'] = "true"
+    Rake::Task['spec'].execute
+  end
+else
+  RSpec::Core::RakeTask.new(:rcov) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+  end
+end

data/lib/shoehorn.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+
+module Shoehorn
+  require "shoehorn/version"
+
+  require "shoehorn/helper_collection"
+  require "shoehorn/helper_collection_set"
+
+  autoload :Helpers, "shoehorn/helpers"
+  autoload :Components, "shoehorn/components"
+
+  require "shoehorn/engine" if defined?(::Rails)
+  require "shoehorn/plugins"
+end
+

data/lib/shoehorn/components.rb

@@ -0,0 +1,17 @@
+module Shoehorn
+  module Components
+    autoload :Base, 'shoehorn/components/base'
+    autoload :Badge, 'shoehorn/components/badge'
+    autoload :Alert, 'shoehorn/components/alert'
+    autoload :Label, 'shoehorn/components/label'
+    autoload :Icon, 'shoehorn/components/icon'
+    #autoload :Form, 'shoehorn/components/form'
+    #autoload :FormBuilder, 'shoehorn/components/form_builder'
+    autoload :Button, 'shoehorn/components/button'
+    autoload :ButtonDropdown, 'shoehorn/components/button_dropdown'
+    autoload :Navigation, 'shoehorn/components/navigation'
+    autoload :Modal, 'shoehorn/components/modal'
+    autoload :ProgressBar, 'shoehorn/components/progress_bar'
+  end
+end
+

data/lib/shoehorn/components/alert.rb

@@ -0,0 +1,69 @@
+module Shoehorn::Components
+  class Alert < Base
+    attr_reader :message
+
+    def initialize(message, options = {})
+      super
+      @message = message
+    end
+
+    def to_s
+      output_buffer << content_tag(:div, build_div_options) do
+        html = ""
+        html << build_close_tag.html_safe   if options[:close]
+        html << build_heading_tag.html_safe if options[:heading]
+        html << message
+        html.html_safe
+      end.html_safe
+      super
+    end
+
+    private
+    def default_options
+      {
+        :class        => "alert",
+        :block        => false,
+        :close        => true,
+        :heading      => nil,
+        :dismiss      => true,
+        :type         => nil,
+        :html_options => {}
+      }
+    end
+
+    def build_close_tag
+      content_tag(:a, "&times;".html_safe, close_tag_options)
+    end
+
+    def build_heading_tag
+      options[:block] ? build_block_heading : build_inline_heading
+    end
+
+    def build_block_heading
+      content_tag(:h4, options[:heading], :class => 'alert-heading')
+    end
+
+    def build_inline_heading
+      content_tag(:strong, options[:heading])
+    end
+
+    def close_tag_options
+      opts = { :class => "close" }
+      opts["data-dismiss"] = "alert" if options[:dismiss]
+      opts
+    end
+
+    def build_div_options
+      opts = { :class => build_class }
+      opts.reverse_merge(options[:html_options])
+    end
+
+    def build_class
+      classes = %w(alert)
+      classes << "alert-block"   if options[:block]
+      classes << "alert-#{options[:type]}" if options[:type]
+      classes.join(" ")
+    end
+  end
+end
+