actionpack 3.2.19 → 4.0.0

data/lib/action_view/helpers/record_tag_helper.rb

@@ -1,15 +1,13 @@
-require 'action_controller/record_identifier'
-
 module ActionView
   # = Action View Record Tag Helpers
   module Helpers
     module RecordTagHelper
-      include ActionController::RecordIdentifier
+      include ActionView::RecordIdentifier
 
       # Produces a wrapper DIV element with id and class parameters that
       # relate to the specified Active Record object. Usage example:
       #
-      #    <%= div_for(@person, :class => "foo") do %>
+      #    <%= div_for(@person, class: "foo") do %>
       #       <%= @person.name %>
       #    <% end %>
       #
@@ -21,7 +19,7 @@ module ActionView
       # get iterated over and yield each record as an argument for the block.
       # For example:
       #
-      #    <%= div_for(@people, :class => "foo") do |person| %>
+      #    <%= div_for(@people, class: "foo") do |person| %>
       #      <%= person.name %>
       #    <% end %>
       #
@@ -67,27 +65,25 @@ module ActionView
       #
       # produces:
       #
-      #   <tr id="person_123" class="person">...</tr>
-      #   <tr id="person_124" class="person">...</tr>
+      #    <tr id="person_123" class="person">...</tr>
+      #    <tr id="person_124" class="person">...</tr>
       #
       # content_tag_for also accepts a hash of options, which will be converted to
       # additional HTML attributes. If you specify a <tt>:class</tt> value, it will be combined
       # with the default class name for your object. For example:
       #
-      #    <%= content_tag_for(:li, @person, :class => "bar") %>...
+      #    <%= content_tag_for(:li, @person, class: "bar") %>...
       #
       # produces:
       #
       #    <li id="person_123" class="person bar">...
       #
       def content_tag_for(tag_name, single_or_multiple_records, prefix = nil, options = nil, &block)
-        if single_or_multiple_records.respond_to?(:to_ary)
-          single_or_multiple_records.to_ary.map do |single_record|
-            capture { content_tag_for_single_record(tag_name, single_record, prefix, options, &block) }
-          end.join("\n").html_safe
-        else
-          content_tag_for_single_record(tag_name, single_or_multiple_records, prefix, options, &block)
-        end
+        options, prefix = prefix, nil if prefix.is_a?(Hash)
+
+        Array(single_or_multiple_records).map do |single_record|
+          content_tag_for_single_record(tag_name, single_record, prefix, options, &block)
+        end.join("\n").html_safe
       end
 
       private
@@ -95,15 +91,14 @@ module ActionView
         # Called by <tt>content_tag_for</tt> internally to render a content tag
         # for each record.
         def content_tag_for_single_record(tag_name, record, prefix, options, &block)
-          options, prefix = prefix, nil if prefix.is_a?(Hash)
           options = options ? options.dup : {}
-          options.merge!(:class => "#{dom_class(record, prefix)} #{options[:class]}".strip, :id => dom_id(record, prefix))
-          if !block_given?
-            content_tag(tag_name, "", options)
-          elsif block.arity == 0
-            content_tag(tag_name, capture(&block), options)
-          else
+          options[:class] = [ dom_class(record, prefix), options[:class] ].compact
+          options[:id]    = dom_id(record, prefix)
+
+          if block_given?
             content_tag(tag_name, capture(record, &block), options)
+          else
+            content_tag(tag_name, "", options)
           end
         end
     end

data/lib/action_view/helpers/rendering_helper.rb

@@ -39,7 +39,7 @@ module ActionView
       # The user can override this default by passing a block to the layout:
       #
       #   # The template
-      #   <%= render :layout => "my_layout" do %>
+      #   <%= render layout: "my_layout" do %>
       #     Content
       #   <% end %>
       #
@@ -59,7 +59,7 @@ module ActionView
       # Finally, the block can take block arguments, which can be passed in by +yield+:
       #
       #   # The template
-      #   <%= render :layout => "my_layout" do |customer| %>
+      #   <%= render layout: "my_layout" do |customer| %>
       #     Hello <%= customer.name %>
       #   <% end %>
       #

data/lib/action_view/helpers/sanitize_helper.rb

@@ -1,9 +1,9 @@
 require 'active_support/core_ext/object/try'
-require 'action_controller/vendor/html-scanner'
+require 'action_view/vendor/html-scanner'
 
 module ActionView
   # = Action View Sanitize Helpers
