formtastic 3.1.0 → 3.1.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+3.1.1
+
+  * Fixed class custom input & action class loading in test environments
+  * Added documentation of custom input & action class finders
+  * Added a link to documentation & wiki from custom class deprecation warnings
+
 3.1.0
 
   * Performance and documentation improvements

data/README.textile

@@ -98,7 +98,7 @@ Simply add Formtastic to your Gemfile and bundle it up:
 
 Run the installation generator:
 
-<pre>
+<pre lang=shell>
   $ rails generate formtastic:install
 </pre>
 

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'bundler/setup'
 require 'appraisal'
-require 'rdoc/task'
+require 'yard'
 require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
@@ -14,13 +14,10 @@ else
 end
 
 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')
+YARD::Rake::YardocTask.new(:yard) do |t|
+
 end
+task doc: :yard
 
 desc 'Test the formtastic plugin.'
 RSpec::Core::RakeTask.new('spec') do |t|

data/formtastic.gemspec

@@ -27,12 +27,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency(%q<actionpack>, [">= 3.2.13"])
 
-  s.add_development_dependency(%q<nokogiri>) 
+  s.add_development_dependency(%q<nokogiri>)
   s.add_development_dependency(%q<rspec-rails>, ["~> 2.14"])
   s.add_development_dependency(%q<rspec_tag_matchers>, ["~> 1.0"])
   s.add_development_dependency(%q<hpricot>, ["~> 0.8.3"])
-  s.add_development_dependency(%q<BlueCloth>, ["~> 1.0"]) # for YARD
-  s.add_development_dependency(%q<yard>, ["~> 0.6"])
+  s.add_development_dependency(%q<RedCloth>, ["~> 4.2"]) # for YARD Textile formatting
+  s.add_development_dependency(%q<yard>, ["~> 0.8"])
   s.add_development_dependency(%q<colored>, ["~> 1.2"])
   s.add_development_dependency(%q<tzinfo>)
   s.add_development_dependency(%q<ammeter>, ["1.1.1"])

data/lib/formtastic.rb

@@ -26,7 +26,7 @@ module Formtastic
     deprecation.warn("Support for Rails < 4.0.4 will be dropped ")
   end
 
-  # @private
+  # @public
   class UnknownInputError < NameError
   end
 

data/lib/formtastic/action_class_finder.rb

@@ -1,16 +1,16 @@
 module Formtastic
 
-  # Uses the +NamespacedClassFinder+ to look up action class names.
+  # Uses the {NamespacedClassFinder} to look up action class names.
   #
-  # See +Formtastic::Helpers::ActionHelper#namespaced_action_class+ for details.
+  # See {Formtastic::Helpers::ActionHelper#namespaced_action_class} for details.
   #
   class ActionClassFinder < NamespacedClassFinder
+
+    # @param builder [FormBuilder]
     def initialize(builder)
       super builder.action_namespaces
     end
 
-    private
-
     def class_name(as)
       "#{super}Action"
     end

data/lib/formtastic/actions/button_action.rb

@@ -1,59 +1,61 @@
-# 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' } %>
-#
-# @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
+
+  # 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
@@ -62,4 +64,4 @@ module Formtastic
       end
     end
   end
-end
+end

data/lib/formtastic/actions/input_action.rb

@@ -1,63 +1,65 @@
-# 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' } %>
-#
-# @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
+
+  # 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)
@@ -65,4 +67,4 @@ module Formtastic
       end
     end
   end
-end
+end

data/lib/formtastic/actions/link_action.rb

@@ -1,82 +1,83 @@
-# 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' } %>
-#
-# @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
-#
-# @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)
 module Formtastic
   module Actions
-    class LinkAction
-
+  # 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

data/lib/formtastic/deprecation.rb

@@ -1,13 +1,13 @@
 require 'active_support/deprecation'
 
-# TODO: remove this branch and file when support for rails 3.2 is dropped
-
 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

data/lib/formtastic/form_builder.rb

