ehoch_simple_form 2.0.2.dev

data/lib/simple_form/action_view_extensions/builder.rb

@@ -0,0 +1,338 @@
+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(form_builder, method_name, object, sanitized_attribute_name, text,
+                     value, input_html_options)
+        @form_builder = form_builder
+        @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)
+        @form_builder.label(@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)
+        @form_builder.radio_button(@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)
+        @form_builder.check_box(@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:
+      #
+      #   form_for @user do |f|
+      #     f.simple_fields_for :posts do |posts_form|
+      #       # Here you have all simple_form methods available
+      #       posts_form.input :title
+      #     end
+      #   end
+      def simple_fields_for(*args, &block)
+        options = args.extract_options!
+        options[:wrapper] ||= self.options[:wrapper]
+
+        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(self, 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|
+          current_option = options[option]
+          next if current_option.nil?
+
+          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
+      end
+    end
+  end
+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

@@ -0,0 +1,74 @@
+module SimpleForm
+  module ActionViewExtensions
+    # This module creates SimpleForm wrappers around default form_for and fields_for.
+    #
+    # Example:
+    #
+    #   simple_form_for @user do |f|
+    #     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)
+        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(" ")
+
+        with_simple_form_field_error_proc do
+          form_for(record, options, &block)
+        end
+      end
+
+      def simple_fields_for(record_name, record_object = nil, options = {}, &block)
+        options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
+        options[:builder] ||= SimpleForm::FormBuilder
+
+        with_simple_form_field_error_proc do
+          fields_for(record_name, record_object, options, &block)
+        end
+      end
+
+      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
+      end
+
+      def simple_form_css_class(record, options)
+        html_options = options[:html]
+        as = options[:as]
+
+        if html_options.key?(:class)
+          html_options[:class]
+        elsif record.is_a?(String) || record.is_a?(Symbol)
+          as || record
+        else
+          record = record.last if record.is_a?(Array)
+          action = record.respond_to?(:persisted?) && record.persisted? ? :edit : :new
+          as ? "#{action}_#{as}" : dom_class(record, action)
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, SimpleForm::ActionViewExtensions::FormHelper

data/lib/simple_form/components.rb

@@ -0,0 +1,20 @@
+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
+  # output under given circumstances without user input. For example,
+  # the disabled helper always need a :disabled => true option given
+  # to the input in order to be enabled. On the other hand, things like
+  # hints can generate output automatically by doing I18n lookups.
+  module Components
+    autoload :Errors,       'simple_form/components/errors'
+    autoload :Hints,        'simple_form/components/hints'
+    autoload :HTML5,        'simple_form/components/html5'
+    autoload :LabelInput,   'simple_form/components/label_input'
+    autoload :Labels,       'simple_form/components/labels'
+    autoload :MinMax,       'simple_form/components/min_max'
+    autoload :Maxlength,    'simple_form/components/maxlength'
+    autoload :Pattern,      'simple_form/components/pattern'
+    autoload :Placeholders, 'simple_form/components/placeholders'
+    autoload :Readonly,     'simple_form/components/readonly'
+  end
+end

data/lib/simple_form/components/errors.rb

@@ -0,0 +1,35 @@
+module SimpleForm
+  module Components
+    module Errors
+      def error
+        error_text if has_errors?
+      end
+
+      def has_errors?
+        object && object.respond_to?(:errors) && errors.present?
+      end
+
+      protected
+
+      def error_text
+        "#{options[:error_prefix]} #{errors.send(error_method)}".lstrip.html_safe
+      end
+
+      def error_method
+        options[:error_method] || SimpleForm.error_method
+      end
+
+      def errors
+        @errors ||= (errors_on_attribute + errors_on_association).compact
+      end
+
+      def errors_on_attribute
+        object.errors[attribute_name]
+      end
+
+      def errors_on_association
+        reflection ? object.errors[reflection.name] : []
+      end
+    end
+  end
+end