simple_form 3.4.0 → 4.0.0

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
 

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.
@@ -27,19 +28,9 @@ module SimpleForm
         length_validator.options[:tokenizer]
       end
 
-      # Use validation with tokenizer if version of Rails is less than 5,
-      # if not validate without the tokenizer, if version is greater than Rails 4.
-      if ActionPack::VERSION::STRING < '5'
-        def maximum_length_value_from(length_validator)
-          if length_validator && !has_tokenizer?(length_validator)
-            length_validator.options[:is] || length_validator.options[:maximum]
-          end
-        end
-      elsif ActionPack::VERSION::STRING >= '5'
-        def maximum_length_value_from(length_validator)
-          if length_validator
-            length_validator.options[:is] || length_validator.options[:maximum]
-          end
+      def maximum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:maximum]
         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

@@ -1,9 +1,10 @@
+# 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 || limit
+        input_html_options[:minlength] ||= minimum_length_from_validation
         nil
       end
 
@@ -27,19 +28,9 @@ module SimpleForm
         length_validator.options[:tokenizer]
       end
 
-      # Use validation with tokenizer if version of Rails is less than 5,
-      # if not validate without the tokenizer, if version is greater than Rails 4.
-      if ActionPack::VERSION::STRING < '5'
-        def minimum_length_value_from(length_validator)
-          if length_validator && !has_tokenizer?(length_validator)
-            length_validator.options[:is] || length_validator.options[:minimum]
-          end
-        end
-      elsif ActionPack::VERSION::STRING >= '5'
-        def minimum_length_value_from(length_validator)
-          if length_validator
-            length_validator.options[:is] || length_validator.options[:minimum]
-          end
+      def minimum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:minimum]
         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

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,25 +13,25 @@ module SimpleForm
       'update' => 'edit'
     }
 
-    ATTRIBUTE_COMPONENTS = [:html5, :min_max, :maxlength, :minlength, :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 :hidden,                                     to: SimpleForm::Inputs::HiddenInput
+    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 ||= {}
@@ -38,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
@@ -136,6 +138,29 @@ 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)
 
@@ -145,7 +170,7 @@ module SimpleForm
 
       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
@@ -461,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
 
@@ -521,7 +550,7 @@ module SimpleForm
       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
@@ -640,5 +669,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

data/lib/simple_form/inputs/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'simple_form/i18n_cache'
 require 'active_support/core_ext/string/output_safety'
 require 'action_view/helpers'
@@ -95,7 +96,7 @@ module SimpleForm
       end
 
       def input_class
-        "#{lookup_model_names.join("_")}_#{reflection_or_attribute_name}"
+        "#{lookup_model_names.join('_')}_#{reflection_or_attribute_name}"
       end
 
       private
@@ -190,6 +191,8 @@ module SimpleForm
 
       def merge_wrapper_options(options, wrapper_options)
         if wrapper_options
+          wrapper_options = set_input_classes(wrapper_options)
+
           wrapper_options.merge(options) do |key, oldval, newval|
             case key.to_s
             when "class"
@@ -205,6 +208,22 @@ module SimpleForm
         end
       end
 
+      def set_input_classes(wrapper_options)
+        wrapper_options = wrapper_options.dup
+        error_class     = wrapper_options.delete(:error_class)
+        valid_class     = wrapper_options.delete(:valid_class)
+
+        if error_class.present? && has_errors?
+          wrapper_options[:class] = "#{wrapper_options[:class]} #{error_class}"
+        end
+
+        if valid_class.present? && valid?
+          wrapper_options[:class] = "#{wrapper_options[:class]} #{valid_class}"
+        end
+
+        wrapper_options
+      end
+
       def i18n_scope
         SimpleForm.i18n_scope
       end

data/lib/simple_form/inputs/block_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class BlockInput < Base

data/lib/simple_form/inputs/boolean_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class BooleanInput < Base
@@ -59,9 +60,9 @@ module SimpleForm
       # we need the hidden field to be *outside* the label (otherwise it
       # generates invalid html - html5 only).
       def build_hidden_field_for_checkbox
-        return "" unless include_hidden?
+        return "" if !include_hidden? || !unchecked_value
         options = { value: unchecked_value, id: nil, disabled: input_html_options[:disabled] }
