formtastic 1.2.4 → 3.1.5

data/lib/formtastic/action_class_finder.rb

@@ -0,0 +1,18 @@
+module Formtastic
+
+  # Uses the {NamespacedClassFinder} to look up action class names.
+  #
+  # See {Formtastic::Helpers::ActionHelper#namespaced_action_class} for details.
+  #
+  class ActionClassFinder < NamespacedClassFinder
+
+    # @param builder [FormBuilder]
+    def initialize(builder)
+      super builder.action_namespaces
+    end
+
+    def class_name(as)
+      "#{super}Action"
+    end
+  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,67 @@
+module Formtastic
+  module Actions
+
+  # 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_reset_action">
+  #           <button type="reset" value="Reset">
+  #         </li>
+  #         <li class="action button_action" id="post_submit_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' } %>
+  #
+  # @todo document i18n keys
+  # @todo document i18n translation with :label (?)
+  class ButtonAction
+      include Base
+      include Buttonish
+
+      # @see Formtastic::Helpers::ActionHelper#action
+      # @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 reset_action class?
+      def to_html
+        wrapper do
+          template.button_tag(text, button_html)
+        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,70 @@
+module Formtastic
+  module Actions
+
+  # 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_reset_action">
+  #           <input type="reset" value="Reset">
+  #         </li>
+  #         <li class="action input_action" id="post_submit_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' } %>
+  # @todo document i18n keys
+  # @todo document i18n translation with :label (?)
+  class InputAction
+      include Base
+      include Buttonish
+
+      # @see Formtastic::Helpers::ActionHelper#action
+      # @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
+      #
+
+      def to_html
+        wrapper do
+          builder.submit(text, button_html)
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/actions/link_action.rb

@@ -0,0 +1,88 @@
+module Formtastic
+  module Actions
+  # Outputs a link wrapped in the standard `<li>` wrapper. This the default for `:cancel` actions.
+  # The link's URL defaults to Rails' built-in `:back` macro (the HTTP referrer, or Javascript for the
+  # browser's history), but can be altered with the `:url` option.
+  #
+  # @example The `:as` can be ommitted, these are functionally equivalent
+  #   <%= f.action :cancel, :as => :link %>
+  #   <%= f.action :cancel %>
+  #
+  # @example Full form context and output
+  #
+  #   <%= semantic_form_for(@post) do |f| %>
+  #     <%= f.actions do %>
+  #       <%= f.action :submit, :as => :input %>
+  #       <%= f.action :cancel, :as => :link %>
+  #     <% end %>
+  #   <% end %>
+  #
+  #   <form...>
+  #     <fieldset class="actions">
+  #       <ol>
+  #         <li class="action input_action" id="post_submit_action">
+  #           <input type="submit" value="Create Post">
+  #         </li>
+  #         <li class="action link_action" id="post_cancel_action">
+  #           <a href="javascript:history.back()">Cancel</a>
+  #         </li>
+  #       </ol>
+  #     </fieldset>
+  #   </form>
+  #
+  # @example Modifying the URL for the link
+  #   <%= f.action :cancel, :as => :link, :url => "http://example.com/path" %>
+  #   <%= f.action :cancel, :as => :link, :url => "/path" %>
+  #   <%= f.action :cancel, :as => :link, :url => posts_path %>
+  #   <%= f.action :cancel, :as => :link, :url => url_for(...) %>
+  #   <%= f.action :cancel, :as => :link, :url => { :controller => "posts", :action => "index" } %>
+  #
+  # @example Specifying a label with a String
+  #   <%= f.action :cancel, :as => :link, :label => "Stop" %>
+  #
+  # @example Pass HTML attributes down to the `<a>`
+  #   <%= f.action :cancel, :as => :link, :button_html => { :class => 'pretty', :accesskey => 'x' } %>
+  #
+  # @example Access key can also be set as a top-level option
+  #   <%= f.action :cancel, :as => :link, :accesskey => 'x' %>
+  #
+  # @example Pass HTML attributes down to the `<li>` wrapper (classes are appended to the existing classes)
+  #   <%= f.action :cancel, :as => :link, :wrapper_html => { :class => 'special', :id => 'whatever' } %>
+  #   <%= f.action :cancel, :as => :link, :wrapper_html => { :class => ['extra', 'special'], :id => 'whatever' } %>
+  #
+  # @todo document i18n keys
+  # @todo document i18n translation with :label (?)
+  # @todo :prefix and :suffix options? (can also be done with CSS or subclassing for custom Actions)
+  class LinkAction
+      include Base
+
+      # @see Formtastic::Helpers::ActionHelper#action
+      # @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 `<a>` tag
+      #
+      # @option *args :wrapper_html [Hash]
+      #   Override or add to the HTML attributes to be passed down to the wrapping `<li>` tag
+      #
+
+      def supported_methods
+        [:cancel]
+      end
+
+      # TODO reset_action class?
+      def to_html
+        wrapper do
+          template.link_to(text, url, button_html)
+        end
+      end
+
+      def url
+        return options[:url] if options.key?(:url)
+        :back
+      end
+
+    end
+  end
+end

data/lib/formtastic/deprecation.rb

@@ -0,0 +1,42 @@
+require 'active_support/deprecation'
+
+module Formtastic
+  if ActiveSupport::Deprecation.respond_to?(:new)
+    Deprecation = ActiveSupport::Deprecation
+  else
+    require 'forwardable'
+
+    # @private
+    # @todo remove this branch and file when support for rails 3.2 is dropped
+    class Deprecation
+      mattr_accessor :deprecation
+      self.deprecation = ActiveSupport::Deprecation.dup
+
+      extend Forwardable
+      methods = deprecation.methods - deprecation.class.methods
+      def_delegators :deprecation, *methods
+
+      def initialize(version, _library)
+        deprecation.silenced = false
+        deprecation.deprecation_horizon = version
+      end
+
+      def deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil)
+        caller_backtrace ||= caller(2)
+
+        deprecated_method_warning(deprecated_method_name, message).tap do |msg|
+          warn(msg, caller_backtrace)
+        end
+      end
+
+      def deprecated_method_warning(method_name, message = nil)
+        warning = "#{method_name} is deprecated and will be removed from Formtastic #{deprecation_horizon}"
+        case message
+          when Symbol then "#{warning} (use #{message} instead)"
+          when String then "#{warning} (#{message})"
+          else warning
+        end
+      end
+    end
+  end
+end