-  module Helpers #:nodoc:
+  module Helpers
     # The SanitizeHelper module provides a set of methods for scrubbing text of undesired HTML elements.
     # These helper methods extend Action View making them callable within your template files.
     module SanitizeHelper
@@ -29,7 +29,7 @@ module ActionView
       #
       # Custom Use (only the mentioned tags and attributes are allowed, nothing else)
       #
-      #   <%= sanitize @article.body, :tags => %w(table tr td), :attributes => %w(id class style) %>
+      #   <%= sanitize @article.body, tags: %w(table tr td), attributes: %w(id class style) %>
       #
       # Add table tags to the default allowed tags
       #
@@ -69,8 +69,6 @@ module ActionView
       # html-scanner tokenizer and so its HTML parsing ability is limited by
       # that of html-scanner.
       #
-      # ==== Examples
-      #
       #   strip_tags("Strip <i>these</i> tags!")
       #   # => Strip these tags!
       #
@@ -85,7 +83,6 @@ module ActionView
 
       # Strips all link tags from +text+ leaving just the link text.
       #
-      # ==== Examples
       #   strip_links('<a href="http://www.rubyonrails.org">Ruby on Rails</a>')
       #   # => Ruby on Rails
       #

data/lib/action_view/helpers/tag_helper.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/output_safety'
 require 'set'
 
@@ -14,7 +13,7 @@ module ActionView
       BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked autobuffer
                            autoplay controls loop selected hidden scoped async
                            defer reversed ismap seemless muted required
-                           autofocus novalidate formnovalidate open pubdate).to_set
+                           autofocus novalidate formnovalidate open pubdate itemscope).to_set
       BOOLEAN_ATTRIBUTES.merge(BOOLEAN_ATTRIBUTES.map {|attribute| attribute.to_sym })
 
       PRE_CONTENT_STRINGS = {
@@ -41,7 +40,7 @@ module ActionView
       # thus accessed as <tt>dataset.userId</tt>.
       #
       # Values are encoded to JSON, with the exception of strings and symbols.
-      # This may come in handy when using jQuery's HTML5-aware <tt>.data()<tt>
+      # This may come in handy when using jQuery's HTML5-aware <tt>.data()</tt>
       # from 1.4.3.
       #
       # ==== Examples
@@ -51,16 +50,16 @@ module ActionView
       #   tag("br", nil, true)
       #   # => <br>
       #
-      #   tag("input", :type => 'text', :disabled => true)
+      #   tag("input", type: 'text', disabled: true)
       #   # => <input type="text" disabled="disabled" />
       #
-      #   tag("img", :src => "open & shut.png")
+      #   tag("img", src: "open & shut.png")
       #   # => <img src="open &amp; shut.png" />
       #
-      #   tag("img", {:src => "open &amp; shut.png"}, false, false)
+      #   tag("img", {src: "open &amp; shut.png"}, false, false)
       #   # => <img src="open &amp; shut.png" />
       #
-      #   tag("div", :data => {:name => 'Stephen', :city_state => %w(Chicago IL)})
+      #   tag("div", data: {name: 'Stephen', city_state: %w(Chicago IL)})
       #   # => <div data-name="Stephen" data-city-state="[&quot;Chicago&quot;,&quot;IL&quot;]" />
       def tag(name, options = nil, open = false, escape = true)
         "<#{name}#{tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
@@ -80,12 +79,12 @@ module ActionView
       # ==== Examples
       #   content_tag(:p, "Hello world!")
       #    # => <p>Hello world!</p>
-      #   content_tag(:div, content_tag(:p, "Hello world!"), :class => "strong")
+      #   content_tag(:div, content_tag(:p, "Hello world!"), class: "strong")
       #    # => <div class="strong"><p>Hello world!</p></div>
-      #   content_tag("select", options, :multiple => true)
+      #   content_tag("select", options, multiple: true)
       #    # => <select multiple="multiple">...options...</select>
       #
-      #   <%= content_tag :div, :class => "strong" do -%>
+      #   <%= content_tag :div, class: "strong" do -%>
       #     Hello world!
       #   <% end -%>
       #    # => <div class="strong">Hello world!</div>
@@ -103,57 +102,71 @@ module ActionView
       # otherwise be recognized as markup. CDATA sections begin with the string
       # <tt><![CDATA[</tt> and end with (and may not contain) the string <tt>]]></tt>.
       #
-      # ==== Examples
       #   cdata_section("<hello world>")
       #   # => <![CDATA[<hello world>]]>
       #
       #   cdata_section(File.read("hello_world.txt"))
       #   # => <![CDATA[<hello from a text file]]>
+      #
+      #   cdata_section("hello]]>world")
+      #   # => <![CDATA[hello]]]]><![CDATA[>world]]>
       def cdata_section(content)
-        "<![CDATA[#{content}]]>".html_safe
+        splitted = content.gsub(']]>', ']]]]><![CDATA[>')
+        "<![CDATA[#{splitted}]]>".html_safe
       end
 
       # Returns an escaped version of +html+ without affecting existing escaped entities.
       #
-      # ==== Examples
       #   escape_once("1 < 2 &amp; 3")
       #   # => "1 &lt; 2 &amp; 3"
       #
       #   escape_once("&lt;&lt; Accept & Checkout")
       #   # => "&lt;&lt; Accept &amp; Checkout"
       def escape_once(html)
-        ActiveSupport::Multibyte.clean(html.to_s).gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] }
+        ERB::Util.html_escape_once(html)
       end
 
       private
 
         def content_tag_string(name, content, options, escape = true)
           tag_options = tag_options(options, escape) if options
