bootstrap2_form_builder 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Zachary G. Wright
+
+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.md

@@ -0,0 +1,101 @@
+# Bootstrap2FormBuilder
+
+*Supports Bootstrap 2* 
+
+This gem adds a helper to all of your views called bootstrap_form_for, which generates a form for a given model object
+and fields with HTML and CSS markup that works with the [Twitter bootstrap](http://twitter.github.com/bootstrap/)  
+library.
+
+## Install
+Add to your gemfile:
+
+```ruby
+gem "bootstrap2_form_builder"
+```
+
+After bundling the gem run 
+
+```console
+rails g bootstrap2_form_builder:install
+```
+
+This will create a partial called error_messages that will contain formatted errors on the object the form is for. This
+generator also takes an option to use HAML (it uses erb by default):
+
+```console
+rails g bootstrap2_form_builder:install -t haml
+```
+
+## Usage
+
+Lets say you have a Person model with required attributes name and email, and an optional attribute of website.
+In your persons_controller in the new action you would set a variable @person = Person.new, which would be handed off
+to your view.
+
+In your view, call bootstrap_form_for just like you would a regular form_for, except leave out labels and most other
+typical markup.
+
+For exmaple:
+
+```ruby
+<%= bootstrap_form_for @person do |form| %>
+	<%= form.text_field :name %>
+	<%= form.text_field :email %>
+	<%= form.text_field :website %>
+<% end %>
+```
+
+This will generate HTML like this:
+
+```html
+<form accept-charset="UTF-8" action="/people" class="new_person" id="new_person" method="post">
+<div style="margin:0;padding:0;display:inline">
+<input name="utf8" type="hidden" value="✓">
+<input name="authenticity_token" type="hidden" value="Edx7gjTOLinEOXqab7LweFhWlJh5uO6Js2l6exeCrwA="></div>
+	<div class="control-group">
+	    <label class="control-label required" for="person_name">Name</label>
+	    <div class="controls">
+	        <input id="person_name" name="person[name]" size="30" type="text">
+        </div>
+    </div>
+	<div class="control-group">
+	    <label class="control-label required" for="person_email">Email</label>
+	    <div class="controls">
+	        <input id="person_email" name="person[email]" size="30" type="text">
+        </div>
+    </div>
+	<div class="control-group">
+	    <label class="control-label" for="person_website">Website</label>
+	    <div class="controls">
+	        <input id="person_website" name="person[website]" size="30" type="text">
+        </div>
+    </div>
+```
+
+See how it automatically generates labels for your inputs? It also marks them as required if there is a
+presence validator for that attribute on the model.
+
+It also adds some options to all of the form helpers (form.text_field, form.text_area, etc)
+
+* :label - Lets you define a custom label
+* :label_class - Lets you define a custom class for your clabel
+* :help_block - A block of text that should appear below your input
+* :help_inline - A line of text that should appear next to your input
+
+For example:
+
+```ruby
+<%= form.text_field :name, :label => "Nickname", :label_class => "important", 
+:help_block => "What do your friends call you?" %>
+```
+
+##Configuration
+
+When you run the install generator it will create an initializer at config/initializers/bootstrap2_form_builder.rb
+
+Here you can customize certain aspects of the form builder. Check the generated file for the most up to date documentation
+and exmaple options.
+
+
+
+This project uses MIT-LICENSE.

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    = 'Bootstrap2FormBuilder'
+  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/bootstrap2_form_builder.rb

@@ -0,0 +1,47 @@
+require 'rails'
+require 'bootstrap2_form_builder/form_builder'
+
+module Bootstrap2FormBuilder
+  mattr_reader :error_partial
+  mattr_writer :error_partial
+  @@error_partial = nil
+
+  mattr_reader :default_form_layout
+  mattr_writer :default_form_layout
+  @@default_form_layout = nil
+
+
+  def self.setup
+    yield self
+  end
+
+  module BootstrapFormHelper
+    def bootstrap_form_for(name, *args, &block)
+      options = args.extract_options!
+
+      target = name
+      if target.kind_of?(Array)
+        target = name[1]
+      end
+
+      #Default form class to form-horizontal.
+      form_html = {:html => {:class => Bootstrap2FormBuilder.default_form_layout}}
+
+      #Work our default class back into the form options. Defer to whatever is passed in if present
+
+      options.merge!(form_html) do |html_key, passed_in_html, default_html|
+        passed_in_html.merge(default_html) do |key, oldval, newval|
+          oldval
+        end
+      end
+
+      partial_location = Bootstrap2FormBuilder.error_partial || "bootstrap2_form_builder/error_messages"
+
+      render(partial_location, :target => target) + form_for(name, *(args << options.merge(:builder => Bootstrap2FormBuilder::FormBuilder)), &block)
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_view) do
+  include Bootstrap2FormBuilder::BootstrapFormHelper
+end

