simple_form 3.1.0 → 5.0.0

data/lib/simple_form/components/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module Errors
@@ -10,7 +11,15 @@ module SimpleForm
       end
 
       def has_errors?
-        object && object.respond_to?(:errors) && errors.present?
+        object_with_errors? || object.nil? && has_custom_error?
+      end
+
+      def has_value?
+        object && object.respond_to?(attribute_name) && object.send(attribute_name).present?
+      end
+
+      def valid?
+        !has_errors? && has_value?
       end
 
       protected
@@ -25,6 +34,10 @@ module SimpleForm
         has_custom_error? ? options[:error] : full_errors.send(error_method)
       end
 
+      def object_with_errors?
+        object && object.respond_to?(:errors) && errors.present?
+      end
+
       def error_method
         options[:error_method] || SimpleForm.error_method
       end
@@ -38,7 +51,7 @@ module SimpleForm
       end
 
       def errors_on_attribute
-        object.errors[attribute_name]
+        object.errors[attribute_name] || []
       end
 
       def full_errors_on_attribute

data/lib/simple_form/components/hints.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.

data/lib/simple_form/components/html5.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module HTML5
@@ -7,10 +8,12 @@ module SimpleForm
 
       def html5(wrapper_options = nil)
         @html5 = true
-        if has_required?
-          input_html_options[:required] = true
-          input_html_options[:'aria-required'] = true
-        end
+
+        input_html_options[:required]        = input_html_required_option
+        input_html_options[:'aria-required'] = input_html_aria_required_option
+
+        input_html_options[:'aria-invalid']  = has_errors? || nil
+
         nil
       end
 
@@ -18,6 +21,14 @@ module SimpleForm
         @html5
       end
 
+      def input_html_required_option
+        !options[:required].nil? ? required_field? : has_required?
+      end
+
+      def input_html_aria_required_option
+        !options[:required].nil? ? (required_field? || nil) : (has_required? || nil)
+      end
+
       def has_required?
         # We need to check browser_validations because
         # some browsers are still checking required even

data/lib/simple_form/components/label_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module LabelInput
@@ -20,7 +21,7 @@ module SimpleForm
       def deprecated_component(namespace, wrapper_options)
         method = method(namespace)
 
-        if method.arity == 0
+        if method.arity.zero?
           ActiveSupport::Deprecation.warn(SimpleForm::CUSTOM_INPUT_DEPRECATION_WARN % { name: namespace })
 
           method.call

data/lib/simple_form/components/labels.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module Labels
@@ -6,18 +7,24 @@ module SimpleForm
       module ClassMethods #:nodoc:
         def translate_required_html
           i18n_cache :translate_required_html do
