formtastic 3.0.0 → 3.1.0.rc1

data/.travis.yml

@@ -11,6 +11,7 @@ gemfile:
   - gemfiles/rails_4.gemfile
   - gemfiles/rails_4.0.4.gemfile
   - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_edge.gemfile
 env:
   - DEFER_GC=false RAILS_EDGE=true

data/Appraisals

@@ -15,6 +15,10 @@ appraise 'rails-4.1' do
   gem 'rails', '~>4.1.0'
 end
 
+appraise 'rails-4.2' do
+  gem 'rails', '~>4.2.0.beta4'
+end
+
 if ENV["RAILS_EDGE"] == "true"
   appraise 'rails-edge' do
     gem 'rails', :git => 'git://github.com/rails/rails.git'

data/CHANGELOG

@@ -1,27 +1,17 @@
-3.0.0
+3.1.0.rc1 (unreleased)
 
-* No changes since 3.0.0.rc2
+* Deprecated support for Rails version < 4.1.0
+* Fixed synchronization issues with custom_namespace configuration
+* Fixed bug where boolean (checkbox) inputs were not being correctly checked (also in 2.3.1)
+* Fixed (silenced) Rails 5 deprecation on column_for_attribute that we're handling fine
+* Added new DatalistInput (:as => :datalist) for HTML5 datalists
+* Added configurable namespaces for custom inputs
+* Various performance and documentation improvements
 
-3.0.0.rc2
+---
 
-* Fixed bug where boolean (checkbox) inputs were not being correctly checked
+See 3.0-stable branch for 3.0.x changes
+https://github.com/justinfrench/formtastic/blob/3.0-stable/CHANGELOG
 
