bootstrap_form_builder 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 John Parker
+
+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,39 @@
+= BootstrapFormBuilder
+
+A Rails form builder that outputs forms structured for use with the
+Twitter Bootstrap library. Labels are automatically created, and errors
+are displayed inline.
+
+BootstrapFormBuilder is built using syntax specific to Ruby 1.9. It
+will not work on Ruby 1.8.
+
+= Usage
+
+The builder conforms generally to the generic Rails form builder API.
+
+  <%= bootstrap_form_for @widget do |f| %>
+    <%= f.text_field :name %>
+    <%= f.collection_select :category_id, Category.all, :id, :name, include_blank: true %>
+    <%= f.submit nil, class: 'primary' %>
+  <% end %>
+
+Labels are automatically created for the field. The label and the input
+are wrapped inside of divs classed according to Twitter Bootstrap library's
+conventions.
+
+The field helpers also accept a block to which it yields the input or
+select tag. This can be used to decorate the input fields.
+
+  <%= f.text_field :price do |input_tag| %>
+    <div class="input-append">
+      <%= input_tag %>
+      <label class="add-on">
+        <%= f.check_box :taxable %>
+        <span>Sales tax</span>
+      </label>
+    </div>
+  <% end %>
+
+= More information
+
+http://twitter.github.com/bootstrap

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'BootstrapFormBuilder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/bootstrap_form_builder.rb

@@ -0,0 +1,6 @@
+require 'bootstrap_form_builder/form_builder'
+require 'bootstrap_form_builder/helpers'
+
+ActionView::Base.class_eval do
+  include BootstrapFormBuilder::Helpers
+end

data/lib/bootstrap_form_builder/form_builder.rb

@@ -0,0 +1,60 @@
+module BootstrapFormBuilder
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    def text_field(attribute, options = {}, &block)
+      input_tag = block_given? ? template.capture(super, &block) : super
+      field(input_tag, attribute, options)
+    end
+
+    def password_field(attribute, options = {}, &block)
+      input_tag = block_given? ? template.capture(super, &block) : super
+      field(input_tag, attribute, options)
+    end
+
+    def file_field(attribute, options = {}, &block)
+      input_tag = block_given? ? template.capture(super, &block) : super
+      field(input_tag, attribute, options)
+    end
+
+    def collection_select(attribute, collection, value_method, text_method, options = {})
+      select_tag = super
+      field(select_tag, attribute, options)
+    end
+
+    def uneditable_field(attribute, options = {})
+      span_tag = template.content_tag(:span, object.send(attribute), class: 'uneditable-input', id: "#{object.class.model_name.underscore}_#{attribute}")
+      field(span_tag, attribute, options)
+    end
+
+    def submit(value = nil, options = {})
+      # This version of #submit differs slightly from the ActionView version in that
+      # the model name is titleized to maintain consistent capitalization, e.g., for
+      # a model named QuoteRequest the button label is "Create Quote Request" rather
+      # than "Create Quote request".
+      value ||= "#{object.new_record? ? 'Create' : 'Update'} #{object.class.model_name.titleize}"
+      button_class = ['btn', *options.delete(:class)].join(' ')
+      template.content_tag :div, class: 'clearfix' do
+        template.content_tag :div, class: 'actions' do
+          super(value, options.merge(class: button_class))
+        end
+      end
+    end
+
+    def field(input_tag, attribute, options)
+      errors = object.errors[attribute].uniq.to_sentence
+      outer_class = errors.blank? ? 'clearfix' : 'clearfix error'
+      inner_class = errors.blank? ? 'input' : 'input error'
+
+      template.content_tag(:div, id: "#{object.class.model_name.underscore}_#{attribute}_input", class: outer_class) do
+        label(attribute, options[:label]) << template.content_tag(:div, class: inner_class) do
+          input_div = input_tag
+          input_div << template.content_tag(:span, options[:hint], class: 'help-block') if options[:hint]
+          input_div << template.content_tag(:span, errors, class: 'help-inline') if errors.present?
+          input_div
+        end
+      end
+    end
+
+    private
+    attr_reader :template
+  end
+end

data/lib/bootstrap_form_builder/helpers.rb

@@ -0,0 +1,13 @@
+module BootstrapFormBuilder
+  module Helpers
+    def bootstrap_form_for(*args, &block)
+      options = args.extract_options!
+      form_for(*args, options.merge(builder: BootstrapFormBuilder::FormBuilder), &block)
+    end
+
+    def bootstrap_fields_for(*args, &block)
+      options = args.extract_options!
+      fields_for(*args, options.merge(builder: BootstrapFormBuilder::FormBuilder), &block)
+    end
+  end
+end

data/lib/bootstrap_form_builder/version.rb

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

data/lib/tasks/bootstrap_form_builder_tasks.rake

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

