simple_form 2.1.0 → 3.2.0

data/lib/simple_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleForm
-  VERSION = "2.1.0".freeze
+  VERSION = "3.2.0".freeze
 end

data/lib/simple_form/wrappers/builder.rb

@@ -12,18 +12,18 @@ module SimpleForm
     #       b.optional :placeholder
     #
     #       # Use a component with specific wrapper options
-    #       b.use :error, :wrap_with => { :tag => "span", :class => "error" }
+    #       b.use :error, wrap_with: { tag: "span", class: "error" }
     #
     #       # Use a set of components by wrapping them in a tag+class.
-    #       b.wrapper :tag => "div", :class => "another" do |ba|
+    #       b.wrapper tag: "div", class: "another" do |ba|
     #         ba.use :label
     #         ba.use :input
     #       end
     #
     #       # Use a set of components by wrapping them in a tag+class.
     #       # This wrapper is identified by :label_input, which means it can
-    #       # be turned off on demand with `f.input :name, :label_input => false`
-    #       b.wrapper :label_input, :tag => "div", :class => "another" do |ba|
+    #       # be turned off on demand with `f.input :name, label_input: false`
+    #       b.wrapper :label_input, tag: "div", class: "another" do |ba|
     #         ba.use :label
     #         ba.use :input
     #       end
@@ -32,7 +32,7 @@ module SimpleForm
     # The builder also accepts default options at the root level. This is usually
     # used if you want a component to be disabled by default:
     #
-    #     config.wrappers :hint => false do |b|
+    #     config.wrappers hint: false do |b|
     #       b.use :hint
     #       b.use :label_input
     #     end
@@ -45,44 +45,20 @@ module SimpleForm
         @components = []
       end
 
-      def use(name, options=nil, &block)
-        if block_given?
-          ActiveSupport::Deprecation.warn "Passing a block to use is deprecated. " \
-            "Please use wrapper instead of use."
-          return wrapper(name, options, &block)
-        end
-
-        if options && options.keys != [:wrap_with]
-          ActiveSupport::Deprecation.warn "Passing :tag, :class and others to use is deprecated. " \
-            "Please invoke b.use #{name.inspect}, :wrap_with => #{options.inspect} instead."
-          options = { :wrap_with => options }
-        end
-
+      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)
-        if block_given?
-          ActiveSupport::Deprecation.warn "Passing a block to optional is deprecated. " \
-            "Please use wrapper instead of optional."
-          return wrapper(name, options, &block)
-        end
-
-        if options && options.keys != [:wrap_with]
-          ActiveSupport::Deprecation.warn "Passing :tag, :class and others to optional is deprecated. " \
-            "Please invoke b.optional #{name.inspect}, :wrap_with => #{options.inspect} instead."
-          options = { :wrap_with => options }
-        end
-
+      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,28 @@
+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 == 0
+          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,7 @@
 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,14 +10,13 @@ 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
         @defaults[:tag]   = :div unless @defaults.key?(:tag)
-        @defaults[:class] = Array.wrap(@defaults[:class])
+        @defaults[:class] = Array(@defaults[:class])
       end
 
       def render(input)
@@ -25,8 +24,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 +50,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 +62,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

@@ -17,13 +17,13 @@ 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
 
       def html_classes(input, options)
-        css = options[:wrapper_class] ? Array.wrap(options[:wrapper_class]) : @defaults[:class]
+        css = options[:wrapper_class] ? Array(options[:wrapper_class]) : @defaults[:class]
         css += SimpleForm.additional_classes_for(:wrapper) do
           input.additional_classes + [input.input_class]
         end

data/lib/simple_form/wrappers/single.rb

@@ -2,14 +2,16 @@ 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

data/lib/simple_form/wrappers.rb

@@ -4,5 +4,6 @@ module SimpleForm
     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
+end

data/lib/simple_form.rb

@@ -18,6 +18,30 @@ module SimpleForm
     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
 
   # Method used to tidy up errors.
@@ -34,11 +58,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 = [: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 = [: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
@@ -49,7 +73,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
@@ -60,27 +84,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 = lambda { |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]
 
-  # 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
 
@@ -90,7 +120,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 = [: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
@@ -100,10 +130,20 @@ 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 }
+  # 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
@@ -112,9 +152,9 @@ module SimpleForm
   mattr_accessor :country_priority
   @@country_priority = nil
 
-  # Maximum size allowed for inputs.
+  # DEPRECATED: Maximum size allowed for inputs.
   mattr_accessor :default_input_size
-  @@default_input_size = 50
+  @@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.
@@ -125,23 +165,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?
 
-  # 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
@@ -154,21 +217,21 @@ 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
@@ -178,47 +241,31 @@ module SimpleForm
     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)