-            I18n.t(:"simple_form.required.html", default:
-              %[<abbr title="#{translate_required_text}">#{translate_required_mark}</abbr>]
+            I18n.t(:"required.html", scope: i18n_scope, default:
+              %(<abbr title="#{translate_required_text}">#{translate_required_mark}</abbr>)
             )
           end
         end
 
         def translate_required_text
-          I18n.t(:"simple_form.required.text", default: 'required')
+          I18n.t(:"required.text", scope: i18n_scope, default: 'required')
         end
 
         def translate_required_mark
-          I18n.t(:"simple_form.required.mark", default: '*')
+          I18n.t(:"required.mark", scope: i18n_scope, default: '*')
+        end
+
+        private
+
+        def i18n_scope
+          SimpleForm.i18n_scope
         end
       end
 
@@ -42,7 +49,7 @@ module SimpleForm
 
       def label_html_options
         label_html_classes = SimpleForm.additional_classes_for(:label) {
-          [input_type, required_class, SimpleForm.label_class].compact
+          [input_type, required_class, disabled_class, SimpleForm.label_class].compact
         }
 
         label_options = html_options_for(:label, label_html_classes)

data/lib/simple_form/components/maxlength.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
@@ -15,10 +16,7 @@ module SimpleForm
           maxlength
         else
           length_validator = find_length_validator
-
-          if length_validator && !has_tokenizer?(length_validator)
-            length_validator.options[:is] || length_validator.options[:maximum]
-          end
+          maximum_length_value_from(length_validator)
         end
       end
 
@@ -29,6 +27,12 @@ module SimpleForm
       def has_tokenizer?(length_validator)
         length_validator.options[:tokenizer]
       end
+
+      def maximum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:maximum]
+        end
+      end
     end
   end
 end

data/lib/simple_form/components/min_max.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module MinMax

data/lib/simple_form/components/minlength.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module SimpleForm
+  module Components
+    # Needs to be enabled in order to do automatic lookups.
+    module Minlength
+      def minlength(wrapper_options = nil)
+        input_html_options[:minlength] ||= minimum_length_from_validation
+        nil
+      end
+
+      private
+
+      def minimum_length_from_validation
+        minlength = options[:minlength]
+        if minlength.is_a?(String) || minlength.is_a?(Integer)
+          minlength
+        else
+          length_validator = find_length_validator
+          minimum_length_value_from(length_validator)
+        end
+      end
+
+      def find_length_validator
+        find_validator(:length)
+      end
+
+      def has_tokenizer?(length_validator)
+        length_validator.options[:tokenizer]
+      end
+
+      def minimum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:minimum]
+        end
+      end
+    end
+  end
+end

data/lib/simple_form/components/pattern.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.

data/lib/simple_form/components/placeholders.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
@@ -7,7 +8,7 @@ module SimpleForm
         nil
       end
 
-      def placeholder_text
+      def placeholder_text(wrapper_options = nil)
         placeholder = options[:placeholder]
         placeholder.is_a?(String) ? placeholder : translate_from_namespace(:placeholders)
       end

data/lib/simple_form/components/readonly.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.

data/lib/simple_form/components.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   # Components are a special type of helpers that can work on their own.
   # For example, by using a component, it will automatically change the
@@ -15,6 +16,7 @@ module SimpleForm
     autoload :Labels
     autoload :MinMax
     autoload :Maxlength
+    autoload :Minlength
     autoload :Pattern
     autoload :Placeholders
     autoload :Readonly

data/lib/simple_form/error_notification.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   class ErrorNotification
     delegate :object, :object_name, :template, to: :@builder

data/lib/simple_form/form_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/core_ext/object/deep_dup'
 require 'simple_form/map_type'
 require 'simple_form/tags'
@@ -12,24 +13,25 @@ module SimpleForm
       'update' => 'edit'
     }
 
-    ATTRIBUTE_COMPONENTS = [:html5, :min_max, :maxlength, :placeholder, :pattern, :readonly]
+    ATTRIBUTE_COMPONENTS = %i[html5 min_max maxlength minlength placeholder pattern readonly]
 
     extend MapType
     include SimpleForm::Inputs
 
