simple_form_with_client_validation 0.0.0

data/lib/simple_form_with_client_validation/helpers/autofocus.rb

@@ -0,0 +1,11 @@
+module SimpleFormWithClientValidation
+  module Helpers
+    module Autofocus
+      private
+
+      def has_autofocus?
+        options[:autofocus] == true
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/helpers/disabled.rb

@@ -0,0 +1,15 @@
+module SimpleFormWithClientValidation
+  module Helpers
+    module Disabled
+      private
+
+      def has_disabled?
+        options[:disabled] == true
+      end
+
+      def disabled_class
+        :disabled if has_disabled?
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/helpers/readonly.rb

@@ -0,0 +1,15 @@
+module SimpleFormWithClientValidation
+  module Helpers
+    module Readonly
+      private
+
+      def readonly_class
+        :readonly if has_readonly?
+      end
+
+      def has_readonly?
+        options[:readonly] == true
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/helpers/required.rb

@@ -0,0 +1,35 @@
+module SimpleFormWithClientValidation
+  module Helpers
+    module Required
+      private
+
+      def required_field?
+        @required
+      end
+
+      def calculate_required
+        if !options[:required].nil?
+          options[:required]
+        elsif has_validators?
+          required_by_validators?
+        else
+          required_by_default?
+        end
+      end
+
+      def required_by_validators?
+        (attribute_validators + reflection_validators).any? { |v| v.kind == :presence && valid_validator?(v) }
+      end
+
+      def required_by_default?
+        SimpleFormWithClientValidation.required_by_default
+      end
+
+      # Do not use has_required? because we want to add the class
+      # regardless of the required option.
+      def required_class
+        required_field? ? :required : :optional
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/helpers/validators.rb

@@ -0,0 +1,44 @@
+module SimpleFormWithClientValidation
+  module Helpers
+    module Validators
+      def has_validators?
+        @has_validators ||= attribute_name && object.class.respond_to?(:validators_on)
+      end
+
+      private
+
+      def attribute_validators
+        object.class.validators_on(attribute_name)
+      end
+
+      def reflection_validators
+        reflection ? object.class.validators_on(reflection.name) : []
+      end
+
+      def valid_validator?(validator)
+        !conditional_validators?(validator) && action_validator_match?(validator)
+      end
+
+      def conditional_validators?(validator)
+        validator.options.include?(:if) || validator.options.include?(:unless)
+      end
+
+      def action_validator_match?(validator)
+        return true if !validator.options.include?(:on)
+
+        case validator.options[:on]
+        when :save
+          true
+        when :create
+          !object.persisted?
+        when :update
+          object.persisted?
+        end
+      end
+
+      def find_validator(validator)
+        attribute_validators.find { |v| validator === v } if has_validators?
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/helpers.rb

@@ -0,0 +1,12 @@
+module SimpleFormWithClientValidation
+  # Helpers are made of several helpers that cannot be turned on automatically.
+  # For instance, disabled cannot be turned on automatically, it requires the
+  # user to explicitly pass the option :disabled => true so it may work.
+  module Helpers
+    autoload :Autofocus,    'simple_form_with_client_validation/helpers/autofocus'
+    autoload :Disabled,     'simple_form_with_client_validation/helpers/disabled'
+    autoload :Readonly,     'simple_form_with_client_validation/helpers/readonly'
+    autoload :Required,     'simple_form_with_client_validation/helpers/required'
+    autoload :Validators,   'simple_form_with_client_validation/helpers/validators'
+  end
+end

data/lib/simple_form_with_client_validation/i18n_cache.rb

@@ -0,0 +1,22 @@
+module SimpleFormWithClientValidation
+  # A lot of configuration values are retrived from I18n,
+  # like boolean collection, required string. This module provides
+  # caching facility to speed up form construction.
+  module I18nCache
+    def i18n_cache(key)
+      get_i18n_cache(key)[I18n.locale] ||= yield.freeze
+    end
+
+    def get_i18n_cache(key)
+      if class_variable_defined?(:"@@#{key}")
+        class_variable_get(:"@@#{key}")
+      else
+        reset_i18n_cache(key)
+      end
+    end
+
+    def reset_i18n_cache(key)
+      class_variable_set(:"@@#{key}", {})
+    end
+  end
+end

data/lib/simple_form_with_client_validation/inputs/base.rb

@@ -0,0 +1,162 @@
+module SimpleFormWithClientValidation
+  module Inputs
+    class Base
+      extend I18nCache
+
+      include SimpleFormWithClientValidation::Helpers::Autofocus
+      include SimpleFormWithClientValidation::Helpers::Disabled
+      include SimpleFormWithClientValidation::Helpers::Readonly
+      include SimpleFormWithClientValidation::Helpers::Required
+      include SimpleFormWithClientValidation::Helpers::Validators
+
+      include SimpleFormWithClientValidation::Components::Errors
+      include SimpleFormWithClientValidation::Components::Hints
+      include SimpleFormWithClientValidation::Components::HTML5
+      include SimpleFormWithClientValidation::Components::LabelInput
+      include SimpleFormWithClientValidation::Components::Maxlength
+      include SimpleFormWithClientValidation::Components::Minlength
+      include SimpleFormWithClientValidation::Components::MinMax
+      include SimpleFormWithClientValidation::Components::Pattern
+      include SimpleFormWithClientValidation::Components::Placeholders
+      include SimpleFormWithClientValidation::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
+
+        @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 = SimpleFormWithClientValidation.additional_classes_for(:input) {
+          [input_type, required_class, readonly_class, disabled_class].compact
+        }
+
+        @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
+
+      private
+
+      def add_size!
+        input_html_options[:size] ||= [limit, SimpleFormWithClientValidation.default_input_size].compact.min
+      end
+
+      def limit
+        column && column.limit
+      end
+
+      def nested_boolean_style?
+        options.fetch(:boolean_style, SimpleFormWithClientValidation.boolean_style) == :nested
+      end
+
+      # Find reflection name when available, otherwise use attribute
+      def 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"] || {}
+        css_classes << html_options[:class] if html_options.key?(:class)
+        html_options[:class] = css_classes
+        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.#{attribute_name}"
+        lookups << default
+
+        I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
+      end
+    end
+  end
+end

data/lib/simple_form_with_client_validation/inputs/block_input.rb

@@ -0,0 +1,14 @@
+module SimpleFormWithClientValidation
+  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_with_client_validation/inputs/boolean_input.rb

@@ -0,0 +1,64 @@
+module SimpleFormWithClientValidation
+  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 + options[: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 SimpleFormWithClientValidation AV helpers.
+      def build_check_box(unchecked_value='0')
+        @builder.check_box(attribute_name, input_html_options, '1', 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 => '0', :id => nil,
+                              :disabled => input_html_options[:disabled])
+      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
+    end
+  end
+end

data/lib/simple_form_with_client_validation/inputs/collection_check_boxes_input.rb

@@ -0,0 +1,21 @@
+module SimpleFormWithClientValidation
+  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_with_client_validation/inputs/collection_input.rb

@@ -0,0 +1,101 @@
+module SimpleFormWithClientValidation
+  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
+      # SimpleFormWithClientValidation.collection_label_methods and
+      # SimpleFormWithClientValidation.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 => SimpleFormWithClientValidation.collection_label_methods.find { |m| sample.respond_to?(m) },
+            :value => SimpleFormWithClientValidation.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
+