simple_form_awesome 2.2.0

data/lib/simple_form/inputs/base.rb

@@ -0,0 +1,184 @@
+module SimpleForm
+  module Inputs
+    class Base
+      extend I18nCache
+
+      include SimpleForm::Helpers::Autofocus
+      include SimpleForm::Helpers::Disabled
+      include SimpleForm::Helpers::Readonly
+      include SimpleForm::Helpers::Required
+      include SimpleForm::Helpers::Validators
+
+      include SimpleForm::Components::Errors
+      include SimpleForm::Components::Hints
+      include SimpleForm::Components::HTML5
+      include SimpleForm::Components::LabelInput
+      include SimpleForm::Components::Maxlength
+      include SimpleForm::Components::MinMax
+      include SimpleForm::Components::Pattern
+      include SimpleForm::Components::Placeholders
+      include SimpleForm::Components::Readonly
+
+      attr_reader :attribute_name, :column, :input_type, :reflection,
+                  :options, :input_html_options, :input_html_classes, :html_classes
+
+      delegate :template, :object, :object_name, :lookup_model_names, :lookup_action, :to => :@builder
+
+      class_attribute :default_options
+      self.default_options = {}
+
+      def self.enable(*keys)
+        options = self.default_options.dup
+        keys.each { |key| options.delete(key) }
+        self.default_options = options
+      end
+
+      def self.disable(*keys)
+        options = self.default_options.dup
+        keys.each { |key| options[key] = false }
+        self.default_options = options
+      end
+
+      # Always enabled.
+      enable :hint
+
+      # Usually disabled, needs to be enabled explicitly passing true as option.
+      disable :maxlength, :placeholder, :pattern, :min_max
+
+      def initialize(builder, attribute_name, column, input_type, options = {})
+        super
+
+        options             = options.dup
+        @builder            = builder
+        @attribute_name     = attribute_name
+        @column             = column
+        @input_type         = input_type
+        @reflection         = options.delete(:reflection)
+        @options            = options.reverse_merge!(self.class.default_options)
+        @required           = calculate_required
+
+        # Notice that html_options_for receives a reference to input_html_classes.
+        # This means that classes added dynamically to input_html_classes will
+        # still propagate to input_html_options.
+        @html_classes = SimpleForm.additional_classes_for(:input) { additional_classes }
+
+        @input_html_classes = @html_classes.dup
+        @input_html_options = html_options_for(:input, input_html_classes).tap do |o|
+          o[:readonly]  = true if has_readonly?
+          o[:disabled]  = true if has_disabled?
+          o[:autofocus] = true if has_autofocus?
+        end
+      end
+
+      def input
+        raise NotImplementedError
+      end
+
+      def input_options
+        options
+      end
+
+      def additional_classes
+        @additional_classes ||= [input_type, required_class, readonly_class, disabled_class].compact
+      end
+
+      def input_class
+        "#{lookup_model_names.join("_")}_#{reflection_or_attribute_name}"
+      end
+
+      private
+
+      def add_size!
+        input_html_options[:size] ||= [limit, SimpleForm.default_input_size].compact.min
+      end
+
+      def limit
+        if column
+          decimal_or_float? ? decimal_limit : column_limit
+        end
+      end
+
+      def column_limit
+        column.limit
+      end
+
+      # Add one for decimal point
+      def decimal_limit
+        column_limit && (column_limit + 1)
+      end
+
+      def decimal_or_float?
+        column.number? && column.type != :integer
+      end
+
+      def nested_boolean_style?
+        options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
+      end
+
+      # Find reflection name when available, otherwise use attribute
+      def reflection_or_attribute_name
+        @reflection_or_attribute_name ||= reflection ? reflection.name : attribute_name
+      end
+
+      # Retrieve options for the given namespace from the options hash
+      def html_options_for(namespace, css_classes)
+        html_options = options[:"#{namespace}_html"]
+        html_options = html_options ? html_options.dup : {}
+        css_classes << html_options[:class] if html_options.key?(:class)
+        html_options[:class] = css_classes unless css_classes.empty?
+        html_options
+      end
+
+      # Lookup translations for the given namespace using I18n, based on object name,
+      # actual action and attribute name. Lookup priority as follows:
+      #
+      #   simple_form.{namespace}.{model}.{action}.{attribute}
+      #   simple_form.{namespace}.{model}.{attribute}
+      #   simple_form.{namespace}.defaults.{attribute}
+      #
+      #  Namespace is used for :labels and :hints.
+      #
+      #  Model is the actual object name, for a @user object you'll have :user.
+      #  Action is the action being rendered, usually :new or :edit.
+      #  And attribute is the attribute itself, :name for example.
+      #
+      #  The lookup for nested attributes is also done in a nested format using
+      #  both model and nested object names, such as follow:
+      #
+      #   simple_form.{namespace}.{model}.{nested}.{action}.{attribute}
+      #   simple_form.{namespace}.{model}.{nested}.{attribute}
+      #   simple_form.{namespace}.{nested}.{action}.{attribute}
+      #   simple_form.{namespace}.{nested}.{attribute}
+      #   simple_form.{namespace}.defaults.{attribute}
+      #
+      #  Example:
+      #
+      #    simple_form:
+      #      labels:
+      #        user:
+      #          new:
+      #            email: 'E-mail para efetuar o sign in.'
+      #          edit:
+      #            email: 'E-mail.'
+      #
+      #  Take a look at our locale example file.
+      def translate(namespace, default='')
+        model_names = lookup_model_names.dup
+        lookups     = []
+
+        while !model_names.empty?
+          joined_model_names = model_names.join(".")
+          model_names.shift
+
+          lookups << :"#{joined_model_names}.#{lookup_action}.#{reflection_or_attribute_name}"
+          lookups << :"#{joined_model_names}.#{reflection_or_attribute_name}"
+        end
+        lookups << :"defaults.#{lookup_action}.#{reflection_or_attribute_name}"
+        lookups << :"defaults.#{reflection_or_attribute_name}"
+        lookups << default
+
+        I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/block_input.rb