-    map_type :text,                                       to: SimpleForm::Inputs::TextInput
-    map_type :file,                                       to: SimpleForm::Inputs::FileInput
-    map_type :string, :email, :search, :tel, :url, :uuid, to: SimpleForm::Inputs::StringInput
-    map_type :password,                                   to: SimpleForm::Inputs::PasswordInput
-    map_type :integer, :decimal, :float,                  to: SimpleForm::Inputs::NumericInput
-    map_type :range,                                      to: SimpleForm::Inputs::RangeInput
-    map_type :check_boxes,                                to: SimpleForm::Inputs::CollectionCheckBoxesInput
-    map_type :radio_buttons,                              to: SimpleForm::Inputs::CollectionRadioButtonsInput
-    map_type :select,                                     to: SimpleForm::Inputs::CollectionSelectInput
-    map_type :grouped_select,                             to: SimpleForm::Inputs::GroupedCollectionSelectInput
-    map_type :date, :time, :datetime,                     to: SimpleForm::Inputs::DateTimeInput
-    map_type :country, :time_zone,                        to: SimpleForm::Inputs::PriorityInput
-    map_type :boolean,                                    to: SimpleForm::Inputs::BooleanInput
+    map_type :text, :hstore, :json, :jsonb,                        to: SimpleForm::Inputs::TextInput
+    map_type :file,                                                to: SimpleForm::Inputs::FileInput
+    map_type :string, :email, :search, :tel, :url, :uuid, :citext, to: SimpleForm::Inputs::StringInput
+    map_type :password,                                            to: SimpleForm::Inputs::PasswordInput
+    map_type :integer, :decimal, :float,                           to: SimpleForm::Inputs::NumericInput
+    map_type :range,                                               to: SimpleForm::Inputs::RangeInput
+    map_type :check_boxes,                                         to: SimpleForm::Inputs::CollectionCheckBoxesInput
+    map_type :radio_buttons,                                       to: SimpleForm::Inputs::CollectionRadioButtonsInput
+    map_type :select,                                              to: SimpleForm::Inputs::CollectionSelectInput
+    map_type :grouped_select,                                      to: SimpleForm::Inputs::GroupedCollectionSelectInput
+    map_type :date, :time, :datetime,                              to: SimpleForm::Inputs::DateTimeInput
+    map_type :country, :time_zone,                                 to: SimpleForm::Inputs::PriorityInput
+    map_type :boolean,                                             to: SimpleForm::Inputs::BooleanInput
+    map_type :hidden,                                              to: SimpleForm::Inputs::HiddenInput
 
     def self.discovery_cache
       @discovery_cache ||= {}
@@ -37,6 +39,7 @@ module SimpleForm
 
     def initialize(*) #:nodoc:
       super
+      @object   = convert_to_model(@object)
       @defaults = options[:defaults]
       @wrapper  = SimpleForm.wrapper(options[:wrapper] || SimpleForm.default_wrapper)
     end
@@ -47,6 +50,11 @@ module SimpleForm
     # label + input + hint (when defined) + errors (when exists), and all can
     # be configured inside a wrapper html.
     #
+    # If a block is given, the contents of the block will replace the input
+    # field that would otherwise be generated automatically. The content will
+    # be given a label and wrapper div to make it consistent with the other
+    # elements in the form.
+    #
     # == Examples
     #
     #   # Imagine @user has error "can't be blank" on name
@@ -130,16 +138,39 @@ module SimpleForm
     #     <input class="string required" id="user_name" maxlength="100"
     #        name="user[name]" type="text" value="Carlos" />
     #
+    # It also support validation classes once it is configured.
+    #
+    #   # config/initializers/simple_form.rb
+    #   SimpleForm.setup do |config|
+    #     config.input_field_valid_class = 'is-valid'
+    #     config.input_field_error_class = 'is-invalid'
+    #   end
+    #
+    #   simple_form_for @user do |f|
+    #     f.input_field :name
+    #   end
+    #
+    # When the validation happens, the input will be rendered with
+    # the class configured according to the validation:
+    #
+    # - when the input is valid:
+    #
+    #     <input class="is-valid string required" id="user_name" value="Carlos" />
+    #
+    # - when the input is invalid:
+    #
+    #     <input class="is-invalid string required" id="user_name" value="" />
+    #
     def input_field(attribute_name, options = {})
       components = (wrapper.components.map(&:namespace) & ATTRIBUTE_COMPONENTS)
 
       options = options.dup
-      options[:input_html] = options.except(:as, :boolean_style, :collection, :label_method, :value_method, *components)
+      options[:input_html] = options.except(:as, :boolean_style, :collection, :disabled, :label_method, :value_method, :prompt, *components)
       options = @defaults.deep_dup.deep_merge(options) if @defaults
 
       input      = find_input(attribute_name, options)
       wrapper    = find_wrapper(input.input_type, options)
