formtastic 3.1.2 → 4.0.0

data/lib/formtastic/inputs/base/database.rb

@@ -4,7 +4,12 @@ module Formtastic
       module Database
         
         def column
-          object.column_for_attribute(method) if object.respond_to?(:column_for_attribute)
+          if object.respond_to?(:column_for_attribute)
+            # Remove deprecation wrapper & review after Rails 5.0 ships
+            ActiveSupport::Deprecation.silence do
+              object.column_for_attribute(method)
+            end
+          end
         end
         
         def column?
@@ -14,4 +19,4 @@ module Formtastic
       end
     end
   end
-end
+end

data/lib/formtastic/inputs/base/errors.rb

@@ -9,21 +9,21 @@ module Formtastic
         
         def error_sentence_html
           error_class = builder.default_inline_error_class
-          template.content_tag(:p, Formtastic::Util.html_safe(errors.to_sentence.html_safe), :class => error_class)
+          template.content_tag(:p, errors.to_sentence, :class => error_class)
         end
                 
         def error_list_html
           error_class = builder.default_error_list_class
           list_elements = []
           errors.each do |error|
-            list_elements << template.content_tag(:li, Formtastic::Util.html_safe(error.html_safe))
+            list_elements << template.content_tag(:li, error.html_safe)
           end
-          template.content_tag(:ul, Formtastic::Util.html_safe(list_elements.join("\n")), :class => error_class)
+          template.content_tag(:ul, list_elements.join("\n").html_safe, :class => error_class)
         end
         
         def error_first_html
           error_class = builder.default_inline_error_class
-          template.content_tag(:p, Formtastic::Util.html_safe(errors.first.untaint), :class => error_class)
+          template.content_tag(:p, errors.first.untaint.html_safe, :class => error_class)
         end
         
         def error_none_html

data/lib/formtastic/inputs/base/hints.rb

@@ -7,7 +7,7 @@ module Formtastic
           if hint?
             template.content_tag(
               :p, 
-              Formtastic::Util.html_safe(hint_text), 
+              hint_text.html_safe, 
               :class => builder.default_hint_class
             )
           end

data/lib/formtastic/inputs/base/html.rb

@@ -2,7 +2,7 @@ module Formtastic
   module Inputs
     module Base
       module Html
-        
+
         # Defines how the instance of an input should be rendered to a HTML string.
         #
         # @abstract Implement this method in your input class to describe how the input should render itself.
@@ -17,15 +17,16 @@ module Formtastic
         def to_html
           raise NotImplementedError
         end
-        
+
         def input_html_options
