formtastic-rails3 0.9.7

data/lib/formtastic/i18n.rb

@@ -0,0 +1,32 @@
+module Formtastic
+  module I18n
+    
+    DEFAULT_SCOPE = [:formtastic].freeze
+    DEFAULT_VALUES = {
+        :required       => 'required',
+        :yes            => 'Yes',
+        :no             => 'No',
+        :create         => 'Create {{model}}',
+        :update         => 'Update {{model}}'
+      }.freeze
+    SCOPES = [
+        '{{model}}.{{action}}.{{attribute}}',
+        '{{model}}.{{attribute}}',
+        '{{attribute}}'
+      ]
+      
+    class << self
+      
+      def translate(*args)
+        key = args.shift.to_sym
+        options = args.extract_options!
+        options.reverse_merge!(:default => DEFAULT_VALUES[key])
+        options[:scope] = [DEFAULT_SCOPE, options[:scope]].flatten.compact
+        ::I18n.translate(key, *(args << options))
+      end
+      alias :t :translate
+      
+    end
+    
+  end
+end

data/lib/formtastic/layout_helper.rb

@@ -0,0 +1,10 @@
+module Formtastic
+  module LayoutHelper
+    
+    def formtastic_stylesheet_link_tag
+      stylesheet_link_tag("formtastic") + 
+      stylesheet_link_tag("formtastic_changes")
+    end
+  
+  end
+end

data/lib/generators/formtastic/form/form_generator.rb

@@ -0,0 +1,85 @@
+# coding: utf-8
+module Formtastic
+  class FormGenerator < Rails::Generators::NamedBase
+    desc "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."
+
+    class_option :haml, :type => :boolean, :default => false, :group => :formtastic,
+                 :desc => "Generate HAML instead of ERB"
+
+    class_option :partial, :type => :boolean, :default => false, :group => :formtastic,
+                 :desc => 'Generate a form partial in the model views path, i.e. "_form.html.erb" or "_form.html.haml"'
+
+    class_option :controller, :type => :string, :default => false, :group => :formtastic,
+                 :desc => 'Generate for custom controller/view path - in case model and controller namespace is different, i.e. "admin/posts"'
+
+    def self.source_root
+      @source_root ||= File.expand_path("../templates", __FILE__)
+    end
+
+    def self.banner
+      "rails generate formtastic:form ExistingModelName [options]"
+    end
+
+    def create_or_show
+      if options[:partial]
+        empty_directory "app/views/#{controller_path}"
+        template "_form.html.#{template_type}", "app/views/#{controller_path}/_form.html.#{template_type}"
+      else
+        template = File.read("#{self.class.source_root}/_form.html.#{template_type}")
+        erb = ERB.new(template, nil, '-')
+        generated_code = erb.result(binding).strip rescue nil
+
+        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
+
+    protected
+
+    IGNORED_COLUMNS = [:updated_at, :created_at].freeze
+
+    def template_type
+      @template_type ||= options[:haml] ? :haml : :erb
+    end
+
+    def controller_path
+      @controller_path ||= if options[:controller]
+        options[:controller].underscore
+      else
+        name.underscore.pluralize
+      end
+    end
+
+    def columns
+      @columns ||= self.name.camelize.constantize.content_columns.reject { |column| IGNORED_COLUMNS.include?(column.name.to_sym) }
+    end
+
+    def save_to_clipboard(data)
+      return unless data
+
+      begin
+        case RUBY_PLATFORM
+        when /win32/
+          require 'win32/clipboard'
+          ::Win32::Clipboard.data = data
+        when /darwin/ # mac
+          `echo "#{data}" | pbcopy`
+        else # linux/unix
+          `echo "#{data}" | xsel --clipboard` || `echo "#{data}" | xclip`
+        end
+      rescue LoadError
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/generators/formtastic/form/templates/_form.html.erb

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

data/lib/generators/formtastic/form/templates/_form.html.haml

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

data/lib/generators/formtastic/install/install_generator.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+module Formtastic
+  class InstallGenerator < Rails::Generators::Base
+    desc "Copies formtastic.css and formtastic_changes.css to public/stylesheets/ and a config initializer to config/initializers/formtastic_config.rb"
+
+    def self.source_root
+      @source_root ||= File.expand_path("../templates", __FILE__)
+    end
+    
+    def self.banner
+      "rails generate formtastic:install [options]"
+    end
+
+    def copy_files
+      empty_directory 'config/initializers'
+      template        'formtastic.rb', 'config/initializers/formtastic.rb'
+
+      empty_directory 'public/stylesheets'
+      template        'formtastic.css',         'public/stylesheets/formtastic.css'
+      template        'formtastic_changes.css', 'public/stylesheets/formtastic_changes.css'
+    end
+  end
+end

data/lib/generators/formtastic/install/templates/formtastic.css

