sensis-formtastic-rails3 1.d4e5326

data/Rakefile

@@ -0,0 +1,127 @@
+# coding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+begin
+  gem 'rspec', '>= 1.2.6'
+  gem 'rspec-rails', '>= 1.2.6'
+  require 'spec'
+  require 'spec/rake/spectask'
+rescue LoadError
+  begin
+    require 'rspec/core/rake_task.rb'
+    require 'rspec/core/version'
+  rescue LoadError
+    puts "[formtastic:] RSpec - or one of it's dependencies - is not available. Install it with: sudo gem install rspec-rails"
+  end
+end
+
+begin
+  GEM = "formtastic"
+  AUTHOR = "Justin French"
+  EMAIL = "justin@indent.com.au"
+  SUMMARY = "A Rails form builder plugin/gem with semantically rich and accessible markup"
+  HOMEPAGE = "http://github.com/justinfrench/formtastic/tree/master"
+  INSTALL_MESSAGE = %q{
+  ========================================================================
+  Thanks for installing Formtastic!
+  ------------------------------------------------------------------------
+  You can now (optionally) run the generator to copy some stylesheets and
+  a config initializer into your application:
+    rails generator formastic:install # Rails 3
+    ./script/generate formtastic      # Rails 2
+
+  To generate some semantic form markup for your existing models, just run:
+    rails generate formtastic:form MODEL_NAME # Rails 3
+    ./script/generate form MODEL_NAME         # Rails 2
+
+  Find out more and get involved:
+    http://github.com/justinfrench/formtastic
+    http://groups.google.com.au/group/formtastic
+  ========================================================================
+  }
+  
+  gem 'jeweler', '>= 1.0.0'
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |s|
+    s.name = GEM
+    s.summary = SUMMARY
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.description = SUMMARY
+    s.author = AUTHOR
+    s.post_install_message = INSTALL_MESSAGE
+    
+    s.require_path = 'lib'
+    s.files = %w(MIT-LICENSE README.textile Rakefile init.rb) + Dir.glob("{rails,lib,generators,spec}/**/*")
+    
+    # Runtime dependencies: When installing Formtastic these will be checked if they are installed.
+    # Will be offered to install these if they are not already installed.
+    s.add_dependency 'activesupport', '>= 2.3.0'
+    s.add_dependency 'actionpack', '>= 2.3.0'
+    s.add_dependency 'i18n', '>= 0.4.0'
+    
+    # Development dependencies. Not installed by default.
+    # Install with: sudo gem install formtastic --development
+    s.add_development_dependency 'rspec-rails', '>= 1.2.6'
+    s.add_development_dependency 'rspec_tag_matchers', '>= 1.0.0'
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "[formtastic:] Jeweler - or one of its dependencies - is not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+desc 'Default: run unit specs.'
+task :default => :spec
+
+desc 'Generate documentation for the formtastic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Formtastic'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+if defined?(Spec)
+  desc 'Test the formtastic plugin.'
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["-c"]
+  end
+
+  desc 'Test the formtastic plugin with specdoc formatting and colors'
+  Spec::Rake::SpecTask.new('specdoc') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["--format specdoc", "-c"]
+  end
+
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,Library']
+  end
+end
+
+if defined?(RSpec)
+  desc 'Test the formtastic plugin.'
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+  end
+
+  desc 'Test the formtastic plugin with specdoc formatting and colors'
+  RSpec::Core::RakeTask.new('specdoc') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+  end
+
+  desc "Run all examples with RCov"
+  RSpec::Core::RakeTask.new('examples_with_rcov') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,Library']
+  end
+end

data/generators/form/USAGE

@@ -0,0 +1,16 @@
+NAME
+  form - Formtastic form generator.
+  
+DESCRIPTION
+  Generates formtastic form code based on an existing model. By default the generated code will be printed out directly in the terminal, and also copied to clipboard. Can optionally be saved into partial directly.
+  
+  Required:
+    ExistingModelName - The name of an existing model for which the generator should generate form code.
+    
+  Options:
+    --haml              Generate HAML instead of ERB.
+    --partial           Generate a form partial in the model views path, i.e. "_form.html.erb" or _form.html.haml".
+    --controller PATH   Generate for custom controller/view path - in case model and controller namespace is different, i.e. "admin/posts".
+    
+EXAMPLE
+  ./script/generate form ExistingModelName [--haml] [--partial]

data/generators/form/form_generator.rb

