formtastic 3.0.0 → 5.0.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     module Base
@@ -85,6 +86,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?
@@ -153,10 +157,11 @@ module Formtastic
         
         def fragment_label_html(fragment)
           text = fragment_label(fragment)
-          text.blank? ? "".html_safe : template.content_tag(:label, text, :for => fragment_id(fragment))
+          text.blank? ? +"".html_safe : template.content_tag(:label, text, :for => fragment_id(fragment))
         end
         
         def value
+          return input_options[:selected] if options.key?(:selected)
           object.send(method) if object && object.respond_to?(method)
         end
         
@@ -213,7 +218,7 @@ module Formtastic
               :class => "label"
             )
           else
-            "".html_safe
+            +"".html_safe
           end
         end
         
@@ -224,7 +229,7 @@ module Formtastic
         end
         
         def hidden_fragments
-          "".html_safe
+          +"".html_safe
         end
         
         def hidden_field_name(fragment)
@@ -238,4 +243,4 @@ module Formtastic
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     module Base
@@ -73,13 +74,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 +93,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 +133,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 +150,7 @@ module Formtastic
               else
                 false
               end
-            }.any?
+            }
           else
             return responds_to_global_required? && !!builder.all_fields_required_by_default
           end
@@ -192,8 +190,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/459e7cf62252558bbf65f582a230562ab1a76c5e/activemodel/lib/active_model/validations/numericality.rb#L65-L70
+        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/base/wrapping.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     module Base
@@ -25,9 +26,7 @@ module Formtastic
         end
 
         def wrapper_classes_raw
-          classes = wrapper_html_options_raw[:class] || []
-          return classes.dup if classes.is_a?(Array)
-          return [classes]
+          [*wrapper_html_options_raw[:class]]
         end
 
         def wrapper_classes

data/lib/formtastic/inputs/base.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     module Base
-      
+
       attr_accessor :builder, :template, :object, :object_name, :method, :options
-      
+
       def initialize(builder, template, object, object_name, method, options)
         @builder = builder
         @template = template
@@ -11,30 +12,35 @@ module Formtastic
         @object_name = object_name
         @method = method
         @options = options.dup
+
+        # Deprecate :member_label and :member_value, remove v4.0
+        member_deprecation_message = "passing an Array of label/value pairs like [['Justin', 2], ['Kate', 3]] into :collection directly (consider building the array in your model using Model.pluck)"
+        warn_deprecated_option!(:member_label, member_deprecation_message)
+        warn_deprecated_option!(:member_value, member_deprecation_message)
       end
-      
+
       # Usefull for deprecating options.
       def warn_and_correct_option!(old_option_name, new_option_name)
         if options.key?(old_option_name)
-          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic in the next version")
+          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic in the next version", caller(6))
           options[new_option_name] = options.delete(old_option_name)
         end
       end
-      
+
       # Usefull for deprecating options.
       def warn_deprecated_option!(old_option_name, instructions)
         if options.key?(old_option_name)
-          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}` and will be removed in the next version")
+          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}`. :#{old_option_name} will be removed in the next version", caller(6))
         end
       end
-      
+
       # Usefull for raising an error on previously supported option.
       def removed_option!(old_option_name)
         raise ArgumentError, ":#{old_option_name} is no longer available" if options.key?(old_option_name)
       end
-      
+
       extend ActiveSupport::Autoload
-      
+
       autoload :DatetimePickerish
       autoload :Associations
       autoload :Collections
@@ -53,7 +59,7 @@ module Formtastic
       autoload :Timeish
       autoload :Validations
       autoload :Wrapping
-      
+
       include Html
       include Options
       include Database
@@ -65,8 +71,7 @@ module Formtastic
       include Associations
       include Labelling
       include Wrapping
-      
+
     end
   end
 end
-  

data/lib/formtastic/inputs/boolean_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     # Boolean inputs are used to render an input for a single checkbox, typically for attributes
@@ -59,7 +60,7 @@ module Formtastic
       end
 
       def label_text_with_embedded_checkbox
-        check_box_html << "" << label_text
+        check_box_html << +"" << label_text
       end
 
       def check_box_html

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -39,6 +40,7 @@ module Formtastic
     #   <%= f.input :categories, :as => :check_boxes, :collection => @categories %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => Category.all %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => Category.some_named_scope %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Category.pluck(:label, :id) %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => [Category.find_by_name("Ruby"), Category.find_by_name("Rails")] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => ["Ruby", "Rails"] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", "ruby"], ["Rails", "rails"]] %>
@@ -56,24 +58,6 @@ module Formtastic
     # @example `:disabled` can be used to disable any checkboxes with a value found in the given Array
     #   <%= f.input :categories, :as => :check_boxes, :collection => ["a", "b"], :disabled => ["a"] %>
     #
-    # @example `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => :name %>
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => :name_with_post_count
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => { |c| "#{c.name} (#{pluralize("post", c.posts.count)})" }
-    #
-    # @example `:member_label` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => method(:fancy_label)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => Proc.new { |category| fancy_label(category) }
-    #
-    # @example `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => :code %>
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => :isbn
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => Proc.new { |c| c.name.downcase.underscore }
-    #
-    # @example `:member_value` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => method(:some_helper)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => Proc.new { |category| some_helper(category) }
-    #
     # @example `:value_as_class` can be used to add a class to the `<li>` wrapped around each choice using the checkbox value for custom styling of each choice
     #   <%= f.input :categories, :as => :check_boxes, :value_as_class => true %>
     #