@@ -0,0 +1,14 @@
+module SimpleForm
+  module Inputs
+    class BlockInput < Base
+      def initialize(*args, &block)
+        super
+        @block = block
+      end
+
+      def input
+        template.capture(&@block)
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/boolean_input.rb

@@ -0,0 +1,78 @@
+module SimpleForm
+  module Inputs
+    class BooleanInput < Base
+      def input
+        if nested_boolean_style?
+          build_hidden_field_for_checkbox +
+            template.label_tag(nil, :class => "checkbox") {
+              build_check_box_without_hidden_field + inline_label
+            }
+        else
+          build_check_box
+        end
+      end
+
+      def label_input
+        if options[:label] == false
+          input
+        elsif nested_boolean_style?
+          html_options = label_html_options.dup
+          html_options[:class].push(:checkbox)
+
+          build_hidden_field_for_checkbox +
+            @builder.label(label_target, html_options) {
+              build_check_box_without_hidden_field + label_text
+            }
+        else
+          input + label
+        end
+      end
+
+      private
+
+      # Build a checkbox tag using default unchecked value. This allows us to
+      # reuse the method for nested boolean style, but with no unchecked value,
+      # which won't generate the hidden checkbox. This is the default functionality
+      # in Rails > 3.2.1, and is backported in SimpleForm AV helpers.
+      def build_check_box(unchecked_value = unchecked_value)
+        @builder.check_box(attribute_name, input_html_options, checked_value, unchecked_value)
+      end
+
+      # Build a checkbox without generating the hidden field. See
+      # #build_hidden_field_for_checkbox for more info.
+      def build_check_box_without_hidden_field
+        build_check_box(nil)
+      end
+
+      # Create a hidden field for the current checkbox, so we can simulate Rails
+      # functionality with hidden + checkbox, but under a nested context, where
+      # we need the hidden field to be *outside* the label (otherwise it
+      # generates invalid html - html5 only).
+      def build_hidden_field_for_checkbox
+        @builder.hidden_field(attribute_name, :value => unchecked_value, :id => nil,
+                              :disabled => input_html_options[:disabled],
+                              :name => input_html_options[:name])
+      end
+
+      def inline_label
+        inline_option = options[:inline_label]
+        inline_option == true ? label_text : inline_option
+      end
+
+      # Booleans are not required by default because in most of the cases
+      # it makes no sense marking them as required. The only exception is
+      # Terms of Use usually presented at most sites sign up screen.
+      def required_by_default?
+        false
+      end
+
+      def checked_value
+        options.fetch(:checked_value, '1')
+      end
+
+      def unchecked_value
+        options.fetch(:unchecked_value, '0')
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/collection_check_boxes_input.rb

@@ -0,0 +1,21 @@
+module SimpleForm
+  module Inputs
+    class CollectionCheckBoxesInput < CollectionRadioButtonsInput
+      protected
+
+      # Checkbox components do not use the required html tag.
+      # More info: https://github.com/plataformatec/simple_form/issues/340#issuecomment-2871956
+      def has_required?
+        false
+      end
+
+      def build_nested_boolean_style_item_tag(collection_builder)
+        collection_builder.check_box + collection_builder.text
+      end
+
+      def item_wrapper_class
+        "checkbox"
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/collection_input.rb

