simple_form 2.0.0 → 3.5.1

data/lib/simple_form/action_view_extensions/builder.rb

@@ -1,187 +1,9 @@
+# frozen_string_literal: true
 module SimpleForm
   module ActionViewExtensions
-    # Base builder to handle each instance of a collection of radio buttons / check boxes.
-    # Based on (at this time upcoming) Rails 4 collection builders.
-    class BuilderBase #:nodoc:
-      attr_reader :object, :text, :value
-
-      def initialize(template_object, object_name, method_name, object,
-                     sanitized_attribute_name, text, value, input_html_options)
-        @template_object = template_object
-        @object_name = object_name
-        @method_name = method_name
-        @object = object
-        @sanitized_attribute_name = sanitized_attribute_name
-        @text = text
-        @value = value
-        @input_html_options = input_html_options
-      end
-
-      def label(label_html_options={}, &block)
-        @template_object.label(@object_name, @sanitized_attribute_name, @text, label_html_options, &block)
-      end
-    end
-
-    # Handles generating an instance of radio + label for collection_radio_buttons.
-    class RadioButtonBuilder < BuilderBase #:nodoc:
-      def radio_button(extra_html_options={})
-        html_options = extra_html_options.merge(@input_html_options)
-        @template_object.radio_button(@object_name, @method_name, @value, html_options)
-      end
-    end
-
-    # Handles generating an instance of check box + label for collection_check_boxes.
-    class CheckBoxBuilder < BuilderBase #:nodoc:
-      def check_box(extra_html_options={})
-        html_options = extra_html_options.merge(@input_html_options)
-        @template_object.check_box(@object_name, @method_name, html_options, @value, nil)
-      end
-    end
-
     # A collection of methods required by simple_form but added to rails default form.
     # This means that you can use such methods outside simple_form context.
     module Builder
-      # Create a collection of radio inputs for the attribute. Basically this
-      # helper will create a radio input associated with a label for each
-      # text/value option in the collection, using value_method and text_method
-      # to convert these text/value. You can give a symbol or a proc to both
-      # value_method and text_method, that will be evaluated for each item in
-      # the collection.
-      #
-      # == Examples
-      #
-      #   form_for @user do |f|
-      #     f.collection_radio_buttons :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #   end
-      #
-      #   <input id="user_options_true" name="user[options]" type="radio" value="true" />
-      #   <label class="collection_radio_buttons" for="user_options_true">Yes</label>
-      #   <input id="user_options_false" name="user[options]" type="radio" value="false" />
-      #   <label class="collection_radio_buttons" for="user_options_false">No</label>
-      #
-      # It is also possible to give a block that should generate the radio +
-      # label. To wrap the radio with the label, for instance:
-      #
-      #   form_for @user do |f|
-      #     f.collection_radio_buttons(
-      #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #     ) do |b|
-      #       b.label { b.radio_button + b.text }
-      #     end
-      #   end
-      #
-      # == Options
-      #
-      # Collection radio accepts some extra options:
-      #
-      #   * checked  => the value that should be checked initially.
-      #
-      #   * disabled => the value or values that should be disabled. Accepts a single
-      #                 item or an array of items.
-      #
-      #   * collection_wrapper_tag   => the tag to wrap the entire collection.
-      #
-      #   * collection_wrapper_class => the CSS class to use for collection_wrapper_tag
-      #
-      #   * item_wrapper_tag         => the tag to wrap each item in the collection.
-      #
-      #   * item_wrapper_class       => the CSS class to use for item_wrapper_tag
-      #
-      #   * a block                  => to generate the label + radio or any other component.
-      #
-      def collection_radio_buttons(attribute, collection, value_method, text_method, options={}, html_options={})
-        rendered_collection = render_collection(
-          collection, value_method, text_method, options, html_options
-        ) do |item, value, text, default_html_options|
-          builder = instantiate_builder(RadioButtonBuilder, attribute, item, value, text, default_html_options)
-
-          if block_given?
-            yield builder
-          else
-            builder.radio_button + builder.label(:class => "collection_radio_buttons")
-          end
-        end
-
-        wrap_rendered_collection(rendered_collection, options)
-      end
-
-      # deprecated
-      def collection_radio(*args, &block)
-        SimpleForm.deprecation_warn "The `collection_radio` helper is deprecated, " \
-          "please use `collection_radio_buttons` instead."
-        collection_radio_buttons(*args, &block)
-      end
-
-      # Creates a collection of check boxes for each item in the collection,
-      # associated with a clickable label. Use value_method and text_method to
-      # convert items in the collection for use as text/value in check boxes.
-      # You can give a symbol or a proc to both value_method and text_method,
-      # that will be evaluated for each item in the collection.
-      #
-      # == Examples
-      #
-      #   form_for @user do |f|
-      #     f.collection_check_boxes :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #   end
-      #
-      #   <input name="user[options][]" type="hidden" value="" />
-      #   <input id="user_options_true" name="user[options][]" type="checkbox" value="true" />
-      #   <label class="collection_check_boxes" for="user_options_true">Yes</label>
-      #   <input name="user[options][]" type="hidden" value="" />
-      #   <input id="user_options_false" name="user[options][]" type="checkbox" value="false" />
-      #   <label class="collection_check_boxes" for="user_options_false">No</label>
-      #
-      # It is also possible to give a block that should generate the check box +
-      # label. To wrap the check box with the label, for instance:
-      #
-      #   form_for @user do |f|
-      #     f.collection_check_boxes(
-      #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #     ) do |b|
-      #       b.label { b.check_box + b.text }
-      #     end
-      #   end
-      #
-      # == Options
-      #
-      # Collection check box accepts some extra options:
-      #
-      #   * checked  => the value or values that should be checked initially. Accepts
-      #                 a single item or an array of items. It overrides existing associations.
-      #
-      #   * disabled => the value or values that should be disabled. Accepts a single
-      #                 item or an array of items.
-      #
-      #   * collection_wrapper_tag   => the tag to wrap the entire collection.
-      #
-      #   * collection_wrapper_class => the CSS class to use for collection_wrapper_tag
-      #
-      #   * item_wrapper_tag         => the tag to wrap each item in the collection.
-      #
-      #   * item_wrapper_class       => the CSS class to use for item_wrapper_tag
-      #
-      #   * a block                  => to generate the label + check box or any other component.
-      #
-      def collection_check_boxes(attribute, collection, value_method, text_method, options={}, html_options={})
-        rendered_collection = render_collection(
-          collection, value_method, text_method, options, html_options
-        ) do |item, value, text, default_html_options|
-          default_html_options[:multiple] = true
-          builder = instantiate_builder(CheckBoxBuilder, attribute, item, value, text, default_html_options)
-
-          if block_given?
-            yield builder
-          else
-            builder.check_box + builder.label(:class => "collection_check_boxes")
-          end
-        end
-
-        # Append a hidden field to make sure something will be sent back to the
-        # server if all checkboxes are unchecked.
-        hidden = template.hidden_field_tag("#{object_name}[#{attribute}][]", "", :id => nil)
-
-        wrap_rendered_collection(rendered_collection + hidden, options)
-      end
 
       # Wrapper for using SimpleForm inside a default rails form.
       # Example:
