twitter_bootstrap_form_for 1.0.0.rc1

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@twitter_bootstrap_form_for

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,61 @@
+Twitter Bootstrap Form For
+==========================
+
+twitter_bootstrap_form_for is a Rails FormBuilder DSL that, like Formtastic,
+makes it easier to create semantically awesome, readily-stylable, and
+wonderfully accessible HTML forms in your Rails applications. It abides by
+the markup expectations of [Twitter Bootstrap], make your forms look great right
+out of the box.
+
+However, it also tries not to do too much. Rather than try to guess at input
+types and provide an exhaustive set of options for each tag helper (as
+Formtastic does), it only lightly wraps the existing Rails form tag helpers.
+
+Dependencies
+============
+
+Besides Rails, Twitter Bootstrap depends on Haml. You don't have to use it
+yourself, but it made the views for this gem far, far cleaner and more
+readable.
+
+I may consider adding a dependency on `less-rails-bootstrap` in the future, to
+tie this plugin to specific releases of Twitter Bootstrap.
+
+Syntax
+======
+
+    = twitter_bootstrap_form_for @user do |user|
+
+      / wraps a section in a fieldset with the provided legend text
+      = user.inputs 'Sign up' do
+  
+        / generates an email field with descriptive help text and standard
+        / HTML attributes
+        = user.email_field :email, :placeholder => 'me@example.com' do
+          %span.help-block No account? #{link_to('Sign up!', '#')}
+    
+        / generates a password field in a similar manner
+        = user.password_field :password do
+          %span.help-block= link_to('Forgot your password?', '#')
+
+        / a field with a custom label
+        = user.password_field :password_confirmation, 'Confirm Password'
+    
+        / input fields with custom add-ons
+        = user.text_field :twitter_id, 'Twitter', :class => 'medium', :add_on => :prepend do
+          %span.add-on @
+    
+        / lists of checkboxes / radio buttons
+        = user.toggles 'Agreements' do
+          = user.check_box :agree, 'I agree to the Terms and Conditions'
+          = user.check_box :spam,  'I agree to receive all sorts of spam'
+  
+      = user.actions do
+        = user.submit 'Sign up'
+        = button_tag 'Cancel', :type => 'reset', :class => 'btn'
+
+That's it. All of the Rails field helpers you know and love work just like
+their normal FormBuilder counterparts, but with minor extensions to expose
+the functionality anticipated by Twitter Bootstrap.
+
+[Twitter Bootstrap]: http://twitter.github.com/bootstrap/

data/app/views/twitter_bootstrap_form_for/_actions.html.haml

@@ -0,0 +1,2 @@
+.actions
+  = yield

data/app/views/twitter_bootstrap_form_for/_input.html.haml

@@ -0,0 +1,6 @@
+= form.div_wrapper attribute, :class => 'clearfix' do
+  = form.label attribute, label if label
+  .input{:class => add_on}
+    = yield
+    %span.help-inline= form.errors_for(attribute) if form.errors_on?(attribute)
+    = capture &block if block.present?

data/app/views/twitter_bootstrap_form_for/_inputs.html.haml

@@ -0,0 +1,5 @@
+%fieldset
+  - if legend.present?
+    %legend= legend
+  
+  = yield

data/app/views/twitter_bootstrap_form_for/_toggle.html.haml

@@ -0,0 +1,4 @@
+%li
+  %label
+    = yield
+    %span= label

data/app/views/twitter_bootstrap_form_for/_toggles.html.haml

@@ -0,0 +1,6 @@
+.clearfix
+  %label= label
+
+  .input
+    %ul.inputs-list
+      = yield

data/lib/twitter_bootstrap_form_for.rb

@@ -0,0 +1,9 @@
+module TwitterBootstrapFormFor
+  require 'twitter_bootstrap_form_for/version'
+  
+  autoload :FormBuilder, 'twitter_bootstrap_form_for/form_builder'
+  autoload :FormHelpers, 'twitter_bootstrap_form_for/form_helpers'
+  autoload :Railtie,     'twitter_bootstrap_form_for/railtie'
+end
+
+TwitterBootstrapFormFor::Railtie # trigger loading the Railtie

data/lib/twitter_bootstrap_form_for/form_builder.rb

