Updating formtastic

vendor/plugins/formtastic/lib/formtastic.rb

@@ -283,30 +283,55 @@ def buttons(*args, &block)
     #
     # The value of the button text can be overridden:
     #
-    #  <%= form.commit_button "Go" %> => <input name="commit" type="submit" value="Go" />
+    #  <%= form.commit_button "Go" %> => <input name="commit" type="submit" value="Go" class="{create|update|submit}" />
+    #  <%= form.commit_button :label => "Go" %> => <input name="commit" type="submit" value="Go" class="{create|update|submit}" />
     #
     # And you can pass html atributes down to the input, with or without the button text:
     #
-    #  <%= form.commit_button "Go" %> => <input name="commit" type="submit" value="Go" />
-    #  <%= form.commit_button :class => "pretty" %> => <input name="commit" type="submit" value="Save Post" class="pretty" />
+    #  <%= form.commit_button "Go" %> => <input name="commit" type="submit" value="Go" class="{create|update|submit}" />
+    #  <%= form.commit_button :class => "pretty" %> => <input name="commit" type="submit" value="Save Post" class="pretty {create|update|submit}" />
     #
     # You can use the actual <button/> html tag instead the default <input type="submit"/>:
     #
-    #  <%= form.commit_button "Save", :use_button_html => true %> => <button name="commit" type="submit">Go</button>
+    #  <%= form.commit_button "Save", :use_button_html => true %> #=> <button name="commit" type="submit">Go</button>
     #
     def commit_button(*args)
-      value = args.first.is_a?(String) ? args.shift : save_or_create_button_text
-      options = args.shift || {}
+      options = args.extract_options!
+      text = options.delete(:label) || args.shift
+
+      if @object
+        key = @object.new_record? ? :create : :update
+        object_name = @object.class.human_name
+
+        if key == :update
+          # Note: Fallback on :save-key (deprecated), :update makes more sense in the REST-world.
+          fallback_text = ::I18n.t(:save, :model => object_name, :default => "Save {{model}}", :scope => [:formtastic])
+          ::ActiveSupport::Deprecation.warn "Formtastic I18n: Key 'formtastic.save' is now deprecated in favor 'formtastic.update'."
+        end
+      else
+        key = :submit
+        object_name = @object_name.to_s.send(@@label_str_method)
+      end
+      fallback_text ||= "#{key.to_s.humanize} {{model}}"
+
+      text = (self.localized_string(key, text, :action, :model => object_name) ||
+              ::I18n.t(key, :model => object_name, :default => fallback_text, :scope => [:formtastic])) unless text.is_a?(::String)
+
       button_html = options.delete(:button_html) || {}
-      button_or_input_tag = begin
-        if options.delete(:use_button_tag)
+      button_html.merge!(:class => [button_html[:class], key].compact.join(' '))
+      element_class = ['commit', options.delete(:class)].compact.join(' ') # TODO: Add class reflecting on form action.
+
+      button_content = begin
+        as = options.delete(:as)
+        if as && as.to_sym == :button || options.delete(:use_button_tag)
           button_html.merge!(:type => 'submit', :name => 'commit')
-          template.content_tag(:button, value, button_html) 
+          template.content_tag(:button, text, button_html) 
         else
-          self.submit(value, button_html)
+          self.submit(text, button_html)
         end
       end
-      template.content_tag(:li, button_or_input_tag, :class => "commit")
+
+      template.content_tag(:li, button_content, :class => "commit")
     end
 
     # A thin wrapper around #fields_for to set :builder => Formtastic::SemanticFormBuilder
@@ -364,10 +389,12 @@ def label(method, options_or_text=nil, options=nil)
         text = options_or_text
         options ||= {}
       end
-
-      text = localized_attribute_string(method, text, :label) || humanized_attribute_name(method)
+      text = localized_string(method, text, :label) || humanized_attribute_name(method)
       text += required_or_optional_string(options.delete(:required))
-
+
+      # special case for boolean (checkbox) labels, which have a nested input
+      text = (options.delete(:label_prefix_for_nested_input) || "") + text
+
       input_name = options.delete(:input_name) || method
       if options.delete(:as_span)
         options[:class] ||= 'label'