-      components = components.concat([:input]).map { |component| SimpleForm::Wrappers::Leaf.new(component) }
+      components = build_input_field_components(components.push(:input))
 
       SimpleForm::Wrappers::Root.new(components, wrapper.options.merge(wrapper: false)).render input
     end
@@ -206,8 +237,8 @@ module SimpleForm
       options = args.extract_options!.dup
       options[:class] = [SimpleForm.button_class, options[:class]].compact
       args << options
-      if respond_to?("#{type}_button")
-        send("#{type}_button", *args, &block)
+      if respond_to?(:"#{type}_button")
+        send(:"#{type}_button", *args, &block)
       else
         send(type, *args, &block)
       end
@@ -284,7 +315,7 @@ module SimpleForm
     #
     #    f.label :name                     # Do I18n lookup
     #    f.label :name, "Name"             # Same behavior as Rails, do not add required tag
-    #    f.label :name, label: "Name"   # Same as above, but adds required tag
+    #    f.label :name, label: "Name"      # Same as above, but adds required tag
     #
     #    f.label :name, required: false
     #    f.label :name, id: "cool_label"
@@ -293,7 +324,7 @@ module SimpleForm
       return super if args.first.is_a?(String) || block_given?
 
       options = args.extract_options!.dup
-      options[:label_html] = options.except(:label, :required, :as)
+      options[:label_html] = options.except(:label, :label_text, :required, :as)
 
       column      = find_attribute_column(attribute_name)
       input_type  = default_input_type(attribute_name, column, options)
@@ -455,13 +486,17 @@ module SimpleForm
         relation = reflection.klass.all
 
         if reflection.respond_to?(:scope) && reflection.scope
-          relation = reflection.klass.instance_exec(&reflection.scope)
+          if reflection.scope.parameters.any?
+            relation = reflection.klass.instance_exec(object, &reflection.scope)
+          else
+            relation = reflection.klass.instance_exec(&reflection.scope)
+          end
         else
           order = reflection.options[:order]
           conditions = reflection.options[:conditions]
           conditions = object.instance_exec(&conditions) if conditions.respond_to?(:call)
 
-          relation = relation.where(conditions)
+          relation = relation.where(conditions) if relation.respond_to?(:where)
           relation = relation.order(order) if relation.respond_to?(:order)
         end
 
@@ -476,7 +511,7 @@ module SimpleForm
       when :has_one
         raise ArgumentError, ":has_one associations are not supported by f.association"
       else
-        if options[:as] == :select
+        if options[:as] == :select || options[:as] == :grouped_select
           html_options = options[:input_html] ||= {}
           html_options[:multiple] = true unless html_options.key?(:multiple)
         end
@@ -504,25 +539,25 @@ module SimpleForm
     end
 
     # Attempt to guess the better input type given the defined options. By
-    # default alwayls fallback to the user :as option, or to a :select when a
+    # default always fallback to the user :as option, or to a :select when a
     # collection is given.
     def default_input_type(attribute_name, column, options)
       return options[:as].to_sym if options[:as]
-      return :select             if options[:collection]
       custom_type = find_custom_type(attribute_name.to_s) and return custom_type
+      return :select             if options[:collection]
 
       input_type = column.try(:type)
       case input_type
       when :timestamp
         :datetime
-      when :string, nil
+      when :string, :citext, nil
         case attribute_name.to_s
-        when /password/  then :password
-        when /time_zone/ then :time_zone
-        when /country/   then :country
-        when /email/     then :email
-        when /phone/     then :tel
-        when /url/       then :url
+        when /(?:\b|\W|_)password(?:\b|\W|_)/  then :password
+        when /(?:\b|\W|_)time_zone(?:\b|\W|_)/ then :time_zone
+        when /(?:\b|\W|_)country(?:\b|\W|_)/   then :country
+        when /(?:\b|\W|_)email(?:\b|\W|_)/     then :email
+        when /(?:\b|\W|_)phone(?:\b|\W|_)/     then :tel
+        when /(?:\b|\W|_)url(?:\b|\W|_)/       then :url
         else
           file_method?(attribute_name) ? :file : (input_type || :string)
         end
