actionview 4.1.0.beta1

data/lib/action_view/helpers/tag_helper.rb

@@ -0,0 +1,176 @@
+require 'active_support/core_ext/string/output_safety'
+require 'set'
+
+module ActionView
+  # = Action View Tag Helpers
+  module Helpers #:nodoc:
+    # Provides methods to generate HTML tags programmatically when you can't use
+    # a Builder. By default, they output XHTML compliant tags.
+    module TagHelper
+      extend ActiveSupport::Concern
+      include CaptureHelper
+
+      BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked autobuffer
+                           autoplay controls loop selected hidden scoped async
+                           defer reversed ismap seamless muted required
+                           autofocus novalidate formnovalidate open pubdate
+                           itemscope allowfullscreen default inert sortable
+                           truespeed typemustmatch).to_set
+
+      BOOLEAN_ATTRIBUTES.merge(BOOLEAN_ATTRIBUTES.map {|attribute| attribute.to_sym })
+
+      PRE_CONTENT_STRINGS = {
+        :textarea => "\n"
+      }
+
+      # Returns an empty HTML tag of type +name+ which by default is XHTML
+      # compliant. Set +open+ to true to create an open tag compatible
+      # with HTML 4.0 and below. Add HTML attributes by passing an attributes
+      # hash to +options+. Set +escape+ to false to disable attribute value
+      # escaping.
+      #
+      # ==== Options
+      # You can use symbols or strings for the attribute names.
+      #
+      # Use +true+ with boolean attributes that can render with no value, like
+      # +disabled+ and +readonly+.
+      #
+      # HTML5 <tt>data-*</tt> attributes can be set with a single +data+ key
+      # pointing to a hash of sub-attributes.
+      #
+      # To play nicely with JavaScript conventions sub-attributes are dasherized.
+      # For example, a key +user_id+ would render as <tt>data-user-id</tt> and
+      # 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>
+      # from 1.4.3.
+      #
+      # ==== Examples
+      #   tag("br")
+      #   # => <br />
+      #
+      #   tag("br", nil, true)
+      #   # => <br>
+      #
+      #   tag("input", type: 'text', disabled: true)
+      #   # => <input type="text" disabled="disabled" />
+      #
+      #   tag("img", src: "open & shut.png")
+      #   # => <img src="open &amp; shut.png" />
+      #
+      #   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)})
+      #   # => <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
+      end
+
+      # Returns an HTML block tag of type +name+ surrounding the +content+. Add
+      # HTML attributes by passing an attributes hash to +options+.
+      # Instead of passing the content as an argument, you can also use a block
+      # in which case, you pass your +options+ as the second parameter.
+      # Set escape to false to disable attribute value escaping.
+      #
+      # ==== Options
+      # The +options+ hash is used with attributes with no value like (<tt>disabled</tt> and
+      # <tt>readonly</tt>), which you can give a value of true in the +options+ hash. You can use
+      # symbols or strings for the attribute names.
+      #
+      # ==== Examples
+      #   content_tag(:p, "Hello world!")
+      #    # => <p>Hello world!</p>
+      #   content_tag(:div, content_tag(:p, "Hello world!"), class: "strong")
+      #    # => <div class="strong"><p>Hello world!</p></div>
+      #   content_tag("select", options, multiple: true)
+      #    # => <select multiple="multiple">...options...</select>
+      #
+      #   <%= content_tag :div, class: "strong" do -%>
+      #     Hello world!
+      #   <% end -%>
+      #    # => <div class="strong">Hello world!</div>
+      def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+        if block_given?
+          options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
+          content_tag_string(name, capture(&block), options, escape)
+        else
+          content_tag_string(name, content_or_options_with_block, options, escape)
+        end
+      end
+
+      # Returns a CDATA section with the given +content+. CDATA sections
+      # are used to escape blocks of text containing characters which would
+      # 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>.
+      #
+      #   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)
+        splitted = content.to_s.gsub(']]>', ']]]]><![CDATA[>')
+        "<![CDATA[#{splitted}]]>".html_safe
+      end
+
+      # Returns an escaped version of +html+ without affecting existing escaped entities.
+      #
+      #   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)
+        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
+          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)
+          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
+          end
+          " #{attrs.sort! * ' '}" 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
+end

data/lib/action_view/helpers/tags.rb

@@ -0,0 +1,41 @@
+module ActionView
+  module Helpers
+    module Tags #:nodoc:
+      extend ActiveSupport::Autoload
+
+      eager_autoload do
+        autoload :Base
+        autoload :CheckBox
+        autoload :CollectionCheckBoxes
+        autoload :CollectionRadioButtons
+        autoload :CollectionSelect
+        autoload :ColorField
+        autoload :DateField
+        autoload :DateSelect
+        autoload :DatetimeField
+        autoload :DatetimeLocalField
+        autoload :DatetimeSelect
+        autoload :EmailField
+        autoload :FileField
+        autoload :GroupedCollectionSelect
+        autoload :HiddenField
+        autoload :Label
+        autoload :MonthField
+        autoload :NumberField
+        autoload :PasswordField
+        autoload :RadioButton
+        autoload :RangeField
+        autoload :SearchField
+        autoload :Select
+        autoload :TelField
+        autoload :TextArea
+        autoload :TextField
+        autoload :TimeField
+        autoload :TimeSelect
+        autoload :TimeZoneSelect
+        autoload :UrlField
+        autoload :WeekField
+      end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+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)
+          value = options.fetch(:selected) { value(object) }
+          select = content_tag("select", add_options(option_tags, options, value), 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