-
-3.0.0.rc
-
-* Removed support for Ruby version < 1.9.3
-* Removed support for Rails version < 3.2.13
-* Removed deprecated option :input_html => { :value => '...'} (#1025)
-* Removed deprecated option :hint_class (#1025)
-* Removed deprecated option :error_class (#1025)
-* Removed deprecated option :group_by (#1025)
-* Removed deprecated option :group_label (#1025)
-* Removed deprecated option :find_options (#1025)
-* Deprecated support for Rails < 4.0.4
-* Changed i18n lookups to use the `:as` option from the form builder (#1033)
-* Improved documentation for country_select gem compatibility & support (#1061)
-* Improved documentation for browser support of datetime and datetime-local (#1029)
-* Added support for ColorInput (:as => :color) in Rails 4 (#1039)
-
-See 2.3-stable branch for earlier releases
+See 2.3-stable branch for 2.3.x and earlier releases
 https://github.com/justinfrench/formtastic/blob/2.3-stable/CHANGELOG

data/DEPRECATIONS

@@ -0,0 +1,47 @@
+This document is for tracking deprecations and removals of 
+Formtastic features and compatibilities.
+
+v4.0 (planned)
+
+* Remove support for Rails < 4.1
+* Remove support for country_select 1.x syntax (they want to remove it in 3.0)
+
+v3.1 (master)
+
+* Deprecate support for Rails < 4.1
+
+v3.0
+
+* Remove support for Ruby version < 1.9.3
+* Remove support for Rails version < 3.2.13
+* Remove deprecated option :value (#1025)
+* Remove deprecated option :hint_class (#1025)
+* Remove deprecated option :error_class (#1025)
+* Remove deprecated option :group_by (#1025)
+* Remove deprecated option :group_label (#1025)
+* Remove deprecated option :find_options (#1025)
+* Deprecate support for Rails < 4.0.4
+
+v2.3
+
+* Remove deprecated date, time and datetime inputs
+* Deprecate :error_class option
+* Deprecate support for Rails < 3.2.13
+
+v2.2
+
+* Remove deprecated buttons DSL, ButtonHelper and commit_button helper
+* Deprecate :value option
+* Deprecate :hint_class option
+* Deprecate :error_class option
+* Deprecate :group_by and :group_label options
+* Deprecate :find_options option
+
+v2.1
+
+* Remove the previously deprecated :label_method, :value_method & :group_label_method options
+* Remove the previously deprecated :as => :numeric
+* Remove the previously deprecated inline_errors_for and related methods
+* Remove the previously deprecated SemanticFormHelper and SemanticFormBuilder
+* Deprecate the Buttons DSL (f.buttons, f.commit_button) in favor of the new Actions DSL — see above
+

data/README.textile

@@ -20,9 +20,10 @@ h2. Documentation & Support
 
 h2. Compatibility
 
-* Formtastic 3 (master on Github) will require Rails 3.2.13 minimum
-* Formtastic 2.3 is Rails 3 and Rails 4 compatible (Rails < 3.2.13 is deprecated)
-* Formtastic 2.1 & 2.2 is Rails 3 and Rails 4 compatible
+* Formtastic 3.1 (master branch) will require Rails 4.1 minimum
+* Formtastic 3.0 requires Rails 3.2.13 minimum
+* Formtastic 2.3 deprecated Rails < 3.2.13
+* Formtastic 2.1, 2.2 & 2.3 are Rails 3.x–4.1.x compatible
 * Formtastic, much like Rails, is very ActiveRecord-centric. Many are successfully using other ActiveModel-like ORMs and objects (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing full compatibility at this stage. Patches are welcome!
 
 
@@ -93,7 +94,7 @@ h2. Installation
 Simply add Formtastic to your Gemfile and bundle it up:
 
 <pre>
-  gem 'formtastic'
+  gem 'formtastic', '~> 3.0'
 </pre>
 
 Run the installation generator:
@@ -315,6 +316,7 @@ Many inputs provide a collection of options to choose from (like @:select@, @:ra
   f.input :author,  :as => :radio,       :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
   f.input :admin,   :as => :radio,       :collection => ["Yes!", "No"]
   f.input :book_id, :as => :select,      :collection => Hash[Book.all.map{|b| [b.name,b.id]}]
+  f.input :fav_book,:as => :datalist   , :collection => Book.pluck(:name)
 </pre>
 
 
@@ -342,6 +344,7 @@ The Formtastic input types:
 * @:search@ - a text field (just like string). Default for columns with name matching @"search"@. New in HTML5. Works on Safari.
 * @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
 * @:range@ - a slider field.
+* @:datalist@ - a text field with a accompanying "datalist tag":https://developer.mozilla.org/en/docs/Web/HTML/Element/datalist which provides options for autocompletion
 
 The comments in the code are pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
 
@@ -516,6 +519,8 @@ For more flexible forms; Formtastic finds translations using a bottom-up approac
 
 Values for @labels@/@hints@/@actions@ are can take values: @String@ (explicit value), @Symbol@ (i18n-lookup-key relative to the current "type", e.g. actions:), @true@ (force I18n lookup), @false@ (force no I18n lookup). Titles (legends) can only take: @String@ and @Symbol@ - true/false have no meaning.
 
+*7. Basic Translations*
+If you want some basic translations, take a look on the "formtastic_i18n gem":https://github.com/timoschilling/formtastic_i18n.
 
 h2. Semantic errors
 

data/formtastic.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency(%q<actionpack>, [">= 3.2.13"])
 
-  s.add_development_dependency(%q<nokogiri>, ["< 1.6.0"]) # 1.6 requires Ruby 1.9.2, drop in v3.0
+  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"])
@@ -35,8 +35,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<yard>, ["~> 0.6"])
   s.add_development_dependency(%q<colored>, ["~> 1.2"])
   s.add_development_dependency(%q<tzinfo>)
-  s.add_development_dependency(%q<ammeter>, ["0.2.5"])
+  s.add_development_dependency(%q<ammeter>, ["1.1.1"])
   s.add_development_dependency(%q<appraisal>, ["~> 1.0"])
-  s.add_development_dependency(%q<rake>, ["<= 10.1.1"]) # Anything higher requires Ruby 1.9, drop in v3.0
+  s.add_development_dependency(%q<rake>)
   s.add_development_dependency(%q<activemodel>, [">= 3.2.13"])
 end

data/gemfiles/rails_4.2.gemfile

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

data/lib/formtastic.rb

@@ -13,25 +13,31 @@ module Formtastic
   autoload :LocalizedString
   autoload :Localizer
   autoload :Util
-  
+  autoload :NamespacedClassFinder
+  autoload :InputClassFinder
+  autoload :ActionClassFinder
+  autoload :Deprecation
+
+  # @private
+  mattr_accessor :deprecation
+  self.deprecation = Formtastic::Deprecation.new('4.0', 'Formtastic')
+
   if defined?(::Rails) && Util.deprecated_version_of_rails?
-    ::ActiveSupport::Deprecation.warn(
-      "Support for Rails < 4.0.4 will be dropped from Formtastic 4.0",
-      caller)
+    deprecation.warn("Support for Rails < 4.0.4 will be dropped ")
   end
 
   # @private
   class UnknownInputError < NameError
   end
-  
+
   # @private
   class UnknownActionError < NameError
   end
-  
+
   # @private
   class PolymorphicInputWithoutCollectionError < ArgumentError
   end
-  
+
   # @private
   class UnsupportedMethodForAction < ArgumentError
   end

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
+    def initialize(builder)
+      super builder.action_namespaces
+    end
+
+    private
+
+    def class_name(as)
+      "#{super}Action"
+    end
+  end
+end

data/lib/formtastic/deprecation.rb

@@ -0,0 +1,42 @@
+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'
+
+    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

data/lib/formtastic/form_builder.rb

@@ -31,6 +31,12 @@ module Formtastic
     configure :default_hint_class, 'inline-hints'
     configure :use_required_attribute, false
     configure :perform_browser_validations, false
+    configure :input_namespaces, [::Object, ::Formtastic::Inputs]
+    # TODO: enable this as default in 4.0 and remove it from configuration generator template
+    configure :input_class_finder #, Formtastic::InputClassFinder
+    configure :action_namespaces, [::Object, ::Formtastic::Actions]
+    # TODO: enable this as default in 4.0 and remove it from configuration generator template
+    configure :action_class_finder#, Formtastic::ActionClassFinder
 
     attr_reader :template
 
@@ -43,8 +49,8 @@ module Formtastic
     include Formtastic::Helpers::ActionHelper
     include Formtastic::Helpers::ActionsHelper
     include Formtastic::Helpers::ErrorsHelper
-    
-    # This is a wrapper around Rails' `ActionView::Helpers::FormBuilder#fields_for`, originally 
+
+    # This is a wrapper around Rails' `ActionView::Helpers::FormBuilder#fields_for`, originally
     # provided to ensure that the `:builder` from `semantic_form_for` was passed down into
     # the nested `fields_for`. Rails 3 no longer requires us to do this, so this method is
     # provided purely for backwards compatibility and DSL consistency.
@@ -76,11 +82,11 @@ module Formtastic
       # Add a :parent_builder to the args so that nested translations can be possible in Rails 3
       options = args.extract_options!
       options[:parent_builder] ||= self
-      
+
       # Wrap the Rails helper
       fields_for(record_or_name_or_array, *(args << options), &block)
     end
-    
+
     def initialize(object_name, object, template, options, block=nil)
       # rails 3 supported passing in the block parameter to FormBuilder
       # rails 4.0 deprecated the block parameter and does nothing with it
@@ -90,12 +96,12 @@ module Formtastic
       else # Must be rails4_1 or greater
         super object_name, object, template, options
       end
-      
+
       if respond_to?('multipart=') && options.is_a?(Hash) && options[:html]
         self.multipart = options[:html][:multipart]
       end
     end
-    
+
   end
 
 end

data/lib/formtastic/helpers/action_helper.rb

@@ -2,7 +2,9 @@
 module Formtastic
   module Helpers
     module ActionHelper
-      
+      ACTION_CLASS_DEPRECATION = 'configure Formtastic::FormBuilder.action_class_finder instead'.freeze
+      private_constant(:ACTION_CLASS_DEPRECATION)
+
       # Renders an action for the form (such as a subit/reset button, or a cancel link).
       #
       # Each action is wrapped in an `<li class="action">` tag with other classes added based on the
@@ -23,9 +25,9 @@ module Formtastic
       #         reset: "Reset form"
       #         submit: "Submit"
       #
-      # For forms with an object present, the `update` key will be used if calling `persisted?` on 
-      # the object returns true (saving changes to a record), otherwise the `create` ey will be 
-      # used. The `submit` key is used as a fallback when there is no object or we cannot determine 
+      # For forms with an object present, the `update` key will be used if calling `persisted?` on
+      # the object returns true (saving changes to a record), otherwise the `create` key will be
+      # used. The `submit` key is used as a fallback when there is no object or we cannot determine
       # if `create` or `update` is appropriate.
       #
       # @example Basic usage
@@ -90,12 +92,35 @@ module Formtastic
       def default_action_type(method, options = {}) #:nodoc:
         case method
           when :submit then :input
-          when :reset then :input
+          when :reset  then :input
           when :cancel then :link
+          else method
         end
       end
 
+      # Takes the `:as` option and attempts to return the corresponding action
+      # class. In the case of `:as => :awesome` it will first attempt to find a
+      # top level `AwesomeAction` class (to allow the application to subclass
+      # 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.
+      #
+      def namespaced_action_class(as)
+        @action_class_finder ||= action_class_finder.new(self)
+        @action_class_finder.find(as)
+      rescue Formtastic::ActionClassFinder::NotFoundError => e
+        raise Formtastic::UnknownActionError, "Unable to find action #{e.message}"
+      end
+
+      # @api private
+      # @deprecated Use {#namespaced_action_class} instead.
       def action_class(as)
+        return namespaced_action_class(as) if action_class_finder
+
+        action_class_deprecation_warning(__method__)
+
         @input_classes_cache ||= {}
         @input_classes_cache[as] ||= begin
           begin
@@ -105,21 +130,33 @@ module Formtastic
               standard_action_class_name(as).constantize
             end
           rescue NameError
-            raise Formtastic::UnknownActionError
+            raise Formtastic::UnknownActionError, "Unable to find action #{as}"
           end
         end
       end
 
+      # @api private
+      # @deprecated Use {Formtastic::ActionClassFinder#class_name} instead.
       # :as => :button # => ButtonAction
       def custom_action_class_name(as)
+        action_class_deprecation_warning(__method__)
         "#{as.to_s.camelize}Action"
       end
 
+      # @api private
+      # @deprecated Use {Formtastic::ActionClassFinder#class_name} instead.
       # :as => :button # => Formtastic::Actions::ButtonAction
       def standard_action_class_name(as)
+        action_class_deprecation_warning(__method__)
         "Formtastic::Actions::#{as.to_s.camelize}Action"
       end
 
+      private
+
+      def action_class_deprecation_warning(method)
+        @action_class_deprecation_warned ||=
+            Formtastic.deprecation.deprecation_warning(method, ACTION_CLASS_DEPRECATION, caller(2))
+      end
     end
   end
 end

data/lib/formtastic/helpers/form_helper.rb

@@ -155,7 +155,7 @@ module Formtastic
         options[:builder] ||= @@builder
         options[:html] ||= {}
         options[:html][:novalidate] = !@@builder.perform_browser_validations unless options[:html].key?(:novalidate)
-        @@builder.custom_namespace = options.delete(:namespace).to_s
+        options[:custom_namespace] = options.delete(:namespace)
 
         singularizer = defined?(ActiveModel::Naming.singular) ? ActiveModel::Naming.method(:singular) : ActionController::RecordIdentifier.method(:singular_class_name)
 
@@ -182,7 +182,7 @@ module Formtastic
       def semantic_fields_for(record_name, record_object = nil, options = {}, &block)
         options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
         options[:builder] ||= @@builder
-        @@builder.custom_namespace = options.delete(:namespace).to_s # TODO needed?
+        options[:custom_namespace] = options.delete(:namespace)
 
         with_custom_field_error_proc do
           self.fields_for(record_name, record_object, options, &block)