@@ -194,79 +16,16 @@ module SimpleForm
       #   end
       def simple_fields_for(*args, &block)
         options = args.extract_options!
-        options[:wrapper] ||= self.options[:wrapper]
+        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
         else
           options[:builder] ||= SimpleForm::FormBuilder
         end
-        fields_for(*(args << options), &block)
-      end
-
-      private
-
-      def instantiate_builder(builder_class, attribute, item, value, text, html_options)
-        builder_class.new(@template, object_name, attribute, item,
-                          sanitize_attribute_name(attribute, value), text, value, html_options)
-      end
-
-      # Generate default options for collection helpers, such as :checked and
-      # :disabled.
-      def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
-        html_options = html_options.dup
-
-        [:checked, :selected, :disabled].each do |option|
-          next unless current_option = options[option]
-
-          accept = if current_option.respond_to?(:call)
-            current_option.call(item)
-          else
-            Array(current_option).include?(value)
-          end
-
-          if accept
-            html_options[option] = true
-          elsif option == :checked
-            html_options[option] = false
-          end
-        end
-
-        html_options
-      end
-
-      def sanitize_attribute_name(attribute, value) #:nodoc:
-        "#{attribute}_#{value.to_s.gsub(/\s/, "_").gsub(/[^-\w]/, "").downcase}"
-      end
-
-      def render_collection(collection, value_method, text_method, options={}, html_options={}) #:nodoc:
-        item_wrapper_tag   = options.fetch(:item_wrapper_tag, :span)
-        item_wrapper_class = options[:item_wrapper_class]
-
-        collection.map do |item|
-          value = value_for_collection(item, value_method)
-          text  = value_for_collection(item, text_method)
-          default_html_options = default_html_options_for_collection(item, value, options, html_options)
-
-          rendered_item = yield item, value, text, default_html_options
-
-          item_wrapper_tag ? @template.content_tag(item_wrapper_tag, rendered_item, :class => item_wrapper_class) : rendered_item
-        end.join.html_safe
-      end
-
-      def value_for_collection(item, value) #:nodoc:
-        value.respond_to?(:call) ? value.call(item) : item.send(value)
-      end
-
-      def wrap_rendered_collection(collection, options)
-        wrapper_tag = options[:collection_wrapper_tag]
-
-        if wrapper_tag
-          wrapper_class = options[:collection_wrapper_class]
-          @template.content_tag(wrapper_tag, collection, :class => wrapper_class)
-        else
-          collection
-        end
+        fields_for(*args, options, &block)
       end
     end
   end
@@ -275,64 +34,5 @@ end
 module ActionView::Helpers
   class FormBuilder
     include SimpleForm::ActionViewExtensions::Builder
-
-    # Override default Rails collection_select helper to handle lambdas/procs in
-    # text and value methods, so it works the same way as collection_radio_buttons
-    # and collection_check_boxes in SimpleForm. If none of text/value methods is a
-    # callable object, then it just delegates back to original collection select.
-    #
-    alias :original_collection_select :collection_select
-    def collection_select(attribute, collection, value_method, text_method, options={}, html_options={})
-      if value_method.respond_to?(:call) || text_method.respond_to?(:call)
-        collection = collection.map do |item|
-          value = value_for_collection(item, value_method)
-          text  = value_for_collection(item, text_method)
-
-          default_html_options = default_html_options_for_collection(item, value, options, html_options)
-          disabled = value if default_html_options[:disabled]
-          selected = value if default_html_options[:selected]
-
-          [value, text, selected, disabled]
-        end
-
-        [:disabled, :selected].each do |option|
-          option_value    = collection.map(&:pop).compact
-          options[option] = option_value if option_value.present?
-        end
-        value_method, text_method = :first, :last
-      end
-
-      original_collection_select(attribute, collection, value_method, text_method, options, html_options)
-    end
-  end
-
-  # Backport Rails fix to checkbox tag element, which does not generate the
-  # hidden input when given nil as unchecked value. This is to make SimpleForm
-  # collection check boxes helper to work fine with nested boolean style, when
-  # they are wrapped in labels. Without that, clicking in the label would
-  # actually change the hidden input, instead of the checkbox.
-  # FIXME: remove when support only Rails >= 3.2.2.
-  class InstanceTag
-    def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
-      options = options.stringify_keys
-      options["type"]     = "checkbox"
-      options["value"]    = checked_value
-      if options.has_key?("checked")
-        cv = options.delete "checked"
-        checked = cv == true || cv == "checked"
-      else
-        checked = self.class.check_box_checked?(value(object), checked_value)
-      end
-      options["checked"] = "checked" if checked
-      if options["multiple"]
-        add_default_name_and_id_for_value(checked_value, options)
-        options.delete("multiple")
-      else
-        add_default_name_and_id(options)
-      end
-      hidden = unchecked_value ? tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value, "disabled" => options["disabled"]) : "".html_safe
-      checkbox = tag("input", options)
-      hidden + checkbox
-    end
   end
 end

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.
@@ -5,29 +6,22 @@ module SimpleForm
     # Example:
     #
     #   simple_form_for @user do |f|
-    #     f.input :name, :hint => 'My hint'
+    #     f.input :name, hint: 'My hint'
     #   end
     #
     module FormHelper
-      # based on what is done in formtastic
-      # http://github.com/justinfrench/formtastic/blob/master/lib/formtastic.rb#L1706
-      @@default_field_error_proc = nil
 
-      # Override the default ActiveRecordHelper behaviour of wrapping the input.
-      # This gets taken care of semantically by adding an error class to the wrapper tag
-      # containing the input.
-      #
-      FIELD_ERROR_PROC = proc do |html_tag, instance_tag|
-        html_tag
-      end
-
-      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)
@@ -46,11 +40,13 @@ module SimpleForm
       private
 
       def with_simple_form_field_error_proc
-        @@default_field_error_proc = ::ActionView::Base.field_error_proc
-        ::ActionView::Base.field_error_proc = FIELD_ERROR_PROC
-        result = yield
-        ::ActionView::Base.field_error_proc = @@default_field_error_proc
-        result
+        default_field_error_proc = ::ActionView::Base.field_error_proc
+        begin
+          ::ActionView::Base.field_error_proc = SimpleForm.field_error_proc
+          yield
+        ensure
+          ::ActionView::Base.field_error_proc = default_field_error_proc
+        end
       end
 
       def simple_form_css_class(record, options)
@@ -71,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,10 +1,15 @@
+# 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?
       end
@@ -12,7 +17,13 @@ module SimpleForm
       protected
 
       def error_text
-        "#{options[:error_prefix]} #{errors.send(error_method)}".lstrip.html_safe
+        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 error_method
@@ -23,13 +34,29 @@ 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 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
 end

data/lib/simple_form/components/hints.rb

@@ -1,16 +1,23 @@
+# 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]
-          hint.is_a?(String) ? hint : translate(:hints)
+
+          if hint.is_a?(String)
+            html_escape(hint)
+          else
+            content = translate_from_namespace(:hints)
+            content.html_safe if content
+          end
         end
       end
 
       def has_hint?
-        hint.present?
+        options[:hint] != false && hint.present?
       end
     end
   end

data/lib/simple_form/components/html5.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Components
     module HTML5
@@ -5,9 +6,14 @@ module SimpleForm
         @html5 = false
       end
 
-      def html5
+      def html5(wrapper_options = nil)
         @html5 = true
-        input_html_options[:required] = true if has_required?
+
+        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
 
@@ -15,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
@@ -23,4 +37,4 @@ module SimpleForm
       end
     end
   end
-end
+end

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 ? "" : 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,34 @@ 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(:"simple_form.required.html", 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(:"simple_form.required.text", default: 'required')
         end
 
         def translate_required_mark
-          I18n.t(:"simple_form.required.mark", :default => '*')
+          I18n.t(:"simple_form.required.mark", default: '*')
         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(raw_label_text, required_label_text).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 +43,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 +67,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)