@@ -433,22 +460,6 @@ def set_options(options)
                      :as, :hint, :input_html, :label_html, :value_as_class)
     end
 
-    # Create a default button text. If the form is working with a object, it
-    # defaults to "Create {{model}}" or "Save {{model}}" depending if we are working
-    # with a new_record or not.
-    #
-    # When not working with models, it defaults to "Submit object".
-    #
-    def save_or_create_button_text(prefix='Submit') #:nodoc:
-      if @object
-        prefix      = @object.new_record? ? 'Create' : 'Save'
-        object_name = @object.class.human_name
-      else
-        object_name = @object_name.to_s.send(@@label_str_method)
-      end
-      I18n.t(prefix.downcase, :model => object_name, :default => "#{prefix} {{model}}", :scope => [:formtastic])
-    end
-
     # Determins if the attribute (eg :title) should be considered required or not.
     #
     # * if the :required option was provided in the options hash, the true/false value will be
@@ -937,8 +948,12 @@ def boolean_input(method, options)
 
       input = self.check_box(method, set_options(options).merge(html_options),
                              options.delete(:checked_value) || '1', options.delete(:unchecked_value) || '0')
-
-      self.label(method, input << self.label(method, options_for_label(options)), options_for_label(options))
+      options = options_for_label(options)
+
+      # the label() method will insert this nested input into the label at the last minute
+      options[:label_prefix_for_nested_input] = input
+
+      self.label(method, options)
     end
 
     # Generates an input for the given method using the type supplied with :as.
@@ -961,7 +976,7 @@ def inline_input_for(method, options)
     # Generates hints for the given method using the text supplied in :hint.
     #
     def inline_hints_for(method, options) #:nodoc:
-      options[:hint] = localized_attribute_string(method, options[:hint], :hint)
+      options[:hint] = localized_string(method, options[:hint], :hint)
       return if options[:hint].blank?
       template.content_tag(:p, options[:hint], :class => 'inline-hints')
     end
@@ -1013,7 +1028,7 @@ def required_or_optional_string(required) #:nodoc:
     #
     def field_set_and_list_wrapping(html_options, contents='', &block) #:nodoc:
       html_options[:name] ||= html_options.delete(:title)
-      html_options[:name] = localized_attribute_string(html_options[:name], html_options[:name], :title) if html_options[:name].is_a?(Symbol)
+      html_options[:name] = localized_string(html_options[:name], html_options[:name], :title) if html_options[:name].is_a?(Symbol)
 
       legend  = html_options.delete(:name).to_s
       legend %= parent_child_index(html_options[:parent]) if html_options[:parent]
@@ -1244,16 +1259,18 @@ def humanized_attribute_name(method)
     # 
     # NOTE: Generic, but only used for form input labels/hints.
     #
-    def localized_attribute_string(attr_name, attr_value, i18n_key)
-      if attr_value.is_a?(String)
-        attr_value
+    def localized_string(key, value, type, options = {})
+      key = value if value.is_a?(::Symbol)
+
+      if value.is_a?(::String)
+        value
       else
-        use_i18n = attr_value.nil? ? @@i18n_lookups_by_default : (attr_value != false)
-        
+        use_i18n = value.nil? ? @@i18n_lookups_by_default : (value != false)
+
         if use_i18n
-          model_name = @object.class.name.underscore
+          model_name  = (@object ? @object.class.name : @object_name.to_s.send(@@label_str_method)).underscore
           action_name = template.params[:action].to_s rescue ''
-          attribute_name = attr_name.to_s
+          attribute_name = key.to_s
 
           defaults = I18N_SCOPES.collect do |i18n_scope|
             i18n_path = i18n_scope.dup
@@ -1265,8 +1282,8 @@ def localized_attribute_string(attr_name, attr_value, i18n_key)
           end
           defaults << ''
 
-          i18n_value = ::I18n.t(defaults.shift, :default => defaults,
-                                :scope => "formtastic.#{i18n_key.to_s.pluralize}")
+          i18n_value = ::I18n.t(defaults.shift, options.merge(:default => defaults,
+                                :scope => :"formtastic.#{type.to_s.pluralize}"))
           i18n_value.blank? ? nil : i18n_value
         end
       end