simple_form 3.0.4 → 5.0.3

data/lib/generators/simple_form/templates/config/initializers/simple_form_foundation.rb

@@ -1,26 +1,122 @@
+# frozen_string_literal: true
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/heartcombo/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
 # Use this setup block to configure all options available in SimpleForm.
 SimpleForm.setup do |config|
-  config.wrappers :foundation, class: :input, hint_class: :field_with_hint, error_class: :error do |b|
+  # Don't forget to edit this file to adapt it to your needs (specially
+  # all the grid-related classes)
+  #
+  # Please note that hints are commented out by default since Foundation
+  # doesn't provide styles for hints. You will need to provide your own CSS styles for hints.
+  # Uncomment them to enable hints.
+
+  config.wrappers :vertical_form, class: :input, hint_class: :field_with_hint, error_class: :error, valid_class: :valid do |b|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
     b.use :label_input
-    b.use :error, wrap_with: { tag: :small }
+    b.use :error, wrap_with: { tag: :small, class: :error }
 
-    # Uncomment the following line to enable hints. The line is commented out by default since Foundation
-    # does't provide styles for hints. You will need to provide your own CSS styles for hints.
+    # b.use :hint,  wrap_with: { tag: :span, class: :hint }
+  end
+
+  config.wrappers :horizontal_form, tag: 'div', class: 'row', hint_class: :field_with_hint, error_class: :error, valid_class: :valid do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :minlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+
+    b.wrapper :label_wrapper, tag: :div, class: 'small-3 columns' do |ba|
+      ba.use :label, class: 'text-right inline'
+    end
+
+    b.wrapper :right_input_wrapper, tag: :div, class: 'small-9 columns' do |ba|
+      ba.use :input
+      ba.use :error, wrap_with: { tag: :small, class: :error }
+      # ba.use :hint,  wrap_with: { tag: :span, class: :hint }
+    end
+  end
+
+  config.wrappers :horizontal_radio_and_checkboxes, tag: 'div', class: 'row' do |b|
+    b.use :html5
+    b.optional :readonly
+
+    b.wrapper :container_wrapper, tag: 'div', class: 'small-offset-3 small-9 columns' do |ba|
+      ba.wrapper tag: 'label', class: 'checkbox' do |bb|
+        bb.use :input
+        bb.use :label_text
+      end
+
+      ba.use :error, wrap_with: { tag: :small, class: :error }
+      # ba.use :hint,  wrap_with: { tag: :span, class: :hint }
+    end
+  end
+
+  # Foundation does not provide a way to handle inline forms
+  # This wrapper can be used to create an inline form
+  # by hiding that labels on every screen sizes ('hidden-for-small-up').
+  #
+  # Note that you need to adapt this wrapper to your needs. If you need a 4
+  # columns form then change the wrapper class to 'small-3', if you need
+  # only two use 'small-6' and so on.
+  config.wrappers :inline_form, tag: 'div', class: 'column small-4', hint_class: :field_with_hint, error_class: :error, valid_class: :valid do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :minlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+
+    b.use :label, class: 'hidden-for-small-up'
+    b.use :input
+
+    b.use :error, wrap_with: { tag: :small, class: :error }
+    # b.use :hint,  wrap_with: { tag: :span, class: :hint }
+  end
+
+  # Examples of use:
+  # - wrapper_html: {class: 'row'}, custom_wrapper_html: {class: 'column small-12'}
+  # - custom_wrapper_html: {class: 'column small-3 end'}
+  config.wrappers :customizable_wrapper, tag: 'div', error_class: :error, valid_class: :valid do |b|
+    b.use :html5
+    b.optional :readonly
+
+    b.wrapper :custom_wrapper, tag: :div do |ba|
+      ba.use :label_input
+    end
+
+    b.use :error, wrap_with: { tag: :small, class: :error }
     # b.use :hint,  wrap_with: { tag: :span, class: :hint }
   end
 
   # CSS class for buttons
   config.button_class = 'button'
 