-          { 
+          {
             :id => dom_id,
             :required => required_attribute?,
-            :autofocus => autofocus?
+            :autofocus => autofocus?,
+            :readonly => readonly?
           }.merge(options[:input_html] || {})
         end
-        
+
         def dom_id
           [
             builder.dom_id_namespace,
@@ -34,7 +35,7 @@ module Formtastic
             association_primary_key || sanitized_method_name
           ].reject { |x| x.blank? }.join('_')
         end
-        
+
         def dom_index
           if builder.options.has_key?(:index)
             builder.options[:index]

data/lib/formtastic/inputs/base/naming.rb

@@ -4,9 +4,9 @@ module Formtastic
       module Naming
 
         def as
-          self.class.name.split("::").last.underscore.gsub(/_input$/, '')
+          self.class.name.split("::")[-1].underscore.gsub(/_input$/, '')
         end
-        
+
         def sanitized_object_name
           object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
         end
@@ -18,7 +18,7 @@ module Formtastic
         def attributized_method_name
           method.to_s.gsub(/_id$/, '').to_sym
         end
-        
+
         def humanized_method_name
           if builder.label_str_method != :humanize
             # Special case where label_str_method should trump the human_attribute_name
@@ -39,4 +39,4 @@ module Formtastic
       end
     end
   end
-end
+end

data/lib/formtastic/inputs/base/options.rb

@@ -2,15 +2,14 @@ module Formtastic
   module Inputs
     module Base
       module Options
-        
+
         def input_options
           options.except(*formtastic_options)
         end
-        
+
         def formtastic_options
           [:priority_countries, :priority_zones, :member_label, :member_value, :collection, :required, :label, :as, :hint, :input_html, :value_as_class, :class]
         end
-      
       end
     end
   end

data/lib/formtastic/inputs/base/timeish.rb

@@ -85,6 +85,9 @@ module Formtastic
       #   <%= f.input :publish_at, :as => :time_select, :include_blank => true %>
       #   <%= f.input :publish_at, :as => :time_select, :include_blank => false %>
       #
+      # @example Provide a value for the field via selected
+      #   <%= f.input :publish_at, :as => :datetime_select, :selected => DateTime.new(2018, 10, 4, 12, 00)
+      #
       # @todo Document i18n
       # @todo Check what other Rails options are supported (`start_year`, `end_year`, `use_month_numbers`, `use_short_month`, `add_month_numbers`, `prompt`), write tests for them, and otherwise support them
       # @todo Could we take the rendering from Rails' helpers and inject better HTML in and around it rather than re-inventing the whee?
@@ -157,6 +160,7 @@ module Formtastic
         end
         
         def value
+          return input_options[:selected] if options.key?(:selected)
           object.send(method) if object && object.respond_to?(method)
         end
         
@@ -238,4 +242,4 @@ module Formtastic
       end
     end
   end
-end
+end

data/lib/formtastic/inputs/base/validations.rb

@@ -73,13 +73,11 @@ module Formtastic
             raise IndeterminableMinimumAttributeError if validation.options[:greater_than] && column? && [:float, :decimal].include?(column.type)
 
             if validation.options[:greater_than_or_equal_to]
-              return (validation.options[:greater_than_or_equal_to].call(object)) if validation.options[:greater_than_or_equal_to].kind_of?(Proc)
-              return (validation.options[:greater_than_or_equal_to])
+              return option_value(validation.options[:greater_than_or_equal_to], object)
             end
 
             if validation.options[:greater_than]
-              return (validation.options[:greater_than].call(object) + 1) if validation.options[:greater_than].kind_of?(Proc)
-              return (validation.options[:greater_than] + 1)
+              return option_value(validation.options[:greater_than], object) + 1
             end
           end
         end
@@ -94,13 +92,11 @@ module Formtastic
             raise IndeterminableMaximumAttributeError if validation.options[:less_than] && column? && [:float, :decimal].include?(column.type)
 
             if validation.options[:less_than_or_equal_to]
-              return (validation.options[:less_than_or_equal_to].call(object)) if validation.options[:less_than_or_equal_to].kind_of?(Proc)
-              return (validation.options[:less_than_or_equal_to])
+              return option_value(validation.options[:less_than_or_equal_to], object)
             end
 
             if validation.options[:less_than]
-              return ((validation.options[:less_than].call(object)) - 1) if validation.options[:less_than].kind_of?(Proc)
-              return (validation.options[:less_than] - 1)
+              return option_value(validation.options[:less_than], object) - 1
             end
           end
         end
@@ -136,9 +132,10 @@ module Formtastic
           return true if options[:required] == true
           return false if not_required_through_negated_validation?
           if validations?
-            validations.select { |validator|
+            validations.any? { |validator|
               if validator.options.key?(:on)
-                return false if (validator.options[:on] != :save) && ((object.new_record? && validator.options[:on] != :create) || (!object.new_record? && validator.options[:on] != :update))
+                validator_on = Array(validator.options[:on])
+                next false if (validator_on.exclude?(:save)) && ((object.new_record? && validator_on.exclude?(:create)) || (!object.new_record? && validator_on.exclude?(:update)))
               end
               case validator.kind
               when :presence
@@ -152,7 +149,7 @@ module Formtastic
               else
                 false
               end
-            }.any?
+            }
           else
             return responds_to_global_required? && !!builder.all_fields_required_by_default
           end
@@ -192,8 +189,37 @@ module Formtastic
           validation_limit || column_limit
         end
 
+        def readonly?
+          readonly_from_options? || readonly_attribute?
+        end
+
+        def readonly_attribute?
+          object_class = self.object.class
+          object_class.respond_to?(:readonly_attributes) &&
+            self.object.persisted? &&
+            column.respond_to?(:name) &&
+            object_class.readonly_attributes.include?(column.name.to_s)
+        end
+
+        def readonly_from_options?
+          options[:input_html] && options[:input_html][:readonly]
+        end
+
+        private
+
+        # Loosely based on
+        # https://github.com/rails/rails/blob/5-2-stable/activemodel/lib/active_model/validations/numericality.rb#L54-L59
+        def option_value(option, object)
+          case option
+          when Symbol
+            object.send(option)
+          when Proc
+            option.call(object)
+          else
+            option
+          end
+        end
       end
     end
   end
 end
-

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -69,6 +69,11 @@ module Formtastic
       include Base::Collections
       include Base::Choices
 
+      def initialize(*args)
+        super
+        raise Formtastic::UnsupportedEnumCollection if collection_from_enum?
+      end
+
       def to_html
         input_wrapping do
           choices_wrapping do
@@ -94,7 +99,7 @@ module Formtastic
       end
 
       def hidden_field_for_all
-        if hidden_fields?
+        if hidden_fields_for_every?
           ''
         else
           options = {}
@@ -104,7 +109,7 @@ module Formtastic
         end
       end
 
-      def hidden_fields?
+      def hidden_fields_for_every?
         options[:hidden_fields]
       end
 
@@ -165,7 +170,7 @@ module Formtastic
       protected
 
       def checkbox_input(choice)
-        if hidden_fields?
+        if hidden_fields_for_every?
           check_box_with_hidden_input(choice)
         else
           check_box_without_hidden_input(choice)
@@ -175,11 +180,14 @@ module Formtastic
       def make_selected_values
         if object.respond_to?(method)
           selected_items = object.send(method)
-
           # Construct an array from the return value, regardless of the return type
           selected_items = [*selected_items].compact.flatten
 
-          [*selected_items.map { |o| send_or_call_or_object(value_method, o) }].compact
+          selected = []
+          selected_items.map do |selected_item|
+            selected_item_id = selected_item.id if selected_item.respond_to? :id
+            item = send_or_call_or_object(value_method, selected_item) || selected_item_id
+          end.compact
         else
           []
         end

data/lib/formtastic/inputs/color_input.rb

@@ -31,7 +31,6 @@ module Formtastic
       include Base::Placeholder
       
       def to_html
-        raise "The :color input requires the color_field form helper, which is only available in Rails 4+" unless builder.respond_to?(:color_field)
         input_wrapping do
           label_html <<
           builder.color_field(method, input_html_options)

data/lib/formtastic/inputs/country_input.rb

@@ -67,8 +67,10 @@ module Formtastic
     class CountryInput 
       include Base
 
+      CountrySelectPluginMissing = Class.new(StandardError)
+
       def to_html
-        raise "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
+        raise CountrySelectPluginMissing, "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
         input_wrapping do
           label_html <<
           builder.country_select(method, priority_countries, input_options, input_html_options)

data/lib/formtastic/inputs/radio_input.rb

@@ -31,6 +31,10 @@ module Formtastic
     # `Section.all` for a `Post` form with an input for a `belongs_to :section` association.
     # You can override or customise this collection through the `:collection` option (see examples).
     #
+    # For radio inputs that map to ActiveRecord `enum` attributes, Formtastic will automatically
+    # load in your enum options to be used as the radio button choices. This can be overridden with
+    # the `:collection` option, or augmented with I18n translations. See examples below.
+    #
     # The way on which Formtastic renders the `value` attribute and label for each choice in the `:collection` is
     # customisable (see examples below). When not provided, we fall back to a list of methods to try on each 
     # object such as `:to_label`, `:name` and `:to_s`, which are defined in the configurations
@@ -100,6 +104,22 @@ module Formtastic
     # @example Set HTML options on a specific radio input option with a 3rd element in the array for a collection member
     #   <%= f.input :author, :as => :radio, :collection => [["Test", 'test'], ["Try", "try", {:disabled => true}]]
     #
+    # @example Using ActiveRecord enum attribute with i18n translation:
+    #   # post.rb
+    #   class Post < ActiveRecord::Base
+    #     enum :status => [ :active, :archived ]
+    #   end
+    #   # en.yml
+    #   en:
+    #     activerecord:
+    #       attributes:
+    #         post:
+    #           statuses:
+    #             active: I am active!
+    #             archived: I am archived!
+    #   # form
+    #   <%= f.input :status, :as => :radio %>
+    #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     # @see Formtastic::Inputs::RadioInput as an alternative for `belongs_to` associations
     #

data/lib/formtastic/inputs/select_input.rb

@@ -8,6 +8,7 @@ module Formtastic
     # This is the default input choice when:
     #
     # * the database column type is an `:integer` and there is an association (`belongs_to`)
+    # * the database column type is an `:integer` and there is an enum defined (`enum`)
     # * the database column type is a `:string` and the `:collection` option is used
     # * there an object with an association, but no database column on the object (`has_many`, etc)
     # * there is no object and the `:collection` option is used
@@ -38,6 +39,13 @@ module Formtastic
     # `:to_s`, which are defined in the configurations `collection_label_methods` and
     # `collection_value_methods` (see examples below).
     #
+    # For select inputs that map to ActiveRecord `enum` attributes, Formtastic will automatically
+    # load in your enum options to be used as the select's options. This can be overridden with
+    # the `:collection` option, or augmented with I18n translations. See examples below.
+    # An error is raised if you try to render a multi-select with an enum, as ActiveRecord can
+    # only store one choice in the database.
+    #
+    #
     # @example Basic `belongs_to` example with full form context
     #
     #     <%= semantic_form_for @post do |f| %>
@@ -124,6 +132,21 @@ module Formtastic
     #   <%= f.input :author, :as => :select, :prompt => true %>   =>   <option value="">Please select</option>
     #   <%= f.input :author, :as => :select, :prompt => "Please select an author" %>
     #
+    # @example Using ActiveRecord enum attribute with i18n translation:
+    #   # post.rb
+    #   class Post < ActiveRecord::Base
+    #     enum :status => [ :active, :archived ]
+    #   end
+    #   # en.yml
+    #   en:
+    #     activerecord:
+    #       attributes:
+    #         post:
+    #           statuses:
+    #             active: I am active!
+    #             archived: I am archived!
+    #   # form
+    #   <%= f.input :status, :as => :select %>
     #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     # @see Formtastic::Inputs::CheckBoxesInput CheckBoxesInput as an alternative for `has_many` and `has_and_belongs_to_many` associations
@@ -134,6 +157,11 @@ module Formtastic
       include Base
       include Base::Collections
 
+      def initialize(*args)
+        super
+        raise Formtastic::UnsupportedEnumCollection if collection_from_enum? && multiple?
+      end
+
       def to_html
         input_wrapping do
           label_html <<
@@ -168,7 +196,7 @@ module Formtastic
       def extra_input_html_options
         {
           :multiple => multiple?,
-          :name => (multiple? && Rails::VERSION::MAJOR >= 3) ? input_html_options_name_multiple : input_html_options_name
+          :name => multiple? ? input_html_options_name_multiple : input_html_options_name
         }
         
         

data/lib/formtastic/inputs/time_zone_input.rb

@@ -28,9 +28,19 @@ module Formtastic
     #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     #
-    # @todo document :priority_zones option
-    # @todo configurable default :priority_zones?
-    class TimeZoneInput 
+    # The priority_zones option:
+    #   Since this input actually uses Rails' `time_zone_select` helper, the :priority_zones
+    #   option needs to be an array of ActiveSupport::TimeZone objects.
+    #
+    #   And you can configure default value using
+    #
+    #   ```
+    #     Formtastic::FormBuilder.priority_time_zones = [timezone1, timezone2]
+    #   ```
+    #
+    #   See http://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/time_zone_select for more information.
+    #
+    class TimeZoneInput
       include Base
 
       def to_html
@@ -39,10 +49,10 @@ module Formtastic
           builder.time_zone_select(method, priority_zones, input_options, input_html_options)
         end
       end
-      
+
       def priority_zones
-        options[:priority_zones] || [] # TODO config?
+        options[:priority_zones] || Formtastic::FormBuilder.priority_time_zones
       end
     end
   end
-end
+end