bootstrap_forms 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Seth Vargo
+
+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.markdown

@@ -0,0 +1,172 @@
+Bootstrap Forms
+===============
+Bootstrap Forms is a nice Rails generator that makes working with [Bootstrap (by Twitter)](http://twitter.github.com/bootstrap) even easier on Rails. 
+
+Forms with Bootstrap are crowded with additional layout markup. While it's necessary, you shouldn't have to type it every time you create a form! That's why I created Bootstrap Forms.
+
+Installation
+------------
+Add it to your `Gemfile`:
+
+    gem 'bootstrap_forms'
+
+Don't forget to run the `bundle` command. The gem will add 2 methods `bootstrap_form_for` and `bootstrap_fields_for` for use in your project. This is different from `bootstrap_forms < 0.1.0`. In previous versions, the default form builders were overridden by default. With backlash from various community members, this is no longer the default.
+
+Be sure to restart your Rails server after installing the gem.
+
+Why?
+----
+With Bootstrap, you would need the following code for a form:
+
+```haml
+/ using haml
+= form_for @model do |f|
+  .clearfix
+    %label MyLabel
+    .input
+      = f.text_area :field, :opts => {...}
+```
+
+```erb
+<!-- using ERB -->
+<%= form_for @model do |f| %>
+  <div class="clearfix">
+    <label>MyLabel</label>
+    <div class="input">
+      <%= f.text_area :field, :opts => {...} %>
+    </div>
+  </div>
+<% end %>
+```
+
+Using Bootstrap Forms, this is **much** simpler:
+
+```haml
+/ using HAML
+= bootstrap_form_for @model do |f|
+  = f.text_area :field, :opts => {...}
+```
+
+```erb
+<!-- using ERB -->
+<%= bootstrap_form_for @model do |f| %>
+  <%= f.text_area :field, :opts => {...} %>
+<% end %>
+```
+
+The custom form builder will automatically wrap everything for you. This helps clean up your view layer significantly!
+
+Additional Form Methods
+-----------------------
+Just when you thought you were done... Bootstrap Forms includes additional form helpers that make life **a lot** easier! For example, the markup required for a list of checkboxes is quite cumbersome... well, it used to be.
+
+### collection_check_boxes
+`collection_check_boxes` behaves very similarly to `collection_select`:
+
+```haml
+= f.collection_check_boxes :category_ids, Category.all, :id, :name
+```
+
+### collection_radio_buttons
+See description above...
+
+```haml
+= f.collection_radio_buttons :primary_category_id, Category.all, :id, :name
+```
+
+Uneditable Field
+----------------
+Bootstrap Forms adds another helper method that generates the necessary markup for uneditable fields:
+
+```haml
+= f.uneditable_field :name
+```
+
+yields:
+
+```html
+<div class="clearfix">
+  <label for="organization_name">Organization Name</label>
+  <div class="input">
+    <span class="uneditable-input">The Variety Hour</span>
+  </div>
+</div>
+```
+
+Submit Tag
+----------
+Bootstrap Forms also adds a default actions panel when you call `f.submit`:
+
+```haml
+= f.submit
+```
+    
+generates:
+
+```html
+<div class="actions">
+  <input type="submit" value="..." class="btn primary" />
+  <a href="..." class="btn">Cancel</a>
+</div>
+```
+
+Pretty swell if you ask me.
+
+Adding More Options
+-------------------
+You can add as many options to any form helper tag. If they are interpreted by Bootstrap Forms, they are interpreted and rendered in the output. If not, they are passed along as values to the final HTML form object.
+
+### Available Options
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+    <th>Usage</th>
+  </tr>
+  <tr>
+    <th>help_inline</th>
+    <td>Add inline help text</td>
+    <td>= f.text_field :name, :help_inline => 'help me!'</td>
+  </tr>
+  <tr>
+    <th>help_block</th>
+    <td>Add block help text (below)</td>
+    <td>= f.text_field :name, :help_block => 'help me!'</td>
+  </tr>
+  <tr>
+    <th>error</th>
+    <td>Styles the field as error (red)</td>
+    <td>= f.text_field :name, :error => 'This is an error!'</td>
+  </tr>
+  <tr>
+    <th>success</th>
+    <td>Styles the field as success (green)</td>
+    <td>= f.text_field :name, :success => 'This checked out OK'</td>
+  </tr>
+  <tr>
+    <th>warning</th>
+    <td>Styles the field as warning (yellow)</td>
+    <td>= f.text_field :name, :warning => 'Take a look at this...'</td>
+  </tr>
+  <tr>
+    <th>prepend</th>
+    <td>Adds special text to the front of the input</td>
+    <td>= f.text_field :name, :prepend => '@'</td>
+  </tr>
+  <tr>
+    <th>append</th>
+    <td>Adds special text at the end of the input</td>
+    <td>= f.text_field :name, :append => '@'</td>
+  </tr>
+</table>
+
+License
+-------
+Copyright (c) 2012 Seth Vargo
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bootstrap_forms.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "bootstrap_forms"
+  s.version     = "0.1.0"
+  s.author      = "Seth Vargo"
+  s.email       = "sethvargo@gmail.com"
+  s.homepage    = "https://github.com/sethvargo/bootstrap_forms"
+  s.summary     = %q{Bootstrap Forms makes Twitter's Bootstrap on Rails easy!}
+  s.description = %q{Bootstrap Forms makes Twitter's Bootstrap on Rails easy to use by creating helpful form builders that minimize markup in your views.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/bootstrap_forms.rb

@@ -0,0 +1 @@
+require 'bootstrap_forms/railtie' if defined?(Rails)

data/lib/bootstrap_forms/form_builder.rb

@@ -0,0 +1,161 @@
+module BootstrapForms
+	class FormBuilder < ActionView::Helpers::FormBuilder
+	  delegate :content_tag, :hidden_field_tag, :check_box_tag, :radio_button_tag, :link_to, :to => :@template
+
+	  def error_messages
+	    if object.errors.full_messages.any?
+	      content_tag(:div, :class => 'alert-message block-message error') do
+	        link_to('&times;'.html_safe, '#', :class => 'close') +
+	        content_tag(:p, "<strong>Oh snap! You got an error!</strong> Fix the errors below and try again.".html_safe) +
+	        content_tag(:ul) do
+	          object.errors.full_messages.map do |message|
+	            content_tag(:li, message)
+	          end.join('').html_safe
+	        end
+	      end
+	    else
+	      '' # return empty string
+	    end
+	  end
+ 
+	  %w(collection_select select check_box email_field file_field number_field password_field phone_field radio_button range_field search_field telephone_field text_area text_field url_field).each do |method_name|
+	    define_method(method_name) do |name, *args|
+	      @name = name
+	      @options = args.extract_options!
+	      @args = args
+     
+	      clearfix_div do
+	        label_field + input_div do
+	          extras { super(name, *(@args << @options)) }
+	        end
+	      end
+	    end
+	  end
+ 
+	  def collection_check_boxes(attribute, records, record_id, record_name, *args)
+	    @name = attribute
+	    @options = args.extract_options!
+	    @args = args
+   
+	    clearfix_div do
+	      label_field + input_div do
+	        extras do
+	          content_tag(:ul, :class => 'inputs-list') do
+	            records.collect do |record|
+	              element_id = "#{object_name}_#{attribute}_#{record.send(record_id)}"
+	              checkbox = check_box_tag("#{object_name}[#{attribute}][]", record.send(record_id), object.send(attribute).include?(record.send(record_id)), :id => element_id)
+         
+	              content_tag(:li) do
+	                content_tag(:label) do
+	                  checkbox + content_tag(:span, record.send(record_name))
+	                end
+	              end
+	            end.join('').html_safe
+	          end 
+	        end
+	      end + hidden_field_tag("#{object_name}[#{attribute}][]")
+	    end
+	  end
+ 
+	  def collection_radio_buttons(attribute, records, record_id, record_name, *args)
+	    @name = attribute
+	    @options = args.extract_options!
+	    @args = args
+   
+	    clearfix_div do
+	      label_field + input_div do
+	        extras do
+	          content_tag(:ul, :class => 'inputs-list') do
+	            records.collect do |record|
+	              element_id = "#{object_name}_#{attribute}_#{record.send(record_id)}"
+	              radiobutton = radio_button_tag("#{object_name}[#{attribute}][]", record.send(record_id), object.send(attribute) == record.send(record_id), :id => element_id)
+           
+	              content_tag(:li) do
+	                content_tag(:label) do
+	                  radiobutton + content_tag(:span, record.send(record_name))
+	                end
+	              end
+	            end.join('').html_safe
+	          end
+	        end
+	      end
+	    end
+	  end
+ 
+	  def uneditable_field(name, *args)
+	    @name = name
+	    @options = args.extract_options!
+	    @args = args
+   
+	    clearfix_div do
+	      label_field + input_div do
+	        extras do
+	          content_tag(:span, :class => 'uneditable-input') do
+	            @options[:value] || object.send(@name.to_sym)
+	          end
+	        end
+	      end
+	    end
+	  end
+ 
+	  def submit(name = nil, *args)
+	    @name = name
+	    @options = args.extract_options!
+	    @args = args
+   
+	    @options[:class] = 'btn primary'
+   
+	    content_tag(:div, :class => 'actions') do
+	      super(name, *(args << @options)) + ' ' + link_to('Cancel', :back, :class => 'btn')
+	    end
+	  end
+ 
+	  private
+	  def clearfix_div(&block)
+	    @options[:error] = object.errors[@name].collect{|e| "#{@options[:label] || @name} #{e}".humanize}.join(', ') unless object.errors[@name].empty?
+   
+	    klasses = ['clearfix']
+	    klasses << 'error' if @options[:error]
+	    klasses << 'success' if @options[:success]
+	    klasses << 'warning' if @options[:warning]
+	    klass = klasses.join(' ')
+   
+	    content_tag(:div, :class => klass, &block)
+	  end
+ 
+	  def input_div(&block)
+	    content_tag(:div, :class => 'input') do
+	      if @options[:append] || @options[:prepend]
+	        klass = 'input-prepend' if @options[:prepend]
+	        klass = 'input-append' if @options[:append]
+	        content_tag(:div, :class => klass, &block)
+	      else
+	        yield if block_given?
+	      end
+	    end
+	  end
+ 
+	  def label_field(&block)
+	    required = object.class.validators_on(@name).any? { |v| v.kind_of? ActiveModel::Validations::PresenceValidator }
+	    label(@name, block_given? ? block : @options[:label], :class => ('required' if required))
+	  end
+ 
+	  %w(help_inline error success warning help_block append prepend).each do |method_name|
+	    define_method(method_name) do |*args|
+	      return '' unless value = @options[method_name.to_sym]
+	      klass = 'help-inline'
+	      klass = 'help-block' if method_name == 'help_block'
+	      klass = 'add-on' if method_name == 'append' || method_name == 'prepend'
+	      content_tag(:span, value, :class => klass)
+	    end
+	  end
+ 
+	  def extras(&block)
+	    [prepend, (yield if block_given?), append, help_inline, error, success, warning, help_block].join('').html_safe
+	  end
+
+	  def objectify_options(options)
+	    super.except(:label, :help_inline, :error, :success, :warning, :help_block, :prepend, :append)
+	  end
+	end
+end

data/lib/bootstrap_forms/initializer.rb

@@ -0,0 +1,24 @@
+require 'bootstrap_forms/form_builder'
+
+module ActionView
+	module Helpers
+		module FormHelper
+			def bootstrap_form_for(record, options = {}, &block)
+				options[:builder] = BootstrapForms::FormBuilder
+				form_for(record, options) do |f|
+					f.error_messages.html_safe + capture(f, &block).html_safe
+				end
+			end
+			
+			def bootstrap_fields_for(record_name, record_object = nil, options = {}, &block)
+				options[:builder] = BootstrapForms::FormBuilder
+				fields_for(record_name, record_object, options, &block)
+			end
+    end
+  end
+end
+
+# don't wrap in those special divs
+ActionView::Base.field_error_proc = Proc.new do |html_tag, instance_tag|
+  html_tag
+end

data/lib/bootstrap_forms/railtie.rb

@@ -0,0 +1,11 @@
+module BootstrapForms
+	class Railtie < ::Rails::Railtie
+		config.after_initialize do |app|
+			require 'bootstrap_forms/initializer'
+		end
+		
+		initializer 'bootstrap_forms.initialize' do |app|
+			
+		end
+	end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap_forms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-16 00:00:00.000000000 Z
+dependencies: []
+description: Bootstrap Forms makes Twitter's Bootstrap on Rails easy to use by creating
+  helpful form builders that minimize markup in your views.
+email: sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- bootstrap_forms.gemspec
+- lib/bootstrap_forms.rb
+- lib/bootstrap_forms/form_builder.rb
+- lib/bootstrap_forms/initializer.rb
+- lib/bootstrap_forms/railtie.rb
+homepage: https://github.com/sethvargo/bootstrap_forms
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Bootstrap Forms makes Twitter's Bootstrap on Rails easy!
+test_files: []