@@ -1,9 +1,18 @@
 module Formtastic
   class FormBuilder < ActionView::Helpers::FormBuilder
 
-    def self.configure(name, value = nil)
+    # Defines a new configurable option
+    # @param [Symbol] name the configuration name
+    # @param [Object] default the configuration default value
+    # @private
+    #
+    # @!macro [new] configure
+    #   @!scope class
+    #   @!attribute [rw] $1
+    #   @api public
+    def self.configure(name, default = nil)
       class_attribute(name)
-      self.send(:"#{name}=", value)
+      self.send(:"#{name}=", default)
     end
 
     configure :custom_namespace
@@ -31,11 +40,15 @@ module Formtastic
     configure :default_hint_class, 'inline-hints'
     configure :use_required_attribute, false
     configure :perform_browser_validations, false
+    # Check {Formtastic::InputClassFinder} to see how are inputs resolved.
     configure :input_namespaces, [::Object, ::Formtastic::Inputs]
-    # TODO: enable this as default in 4.0 and remove it from configuration generator template
+    # @todo enable this as default in 4.0 and remove it from configuration generator template
+    # Will be {Formtastic::InputClassFinder} by default in 4.0.
     configure :input_class_finder #, Formtastic::InputClassFinder
+    # Check {Formtastic::ActionClassFinder} to see how are inputs resolved.
     configure :action_namespaces, [::Object, ::Formtastic::Actions]
-    # TODO: enable this as default in 4.0 and remove it from configuration generator template
+    # @todo enable this as default in 4.0 and remove it from configuration generator template
+    # Will be {Formtastic::ActionClassFinder} by default in 4.0.
     configure :action_class_finder#, Formtastic::ActionClassFinder
 
     attr_reader :template

data/lib/formtastic/helpers/action_helper.rb

@@ -2,7 +2,7 @@
 module Formtastic
   module Helpers
     module ActionHelper
-      ACTION_CLASS_DEPRECATION = 'configure Formtastic::FormBuilder.action_class_finder instead'.freeze
+      ACTION_CLASS_DEPRECATION = 'configure Formtastic::FormBuilder.action_class_finder instead (upgrade guide on wiki: http://bit.ly/1F9QtKc )'.freeze
       private_constant(:ACTION_CLASS_DEPRECATION)
 
       # Renders an action for the form (such as a subit/reset button, or a cancel link).
@@ -89,7 +89,7 @@ module Formtastic
 
       protected
 
-      def default_action_type(method, options = {}) #:nodoc:
+      def default_action_type(method, options = {}) # @private
         case method
           when :submit then :input
           when :reset  then :input
@@ -104,9 +104,9 @@ module Formtastic
       # and modify to suit), falling back to `Formtastic::Actions::AwesomeAction`.
       #
       # Custom action namespaces to look into can be configured via the
-      # .action_namespaces +FormBuilder+ configuration setting.
-      # See +Formtastic::Helpers::InputHelper#namespaced_input_class+ for details.
-      #
+      # {Formtastic::FormBuilder.action_namespaces} configuration setting.
+      # @see Helpers::InputHelper#namespaced_input_class
+      # @see Formtastic::ActionClassFinder
       def namespaced_action_class(as)
         @action_class_finder ||= action_class_finder.new(self)
         @action_class_finder.find(as)

data/lib/formtastic/helpers/fieldset_wrapper.rb

@@ -21,7 +21,7 @@ module Formtastic
       #   f.inputs "My little legend", :title, :body, :author   # Explicit legend string => "My little legend"
       #   f.inputs :my_little_legend, :title, :body, :author    # Localized (118n) legend with I18n key => I18n.t(:my_little_legend, ...)
       #   f.inputs :title, :body, :author                       # First argument is a column => (no legend)
-      def field_set_and_list_wrapping(*args, &block) #:nodoc:
+      def field_set_and_list_wrapping(*args, &block) # @private
         contents = args.last.is_a?(::Hash) ? '' : args.pop.flatten
         html_options = args.extract_options!
 