@@ -0,0 +1,162 @@
+require 'twitter_bootstrap_form_for'
+
+class TwitterBootstrapFormFor::FormBuilder < ActionView::Helpers::FormBuilder
+  # TODO: support inline inputs
+  
+  include TwitterBootstrapFormFor::FormHelpers
+  
+  attr_reader :template
+  attr_reader :object
+  attr_reader :object_name
+  
+  INPUTS = [
+    :select,
+    *ActionView::Helpers::FormBuilder.instance_methods.grep(%r{_area$}),
+    *ActionView::Helpers::FormBuilder.instance_methods.grep(%r{_button$}),
+    *ActionView::Helpers::FormBuilder.instance_methods.grep(%r{_field$}),
+    *ActionView::Helpers::FormBuilder.instance_methods.grep(%r{_select$}),
+  ]
+  
+  TOGGLES = [
+    :check_box,
+    :radio_button,
+  ]
+  
+  #
+  # Wraps the contents of the block passed in a fieldset with optional
+  # +legend+ text.
+  #
+  def inputs(legend = nil, &block)
+    # TODO: don't wrap error fields in field_with_error divs
+    # ActionView::Base.field_error_proc = ->(html_tag, instance) { html_tag }
+  
+    template.render(
+      :layout => 'twitter_bootstrap_form_for/inputs',
+      :locals => { :legend => legend },
+      &block
+    )
+  end
+  
+  #
+  # Wraps groups of toggles (radio buttons, checkboxes) with a single label
+  # and the appropriate markup. All toggle buttons should be rendered
+  # inside of here, and will not look correct unless they are.
+  #
+  def toggles(label = nil, &block)
+    template.render(
+      :layout => 'twitter_bootstrap_form_for/toggles',
+      :locals => { :label => label },
+      &block
+    )
+  end
+  
+  #
+  # Wraps action buttons into their own styled container.
+  #
+  def actions(&block)
+    template.render(
+      :layout => 'twitter_bootstrap_form_for/actions',
+      :locals => { },
+      &block
+    )
+  end
+  
+  #
+  # Renders a submit tag with default classes to style it as a primary form
+  # button.
+  #
+  def submit(value = nil, options = {})
+    options[:class] ||= 'btn primary'
+    
+    super value, options
+  end
+  
+  INPUTS.each do |input|
+    define_method input do |attribute, *args, &block|
+      options = args.extract_options!
+      
+      template.render(
+        :layout => 'twitter_bootstrap_form_for/input',
+        :locals => {
+          :form      => self,
+          :attribute => attribute,
+          # only skip label if it's explicitly false
+          :label     => args.first.nil? ? '' : args.shift,
+          :add_on    => (options[:add_on] && 'input-' << options.delete(:add_on).to_s),
+          :block     => block
+        }
+      ) { super attribute, *(args << options) }
+    end
+  end
+  
+  TOGGLES.each do |toggle|
+    define_method toggle do |attribute, *args, &block|
+      options = args.extract_options!
+      
+      template.render(
+        :layout => 'twitter_bootstrap_form_for/toggle',
+        :locals => {
+          :form      => self,
+          :attribute => attribute,
+          :label     => args.first.nil? ? '' : args.shift,
+        }
+      ) { super attribute, *(args << options) }
+    end
+  end
+  
+  def div_wrapper(attribute, options = {}, &block)
+    options[:id]    = _wrapper_id      attribute, options[:id]
+    options[:class] = _wrapper_classes attribute, options[:class]
+    
+    template.content_tag(:div, options, &block)
+  end
+  
+  def errors_on?(attribute)
+    self.object.errors[attribute].present?
+  end
+  
+  def errors_for(attribute)
+    self.object.errors[attribute].try(:join, ', ')
+  end
+  
+  private
+  
+  #
+  # Returns an HTML id to uniquely identify the markup around an input field.
+  # If a +default+ is provided, it uses that one instead.
+  #
+  def _wrapper_id(attribute, default = nil)
+    default || [
+      _object_name + _object_index, 
+      _attribute_name(attribute),
+      'input'
+     ].join('_')
+  end
+  
+  #
+  # Returns any classes necessary for the wrapper div around fields for
+  # +attribute+, such as 'errors' if any errors are present on the attribute.
+  # This merges any +classes+ passed in.
+  #
+  def _wrapper_classes(attribute, *classes)
+    classes.tap do |classes|
+      classes.push 'error' if self.errors_on?(attribute)
+    end
+  end
+  
+  def _attribute_name(attribute)
+    attribute.to_s.gsub(/[\?\/\-]$/, '')
+  end
+  
+  def _object_name
+    self.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
+  end
+  
+  def _object_index
+    case
+      when options.has_key?(:index) then options[:index]
+      when defined?(@auto_index)    then @auto_index
+      else                               nil
+    end.to_s
+  end
+end

