simple_form 3.4.0 → 5.1.0

data/lib/simple_form/inputs/collection_check_boxes_input.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class CollectionCheckBoxesInput < CollectionRadioButtonsInput
       protected
 
       # Checkbox components do not use the required html tag.
-      # More info: https://github.com/plataformatec/simple_form/issues/340#issuecomment-2871956
+      # More info: https://github.com/heartcombo/simple_form/issues/340#issuecomment-2871956
       def has_required?
         false
       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
@@ -9,10 +10,8 @@ module SimpleForm
       # Texts can be translated using i18n in "simple_form.yes" and
       # "simple_form.no" keys. See the example locale file.
       def self.boolean_collection
-        i18n_cache :boolean_collection do
-          [ [I18n.t(:"simple_form.yes", default: 'Yes'), true],
-            [I18n.t(:"simple_form.no", default: 'No'), false] ]
-        end
+        [ [I18n.t(:"simple_form.yes", default: 'Yes'), true],
+          [I18n.t(:"simple_form.no", default: 'No'), false] ]
       end
 
       def input(wrapper_options = nil)
@@ -40,12 +39,12 @@ module SimpleForm
       end
 
       def has_required?
-        super && (input_options[:include_blank] || input_options[:prompt] || multiple?)
+        super && (input_options[:include_blank] || input_options[:prompt].present? || multiple?)
       end
 
       # 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 +88,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/color_input.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module SimpleForm
+  module Inputs
+    class ColorInput < Base
+      def input(wrapper_options = nil)
+        input_html_options[:type] ||= "color" if html5?
+
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_field(attribute_name, merged_input_options)
+      end
+    end
+  end
+end

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
@@ -14,10 +15,6 @@ module SimpleForm
 
       protected
 
-      def has_required?
-        false
-      end
-
       def skip_include_blank?
         super || input_priority.present?
       end

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/rich_text_area_input.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SimpleForm
+  module Inputs
+    class RichTextAreaInput < Base
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.rich_text_area(attribute_name, merged_input_options)
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/string_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class StringInput < Base
@@ -17,7 +18,7 @@ module SimpleForm
       private
 
       def string?
-        input_type == :string
+        input_type == :string || input_type == :citext
       end
     end
   end

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
@@ -9,6 +10,7 @@ module SimpleForm
     autoload :CollectionInput
     autoload :CollectionRadioButtonsInput
     autoload :CollectionSelectInput
+    autoload :ColorInput
     autoload :DateTimeInput
     autoload :FileInput
     autoload :GroupedCollectionSelectInput
@@ -17,6 +19,7 @@ module SimpleForm
     autoload :PasswordInput
     autoload :PriorityInput
     autoload :RangeInput
+    autoload :RichTextAreaInput
     autoload :StringInput
     autoload :TextInput
   end

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
@@ -47,7 +48,9 @@ module SimpleForm
       private
 
       def render_component(builder)
-        builder.radio_button + builder.label(class: "collection_radio_buttons")
+        label_class = "#{@options[:item_label_class]} collection_radio_buttons".strip
+
+        builder.radio_button + builder.label(class: label_class)
       end
     end
 
@@ -61,7 +64,9 @@ module SimpleForm
       private
 
       def render_component(builder)
-        builder.check_box + builder.label(class: "collection_check_boxes")
+        label_class = "#{@options[:item_label_class]} collection_check_boxes".strip
+
+        builder.check_box + builder.label(class: label_class)
       end
     end
   end

data/lib/simple_form/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
-  VERSION = "3.4.0".freeze
+  VERSION = "5.1.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
@@ -27,10 +28,16 @@ module SimpleForm
         css += SimpleForm.additional_classes_for(:wrapper) do
           input.additional_classes + [input.input_class]
         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 << html_class(:error_class, options) { input.has_errors? }
+        css << html_class(:hint_class, options) { input.has_hint? }
+        css << html_class(:valid_class, options) { input.valid? }
         css.compact
       end
