formtastic 1.2.4 → 3.1.5

data/lib/formtastic/inputs/base/wrapping.rb

@@ -0,0 +1,50 @@
+module Formtastic
+  module Inputs
+    module Base
+      # @todo relies on `dom_id`, `required?`, `optional`, `errors?`, `association_primary_key` & `sanitized_method_name` methods from another module
+      module Wrapping
+
+        # Override this method if you want to change the display order (for example, rendering the
+        # errors before the body of the input).
+        def input_wrapping(&block)
+          template.content_tag(:li,
+            [template.capture(&block), error_html, hint_html].join("\n").html_safe,
+            wrapper_html_options
+          )
+        end
+
+        def wrapper_html_options
+          opts = wrapper_html_options_raw
+          opts[:class] = wrapper_classes
+          opts[:id] = wrapper_dom_id unless opts.has_key? :id
+          opts
+        end
+
+        def wrapper_html_options_raw
+          (options[:wrapper_html] || {}).dup
+        end
+
+        def wrapper_classes_raw
+          [*wrapper_html_options_raw[:class]]
+        end
+
+        def wrapper_classes
+          classes = wrapper_classes_raw
+          classes << as
+          classes << "input"
+          classes << "error" if errors?
+          classes << "optional" if optional?
+          classes << "required" if required?
+          classes << "autofocus" if autofocus?
+
+          classes.join(' ')
+        end
+
+        def wrapper_dom_id
+          @wrapper_dom_id ||= "#{dom_id.to_s.gsub((association_primary_key || method).to_s, sanitized_method_name.to_s)}_input"
+        end
+
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/boolean_input.rb