data/lib/bootstrap2_form_builder/form_builder.rb

@@ -0,0 +1,53 @@
+module Bootstrap2FormBuilder
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    #Replace form submit input with styled buttons
+    def submit(label, *args)
+      options = args.extract_options!
+      new_class = options[:class] || "btn btn-primary"
+      @template.content_tag("div",
+        super(label, *(args << options.merge(:class => new_class))), :class => "form-actions")
+    end
+
+=begin
+Generates form fields that work with Twitter Bootstrap. Automatically marks required things as required and places errors
+on matching inputs.
+=end
+    def self.create_tagged_field(method_name)
+      define_method(method_name) do |label, *args|
+        options = args.extract_options!
+
+        custom_label = options[:label] || label.to_s.humanize
+        label_class = options[:label_class] || "control-label"
+
+        if @object.class.validators_on(label).collect(&:class).include? ActiveModel::Validations::PresenceValidator
+          if label_class.nil?
+            label_class = "required"
+          else
+            label_class = label_class + " required"
+          end
+        end
+
+        control_group_class = "control-group"
+        if @object.errors.messages[label]
+          control_group_class = control_group_class + " error"
+        end
+
+      @template.content_tag("div",
+        @template.content_tag("label",
+                  custom_label,
+                  :for => "#{@object_name}_#{label}",
+                  :class => label_class)  +
+          @template.content_tag("div",
+                    super(label, *(args << options)) +
+                        (@template.content_tag("p", options[:help_block], :class => "help-block") if options[:help_block]) +
+                        (@template.content_tag("span", options[:help_inline], :class => "help-inline") if options[:help_inline]),
+                    :class => "controls"),
+                    :class => control_group_class)
+      end
+    end
+
+    field_helpers.each do |name|
+      create_tagged_field(name)
+    end
+  end
+end

data/lib/bootstrap2_form_builder/version.rb

@@ -0,0 +1,3 @@
+module Bootstrap2FormBuilder
+  VERSION = "0.0.2"
+end

data/lib/generators/bootstrap2_form_builder/install_generator.rb

@@ -0,0 +1,23 @@
+module Bootstrap2FormBuilder
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates/bootstrap2_form_builder", __FILE__)
+
+      class_option :view_engine, :type => :string, :aliases => "-t", :desc => "Template engine for the views. Available options are 'erb' and 'haml'.", :default => "erb"
+      class_option :haml, :type => :boolean, :default => false
+
+      # all public methods in here will be run in order
+      def add_my_initializer
+        template "initializer.rb", "config/initializers/bootstrap2_form_builder.rb"
+      end
+
+      def create_error_partials
+        if options[:view_engine] == "haml" || options[:haml]
+          copy_file "_error_messages.html.haml", "app/views/bootstrap2_form_builder/_error_messages.html.haml"
+        elsif
+          copy_file "_error_messages.html.erb", "app/views/bootstrap2_form_builder/_error_messages.html.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/bootstrap2_form_builder/_error_messages.html.erb

@@ -0,0 +1,16 @@
+<% if target.errors.any? %>
+    <div class="alert-message block-message error fade in">
+        <a href="#">
+            *
+        </a>
+        <strong>
+            <%= "#{pluralize(target.errors.count, "error")} prohibited this record from being saved:" %>
+        </strong>
+        <ul>
+            <% targer.errors.full_messages.each do |msg| %>
+                <li>
+                    <%= msg %>
+                </li>
+        </ul>
+    </div>
+<% end %>

data/lib/generators/templates/bootstrap2_form_builder/_error_messages.html.haml

@@ -0,0 +1,9 @@
+- if target.errors.any?
+  %div.alert-message.block-message.error.fade.in
+    %a.close(href="#")×
+    %strong
+      =pluralize(target.errors.count, "error") + " prohibited this record from being saved:"
+    %ul
+    - target.errors.full_messages.each do |msg|
+      %li
+        =msg

data/lib/generators/templates/bootstrap2_form_builder/initializer.rb

@@ -0,0 +1,8 @@
+Bootstrap2FormBuilder.setup do |config|
+  # The error messages partial to render with the form
+  config.error_partial = "bootstrap2_form_builder/error_messages"
+
+  # The default class to give generated forms.
+  # The different types can be found here: http://twitter.github.com/bootstrap/base-css.html#forms
+  config.default_form_layout = "form-horizontal"
+end

data/lib/tasks/bootstrap2_form_builder_tasks.rake

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

data/test/bootstrap2_form_builder_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class Bootstrap2FormBuilderTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Bootstrap2FormBuilder
+  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.