@@ -86,6 +70,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
@@ -111,8 +100,8 @@ module Formtastic
       end
 
       def hidden_field_for_all
-        if hidden_fields?
-          ''
+        if hidden_fields_for_every?
+          +''
         else
           options = {}
           options[:class] = [method.to_s.singularize, 'default'].join('_') if value_as_class?
@@ -121,7 +110,7 @@ module Formtastic
         end
       end
 
-      def hidden_fields?
+      def hidden_fields_for_every?
         options[:hidden_fields]
       end
 
@@ -182,7 +171,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)
@@ -192,11 +181,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -31,7 +32,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     # Outputs a country select input, wrapping around a regular country_select helper.
@@ -67,8 +68,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/datalist_input.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Formtastic
+  module Inputs
+    # Outputs a label and a text field, along with a datalist tag
+    # datalist tag provides a list of options which drives a simple autocomplete
+    # on the text field. This is a HTML5 feature, more info can be found at
+    # {https://developer.mozilla.org/en/docs/Web/HTML/Element/datalist <datalist> at MDN}
+    # This input accepts a :collection option which takes data in all the usual formats accepted by
+    # {http://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/options_for_select options_for_select}
+    #
+    # @example Input is used as follows
+    #   f.input :fav_book, :as => :datalist, :collection => Book.pluck(:name)
+    #
+    class DatalistInput
+      include Base
+      include Base::Stringish
+      include Base::Collections
+
+      def to_html
+        @name = input_html_options[:id].gsub(/_id$/, "")
+        input_wrapping do
+          label_html <<
+          builder.text_field(method, input_html_options) << # standard input
+          data_list_html # append new datalist element
+        end
+      end
+
+      def input_html_options
+        super.merge(:list => html_id_of_datalist)
+      end
+
+      def html_id_of_datalist
+        "#{@name}_datalist"
+      end
+
+      def data_list_html
+        html = builder.template.options_for_select(collection)
+        builder.template.content_tag(:datalist,html, { :id => html_id_of_datalist }, false)
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/date_picker_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     

data/lib/formtastic/inputs/date_select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     # Outputs a series of select boxes for the fragments that make up a date (year, month, day).

data/lib/formtastic/inputs/datetime_picker_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     

data/lib/formtastic/inputs/datetime_select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/email_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/file_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -20,7 +21,7 @@ module Formtastic
     #   <form...>
     #     <fieldset>
     #       <ol>
-    #         <li class="email">
+    #         <li class="file">
     #           <label for="user_avatar">Avatar</label>
     #           <input type="file" id="user_avatar" name="user[avatar]">
     #         </li>
@@ -29,7 +30,7 @@ module Formtastic
     #   </form>
     #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
-    class FileInput 
+    class FileInput
       include Base
       def to_html
         input_wrapping do

data/lib/formtastic/inputs/hidden_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -42,7 +43,7 @@ module Formtastic
       end
       
       def error_html
-        ""
+        +""
       end
       
       def errors?
@@ -50,7 +51,7 @@ module Formtastic
       end
       
       def hint_html
-        ""
+        +""
       end
       
       def hint?

data/lib/formtastic/inputs/number_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/password_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/phone_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/radio_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -31,10 +32,13 @@ 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).
     #
-    # The way on which Formtastic renders the `value` attribute and label for each choice is
-    # customisable through the `:member_label` and `:member_value` options (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
+    # 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
     # `collection_label_methods` and `collection_value_methods`.
     #
     # @example Basic `belongs_to` example with full form context
@@ -78,6 +82,8 @@ module Formtastic
     #   <%= f.input :author, :as => :radio, :collection => @authors %>
     #   <%= f.input :author, :as => :radio, :collection => Author.all %>
     #   <%= f.input :author, :as => :radio, :collection => Author.some_named_scope %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.pluck(:full_name, :id) %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.pluck(Arel.sql("CONCAT(`first_name`, ' ', `last_name`)"), :id)) %>
     #   <%= f.input :author, :as => :radio, :collection => [Author.find_by_login("justin"), Category.find_by_name("kate")] %>
     #   <%= f.input :author, :as => :radio, :collection => ["Justin", "Kate"] %>
     #   <%= f.input :author, :as => :radio, :collection => [["Justin", "justin"], ["Kate", "kate"]] %>
@@ -87,23 +93,6 @@ module Formtastic
     #   <%= f.input :author, :as => :radio, :collection => [:justin, :kate] %>
     #   <%= f.input :author, :as => :radio, :collection => 1..5 %>
     #
-    # @example The `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
-    #   <%= f.input :author, :as => :radio, :member_label => :name %>
-    #   <%= f.input :author, :as => :radio, :member_label => :name_with_post_count
-    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |a| "#{c.name} (#{pluralize("post", a.posts.count)})" }
-    #
-    # @example `:member_label` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :author, :as => :radio, :member_label => method(:fancy_label)
-    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |author| fancy_label(author) }
-    #
-    # @example The `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
-    #   <%= f.input :author, :as => :radio, :member_value => :login %>
-    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |c| c.full_name.downcase.underscore }
-    #
-    # @example `:member_value` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :author, :as => :radio, :member_value => method(:some_helper)
-    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |author| some_helper(author) }
-    #
     # @example Set HTML attributes on each `<input type="radio">` tag with `:input_html`
     #   <%= f.input :author, :as => :radio, :input_html => { :size => 20, :multiple => true, :class => "special" } %>
     #
@@ -116,6 +105,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/range_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     

data/lib/formtastic/inputs/search_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs