formatted_form 1.1.0 → 2.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'rails', '>=3.1.0'
+
+group :development do
+  gem 'jeweler'
+end

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Jack Neto
+Copyright (c) 2012 Jack Neto, The Working Group
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,46 +1,138 @@
-# Formatted Form
-Author: [The Working Group](http://www.theworkinggroup.ca)
+# Formatted Form [![Build Status](https://secure.travis-ci.org/twg/formatted_form.png)](http://travis-ci.org/twg/formatted_form)
 
----
+A Rails form builder that generates [Twitter Bootstrap](http://twitter.github.com/bootstrap) markup and helps keep your code clean.
 
-## What is it?
+* Uses existing Rails helpers
+* Auto-generates labels
+* Generates horizontal, vertical and inline forms
+* Groups of checkboxes
+* Groups of radio buttons
+* Prevents double clicking on submit buttons
 
-A Rails form builder to simplify your forms and keep your views clean.
-  
-  
-## Install
+## Installation
 
-### 1. Add the gem definition to your Gemfile:
-    
-    config.gem 'form_builder'
-    
-### 2. From within your Rails project run:
+Add gem definition to your Gemfile and run `bundle install`:
     
-    bundle install
+``` ruby
+gem 'formatted_form'
+```
 
-### 3. Generate the javascript file
+Require it in your CSS and JS manifest files:
 
-    rails g formatted_form:javascripts
+``` css
+//= require formatted_form
+```
 
-This will create `public/javascripts/formatted_form.js` and you should load it using:
-  
-    javascript_include_tag 'formatted_form'
+## Usage (with haml)
 
-### 4. (Optionaly) generate the stylesshet (SASS) file
+Use `formatted_form_for` when you want to render a form with Bootstrap markup.
 
-    rails g formatted_form:stylesheets
+### A sample user form
 
-This will create `app/views/stylesheets/formatted_form.sass` and you can move it to wherever you keep your SASS files and load it using:
+``` ruby
+= formatted_form_for [:admin, @user] do |f|
+  = f.text_field :name
+  = f.number_field :age, nil, :in => 1...100
+  = f.email_field :email, :prepend => '@'
+  = f.phone_field :phone
+  = f.password_field :password
+  = f.password_field :password_confirmation
+  = f.select :role, User::ROLES
+  = f.time_zone_select :time_zone
+  = f.check_box :reminder, :label => 'Send Daily Reminder?'
+  = f.submit 'Save'
+```
 
-    stylesheet_link_tag 'formatted_form'
+### A login form
 
+Add a class to the form or any field to change the way it is rendered.
 
+``` ruby
+= formatted_form_for @session_user, :url => login_path, :class => 'form-horizontal' do |f|
+  = f.text_field :email
+  = f.password_field :password
+  = f.check_box :remember_me, :label => 'Remember me when I come back'
+  = f.submit 'Log In'
+```
 
-## Usage (with haml)
+### A search form
+
+Hide the label by passing `:label => ''` on any field. (Useful for inline search forms)
 
-    = formatted_form_for @session_user, :url => login_path do |f|
-      = f.text_field :email, :label => 'Email address'
-      = f.password_field :password
-      = f.check_box :remember_me, :label => 'Remember me when I come back'
-      = f.submit 'Log In', :change_to_text => 'Logging you in ...', :image => true
+
+``` ruby
+= formatted_form_for @search, :url => [:admin, :users], :html => {:method => :get, :class => 'form-search'} do |f|
+  = f.text_field :name_equals, :label => 'Find by', :placeholder => 'Name'
+  = f.select :role_equals, User::ROLES, :label => ''
+  = f.submit 'Search', :class => 'btn-default'
+```
+
+*(Example using [MetaSearch](https://github.com/ernie/meta_search) helpers)*
+
+### Checkboxes
+
+A single checkbox:
+
+``` ruby
+= f.check_box :send_reminder
+```
+
+A group of checkboxes:
   
+``` ruby
+= f.check_box :colours, :values => [['Red', 1], ['Green', 2], ['Blue', 3]]
+```
+
+Use the :help_block option to show the label on the right side:
+
+``` ruby
+= f.check_box :approved, :help_block => 'Label on the Right'
+```
+
+
+### Radio buttons
+
+A single radio button:
+
+``` ruby
+= f.check_box :role, 'admin'
+```
+
+A group of radio buttons:
+
+``` ruby
+= f.radio_button :role, [['Admin', 1], ['Manager', 2], ['Editor', 3]]
+```
+
+### Submit
+If you add 'formatted_builder' to your Javascript manifest you'll be able to add an extra `data-loading-text` option to submit buttons. This will prevent accidental multiple form submits.
+
+``` ruby
+= f.submit 'Log In', :data => {:loading_text => 'Saving ...'}
+```
+
+### More examples
+
+Override the autogenerated label by using the `:label` option on any element.
+
+``` ruby
+= f.text_field :name, :label => 'Full name'
+```
+
+Use `:append` and `:prepend` on any field:
+
+``` ruby
+= f.text_field :price, :append => '.00'
+= f.email_field :email, :prepend => '@'
+```
+
+Use `:help_block` to provide extra description to a fields:
+
+``` ruby
+= f.email_field :email, :help_block => 'Please enter your emails address'
+```
+
+---
+
+Copyright 2012 Jack Neto, Oleg Khabarov, [The Working Group, Inc](http://twg.ca)
+

data/Rakefile

@@ -1,14 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
 require 'rubygems'
 require 'rake'
-require 'jeweler'
 
-Jeweler::Tasks.new do |gem|
-  gem.name = "formatted_form"
-  gem.homepage = "http://github.com/twg/formatted_form"
-  gem.license = "MIT"
-  gem.summary = "A Rails form builder to simplify your forms"
-  gem.description = ''
-  gem.email = "jack@theworkinggroup.ca"
-  gem.authors = ["Jack Neto"]
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "formatted_form"
+    gem.homepage    = "http://github.com/twg/formatted_form"
+    gem.license     = "MIT"
+    gem.summary     = "A Rails form builder that generates Twitter Bootstrap markup and helps keep your code clean"
+    gem.description = ''
+    gem.email       = "jack@twg.ca"
+    gem.authors     = ["Jack Neto", 'Oleg Khabarov', 'The Working Group Inc.']
+  end
+  Jeweler::RubygemsDotOrgTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
 end
-Jeweler::RubygemsDotOrgTasks.new
+task :default => :test

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/app/assets/javascripts/formatted_form.js

@@ -0,0 +1,12 @@
+// Reset the state of the submit button
+$(document).ready(function() {
+  
+  $('input[type=submit][data-loading-text]').each(function(i, button){
+    $(button).button('reset');
+  });
+  
+  $('form').on('submit', function(event){
+    $('input[type=submit][data-loading-text]', event.target).button('loading');
+  });
+  
+});

data/app/views/formatted_form/_check_box.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/choices', :locals => {:options => options} %>

data/app/views/formatted_form/_date_select.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_datetime_select.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_element.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_email_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_file_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_number_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_password_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_phone_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_radio_button.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/choices', :locals => {:options => options} %>

data/app/views/formatted_form/_range_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_search_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_select.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_submit.html.erb

@@ -0,0 +1 @@
+<%= options[:content] %>

data/app/views/formatted_form/_telephone_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_text_area.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_text_field.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_time_select.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/_time_zone_select.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'formatted_form/templates/field', :locals => {:options => options} %>

data/app/views/formatted_form/templates/_choices.html.erb

@@ -0,0 +1,35 @@
+<%
+  control_group_class  = 'control-group'
+  control_group_class << " cg-#{options[:method].to_s.dasherize}" if options[:method]
+  control_group_class << ' error'                                 if options[:errors]
+%>
+
+<%= content_tag(:div, :class => control_group_class) do %>
+  
+  <% unless options[:label] == '' %>
+    <%= content_tag(:div, :class => 'control-label') do %>
+      <% if options[:choices].size == 1 %>
+        <%= options[:builder].label(options[:method], options[:label]) %>
+      <% else %>
+        <%= options[:label] || options[:method].to_s.humanize %>
+      <% end %>
+    <% end %>
+  <% end %>
+  
+  <%= content_tag(:div, :class => 'controls') do %>
+    <% options[:choices].each do |field, label, inline| %>
+      <% if options[:choices].size == 1 %>
+        <%= field %>
+      <% else%>
+        <% label_class = options[:field_name].to_s.gsub(/(_button$|_)/, '') %>
+        <% label_class << ' inline' if inline %>
+        <%= content_tag(:label, :class => label_class) do %>
+          <%= field %><%= label %>
+        <% end %>
+      <% end %>
+    <% end %>
+    <%= content_tag(:span, options[:errors], :class => 'help-inline') if options[:errors] %>
+    <%= content_tag(:span, options[:help_block], :class => 'help-block') if options[:help_block] %>
+  <% end %>
+  
+<% end %>

data/app/views/formatted_form/templates/_field.html.erb

@@ -0,0 +1,34 @@
+<%
+  inline_form = [:inline, :search].member?(options[:builder].options[:type])
+  
+  control_group_class  = 'control-group'
+  control_group_class << " cg-#{options[:method].to_s.dasherize}" if options[:method]
+  control_group_class << ' error'                                 if options[:errors]
+  
+  if ([:prepend, :append, :prepend_html, :append_html] & options.keys).present?
+    wrapper_class = "#{wrapper_class} input-prepend".strip  if options[:prepend]  || options[:prepend_html]
+    wrapper_class = "#{wrapper_class} input-append".strip   if options[:append]   || options[:append_html]
+  end
+%>
+
+<%= content_tag_unless(inline_form, :div, :class => control_group_class) do %>
+  
+  <% unless ['', false].include?(options[:label]) %>
+    <%= options[:builder].label(options[:method], options[:label], :class => 'control-label') %>
+  <% end %>
+  
+  <%= content_tag_unless(inline_form, :div, :class => 'controls') do %>
+    
+    <%= content_tag_if(wrapper_class, :div, :class => wrapper_class) do %>
+      <%= options[:prepend_html].html_safe if options[:prepend_html] %>
+      <%= content_tag(:span, options[:prepend], :class => 'add-on') if options[:prepend] %>
+      <%= options[:content] %>
+      <%= content_tag(:span, options[:append], :class => 'add-on') if options[:append] %>
+      <%= options[:append_html].html_safe if options[:append_html] %>
+    <% end %>
+    
+    <%= content_tag(:span, options[:errors], :class => 'help-inline') if options[:errors] %>
+    <%= content_tag(:span, options[:help_block], :class => 'help-block') if options[:help_block] %>
+  <% end %>
+  
+<% end %>

data/formatted_form.gemspec

@@ -4,55 +4,105 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{formatted_form}
-  s.version = "1.1.0"
+  s.name = "formatted_form"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jack Neto"]
-  s.date = %q{2011-10-16}
-  s.description = %q{}
-  s.email = %q{jack@theworkinggroup.ca}
+  s.authors = ["Jack Neto", "Oleg Khabarov", "The Working Group Inc."]
+  s.date = "2012-12-03"
+  s.description = ""
+  s.email = "jack@twg.ca"
   s.extra_rdoc_files = [
-    "LICENSE.txt",
+    "LICENSE",
     "README.md"
   ]
   s.files = [
-    "LICENSE.txt",
+    "Gemfile",
+    "LICENSE",
     "README.md",
     "Rakefile",
     "VERSION",
-    "app/views/formatted_form/_check_box.html.haml",
-    "app/views/formatted_form/_default_field.html.haml",
-    "app/views/formatted_form/_radio_button.html.haml",
-    "app/views/formatted_form/_submit.html.haml",
-    "app/views/twitter_bootstrap/_check_box.html.haml",
-    "app/views/twitter_bootstrap/_default_field.html.haml",
-    "app/views/twitter_bootstrap/_radio_button.html.haml",
-    "app/views/twitter_bootstrap/_submit.html.haml",
+    "app/assets/javascripts/formatted_form.js",
+    "app/assets/stylesheets/formatted_form.css",
+    "app/views/formatted_form/_check_box.html.erb",
+    "app/views/formatted_form/_date_select.html.erb",
+    "app/views/formatted_form/_datetime_select.html.erb",
+    "app/views/formatted_form/_element.html.erb",
+    "app/views/formatted_form/_email_field.html.erb",
+    "app/views/formatted_form/_file_field.html.erb",
+    "app/views/formatted_form/_number_field.html.erb",
+    "app/views/formatted_form/_password_field.html.erb",
+    "app/views/formatted_form/_phone_field.html.erb",
+    "app/views/formatted_form/_radio_button.html.erb",
+    "app/views/formatted_form/_range_field.html.erb",
+    "app/views/formatted_form/_search_field.html.erb",
+    "app/views/formatted_form/_select.html.erb",
+    "app/views/formatted_form/_submit.html.erb",
+    "app/views/formatted_form/_telephone_field.html.erb",
+    "app/views/formatted_form/_text_area.html.erb",
+    "app/views/formatted_form/_text_field.html.erb",
+    "app/views/formatted_form/_time_select.html.erb",
+    "app/views/formatted_form/_time_zone_select.html.erb",
+    "app/views/formatted_form/templates/_choices.html.erb",
+    "app/views/formatted_form/templates/_field.html.erb",
     "formatted_form.gemspec",
     "lib/formatted_form.rb",
-    "lib/formatted_form/builder.rb",
-    "lib/formatted_form/configuration.rb",
     "lib/formatted_form/engine.rb",
-    "lib/formatted_form/helper.rb",
-    "lib/generators/formatted_form/javascripts/javascripts_generator.rb",
-    "lib/generators/formatted_form/stylesheets/stylesheets_generator.rb",
-    "templates/javascripts/formatted_form.js",
-    "templates/stylesheets/formatted_form.sass"
+    "lib/formatted_form/form_builder.rb",
+    "lib/formatted_form/view_helper.rb",
+    "test/dummy/README.rdoc",
+    "test/dummy/Rakefile",
+    "test/dummy/app/assets/javascripts/application.js",
+    "test/dummy/app/assets/stylesheets/application.css",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/.gitkeep",
+    "test/dummy/app/models/.gitkeep",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wrap_parameters.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/lib/assets/.gitkeep",
+    "test/dummy/log/.gitkeep",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/script/rails",
+    "test/form_builder_test.rb",
+    "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/twg/formatted_form}
+  s.homepage = "http://github.com/twg/formatted_form"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{A Rails form builder to simplify your forms}
+  s.rubygems_version = "1.8.23"
+  s.summary = "A Rails form builder that generates Twitter Bootstrap markup and helps keep your code clean"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
+      s.add_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rails>, [">= 3.1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end
 

data/lib/formatted_form/engine.rb

@@ -1,17 +1,12 @@
-require "formatted_form"
-require "rails"
+require 'rails'
+require 'formatted_form'
 
 module FormattedForm
   class Engine < Rails::Engine
-    
-    initializer 'formatted_form_helper' do |app|
-      ActionView::Base.send(:include, FormattedForm::Helper)
-      
-      # Removing field_with_errors div araound elemetns with errors
-      if FormattedForm.config.template == :twitter_bootstrap
-        ActionView::Base.field_error_proc = proc { |input, instance| input }
-      end
+    initializer 'helper' do |app|
+      ActionView::Base.send(:include, FormattedForm::ViewHelper)
+      # Remove field_with_errors div around elements with errors
+      ActionView::Base.field_error_proc = proc { |input, instance| input }
     end
-    
   end
 end