data/test/bootstrap_form_builder/form_builder_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+class BootstrapFormBuilder::FormBuilderTest < ActiveSupport::TestCase
+  include ActionView::Helpers
+  include BootstrapFormBuilder::Helpers
+
+  attr_accessor :output_buffer
+
+  def protect_against_forgery?() end
+
+  class ::Book
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    attr_accessor :author_id, :title, :passphrase
+
+    def persisted?() end
+  end
+
+  def books_path(*args) '/books' end
+
+  setup do
+    @output_buffer = ''
+    @book = Book.new
+  end
+
+  test '#text_field outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.text_field(:title)) })
+    assert_match output_buffer, %r{<div class="clearfix" id="book_title_input">}
+  end
+
+  test '#text_field outputs a label tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.text_field(:title)) })
+    assert_match output_buffer, %r{<label for="book_title">Title</label>}
+  end
+
+  test '#text_field outputs an input tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.text_field(:title)) })
+    assert_match output_buffer, %r{<div class="input"><input id="book_title" name="book\[title\]" size="30" type="text" /></div>}
+  end
+
+  test '#text_field with hint option outputs a help block' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.text_field(:title, hint: 'The Hobbit')) })
+    assert_match output_buffer, %r{<span class="help-block">The Hobbit</span>}
+  end
+
+  test '#text_field with errors wraps field in error class' do
+    @book.errors.stubs(:[]).returns(["can't be blank"])
+    concat(bootstrap_form_for(@book) { |f| concat(f.text_field(:title)) })
+    assert_match output_buffer, %r{<div class="clearfix error" id="book_title_input">}
+    assert_match output_buffer, %r{<div class="input error">}
+    assert_match output_buffer, %r{<span class="help-inline">can't be blank</span>}
+  end
+
+  test '#password_field outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.password_field(:passphrase)) })
+    assert_match output_buffer, %r{<div class="clearfix" id="book_passphrase_input">}
+  end
+
+  test '#password_field outputs a label tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.password_field(:passphrase)) })
+    assert_match output_buffer, %r{<label for="book_passphrase">Passphrase</label>}
+  end
+
+  test '#password_field outputs an input tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.password_field(:passphrase)) })
+    assert_match output_buffer, %r{<div class="input"><input id="book_passphrase" name="book\[passphrase\]" size="30" type="password" /></div>}
+  end
+
+  test '#file_field outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.file_field(:attachment)) })
+    assert_match output_buffer, %r{<div class="clearfix" id="book_attachment_input">}
+  end
+
+  test '#file_field outputs a label tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.file_field(:attachment)) })
+    assert_match output_buffer, %r{<label for="book_attachment">Attachment</label>}
+  end
+
+  test '#file_field outputs an input tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.file_field(:attachment)) })
+    assert_match output_buffer, %r{<div class="input"><input id="book_attachment" name="book\[attachment\]" type="file" /></div>}
+  end
+
+  test '#collection_select outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.collection_select(:author_id, [], :id, :name)) })
+    assert_match output_buffer, %r{<div class="clearfix" id="book_author_id_input">}
+  end
+
+  test '#collection_select outputs a label tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.collection_select(:author_id, [], :id, :name)) })
+    assert_match output_buffer, %r{<label for="book_author_id">Author</label>}
+  end
+
+  test '#collection_select outputs a select tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.collection_select(:author_id, [], :id, :name)) })
+    assert_match output_buffer, %r{<div class="input"><select id="book_author_id" name="book\[author_id\]"></select></div>}
+  end
+
+  test '#submit outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.submit) })
+    assert_match output_buffer, %r{<div class="clearfix"><div class="actions">}
+  end
+
+  test '#submit outputs a submit button' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.submit) })
+    assert_match output_buffer, %r{<input class="btn" name="commit" type="submit" value="Create Book" />}
+  end
+
+  test '#submit applies provided class to button' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.submit(nil, class: 'primary')) })
+    assert_match output_buffer, %r{<input class="btn primary" .* />}
+  end
+
+  test '#uneditable_field outputs a clearfix div' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.uneditable_field(:title)) })
+    assert_match output_buffer, %r{<div class="clearfix" id="book_title_input">}
+  end
+
+  test '#uneditable_field outputs a label tag' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.uneditable_field(:title)) })
+    assert_match output_buffer, %r{<label for="book_title">Title</label>}
+  end
+
+  test '#uneditable_field outputs a span tag with class uneditable-input' do
+    concat(bootstrap_form_for(@book) { |f| concat(f.uneditable_field(:title)) })
+    assert_match output_buffer, %r{<div class="input"><span class="uneditable-input" id="book_title"></span></div>}
+  end
+end

data/test/bootstrap_form_builder/helpers_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class BootstrapFormBuilder::HelpersTest < ActionView::TestCase
+  test '#bootstrap_form_for calls form_for with a builder option' do
+    view.expects(:form_for).with(anything, has_entry(:builder, BootstrapFormBuilder::FormBuilder))
+    view.bootstrap_form_for(stub_everything) {}
+  end
+
+  test '#bootstrap_form_for passes other options through to form_for' do
+    view.expects(:form_for).with(anything, has_entries(builder: BootstrapFormBuilder::FormBuilder, method: :put, html: {multipart: true}))
+    view.bootstrap_form_for(stub_everything, method: :put, html: {multipart: true}) {}
+  end
+
+  test '#bootstrap_fields_for calls fields_for with a builder option' do
+    view.expects(:fields_for).with(anything, has_entry(:builder, BootstrapFormBuilder::FormBuilder))
+    view.bootstrap_fields_for(stub_everything) {}
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.