@@ -0,0 +1,144 @@
+/* -------------------------------------------------------------------------------------------------
+
+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 { 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 { }
+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; }
+
+/* clearfixing the fieldsets */
+form.formtastic fieldset { display: inline-block; }
+form.formtastic fieldset:after { content: "."; display: block; height: 0; clear: both; visibility: hidden; }
+html[xmlns] form.formtastic fieldset { display: block; }
+* html form.formtastic fieldset { height: 1%; }
+
+
+/* INPUT LIs
+--------------------------------------------------------------------------------------------------*/
+form.formtastic fieldset ol li { margin-bottom:1.5em; }
+
+/* clearfixing the li's */
+form.formtastic fieldset ol li { display: inline-block; }
+form.formtastic fieldset ol li:after { content: "."; display: block; height: 0; clear: both; visibility: hidden; }
+html[xmlns] form.formtastic fieldset ol li { display: block; }
+* html form.formtastic fieldset ol li { height: 1%; }
+
+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:25%; padding-top:0.1em; }
+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 { width:74%; }
+form.formtastic fieldset ol li.password input { width:74%; }
+form.formtastic fieldset ol li.numeric input { 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/lib/generators/formtastic/install/templates/formtastic.rb

@@ -0,0 +1,58 @@
+# 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 user 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]
+
+# Formtastic by default renders inside li tags you can customize it to render
+# with div tags if required
+# Formtastic::SemanticFormBuilder.item_separator = :div
+
+# 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

data/lib/generators/formtastic/install/templates/formtastic_changes.css

@@ -0,0 +1,10 @@
+/* -------------------------------------------------------------------------------------------------
+
+Load this stylesheet after formtastic.css in your layouts to override the CSS to suit your needs.
+This will allow you to update formtastic.css with new releases without clobbering your own changes.
+
+For example, to make the inline hint paragraphs a little darker in color than the standard #666:
+
+form.formtastic fieldset ol li p.inline-hints { color:#333; }
+
+--------------------------------------------------------------------------------------------------*/

data/lib/locale/en.yml

@@ -0,0 +1,8 @@
+en:
+  formtastic:
+    :yes: 'Yes'
+    :no: 'No'
+    create: 'Create'
+    save: 'Save'
+    submit: 'Submit'
+    required: 'Required'

data/spec/buttons_spec.rb

@@ -0,0 +1,149 @@
+# coding: utf-8
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'SemanticFormBuilder#buttons' do
+
+  include FormtasticSpecHelper
+  
+  before do
+    @output_buffer = ActiveSupport::SafeBuffer.new
+    mock_everything
+  end
+
+  describe 'with a block' do
+    describe 'when no options are provided' do
+      before do
+        semantic_form_for(@new_post) do |builder|
+          builder.buttons do
+            concat('hello')
+          end
+        end
+      end
+
+      it 'should render a fieldset inside the form, with a class of "inputs"' do
+        output_buffer.should have_tag("form fieldset.buttons")
+      end
+
+      it 'should render an ol inside the fieldset' do
+        output_buffer.should have_tag("form fieldset.buttons ol")
+      end
+
+      it 'should render the contents of the block inside the ol' do
+        output_buffer.should have_tag("form fieldset.buttons ol", /hello/)
+      end
+
+      it 'should not render a legend inside the fieldset' do
+        output_buffer.should_not have_tag("form fieldset.buttons legend")
+      end
+    end
+
+    describe 'when a :name option is provided' do
+      before do
+        @legend_text = "Advanced options"
+
+        semantic_form_for(@new_post) do |builder|
+          builder.buttons :name => @legend_text do
+          end
+        end
+      end
+      it 'should render a fieldset inside the form' do
+        output_buffer.should have_tag("form fieldset legend", /#{@legend_text}/)
+      end
+    end
+
+    describe 'when other options are provided' do
+      before do
+        @id_option = 'advanced'
+        @class_option = 'wide'
+
+        semantic_form_for(@new_post) do |builder|
+          builder.buttons :id => @id_option, :class => @class_option do
+          end
+        end
+      end
+      it 'should pass the options into the fieldset tag as attributes' do
+        output_buffer.should have_tag("form fieldset##{@id_option}")
+        output_buffer.should have_tag("form fieldset.#{@class_option}")
+      end
+    end
+
+  end
+
+  describe 'without a block' do
+
+    describe 'with no args (default buttons)' do
+
+      before do
+        semantic_form_for(@new_post) do |builder|
+          concat(builder.buttons)
+        end
+      end
+
+      it 'should render a form' do
+        output_buffer.should have_tag('form')
+      end
+
+      it 'should render a buttons fieldset inside the form' do
+        output_buffer.should have_tag('form fieldset.buttons')
+      end
+
+      it 'should not render a legend in the fieldset' do
+        output_buffer.should_not have_tag('form fieldset.buttons legend')
+      end
+
+      it 'should render an ol in the fieldset' do
+        output_buffer.should have_tag('form fieldset.buttons ol')
+      end
+
+      it 'should render a list item in the ol for each default button' do
+        output_buffer.should have_tag('form fieldset.buttons ol li', :count => 1)
+      end
+
+      it 'should render a commit list item for the commit button' do
+        output_buffer.should have_tag('form fieldset.buttons ol li.commit')
+      end
+
+    end
+
+    describe 'with button names as args' do
+
+      before do
+        semantic_form_for(@new_post) do |builder|
+          concat(builder.buttons(:commit))
+        end
+      end
+
+      it 'should render a form with a fieldset containing a list item for each button arg' do
+        output_buffer.should have_tag('form > fieldset.buttons > ol > li', :count => 1)
+        output_buffer.should have_tag('form > fieldset.buttons > ol > li.commit')
+      end
+
+    end
+
+    describe 'with button names as args and an options hash' do
+
+      before do
+        semantic_form_for(@new_post) do |builder|
+          concat(builder.buttons(:commit, :name => "Now click a button", :id => "my-id"))
+        end
+      end
+
+      it 'should render a form with a fieldset containing a list item for each button arg' do
+        output_buffer.should have_tag('form > fieldset.buttons > ol > li', :count => 1)
+        output_buffer.should have_tag('form > fieldset.buttons > ol > li.commit', :count => 1)
+      end
+
+      it 'should pass the options down to the fieldset' do
+        output_buffer.should have_tag('form > fieldset#my-id.buttons')
+      end
+
+      it 'should use the special :name option as a text for the legend tag' do
+        output_buffer.should have_tag('form > fieldset#my-id.buttons > legend', /Now click a button/)
+      end
+
+    end
+
+  end
+
+end
+