@@ -0,0 +1,120 @@
+# coding: utf-8
+# Get current OS - needed for clipboard functionality
+case RUBY_PLATFORM
+when /darwin/ then
+  CURRENT_OS = :osx
+when /win32/
+  CURRENT_OS = :win
+  begin
+    require 'win32/clipboard'
+  rescue LoadError
+    # Do nothing
+  end
+else
+  CURRENT_OS = :x
+end
+
+class FormGenerator < Rails::Generator::NamedBase
+  
+  default_options :haml => false,
+                  :partial => false
+  
+  VIEWS_PATH = File.join('app', 'views').freeze
+  IGNORED_COLUMNS = [:updated_at, :created_at].freeze
+  
+  attr_reader   :controller_file_name,
+                :controller_class_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :template_type
+                
+  def initialize(runtime_args, runtime_options = {})
+    super
+    base_name, @controller_class_path = extract_modules(@name.pluralize)
+    controller_class_name_without_nesting, @controller_file_name = inflect_names(base_name)
+    @template_type = options[:haml] ? :haml : :erb
+  end
+  
+  def manifest
+    record do |m|
+      if options[:partial]
+        controller_and_view_path = options[:controller] || File.join(controller_class_path, controller_file_name)
+        # Ensure directory exists.
+        m.directory File.join(VIEWS_PATH, controller_and_view_path)
+        # Create a form partial for the model as "_form" in it's views path.
+        m.template "view__form.html.#{template_type}", File.join(VIEWS_PATH, controller_and_view_path, "_form.html.#{template_type}")
+      else
+        # Load template file, and render without saving to file
+        template = File.read(File.join(source_root, "view__form.html.#{template_type}"))
+        erb = ERB.new(template, nil, '-')
+        generated_code = erb.result(binding).strip rescue nil
+        
+        # Print the result, and copy to clipboard
+        puts "# ---------------------------------------------------------"
+        puts "#  GENERATED FORMTASTIC CODE"
+        puts "# ---------------------------------------------------------"
+        puts
+        puts generated_code || " Nothing could be generated - model exists?"
+        puts
+        puts "# ---------------------------------------------------------"
+        puts " Copied to clipboard - just paste it!" if save_to_clipboard(generated_code)
+      end
+    end
+  end
+  
+  protected
+    
+    # Save to lipboard with multiple OS support.
+    def save_to_clipboard(data)
+      return unless data
+      begin
+        case CURRENT_OS
+        when :osx
+          `echo "#{data}" | pbcopy`
+        when :win
+          ::Win32::Clipboard.data = data
+        else # :linux/:unix
+          `echo "#{data}" | xsel --clipboard` || `echo "#{data}" | xclip`
+        end
+      rescue
+        false
+      else
+        true
+      end
+    end
+    
+    # Add additional model attributes if specified in args - probably not that common scenario.
+    def attributes
+      # Get columns for the requested model.
+      existing_attributes = @class_name.constantize.content_columns.reject { |column| IGNORED_COLUMNS.include?(column.name.to_sym) }
+      @args = super + existing_attributes
+    end
+    
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      
+      # Allow option to generate HAML views instead of ERB.
+      opt.on('--haml',
+        "Generate HAML output instead of the default ERB.") do |v|
+        options[:haml] = v
+      end
+      
+      # Allow option to generate to partial in model's views path, instead of printing out in terminal.
+      opt.on('--partial',
+        "Save generated output directly to a form partial (app/views/{resource}/_form.html.*).") do |v|
+        options[:partial] = v
+      end
+      
+      opt.on('--controller CONTROLLER_PATH',
+        "Specify a non-standard controller for the specified model (e.g. admin/posts).") do |v|
+        options[:controller] = v if v.present?
+      end
+    end
+    
+    def banner
+      "Usage: #{$0} form ExistingModelName [--haml] [--partial]"
+    end
+    
+end

data/generators/form/templates/view__form.html.erb

@@ -0,0 +1,5 @@
+<%% f.inputs do %>
+<% attributes.each do |attribute| -%>
+  <%%= f.input :<%= attribute.name %>, :label => '<%= attribute.name.humanize %>' %>
+<% end -%>
+<%% end %>

data/generators/form/templates/view__form.html.haml

@@ -0,0 +1,4 @@
+- f.inputs do
+<% attributes.each do |attribute| -%>
+  = f.input :<%= attribute.name %>, :label => '<%= attribute.name.humanize %>'
+<% end -%>

data/generators/formtastic/formtastic_generator.rb

