simple_form 2.0.0 → 3.5.1

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'
@@ -6,14 +8,41 @@ require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/reverse_merge'
 
 module SimpleForm
-  autoload :Components,        'simple_form/components'
-  autoload :ErrorNotification, 'simple_form/error_notification'
-  autoload :FormBuilder,       'simple_form/form_builder'
-  autoload :Helpers,           'simple_form/helpers'
-  autoload :I18nCache,         'simple_form/i18n_cache'
-  autoload :Inputs,            'simple_form/inputs'
-  autoload :MapType,           'simple_form/map_type'
-  autoload :Wrappers,          'simple_form/wrappers'
+  extend ActiveSupport::Autoload
+
+  autoload :Helpers
+  autoload :Wrappers
+
+  eager_autoload do
+    autoload :Components
+    autoload :ErrorNotification
+    autoload :FormBuilder
+    autoload :Inputs
+  end
+
+  def self.eager_load!
+    super
+    SimpleForm::Inputs.eager_load!
+    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/plataformatec/simple_form/pull/997 for more information.
+  WARN
+
+  @@configured = false
+
+  def self.configured? #:nodoc:
+    @@configured
+  end
 
   ## CONFIGURATION OPTIONS
 
@@ -31,11 +60,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
@@ -46,7 +75,7 @@ module SimpleForm
   @@collection_wrapper_class = nil
 
   # You can wrap each item in a collection of radio/check boxes with a tag,
-  # defaulting to none. Please note that when using :boolean_style = :nested,
+  # defaulting to span. Please note that when using :boolean_style = :nested,
   # SimpleForm will force this option to be a :label.
   mattr_accessor :item_wrapper_tag
   @@item_wrapper_tag = :span
@@ -57,27 +86,33 @@ 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 use on all labels. Default is nil.
+  # You can define the class to be used on all labels. Defaults to none.
   mattr_accessor :label_class
   @@label_class = nil
 
   # Define the way to render check boxes / radio buttons with labels.
-  #   :inline => input + label (default)
-  #   :nested => label > input
+  #   inline: input + label (default)
+  #   nested: label > input
   mattr_accessor :boolean_style
   @@boolean_style = :inline
 
-  # You can define the class to use 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 which elements should obtain additional classes
+  # 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).
+  # Whether attributes are required by default or not.
   mattr_accessor :required_by_default
   @@required_by_default = true
 
@@ -87,7 +122,7 @@ module SimpleForm
 
   # Collection of methods to detect if a file type was given.
   mattr_accessor :file_methods
-  @@file_methods = [ :mounted_as, :file?, :public_filename ]
+  @@file_methods = %i[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
@@ -95,6 +130,22 @@ module SimpleForm
   mattr_accessor :input_mappings
   @@input_mappings = nil
 
+  # 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
@@ -103,10 +154,6 @@ module SimpleForm
   mattr_accessor :country_priority
   @@country_priority = nil
 
-  # Maximum size allowed for inputs.
-  mattr_accessor :default_input_size
-  @@default_input_size = 50
-
   # 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
@@ -116,23 +163,46 @@ module SimpleForm
   mattr_accessor :inputs_discovery
   @@inputs_discovery = true
 
-  # Cache SimpleForm inputs discovery
+  # 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
+  # Adds a class to each generated button, mostly for compatiblity.
   mattr_accessor :button_class
   @@button_class = 'button'
 
+  # Override the default ActiveModelHelper behaviour of wrapping the input.
+  # This gets taken care of semantically by adding an error class to the wrapper tag
+  # containing the input.
+  mattr_accessor :field_error_proc
+  @@field_error_proc = proc do |html_tag, instance_tag|
+    html_tag
+  end
+
+  # Adds a class to each generated inputs
+  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'
 
   # 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
@@ -145,71 +215,56 @@ 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 do |b|
     b.use :html5
 
     b.use :min_max
     b.use :maxlength
+    b.use :minlength
     b.use :placeholder
     b.optional :pattern
     b.optional :readonly
 
     b.use :label_input
-    b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
-    b.use :error, :wrap_with => { :tag => :span, :class => :error }
-  end
-
-  ## SETUP
-
-  DEPRECATED = %w(hint_tag hint_class error_tag error_class error_notification_id wrapper_tag wrapper_class wrapper_error_class components html5)
-  @@deprecated = []
-
-  DEPRECATED.each do |method|
-    class_eval "def self.#{method}=(*); @@deprecated << :#{method}=; end"
-    class_eval "def self.#{method}; deprecation_warn 'SimpleForm.#{method} is deprecated and has no effect'; end"
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
   end
 
-  def self.translate=(value)
-    deprecation_warn "SimpleForm.translate= is disabled in favor of translate_labels="
-    self.translate_labels = value
+  def self.additional_classes_for(component)
+    generate_additional_classes_for.include?(component) ? yield : []
   end
 
-  def self.translate
-    deprecation_warn "SimpleForm.translate is disabled in favor of translate_labels"
-    self.translate_labels
-  end
+  ## SETUP
 
-  def self.deprecation_warn(message)
-    ActiveSupport::Deprecation.warn "[SIMPLE_FORM] #{message}", caller
+  def self.default_input_size=(*)
+    ActiveSupport::Deprecation.warn "[SIMPLE_FORM] SimpleForm.default_input_size= is deprecated and has no effect", caller
   end
 
-  def self.additional_classes_for(component)
-    generate_additional_classes_for.include?(component) ? yield : []
+  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
 
-  # Default way to setup SimpleForm. Run rails generate simple_form:install
+  # 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
-
-    unless @@deprecated.empty?
-      raise "[SIMPLE FORM] Your SimpleForm initializer file is using the following methods: #{@@deprecated.to_sentence}. " <<
-        "Those methods are part of the outdated configuration API. Updating to the new API is easy and fast. " <<
-        "Check for more info here: https://github.com/plataformatec/simple_form/wiki/Upgrading-to-Simple-Form-2.0"
-    end
   end
 end
+
+require 'simple_form/railtie' if defined?(Rails)