@@ -54,7 +54,7 @@ module Formtastic
 
       # Gets the nested_child_index value from the parent builder. It returns a hash with each
       # association that the parent builds.
-      def parent_child_index(parent) #:nodoc:
+      def parent_child_index(parent) # @private
         # Could be {"post[authors_attributes]"=>0} or { :authors => 0 }
         duck = parent[:builder].instance_variable_get('@nested_child_index')
         

data/lib/formtastic/helpers/input_helper.rb

@@ -36,7 +36,7 @@ module Formtastic
     # @see Formtastic::Helpers::InputsHelper#inputs
     # @see Formtastic::Helpers::FormHelper#semantic_form_for
     module InputHelper
-      INPUT_CLASS_DEPRECATION = 'configure Formtastic::FormBuilder.input_class_finder instead'.freeze
+      INPUT_CLASS_DEPRECATION = 'configure Formtastic::FormBuilder.input_class_finder instead (upgrade guide on wiki: http://bit.ly/1F9QtKc )'.freeze
       private_constant(:INPUT_CLASS_DEPRECATION)
 
       include Formtastic::Helpers::Reflection
@@ -227,6 +227,7 @@ module Formtastic
       #          first_name: "Joe"
       #          last_name: "Smith"
       #
+      # @see #namespaced_input_class
       # @todo Many many more examples. Some of the detail probably needs to be pushed out to the relevant methods too.
       # @todo More i18n examples.
       def input(method, options = {})
@@ -251,7 +252,7 @@ module Formtastic
       #
       # If there is no column for the method (eg "virtual columns" with an attr_accessor), the
       # default is a :string, a similar behaviour to Rails' scaffolding.
-      def default_input_type(method, options = {}) #:nodoc:
+      def default_input_type(method, options = {}) # @private
         if @object
           return :select  if reflection_for(method)
 
@@ -295,7 +296,7 @@ module Formtastic
       end
 
       # Get a column object for a specified attribute method - if possible.
-      def column_for(method) #:nodoc:
+      def column_for(method) # @private
         if @object.respond_to?(:column_for_attribute)
           # Remove deprecation wrapper & review after Rails 5.0 ships
           ActiveSupport::Deprecation.silence do
@@ -310,7 +311,7 @@ module Formtastic
       # and modify to suit), falling back to `Formtastic::Inputs::AwesomeInput`.
       #
       # Custom input namespaces to look into can be configured via the
-      # .input_namespaces +FormBuilder+ configuration setting.
+      # {Formtastic::FormBuilder.input_namespaces} configuration setting.
       #
       # @param [Symbol] as A symbol representing the type of input to render
       # @raise [Formtastic::UnknownInputError] An appropriate input class could not be found
@@ -323,7 +324,7 @@ module Formtastic
       # @example When a top-level class is found
       #   input_class(:string) #=> StringInput
       #   input_class(:awesome) #=> AwesomeInput
-
+      # @see NamespacedClassFinder#find
       def namespaced_input_class(as)
         @input_class_finder ||= input_class_finder.new(self)
         @input_class_finder.find(as)
@@ -384,7 +385,7 @@ module Formtastic
 
       # @api private
       # @deprecated Use {InputClassFinder#class_name} instead.
-      # :as => :string # => Formtastic::Inputs::StringInput
+      # :as => :string # => {Formtastic::Inputs::StringInput}
       def standard_input_class_name(as)
         input_class_deprecation_warning(__method__)
         "Formtastic::Inputs::#{as.to_s.camelize}Input"

data/lib/formtastic/helpers/inputs_helper.rb

@@ -338,7 +338,7 @@ module Formtastic
       # Collects association columns (relation columns) for the current form object class. Skips
       # polymorphic associations because we can't guess which class to use for an automatically
       # generated input.
-      def association_columns(*by_associations) #:nodoc:
+      def association_columns(*by_associations) # @private
         if @object.present? && @object.class.respond_to?(:reflections)
           @object.class.reflections.collect do |name, association_reflection|
             if by_associations.present?