-        options[:name] = input_html_options[:name] if input_html_options.has_key?(:name)
+        options[:name] = input_html_options[:name] if input_html_options.key?(:name)
 
         @builder.hidden_field(attribute_name, options)
       end

data/lib/simple_form/inputs/collection_check_boxes_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class CollectionCheckBoxesInput < CollectionRadioButtonsInput
@@ -10,7 +11,7 @@ module SimpleForm
       end
 
       def build_nested_boolean_style_item_tag(collection_builder)
-        collection_builder.check_box + collection_builder.text
+        collection_builder.check_box + collection_builder.text.to_s
       end
 
       def item_wrapper_class

data/lib/simple_form/inputs/collection_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class CollectionInput < Base
@@ -45,7 +46,7 @@ module SimpleForm
 
       # Check if :include_blank must be included by default.
       def skip_include_blank?
-        (options.keys & [:prompt, :include_blank, :default, :selected]).any? || multiple?
+        (options.keys & %i[prompt include_blank default selected]).any? || multiple?
       end
 
       def multiple?
@@ -89,7 +90,7 @@ module SimpleForm
       end
 
       def detect_collection_classes(some_collection = collection)
-        some_collection.map { |e| e.class }.uniq
+        some_collection.map(&:class).uniq
       end
 
       def collection_includes_basic_objects?(collection_classes)

data/lib/simple_form/inputs/collection_radio_buttons_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class CollectionRadioButtonsInput < CollectionInput
@@ -40,7 +41,7 @@ module SimpleForm
       end
 
       def build_nested_boolean_style_item_tag(collection_builder)
-        collection_builder.radio_button + collection_builder.text
+        collection_builder.radio_button + collection_builder.text.to_s
       end
 
       def item_wrapper_class

data/lib/simple_form/inputs/collection_select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class CollectionSelectInput < CollectionInput

data/lib/simple_form/inputs/date_time_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class DateTimeInput < Base

data/lib/simple_form/inputs/file_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class FileInput < Base

data/lib/simple_form/inputs/grouped_collection_select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class GroupedCollectionSelectInput < CollectionInput

data/lib/simple_form/inputs/hidden_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class HiddenInput < Base

data/lib/simple_form/inputs/numeric_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class NumericInput < Base

data/lib/simple_form/inputs/password_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class PasswordInput < Base

data/lib/simple_form/inputs/priority_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class PriorityInput < CollectionSelectInput

data/lib/simple_form/inputs/range_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class RangeInput < NumericInput

data/lib/simple_form/inputs/string_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class StringInput < Base

data/lib/simple_form/inputs/text_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class TextInput < Base

data/lib/simple_form/inputs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     extend ActiveSupport::Autoload

data/lib/simple_form/map_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/core_ext/class/attribute'
 
 module SimpleForm

data/lib/simple_form/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/railtie'
 
 module SimpleForm

data/lib/simple_form/tags.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Tags
     module CollectionExtensions

data/lib/simple_form/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
-  VERSION = "3.4.0".freeze
+  VERSION = "4.0.0".freeze
 end

data/lib/simple_form/wrappers/builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # Provides the builder syntax for components. The builder provides

data/lib/simple_form/wrappers/leaf.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     class Leaf
@@ -11,7 +12,7 @@ module SimpleForm
       def render(input)
         method = input.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/wrappers/many.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # A wrapper is an object that holds several components and render them.

data/lib/simple_form/wrappers/root.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # `Root` is the root wrapper for all components. It is special cased to
@@ -29,6 +30,7 @@ module SimpleForm
         end
         css << (options[:wrapper_error_class] || @defaults[:error_class]) if input.has_errors?
         css << (options[:wrapper_hint_class] || @defaults[:hint_class]) if input.has_hint?
+        css << (options[:wrapper_valid_class] || @defaults[:valid_class]) if input.valid?
         css.compact
       end
     end

data/lib/simple_form/wrappers/single.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # `Single` is an optimization for a wrapper that has only one component.
@@ -19,7 +20,7 @@ module SimpleForm
       private
 
       def html_options(options)
-        [:label, :input].include?(namespace) ? {} : super
+        %i[label input].include?(namespace) ? {} : super
       end
     end
   end

data/lib/simple_form/wrappers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     autoload :Builder, 'simple_form/wrappers/builder'