@@ -0,0 +1,118 @@
+module Formtastic
+  module Inputs
+    # Boolean inputs are used to render an input for a single checkbox, typically for attributes
+    # with a simple yes/no or true/false value. Boolean inputs are used by default for boolean
+    # database columns.
+    #
+    # @example Full form context and markup
+    #   <%= semantic_form_for @post %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :published, :as => :boolean %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="boolean" id="post_published_input">
+    #           <input type="hidden" name="post[published]" id="post_published" value="0">
+    #           <label for="post_published">
+    #             <input type="checkbox" name="post[published]" id="post_published" value="1">
+    #             Published?
+    #           </label>
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @example Set the values for the checked and unchecked states
+    #   <%= f.input :published, :checked_value => "yes", :unchecked_value => "no" %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class BooleanInput
+      include Base
+
+      def to_html
+        input_wrapping do
+          hidden_field_html <<
+          label_with_nested_checkbox
+        end
+      end
+
+      def hidden_field_html
+        template.hidden_field_tag(input_html_options[:name], unchecked_value, :id => nil, :disabled => input_html_options[:disabled] )
+      end
+
+      def label_with_nested_checkbox
+        builder.label(
+          method,
+          label_text_with_embedded_checkbox,
+          label_html_options
+        )
+      end
+      
+      def label_html_options
+        {
+          :for => input_html_options[:id],
+          :class => super[:class] - ['label'] # remove 'label' class
+        }
+      end
+
+      def label_text_with_embedded_checkbox
+        check_box_html << "" << label_text
+      end
+
+      def check_box_html
+        template.check_box_tag("#{object_name}[#{method}]", checked_value, checked?, input_html_options)
+      end
+
+      def unchecked_value
+        options[:unchecked_value] || '0'
+      end
+
+      def checked_value
+        options[:checked_value] || '1'
+      end
+
+      def responds_to_global_required?
+        false
+      end
+
+      def input_html_options
+        {:name => input_html_options_name}.merge(super)
+      end
+      
+      def input_html_options_name
+        if builder.options.key?(:index)
+          "#{object_name}[#{builder.options[:index]}][#{method}]"
+        else
+          "#{object_name}[#{method}]"
+        end
+      end
+
+      def checked?
+        object && boolean_checked?(object.send(method), checked_value) 
+      end
+      
+      private 
+
+      def boolean_checked?(value, checked_value)
+        case value
+        when TrueClass, FalseClass
+          value
+        when NilClass
+          false
+        when Integer
+          value == checked_value.to_i
+        when String
+          value == checked_value
+        when Array
+          value.include?(checked_value)
+        else
+          value.to_i != 0
+        end
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -0,0 +1,197 @@
+module Formtastic
+  module Inputs
+
+    # A CheckBoxes input is used to render a series of checkboxes. This is an alternative input choice
+    # for `has_many` or `has_and_belongs_to_many` associations like a `Post` belonging to many
+    # `categories` (by default, a {SelectInput `:select`} input is used, allowing multiple selections).
+    #
+    # Within the standard `<li>` wrapper, the output is a `<fieldset>` with a `<legend>` to
+    # represent the "label" for the input, and an `<ol>` containing `<li>`s for each choice in
+    # the association. Each `<li>` choice contains a hidden `<input>` tag for the "unchecked"
+    # value (like Rails), and a `<label>` containing the checkbox `<input>` and the label text
+    # for each choice.
+    #
+    # @example Basic example with full form context
+    #
+    #   <%= semantic_form_for @post do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :categories, :as => :check_boxes %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <li class='check_boxes'>
+    #     <fieldset>
+    #       <legend class="label"><label>Categories</label></legend>
+    #       <ol>
+    #         <li>
+    #           <input type="hidden" name="post[category_ids][1]" value="">
+    #           <label for="post_category_ids_1"><input id="post_category_ids_1" name="post[category_ids][1]" type="checkbox" value="1" /> Ruby</label>
+    #         </li>
+    #         <li>
+    #           <input type="hidden" name="post[category_ids][2]" value="">
+    #           <label for="post_category_ids_2"><input id="post_category_ids_2" name="post[category_ids][2]" type="checkbox" value="2" /> Rails</label>
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </li>
+    #
+    # @example `:collection` can be used to customize the choices
+    #   <%= f.input :categories, :as => :check_boxes, :collection => @categories %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Category.all %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Category.some_named_scope %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Category.pluck(:label, :id) %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [Category.find_by_name("Ruby"), Category.find_by_name("Rails")] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => ["Ruby", "Rails"] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", "ruby"], ["Rails", "rails"]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", "1"], ["Rails", "2"]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", 1], ["Rails", 2]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", 1, {'data-attr' => 'attr-value'}]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => 1..5 %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [:ruby, :rails] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", :ruby], ["Rails", :rails]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Set.new([:ruby, :rails]) %>
+    #
+    # @example `:hidden_fields` can be used to skip Rails' rendering of a hidden field before every checkbox
+    #   <%= f.input :categories, :as => :check_boxes, :hidden_fields => false %>
+    #
+    # @example `:disabled` can be used to disable any checkboxes with a value found in the given Array
+    #   <%= f.input :categories, :as => :check_boxes, :collection => ["a", "b"], :disabled => ["a"] %>
+    #
+    # @example `:value_as_class` can be used to add a class to the `<li>` wrapped around each choice using the checkbox value for custom styling of each choice
+    #   <%= f.input :categories, :as => :check_boxes, :value_as_class => true %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    # @see Formtastic::Inputs::BooleanInput BooleanInput for a single checkbox for boolean (checked = true) inputs
+    #
+    # @todo Do/can we support the per-item HTML options like RadioInput?
+    class CheckBoxesInput
+      include Base
+      include Base::Collections
+      include Base::Choices
+
+      def initialize(*args)
+        super
+        raise Formtastic::UnsupportedEnumCollection if collection_from_enum?
+      end
+
+      def to_html
+        input_wrapping do
+          choices_wrapping do
+            legend_html <<
+            hidden_field_for_all <<
+            choices_group_wrapping do
+              collection.map { |choice|
+                choice_wrapping(choice_wrapping_html_options(choice)) do
+                  choice_html(choice)
+                end
+              }.join("\n").html_safe
+            end
+          end
+        end
+      end
+
+      def choice_html(choice)
+        template.content_tag(
+          :label,
+          checkbox_input(choice) + choice_label(choice),
+          label_html_options.merge(:for => choice_input_dom_id(choice), :class => nil)
+        )
+      end
+
+      def hidden_field_for_all
+        if hidden_fields?
+          ''
+        else
+          options = {}
+          options[:class] = [method.to_s.singularize, 'default'].join('_') if value_as_class?
+          options[:id] = [object_name, method, 'none'].join('_')
+          template.hidden_field_tag(input_name, '', options)
+        end
+      end
+
+      def hidden_fields?
+        options[:hidden_fields]
+      end
+
+      def check_box_with_hidden_input(choice)
+        value = choice_value(choice)
+        builder.check_box(
+          association_primary_key || method,
+          extra_html_options(choice).merge(:id => choice_input_dom_id(choice), :name => input_name, :disabled => disabled?(value), :required => false),
+          value,
+          unchecked_value
+        )
+      end
+
+      def check_box_without_hidden_input(choice)
+        value = choice_value(choice)
+        template.check_box_tag(
+          input_name,
+          value,
+          checked?(value),
+          extra_html_options(choice).merge(:id => choice_input_dom_id(choice), :disabled => disabled?(value), :required => false)
+        )
+      end
+
+      def extra_html_options(choice)
+        input_html_options.merge(custom_choice_html_options(choice))
+      end
+
+      def checked?(value)
+        selected_values.include?(value)
+      end
+
+      def disabled?(value)
+        disabled_values.include?(value)
+      end
+
+      def selected_values
+        @selected_values ||= make_selected_values
+      end
+
+      def disabled_values
+        vals = options[:disabled] || []
+        vals = [vals] unless vals.is_a?(Array)
+        vals
+      end
+
+      def unchecked_value
+        options[:unchecked_value] || ''
+      end
+
+      def input_name
+        if builder.options.key?(:index)
+          "#{object_name}[#{builder.options[:index]}][#{association_primary_key || method}][]"
+        else
+          "#{object_name}[#{association_primary_key || method}][]"
+        end
+      end
+
+      protected
+
+      def checkbox_input(choice)
+        if hidden_fields?
+          check_box_with_hidden_input(choice)
+        else
+          check_box_without_hidden_input(choice)
+        end
+      end
+
+      def make_selected_values
+        if object.respond_to?(method)
+          selected_items = object.send(method)
+          # Construct an array from the return value, regardless of the return type
+          selected_items = [*selected_items].compact.flatten
+
+          selected = []
+          selected_items.map do |selected_item|
+            selected_item_id = selected_item.id if selected_item.respond_to? :id
+            item = send_or_call_or_object(value_method, selected_item) || selected_item_id
+          end.compact
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/color_input.rb

