formtastic 2.0.2 → 2.1.0.beta1

data/Rakefile

@@ -1,15 +1,19 @@
 # encoding: utf-8
-require 'rubygems'
-require 'rake'
-require 'rake/rdoctask'
+require 'bundler/setup'
+require 'appraisal'
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 require 'tasks/verify_rcov'
-require 'bundler'
 
 Bundler::GemHelper.install_tasks
 
 desc 'Default: run unit specs.'
-task :default => :spec_and_verify_coverage
+task :default => :all
+
+desc 'Test formtastic with all supported Rails versions.'
+task :all => ["appraisal:install"] do
+  exec('rake appraisal spec')
+end
 
 desc 'Generate documentation for the formtastic plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|

data/app/assets/stylesheets/formtastic.css

@@ -18,6 +18,7 @@ This stylesheet forms part of the Formtastic Rails Plugin
 .formtastic fieldset,
 .formtastic legend,
 .formtastic input,
+.formtastic button,
 .formtastic textarea,
 .formtastic select,
 .formtastic p {
@@ -47,6 +48,7 @@ This stylesheet forms part of the Formtastic Rails Plugin
 }
 
 .formtastic input,
+.formtastic button,
 .formtastic textarea {
   font-family:sans-serif;
   font-size:inherit;
@@ -80,18 +82,29 @@ This stylesheet forms part of the Formtastic Rails Plugin
 }
 
 
-/* BUTTONS
+/* BUTTONS & ACTIONS
 --------------------------------------------------------------------------------------------------*/