@@ -0,0 +1,101 @@
+module SimpleForm
+  module Inputs
+    class CollectionInput < Base
+      # Default boolean collection for use with selects/radios when no
+      # collection is given. Always fallback to this boolean collection.
+      # Texts can be translated using i18n in "simple_form.yes" and
+      # "simple_form.no" keys. See the example locale file.
+      def self.boolean_collection
+        i18n_cache :boolean_collection do
+          [ [I18n.t(:"simple_form.yes", :default => 'Yes'), true],
+            [I18n.t(:"simple_form.no", :default => 'No'), false] ]
+        end
+      end
+
+      def input
+        raise NotImplementedError,
+          "input should be implemented by classes inheriting from CollectionInput"
+      end
+
+      def input_options
+        options = super
+        options[:include_blank] = true unless skip_include_blank?
+        options
+      end
+
+      private
+
+      def collection
+        @collection ||= begin
+          collection = options.delete(:collection) || self.class.boolean_collection
+          collection.respond_to?(:call) ? collection.call : collection.to_a
+        end
+      end
+
+      def has_required?
+        super && (input_options[:include_blank] || multiple?)
+      end
+
+      # Check if :include_blank must be included by default.
+      def skip_include_blank?
+        (options.keys & [:prompt, :include_blank, :default, :selected]).any? || multiple?
+      end
+
+      def multiple?
+        !!options[:input_html].try(:[], :multiple)
+      end
+
+      # Detect the right method to find the label and value for a collection.
+      # If no label or value method are defined, will attempt to find them based
+      # on default label and value methods that can be configured through
+      # SimpleForm.collection_label_methods and
+      # SimpleForm.collection_value_methods.
+      def detect_collection_methods
+        label, value = options.delete(:label_method), options.delete(:value_method)
+
+        unless label && value
+          common_method_for = detect_common_display_methods
+          label ||= common_method_for[:label]
+          value ||= common_method_for[:value]
+        end
+
+        [label, value]
+      end
+
+      def detect_common_display_methods(collection_classes = detect_collection_classes)
+        collection_translated = translate_collection if collection_classes == [Symbol]
+
+        if collection_translated || collection_classes.include?(Array)
+          { :label => :first, :value => :last }
+        elsif collection_includes_basic_objects?(collection_classes)
+          { :label => :to_s, :value => :to_s }
+        else
+          sample = collection.first || collection.last
+
+          { :label => SimpleForm.collection_label_methods.find { |m| sample.respond_to?(m) },
+            :value => SimpleForm.collection_value_methods.find { |m| sample.respond_to?(m) } }
+        end
+      end
+
+      def detect_collection_classes(some_collection = collection)
+        some_collection.map { |e| e.class }.uniq
+      end
+
+      def collection_includes_basic_objects?(collection_classes)
+        (collection_classes & [
+          String, Integer, Fixnum, Bignum, Float, NilClass, Symbol, TrueClass, FalseClass
+        ]).any?
+      end
+
+      def translate_collection
+        if translated_collection = translate(:options)
+          @collection = collection.map do |key|
+            [translated_collection[key] || key, key]
+          end
+          true
+        end
+      end
+    end
+  end
+end
+

data/lib/simple_form/inputs/collection_radio_buttons_input.rb

@@ -0,0 +1,63 @@
+module SimpleForm
+  module Inputs
+    class CollectionRadioButtonsInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+
+        @builder.send("collection_#{input_type}",
+          attribute_name, collection, value_method, label_method,
+          input_options, input_html_options, &collection_block_for_nested_boolean_style
+        )
+      end
+
+      def input_options
+        options = super
+        apply_default_collection_options!(options)
+        apply_nested_boolean_collection_options!(options) if nested_boolean_style?
+        options
+      end
+
+      protected
+
+      def apply_default_collection_options!(options)
+        options[:item_wrapper_tag] ||= options.fetch(:item_wrapper_tag, SimpleForm.item_wrapper_tag)
+        options[:item_wrapper_class] = [
+          item_wrapper_class, options[:item_wrapper_class], SimpleForm.item_wrapper_class
+        ].compact.presence
+
+        options[:collection_wrapper_tag] ||= options.fetch(:collection_wrapper_tag, SimpleForm.collection_wrapper_tag)
+        options[:collection_wrapper_class] = [
+          options[:collection_wrapper_class], SimpleForm.collection_wrapper_class
+        ].compact.presence
+      end
+
+      # Force item wrapper to be a label when using nested boolean, to support
+      # configuring classes through :item_wrapper_class, and to maintain
+      # compatibility with :inline style and default :item_wrapper_tag.
+      def apply_nested_boolean_collection_options!(options)
+        options[:item_wrapper_tag] = :label
+      end
+
+      def collection_block_for_nested_boolean_style
+        return unless nested_boolean_style?
+
+        proc { |builder| build_nested_boolean_style_item_tag(builder) }
+      end
+
+      def build_nested_boolean_style_item_tag(collection_builder)
+        collection_builder.radio_button + collection_builder.text
+      end
+
+      def item_wrapper_class
+        "radio"
+      end
+
+      # Do not attempt to generate label[for] attributes by default, unless an
+      # explicit html option is given. This avoids generating labels pointing to
+      # non existent fields.
+      def generate_label_for_attribute?
+        false
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/collection_select_input.rb