+  # Set this to div to make the checkbox and radio properly work
+  # otherwise simple_form adds a label tag instead of a div around
+  # the nested label
+  config.item_wrapper_tag = :div
+
   # CSS class to add for error notification helper.
   config.error_notification_class = 'alert-box alert'
 
   # The default wrapper to be used by the FormBuilder.
-  config.default_wrapper = :foundation
+  config.default_wrapper = :vertical_form
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
 end

data/lib/generators/simple_form/templates/config/locales/simple_form.en.yml

@@ -10,7 +10,7 @@ en:
       # html: '<abbr title="required">*</abbr>'
     error_notification:
       default_message: "Please review the problems below:"
-    # Labels and hints examples
+    # Examples
     # labels:
     #   defaults:
     #     password: 'Password'
@@ -23,4 +23,9 @@ en:
     #   defaults:
     #     username: 'User name to sign in.'
     #     password: 'No special characters, please.'
-
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

data/lib/simple_form/action_view_extensions/builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module ActionViewExtensions
     # A collection of methods required by simple_form but added to rails default form.
@@ -17,6 +18,7 @@ module SimpleForm
         options = args.extract_options!
         options[:wrapper] = self.options[:wrapper] if options[:wrapper].nil?
         options[:defaults] ||= self.options[:defaults]
+        options[:wrapper_mappings] ||= self.options[:wrapper_mappings]
 
         if self.class < ActionView::Helpers::FormBuilder
           options[:builder] ||= self.class

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module ActionViewExtensions
     # This module creates SimpleForm wrappers around default form_for and fields_for.
@@ -10,13 +11,17 @@ module SimpleForm
     #
     module FormHelper
 
-      def simple_form_for(record, options={}, &block)
+      def simple_form_for(record, options = {}, &block)
         options[:builder] ||= SimpleForm::FormBuilder
         options[:html] ||= {}
         unless options[:html].key?(:novalidate)
           options[:html][:novalidate] = !SimpleForm.browser_validations
         end
-        options[:html][:class] = [SimpleForm.form_class, simple_form_css_class(record, options)].compact.join(" ")
+        if options[:html].key?(:class)
+          options[:html][:class] = [SimpleForm.form_class, options[:html][:class]].compact
+        else
+          options[:html][:class] = [SimpleForm.form_class, SimpleForm.default_form_class, simple_form_css_class(record, options)].compact
+        end
 
         with_simple_form_field_error_proc do
           form_for(record, options, &block)
@@ -62,4 +67,6 @@ module SimpleForm
   end
 end
 
-ActionView::Base.send :include, SimpleForm::ActionViewExtensions::FormHelper
+ActiveSupport.on_load(:action_view) do
+  include SimpleForm::ActionViewExtensions::FormHelper
+end

data/lib/simple_form/components/errors.rb

@@ -1,22 +1,43 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module Errors
-      def error
+      def error(wrapper_options = nil)
         error_text if has_errors?
       end
 
+      def full_error(wrapper_options = nil)
+        full_error_text if options[:error] != false && has_errors?
+      end
+
       def has_errors?
-        object && object.respond_to?(:errors) && errors.present?
+        object_with_errors? || object.nil? && has_custom_error?
+      end
+
+      def has_value?
+        object && object.respond_to?(attribute_name) && object.send(attribute_name).present?
+      end
+
+      def valid?
+        !has_errors? && has_value?
       end
 
       protected
 
       def error_text
-        text = has_error_in_options? ? options[:error] : errors.send(error_method)
+        text = has_custom_error? ? options[:error] : errors.send(error_method)
 
         "#{html_escape(options[:error_prefix])} #{html_escape(text)}".lstrip.html_safe
       end
 
+      def full_error_text
+        has_custom_error? ? options[:error] : full_errors.send(error_method)
+      end
+
+      def object_with_errors?
+        object && object.respond_to?(:errors) && errors.present?
+      end
+
       def error_method
         options[:error_method] || SimpleForm.error_method
       end