-.formtastic .buttons {
+.formtastic .buttons, 
+.formtastic .actions {
   overflow:hidden; /* clear containing floats */
   padding-left:25%;
 }
 
-.formtastic .button {
+.formtastic .button, 
+.formtastic .action {
   float:left;
   padding-right:0.5em;
 }
 
+.formtastic .button_action button {
+  padding:3px 8px;
+}
+
+.formtastic .link_action a {
+  display:block;
+  padding:3px 0;
+}
+
 
 /* INPUTS
 --------------------------------------------------------------------------------------------------*/

data/formtastic.gemspec

@@ -23,13 +23,17 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = %q{1.3.6}
 
-  s.add_dependency(%q<rails>, ["~> 3.0"])
+  s.add_dependency(%q<actionpack>, ["~> 3.0"])
 
-  s.add_development_dependency(%q<rspec-rails>, ["~> 2.5"])
+  s.add_development_dependency(%q<rspec-rails>, ["~> 2.8.0"])
   s.add_development_dependency(%q<rspec_tag_matchers>, [">= 1.0.0"])
   s.add_development_dependency(%q<hpricot>, ["~> 0.8.3"])
   s.add_development_dependency(%q<BlueCloth>) # for YARD
   s.add_development_dependency(%q<yard>, ["~> 0.6"])
   s.add_development_dependency(%q<rcov>, ["~> 0.9.9"])
   s.add_development_dependency(%q<colored>)
+  s.add_development_dependency(%q<tzinfo>)
+  s.add_development_dependency(%q<ammeter>, ["~> 0.2.2"])
+  s.add_development_dependency(%q<appraisal>)
+  s.add_development_dependency(%q<rake>)
 end

data/gemfiles/rails-3.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rails", "~> 3.2.0.rc2"
+
+gemspec :path=>"../"

data/lib/formtastic.rb

@@ -1,25 +1,33 @@
 # encoding: utf-8
-require 'formtastic/railtie' if defined?(::Rails)
 require 'formtastic/engine' if defined?(::Rails)
 
 module Formtastic
   extend ActiveSupport::Autoload
 
   autoload :FormBuilder
-  autoload :SemanticFormBuilder
   autoload :Helpers
   autoload :HtmlAttributes
   autoload :I18n
   autoload :Inputs
+  autoload :Actions
   autoload :LocalizedString
+  autoload :Localizer
   autoload :Util
   
   # @private
   class UnknownInputError < NameError
   end
   
+  # @private
+  class UnknownActionError < NameError
+  end
+  
   # @private
   class PolymorphicInputWithoutCollectionError < ArgumentError
   end
   
+  # @private
+  class UnsupportedMethodForAction < ArgumentError
+  end
+
 end

data/lib/formtastic/actions.rb

@@ -0,0 +1,11 @@
+module Formtastic
+  module Actions
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Buttonish
+    autoload :InputAction
+    autoload :LinkAction
+    autoload :ButtonAction
+  end
+end

data/lib/formtastic/actions/base.rb

@@ -0,0 +1,156 @@
+module Formtastic
+  module Actions
+    module Base
+      include Formtastic::LocalizedString
+      
+      attr_accessor :builder, :template, :object, :object_name, :method, :options
+  
+      def initialize(builder, template, object, object_name, method, options)
+        @builder = builder
+        @template = template
+        @object = object
+        @object_name = object_name
+        @method = method
+        @options = options.dup
+        
+        check_supported_methods!
+      end
+      
+      def to_html
+        raise NotImplementedError
+      end
+      
+      def wrapper(&block)
+        template.content_tag(:li, 
+          template.capture(&block), 
+          wrapper_html_options
+        )
+      end
+      
+      def wrapper_html_options
+        wrapper_html_options_from_options.merge(default_wrapper_html_options)
+      end
+      
+      def wrapper_html_options_from_options
+        options[:wrapper_html] || {}
+      end
+      
+      def default_wrapper_html_options
+        {
+          :class => wrapper_class,
+          :id => wrapper_id
+        }
+      end
+      
+      def wrapper_class
+        (default_wrapper_classes << wrapper_classes_from_options).join(" ")
+      end
+      
+      def default_wrapper_classes
+        ["action", "#{options[:as]}_action"]
+      end
+      
+      def wrapper_classes_from_options
+        classes = wrapper_html_options_from_options[:class] || []
+        classes = classes.split(" ") if classes.is_a? String
+        classes
+      end
+      
+      def wrapper_html_options_from_options
+        options[:wrapper_html] || {}
+      end
+      
+      def wrapper_id
+        wrapper_id_from_options || default_wrapper_id
+      end
+      
+      def wrapper_id_from_options
+        wrapper_html_options_from_options[:id]
+      end
+      
+      def default_wrapper_id
+        "#{object_name}_#{method}_action"
+      end
+      
+      def supported_methods
+        raise NotImplementedError
+      end
+      
+      def text
+        text = options[:label]
+        text = (localized_string(i18n_key, text, :action, :model => sanitized_object_name) ||
+               Formtastic::I18n.t(i18n_key, :model => sanitized_object_name)) unless text.is_a?(::String)
+        text
+      end
+      
+      def button_html
+        default_button_html.merge(button_html_from_options || {}).merge(extra_button_html_options)
+      end
+      
+      def button_html_from_options
+        options[:button_html]
+      end
+      
+      def extra_button_html_options
+        {}
+      end
+      
+      def default_button_html
+        { :accesskey => accesskey }
+      end
+      
+      def accesskey
+        # TODO could be cleaner and separated, remember that nil is an allowed value for all of these
+        return options[:accesskey] if options.key?(:accesskey)
+        return options[:button_html][:accesskey] if options.key?(:button_html) && options[:button_html].key?(:accesskey)
+        # TODO might be different for cancel, etc?
+        return builder.default_commit_button_accesskey
+      end
+      
+      
+      protected
+      
+      def check_supported_methods!
+        raise Formtastic::UnsupportedMethodForAction unless supported_methods.include?(method)
+      end
+      
+      def i18n_key
+        return submit_i18n_key if method == :submit
+        method
+      end
+      
+      def submit_i18n_key
+        if new_or_persisted_object?
+          key = @object.persisted? ? :update : :create
+        else
+          key = :submit
+        end
+      end
+      
+      def new_or_persisted_object?
+        object && (object.respond_to?(:persisted?) || object.respond_to?(:new_record?))
+      end
+      
+      def sanitized_object_name
+        if new_or_persisted_object?
+          # Deal with some complications with ActiveRecord::Base.human_name and two name models (eg UserPost)
+          # ActiveRecord::Base.human_name falls back to ActiveRecord::Base.name.humanize ("Userpost")
+          # if there's no i18n, which is pretty crappy.  In this circumstance we want to detect this
+          # fall back (human_name == name.humanize) and do our own thing name.underscore.humanize ("User Post")
+          if object.class.model_name.respond_to?(:human)
+            sanitized_object_name = object.class.model_name.human
+          else
+            object_human_name = @object.class.human_name                # default is UserPost => "Userpost", but i18n may do better ("User post")
+            crappy_human_name = @object.class.name.humanize             # UserPost => "Userpost"
+            decent_human_name = @object.class.name.underscore.humanize  # UserPost => "User post"
+            sanitized_object_name = (object_human_name == crappy_human_name) ? decent_human_name : object_human_name
+          end
+        else
+          sanitized_object_name = object_name.to_s.send(builder.label_str_method)
+        end
+        sanitized_object_name
+      end
+      
+    end
+  end
+end

data/lib/formtastic/actions/button_action.rb

@@ -0,0 +1,72 @@
+# Outputs a `<button type="submit">` or `<button type="reset">` wrapped in the standard `<li>` 
+# wrapper. This is an alternative choice for `:submit` and `:reset` actions, which render with 
+# `<input type="submit">` and `<input type="reset">` by default.
+#
+# @example Full form context and output
+#
+#   <%= semantic_form_for(@post) do |f| %>
+#     <%= f.actions do %>
+#       <%= f.action :reset, :as => :button %>
+#       <%= f.action :submit, :as => :button %>
+#     <% end %>
+#   <% end %>
+#
+#   <form...>
+#     <fieldset class="actions">
+#       <ol>
+#         <li class="action button_action" id="post_submit_action">
+#           <button type="reset" value="Reset">
+#         </li>
+#         <li class="action button_action" id="post_reset_action">
+#           <button type="submit" value="Create Post">
+#         </li>
+#       </ol>
+#     </fieldset>
+#   </form>
+#
+# @example Specifying a label with a String
+#   <%= f.action :submit, :as => :button, :label => "Go" %>
+#
+# @example Pass HTML attributes down to the `<button>`
+#   <%= f.action :submit, :as => :button, :button_html => { :class => 'pretty', :accesskey => 'g', :disable_with => "Wait..." } %>
+#
+# @example Access key can also be set as a top-level option
+#   <%= f.action :submit, :as => :button, :accesskey => 'g' %>
+#
+# @example Pass HTML attributes down to the `<li>` wrapper (classes are appended to the existing classes)
+#   <%= f.action :submit, :as => :button, :wrapper_html => { :class => 'special', :id => 'whatever' } %>
+#   <%= f.action :submit, :as => :button, :wrapper_html => { :class => ['extra', 'special'], :id => 'whatever' } %>
+#
+# @option *args :label [String, Symbol]
+#   Override the label text with a String or a symbol for an i18n translation key
+#
+# @option *args :button_html [Hash]
+#   Override or add to the HTML attributes to be passed down to the `<input>` tag
+#
+# @option *args :wrapper_html [Hash]
+#   Override or add to the HTML attributes to be passed down to the wrapping `<li>` tag
+#
+# @todo document i18n keys
+# @todo document i18n translation with :label (?)
+module Formtastic
+  module Actions
+    class ButtonAction
+      include Base
+      include Buttonish
+      
+      # TODO absolutely horrible hack to work-around Rails < 3.1 missing button_tag, need
+      # to figure out something more appropriate.
+      #
+      # TODO reset_action class?
+      def to_html
+        wrapper do
+          if template.respond_to?(:button_tag)
+            template.button_tag(text, button_html)
+          else
+            template.content_tag(:button, text, button_html)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/actions/buttonish.rb

@@ -0,0 +1,17 @@
+module Formtastic
+  module Actions
+    module Buttonish
+      
+      def supported_methods
+        [:submit, :reset]
+      end
+
+      def extra_button_html_options
+        {
+          :type => method
+        }
+      end
+      
+    end
+  end
+end

data/lib/formtastic/actions/input_action.rb

@@ -0,0 +1,68 @@
+# Outputs an `<input type="submit">` or `<input type="reset">` wrapped in the standard `<li>` 
+# wrapper. This the default for `:submit` and `:reset` actions, but `:as => :button` is also 
+# available as an alternative.
+#
+# @example The `:as` can be ommitted, these are functionally equivalent
+#   <%= f.action :submit, :as => :input %>
+#   <%= f.action :submit %>
+#
+# @example Full form context and output
+#
+#   <%= semantic_form_for(@post) do |f| %>
+#     <%= f.actions do %>
+#       <%= f.action :reset, :as => :input %>
+#       <%= f.action :submit, :as => :input %>
+#     <% end %>
+#   <% end %>
+#
+#   <form...>
+#     <fieldset class="actions">
+#       <ol>
+#         <li class="action input_action" id="post_submit_action">
+#           <input type="reset" value="Reset">
+#         </li>
+#         <li class="action input_action" id="post_reset_action">
+#           <input type="submit" value="Create Post">
+#         </li>
+#       </ol>
+#     </fieldset>
+#   </form>
+#
+# @example Specifying a label with a String
+#   <%= f.action :submit, :as => :input, :label => "Go" %>
+#
+# @example Pass HTML attributes down to the `<input>`
+#   <%= f.action :submit, :as => :input, :button_html => { :class => 'pretty', :accesskey => 'g', :disable_with => "Wait..." } %>
+#
+# @example Access key can also be set as a top-level option
+#   <%= f.action :submit, :as => :input, :accesskey => 'g' %>
+#
+# @example Pass HTML attributes down to the `<li>` wrapper (classes are appended to the existing classes)
+#   <%= f.action :submit, :as => :input, :wrapper_html => { :class => 'special', :id => 'whatever' } %>
+#   <%= f.action :submit, :as => :input, :wrapper_html => { :class => ['extra', 'special'], :id => 'whatever' } %>
+#
+# @option *args :label [String, Symbol]
+#   Override the label text with a String or a symbol for an i18n translation key
+#
+# @option *args :button_html [Hash]
+#   Override or add to the HTML attributes to be passed down to the `<input>` tag
+#
+# @option *args :wrapper_html [Hash]
+#   Override or add to the HTML attributes to be passed down to the wrapping `<li>` tag
+#
+# @todo document i18n keys
+# @todo document i18n translation with :label (?)
+module Formtastic
+  module Actions
+    class InputAction
+      include Base
+      include Buttonish
+      
+      def to_html
+        wrapper do
+          builder.submit(text, button_html)
+        end
+      end
+    end
+  end
+end