@@ -0,0 +1,42 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="color">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for attributes with a name matching
+    # `/color/`, but can be applied to any text-like input with `:as => :color`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :color, :as => :color %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="color">
+    #           <label for="user_color">Color</label>
+    #           <input type="color" id="user_color" name="user[color]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class ColorInput 
+      include Base
+      include Base::Stringish
+      include Base::Placeholder
+      
+      def to_html
+        raise "The :color input requires the color_field form helper, which is only available in Rails 4+" unless builder.respond_to?(:color_field)
+        input_wrapping do
+          label_html <<
+          builder.color_field(method, input_html_options)
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/country_input.rb

@@ -0,0 +1,86 @@
+module Formtastic
+  module Inputs
+    # Outputs a country select input, wrapping around a regular country_select helper.
+    # Rails doesn't come with a `country_select` helper by default any more, so you'll need to do
+    # one of the following:
+    #
+    # * install the [country_select](https://github.com/stefanpenner/country_select) gem
+    # * install any other country_select plugin that behaves in a similar way
+    # * roll your own `country_select` helper with the same args and options as the Rails one
+    #
+    # Formtastic supports both 1.x and 2.x of stefanpenner/country_select, but if you're upgrading
+    # from 1.x, they behave quite differently, so please see their [upgrade instructions](https://github.com/stefanpenner/country_select/blob/master/UPGRADING.md).
+    #
+    # By default, Formtastic includes a handful of English-speaking countries as "priority
+    # countries", which can be set in the `priority_countries` configuration array in the
+    # formtastic.rb initializer to suit your market and user base (see README for more info on
+    # configuration). Additionally, it is possible to set the :priority_countries on a per-input
+    # basis through the `:priority_countries` option. These priority countries will be passed down
+    # to the `country_select` helper of your choice, and may or may not be used by the helper.
+    #
+    # @example Basic example with full form context using `priority_countries` from config
+    #
+    #   <%= semantic_form_for @user do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :nationality, :as => :country %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <li class='country'>
+    #     <label for="user_nationality">Country</label>
+    #     <select id="user_nationality" name="user[nationality]">
+    #       <option value="...">...</option>
+    #       # ...
+    #   </li>
+    #
+    # @example `:priority_countries` set on a specific input (country_select 1.x)
+    #
+    #   <%= semantic_form_for @user do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :nationality, :as => :country, :priority_countries => ["Australia", "New Zealand"] %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <li class='country'>
+    #     <label for="user_nationality">Country</label>
+    #     <select id="user_nationality" name="user[nationality]">
+    #       <option value="...">...</option>
+    #       # ...
+    #   </li>
+    #
+    # @example `:priority_countries` set on a specific input (country_select 2.x)
+    #
+    #   <%= semantic_form_for @user do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :nationality, :as => :country, :priority_countries => ["AU", "NZ"] %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <li class='country'>
+    #     <label for="user_nationality">Country</label>
+    #     <select id="user_nationality" name="user[nationality]">
+    #       <option value="...">...</option>
+    #       # ...
+    #   </li>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class CountryInput 
+      include Base
+
+      CountrySelectPluginMissing = Class.new(StandardError)
+
+      def to_html
+        raise CountrySelectPluginMissing, "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
+        input_wrapping do
+          label_html <<
+          builder.country_select(method, priority_countries, input_options, input_html_options)
+        end
+      end
+      
+      def priority_countries
+        options[:priority_countries] || builder.priority_countries
+      end
+
+    end
+  end
+end