formatted_form 1.1.0 → 2.0.0

data/lib/formatted_form/form_builder.rb

@@ -0,0 +1,125 @@
+class FormattedForm::FormBuilder < ActionView::Helpers::FormBuilder
+    
+  %w(
+    text_field password_field email_field telephone_field number_field
+    text_area file_field range_field search_field
+  ).each do |field_name|
+    define_method field_name do |method, *args|
+      options = args.detect { |a| a.is_a?(Hash) } || {}
+      default_field(field_name, method, options) do
+        super(method, *args)
+      end
+    end
+  end
+
+  %w(
+    datetime_select date_select time_select time_zone_select
+  ).each do |field_name|
+    define_method field_name do |method, options = {}, html_options = {}|
+      default_field(field_name, method, options) do
+        super(method, options)
+      end
+    end
+  end
+
+  # Wrapper for the select field
+  def select(method, choices, options = {}, html_options = {})
+    default_field(:select, method, options) do 
+      super(method, choices, options, html_options)
+    end 
+  end
+  
+  # Same as the old check box but it's possible to send an array of values
+  #   form.check_box :color
+  #   form.check_box :color, {}, 'white'
+  #   form.check_box :color, {}, ['red', 'blue']
+  #   form.check_box :color, {}, [['Red', 'red'], ['Blue', 'blue']]
+  def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+    is_array = checked_value.is_a?(Array)
+    options.merge!(:multiple => true) if is_array
+    checked_value = is_array ? checked_value : [[checked_value, checked_value, unchecked_value]]
+    choices = checked_value.collect do |label, checked, unchecked|
+      label, checked  = label, label  if !checked && is_array
+      checked         = label         if !checked
+      label           = nil           if !is_array
+      [super(method, options, checked, unchecked), label, options[:class].to_s =~ /inline/]
+    end
+    default_field(:check_box, method, options.merge(:choices => choices))
+  end
+  
+  # Radio button helper. Optionally it's possible to specify multiple choices at once:
+  #   form.radio_button :role, 'admin'
+  #   form.radio_button :role, ['admin', 'regular']
+  #   form.radio_button :role, [['Admin', 1], ['Regular', 0]]
+  def radio_button(method, tag_value, options = {})
+    tag_values = tag_value.is_a?(Array) ? tag_value : [tag_value]
+    choices = tag_values.collect do |label, choice|
+      label, choice = label, label if !choice
+      [super(method, choice, options), label, options[:class].to_s =~ /inline/]
+    end
+    default_field(:radio_button, method, options.merge(:choices => choices))
+  end
+  
+  # Creates submit button element with appropriate bootstrap classes.
+  #   form.submit, :class => 'btn-danger'
+  def submit(value = nil, options = {}, &block)
+    value, options = nil, value if value.is_a?(Hash)
+    value ||= submit_default_value
+    
+    # Add specific bootstrap class
+    options[:class] = "#{options[:class]} btn".strip
+    options[:class] = "#{options[:class]} btn-primary" unless options[:class] =~ /btn-/
+    
+    default_field(:submit, nil, options) do
+      super(value, options)
+    end
+  end
+  
+  # Form helper to render generic content as a form field. For example:
+  #   form.element 'Label', 'Content'
+  #   form.element 'Label do
+  #     Content
+  #   end
+  def element(label = false, value = nil, &block)
+    options = {:label => label, :content => value }
+    default_field(:element, nil, options, &block)
+  end
+  
+  # adding builder class for fields_for
+  def fields_for(record_name, record_object = nil, options = {}, &block)
+    options[:builder] ||= FormattedForm::FormBuilder
+    super(record_name, record_object, options, &block)
+  end
+  
+protected
+  
+  # Main rendering method
+  def default_field(field_name, method, options = {}, &block)
+    return yield if options[:builder] == false
+    builder_options = builder_options!(options)
+    @template.render(
+      :partial => "formatted_form/#{field_name}",
+      :locals  => { :options => builder_options.merge(
+        :builder    => self,
+        :field_name => field_name,
+        :method     => method,
+        :content    => block_given?? @template.capture(&block) : options.delete(:content),
+        :errors     => method ? error_messages_for(method) : nil
+      )}
+    )
+  end
+  
+  # Extacts parameters that are used for rendering the field
+  def builder_options!(options = {})
+    [
+      :label, :prepend, :append, :prepend_html, :append_html, :help_block, :choices
+    ].each_with_object({}) do |attr, hash|
+      hash[attr] = options.delete(attr)
+    end
+  end
+  
+  # Collecting errors for a field and outputting first instance
+  def error_messages_for(method)
+    [object.errors[method]].flatten.first if object && object.respond_to?(:errors)
+  end
+end

data/lib/formatted_form/view_helper.rb

@@ -0,0 +1,49 @@
+module FormattedForm::ViewHelper
+  
+  def formatted_form_for(record, options = {}, &proc)
+    options = options.dup
+    options[:builder] ||= FormattedForm::FormBuilder
+    
+    options[:html] ||= { }
+    options[:html][:class] ||= 'formatted'
+    
+    # :type option will set proper form class. Conversely having
+    # proper css class will set the type that controls what html
+    # wrappers are used to render form fields
+    if type = options[:html][:class].match(/form-(inline|horizontal|search)/)
+      options[:type] ||= type[1].try(:to_sym)
+    
+    elsif options[:type].present?
+      form_class = case options[:type]
+        when :inline      then 'form-inline'
+        when :horizontal  then 'form-horizontal'
+        when :search      then 'form-search'
+      end
+      options[:html][:class] = "#{options[:html][:class]} #{form_class}".strip
+    end
+    options[:type] ||= :default
+    options[:type] = options[:type].to_sym
+    
+    form_for(record, options, &proc)
+  end
+  
+  # Convenience helper to make templates a bit more dry
+  #   content_tag_if(true, :div, 'test')
+  #   => <div>test</div>
+  #   content_tag_if(false, :div, 'test')
+  #   => test
+  def content_tag_if(boolean, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+    if boolean
+      content_tag(name, content_or_options_with_block, options, escape, &block)
+    elsif block_given?
+      capture(&block)
+    else
+      content_or_options_with_block
+    end
+  end
+  
+  def content_tag_unless(boolean, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+    content_tag_if(!boolean, name, content_or_options_with_block, options, escape, &block)
+  end
+  
+end

data/lib/formatted_form.rb

@@ -1,20 +1,3 @@
-require 'formatted_form/engine' if defined?(Rails)
-require 'formatted_form/builder'
-require 'formatted_form/helper'
-require 'formatted_form/configuration'
-
-module FormattedForm
-  class << self
-
-    def configure
-      yield configuration
-    end
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-    alias :config :configuration
-
-  end
-end
-
+require 'formatted_form/engine'
+require 'formatted_form/form_builder'
+require 'formatted_form/view_helper'

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.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require
+require "formatted_form"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,31 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end