@@ -355,7 +355,7 @@ module Formtastic
       end
 
       # Collects content columns (non-relation columns) for the current form object class.
-      def content_columns #:nodoc:
+      def content_columns # @private
         # TODO: NameError is raised by Inflector.constantize. Consider checking if it exists instead.
         begin klass = model_name.constantize; rescue NameError; return [] end
         return [] unless klass.respond_to?(:content_columns)
@@ -367,7 +367,7 @@ module Formtastic
       # key.
       #
       # It should raise an error if a block with arity zero is given.
-      def inputs_for_nested_attributes(*args, &block) #:nodoc:
+      def inputs_for_nested_attributes(*args, &block) # @private
         options = args.extract_options!
         args << options.merge!(:parent => { :builder => self, :for => options[:for] })
 
@@ -396,7 +396,7 @@ module Formtastic
         fields_for(*fields_for_args, &fields_for_block)
       end
 
-      def field_set_title_from_args(*args) #:nodoc:
+      def field_set_title_from_args(*args) # @private
         options = args.extract_options!
         options[:name] ||= options.delete(:title)
         title = options[:name]

data/lib/formtastic/helpers/reflection.rb

@@ -4,20 +4,20 @@ module Formtastic
     module Reflection
       # If an association method is passed in (f.input :author) try to find the
       # reflection object.
-      def reflection_for(method) #:nodoc:
+      def reflection_for(method) # @private
         if @object.class.respond_to?(:reflect_on_association)
-          @object.class.reflect_on_association(method) 
+          @object.class.reflect_on_association(method)
         elsif @object.class.respond_to?(:associations) # MongoMapper uses the 'associations(method)' instead
           @object.class.associations[method]
         end
       end
 
-      def association_macro_for_method(method) #:nodoc:
+      def association_macro_for_method(method) # @private
         reflection = reflection_for(method)
         reflection.macro if reflection
       end
 
-      def association_primary_key_for_method(method) #:nodoc:
+      def association_primary_key_for_method(method) # @private
         reflection = reflection_for(method)
         if reflection
           case association_macro_for_method(method)

data/lib/formtastic/input_class_finder.rb

@@ -1,16 +1,16 @@
 module Formtastic
 
-  # Uses the Formtastic::NamespacedClassFinder to look up input class names.
+  # Uses the {Formtastic::NamespacedClassFinder} to look up input class names.
   #
-  # See Formtastic::Helpers::InputHelper#namespaced_input_class for details.
+  # See {Formtastic::FormBuilder#namespaced_input_class} for details.
   #
   class InputClassFinder < NamespacedClassFinder
+
+    # @param builder [FormBuilder]
     def initialize(builder)
       super builder.input_namespaces
     end
 
-    private
-
     def class_name(as)
       "#{super}Input"
     end

data/lib/formtastic/localized_string.rb

@@ -7,7 +7,7 @@ module Formtastic
 
     protected
 
-    def localized_string(key, value, type, options = {}) #:nodoc:
+    def localized_string(key, value, type, options = {}) # @private
       current_builder = respond_to?(:builder) ? builder : self
       localizer = Formtastic::FormBuilder.i18n_localizer.new(current_builder)
       localizer.localize(key, value, type, options)

data/lib/formtastic/localizer.rb

@@ -56,7 +56,7 @@ module Formtastic
       self.builder = current_builder 
     end
 
-    def localize(key, value, type, options = {}) #:nodoc:
+    def localize(key, value, type, options = {}) # @private
       key = value if value.is_a?(::Symbol)
       
       if value.is_a?(::String)
@@ -132,7 +132,7 @@ module Formtastic
       end
     end
 
-    def escape_html_entities(string) #:nodoc:
+    def escape_html_entities(string) # @private
       if (builder.escape_html_entities_in_hints_and_labels) ||
          (self.respond_to?(:escape_html_entities_in_hints_and_labels) && escape_html_entities_in_hints_and_labels)
         string = builder.template.escape_once(string) unless string.respond_to?(:html_safe?) && string.html_safe? == true # Accept html_safe flag as indicator to skip escaping

