twitter-bootstrap-form-builder 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Eagar
+
+MIT License
+
+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,213 @@
+# TwitterBootstrapFormBuilder
+
+A gem for building **horzontal** (vertial/search/inline coming soon) Twitter Bootstrap forms, automagically handling the
+control-group markup, field labels and inline-error messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'twitter-bootstrap-form-builder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twitter-bootstrap-form-builder
+
+## QuickStart
+
+### app/helpers/application_helper.rb
+
+```ruby
+module ApplicationHelper
+  # Replace form_for
+  include MNE::TwitterBootstrapFormBuilder
+end
+```
+
+### Using the form builder
+
+```erb
+<% # Labels and control-group markup are handled by the form builder %>
+
+<%= form_for @post do |f| %>
+  <%= f.text_field :topic %>
+  <%= f.text_area :body %>
+  <div class="form-actions">
+    <%= f.submit "Create Post" %>
+  </div>
+<% end %>
+```
+
+
+## Usage
+
+Twitter Bootstrap FormBuilder is designed to output all the markup required to build **horzontal** forms,
+with minimal typing.
+
+After installing the Gem, you can use the special `form_for` helper by mixing `TwitterBootstrapFormBuilder::Helper`
+into your Helper modules, which will automatically add the `form-horizontal` class to your `<form>` tag,
+and set the `:builder` to `TwitterBootstrapFormBuilder`. That is, the following are roughly equivalent:
+
+```ruby
+# Using the TBFB helper:
+form_for @post do |f|
+
+# Using the regular form_for helper
+form_for @post, :builder => MNE::TwitterBootstrapFormBuilder::FormBuilder, :html => { :class => "form-horizontal" } do |f|
+```
+
+### Using the FormBuilder:
+
+The various `*_field` and `select` methods will output the full markup for a control group, including labels.
+
+The following `text_field`...
+
+```erb
+<%= form_for @post do |f| %>
+  <%= f.text_field :subject %>
+```
+
+Outputs the following HTML:
+
+```html
+<div class="text_field control-group subject">
+  <label for="post_subject">Subject</label>
+  <div class="controls">
+     <input type="text" name="post[subject]" id="post_subject" value="..." />
+  </div>
+</div>
+```
+
+If you need to override the text of the label, use `:label`:
+
+```erb
+<%= f.text_field :email, :label => "Email Address" %>
+```
+
+If you want to turn off the helper entirely and output *just* the text field, exactly as if you were calling
+the regular `FormBuilder#text_field`, use `:label => false`:
+
+```erb
+<%= f.text_field :email, :label => false %> # <input type="text" id="post_email" />
+```
+
+### Errors and validation
+
+The TwitterBootstrapFormBuilder relies on the dynamic_form gem to output inline error messages.
+
+Outputting a field with errors will add an inline error message and decorate the top-level control-group with an
+`error` class, causing the field inside to be outlined in Red by bootstrap.css
+
+Given a post with a "can't be blank" error on the topic field:
+
+```erb
+<%= form_for @post do |f| %>
+  <%= f.text_field :topic %>
+<% end %>
+```
+
+The following will be produced (a mixture of Rail's `field_with_errors` and Bootstrap-specific classes):
+
+```html
+<div class="text_field control-group topic error">
+  <div class="field_with_errors">
+    <label for="post_topic">Topic</label>
+  </div>
+  <div class="controls">
+    <div class="field_with_errors">
+      <input type="text" name="post[topic]" value="..." />
+    </div>
+    <p class="help-block">Topic can't be blank</p>
+  </div>
+</div>
+```
+
+Note that both the `label` and `input` elements are still wrapped in `<div class="field_with_errors">` by the base
+FormBuilder. In addition, a `<p class="help-block">` is output below the field containing the error message.
+
+### Rendering just some fields:
+
+```erb
+<%= fields_for @post, :builder => MNE::TwitterBootstrapFormBuilder::FormBuilder do |f| %>
+```
+
+### Other helpers
+
+If you want to output your own control group, you can use the `control_group` method to help with the markup.
+
+```erb
+<%= f.control_group :topic %> <!-- div class="control-group topic [error]" -->
+  <%= f.label :topic %>
+  <div class="controls">
+    <%= f.text_field :topic, :label => false %>
+    <div class="errors">
+      <%= f.errors_for :topic %><!-- as provided by dynamic_form -->
+    </div>
+  </div>
+<% end %>
+```
+
+## Examples
+
+Here is a basic form for a PhotoSet, which contains a title and description attribute.
+The form has been posted back, causing a `validates_presence_of` validator to fail on the `title` field:
+
+Form:
+
+```erb
+<%= form_for [:admin, @photo_set] do |f| %>
+  <%= f.text_field :title %>
+  <%= f.text_area :description %>
+
+  <div class="form-actions">
+    <%= f.submit "Create Photo Set" %>
+  </div>
+<% end %>
+```
+
+Output (cleaned up and indented):
+
+```html
+<form accept-charset="UTF-8" action="/admin/photo_sets" class="form-horizontal" id="new_photo_set" method="post">
+	<div style="margin:0;padding:0;display:inline">
+		<input name="utf8" type="hidden" value="&#x2713;" />
+		<input name="authenticity_token" type="hidden" value="nVRM9bXgeD2s/WGum+fJMy9dMYSNVCzYR6/U0Pg+068=" />
+	</div>
+	<div class="text_field control-group title error">
+		<div class="field_with_errors">
+			<label class="control-label" for="photo_set_title">Title</label>
+		</div>
+		<div class="controls">
+			<div class="field_with_errors">
+				<input id="photo_set_title" name="photo_set[title]" size="30" type="text" value="" />
+			</div>
+			<p class="help-block">Title can't be blank</p>
+		</div>
+	</div>
+	<div class="text_area control-group description">
+		<label class="control-label" for="photo_set_description">Description</label>
+		<div class="controls">
+			<textarea cols="40" id="photo_set_description" name="photo_set[description]" rows="20">
+
+			</textarea>
+		</div>
+	</div>
+	<div class="form-actions">
+		<input name="commit" type="submit" value="Create Photo Set" />
+	</div>
+</form>
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/twitter-bootstrap-form-builder.rb

@@ -0,0 +1,3 @@
+require "twitter-bootstrap-form-builder/version"
+require "twitter-bootstrap-form-builder/form_builder"
+require "twitter-bootstrap-form-builder/helper"

data/lib/twitter-bootstrap-form-builder/form_builder.rb

@@ -0,0 +1,62 @@
+
+require 'dynamic_form'
+
+module MNE
+  module TwitterBootstrapFormBuilder
+    class FormBuilder < ActionView::Helpers::FormBuilder
+
+      include ActionView::Helpers::DynamicForm::FormBuilderMethods
+
+      def control_group(field = nil, opts = {}, &block)
+        raise "Expected hash for options, got #{opts.inspect}" unless opts.is_a? Hash
+
+        # wrap in array if not an array
+        opts[:class] = Array(opts[:class])
+        opts[:class] << "control-group"
+        opts[:class] << field if field
+
+        opts[:class] << "error" if @object.errors.messages.has_key? field
+
+        @template.content_tag(:div, opts) do
+          @template.capture &block
+        end
+      end
+
+      %w(text_field phone_field password_field email_field number_field file_field text_area select check_box).each do |method_name|
+        define_method method_name.to_sym do |field, *args|
+
+          # extract the options for the label tag
+          opts = args.find { |a| a.is_a?(Hash) && a.has_key?(:label) }
+          label_opts = opts ? opts[:label] : []
+                 
+          # If label is false, we're rendering the field without modification
+          return super(field, *args) if label_opts === false
+          
+          # create a help-block if present
+          help_opts = args.find { |a| a.is_a?(Hash) && a.has_key?(:help_block) }
+          help_block = help_opts && help_opts[:help_block] ? @template.content_tag(:p, help_opts[:help_block], :class => "help-block") : ""
+                 
+          # propogate properties of control group up
+          h = args.find { |a| a.is_a?(Hash) && a.has_key?(:control_group) }
+          control_group_opts = (h && h[:control_group]) || {}
+          control_group_opts[:class] =  control_group_opts[:class] ?  control_group_opts[:class] + " #{method_name}" : "#{method_name}"
+          
+          label_opts = Array[label_opts] << { :class => "control-label" }
+
+          control_group(field, control_group_opts) do
+            label(field, *label_opts) + @template.content_tag(:div, :class => "controls") do
+              super(field, *args) + help_block + errors_for(field)
+            end
+          end.html_safe
+        end
+
+      end
+
+      def errors_for(field)
+        @template.content_tag(:span, "#{object.class.human_attribute_name(field)} #{object.errors.messages[field].join(",")}",
+                              :class => "help-inline") if object.errors.messages[field].any?
+      end
+
+    end
+  end
+end

data/lib/twitter-bootstrap-form-builder/helper.rb

@@ -0,0 +1,21 @@
+
+module MNE
+  module TwitterBootstrapFormBuilder
+    module Helper
+      def form_for (*args)
+        args << {} unless args.last.is_a? Hash
+
+        args.last[:builder] ||= MNE::TwitterBootstrapFormBuilder::FormBuilder
+        args.last[:html] ||= {}
+        args.last[:html][:class] ||= ""
+
+        if !args.last[:html][:class].match(/form-(horizontal|vertical)/)
+          args.last[:html][:class] = ["form-horizontal", args.last[:html][:class]].join(" ")
+        end
+
+        super
+      end
+    end
+  end
+end
+

data/lib/twitter-bootstrap-form-builder/version.rb

@@ -0,0 +1,5 @@
+module MNE
+  module TwitterBootstrapFormBuilder
+    VERSION = "0.0.2"
+  end
+end

data/twitter-bootstrap-form-builder.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/twitter-bootstrap-form-builder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matthew Eagar"]
+  gem.email         = ["matthew.eagar@mosaic.com"]
+  gem.description   = "Twitter Bootstrap form_for" 
+  gem.summary       = "Twitter Bootstrap form_for"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "twitter-bootstrap-form-builder"
+  gem.require_paths = ["lib"]
+  gem.version       = MNE::TwitterBootstrapFormBuilder::VERSION
+
+  gem.add_dependency 'dynamic_form', '~>1.1.4'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: twitter-bootstrap-form-builder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Matthew Eagar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dynamic_form
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :runtime
+  version_requirements: *id001
+description: Twitter Bootstrap form_for
+email: 
+- matthew.eagar@mosaic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/twitter-bootstrap-form-builder.rb
+- lib/twitter-bootstrap-form-builder/form_builder.rb
+- lib/twitter-bootstrap-form-builder/helper.rb
+- lib/twitter-bootstrap-form-builder/version.rb
+- twitter-bootstrap-form-builder.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Twitter Bootstrap form_for
+test_files: []
+