@@ -537,13 +572,34 @@ module SimpleForm
       }.try(:last) if SimpleForm.input_mappings
     end
 
+    # Internal: Try to discover whether an attribute corresponds to a file or not.
+    #
+    # Most upload Gems add some kind of attributes to the ActiveRecord's model they are included in.
+    # This method tries to guess if an attribute belongs to some of these Gems by checking the presence
+    # of their methods using `#respond_to?`.
+    #
+    # Note: This does not support multiple file upload inputs, as this is very application-specific.
+    #
+    # The order here was choosen based on the popularity of Gems and for commodity - e.g. the method
+    # with the suffix `_url` is present in three Gems, so it's checked with priority:
+    #
+    # - `#{attribute_name}_attachment` - ActiveStorage >= `5.2` and Refile >= `0.2.0` <= `0.4.0`
+    # - `#{attribute_name}_url` - Shrine >= `0.9.0`, Refile >= `0.6.0` and CarrierWave >= `0.2.1`
+    # - `#{attribute_name}_attacher` - Refile >= `0.4.0` and Shrine >= `0.9.0`
+    # - `#{attribute_name}_file_name` - Paperclip ~> `2.0` (added for backwards compatibility)
+    #
+    # Returns a Boolean.
     def file_method?(attribute_name)
-      file = @object.send(attribute_name) if @object.respond_to?(attribute_name)
-      file && SimpleForm.file_methods.any? { |m| file.respond_to?(m) }
+      @object.respond_to?("#{attribute_name}_attachment") ||
+        @object.respond_to?("#{attribute_name}_url") ||
+        @object.respond_to?("#{attribute_name}_attacher") ||
+        @object.respond_to?("#{attribute_name}_file_name")
     end
 
     def find_attribute_column(attribute_name)
-      if @object.respond_to?(:column_for_attribute) && @object.has_attribute?(attribute_name)
+      if @object.respond_to?(:type_for_attribute) && @object.has_attribute?(attribute_name)
+        @object.type_for_attribute(attribute_name.to_s)
+      elsif @object.respond_to?(:column_for_attribute) && @object.has_attribute?(attribute_name)
         @object.column_for_attribute(attribute_name)
       end
     end
@@ -632,5 +688,31 @@ module SimpleForm
 
       nil
     end
+
+    def build_input_field_components(components)
+      components.map do |component|
+        if component == :input
+          SimpleForm::Wrappers::Leaf.new(component, build_input_field_options)
+        else
+          SimpleForm::Wrappers::Leaf.new(component)
+        end
+      end
+    end
+
+    def build_input_field_options
+      input_field_options = {}
+      valid_class         = SimpleForm.input_field_valid_class
+      error_class         = SimpleForm.input_field_error_class
+
+      if error_class.present?
+        input_field_options[:error_class] = error_class
+      end
+
+      if valid_class.present?
+        input_field_options[:valid_class] = valid_class
+      end
+
+      input_field_options
+    end
   end
 end

data/lib/simple_form/helpers/autofocus.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Helpers
     module Autofocus

data/lib/simple_form/helpers/disabled.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Helpers
     module Disabled

data/lib/simple_form/helpers/readonly.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Helpers
     module Readonly

data/lib/simple_form/helpers/required.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Helpers
     module Required

data/lib/simple_form/helpers/validators.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Helpers
     module Validators
@@ -24,7 +25,7 @@ module SimpleForm
       end
 
       def action_validator_match?(validator)
-        return true if !validator.options.include?(:on)
+        return true unless validator.options.include?(:on)
 
         case validator.options[:on]
         when :save

data/lib/simple_form/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   # Helpers are made of several helpers that cannot be turned on automatically.
   # For instance, disabled cannot be turned on automatically, it requires the

data/lib/simple_form/i18n_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   # A lot of configuration values are retrived from I18n,
   # like boolean collection, required string. This module provides