-          "<#{name}#{tag_options}>#{PRE_CONTENT_STRINGS[name.to_sym]}#{escape ? ERB::Util.h(content) : content}</#{name}>".html_safe
+          content     = ERB::Util.h(content) if escape
+          "<#{name}#{tag_options}>#{PRE_CONTENT_STRINGS[name.to_sym]}#{content}</#{name}>".html_safe
         end
 
         def tag_options(options, escape = true)
-          unless options.blank?
-            attrs = []
-            options.each_pair do |key, value|
-              if key.to_s == 'data' && value.is_a?(Hash)
-                value.each do |k, v|
-                  unless v.is_a?(String) || v.is_a?(Symbol) || v.is_a?(BigDecimal)
-                    v = v.to_json
-                  end
-                  v = ERB::Util.html_escape(v) if escape
-                  attrs << %(data-#{k.to_s.dasherize}="#{v}")
-                end
-              elsif BOOLEAN_ATTRIBUTES.include?(key)
-                attrs << %(#{key}="#{key}") if value
-              elsif !value.nil?
-                final_value = value.is_a?(Array) ? value.join(" ") : value
-                final_value = ERB::Util.html_escape(final_value) if escape
-                attrs << %(#{key}="#{final_value}")
+          return if options.blank?
+          attrs = []
+          options.each_pair do |key, value|
+            if key.to_s == 'data' && value.is_a?(Hash)
+              value.each_pair do |k, v|
+                attrs << data_tag_option(k, v, escape)
               end
+            elsif BOOLEAN_ATTRIBUTES.include?(key)
+              attrs << boolean_tag_option(key) if value
+            elsif !value.nil?
+              attrs << tag_option(key, value, escape)
             end
-            " #{attrs.sort * ' '}".html_safe unless attrs.empty?
           end
+          " #{attrs.sort * ' '}".html_safe unless attrs.empty?
+        end
+
+        def data_tag_option(key, value, escape)
+          key   = "data-#{key.to_s.dasherize}"
+          unless value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(BigDecimal)
+            value = value.to_json
+          end
+          tag_option(key, value, escape)
+        end
+
+        def boolean_tag_option(key)
+          %(#{key}="#{key}")
+        end
+
+        def tag_option(key, value, escape)
+          value = value.join(" ") if value.is_a?(Array)
+          value = ERB::Util.h(value) if escape
+          %(#{key}="#{value}")
         end
     end
   end

data/lib/action_view/helpers/tags/base.rb

@@ -0,0 +1,147 @@
+module ActionView
+  module Helpers
+    module Tags # :nodoc:
+      class Base # :nodoc:
+        include Helpers::ActiveModelInstanceTag, Helpers::TagHelper, Helpers::FormTagHelper
+        include FormOptionsHelper
+
+        attr_reader :object
+
+        def initialize(object_name, method_name, template_object, options = {})
+          @object_name, @method_name = object_name.to_s.dup, method_name.to_s.dup
+          @template_object = template_object
+
+          @object_name.sub!(/\[\]$/,"") || @object_name.sub!(/\[\]\]$/,"]")
+          @object = retrieve_object(options.delete(:object))
+          @options = options
+          @auto_index = retrieve_autoindex(Regexp.last_match.pre_match) if Regexp.last_match
+        end
+
+        # This is what child classes implement.
+        def render
+          raise NotImplementedError, "Subclasses must implement a render method"
+        end
+
+        private
+
+        def value(object)
+          object.send @method_name if object
+        end
+
+        def value_before_type_cast(object)
+          unless object.nil?
+            method_before_type_cast = @method_name + "_before_type_cast"
+
+            object.respond_to?(method_before_type_cast) ?
+              object.send(method_before_type_cast) :
+              value(object)
+          end
+        end
+
+        def retrieve_object(object)
+          if object
+            object
+          elsif @template_object.instance_variable_defined?("@#{@object_name}")
+            @template_object.instance_variable_get("@#{@object_name}")
+          end
+        rescue NameError
+          # As @object_name may contain the nested syntax (item[subobject]) we need to fallback to nil.
+          nil
+        end
+
+        def retrieve_autoindex(pre_match)
+          object = self.object || @template_object.instance_variable_get("@#{pre_match}")
+          if object && object.respond_to?(:to_param)
+            object.to_param
+          else
+            raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
+          end
+        end
+
+        def add_default_name_and_id_for_value(tag_value, options)
+          if tag_value.nil?
+            add_default_name_and_id(options)
+          else
+            specified_id = options["id"]
+            add_default_name_and_id(options)
+
+            if specified_id.blank? && options["id"].present?
+              options["id"] += "_#{sanitized_value(tag_value)}"
+            end
+          end
+        end
+
+        def add_default_name_and_id(options)
+          if options.has_key?("index")
+            options["name"] ||= options.fetch("name"){ tag_name_with_index(options["index"], options["multiple"]) }
+            options["id"] = options.fetch("id"){ tag_id_with_index(options["index"]) }
+            options.delete("index")
+          elsif defined?(@auto_index)
+            options["name"] ||= options.fetch("name"){ tag_name_with_index(@auto_index, options["multiple"]) }
+            options["id"] = options.fetch("id"){ tag_id_with_index(@auto_index) }
+          else
+            options["name"] ||= options.fetch("name"){ tag_name(options["multiple"]) }
+            options["id"] = options.fetch("id"){ tag_id }
+          end
+
+          options["id"] = [options.delete('namespace'), options["id"]].compact.join("_").presence
+        end
+
+        def tag_name(multiple = false)
+          "#{@object_name}[#{sanitized_method_name}]#{"[]" if multiple}"
+        end
+
+        def tag_name_with_index(index, multiple = false)
+          "#{@object_name}[#{index}][#{sanitized_method_name}]#{"[]" if multiple}"
+        end
+
+        def tag_id
+          "#{sanitized_object_name}_#{sanitized_method_name}"
+        end
+
+        def tag_id_with_index(index)
+          "#{sanitized_object_name}_#{index}_#{sanitized_method_name}"
+        end
+
+        def sanitized_object_name
+          @sanitized_object_name ||= @object_name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
+        end
+
+        def sanitized_method_name
+          @sanitized_method_name ||= @method_name.sub(/\?$/,"")
+        end
+
+        def sanitized_value(value)
+          value.to_s.gsub(/\s/, "_").gsub(/[^-\w]/, "").downcase
+        end
+
+        def select_content_tag(option_tags, options, html_options)
+          html_options = html_options.stringify_keys
+          add_default_name_and_id(html_options)
+          options[:include_blank] ||= true unless options[:prompt] || select_not_required?(html_options)
+          select = content_tag("select", add_options(option_tags, options, value(object)), html_options)
+
+          if html_options["multiple"] && options.fetch(:include_hidden, true)
+            tag("input", :disabled => html_options["disabled"], :name => html_options["name"], :type => "hidden", :value => "") + select
+          else
+            select
+          end
+        end
+
+        def select_not_required?(html_options)
+          !html_options["required"] || html_options["multiple"] || html_options["size"].to_i > 1
+        end
+
+        def add_options(option_tags, options, value = nil)
+          if options[:include_blank]
+            option_tags = content_tag_string('option', options[:include_blank].kind_of?(String) ? options[:include_blank] : nil, :value => '') + "\n" + option_tags
+          end
+          if value.blank? && options[:prompt]
+            option_tags = content_tag_string('option', prompt_text(options[:prompt]), :value => '') + "\n" + option_tags
+          end
+          option_tags
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/tags/check_box.rb

@@ -0,0 +1,64 @@
+require 'action_view/helpers/tags/checkable'
+
+module ActionView
+  module Helpers
+    module Tags # :nodoc:
+      class CheckBox < Base #:nodoc:
+        include Checkable
+
+        def initialize(object_name, method_name, template_object, checked_value, unchecked_value, options)
+          @checked_value   = checked_value
+          @unchecked_value = unchecked_value
+          super(object_name, method_name, template_object, options)
+        end
+
+        def render
+          options = @options.stringify_keys
+          options["type"]     = "checkbox"
+          options["value"]    = @checked_value
+          options["checked"] = "checked" if input_checked?(object, options)
+
+          if options["multiple"]
+            add_default_name_and_id_for_value(@checked_value, options)
+            options.delete("multiple")
+          else
+            add_default_name_and_id(options)
+          end
+
+          include_hidden = options.delete("include_hidden") { true }
+          checkbox = tag("input", options)
+
+          if include_hidden
+            hidden = hidden_field_for_checkbox(options)
+            hidden + checkbox
+          else
+            checkbox
+          end
+        end
+
+        private
+
+        def checked?(value)
+          case value
+          when TrueClass, FalseClass
+            value == !!@checked_value
+          when NilClass
+            false
+          when String
+            value == @checked_value
+          else
+            if value.respond_to?(:include?)
+              value.include?(@checked_value)
+            else
+              value.to_i == @checked_value.to_i
+            end
+          end
+        end
+
+        def hidden_field_for_checkbox(options)
+          @unchecked_value ? tag("input", options.slice("name", "disabled", "form").merge!("type" => "hidden", "value" => @unchecked_value)) : "".html_safe
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/tags/checkable.rb

@@ -0,0 +1,16 @@
+module ActionView
+  module Helpers
+    module Tags # :nodoc:
+      module Checkable # :nodoc:
+        def input_checked?(object, options)
+          if options.has_key?("checked")
+            checked = options.delete "checked"
+            checked == true || checked == "checked"
+          else
+            checked?(value(object))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/tags/collection_check_boxes.rb

@@ -0,0 +1,43 @@
+require 'action_view/helpers/tags/collection_helpers'
+
+module ActionView
+  module Helpers
+    module Tags # :nodoc:
+      class CollectionCheckBoxes < Base # :nodoc:
+        include CollectionHelpers
+
+        class CheckBoxBuilder < Builder # :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
+
+        def render(&block)
+          rendered_collection = render_collection do |item, value, text, default_html_options|
+            default_html_options[:multiple] = true
+            builder = instantiate_builder(CheckBoxBuilder, item, value, text, default_html_options)
+
+            if block_given?
+              @template_object.capture(builder, &block)
+            else
+              render_component(builder)
+            end
+          end
+
+          # Append a hidden field to make sure something will be sent back to the
+          # server if all check boxes are unchecked.
+          hidden = @template_object.hidden_field_tag("#{tag_name}[]", "", :id => nil)
+
+          rendered_collection + hidden
+        end
+
+        private
+
+        def render_component(builder)
+          builder.check_box + builder.label
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/tags/collection_helpers.rb

@@ -0,0 +1,83 @@
+module ActionView
+  module Helpers
+    module Tags # :nodoc:
+      module CollectionHelpers # :nodoc:
+        class Builder # :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
+
+        def initialize(object_name, method_name, template_object, collection, value_method, text_method, options, html_options)
+          @collection   = collection
+          @value_method = value_method
+          @text_method  = text_method
+          @html_options = html_options
+
+          super(object_name, method_name, template_object, options)
+        end
+
+        private
+
+        def instantiate_builder(builder_class, item, value, text, html_options)
+          builder_class.new(@template_object, @object_name, @method_name, item,
+                            sanitize_attribute_name(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) #:nodoc:
+          html_options = @html_options.dup
+
+          [:checked, :selected, :disabled].each do |option|
+            current_value = @options[option]
+            next if current_value.nil?
+
+            accept = if current_value.respond_to?(:call)
+              current_value.call(item)
+            else
+              Array(current_value).map(&:to_s).include?(value.to_s)
+            end
+
+            if accept
+              html_options[option] = true
+            elsif option == :checked
+              html_options[option] = false
+            end
+          end
+
+          html_options[:object] = @object
+          html_options
+        end
+
+        def sanitize_attribute_name(value) #:nodoc:
+          "#{sanitized_method_name}_#{sanitized_value(value)}"
+        end
+
+        def render_collection #:nodoc:
+          @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)
+
+            yield item, value, text, default_html_options
+          end.join.html_safe
+        end
+      end
+    end
+  end
+end