data/lib/formtastic/namespaced_class_finder.rb

@@ -3,12 +3,11 @@ module Formtastic
   # is used both by Formtastic::Helpers::InputHelper and
   # Formtastic::Helpers::ActionHelper to look up action and input classes.
   #
-  # ==== Example
-  # You can implement own class finder that for example prefixes the class name or uses custom module.
-  #
+  # @example Implementing own class finder
+  #   # You can implement own class finder that for example prefixes the class name or uses custom module.
   #   class MyInputClassFinder < Formtastic::NamespacedClassFinder
-  #     def initialize(builder)
-  #       super [MyNamespace, Object] # first lookup in MyNamespace then the globals
+  #     def initialize(namespaces)
+  #       super [MyNamespace] + namespaces # first lookup in MyNamespace then the defaults
   #     end
   #
   #     private
@@ -18,17 +17,23 @@ module Formtastic
   #     end
   #   end
   #
-  # And then set Formtastic::FormBuilder.input_class_finder with that class.
+  #   # in config/initializers/formtastic.rb
+  #   Formtastic::FormBuilder.input_class_finder = MyInputClassFinder
   #
 
   class NamespacedClassFinder
-    attr_reader :namespaces #:nodoc:
+    attr_reader :namespaces # @private
 
     # @private
     class NotFoundError < NameError
     end
 
-    def initialize(namespaces) #:nodoc:
+    def self.use_const_defined?
+      defined?(Rails) && ::Rails.application && ::Rails.application.config.eager_load
+    end
+
+    # @param namespaces [Array<Module>]
+    def initialize(namespaces)
       @namespaces = namespaces.flatten
       @cache = {}
     end
@@ -50,18 +55,23 @@ module Formtastic
       finder(class_name) or raise NotFoundError, "class #{class_name}"
     end
 
-    private
+    # Converts symbol to class name
+    # Overridden in subclasses to create `StringInput` and `ButtonAction`
+    # @example
+    #   class_name(:string) == "String"
 
     def class_name(as)
       as.to_s.camelize
     end
 
-    if defined?(Rails) && ::Rails.application && ::Rails.application.config.cache_classes
-      def finder(class_name) # :nodoc:
+    private
+
+    if use_const_defined?
+      def finder(class_name) # @private
         find_with_const_defined(class_name)
       end
     else
-      def finder(class_name) # :nodoc:
+      def finder(class_name) # @private
         find_by_trying(class_name)
       end
     end

data/lib/formtastic/version.rb

@@ -1,3 +1,3 @@
 module Formtastic
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

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

@@ -4,15 +4,20 @@ module Formtastic
   # files without confirmation.
   #
   # @example
+  # !!!shell
   #   $ rails generate formtastic:form Post
   # @example Copy the partial code to the pasteboard rather than generating a partial
+  # !!!shell
   #   $ rails generate formtastic:form Post --copy
   # @example Return HAML or Slim output instead of default ERB
+  # !!!shell
   #   $ rails generate formtastic:form Post --template-engine haml
   #   $ rails generate formtastic:form Post --template-engine slim
   # @example Generate a form for specific model attributes
+  # !!!shell
   #   $ rails generate formtastic:form Post title:string body:text
   # @example Generate a form for a specific controller
+  # !!!shell
   #   $ rails generate formtastic:form Post --controller admin/posts
   class FormGenerator < Rails::Generators::NamedBase
     desc "Generates a Formtastic form partial based on an existing model."
@@ -103,4 +108,4 @@ module Formtastic
     end
 
   end
-end
+end

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

@@ -4,6 +4,7 @@ module Formtastic
   # Copies a config initializer to config/initializers/formtastic.rb
   #
   # @example
+  # !!!shell
   #   $ rails generate formtastic:install
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../../../templates', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formtastic
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -92,13 +92,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.3
 - !ruby/object:Gem::Dependency
-  name: BlueCloth
+  name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement