simple_form 3.0.4 → 5.0.3

data/lib/simple_form/inputs/priority_input.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class PriorityInput < CollectionSelectInput
-      def input
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
         @builder.send(:"#{input_type}_select", attribute_name, input_priority,
-                      input_options, input_html_options)
+                      input_options, merged_input_options)
       end
 
       def input_priority
@@ -12,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,7 +1,8 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class RangeInput < NumericInput
-      def input
+      def input(wrapper_options = nil)
         if html5?
           input_html_options[:type] ||= "range"
           input_html_options[:step] ||= 1

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,21 +1,24 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class StringInput < Base
-      enable :placeholder, :maxlength, :pattern
+      enable :placeholder, :maxlength, :minlength, :pattern
 
-      def input
+      def input(wrapper_options = nil)
         unless string?
           input_html_classes.unshift("string")
           input_html_options[:type] ||= input_type if html5?
         end
 
-        @builder.text_field(attribute_name, input_html_options)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_field(attribute_name, merged_input_options)
       end
 
       private
 
       def string?
-        input_type == :string
+        input_type == :string || input_type == :citext
       end
     end
   end

data/lib/simple_form/inputs/text_input.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
 module SimpleForm
   module Inputs
     class TextInput < Base
-      enable :placeholder, :maxlength
+      enable :placeholder, :maxlength, :minlength
 