@@ -25,16 +46,28 @@ module SimpleForm
         @errors ||= (errors_on_attribute + errors_on_association).compact
       end
 
+      def full_errors
+        @full_errors ||= (full_errors_on_attribute + full_errors_on_association).compact
+      end
+
       def errors_on_attribute
-        object.errors[attribute_name]
+        object.errors[attribute_name] || []
+      end
+
+      def full_errors_on_attribute
+        object.errors.full_messages_for(attribute_name)
       end
 
       def errors_on_association
         reflection ? object.errors[reflection.name] : []
       end
 
-      def has_error_in_options?
-        options[:error] && !options[:error].nil?
+      def full_errors_on_association
+        reflection ? object.errors.full_messages_for(reflection.name) : []
+      end
+
+      def has_custom_error?
+        options[:error].is_a?(String)
       end
     end
   end

data/lib/simple_form/components/hints.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
     module Hints
-      def hint
+      def hint(wrapper_options = nil)
         @hint ||= begin
           hint = options[:hint]
 
           if hint.is_a?(String)
             html_escape(hint)
           else
-            content = translate(:hints)
+            content = translate_from_namespace(:hints)
             content.html_safe if content
           end
         end

data/lib/simple_form/components/html5.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module HTML5
@@ -5,12 +6,14 @@ module SimpleForm
         @html5 = false
       end
 
-      def html5
+      def html5(wrapper_options = nil)
         @html5 = true
-        if has_required?
-          input_html_options[:required] = true
-          input_html_options[:'aria-required'] = true
-        end
+
+        input_html_options[:required]        = input_html_required_option
+        input_html_options[:'aria-required'] = input_html_aria_required_option
+
+        input_html_options[:'aria-invalid']  = has_errors? || nil
+
         nil
       end
 
@@ -18,6 +21,14 @@ module SimpleForm
         @html5
       end
 
+      def input_html_required_option
+        !options[:required].nil? ? required_field? : has_required?
+      end
+
+      def input_html_aria_required_option
+        !options[:required].nil? ? (required_field? || nil) : (has_required? || nil)
+      end
+
       def has_required?
         # We need to check browser_validations because
         # some browsers are still checking required even

data/lib/simple_form/components/label_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module LabelInput
@@ -7,8 +8,26 @@ module SimpleForm
         include SimpleForm::Components::Labels
       end
 
-      def label_input
-        options[:label] == false ? input : (label + input)
+      def label_input(wrapper_options = nil)
+        if options[:label] == false
+          deprecated_component(:input, wrapper_options)
+        else
+          deprecated_component(:label, wrapper_options) + deprecated_component(:input, wrapper_options)
+        end
+      end
+
+      private
+
+      def deprecated_component(namespace, wrapper_options)
+        method = method(namespace)
+
+        if method.arity.zero?
+          ActiveSupport::Deprecation.warn(SimpleForm::CUSTOM_INPUT_DEPRECATION_WARN % { name: namespace })
+
+          method.call
+        else
+          method.call(wrapper_options)
+        end
       end
     end
   end

data/lib/simple_form/components/labels.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module Labels
@@ -6,31 +7,40 @@ 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
 
-      def label
+      def label(wrapper_options = nil)
+        label_options = merge_wrapper_options(label_html_options, wrapper_options)
+
         if generate_label_for_attribute?
-          @builder.label(label_target, label_text, label_html_options)
+          @builder.label(label_target, label_text, label_options)
         else
-          template.label_tag(nil, label_text, label_html_options)
+          template.label_tag(nil, label_text, label_options)
         end
       end
 
-      def label_text
-        SimpleForm.label_text.call(html_escape(raw_label_text), required_label_text).strip.html_safe
+      def label_text(wrapper_options = nil)
+        label_text = options[:label_text] || SimpleForm.label_text
+        label_text.call(html_escape(raw_label_text), required_label_text, options[:label].present?).strip.html_safe
       end
 
       def label_target