+
+      def html_class(key, options)
+        css = (options[:"wrapper_#{key}"] || @defaults[key])
+        css if css && yield
+      end
     end
   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'

data/lib/simple_form.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'action_view'
+require 'action_pack'
 require 'simple_form/action_view_extensions/form_helper'
 require 'simple_form/action_view_extensions/builder'
 require 'active_support/core_ext/hash/slice'
@@ -33,7 +35,18 @@ to
 
     def %{name}(wrapper_options)
 
-See https://github.com/plataformatec/simple_form/pull/997 for more information.
+See https://github.com/heartcombo/simple_form/pull/997 for more information.
+  WARN
+
+  FILE_METHODS_DEPRECATION_WARN = <<-WARN
+[SIMPLE_FORM] SimpleForm.file_methods is deprecated and has no effect.
+
+Since version 5, Simple Form now supports automatically discover of file inputs for the following Gems: activestorage, carrierwave, paperclip, refile and shrine.
+If you are using a custom method that is not from one of the supported Gems, please change your forms to pass the input type explicitly:
+
+    <%= form.input :avatar, as: :file %>
+
+See http://blog.plataformatec.com.br/2019/09/incorrect-access-control-in-simple-form-cve-2019-16676 for more information.
   WARN
 
   @@configured = false
@@ -58,11 +71,11 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
 
   # Series of attemps to detect a default label method for collection.
   mattr_accessor :collection_label_methods
-  @@collection_label_methods = [:to_label, :name, :title, :to_s]
+  @@collection_label_methods = %i[to_label name title to_s]
 
   # Series of attemps to detect a default value method for collection.
   mattr_accessor :collection_value_methods
-  @@collection_value_methods = [:id, :to_s]
+  @@collection_value_methods = %i[id to_s]
 
   # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
   mattr_accessor :collection_wrapper_tag
@@ -84,7 +97,7 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
 
   # How the label text should be generated altogether with the required text.
   mattr_accessor :label_text
-  @@label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+  @@label_text = ->(label, required, explicit_label) { "#{required} #{label}" }
 
   # You can define the class to be used on all labels. Defaults to none.
   mattr_accessor :label_class
@@ -108,7 +121,7 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
 
   # You can define which elements should obtain additional classes.
   mattr_accessor :generate_additional_classes_for
-  @@generate_additional_classes_for = [:wrapper, :label, :input]
+  @@generate_additional_classes_for = %i[wrapper label input]
 
   # Whether attributes are required by default or not.
   mattr_accessor :required_by_default
@@ -118,10 +131,6 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
   mattr_accessor :browser_validations
   @@browser_validations = true
 
-  # Collection of methods to detect if a file type was given.
-  mattr_accessor :file_methods
-  @@file_methods = [:mounted_as, :file?, :public_filename]
-
   # Custom mappings for input types. This should be a hash containing a regexp
   # to match as key, and the input type that will be used when the field name
   # matches the regexp as value, such as { /count/ => :integer }.
@@ -163,7 +172,7 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
 
   # Cache SimpleForm inputs discovery.
   mattr_accessor :cache_discovery
-  @@cache_discovery = defined?(Rails) && !Rails.env.development?
+  @@cache_discovery = defined?(Rails.env) && !Rails.env.development?
 
   # Adds a class to each generated button, mostly for compatiblity.
   mattr_accessor :button_class
@@ -198,6 +207,12 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
   mattr_accessor :i18n_scope
   @@i18n_scope = 'simple_form'
 
+  mattr_accessor :input_field_error_class
+  @@input_field_error_class = nil
+
+  mattr_accessor :input_field_valid_class
+  @@input_field_valid_class = nil
+
   # Retrieves a given wrapper
   def self.wrapper(name)
     @@wrappers[name.to_s] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