data/lib/twitter_bootstrap_form_for/form_helpers.rb

@@ -0,0 +1,16 @@
+require 'twitter_bootstrap_form_for'
+
+module TwitterBootstrapFormFor::FormHelpers
+  [:form_for, :fields_for].each do |method|
+    module_eval do
+      define_method "twitter_bootstrap_#{method}" do |record, *args, &block|
+        # add the TwitterBootstrap builder to the options
+        options           = args.extract_options!
+        options[:builder] = TwitterBootstrapFormFor::FormBuilder
+        
+        # call the original method with our overridden options
+        send method, record, *(args << options), &block
+      end
+    end
+  end
+end

data/lib/twitter_bootstrap_form_for/railtie.rb

@@ -0,0 +1,10 @@
+require 'twitter_bootstrap_form_for'
+require 'rails'
+
+class TwitterBootstrapFormFor::Railtie < Rails::Railtie
+  initializer 'twitter_bootstrap_form_for.initialize',
+    :after => :after_initialize do
+    ActionView::Base.send :include, TwitterBootstrapFormFor::FormHelpers
+    ActionController::Base.append_view_path Pathname.new(__FILE__).join('../../../app/views')
+  end
+end

data/lib/twitter_bootstrap_form_for/version.rb

@@ -0,0 +1,3 @@
+module TwitterBootstrapFormFor
+  VERSION = '1.0.0.rc1'
+end

data/twitter_bootstrap_form_for.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/twitter_bootstrap_form_for/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'twitter_bootstrap_form_for'
+  s.version     = TwitterBootstrapFormFor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Stephen Touset' ]
+  s.email       = [ 'stephen@touset.org' ]
+  s.homepage    = 'http://github.com/stouset/twitter_bootstrap_form_for'
+  s.summary     = 'Rails form builder optimized for Twitter Bootstrap'
+  s.description = 'A custom Rails FormBuilder that assumes the use of Twitter Bootstrap'
+  
+  # s.required_rubygems_version = '>= 1.8.0'
+  # s.rubyforge_project         = 'twitter_bootstrap_form_for'
+  
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map {|f| f =~ /^bin\/(.*)/ ? $1 : nil }.compact
+  s.require_path = 'lib'
+
+  s.add_dependency 'rails', '~> 3'
+  s.add_dependency 'haml',  '~> 3'
+  # TODO: uncomment the next line
+  #  s.add_dependency 'twitter-bootstrap', '~> 1.3'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: twitter_bootstrap_form_for
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+  prerelease: 6
+platform: ruby
+authors:
+- Stephen Touset
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70272000133280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272000133280
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &70272000132780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272000132780
+description: A custom Rails FormBuilder that assumes the use of Twitter Bootstrap
+email:
+- stephen@touset.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.markdown
+- app/views/twitter_bootstrap_form_for/_actions.html.haml
+- app/views/twitter_bootstrap_form_for/_input.html.haml
+- app/views/twitter_bootstrap_form_for/_inputs.html.haml
+- app/views/twitter_bootstrap_form_for/_toggle.html.haml
+- app/views/twitter_bootstrap_form_for/_toggles.html.haml
+- lib/twitter_bootstrap_form_for.rb
+- lib/twitter_bootstrap_form_for/form_builder.rb
+- lib/twitter_bootstrap_form_for/form_helpers.rb
+- lib/twitter_bootstrap_form_for/railtie.rb
+- lib/twitter_bootstrap_form_for/version.rb
+- twitter_bootstrap_form_for.gemspec
+homepage: http://github.com/stouset/twitter_bootstrap_form_for
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Rails form builder optimized for Twitter Bootstrap
+test_files: []