@@ -39,13 +49,14 @@ module SimpleForm
 
       def label_html_options
         label_html_classes = SimpleForm.additional_classes_for(:label) {
-          [input_type, required_class, SimpleForm.label_class].compact
+          [input_type, required_class, disabled_class, SimpleForm.label_class].compact
         }
 
         label_options = html_options_for(:label, label_html_classes)
         if options.key?(:input_html) && options[:input_html].key?(:id)
           label_options[:for] = options[:input_html][:id]
         end
+
         label_options
       end
 
@@ -62,7 +73,7 @@ module SimpleForm
 
       # First check labels translation and then human attribute name.
       def label_translation #:nodoc:
-        if SimpleForm.translate_labels && (translated_label = translate(:labels))
+        if SimpleForm.translate_labels && (translated_label = translate_from_namespace(:labels))
           translated_label
         elsif object.class.respond_to?(:human_attribute_name)
           object.class.human_attribute_name(reflection_or_attribute_name.to_s)

data/lib/simple_form/components/maxlength.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
     module Maxlength
-      def maxlength
+      def maxlength(wrapper_options = nil)
         input_html_options[:maxlength] ||= maximum_length_from_validation || limit
         nil
       end
@@ -15,10 +16,7 @@ module SimpleForm
           maxlength
         else
           length_validator = find_length_validator
-
-          if length_validator && !has_tokenizer?(length_validator)
-            length_validator.options[:is] || length_validator.options[:maximum]
-          end
+          maximum_length_value_from(length_validator)
         end
       end
 
@@ -29,6 +27,12 @@ module SimpleForm
       def has_tokenizer?(length_validator)
         length_validator.options[:tokenizer]
       end
+
+      def maximum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:maximum]
+        end
+      end
     end
   end
 end

data/lib/simple_form/components/min_max.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module MinMax
-      def min_max
+      def min_max(wrapper_options = nil)
         if numeric_validator = find_numericality_validator
           validator_options = numeric_validator.options
           input_html_options[:min] ||= minimum_value(validator_options)

data/lib/simple_form/components/minlength.rb

@@ -0,0 +1,38 @@
+# 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
+        nil
+      end
+
+      private
+
+      def minimum_length_from_validation
+        minlength = options[:minlength]
+        if minlength.is_a?(String) || minlength.is_a?(Integer)
+          minlength
+        else
+          length_validator = find_length_validator
+          minimum_length_value_from(length_validator)
+        end
+      end
+
+      def find_length_validator
+        find_validator(:length)
+      end
+
+      def has_tokenizer?(length_validator)
+        length_validator.options[:tokenizer]
+      end
+
+      def minimum_length_value_from(length_validator)
+        if length_validator
+          length_validator.options[:is] || length_validator.options[:minimum]
+        end
+      end
+    end
+  end
+end

data/lib/simple_form/components/pattern.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
     module Pattern
-      def pattern
+      def pattern(wrapper_options = nil)
         input_html_options[:pattern] ||= pattern_source
         nil
       end

data/lib/simple_form/components/placeholders.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
     module Placeholders
-      def placeholder
+      def placeholder(wrapper_options = nil)
         input_html_options[:placeholder] ||= placeholder_text
         nil
       end
 
-      def placeholder_text
+      def placeholder_text(wrapper_options = nil)
         placeholder = options[:placeholder]
-        placeholder.is_a?(String) ? placeholder : translate(:placeholders)
+        placeholder.is_a?(String) ? placeholder : translate_from_namespace(:placeholders)
       end
     end
   end

data/lib/simple_form/components/readonly.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     # Needs to be enabled in order to do automatic lookups.
     module Readonly
-      def readonly
+      def readonly(wrapper_options = nil)
         if readonly_attribute? && !has_readonly?
           input_html_options[:readonly] ||= true
           input_html_classes << :readonly

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
@@ -15,6 +16,7 @@ module SimpleForm
     autoload :Labels
     autoload :MinMax
     autoload :Maxlength
+    autoload :Minlength
     autoload :Pattern
     autoload :Placeholders
     autoload :Readonly

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