@@ -227,7 +242,7 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
     SimpleForm::Wrappers::Root.new(builder.to_a, options)
   end
 
-  wrappers class: :input, hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+  wrappers class: :input, hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b|
     b.use :html5
 
     b.use :min_max
@@ -257,12 +272,65 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
     @@form_class = value
   end
 
+  def self.file_methods=(file_methods)
+    ActiveSupport::Deprecation.warn(FILE_METHODS_DEPRECATION_WARN, caller)
+    @@file_methods = file_methods
+  end
+
+  def self.file_methods
+    ActiveSupport::Deprecation.warn(FILE_METHODS_DEPRECATION_WARN, caller)
+    @@file_methods
+  end
+
   # Default way to setup Simple Form. Run rails generate simple_form:install
   # to create a fresh initializer with all configuration values.
   def self.setup
     @@configured = true
     yield self
   end
+
+  # Includes a component to be used by Simple Form. Methods defined in a
+  # component will be exposed to be used in the wrapper as Simple::Components
+  #
+  # Examples
+  #
+  #    # The application needs to tell where the components will be.
+  #    Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+  #
+  #    # Create a custom component in the path specified above.
+  #    # lib/components/input_group_component.rb
+  #    module InputGroupComponent
+  #      def prepend
+  #        ...
+  #      end
+  #
+  #      def append
+  #        ...
+  #      end
+  #    end
+  #
+  #    SimpleForm.setup do |config|
+  #      # Create a wrapper using the custom component.
+  #      config.wrappers :input_group, tag: :div, error_class: :error do |b|
+  #        b.use :label
+  #        b.optional :prepend
+  #        b.use :input
+  #        b.use :append
+  #      end
+  #    end
+  #
+  #    # Using the custom component in the form.
+  #    <%= simple_form_for @blog, wrapper: input_group do |f| %>
+  #      <%= f.input :title, prepend: true %>
+  #    <% end %>
+  #
+  def self.include_component(component)
+    if Module === component
+      SimpleForm::Inputs::Base.include(component)
+    else
+      raise TypeError, "SimpleForm.include_component expects a module but got: #{component.class}"
+    end
+  end
 end
 
 require 'simple_form/railtie' if defined?(Rails)

data/test/action_view_extensions/builder_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class BuilderTest < ActionView::TestCase
@@ -36,7 +37,7 @@ class BuilderTest < ActionView::TestCase
   end
 
   test "collection radio handles camelized collection values for labels correctly" do
-    with_collection_radio_buttons @user, :active, ['Yes', 'No'], :to_s, :to_s
+    with_collection_radio_buttons @user, :active, %w[Yes No], :to_s, :to_s
 
     assert_select 'form label.collection_radio_buttons[for=user_active_yes]', 'Yes'
     assert_select 'form label.collection_radio_buttons[for=user_active_no]', 'No'
@@ -44,8 +45,17 @@ class BuilderTest < ActionView::TestCase
 
   test "collection radio sanitizes collection values for labels correctly" do
     with_collection_radio_buttons @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
-    assert_select 'label.collection_radio_buttons[for=user_name_099]', '$0.99'
-    assert_select 'label.collection_radio_buttons[for=user_name_199]', '$1.99'
+
+    # Rails 6 changed the way it sanitizes the values
+    # https://github.com/rails/rails/blob/6-0-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    # https://github.com/rails/rails/blob/5-2-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    if ActionView::VERSION::MAJOR == 5
+      assert_select 'label.collection_radio_buttons[for=user_name_099]', '$0.99'
+      assert_select 'label.collection_radio_buttons[for=user_name_199]', '$1.99'
+    else
+      assert_select 'label.collection_radio_buttons[for=user_name_0_99]', '$0.99'
+      assert_select 'label.collection_radio_buttons[for=user_name_1_99]', '$1.99'
+    end
   end
 
   test "collection radio checks the correct value to local variables" do
@@ -243,7 +253,7 @@ class BuilderTest < ActionView::TestCase
 
   test "collection radio with block helpers does not leak the template" do
     with_concat_form_for(@user) do |f|
-      collection_input =  f.collection_radio_buttons :active, [true, false], :to_s, :to_s do |b|
+      collection_input = f.collection_radio_buttons :active, [true, false], :to_s, :to_s do |b|
         b.label(class: b.object) { b.radio_button + b.text }
       end
       concat collection_input
@@ -283,7 +293,7 @@ class BuilderTest < ActionView::TestCase
   end
 
   test "collection check box handles camelized collection values for labels correctly" do
-    with_collection_check_boxes @user, :active, ['Yes', 'No'], :to_s, :to_s
+    with_collection_check_boxes @user, :active, %w[Yes No], :to_s, :to_s
 
     assert_select 'form label.collection_check_boxes[for=user_active_yes]', 'Yes'
     assert_select 'form label.collection_check_boxes[for=user_active_no]', 'No'
@@ -291,8 +301,17 @@ class BuilderTest < ActionView::TestCase
 
   test "collection check box sanitizes collection values for labels correctly" do
     with_collection_check_boxes @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
-    assert_select 'label.collection_check_boxes[for=user_name_099]', '$0.99'
-    assert_select 'label.collection_check_boxes[for=user_name_199]', '$1.99'
+
+    # Rails 6 changed the way it sanitizes the values
+    # https://github.com/rails/rails/blob/6-0-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    # https://github.com/rails/rails/blob/5-2-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    if ActionView::VERSION::MAJOR == 5
+      assert_select 'label.collection_check_boxes[for=user_name_099]', '$0.99'
+      assert_select 'label.collection_check_boxes[for=user_name_199]', '$1.99'
+    else
+      assert_select 'label.collection_check_boxes[for=user_name_0_99]', '$0.99'
+      assert_select 'label.collection_check_boxes[for=user_name_1_99]', '$1.99'
+    end
   end
 
   test "collection check box checks the correct value to local variables" do
@@ -317,7 +336,7 @@ class BuilderTest < ActionView::TestCase
 
   test "collection check boxes accepts selected string values as :checked option" do
     collection = (1..3).map { |i| [i, "Category #{i}"] }
-    with_collection_check_boxes :user, :category_ids, collection, :first, :last, checked: ['1', '3']
+    with_collection_check_boxes :user, :category_ids, collection, :first, :last, checked: %w[1 3]
 
     assert_select 'input[type=checkbox][value="1"][checked=checked]'
     assert_select 'input[type=checkbox][value="3"][checked=checked]'
@@ -541,7 +560,7 @@ class BuilderTest < ActionView::TestCase
 
   test "collection check boxes with block helpers does not leak the template" do
     with_concat_form_for(@user) do |f|
-      collection_input =  f.collection_check_boxes :active, [true, false], :to_s, :to_s do |b|
+      collection_input = f.collection_check_boxes :active, [true, false], :to_s, :to_s do |b|
         b.label(class: b.object) { b.check_box + b.text }
       end
       concat collection_input

data/test/action_view_extensions/form_helper_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class FormHelperTest < ActionView::TestCase
@@ -151,7 +152,7 @@ class FormHelperTest < ActionView::TestCase
   end
 
   test 'SimpleForm for swaps default action view field_error_proc' do
-    expected_error_proc = lambda {}
+    expected_error_proc = -> {}
     swap SimpleForm, field_error_proc: expected_error_proc do
       simple_form_for :user do |f|
         assert_equal expected_error_proc, ::ActionView::Base.field_error_proc
@@ -161,7 +162,7 @@ class FormHelperTest < ActionView::TestCase
 
   private
 
-  def swap_field_error_proc(expected_error_proc = lambda {})
+  def swap_field_error_proc(expected_error_proc = -> {})
     swap ActionView::Base, field_error_proc: expected_error_proc do
       yield