@@ -0,0 +1,24 @@
+class FormtasticGenerator < Rails::Generator::Base
+  
+  def initialize(*runtime_args)
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory File.join('config', 'initializers')
+      m.template 'formtastic.rb',   File.join('config', 'initializers', 'formtastic.rb')
+
+      m.directory File.join('public', 'stylesheets')
+      m.template 'formtastic.css',   File.join('public', 'stylesheets', 'formtastic.css')
+      m.template 'formtastic_changes.css',   File.join('public', 'stylesheets', 'formtastic_changes.css')
+    end
+  end
+    
+  protected
+  
+  def banner
+    %{Usage: #{$0} #{spec.name}\nCopies formtastic.css and formtastic_changes.css to public/stylesheets/ and a config initializer to config/initializers/formtastic.rb}
+  end
+  
+end

data/generators/formtastic/templates/formtastic.css

@@ -0,0 +1,131 @@
+/* -------------------------------------------------------------------------------------------------
+
+It's *strongly* suggested that you don't modify this file.  Instead, load a new stylesheet after
+this one in your layouts (eg formtastic_changes.css) and override the styles to suit your needs.
+This will allow you to update formtastic.css with new releases without clobbering your own changes.
+
+This stylesheet forms part of the Formtastic Rails Plugin
+(c) 2008 Justin French
+
+--------------------------------------------------------------------------------------------------*/
+
+
+/* NORMALIZE AND RESET - obviously inspired by Yahoo's reset.css, but scoped to just form.formtastic
+--------------------------------------------------------------------------------------------------*/
+form.formtastic, form.formtastic ul, form.formtastic ol, form.formtastic li, form.formtastic fieldset, form.formtastic legend, form.formtastic input, form.formtastic textarea, form.formtastic select, form.formtastic p { margin:0; padding:0; }
+form.formtastic fieldset { border:0; }
+form.formtastic em, form.formtastic strong { font-style:normal; font-weight:normal; }
+form.formtastic ol, form.formtastic ul { list-style:none; }
+form.formtastic abbr, form.formtastic acronym { border:0; font-variant:normal; }
+form.formtastic input, form.formtastic textarea, form.formtastic select { font-family:inherit; font-size:inherit; font-weight:inherit; }
+form.formtastic input, form.formtastic textarea, form.formtastic select { font-size:100%; }
+form.formtastic legend { white-space:normal; color:#000; }
+
+
+/* SEMANTIC ERRORS
+--------------------------------------------------------------------------------------------------*/
+form.formtastic ul.errors { color:#cc0000; margin:0.5em 0 1.5em 25%; list-style:square; }
+form.formtastic ul.errors li { padding:0; border:none; display:list-item; }
+
+
+/* FIELDSETS & LISTS
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset { overflow:auto; } /* clearing contained floats */
+form.formtastic fieldset.inputs { }
+form.formtastic fieldset.buttons { padding-left:25%; }
+form.formtastic fieldset ol { }
+form.formtastic fieldset.buttons li { float:left; padding-right:0.5em; }
+
+/* INPUT LIs
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li { margin-bottom:1.5em; }
+form.formtastic fieldset > ol > li { overflow:auto; } /* clearing contained floats */
+
+form.formtastic fieldset > ol > li.required { }
+form.formtastic fieldset > ol > li.optional { }
+form.formtastic fieldset > ol > li.error { }
+  
+
+/* LABELS
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li label { display:block; width:25%; float:left; padding-top:.2em; }
+form.formtastic fieldset > ol > li > li label { line-height:100%; padding-top:0; }
+form.formtastic fieldset > ol > li > li label input { line-height:100%; vertical-align:middle; margin-top:-0.1em;}
+
+
+/* NESTED FIELDSETS AND LEGENDS (radio, check boxes and date/time inputs use nested fieldsets)
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li fieldset { position:relative; }
+form.formtastic fieldset > ol > li fieldset legend { position:absolute; width:95%; padding-top:0.1em; left: 0px; }
+form.formtastic fieldset > ol > li fieldset legend span { position:absolute; }
+form.formtastic fieldset > ol > li fieldset legend.label label { position:absolute; }
+form.formtastic fieldset > ol > li fieldset ol { float:left; width:74%; margin:0; padding:0 0 0 25%; }
+form.formtastic fieldset > ol > li fieldset ol li { padding:0; border:0; }
+
+
+/* INLINE HINTS
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li p.inline-hints { color:#666; margin:0.5em 0 0 25%; }
+
+
+/* INLINE ERRORS
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li p.inline-errors { color:#cc0000; margin:0.5em 0 0 25%; }
+form.formtastic fieldset > ol > li ul.errors { color:#cc0000; margin:0.5em 0 0 25%; list-style:square; }
+form.formtastic fieldset > ol > li ul.errors li { padding:0; border:none; display:list-item; }
+
+
+/* STRING & NUMERIC OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.string input { max-width:74%; }
+form.formtastic fieldset > ol > li.password input { max-width: 13em; }
+form.formtastic fieldset > ol > li.numeric input { max-width:74%; }
+
+
+/* TEXTAREA OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.text textarea { width:74%; }
+
+
+/* HIDDEN OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset ol li.hidden { display:none; }
+
+/* BOOLEAN OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.boolean label { padding-left:25%; width:auto; }
+form.formtastic fieldset > ol > li.boolean label input { margin:0 0.5em 0 0.2em; }
+
+
+/* RADIO OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.radio { }
+form.formtastic fieldset > ol > li.radio fieldset ol { margin-bottom:-0.6em; }
+form.formtastic fieldset > ol > li.radio fieldset ol li { margin:0.1em 0 0.5em 0; }
+form.formtastic fieldset > ol > li.radio fieldset ol li label { float:none; width:100%; }
+form.formtastic fieldset > ol > li.radio fieldset ol li label input { margin-right:0.2em; }
+
+
+/* CHECK BOXES (COLLECTION) OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.check_boxes { }
+form.formtastic fieldset > ol > li.check_boxes fieldset ol { margin-bottom:-0.6em; }
+form.formtastic fieldset > ol > li.check_boxes fieldset ol li { margin:0.1em 0 0.5em 0; }
+form.formtastic fieldset > ol > li.check_boxes fieldset ol li label { float:none; width:100%; }
+form.formtastic fieldset > ol > li.check_boxes fieldset ol li label input { margin-right:0.2em; }
+
+
+
+/* DATE & TIME OVERRIDES
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset > ol > li.date fieldset ol li,
+form.formtastic fieldset > ol > li.time fieldset ol li,
+form.formtastic fieldset > ol > li.datetime fieldset ol li { float:left; width:auto; margin:0 .3em 0 0; }
+
+form.formtastic fieldset > ol > li.date fieldset ol li label,
+form.formtastic fieldset > ol > li.time fieldset ol li label,
+form.formtastic fieldset > ol > li.datetime fieldset ol li label { display:none; }
+
+form.formtastic fieldset > ol > li.date fieldset ol li label input, 
+form.formtastic fieldset > ol > li.time fieldset ol li label input, 
+form.formtastic fieldset > ol > li.datetime fieldset ol li label input { display:inline; margin:0; padding:0;  }

data/generators/formtastic/templates/formtastic.rb

@@ -0,0 +1,54 @@
+# Set the default text field size when input is a string. Default is 50.
+# Formtastic::SemanticFormBuilder.default_text_field_size = 50
+
+# Set the default text area height when input is a text. Default is 20.
+# Formtastic::SemanticFormBuilder.default_text_area_height = 5
+
+# Should all fields be considered "required" by default?
+# Defaults to true, see ValidationReflection notes below.
+# Formtastic::SemanticFormBuilder.all_fields_required_by_default = true
+
+# Should select fields have a blank option/prompt by default?
+# Defaults to true.
+# Formtastic::SemanticFormBuilder.include_blank_for_select_by_default = true
+
+# Set the string that will be appended to the labels/fieldsets which are required
+# It accepts string or procs and the default is a localized version of
+# '<abbr title="required">*</abbr>'. In other words, if you configure formtastic.required
+# in your locale, it will replace the abbr title properly. But if you don't want to use
+# abbr tag, you can simply give a string as below
+# Formtastic::SemanticFormBuilder.required_string = "(required)"
+
+# Set the string that will be appended to the labels/fieldsets which are optional
+# Defaults to an empty string ("") and also accepts procs (see required_string above)
+# Formtastic::SemanticFormBuilder.optional_string = "(optional)"
+
+# Set the way inline errors will be displayed.
+# Defaults to :sentence, valid options are :sentence, :list and :none
+# Formtastic::SemanticFormBuilder.inline_errors = :sentence
+
+# Set the method to call on label text to transform or format it for human-friendly
+# reading when formtastic is used without object. Defaults to :humanize.
+# Formtastic::SemanticFormBuilder.label_str_method = :humanize
+
+# Set the array of methods to try calling on parent objects in :select and :radio inputs
+# for the text inside each @<option>@ tag or alongside each radio @<input>@. The first method
+# that is found on the object will be used.
+# Defaults to ["to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
+# Formtastic::SemanticFormBuilder.collection_label_methods = [
+#   "to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
+
+# Formtastic by default renders inside li tags the input, hints and then
+# errors messages. Sometimes you want the hints to be rendered first than
+# the input, in the following order: hints, input and errors. You can
+# customize it doing just as below:
+# Formtastic::SemanticFormBuilder.inline_order = [:input, :hints, :errors]
+
+# Specifies if labels/hints for input fields automatically be looked up using I18n.
+# Default value: false. Overridden for specific fields by setting value to true,
+# i.e. :label => true, or :hint => true (or opposite depending on initialized value)
+# Formtastic::SemanticFormBuilder.i18n_lookups_by_default = false
+
+# You can add custom inputs or override parts of Formtastic by subclassing SemanticFormBuilder and
+# specifying that class here.  Defaults to SemanticFormBuilder.
+# Formtastic::SemanticFormHelper.builder = MyCustomBuilder