@@ -0,0 +1,14 @@
+module SimpleForm
+  module Inputs
+    class CollectionSelectInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+
+        @builder.collection_select(
+          attribute_name, collection, value_method, label_method,
+          input_options, input_html_options
+        )
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/date_time_input.rb

@@ -0,0 +1,28 @@
+module SimpleForm
+  module Inputs
+    class DateTimeInput < Base
+      def input
+        @builder.send(:"#{input_type}_select", attribute_name, input_options, input_html_options)
+      end
+
+      def has_required?
+        false
+      end
+
+      private
+
+      def label_target
+        position = case input_type
+        when :date, :datetime
+          date_order = input_options[:order] || I18n.t('date.order')
+          date_order.first
+        else
+          :hour
+        end
+
+        position = ActionView::Helpers::DateTimeSelector::POSITION[position]
+        "#{attribute_name}_#{position}i"
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/file_input.rb

@@ -0,0 +1,9 @@
+module SimpleForm
+  module Inputs
+    class FileInput < Base
+      def input
+        @builder.file_field(attribute_name, input_html_options)
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/grouped_collection_select_input.rb

@@ -0,0 +1,41 @@
+module SimpleForm
+  module Inputs
+    class GroupedCollectionSelectInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+        @builder.grouped_collection_select(attribute_name, grouped_collection,
+                      group_method, group_label_method, value_method, label_method,
+                      input_options, input_html_options)
+      end
+
+      private
+
+      def grouped_collection
+        @grouped_collection ||= begin
+          grouped_collection = options.delete(:collection)
+          grouped_collection.respond_to?(:call) ? grouped_collection.call : grouped_collection.to_a
+        end
+      end
+
+      # Sample collection
+      def collection
+        @collection ||= grouped_collection.first.try(:send, group_method) || []
+      end
+
+      def group_method
+        @group_method ||= options.delete(:group_method)
+      end
+
+      def group_label_method
+        label = options.delete(:group_label_method)
+
+        unless label
+          common_method_for = detect_common_display_methods(detect_collection_classes(grouped_collection))
+          label = common_method_for[:label]
+        end
+
+        label
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/hidden_input.rb

@@ -0,0 +1,17 @@
+module SimpleForm
+  module Inputs
+    class HiddenInput < Base
+      disable :label, :errors, :hint, :required
+
+      def input
+        @builder.hidden_field(attribute_name, input_html_options)
+      end
+
+      private
+
+      def required_class
+        nil
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/numeric_input.rb

@@ -0,0 +1,24 @@
+module SimpleForm
+  module Inputs
+    class NumericInput < Base
+      enable :placeholder, :min_max
+
+      def input
+        add_size!
+        input_html_classes.unshift("numeric")
+        if html5?
+          input_html_options[:type] ||= "number"
+          input_html_options[:step] ||= integer? ? 1 : "any"
+        end
+        @builder.text_field(attribute_name, input_html_options)
+      end
+
+      private
+
+      # Rails adds the size attr by default, if the :size key does not exist.
+      def add_size!
+        input_html_options[:size] ||= nil
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/password_input.rb

@@ -0,0 +1,12 @@
+module SimpleForm
+  module Inputs
+    class PasswordInput < Base
+      enable :placeholder, :maxlength
+
+      def input
+        add_size!
+        @builder.password_field(attribute_name, input_html_options)
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/priority_input.rb

@@ -0,0 +1,24 @@
+module SimpleForm
+  module Inputs
+    class PriorityInput < CollectionSelectInput
+      def input
+        @builder.send(:"#{input_type}_select", attribute_name, input_priority,
+                      input_options, input_html_options)
+      end
+
+      def input_priority
+        options[:priority] || SimpleForm.send(:"#{input_type}_priority")
+      end
+
+      protected
+
+      def has_required?
+        false
+      end
+
+      def skip_include_blank?
+        super || input_priority.present?
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/range_input.rb

@@ -0,0 +1,14 @@
+module SimpleForm
+  module Inputs
+    class RangeInput < NumericInput
+      def input
+        if html5?
+          input_html_options[:type] ||= "range"
+          input_html_options[:step] ||= 1
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/string_input.rb

@@ -0,0 +1,23 @@
+module SimpleForm
+  module Inputs
+    class StringInput < Base
+      enable :placeholder, :maxlength, :pattern
+
+      def input
+        unless string?
+          input_html_classes.unshift("string")
+          input_html_options[:type] ||= input_type if html5?
+        end
+
+        add_size!
+        @builder.text_field(attribute_name, input_html_options)
+      end
+
+      private
+
+      def string?
+        input_type == :string
+      end
+    end
+  end
+end