-      def input
-        @builder.text_area(attribute_name, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_area(attribute_name, merged_input_options)
       end
     end
   end

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,7 +1,15 @@
+# frozen_string_literal: true
 require 'rails/railtie'
 
 module SimpleForm
   class Railtie < Rails::Railtie
     config.eager_load_namespaces << SimpleForm
+
+    config.after_initialize do
+      unless SimpleForm.configured?
+        warn '[Simple Form] Simple Form is not configured in the application and will use the default values.' +
+          ' Use `rails generate simple_form:install` to generate the Simple Form configuration.'
+      end
+    end
   end
 end

data/lib/simple_form/tags.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Tags
     module CollectionExtensions
@@ -15,6 +16,12 @@ module SimpleForm
 
           rendered_item = yield item, value, text, default_html_options.merge(additional_html_options)
 
+          if @options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
+            label_options = default_html_options.slice(:index, :namespace)
+            label_options['class'] = @options[:item_label_class]
+            rendered_item = @template_object.label(@object_name, sanitize_attribute_name(value), rendered_item, label_options)
+          end
+
           item_wrapper_tag ? @template_object.content_tag(item_wrapper_tag, rendered_item, class: item_wrapper_class) : rendered_item
         end.join.html_safe
       end
@@ -41,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
 
@@ -55,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.0.4".freeze
+  VERSION = "5.0.3".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
@@ -45,20 +46,20 @@ module SimpleForm
         @components = []
       end
 
-      def use(name, options=nil, &block)
+      def use(name, options = {})
         if options && wrapper = options[:wrap_with]
-          @components << Single.new(name, wrapper)
+          @components << Single.new(name, wrapper, options.except(:wrap_with))
         else
-          @components << name
+          @components << Leaf.new(name, options)
         end
       end
 
-      def optional(name, options=nil, &block)
+      def optional(name, options = {}, &block)
         @options[name] = false
-        use(name, options, &block)
+        use(name, options)
       end
 
-      def wrapper(name, options=nil)
+      def wrapper(name, options = nil)
         if block_given?
           name, options = nil, name if name.is_a?(Hash)
           builder = self.class.new(@options)

data/lib/simple_form/wrappers/leaf.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module SimpleForm
+  module Wrappers
+    class Leaf
+      attr_reader :namespace
+
+      def initialize(namespace, options = {})
+        @namespace = namespace
+        @options = options
+      end
+
+      def render(input)
+        method = input.method(@namespace)
+
+        if method.arity.zero?
+          ActiveSupport::Deprecation.warn(SimpleForm::CUSTOM_INPUT_DEPRECATION_WARN % { name: @namespace })
+
+          method.call
+        else
+          method.call(@options)
+        end
+      end
+
+      def find(name)
+        self if @namespace == name
+      end
+    end
+  end
+end

data/lib/simple_form/wrappers/many.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # A wrapper is an object that holds several components and render them.
-    # A component may either be a symbol or any object that responds to `render`.
+    # A component may be any object that responds to `render`.
     # This API allows inputs/components to be easily wrapped, removing the
     # need to modify the code only to wrap input in an extra tag.
     #
@@ -10,9 +11,8 @@ module SimpleForm
     # on demand on input generation.
     class Many
       attr_reader :namespace, :defaults, :components
-      alias :to_sym :namespace
 
-      def initialize(namespace, components, defaults={})
+      def initialize(namespace, components, defaults = {})
         @namespace  = namespace
         @components = components
         @defaults   = defaults
@@ -25,8 +25,8 @@ module SimpleForm
         options = input.options
 
         components.each do |component|
-          next if options[component] == false
-          rendered = component.respond_to?(:render) ? component.render(input) : input.send(component)
+          next if options[component.namespace] == false
+          rendered = component.render(input)
           content.safe_concat rendered.to_s if rendered
         end
 
@@ -51,6 +51,7 @@ module SimpleForm
 
       def wrap(input, options, content)
         return content if options[namespace] == false
+        return if defaults[:unless_blank] && content.empty?
 
         tag = (namespace && options[:"#{namespace}_tag"]) || @defaults[:tag]
         return content unless tag
@@ -62,7 +63,7 @@ module SimpleForm
       end
 
       def html_options(options)
-        options[:"#{namespace}_html"] || {}
+        (@defaults[:html] || {}).merge(options[:"#{namespace}_html"] || {})
       end
 
       def html_classes(input, options)

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
@@ -17,7 +18,7 @@ module SimpleForm
 
       # Provide a fallback if name cannot be found.
       def find(name)
-        super || SimpleForm::Wrappers::Many.new(name, [name])
+        super || SimpleForm::Wrappers::Many.new(name, [Leaf.new(name)])
       end
 
       private
@@ -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,15 +1,18 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     # `Single` is an optimization for a wrapper that has only one component.
     class Single < Many
-      def initialize(name, options={})
-        super(name, [name], options)
+      def initialize(name, wrapper_options = {}, options = {})
+        @component = Leaf.new(name, options)
+
+        super(name, [@component], wrapper_options)
       end
 
       def render(input)
         options = input.options
         if options[namespace] != false
-          content = input.send(namespace)
+          content = @component.render(input)
           wrap(input, options, content) if content
         end
       end
@@ -17,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,8 +1,10 @@
+# frozen_string_literal: true
 module SimpleForm
   module Wrappers
     autoload :Builder, 'simple_form/wrappers/builder'
     autoload :Many,    'simple_form/wrappers/many'
     autoload :Root,    'simple_form/wrappers/root'
     autoload :Single,  'simple_form/wrappers/single'
+    autoload :Leaf,    'simple_form/wrappers/leaf'
   end
 end

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'
@@ -24,6 +26,35 @@ module SimpleForm
     SimpleForm::Components.eager_load!
   end
 
+  CUSTOM_INPUT_DEPRECATION_WARN = <<-WARN
+%{name} method now accepts a `wrapper_options` argument. The method definition without the argument is deprecated and will be removed in the next Simple Form version. Change your code from:
+
+    def %{name}
+
+to
+
+    def %{name}(wrapper_options)
+
+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
+
+  def self.configured? #:nodoc:
+    @@configured
+  end
+
   ## CONFIGURATION OPTIONS
 
   # Method used to tidy up errors.
@@ -40,11 +71,11 @@ module SimpleForm
 
   # 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
@@ -66,7 +97,7 @@ module SimpleForm
 
   # How the label text should be generated altogether with the required text.
   mattr_accessor :label_text
-  @@label_text = lambda { |label, required| "#{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
@@ -78,13 +109,19 @@ module SimpleForm
   mattr_accessor :boolean_style
   @@boolean_style = :inline
 
-  # You can define the class to be used on all forms. Default is simple_form.
-  mattr_accessor :form_class
+  # DEPRECATED: You can define the class to be used on all forms. Default is
+  # simple_form.
+  mattr_reader :form_class
   @@form_class = :simple_form
 
+  # You can define the default class to be used on all forms. Can be overriden
+  # with `html: { :class }`. Defaults to none.
+  mattr_accessor :default_form_class
+  @@default_form_class = nil
+
   # 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
@@ -94,10 +131,6 @@ module SimpleForm
   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 }.
@@ -107,9 +140,19 @@ module SimpleForm
   # Custom wrappers for input types. This should be a hash containing an input
   # type as key and the wrapper that will be used for all inputs with specified type.
   # e.g { string: :string_wrapper, boolean: :boolean_wrapper }
+  # You can also set a wrapper mapping per form basis.
+  # e.g simple_form_for(@foo, wrapper_mappings: { check_boxes: :bootstrap_checkbox })
   mattr_accessor :wrapper_mappings
   @@wrapper_mappings = nil
 
+  # Namespaces where SimpleForm should look for custom input classes that override
+  # default inputs. Namespaces are given as string to allow lazy loading inputs.
+  # e.g. config.custom_inputs_namespaces << "CustomInputs"
+  #      will try to find CustomInputs::NumericInput when an :integer
+  #      field is called.
+  mattr_accessor :custom_inputs_namespaces
+  @@custom_inputs_namespaces = []
+
   # Default priority for time_zone inputs.
   mattr_accessor :time_zone_priority
   @@time_zone_priority = nil
@@ -118,10 +161,6 @@ module SimpleForm
   mattr_accessor :country_priority
   @@country_priority = nil
 
-  # DEPRECATED: Maximum size allowed for inputs.
-  mattr_accessor :default_input_size
-  @@default_input_size = nil
-
   # When off, do not use translations in labels. Disabling translation in
   # hints and placeholders can be done manually in the wrapper API.
   mattr_accessor :translate_labels
@@ -133,7 +172,7 @@ module SimpleForm
 
   # 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
@@ -151,15 +190,32 @@ module SimpleForm
   mattr_accessor :input_class
   @@input_class = nil
 
+  # Defines if an input wrapper class should be included or not
+  mattr_accessor :include_default_input_wrapper_class
+  @@include_default_input_wrapper_class = true
+
+  # Define the default class of the input wrapper of the boolean input.
+  mattr_accessor :boolean_label_class
+  @@boolean_label_class = 'checkbox'
+
   ## WRAPPER CONFIGURATION
   # The default wrapper to be used by the FormBuilder.
   mattr_accessor :default_wrapper
   @@default_wrapper = :default
-  @@wrappers = {}
+  @@wrappers = {} #:nodoc:
+
+  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_sym] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
+    @@wrappers[name.to_s] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
   end
 
   # Raised when fails to find a given wrapper name
@@ -172,25 +228,26 @@ module SimpleForm
     if block_given?
       options                 = args.extract_options!
       name                    = args.first || :default
-      @@wrappers[name.to_sym] = build(options, &block)
+      @@wrappers[name.to_s]   = build(options, &block)
     else
       @@wrappers
     end
   end
 
   # Builds a new wrapper using SimpleForm::Wrappers::Builder.
-  def self.build(options={})
+  def self.build(options = {})
     options[:tag] = :div if options[:tag].nil?
     builder = SimpleForm::Wrappers::Builder.new(options)
     yield builder
     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
     b.use :maxlength
+    b.use :minlength
     b.use :placeholder
     b.optional :pattern
     b.optional :readonly
@@ -210,11 +267,70 @@ module SimpleForm
     ActiveSupport::Deprecation.warn "[SIMPLE_FORM] SimpleForm.default_input_size= is deprecated and has no effect", caller
   end
 
-  # Default way to setup SimpleForm. Run rails generate simple_form:install
+  def self.form_class=(value)
+    ActiveSupport::Deprecation.warn "[SIMPLE_FORM] SimpleForm.form_class= is deprecated and will be removed in 4.x. Use SimpleForm.default_form_class= instead", caller
+    @@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)