diff options
Diffstat (limited to 'actionpack/lib/action_view/helpers')
57 files changed, 0 insertions, 9312 deletions
diff --git a/actionpack/lib/action_view/helpers/active_model_helper.rb b/actionpack/lib/action_view/helpers/active_model_helper.rb deleted file mode 100644 index 901f433c70..0000000000 --- a/actionpack/lib/action_view/helpers/active_model_helper.rb +++ /dev/null @@ -1,49 +0,0 @@ -require 'active_support/core_ext/class/attribute_accessors' -require 'active_support/core_ext/enumerable' - -module ActionView - # = Active Model Helpers - module Helpers - module ActiveModelHelper - end - - module ActiveModelInstanceTag - def object - @active_model_object ||= begin - object = super - object.respond_to?(:to_model) ? object.to_model : object - end - end - - def content_tag(*) - error_wrapping(super) - end - - def tag(type, options, *) - tag_generate_errors?(options) ? error_wrapping(super) : super - end - - def error_wrapping(html_tag) - if object_has_errors? - Base.field_error_proc.call(html_tag, self) - else - html_tag - end - end - - def error_message - object.errors[@method_name] - end - - private - - def object_has_errors? - object.respond_to?(:errors) && object.errors.respond_to?(:[]) && error_message.present? - end - - def tag_generate_errors?(options) - options['type'] != 'hidden' - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/asset_tag_helper.rb b/actionpack/lib/action_view/helpers/asset_tag_helper.rb deleted file mode 100644 index 2b3a3c6a29..0000000000 --- a/actionpack/lib/action_view/helpers/asset_tag_helper.rb +++ /dev/null @@ -1,316 +0,0 @@ -require 'active_support/core_ext/array/extract_options' -require 'active_support/core_ext/hash/keys' -require 'action_view/helpers/asset_url_helper' -require 'action_view/helpers/tag_helper' - -module ActionView - # = Action View Asset Tag Helpers - module Helpers #:nodoc: - # This module provides methods for generating HTML that links views to assets such - # as images, javascripts, stylesheets, and feeds. These methods do not verify - # the assets exist before linking to them: - # - # image_tag("rails.png") - # # => <img alt="Rails" src="/assets/rails.png" /> - # stylesheet_link_tag("application") - # # => <link href="/assets/application.css?body=1" media="screen" rel="stylesheet" /> - module AssetTagHelper - extend ActiveSupport::Concern - - include AssetUrlHelper - include TagHelper - - # Returns an HTML script tag for each of the +sources+ provided. - # - # Sources may be paths to JavaScript files. Relative paths are assumed to be relative - # to <tt>assets/javascripts</tt>, full paths are assumed to be relative to the document - # root. Relative paths are idiomatic, use absolute paths only when needed. - # - # When passing paths, the ".js" extension is optional. - # - # You can modify the HTML attributes of the script tag by passing a hash as the - # last argument. - # - # When the Asset Pipeline is enabled, you can pass the name of your manifest as - # source, and include other JavaScript or CoffeeScript files inside the manifest. - # - # javascript_include_tag "xmlhr" - # # => <script src="/assets/xmlhr.js?1284139606"></script> - # - # javascript_include_tag "xmlhr.js" - # # => <script src="/assets/xmlhr.js?1284139606"></script> - # - # javascript_include_tag "common.javascript", "/elsewhere/cools" - # # => <script src="/assets/common.javascript?1284139606"></script> - # # <script src="/elsewhere/cools.js?1423139606"></script> - # - # javascript_include_tag "http://www.example.com/xmlhr" - # # => <script src="http://www.example.com/xmlhr"></script> - # - # javascript_include_tag "http://www.example.com/xmlhr.js" - # # => <script src="http://www.example.com/xmlhr.js"></script> - def javascript_include_tag(*sources) - options = sources.extract_options!.stringify_keys - path_options = options.extract!('protocol').symbolize_keys - - sources.uniq.map { |source| - tag_options = { - "src" => path_to_javascript(source, path_options) - }.merge!(options) - content_tag(:script, "", tag_options) - }.join("\n").html_safe - end - - # Returns a stylesheet link tag for the sources specified as arguments. If - # you don't specify an extension, <tt>.css</tt> will be appended automatically. - # You can modify the link attributes by passing a hash as the last argument. - # For historical reasons, the 'media' attribute will always be present and defaults - # to "screen", so you must explicitly set it to "all" for the stylesheet(s) to - # apply to all media types. - # - # stylesheet_link_tag "style" - # # => <link href="/assets/style.css" media="screen" rel="stylesheet" /> - # - # stylesheet_link_tag "style.css" - # # => <link href="/assets/style.css" media="screen" rel="stylesheet" /> - # - # stylesheet_link_tag "http://www.example.com/style.css" - # # => <link href="http://www.example.com/style.css" media="screen" rel="stylesheet" /> - # - # stylesheet_link_tag "style", media: "all" - # # => <link href="/assets/style.css" media="all" rel="stylesheet" /> - # - # stylesheet_link_tag "style", media: "print" - # # => <link href="/assets/style.css" media="print" rel="stylesheet" /> - # - # stylesheet_link_tag "random.styles", "/css/stylish" - # # => <link href="/assets/random.styles" media="screen" rel="stylesheet" /> - # # <link href="/css/stylish.css" media="screen" rel="stylesheet" /> - def stylesheet_link_tag(*sources) - options = sources.extract_options!.stringify_keys - path_options = options.extract!('protocol').symbolize_keys - - sources.uniq.map { |source| - tag_options = { - "rel" => "stylesheet", - "media" => "screen", - "href" => path_to_stylesheet(source, path_options) - }.merge!(options) - tag(:link, tag_options) - }.join("\n").html_safe - end - - # Returns a link tag that browsers and news readers can use to auto-detect - # an RSS or Atom feed. The +type+ can either be <tt>:rss</tt> (default) or - # <tt>:atom</tt>. Control the link options in url_for format using the - # +url_options+. You can modify the LINK tag itself in +tag_options+. - # - # ==== Options - # - # * <tt>:rel</tt> - Specify the relation of this link, defaults to "alternate" - # * <tt>:type</tt> - Override the auto-generated mime type - # * <tt>:title</tt> - Specify the title of the link, defaults to the +type+ - # - # ==== Examples - # - # auto_discovery_link_tag - # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/action" /> - # auto_discovery_link_tag(:atom) - # # => <link rel="alternate" type="application/atom+xml" title="ATOM" href="http://www.currenthost.com/controller/action" /> - # auto_discovery_link_tag(:rss, {action: "feed"}) - # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/feed" /> - # auto_discovery_link_tag(:rss, {action: "feed"}, {title: "My RSS"}) - # # => <link rel="alternate" type="application/rss+xml" title="My RSS" href="http://www.currenthost.com/controller/feed" /> - # auto_discovery_link_tag(:rss, {controller: "news", action: "feed"}) - # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/news/feed" /> - # auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {title: "Example RSS"}) - # # => <link rel="alternate" type="application/rss+xml" title="Example RSS" href="http://www.example.com/feed" /> - def auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {}) - if !(type == :rss || type == :atom) && tag_options[:type].blank? - raise ArgumentError.new("You should pass :type tag_option key explicitly, because you have passed #{type} type other than :rss or :atom.") - end - - tag( - "link", - "rel" => tag_options[:rel] || "alternate", - "type" => tag_options[:type] || Mime::Type.lookup_by_extension(type.to_s).to_s, - "title" => tag_options[:title] || type.to_s.upcase, - "href" => url_options.is_a?(Hash) ? url_for(url_options.merge(:only_path => false)) : url_options - ) - end - - # Returns a link loading a favicon file. You may specify a different file - # in the first argument. The helper accepts an additional options hash where - # you can override "rel" and "type". - # - # ==== Options - # - # * <tt>:rel</tt> - Specify the relation of this link, defaults to 'shortcut icon' - # * <tt>:type</tt> - Override the auto-generated mime type, defaults to 'image/vnd.microsoft.icon' - # - # ==== Examples - # - # favicon_link_tag '/myicon.ico' - # # => <link href="/assets/myicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" /> - # - # Mobile Safari looks for a different <link> tag, pointing to an image that - # will be used if you add the page to the home screen of an iPod Touch, iPhone, or iPad. - # The following call would generate such a tag: - # - # favicon_link_tag '/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' - # # => <link href="/assets/mb-icon.png" rel="apple-touch-icon" type="image/png" /> - def favicon_link_tag(source='favicon.ico', options={}) - tag('link', { - :rel => 'shortcut icon', - :type => 'image/vnd.microsoft.icon', - :href => path_to_image(source) - }.merge!(options.symbolize_keys)) - end - - # Returns an HTML image tag for the +source+. The +source+ can be a full - # path or a file. - # - # ==== Options - # - # You can add HTML attributes using the +options+. The +options+ supports - # three additional keys for convenience and conformance: - # - # * <tt>:alt</tt> - If no alt text is given, the file name part of the - # +source+ is used (capitalized and without the extension) - # * <tt>:size</tt> - Supplied as "{Width}x{Height}" or "{Number}", so "30x45" becomes - # width="30" and height="45", and "50" becomes width="50" and height="50". - # <tt>:size</tt> will be ignored if the value is not in the correct format. - # - # ==== Examples - # - # image_tag("icon") - # # => <img alt="Icon" src="/assets/icon" /> - # image_tag("icon.png") - # # => <img alt="Icon" src="/assets/icon.png" /> - # image_tag("icon.png", size: "16x10", alt: "Edit Entry") - # # => <img src="/assets/icon.png" width="16" height="10" alt="Edit Entry" /> - # image_tag("/icons/icon.gif", size: "16") - # # => <img src="/icons/icon.gif" width="16" height="16" alt="Icon" /> - # image_tag("/icons/icon.gif", height: '32', width: '32') - # # => <img alt="Icon" height="32" src="/icons/icon.gif" width="32" /> - # image_tag("/icons/icon.gif", class: "menu_icon") - # # => <img alt="Icon" class="menu_icon" src="/icons/icon.gif" /> - def image_tag(source, options={}) - options = options.symbolize_keys - - src = options[:src] = path_to_image(source) - - unless src =~ /^(?:cid|data):/ || src.blank? - options[:alt] = options.fetch(:alt){ image_alt(src) } - end - - if size = options.delete(:size) - options[:width], options[:height] = size.split("x") if size =~ %r{\A\d+x\d+\z} - options[:width] = options[:height] = size if size =~ %r{\A\d+\z} - end - - tag("img", options) - end - - # Returns a string suitable for an html image tag alt attribute. - # The +src+ argument is meant to be an image file path. - # The method removes the basename of the file path and the digest, - # if any. It also removes hyphens and underscores from file names and - # replaces them with spaces, returning a space-separated, titleized - # string. - # - # ==== Examples - # - # image_tag('rails.png') - # # => <img alt="Rails" src="/assets/rails.png" /> - # - # image_tag('hyphenated-file-name.png') - # # => <img alt="Hyphenated file name" src="/assets/hyphenated-file-name.png" /> - # - # image_tag('underscored_file_name.png') - # # => <img alt="Underscored file name" src="/assets/underscored_file_name.png" /> - def image_alt(src) - File.basename(src, '.*').sub(/-[[:xdigit:]]{32}\z/, '').tr('-_', ' ').capitalize - end - - # Returns an html video tag for the +sources+. If +sources+ is a string, - # a single video tag will be returned. If +sources+ is an array, a video - # tag with nested source tags for each source will be returned. The - # +sources+ can be full paths or files that exists in your public videos - # directory. - # - # ==== Options - # You can add HTML attributes using the +options+. The +options+ supports - # two additional keys for convenience and conformance: - # - # * <tt>:poster</tt> - Set an image (like a screenshot) to be shown - # before the video loads. The path is calculated like the +src+ of +image_tag+. - # * <tt>:size</tt> - Supplied as "{Width}x{Height}", so "30x45" becomes - # width="30" and height="45". <tt>:size</tt> will be ignored if the - # value is not in the correct format. - # - # ==== Examples - # - # video_tag("trailer") - # # => <video src="/videos/trailer" /> - # video_tag("trailer.ogg") - # # => <video src="/videos/trailer.ogg" /> - # video_tag("trailer.ogg", controls: true, autobuffer: true) - # # => <video autobuffer="autobuffer" controls="controls" src="/videos/trailer.ogg" /> - # video_tag("trailer.m4v", size: "16x10", poster: "screenshot.png") - # # => <video src="/videos/trailer.m4v" width="16" height="10" poster="/assets/screenshot.png" /> - # video_tag("/trailers/hd.avi", size: "16x16") - # # => <video src="/trailers/hd.avi" width="16" height="16" /> - # video_tag("/trailers/hd.avi", height: '32', width: '32') - # # => <video height="32" src="/trailers/hd.avi" width="32" /> - # video_tag("trailer.ogg", "trailer.flv") - # # => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video> - # video_tag(["trailer.ogg", "trailer.flv"]) - # # => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video> - # video_tag(["trailer.ogg", "trailer.flv"], size: "160x120") - # # => <video height="120" width="160"><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video> - def video_tag(*sources) - multiple_sources_tag('video', sources) do |options| - options[:poster] = path_to_image(options[:poster]) if options[:poster] - - if size = options.delete(:size) - options[:width], options[:height] = size.split("x") if size =~ %r{^\d+x\d+$} - end - end - end - - # Returns an HTML audio tag for the +source+. - # The +source+ can be full path or file that exists in - # your public audios directory. - # - # audio_tag("sound") - # # => <audio src="/audios/sound" /> - # audio_tag("sound.wav") - # # => <audio src="/audios/sound.wav" /> - # audio_tag("sound.wav", autoplay: true, controls: true) - # # => <audio autoplay="autoplay" controls="controls" src="/audios/sound.wav" /> - # audio_tag("sound.wav", "sound.mid") - # # => <audio><source src="/audios/sound.wav" /><source src="/audios/sound.mid" /></audio> - def audio_tag(*sources) - multiple_sources_tag('audio', sources) - end - - private - def multiple_sources_tag(type, sources) - options = sources.extract_options!.symbolize_keys - sources.flatten! - - yield options if block_given? - - if sources.size > 1 - content_tag(type, options) do - safe_join sources.map { |source| tag("source", :src => send("path_to_#{type}", source)) } - end - else - options[:src] = send("path_to_#{type}", sources.first) - content_tag(type, nil, options) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/asset_url_helper.rb b/actionpack/lib/action_view/helpers/asset_url_helper.rb deleted file mode 100644 index 0b957adb91..0000000000 --- a/actionpack/lib/action_view/helpers/asset_url_helper.rb +++ /dev/null @@ -1,355 +0,0 @@ -require 'zlib' - -module ActionView - # = Action View Asset URL Helpers - module Helpers - # This module provides methods for generating asset paths and - # urls. - # - # image_path("rails.png") - # # => "/assets/rails.png" - # - # image_url("rails.png") - # # => "http://www.example.com/assets/rails.png" - # - # === Using asset hosts - # - # By default, Rails links to these assets on the current host in the public - # folder, but you can direct Rails to link to assets from a dedicated asset - # server by setting <tt>ActionController::Base.asset_host</tt> in the application - # configuration, typically in <tt>config/environments/production.rb</tt>. - # For example, you'd define <tt>assets.example.com</tt> to be your asset - # host this way, inside the <tt>configure</tt> block of your environment-specific - # configuration files or <tt>config/application.rb</tt>: - # - # config.action_controller.asset_host = "assets.example.com" - # - # Helpers take that into account: - # - # image_tag("rails.png") - # # => <img alt="Rails" src="http://assets.example.com/assets/rails.png" /> - # stylesheet_link_tag("application") - # # => <link href="http://assets.example.com/assets/application.css" media="screen" rel="stylesheet" /> - # - # Browsers typically open at most two simultaneous connections to a single - # host, which means your assets often have to wait for other assets to finish - # downloading. You can alleviate this by using a <tt>%d</tt> wildcard in the - # +asset_host+. For example, "assets%d.example.com". If that wildcard is - # present Rails distributes asset requests among the corresponding four hosts - # "assets0.example.com", ..., "assets3.example.com". With this trick browsers - # will open eight simultaneous connections rather than two. - # - # image_tag("rails.png") - # # => <img alt="Rails" src="http://assets0.example.com/assets/rails.png" /> - # stylesheet_link_tag("application") - # # => <link href="http://assets2.example.com/assets/application.css" media="screen" rel="stylesheet" /> - # - # To do this, you can either setup four actual hosts, or you can use wildcard - # DNS to CNAME the wildcard to a single asset host. You can read more about - # setting up your DNS CNAME records from your ISP. - # - # Note: This is purely a browser performance optimization and is not meant - # for server load balancing. See http://www.die.net/musings/page_load_time/ - # for background. - # - # Alternatively, you can exert more control over the asset host by setting - # +asset_host+ to a proc like this: - # - # ActionController::Base.asset_host = Proc.new { |source| - # "http://assets#{Digest::MD5.hexdigest(source).to_i(16) % 2 + 1}.example.com" - # } - # image_tag("rails.png") - # # => <img alt="Rails" src="http://assets1.example.com/assets/rails.png" /> - # stylesheet_link_tag("application") - # # => <link href="http://assets2.example.com/assets/application.css" media="screen" rel="stylesheet" /> - # - # The example above generates "http://assets1.example.com" and - # "http://assets2.example.com". This option is useful for example if - # you need fewer/more than four hosts, custom host names, etc. - # - # As you see the proc takes a +source+ parameter. That's a string with the - # absolute path of the asset, for example "/assets/rails.png". - # - # ActionController::Base.asset_host = Proc.new { |source| - # if source.ends_with?('.css') - # "http://stylesheets.example.com" - # else - # "http://assets.example.com" - # end - # } - # image_tag("rails.png") - # # => <img alt="Rails" src="http://assets.example.com/assets/rails.png" /> - # stylesheet_link_tag("application") - # # => <link href="http://stylesheets.example.com/assets/application.css" media="screen" rel="stylesheet" /> - # - # Alternatively you may ask for a second parameter +request+. That one is - # particularly useful for serving assets from an SSL-protected page. The - # example proc below disables asset hosting for HTTPS connections, while - # still sending assets for plain HTTP requests from asset hosts. If you don't - # have SSL certificates for each of the asset hosts this technique allows you - # to avoid warnings in the client about mixed media. - # - # config.action_controller.asset_host = Proc.new { |source, request| - # if request.ssl? - # "#{request.protocol}#{request.host_with_port}" - # else - # "#{request.protocol}assets.example.com" - # end - # } - # - # You can also implement a custom asset host object that responds to +call+ - # and takes either one or two parameters just like the proc. - # - # config.action_controller.asset_host = AssetHostingWithMinimumSsl.new( - # "http://asset%d.example.com", "https://asset1.example.com" - # ) - # - module AssetUrlHelper - URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}i - - # Computes the path to asset in public directory. If :type - # options is set, a file extension will be appended and scoped - # to the corresponding public directory. - # - # All other asset *_path helpers delegate through this method. - # - # asset_path "application.js" # => /application.js - # asset_path "application", type: :javascript # => /javascripts/application.js - # asset_path "application", type: :stylesheet # => /stylesheets/application.css - # asset_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js - def asset_path(source, options = {}) - source = source.to_s - return "" unless source.present? - return source if source =~ URI_REGEXP - - tail, source = source[/([\?#].+)$/], source.sub(/([\?#].+)$/, '') - - if extname = compute_asset_extname(source, options) - source = "#{source}#{extname}" - end - - if source[0] != ?/ - source = compute_asset_path(source, options) - end - - relative_url_root = defined?(config.relative_url_root) && config.relative_url_root - if relative_url_root - source = "#{relative_url_root}#{source}" unless source.starts_with?("#{relative_url_root}/") - end - - if host = compute_asset_host(source, options) - source = "#{host}#{source}" - end - - "#{source}#{tail}" - end - alias_method :path_to_asset, :asset_path # aliased to avoid conflicts with a asset_path named route - - # Computes the full URL to a asset in the public directory. This - # will use +asset_path+ internally, so most of their behaviors - # will be the same. - def asset_url(source, options = {}) - path_to_asset(source, options.merge(:protocol => :request)) - end - alias_method :url_to_asset, :asset_url # aliased to avoid conflicts with an asset_url named route - - ASSET_EXTENSIONS = { - javascript: '.js', - stylesheet: '.css' - } - - # Compute extname to append to asset path. Returns nil if - # nothing should be added. - def compute_asset_extname(source, options = {}) - return if options[:extname] == false - extname = options[:extname] || ASSET_EXTENSIONS[options[:type]] - extname if extname && File.extname(source) != extname - end - - # Maps asset types to public directory. - ASSET_PUBLIC_DIRECTORIES = { - audio: '/audios', - font: '/fonts', - image: '/images', - javascript: '/javascripts', - stylesheet: '/stylesheets', - video: '/videos' - } - - # Computes asset path to public directory. Plugins and - # extensions can override this method to point to custom assets - # or generate digested paths or query strings. - def compute_asset_path(source, options = {}) - dir = ASSET_PUBLIC_DIRECTORIES[options[:type]] || "" - File.join(dir, source) - end - - # Pick an asset host for this source. Returns +nil+ if no host is set, - # the host if no wildcard is set, the host interpolated with the - # numbers 0-3 if it contains <tt>%d</tt> (the number is the source hash mod 4), - # or the value returned from invoking call on an object responding to call - # (proc or otherwise). - def compute_asset_host(source = "", options = {}) - request = self.request if respond_to?(:request) - host = config.asset_host if defined? config.asset_host - host ||= request.base_url if request && options[:protocol] == :request - - if host.respond_to?(:call) - arity = host.respond_to?(:arity) ? host.arity : host.method(:call).arity - args = [source] - args << request if request && (arity > 1 || arity < 0) - host = host.call(*args) - elsif host =~ /%d/ - host = host % (Zlib.crc32(source) % 4) - end - - return unless host - - if host =~ URI_REGEXP - host - else - protocol = options[:protocol] || config.default_asset_host_protocol || (request ? :request : :relative) - case protocol - when :relative - "//#{host}" - when :request - "#{request.protocol}#{host}" - else - "#{protocol}://#{host}" - end - end - end - - # Computes the path to a javascript asset in the public javascripts directory. - # If the +source+ filename has no extension, .js will be appended (except for explicit URIs) - # Full paths from the document root will be passed through. - # Used internally by javascript_include_tag to build the script path. - # - # javascript_path "xmlhr" # => /javascripts/xmlhr.js - # javascript_path "dir/xmlhr.js" # => /javascripts/dir/xmlhr.js - # javascript_path "/dir/xmlhr" # => /dir/xmlhr.js - # javascript_path "http://www.example.com/js/xmlhr" # => http://www.example.com/js/xmlhr - # javascript_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js - def javascript_path(source, options = {}) - path_to_asset(source, {type: :javascript}.merge!(options)) - end - alias_method :path_to_javascript, :javascript_path # aliased to avoid conflicts with a javascript_path named route - - # Computes the full URL to a javascript asset in the public javascripts directory. - # This will use +javascript_path+ internally, so most of their behaviors will be the same. - def javascript_url(source, options = {}) - url_to_asset(source, {type: :javascript}.merge!(options)) - end - alias_method :url_to_javascript, :javascript_url # aliased to avoid conflicts with a javascript_url named route - - # Computes the path to a stylesheet asset in the public stylesheets directory. - # If the +source+ filename has no extension, <tt>.css</tt> will be appended (except for explicit URIs). - # Full paths from the document root will be passed through. - # Used internally by +stylesheet_link_tag+ to build the stylesheet path. - # - # stylesheet_path "style" # => /stylesheets/style.css - # stylesheet_path "dir/style.css" # => /stylesheets/dir/style.css - # stylesheet_path "/dir/style.css" # => /dir/style.css - # stylesheet_path "http://www.example.com/css/style" # => http://www.example.com/css/style - # stylesheet_path "http://www.example.com/css/style.css" # => http://www.example.com/css/style.css - def stylesheet_path(source, options = {}) - path_to_asset(source, {type: :stylesheet}.merge!(options)) - end - alias_method :path_to_stylesheet, :stylesheet_path # aliased to avoid conflicts with a stylesheet_path named route - - # Computes the full URL to a stylesheet asset in the public stylesheets directory. - # This will use +stylesheet_path+ internally, so most of their behaviors will be the same. - def stylesheet_url(source, options = {}) - url_to_asset(source, {type: :stylesheet}.merge!(options)) - end - alias_method :url_to_stylesheet, :stylesheet_url # aliased to avoid conflicts with a stylesheet_url named route - - # Computes the path to an image asset. - # Full paths from the document root will be passed through. - # Used internally by +image_tag+ to build the image path: - # - # image_path("edit") # => "/assets/edit" - # image_path("edit.png") # => "/assets/edit.png" - # image_path("icons/edit.png") # => "/assets/icons/edit.png" - # image_path("/icons/edit.png") # => "/icons/edit.png" - # image_path("http://www.example.com/img/edit.png") # => "http://www.example.com/img/edit.png" - # - # If you have images as application resources this method may conflict with their named routes. - # The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and - # plugin authors are encouraged to do so. - def image_path(source, options = {}) - path_to_asset(source, {type: :image}.merge!(options)) - end - alias_method :path_to_image, :image_path # aliased to avoid conflicts with an image_path named route - - # Computes the full URL to an image asset. - # This will use +image_path+ internally, so most of their behaviors will be the same. - def image_url(source, options = {}) - url_to_asset(source, {type: :image}.merge!(options)) - end - alias_method :url_to_image, :image_url # aliased to avoid conflicts with an image_url named route - - # Computes the path to a video asset in the public videos directory. - # Full paths from the document root will be passed through. - # Used internally by +video_tag+ to build the video path. - # - # video_path("hd") # => /videos/hd - # video_path("hd.avi") # => /videos/hd.avi - # video_path("trailers/hd.avi") # => /videos/trailers/hd.avi - # video_path("/trailers/hd.avi") # => /trailers/hd.avi - # video_path("http://www.example.com/vid/hd.avi") # => http://www.example.com/vid/hd.avi - def video_path(source, options = {}) - path_to_asset(source, {type: :video}.merge!(options)) - end - alias_method :path_to_video, :video_path # aliased to avoid conflicts with a video_path named route - - # Computes the full URL to a video asset in the public videos directory. - # This will use +video_path+ internally, so most of their behaviors will be the same. - def video_url(source, options = {}) - url_to_asset(source, {type: :video}.merge!(options)) - end - alias_method :url_to_video, :video_url # aliased to avoid conflicts with an video_url named route - - # Computes the path to an audio asset in the public audios directory. - # Full paths from the document root will be passed through. - # Used internally by +audio_tag+ to build the audio path. - # - # audio_path("horse") # => /audios/horse - # audio_path("horse.wav") # => /audios/horse.wav - # audio_path("sounds/horse.wav") # => /audios/sounds/horse.wav - # audio_path("/sounds/horse.wav") # => /sounds/horse.wav - # audio_path("http://www.example.com/sounds/horse.wav") # => http://www.example.com/sounds/horse.wav - def audio_path(source, options = {}) - path_to_asset(source, {type: :audio}.merge!(options)) - end - alias_method :path_to_audio, :audio_path # aliased to avoid conflicts with an audio_path named route - - # Computes the full URL to an audio asset in the public audios directory. - # This will use +audio_path+ internally, so most of their behaviors will be the same. - def audio_url(source, options = {}) - url_to_asset(source, {type: :audio}.merge!(options)) - end - alias_method :url_to_audio, :audio_url # aliased to avoid conflicts with an audio_url named route - - # Computes the path to a font asset. - # Full paths from the document root will be passed through. - # - # font_path("font") # => /assets/font - # font_path("font.ttf") # => /assets/font.ttf - # font_path("dir/font.ttf") # => /assets/dir/font.ttf - # font_path("/dir/font.ttf") # => /dir/font.ttf - # font_path("http://www.example.com/dir/font.ttf") # => http://www.example.com/dir/font.ttf - def font_path(source, options = {}) - path_to_asset(source, {type: :font}.merge!(options)) - end - alias_method :path_to_font, :font_path # aliased to avoid conflicts with an font_path named route - - # Computes the full URL to a font asset. - # This will use +font_path+ internally, so most of their behaviors will be the same. - def font_url(source, options = {}) - url_to_asset(source, {type: :font}.merge!(options)) - end - alias_method :url_to_font, :font_url # aliased to avoid conflicts with an font_url named route - end - end -end diff --git a/actionpack/lib/action_view/helpers/atom_feed_helper.rb b/actionpack/lib/action_view/helpers/atom_feed_helper.rb deleted file mode 100644 index 42b1dd8933..0000000000 --- a/actionpack/lib/action_view/helpers/atom_feed_helper.rb +++ /dev/null @@ -1,203 +0,0 @@ -require 'set' - -module ActionView - # = Action View Atom Feed Helpers - module Helpers - module AtomFeedHelper - # Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERB or any other - # template languages). - # - # Full usage example: - # - # config/routes.rb: - # Basecamp::Application.routes.draw do - # resources :posts - # root to: "posts#index" - # end - # - # app/controllers/posts_controller.rb: - # class PostsController < ApplicationController::Base - # # GET /posts.html - # # GET /posts.atom - # def index - # @posts = Post.all - # - # respond_to do |format| - # format.html - # format.atom - # end - # end - # end - # - # app/views/posts/index.atom.builder: - # atom_feed do |feed| - # feed.title("My great blog!") - # feed.updated(@posts[0].created_at) if @posts.length > 0 - # - # @posts.each do |post| - # feed.entry(post) do |entry| - # entry.title(post.title) - # entry.content(post.body, type: 'html') - # - # entry.author do |author| - # author.name("DHH") - # end - # end - # end - # end - # - # The options for atom_feed are: - # - # * <tt>:language</tt>: Defaults to "en-US". - # * <tt>:root_url</tt>: The HTML alternative that this feed is doubling for. Defaults to / on the current host. - # * <tt>:url</tt>: The URL for this feed. Defaults to the current URL. - # * <tt>:id</tt>: The id for this feed. Defaults to "tag:#{request.host},#{options[:schema_date]}:#{request.fullpath.split(".")[0]}" - # * <tt>:schema_date</tt>: The date at which the tag scheme for the feed was first used. A good default is the year you - # created the feed. See http://feedvalidator.org/docs/error/InvalidTAG.html for more information. If not specified, - # 2005 is used (as an "I don't care" value). - # * <tt>:instruct</tt>: Hash of XML processing instructions in the form {target => {attribute => value, }} or {target => [{attribute => value, }, ]} - # - # Other namespaces can be added to the root element: - # - # app/views/posts/index.atom.builder: - # atom_feed({'xmlns:app' => 'http://www.w3.org/2007/app', - # 'xmlns:openSearch' => 'http://a9.com/-/spec/opensearch/1.1/'}) do |feed| - # feed.title("My great blog!") - # feed.updated((@posts.first.created_at)) - # feed.tag!(openSearch:totalResults, 10) - # - # @posts.each do |post| - # feed.entry(post) do |entry| - # entry.title(post.title) - # entry.content(post.body, type: 'html') - # entry.tag!('app:edited', Time.now) - # - # entry.author do |author| - # author.name("DHH") - # end - # end - # end - # end - # - # The Atom spec defines five elements (content rights title subtitle - # summary) which may directly contain xhtml content if type: 'xhtml' - # is specified as an attribute. If so, this helper will take care of - # the enclosing div and xhtml namespace declaration. Example usage: - # - # entry.summary type: 'xhtml' do |xhtml| - # xhtml.p pluralize(order.line_items.count, "line item") - # xhtml.p "Shipped to #{order.address}" - # xhtml.p "Paid by #{order.pay_type}" - # end - # - # - # <tt>atom_feed</tt> yields an +AtomFeedBuilder+ instance. Nested elements yield - # an +AtomBuilder+ instance. - def atom_feed(options = {}, &block) - if options[:schema_date] - options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime) - else - options[:schema_date] = "2005" # The Atom spec copyright date - end - - xml = options.delete(:xml) || eval("xml", block.binding) - xml.instruct! - if options[:instruct] - options[:instruct].each do |target,attrs| - if attrs.respond_to?(:keys) - xml.instruct!(target, attrs) - elsif attrs.respond_to?(:each) - attrs.each { |attr_group| xml.instruct!(target, attr_group) } - end - end - end - - feed_opts = {"xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom'} - feed_opts.merge!(options).reject!{|k,v| !k.to_s.match(/^xml/)} - - xml.feed(feed_opts) do - xml.id(options[:id] || "tag:#{request.host},#{options[:schema_date]}:#{request.fullpath.split(".")[0]}") - xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port)) - xml.link(:rel => 'self', :type => 'application/atom+xml', :href => options[:url] || request.url) - - yield AtomFeedBuilder.new(xml, self, options) - end - end - - class AtomBuilder #:nodoc: - XHTML_TAG_NAMES = %w(content rights title subtitle summary).to_set - - def initialize(xml) - @xml = xml - end - - private - # Delegate to xml builder, first wrapping the element in a xhtml - # namespaced div element if the method and arguments indicate - # that an xhtml_block? is desired. - def method_missing(method, *arguments, &block) - if xhtml_block?(method, arguments) - @xml.__send__(method, *arguments) do - @xml.div(:xmlns => 'http://www.w3.org/1999/xhtml') do |xhtml| - block.call(xhtml) - end - end - else - @xml.__send__(method, *arguments, &block) - end - end - - # True if the method name matches one of the five elements defined - # in the Atom spec as potentially containing XHTML content and - # if type: 'xhtml' is, in fact, specified. - def xhtml_block?(method, arguments) - if XHTML_TAG_NAMES.include?(method.to_s) - last = arguments.last - last.is_a?(Hash) && last[:type].to_s == 'xhtml' - end - end - end - - class AtomFeedBuilder < AtomBuilder #:nodoc: - def initialize(xml, view, feed_options = {}) - @xml, @view, @feed_options = xml, view, feed_options - end - - # Accepts a Date or Time object and inserts it in the proper format. If nil is passed, current time in UTC is used. - def updated(date_or_time = nil) - @xml.updated((date_or_time || Time.now.utc).xmlschema) - end - - # Creates an entry tag for a specific record and prefills the id using class and id. - # - # Options: - # - # * <tt>:published</tt>: Time first published. Defaults to the created_at attribute on the record if one such exists. - # * <tt>:updated</tt>: Time of update. Defaults to the updated_at attribute on the record if one such exists. - # * <tt>:url</tt>: The URL for this entry. Defaults to the polymorphic_url for the record. - # * <tt>:id</tt>: The ID for this entry. Defaults to "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}" - # * <tt>:type</tt>: The TYPE for this entry. Defaults to "text/html". - def entry(record, options = {}) - @xml.entry do - @xml.id(options[:id] || "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}") - - if options[:published] || (record.respond_to?(:created_at) && record.created_at) - @xml.published((options[:published] || record.created_at).xmlschema) - end - - if options[:updated] || (record.respond_to?(:updated_at) && record.updated_at) - @xml.updated((options[:updated] || record.updated_at).xmlschema) - end - - type = options.fetch(:type, 'text/html') - - @xml.link(:rel => 'alternate', :type => type, :href => options[:url] || @view.polymorphic_url(record)) - - yield AtomBuilder.new(@xml) - end - end - end - - end - end -end diff --git a/actionpack/lib/action_view/helpers/cache_helper.rb b/actionpack/lib/action_view/helpers/cache_helper.rb deleted file mode 100644 index 8fc78ea7fb..0000000000 --- a/actionpack/lib/action_view/helpers/cache_helper.rb +++ /dev/null @@ -1,196 +0,0 @@ -module ActionView - # = Action View Cache Helper - module Helpers - module CacheHelper - # This helper exposes a method for caching fragments of a view - # rather than an entire action or page. This technique is useful - # caching pieces like menus, lists of newstopics, static HTML - # fragments, and so on. This method takes a block that contains - # the content you wish to cache. - # - # The best way to use this is by doing key-based cache expiration - # on top of a cache store like Memcached that'll automatically - # kick out old entries. For more on key-based expiration, see: - # http://37signals.com/svn/posts/3113-how-key-based-cache-expiration-works - # - # When using this method, you list the cache dependency as the name of the cache, like so: - # - # <% cache project do %> - # <b>All the topics on this project</b> - # <%= render project.topics %> - # <% end %> - # - # This approach will assume that when a new topic is added, you'll touch - # the project. The cache key generated from this call will be something like: - # - # views/projects/123-20120806214154/7a1156131a6928cb0026877f8b749ac9 - # ^class ^id ^updated_at ^template tree digest - # - # The cache is thus automatically bumped whenever the project updated_at is touched. - # - # If your template cache depends on multiple sources (try to avoid this to keep things simple), - # you can name all these dependencies as part of an array: - # - # <% cache [ project, current_user ] do %> - # <b>All the topics on this project</b> - # <%= render project.topics %> - # <% end %> - # - # This will include both records as part of the cache key and updating either of them will - # expire the cache. - # - # ==== Template digest - # - # The template digest that's added to the cache key is computed by taking an md5 of the - # contents of the entire template file. This ensures that your caches will automatically - # expire when you change the template file. - # - # Note that the md5 is taken of the entire template file, not just what's within the - # cache do/end call. So it's possible that changing something outside of that call will - # still expire the cache. - # - # Additionally, the digestor will automatically look through your template file for - # explicit and implicit dependencies, and include those as part of the digest. - # - # The digestor can be bypassed by passing skip_digest: true as an option to the cache call: - # - # <% cache project, skip_digest: true do %> - # <b>All the topics on this project</b> - # <%= render project.topics %> - # <% end %> - # - # ==== Implicit dependencies - # - # Most template dependencies can be derived from calls to render in the template itself. - # Here are some examples of render calls that Cache Digests knows how to decode: - # - # render partial: "comments/comment", collection: commentable.comments - # render "comments/comments" - # render 'comments/comments' - # render('comments/comments') - # - # render "header" => render("comments/header") - # - # render(@topic) => render("topics/topic") - # render(topics) => render("topics/topic") - # render(message.topics) => render("topics/topic") - # - # It's not possible to derive all render calls like that, though. Here are a few examples of things that can't be derived: - # - # render group_of_attachments - # render @project.documents.where(published: true).order('created_at') - # - # You will have to rewrite those to the explicit form: - # - # render partial: 'attachments/attachment', collection: group_of_attachments - # render partial: 'documents/document', collection: @project.documents.where(published: true).order('created_at') - # - # === Explicit dependencies - # - # Some times you'll have template dependencies that can't be derived at all. This is typically - # the case when you have template rendering that happens in helpers. Here's an example: - # - # <%= render_sortable_todolists @project.todolists %> - # - # You'll need to use a special comment format to call those out: - # - # <%# Template Dependency: todolists/todolist %> - # <%= render_sortable_todolists @project.todolists %> - # - # The pattern used to match these is /# Template Dependency: ([^ ]+)/, so it's important that you type it out just so. - # You can only declare one template dependency per line. - # - # === External dependencies - # - # If you use a helper method, for example, inside of a cached block and you then update that helper, - # you'll have to bump the cache as well. It doesn't really matter how you do it, but the md5 of the template file - # must change. One recommendation is to simply be explicit in a comment, like: - # - # <%# Helper Dependency Updated: May 6, 2012 at 6pm %> - # <%= some_helper_method(person) %> - # - # Now all you'll have to do is change that timestamp when the helper method changes. - def cache(name = {}, options = nil, &block) - if controller.perform_caching - safe_concat(fragment_for(cache_fragment_name(name, options), options, &block)) - else - yield - end - - nil - end - - # Cache fragments of a view if +condition+ is true - # - # <%= cache_if admin?, project do %> - # <b>All the topics on this project</b> - # <%= render project.topics %> - # <% end %> - def cache_if(condition, name = {}, options = nil, &block) - if condition - cache(name, options, &block) - else - yield - end - - nil - end - - # Cache fragments of a view unless +condition+ is true - # - # <%= cache_unless admin?, project do %> - # <b>All the topics on this project</b> - # <%= render project.topics %> - # <% end %> - def cache_unless(condition, name = {}, options = nil, &block) - cache_if !condition, name, options, &block - end - - # This helper returns the name of a cache key for a given fragment cache - # call. By supplying skip_digest: true to cache, the digestion of cache - # fragments can be manually bypassed. This is useful when cache fragments - # cannot be manually expired unless you know the exact key which is the - # case when using memcached. - def cache_fragment_name(name = {}, options = nil) - skip_digest = options && options[:skip_digest] - - if skip_digest - name - else - fragment_name_with_digest(name) - end - end - - private - - def fragment_name_with_digest(name) #:nodoc: - if @virtual_path - [ - *Array(name.is_a?(Hash) ? controller.url_for(name).split("://").last : name), - Digestor.digest(@virtual_path, formats.last.to_sym, lookup_context, dependencies: view_cache_dependencies) - ] - else - name - end - end - - # TODO: Create an object that has caching read/write on it - def fragment_for(name = {}, options = nil, &block) #:nodoc: - if fragment = controller.read_fragment(name, options) - fragment - else - # VIEW TODO: Make #capture usable outside of ERB - # This dance is needed because Builder can't use capture - pos = output_buffer.length - yield - output_safe = output_buffer.html_safe? - fragment = output_buffer.slice!(pos..-1) - if output_safe - self.output_buffer = output_buffer.class.new(output_buffer) - end - controller.write_fragment(name, fragment, options) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/capture_helper.rb b/actionpack/lib/action_view/helpers/capture_helper.rb deleted file mode 100644 index 5afe435459..0000000000 --- a/actionpack/lib/action_view/helpers/capture_helper.rb +++ /dev/null @@ -1,216 +0,0 @@ -require 'active_support/core_ext/string/output_safety' - -module ActionView - # = Action View Capture Helper - module Helpers - # CaptureHelper exposes methods to let you extract generated markup which - # can be used in other parts of a template or layout file. - # - # It provides a method to capture blocks into variables through capture and - # a way to capture a block of markup for use in a layout through content_for. - module CaptureHelper - # The capture method allows you to extract part of a template into a - # variable. You can then use this variable anywhere in your templates or layout. - # - # The capture method can be used in ERB templates... - # - # <% @greeting = capture do %> - # Welcome to my shiny new web page! The date and time is - # <%= Time.now %> - # <% end %> - # - # ...and Builder (RXML) templates. - # - # @timestamp = capture do - # "The current timestamp is #{Time.now}." - # end - # - # You can then use that variable anywhere else. For example: - # - # <html> - # <head><title><%= @greeting %></title></head> - # <body> - # <b><%= @greeting %></b> - # </body></html> - # - def capture(*args) - value = nil - buffer = with_output_buffer { value = yield(*args) } - if string = buffer.presence || value and string.is_a?(String) - ERB::Util.html_escape string - end - end - - # Calling content_for stores a block of markup in an identifier for later use. - # In order to access this stored content in other templates, helper modules - # or the layout, you would pass the identifier as an argument to <tt>content_for</tt>. - # - # Note: <tt>yield</tt> can still be used to retrieve the stored content, but calling - # <tt>yield</tt> doesn't work in helper modules, while <tt>content_for</tt> does. - # - # <% content_for :not_authorized do %> - # alert('You are not authorized to do that!') - # <% end %> - # - # You can then use <tt>content_for :not_authorized</tt> anywhere in your templates. - # - # <%= content_for :not_authorized if current_user.nil? %> - # - # This is equivalent to: - # - # <%= yield :not_authorized if current_user.nil? %> - # - # <tt>content_for</tt>, however, can also be used in helper modules. - # - # module StorageHelper - # def stored_content - # content_for(:storage) || "Your storage is empty" - # end - # end - # - # This helper works just like normal helpers. - # - # <%= stored_content %> - # - # You can also use the <tt>yield</tt> syntax alongside an existing call to - # <tt>yield</tt> in a layout. For example: - # - # <%# This is the layout %> - # <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> - # <head> - # <title>My Website</title> - # <%= yield :script %> - # </head> - # <body> - # <%= yield %> - # </body> - # </html> - # - # And now, we'll create a view that has a <tt>content_for</tt> call that - # creates the <tt>script</tt> identifier. - # - # <%# This is our view %> - # Please login! - # - # <% content_for :script do %> - # <script>alert('You are not authorized to view this page!')</script> - # <% end %> - # - # Then, in another view, you could to do something like this: - # - # <%= link_to 'Logout', action: 'logout', remote: true %> - # - # <% content_for :script do %> - # <%= javascript_include_tag :defaults %> - # <% end %> - # - # That will place +script+ tags for your default set of JavaScript files on the page; - # this technique is useful if you'll only be using these scripts in a few views. - # - # Note that content_for concatenates (default) the blocks it is given for a particular - # identifier in order. For example: - # - # <% content_for :navigation do %> - # <li><%= link_to 'Home', action: 'index' %></li> - # <% end %> - # - # And in other place: - # - # <% content_for :navigation do %> - # <li><%= link_to 'Login', action: 'login' %></li> - # <% end %> - # - # Then, in another template or layout, this code would render both links in order: - # - # <ul><%= content_for :navigation %></ul> - # - # If the flush parameter is true content_for replaces the blocks it is given. For example: - # - # <% content_for :navigation do %> - # <li><%= link_to 'Home', action: 'index' %></li> - # <% end %> - # - # <%# Add some other content, or use a different template: %> - # - # <% content_for :navigation, flush: true do %> - # <li><%= link_to 'Login', action: 'login' %></li> - # <% end %> - # - # Then, in another template or layout, this code would render only the last link: - # - # <ul><%= content_for :navigation %></ul> - # - # Lastly, simple content can be passed as a parameter: - # - # <% content_for :script, javascript_include_tag(:defaults) %> - # - # WARNING: content_for is ignored in caches. So you shouldn't use it for elements that will be fragment cached. - def content_for(name, content = nil, options = {}, &block) - if content || block_given? - if block_given? - options = content if content - content = capture(&block) - end - if content - options[:flush] ? @view_flow.set(name, content) : @view_flow.append(name, content) - end - nil - else - @view_flow.get(name).presence - end - end - - # The same as +content_for+ but when used with streaming flushes - # straight back to the layout. In other words, if you want to - # concatenate several times to the same buffer when rendering a given - # template, you should use +content_for+, if not, use +provide+ to tell - # the layout to stop looking for more contents. - def provide(name, content = nil, &block) - content = capture(&block) if block_given? - result = @view_flow.append!(name, content) if content - result unless content - end - - # content_for? checks whether any content has been captured yet using `content_for`. - # Useful to render parts of your layout differently based on what is in your views. - # - # <%# This is the layout %> - # <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> - # <head> - # <title>My Website</title> - # <%= yield :script %> - # </head> - # <body class="<%= content_for?(:right_col) ? 'two-column' : 'one-column' %>"> - # <%= yield %> - # <%= yield :right_col %> - # </body> - # </html> - def content_for?(name) - @view_flow.get(name).present? - end - - # Use an alternate output buffer for the duration of the block. - # Defaults to a new empty string. - def with_output_buffer(buf = nil) #:nodoc: - unless buf - buf = ActionView::OutputBuffer.new - buf.force_encoding(output_buffer.encoding) if output_buffer - end - self.output_buffer, old_buffer = buf, output_buffer - yield - output_buffer - ensure - self.output_buffer = old_buffer - end - - # Add the output buffer to the response body and start a new one. - def flush_output_buffer #:nodoc: - if output_buffer && !output_buffer.empty? - response.stream.write output_buffer - self.output_buffer = output_buffer.respond_to?(:clone_empty) ? output_buffer.clone_empty : output_buffer[0, 0] - nil - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/controller_helper.rb b/actionpack/lib/action_view/helpers/controller_helper.rb deleted file mode 100644 index 74ef25f7c1..0000000000 --- a/actionpack/lib/action_view/helpers/controller_helper.rb +++ /dev/null @@ -1,25 +0,0 @@ -require 'active_support/core_ext/module/attr_internal' - -module ActionView - module Helpers - # This module keeps all methods and behavior in ActionView - # that simply delegates to the controller. - module ControllerHelper #:nodoc: - attr_internal :controller, :request - - delegate :request_forgery_protection_token, :params, :session, :cookies, :response, :headers, - :flash, :action_name, :controller_name, :controller_path, :to => :controller - - def assign_controller(controller) - if @_controller = controller - @_request = controller.request if controller.respond_to?(:request) - @_config = controller.config.inheritable_copy if controller.respond_to?(:config) - end - end - - def logger - controller.logger if controller.respond_to?(:logger) - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/csrf_helper.rb b/actionpack/lib/action_view/helpers/csrf_helper.rb deleted file mode 100644 index eeb0ed94b9..0000000000 --- a/actionpack/lib/action_view/helpers/csrf_helper.rb +++ /dev/null @@ -1,30 +0,0 @@ -module ActionView - # = Action View CSRF Helper - module Helpers - module CsrfHelper - # Returns meta tags "csrf-param" and "csrf-token" with the name of the cross-site - # request forgery protection parameter and token, respectively. - # - # <head> - # <%= csrf_meta_tags %> - # </head> - # - # These are used to generate the dynamic forms that implement non-remote links with - # <tt>:method</tt>. - # - # Note that regular forms generate hidden fields, and that Ajax calls are whitelisted, - # so they do not use these tags. - def csrf_meta_tags - if protect_against_forgery? - [ - tag('meta', :name => 'csrf-param', :content => request_forgery_protection_token), - tag('meta', :name => 'csrf-token', :content => form_authenticity_token) - ].join("\n").html_safe - end - end - - # For backwards compatibility. - alias csrf_meta_tag csrf_meta_tags - end - end -end diff --git a/actionpack/lib/action_view/helpers/date_helper.rb b/actionpack/lib/action_view/helpers/date_helper.rb deleted file mode 100644 index 8fb5eb1548..0000000000 --- a/actionpack/lib/action_view/helpers/date_helper.rb +++ /dev/null @@ -1,1083 +0,0 @@ -require 'date' -require 'action_view/helpers/tag_helper' -require 'active_support/core_ext/array/extract_options' -require 'active_support/core_ext/date/conversions' -require 'active_support/core_ext/hash/slice' -require 'active_support/core_ext/object/with_options' - -module ActionView - module Helpers - # = Action View Date Helpers - # - # The Date Helper primarily creates select/option tags for different kinds of dates and times or date and time - # elements. All of the select-type methods share a number of common options that are as follows: - # - # * <tt>:prefix</tt> - overwrites the default prefix of "date" used for the select names. So specifying "birthday" - # would give \birthday[month] instead of \date[month] if passed to the <tt>select_month</tt> method. - # * <tt>:include_blank</tt> - set to true if it should be possible to set an empty date. - # * <tt>:discard_type</tt> - set to true if you want to discard the type part of the select name. If set to true, - # the <tt>select_month</tt> method would use simply "date" (which can be overwritten using <tt>:prefix</tt>) instead - # of \date[month]. - module DateHelper - # Reports the approximate distance in time between two Time, Date or DateTime objects or integers as seconds. - # Pass <tt>include_seconds: true</tt> if you want more detailed approximations when distance < 1 min, 29 secs. - # Distances are reported based on the following table: - # - # 0 <-> 29 secs # => less than a minute - # 30 secs <-> 1 min, 29 secs # => 1 minute - # 1 min, 30 secs <-> 44 mins, 29 secs # => [2..44] minutes - # 44 mins, 30 secs <-> 89 mins, 29 secs # => about 1 hour - # 89 mins, 30 secs <-> 23 hrs, 59 mins, 29 secs # => about [2..24] hours - # 23 hrs, 59 mins, 30 secs <-> 41 hrs, 59 mins, 29 secs # => 1 day - # 41 hrs, 59 mins, 30 secs <-> 29 days, 23 hrs, 59 mins, 29 secs # => [2..29] days - # 29 days, 23 hrs, 59 mins, 30 secs <-> 44 days, 23 hrs, 59 mins, 29 secs # => about 1 month - # 44 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs # => about 2 months - # 59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec # => [2..12] months - # 1 yr <-> 1 yr, 3 months # => about 1 year - # 1 yr, 3 months <-> 1 yr, 9 months # => over 1 year - # 1 yr, 9 months <-> 2 yr minus 1 sec # => almost 2 years - # 2 yrs <-> max time or date # => (same rules as 1 yr) - # - # With <tt>include_seconds: true</tt> and the difference < 1 minute 29 seconds: - # 0-4 secs # => less than 5 seconds - # 5-9 secs # => less than 10 seconds - # 10-19 secs # => less than 20 seconds - # 20-39 secs # => half a minute - # 40-59 secs # => less than a minute - # 60-89 secs # => 1 minute - # - # from_time = Time.now - # distance_of_time_in_words(from_time, from_time + 50.minutes) # => about 1 hour - # distance_of_time_in_words(from_time, 50.minutes.from_now) # => about 1 hour - # distance_of_time_in_words(from_time, from_time + 15.seconds) # => less than a minute - # distance_of_time_in_words(from_time, from_time + 15.seconds, include_seconds: true) # => less than 20 seconds - # distance_of_time_in_words(from_time, 3.years.from_now) # => about 3 years - # distance_of_time_in_words(from_time, from_time + 60.hours) # => 3 days - # distance_of_time_in_words(from_time, from_time + 45.seconds, include_seconds: true) # => less than a minute - # distance_of_time_in_words(from_time, from_time - 45.seconds, include_seconds: true) # => less than a minute - # distance_of_time_in_words(from_time, 76.seconds.from_now) # => 1 minute - # distance_of_time_in_words(from_time, from_time + 1.year + 3.days) # => about 1 year - # distance_of_time_in_words(from_time, from_time + 3.years + 6.months) # => over 3 years - # distance_of_time_in_words(from_time, from_time + 4.years + 9.days + 30.minutes + 5.seconds) # => about 4 years - # - # to_time = Time.now + 6.years + 19.days - # distance_of_time_in_words(from_time, to_time, include_seconds: true) # => about 6 years - # distance_of_time_in_words(to_time, from_time, include_seconds: true) # => about 6 years - # distance_of_time_in_words(Time.now, Time.now) # => less than a minute - def distance_of_time_in_words(from_time, to_time = 0, include_seconds_or_options = {}, options = {}) - if include_seconds_or_options.is_a?(Hash) - options = include_seconds_or_options - else - ActiveSupport::Deprecation.warn "distance_of_time_in_words and time_ago_in_words now accept :include_seconds " + - "as a part of options hash, not a boolean argument" - options[:include_seconds] ||= !!include_seconds_or_options - end - - options = { - scope: :'datetime.distance_in_words' - }.merge!(options) - - from_time = from_time.to_time if from_time.respond_to?(:to_time) - to_time = to_time.to_time if to_time.respond_to?(:to_time) - from_time, to_time = to_time, from_time if from_time > to_time - distance_in_minutes = ((to_time - from_time)/60.0).round - distance_in_seconds = (to_time - from_time).round - - I18n.with_options :locale => options[:locale], :scope => options[:scope] do |locale| - case distance_in_minutes - when 0..1 - return distance_in_minutes == 0 ? - locale.t(:less_than_x_minutes, :count => 1) : - locale.t(:x_minutes, :count => distance_in_minutes) unless options[:include_seconds] - - case distance_in_seconds - when 0..4 then locale.t :less_than_x_seconds, :count => 5 - when 5..9 then locale.t :less_than_x_seconds, :count => 10 - when 10..19 then locale.t :less_than_x_seconds, :count => 20 - when 20..39 then locale.t :half_a_minute - when 40..59 then locale.t :less_than_x_minutes, :count => 1 - else locale.t :x_minutes, :count => 1 - end - - when 2...45 then locale.t :x_minutes, :count => distance_in_minutes - when 45...90 then locale.t :about_x_hours, :count => 1 - # 90 mins up to 24 hours - when 90...1440 then locale.t :about_x_hours, :count => (distance_in_minutes.to_f / 60.0).round - # 24 hours up to 42 hours - when 1440...2520 then locale.t :x_days, :count => 1 - # 42 hours up to 30 days - when 2520...43200 then locale.t :x_days, :count => (distance_in_minutes.to_f / 1440.0).round - # 30 days up to 60 days - when 43200...86400 then locale.t :about_x_months, :count => (distance_in_minutes.to_f / 43200.0).round - # 60 days up to 365 days - when 86400...525600 then locale.t :x_months, :count => (distance_in_minutes.to_f / 43200.0).round - else - if from_time.acts_like?(:time) && to_time.acts_like?(:time) - fyear = from_time.year - fyear += 1 if from_time.month >= 3 - tyear = to_time.year - tyear -= 1 if to_time.month < 3 - leap_years = (fyear > tyear) ? 0 : (fyear..tyear).count{|x| Date.leap?(x)} - minute_offset_for_leap_year = leap_years * 1440 - # Discount the leap year days when calculating year distance. - # e.g. if there are 20 leap year days between 2 dates having the same day - # and month then the based on 365 days calculation - # the distance in years will come out to over 80 years when in written - # english it would read better as about 80 years. - minutes_with_offset = distance_in_minutes - minute_offset_for_leap_year - else - minutes_with_offset = distance_in_minutes - end - remainder = (minutes_with_offset % 525600) - distance_in_years = (minutes_with_offset.div 525600) - if remainder < 131400 - locale.t(:about_x_years, :count => distance_in_years) - elsif remainder < 394200 - locale.t(:over_x_years, :count => distance_in_years) - else - locale.t(:almost_x_years, :count => distance_in_years + 1) - end - end - end - end - - # Like <tt>distance_of_time_in_words</tt>, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>. - # - # time_ago_in_words(3.minutes.from_now) # => 3 minutes - # time_ago_in_words(3.minutes.ago) # => 3 minutes - # time_ago_in_words(Time.now - 15.hours) # => about 15 hours - # time_ago_in_words(Time.now) # => less than a minute - # time_ago_in_words(Time.now, include_seconds: true) # => less than 5 seconds - # - # from_time = Time.now - 3.days - 14.minutes - 25.seconds - # time_ago_in_words(from_time) # => 3 days - # - # from_time = (3.days + 14.minutes + 25.seconds).ago - # time_ago_in_words(from_time) # => 3 days - # - # Note that you cannot pass a <tt>Numeric</tt> value to <tt>time_ago_in_words</tt>. - # - def time_ago_in_words(from_time, include_seconds_or_options = {}) - distance_of_time_in_words(from_time, Time.now, include_seconds_or_options) - end - - alias_method :distance_of_time_in_words_to_now, :time_ago_in_words - - # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based - # attribute (identified by +method+) on an object assigned to the template (identified by +object+). - # - # ==== Options - # * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g. - # "2" instead of "February"). - # * <tt>:use_two_digit_numbers</tt> - Set to true if you want to display two digit month and day numbers (e.g. - # "02" instead of "February" and "08" instead of "8"). - # * <tt>:use_short_month</tt> - Set to true if you want to use abbreviated month names instead of full - # month names (e.g. "Feb" instead of "February"). - # * <tt>:add_month_numbers</tt> - Set to true if you want to use both month numbers and month names (e.g. - # "2 - February" instead of "February"). - # * <tt>:use_month_names</tt> - Set to an array with 12 month names if you want to customize month names. - # Note: You can also use Rails' i18n functionality for this. - # * <tt>:date_separator</tt> - Specifies a string to separate the date fields. Default is "" (i.e. nothing). - # * <tt>:start_year</tt> - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>. - # * <tt>:end_year</tt> - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>. - # * <tt>:discard_day</tt> - Set to true if you don't want to show a day select. This includes the day - # as a hidden field instead of showing a select field. Also note that this implicitly sets the day to be the - # first of the given month in order to not create invalid dates like 31 February. - # * <tt>:discard_month</tt> - Set to true if you don't want to show a month select. This includes the month - # as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true. - # * <tt>:discard_year</tt> - Set to true if you don't want to show a year select. This includes the year - # as a hidden field instead of showing a select field. - # * <tt>:order</tt> - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> to - # customize the order in which the select fields are shown. If you leave out any of the symbols, the respective - # select will not be shown (like when you set <tt>discard_xxx: true</tt>. Defaults to the order defined in - # the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails). - # * <tt>:include_blank</tt> - Include a blank option in every select field so it's possible to set empty - # dates. - # * <tt>:default</tt> - Set a default date if the affected date isn't set or is nil. - # * <tt>:selected</tt> - Set a date that overrides the actual value. - # * <tt>:disabled</tt> - Set to true if you want show the select fields as disabled. - # * <tt>:prompt</tt> - Set to true (for a generic prompt), a prompt string or a hash of prompt strings - # for <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>, <tt>:minute</tt> and <tt>:second</tt>. - # Setting this option prepends a select option with a generic prompt (Day, Month, Year, Hour, Minute, Seconds) - # or the given prompt string. - # * <tt>:with_css_classes</tt> - Set to true if you want assign different styles for 'select' tags. This option - # automatically set classes 'year', 'month', 'day', 'hour', 'minute' and 'second' for your 'select' tags. - # - # If anything is passed in the +html_options+ hash it will be applied to every select tag in the set. - # - # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed. - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute. - # date_select("article", "written_on") - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute, - # # with the year in the year drop down box starting at 1995. - # date_select("article", "written_on", start_year: 1995) - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute, - # # with the year in the year drop down box starting at 1995, numbers used for months instead of words, - # # and without a day select box. - # date_select("article", "written_on", start_year: 1995, use_month_numbers: true, - # discard_day: true, include_blank: true) - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute, - # # with two digit numbers used for months and days. - # date_select("article", "written_on", use_two_digit_numbers: true) - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute - # # with the fields ordered as day, month, year rather than month, day, year. - # date_select("article", "written_on", order: [:day, :month, :year]) - # - # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute - # # lacking a year field. - # date_select("user", "birthday", order: [:month, :day]) - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute - # # which is initially set to the date 3 days from the current date - # date_select("article", "written_on", default: 3.days.from_now) - # - # # Generates a date select that when POSTed is stored in the article variable, in the written_on attribute - # # which is set in the form with todays date, regardless of the value in the Active Record object. - # date_select("article", "written_on", selected: Date.today) - # - # # Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute - # # that will have a default day of 20. - # date_select("credit_card", "bill_due", default: { day: 20 }) - # - # # Generates a date select with custom prompts. - # date_select("article", "written_on", prompt: { day: 'Select day', month: 'Select month', year: 'Select year' }) - # - # The selects are prepared for multi-parameter assignment to an Active Record object. - # - # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that - # all month choices are valid. - def date_select(object_name, method, options = {}, html_options = {}) - Tags::DateSelect.new(object_name, method, self, options, html_options).render - end - - # Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a - # specified time-based attribute (identified by +method+) on an object assigned to the template (identified by - # +object+). You can include the seconds with <tt>:include_seconds</tt>. You can get hours in the AM/PM format - # with <tt>:ampm</tt> option. - # - # This method will also generate 3 input hidden tags, for the actual year, month and day unless the option - # <tt>:ignore_date</tt> is set to +true+. If you set the <tt>:ignore_date</tt> to +true+, you must have a - # +date_select+ on the same method within the form otherwise an exception will be raised. - # - # If anything is passed in the html_options hash it will be applied to every select tag in the set. - # - # # Creates a time select tag that, when POSTed, will be stored in the article variable in the sunrise attribute. - # time_select("article", "sunrise") - # - # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the article variables in - # # the sunrise attribute. - # time_select("article", "start_time", include_seconds: true) - # - # # You can set the <tt>:minute_step</tt> to 15 which will give you: 00, 15, 30 and 45. - # time_select 'game', 'game_time', {minute_step: 15} - # - # # Creates a time select tag with a custom prompt. Use <tt>prompt: true</tt> for generic prompts. - # time_select("article", "written_on", prompt: {hour: 'Choose hour', minute: 'Choose minute', second: 'Choose seconds'}) - # time_select("article", "written_on", prompt: {hour: true}) # generic prompt for hours - # time_select("article", "written_on", prompt: true) # generic prompts for all - # - # # You can set :ampm option to true which will show the hours as: 12 PM, 01 AM .. 11 PM. - # time_select 'game', 'game_time', {ampm: true} - # - # The selects are prepared for multi-parameter assignment to an Active Record object. - # - # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that - # all month choices are valid. - def time_select(object_name, method, options = {}, html_options = {}) - Tags::TimeSelect.new(object_name, method, self, options, html_options).render - end - - # Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a - # specified datetime-based attribute (identified by +method+) on an object assigned to the template (identified - # by +object+). - # - # If anything is passed in the html_options hash it will be applied to every select tag in the set. - # - # # Generates a datetime select that, when POSTed, will be stored in the article variable in the written_on - # # attribute. - # datetime_select("article", "written_on") - # - # # Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the - # # article variable in the written_on attribute. - # datetime_select("article", "written_on", start_year: 1995) - # - # # Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will - # # be stored in the trip variable in the departing attribute. - # datetime_select("trip", "departing", default: 3.days.from_now) - # - # # Generate a datetime select with hours in the AM/PM format - # datetime_select("article", "written_on", ampm: true) - # - # # Generates a datetime select that discards the type that, when POSTed, will be stored in the article variable - # # as the written_on attribute. - # datetime_select("article", "written_on", discard_type: true) - # - # # Generates a datetime select with a custom prompt. Use <tt>prompt: true</tt> for generic prompts. - # datetime_select("article", "written_on", prompt: {day: 'Choose day', month: 'Choose month', year: 'Choose year'}) - # datetime_select("article", "written_on", prompt: {hour: true}) # generic prompt for hours - # datetime_select("article", "written_on", prompt: true) # generic prompts for all - # - # The selects are prepared for multi-parameter assignment to an Active Record object. - def datetime_select(object_name, method, options = {}, html_options = {}) - Tags::DatetimeSelect.new(object_name, method, self, options, html_options).render - end - - # Returns a set of html select-tags (one for year, month, day, hour, minute, and second) pre-selected with the - # +datetime+. It's also possible to explicitly set the order of the tags using the <tt>:order</tt> option with - # an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not - # supply a Symbol, it will be appended onto the <tt>:order</tt> passed in. You can also add - # <tt>:date_separator</tt>, <tt>:datetime_separator</tt> and <tt>:time_separator</tt> keys to the +options+ to - # control visual display of the elements. - # - # If anything is passed in the html_options hash it will be applied to every select tag in the set. - # - # my_date_time = Time.now + 4.days - # - # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today). - # select_datetime(my_date_time) - # - # # Generates a datetime select that defaults to today (no specified datetime) - # select_datetime() - # - # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today) - # # with the fields ordered year, month, day rather than month, day, year. - # select_datetime(my_date_time, order: [:year, :month, :day]) - # - # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today) - # # with a '/' between each date field. - # select_datetime(my_date_time, date_separator: '/') - # - # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today) - # # with a date fields separated by '/', time fields separated by '' and the date and time fields - # # separated by a comma (','). - # select_datetime(my_date_time, date_separator: '/', time_separator: '', datetime_separator: ',') - # - # # Generates a datetime select that discards the type of the field and defaults to the datetime in - # # my_date_time (four days after today) - # select_datetime(my_date_time, discard_type: true) - # - # # Generate a datetime field with hours in the AM/PM format - # select_datetime(my_date_time, ampm: true) - # - # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today) - # # prefixed with 'payday' rather than 'date' - # select_datetime(my_date_time, prefix: 'payday') - # - # # Generates a datetime select with a custom prompt. Use <tt>prompt: true</tt> for generic prompts. - # select_datetime(my_date_time, prompt: {day: 'Choose day', month: 'Choose month', year: 'Choose year'}) - # select_datetime(my_date_time, prompt: {hour: true}) # generic prompt for hours - # select_datetime(my_date_time, prompt: true) # generic prompts for all - def select_datetime(datetime = Time.current, options = {}, html_options = {}) - DateTimeSelector.new(datetime, options, html_options).select_datetime - end - - # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+. - # It's possible to explicitly set the order of the tags using the <tt>:order</tt> option with an array of - # symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. - # If the array passed to the <tt>:order</tt> option does not contain all the three symbols, all tags will be hidden. - # - # If anything is passed in the html_options hash it will be applied to every select tag in the set. - # - # my_date = Time.now + 6.days - # - # # Generates a date select that defaults to the date in my_date (six days after today). - # select_date(my_date) - # - # # Generates a date select that defaults to today (no specified date). - # select_date() - # - # # Generates a date select that defaults to the date in my_date (six days after today) - # # with the fields ordered year, month, day rather than month, day, year. - # select_date(my_date, order: [:year, :month, :day]) - # - # # Generates a date select that discards the type of the field and defaults to the date in - # # my_date (six days after today). - # select_date(my_date, discard_type: true) - # - # # Generates a date select that defaults to the date in my_date, - # # which has fields separated by '/'. - # select_date(my_date, date_separator: '/') - # - # # Generates a date select that defaults to the datetime in my_date (six days after today) - # # prefixed with 'payday' rather than 'date'. - # select_date(my_date, prefix: 'payday') - # - # # Generates a date select with a custom prompt. Use <tt>prompt: true</tt> for generic prompts. - # select_date(my_date, prompt: {day: 'Choose day', month: 'Choose month', year: 'Choose year'}) - # select_date(my_date, prompt: {hour: true}) # generic prompt for hours - # select_date(my_date, prompt: true) # generic prompts for all - def select_date(date = Date.current, options = {}, html_options = {}) - DateTimeSelector.new(date, options, html_options).select_date - end - - # Returns a set of html select-tags (one for hour and minute). - # You can set <tt>:time_separator</tt> key to format the output, and - # the <tt>:include_seconds</tt> option to include an input for seconds. - # - # If anything is passed in the html_options hash it will be applied to every select tag in the set. - # - # my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds - # - # # Generates a time select that defaults to the time in my_time. - # select_time(my_time) - # - # # Generates a time select that defaults to the current time (no specified time). - # select_time() - # - # # Generates a time select that defaults to the time in my_time, - # # which has fields separated by ':'. - # select_time(my_time, time_separator: ':') - # - # # Generates a time select that defaults to the time in my_time, - # # that also includes an input for seconds. - # select_time(my_time, include_seconds: true) - # - # # Generates a time select that defaults to the time in my_time, that has fields - # # separated by ':' and includes an input for seconds. - # select_time(my_time, time_separator: ':', include_seconds: true) - # - # # Generate a time select field with hours in the AM/PM format - # select_time(my_time, ampm: true) - # - # # Generates a time select field with hours that range from 2 to 14 - # select_time(my_time, start_hour: 2, end_hour: 14) - # - # # Generates a time select with a custom prompt. Use <tt>:prompt</tt> to true for generic prompts. - # select_time(my_time, prompt: {day: 'Choose day', month: 'Choose month', year: 'Choose year'}) - # select_time(my_time, prompt: {hour: true}) # generic prompt for hours - # select_time(my_time, prompt: true) # generic prompts for all - def select_time(datetime = Time.current, options = {}, html_options = {}) - DateTimeSelector.new(datetime, options, html_options).select_time - end - - # Returns a select tag with options for each of the seconds 0 through 59 with the current second selected. - # The <tt>datetime</tt> can be either a +Time+ or +DateTime+ object or an integer. - # Override the field name using the <tt>:field_name</tt> option, 'second' by default. - # - # my_time = Time.now + 16.minutes - # - # # Generates a select field for seconds that defaults to the seconds for the time in my_time. - # select_second(my_time) - # - # # Generates a select field for seconds that defaults to the number given. - # select_second(33) - # - # # Generates a select field for seconds that defaults to the seconds for the time in my_time - # # that is named 'interval' rather than 'second'. - # select_second(my_time, field_name: 'interval') - # - # # Generates a select field for seconds with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_second(14, prompt: 'Choose seconds') - def select_second(datetime, options = {}, html_options = {}) - DateTimeSelector.new(datetime, options, html_options).select_second - end - - # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected. - # Also can return a select tag with options by <tt>minute_step</tt> from 0 through 59 with the 00 minute - # selected. The <tt>datetime</tt> can be either a +Time+ or +DateTime+ object or an integer. - # Override the field name using the <tt>:field_name</tt> option, 'minute' by default. - # - # my_time = Time.now + 6.hours - # - # # Generates a select field for minutes that defaults to the minutes for the time in my_time. - # select_minute(my_time) - # - # # Generates a select field for minutes that defaults to the number given. - # select_minute(14) - # - # # Generates a select field for minutes that defaults to the minutes for the time in my_time - # # that is named 'moment' rather than 'minute'. - # select_minute(my_time, field_name: 'moment') - # - # # Generates a select field for minutes with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_minute(14, prompt: 'Choose minutes') - def select_minute(datetime, options = {}, html_options = {}) - DateTimeSelector.new(datetime, options, html_options).select_minute - end - - # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected. - # The <tt>datetime</tt> can be either a +Time+ or +DateTime+ object or an integer. - # Override the field name using the <tt>:field_name</tt> option, 'hour' by default. - # - # my_time = Time.now + 6.hours - # - # # Generates a select field for hours that defaults to the hour for the time in my_time. - # select_hour(my_time) - # - # # Generates a select field for hours that defaults to the number given. - # select_hour(13) - # - # # Generates a select field for hours that defaults to the hour for the time in my_time - # # that is named 'stride' rather than 'hour'. - # select_hour(my_time, field_name: 'stride') - # - # # Generates a select field for hours with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_hour(13, prompt: 'Choose hour') - # - # # Generate a select field for hours in the AM/PM format - # select_hour(my_time, ampm: true) - # - # # Generates a select field that includes options for hours from 2 to 14. - # select_hour(my_time, start_hour: 2, end_hour: 14) - def select_hour(datetime, options = {}, html_options = {}) - DateTimeSelector.new(datetime, options, html_options).select_hour - end - - # Returns a select tag with options for each of the days 1 through 31 with the current day selected. - # The <tt>date</tt> can also be substituted for a day number. - # If you want to display days with a leading zero set the <tt>:use_two_digit_numbers</tt> key in +options+ to true. - # Override the field name using the <tt>:field_name</tt> option, 'day' by default. - # - # my_date = Time.now + 2.days - # - # # Generates a select field for days that defaults to the day for the date in my_date. - # select_day(my_time) - # - # # Generates a select field for days that defaults to the number given. - # select_day(5) - # - # # Generates a select field for days that defaults to the number given, but displays it with two digits. - # select_day(5, use_two_digit_numbers: true) - # - # # Generates a select field for days that defaults to the day for the date in my_date - # # that is named 'due' rather than 'day'. - # select_day(my_time, field_name: 'due') - # - # # Generates a select field for days with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_day(5, prompt: 'Choose day') - def select_day(date, options = {}, html_options = {}) - DateTimeSelector.new(date, options, html_options).select_day - end - - # Returns a select tag with options for each of the months January through December with the current month - # selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are - # used as values (what's submitted to the server). It's also possible to use month numbers for the presentation - # instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you - # want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer - # to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want - # to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names. - # If you want to display months with a leading zero set the <tt>:use_two_digit_numbers</tt> key in +options+ to true. - # Override the field name using the <tt>:field_name</tt> option, 'month' by default. - # - # # Generates a select field for months that defaults to the current month that - # # will use keys like "January", "March". - # select_month(Date.today) - # - # # Generates a select field for months that defaults to the current month that - # # is named "start" rather than "month". - # select_month(Date.today, field_name: 'start') - # - # # Generates a select field for months that defaults to the current month that - # # will use keys like "1", "3". - # select_month(Date.today, use_month_numbers: true) - # - # # Generates a select field for months that defaults to the current month that - # # will use keys like "1 - January", "3 - March". - # select_month(Date.today, add_month_numbers: true) - # - # # Generates a select field for months that defaults to the current month that - # # will use keys like "Jan", "Mar". - # select_month(Date.today, use_short_month: true) - # - # # Generates a select field for months that defaults to the current month that - # # will use keys like "Januar", "Marts." - # select_month(Date.today, use_month_names: %w(Januar Februar Marts ...)) - # - # # Generates a select field for months that defaults to the current month that - # # will use keys with two digit numbers like "01", "03". - # select_month(Date.today, use_two_digit_numbers: true) - # - # # Generates a select field for months with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_month(14, prompt: 'Choose month') - def select_month(date, options = {}, html_options = {}) - DateTimeSelector.new(date, options, html_options).select_month - end - - # Returns a select tag with options for each of the five years on each side of the current, which is selected. - # The five year radius can be changed using the <tt>:start_year</tt> and <tt>:end_year</tt> keys in the - # +options+. Both ascending and descending year lists are supported by making <tt>:start_year</tt> less than or - # greater than <tt>:end_year</tt>. The <tt>date</tt> can also be substituted for a year given as a number. - # Override the field name using the <tt>:field_name</tt> option, 'year' by default. - # - # # Generates a select field for years that defaults to the current year that - # # has ascending year values. - # select_year(Date.today, start_year: 1992, end_year: 2007) - # - # # Generates a select field for years that defaults to the current year that - # # is named 'birth' rather than 'year'. - # select_year(Date.today, field_name: 'birth') - # - # # Generates a select field for years that defaults to the current year that - # # has descending year values. - # select_year(Date.today, start_year: 2005, end_year: 1900) - # - # # Generates a select field for years that defaults to the year 2006 that - # # has ascending year values. - # select_year(2006, start_year: 2000, end_year: 2010) - # - # # Generates a select field for years with a custom prompt. Use <tt>prompt: true</tt> for a - # # generic prompt. - # select_year(14, prompt: 'Choose year') - def select_year(date, options = {}, html_options = {}) - DateTimeSelector.new(date, options, html_options).select_year - end - - # Returns an html time tag for the given date or time. - # - # time_tag Date.today # => - # <time datetime="2010-11-04">November 04, 2010</time> - # time_tag Time.now # => - # <time datetime="2010-11-04T17:55:45+01:00">November 04, 2010 17:55</time> - # time_tag Date.yesterday, 'Yesterday' # => - # <time datetime="2010-11-03">Yesterday</time> - # time_tag Date.today, pubdate: true # => - # <time datetime="2010-11-04" pubdate="pubdate">November 04, 2010</time> - # time_tag Date.today, datetime: Date.today.strftime('%G-W%V') # => - # <time datetime="2010-W44">November 04, 2010</time> - # - # <%= time_tag Time.now do %> - # <span>Right now</span> - # <% end %> - # # => <time datetime="2010-11-04T17:55:45+01:00"><span>Right now</span></time> - def time_tag(date_or_time, *args, &block) - options = args.extract_options! - format = options.delete(:format) || :long - content = args.first || I18n.l(date_or_time, :format => format) - datetime = date_or_time.acts_like?(:time) ? date_or_time.xmlschema : date_or_time.iso8601 - - content_tag(:time, content, options.reverse_merge(:datetime => datetime), &block) - end - end - - class DateTimeSelector #:nodoc: - include ActionView::Helpers::TagHelper - - DEFAULT_PREFIX = 'date'.freeze - POSITION = { - :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6 - }.freeze - - AMPM_TRANSLATION = Hash[ - [[0, "12 AM"], [1, "01 AM"], [2, "02 AM"], [3, "03 AM"], - [4, "04 AM"], [5, "05 AM"], [6, "06 AM"], [7, "07 AM"], - [8, "08 AM"], [9, "09 AM"], [10, "10 AM"], [11, "11 AM"], - [12, "12 PM"], [13, "01 PM"], [14, "02 PM"], [15, "03 PM"], - [16, "04 PM"], [17, "05 PM"], [18, "06 PM"], [19, "07 PM"], - [20, "08 PM"], [21, "09 PM"], [22, "10 PM"], [23, "11 PM"]] - ].freeze - - def initialize(datetime, options = {}, html_options = {}) - @options = options.dup - @html_options = html_options.dup - @datetime = datetime - @options[:datetime_separator] ||= ' — ' - @options[:time_separator] ||= ' : ' - end - - def select_datetime - order = date_order.dup - order -= [:hour, :minute, :second] - @options[:discard_year] ||= true unless order.include?(:year) - @options[:discard_month] ||= true unless order.include?(:month) - @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day) - @options[:discard_minute] ||= true if @options[:discard_hour] - @options[:discard_second] ||= true unless @options[:include_seconds] && !@options[:discard_minute] - - set_day_if_discarded - - if @options[:tag] && @options[:ignore_date] - select_time - else - [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) } - order += [:hour, :minute, :second] unless @options[:discard_hour] - - build_selects_from_types(order) - end - end - - def select_date - order = date_order.dup - - @options[:discard_hour] = true - @options[:discard_minute] = true - @options[:discard_second] = true - - @options[:discard_year] ||= true unless order.include?(:year) - @options[:discard_month] ||= true unless order.include?(:month) - @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day) - - set_day_if_discarded - - [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) } - - build_selects_from_types(order) - end - - def select_time - order = [] - - @options[:discard_month] = true - @options[:discard_year] = true - @options[:discard_day] = true - @options[:discard_second] ||= true unless @options[:include_seconds] - - order += [:year, :month, :day] unless @options[:ignore_date] - - order += [:hour, :minute] - order << :second if @options[:include_seconds] - - build_selects_from_types(order) - end - - def select_second - if @options[:use_hidden] || @options[:discard_second] - build_hidden(:second, sec) if @options[:include_seconds] - else - build_options_and_select(:second, sec) - end - end - - def select_minute - if @options[:use_hidden] || @options[:discard_minute] - build_hidden(:minute, min) - else - build_options_and_select(:minute, min, :step => @options[:minute_step]) - end - end - - def select_hour - if @options[:use_hidden] || @options[:discard_hour] - build_hidden(:hour, hour) - else - options = {} - options[:ampm] = @options[:ampm] || false - options[:start] = @options[:start_hour] || 0 - options[:end] = @options[:end_hour] || 23 - build_options_and_select(:hour, hour, options) - end - end - - def select_day - if @options[:use_hidden] || @options[:discard_day] - build_hidden(:day, day || 1) - else - build_options_and_select(:day, day, :start => 1, :end => 31, :leading_zeros => false, :use_two_digit_numbers => @options[:use_two_digit_numbers]) - end - end - - def select_month - if @options[:use_hidden] || @options[:discard_month] - build_hidden(:month, month || 1) - else - month_options = [] - 1.upto(12) do |month_number| - options = { :value => month_number } - options[:selected] = "selected" if month == month_number - month_options << content_tag(:option, month_name(month_number), options) + "\n" - end - build_select(:month, month_options.join) - end - end - - def select_year - if !@datetime || @datetime == 0 - val = '1' - middle_year = Date.today.year - else - val = middle_year = year - end - - if @options[:use_hidden] || @options[:discard_year] - build_hidden(:year, val) - else - options = {} - options[:start] = @options[:start_year] || middle_year - 5 - options[:end] = @options[:end_year] || middle_year + 5 - options[:step] = options[:start] < options[:end] ? 1 : -1 - options[:leading_zeros] = false - options[:max_years_allowed] = @options[:max_years_allowed] || 1000 - - if (options[:end] - options[:start]).abs > options[:max_years_allowed] - raise ArgumentError, "There are too many years options to be built. Are you sure you haven't mistyped something? You can provide the :max_years_allowed parameter." - end - - build_options_and_select(:year, val, options) - end - end - - private - %w( sec min hour day month year ).each do |method| - define_method(method) do - @datetime.kind_of?(Numeric) ? @datetime : @datetime.send(method) if @datetime - end - end - - # If the day is hidden, the day should be set to the 1st so all month and year choices are - # valid. Otherwise, February 31st or February 29th, 2011 can be selected, which are invalid. - def set_day_if_discarded - if @datetime && @options[:discard_day] - @datetime = @datetime.change(:day => 1) - end - end - - # Returns translated month names, but also ensures that a custom month - # name array has a leading nil element. - def month_names - @month_names ||= begin - month_names = @options[:use_month_names] || translated_month_names - month_names.unshift(nil) if month_names.size < 13 - month_names - end - end - - # Returns translated month names. - # => [nil, "January", "February", "March", - # "April", "May", "June", "July", - # "August", "September", "October", - # "November", "December"] - # - # If <tt>:use_short_month</tt> option is set - # => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun", - # "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] - def translated_month_names - key = @options[:use_short_month] ? :'date.abbr_month_names' : :'date.month_names' - I18n.translate(key, :locale => @options[:locale]) - end - - # Lookup month name for number. - # month_name(1) => "January" - # - # If <tt>:use_month_numbers</tt> option is passed - # month_name(1) => 1 - # - # If <tt>:use_two_month_numbers</tt> option is passed - # month_name(1) => '01' - # - # If <tt>:add_month_numbers</tt> option is passed - # month_name(1) => "1 - January" - def month_name(number) - if @options[:use_month_numbers] - number - elsif @options[:use_two_digit_numbers] - sprintf "%02d", number - elsif @options[:add_month_numbers] - "#{number} - #{month_names[number]}" - else - month_names[number] - end - end - - def date_order - @date_order ||= @options[:order] || translated_date_order - end - - def translated_date_order - date_order = I18n.translate(:'date.order', :locale => @options[:locale], :default => []) - date_order = date_order.map { |element| element.to_sym } - - forbidden_elements = date_order - [:year, :month, :day] - if forbidden_elements.any? - raise StandardError, - "#{@options[:locale]}.date.order only accepts :year, :month and :day" - end - - date_order - end - - # Build full select tag from date type and options. - def build_options_and_select(type, selected, options = {}) - build_select(type, build_options(selected, options)) - end - - # Build select option html from date value and options. - # build_options(15, start: 1, end: 31) - # => "<option value="1">1</option> - # <option value="2">2</option> - # <option value="3">3</option>..." - # - # If <tt>use_two_digit_numbers: true</tt> option is passed - # build_options(15, start: 1, end: 31, use_two_digit_numbers: true) - # => "<option value="1">01</option> - # <option value="2">02</option> - # <option value="3">03</option>..." - # - # If <tt>:step</tt> options is passed - # build_options(15, start: 1, end: 31, step: 2) - # => "<option value="1">1</option> - # <option value="3">3</option> - # <option value="5">5</option>..." - def build_options(selected, options = {}) - options = { - leading_zeros: true, ampm: false, use_two_digit_numbers: false - }.merge!(options) - - start = options.delete(:start) || 0 - stop = options.delete(:end) || 59 - step = options.delete(:step) || 1 - leading_zeros = options.delete(:leading_zeros) - - select_options = [] - start.step(stop, step) do |i| - value = leading_zeros ? sprintf("%02d", i) : i - tag_options = { :value => value } - tag_options[:selected] = "selected" if selected == i - text = options[:use_two_digit_numbers] ? sprintf("%02d", i) : value - text = options[:ampm] ? AMPM_TRANSLATION[i] : text - select_options << content_tag(:option, text, tag_options) - end - - (select_options.join("\n") + "\n").html_safe - end - - # Builds select tag from date type and html select options. - # build_select(:month, "<option value="1">January</option>...") - # => "<select id="post_written_on_2i" name="post[written_on(2i)]"> - # <option value="1">January</option>... - # </select>" - def build_select(type, select_options_as_html) - select_options = { - :id => input_id_from_type(type), - :name => input_name_from_type(type) - }.merge!(@html_options) - select_options[:disabled] = 'disabled' if @options[:disabled] - select_options[:class] = type if @options[:with_css_classes] - - select_html = "\n" - select_html << content_tag(:option, '', :value => '') + "\n" if @options[:include_blank] - select_html << prompt_option_tag(type, @options[:prompt]) + "\n" if @options[:prompt] - select_html << select_options_as_html - - (content_tag(:select, select_html.html_safe, select_options) + "\n").html_safe - end - - # Builds a prompt option tag with supplied options or from default options. - # prompt_option_tag(:month, prompt: 'Select month') - # => "<option value="">Select month</option>" - def prompt_option_tag(type, options) - prompt = case options - when Hash - default_options = {:year => false, :month => false, :day => false, :hour => false, :minute => false, :second => false} - default_options.merge!(options)[type.to_sym] - when String - options - else - I18n.translate(:"datetime.prompts.#{type}", :locale => @options[:locale]) - end - - prompt ? content_tag(:option, prompt, :value => '') : '' - end - - # Builds hidden input tag for date part and value. - # build_hidden(:year, 2008) - # => "<input id="post_written_on_1i" name="post[written_on(1i)]" type="hidden" value="2008" />" - def build_hidden(type, value) - select_options = { - :type => "hidden", - :id => input_id_from_type(type), - :name => input_name_from_type(type), - :value => value - }.merge!(@html_options.slice(:disabled)) - select_options[:disabled] = 'disabled' if @options[:disabled] - - tag(:input, select_options) + "\n".html_safe - end - - # Returns the name attribute for the input tag. - # => post[written_on(1i)] - def input_name_from_type(type) - prefix = @options[:prefix] || ActionView::Helpers::DateTimeSelector::DEFAULT_PREFIX - prefix += "[#{@options[:index]}]" if @options.has_key?(:index) - - field_name = @options[:field_name] || type - if @options[:include_position] - field_name += "(#{ActionView::Helpers::DateTimeSelector::POSITION[type]}i)" - end - - @options[:discard_type] ? prefix : "#{prefix}[#{field_name}]" - end - - # Returns the id attribute for the input tag. - # => "post_written_on_1i" - def input_id_from_type(type) - id = input_name_from_type(type).gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '') - id = @options[:namespace] + '_' + id if @options[:namespace] - - id - end - - # Given an ordering of datetime components, create the selection HTML - # and join them with their appropriate separators. - def build_selects_from_types(order) - select = '' - first_visible = order.find { |type| !@options[:"discard_#{type}"] } - order.reverse.each do |type| - separator = separator(type) unless type == first_visible # don't add before first visible field - select.insert(0, separator.to_s + send("select_#{type}").to_s) - end - select.html_safe - end - - # Returns the separator for a given datetime component. - def separator(type) - return "" if @options[:use_hidden] - - case type - when :year, :month, :day - @options[:"discard_#{type}"] ? "" : @options[:date_separator] - when :hour - (@options[:discard_year] && @options[:discard_day]) ? "" : @options[:datetime_separator] - when :minute, :second - @options[:"discard_#{type}"] ? "" : @options[:time_separator] - end - end - end - - class FormBuilder - # Wraps ActionView::Helpers::DateHelper#date_select for form builders: - # - # <%= form_for @person do |f| %> - # <%= f.date_select :birth_date %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def date_select(method, options = {}, html_options = {}) - @template.date_select(@object_name, method, objectify_options(options), html_options) - end - - # Wraps ActionView::Helpers::DateHelper#time_select for form builders: - # - # <%= form_for @race do |f| %> - # <%= f.time_select :average_lap %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def time_select(method, options = {}, html_options = {}) - @template.time_select(@object_name, method, objectify_options(options), html_options) - end - - # Wraps ActionView::Helpers::DateHelper#datetime_select for form builders: - # - # <%= form_for @person do |f| %> - # <%= f.time_select :last_request_at %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def datetime_select(method, options = {}, html_options = {}) - @template.datetime_select(@object_name, method, objectify_options(options), html_options) - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/debug_helper.rb b/actionpack/lib/action_view/helpers/debug_helper.rb deleted file mode 100644 index c29c1b1eea..0000000000 --- a/actionpack/lib/action_view/helpers/debug_helper.rb +++ /dev/null @@ -1,39 +0,0 @@ -module ActionView - # = Action View Debug Helper - # - # Provides a set of methods for making it easier to debug Rails objects. - module Helpers - module DebugHelper - - include TagHelper - - # Returns a YAML representation of +object+ wrapped with <pre> and </pre>. - # If the object cannot be converted to YAML using +to_yaml+, +inspect+ will be called instead. - # Useful for inspecting an object at the time of rendering. - # - # @user = User.new({ username: 'testing', password: 'xyz', age: 42}) %> - # debug(@user) - # # => - # <pre class='debug_dump'>--- !ruby/object:User - # attributes: - # updated_at: - # username: testing - # - # age: 42 - # password: xyz - # created_at: - # attributes_cache: {} - # - # new_record: true - # </pre> - def debug(object) - Marshal::dump(object) - object = ERB::Util.html_escape(object.to_yaml).gsub(" ", " ").html_safe - content_tag(:pre, object, :class => "debug_dump") - rescue Exception # errors from Marshal or YAML - # Object couldn't be dumped, perhaps because of singleton methods -- this is the fallback - content_tag(:code, object.inspect, :class => "debug_dump") - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/form_helper.rb b/actionpack/lib/action_view/helpers/form_helper.rb deleted file mode 100644 index f64c0ca30b..0000000000 --- a/actionpack/lib/action_view/helpers/form_helper.rb +++ /dev/null @@ -1,1880 +0,0 @@ -require 'cgi' -require 'action_view/helpers/date_helper' -require 'action_view/helpers/tag_helper' -require 'action_view/helpers/form_tag_helper' -require 'action_view/helpers/active_model_helper' -require 'action_view/helpers/tags' -require 'action_view/model_naming' -require 'active_support/core_ext/class/attribute_accessors' -require 'active_support/core_ext/hash/slice' -require 'active_support/core_ext/string/output_safety' -require 'active_support/core_ext/string/inflections' - -module ActionView - # = Action View Form Helpers - module Helpers - # Form helpers are designed to make working with resources much easier - # compared to using vanilla HTML. - # - # Typically, a form designed to create or update a resource reflects the - # identity of the resource in several ways: (i) the url that the form is - # sent to (the form element's +action+ attribute) should result in a request - # being routed to the appropriate controller action (with the appropriate <tt>:id</tt> - # parameter in the case of an existing resource), (ii) input fields should - # be named in such a way that in the controller their values appear in the - # appropriate places within the +params+ hash, and (iii) for an existing record, - # when the form is initially displayed, input fields corresponding to attributes - # of the resource should show the current values of those attributes. - # - # In Rails, this is usually achieved by creating the form using +form_for+ and - # a number of related helper methods. +form_for+ generates an appropriate <tt>form</tt> - # tag and yields a form builder object that knows the model the form is about. - # Input fields are created by calling methods defined on the form builder, which - # means they are able to generate the appropriate names and default values - # corresponding to the model attributes, as well as convenient IDs, etc. - # Conventions in the generated field names allow controllers to receive form data - # nicely structured in +params+ with no effort on your side. - # - # For example, to create a new person you typically set up a new instance of - # +Person+ in the <tt>PeopleController#new</tt> action, <tt>@person</tt>, and - # in the view template pass that object to +form_for+: - # - # <%= form_for @person do |f| %> - # <%= f.label :first_name %>: - # <%= f.text_field :first_name %><br /> - # - # <%= f.label :last_name %>: - # <%= f.text_field :last_name %><br /> - # - # <%= f.submit %> - # <% end %> - # - # The HTML generated for this would be (modulus formatting): - # - # <form action="/people" class="new_person" id="new_person" method="post"> - # <div style="margin:0;padding:0;display:inline"> - # <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" /> - # </div> - # <label for="person_first_name">First name</label>: - # <input id="person_first_name" name="person[first_name]" type="text" /><br /> - # - # <label for="person_last_name">Last name</label>: - # <input id="person_last_name" name="person[last_name]" type="text" /><br /> - # - # <input name="commit" type="submit" value="Create Person" /> - # </form> - # - # As you see, the HTML reflects knowledge about the resource in several spots, - # like the path the form should be submitted to, or the names of the input fields. - # - # In particular, thanks to the conventions followed in the generated field names, the - # controller gets a nested hash <tt>params[:person]</tt> with the person attributes - # set in the form. That hash is ready to be passed to <tt>Person.create</tt>: - # - # if @person = Person.create(params[:person]) - # # success - # else - # # error handling - # end - # - # Interestingly, the exact same view code in the previous example can be used to edit - # a person. If <tt>@person</tt> is an existing record with name "John Smith" and ID 256, - # the code above as is would yield instead: - # - # <form action="/people/256" class="edit_person" id="edit_person_256" method="post"> - # <div style="margin:0;padding:0;display:inline"> - # <input name="_method" type="hidden" value="patch" /> - # <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" /> - # </div> - # <label for="person_first_name">First name</label>: - # <input id="person_first_name" name="person[first_name]" type="text" value="John" /><br /> - # - # <label for="person_last_name">Last name</label>: - # <input id="person_last_name" name="person[last_name]" type="text" value="Smith" /><br /> - # - # <input name="commit" type="submit" value="Update Person" /> - # </form> - # - # Note that the endpoint, default values, and submit button label are tailored for <tt>@person</tt>. - # That works that way because the involved helpers know whether the resource is a new record or not, - # and generate HTML accordingly. - # - # The controller would receive the form data again in <tt>params[:person]</tt>, ready to be - # passed to <tt>Person#update</tt>: - # - # if @person.update(params[:person]) - # # success - # else - # # error handling - # end - # - # That's how you typically work with resources. - module FormHelper - extend ActiveSupport::Concern - - include FormTagHelper - include UrlHelper - include ModelNaming - - # Creates a form that allows the user to create or update the attributes - # of a specific model object. - # - # The method can be used in several slightly different ways, depending on - # how much you wish to rely on Rails to infer automatically from the model - # how the form should be constructed. For a generic model object, a form - # can be created by passing +form_for+ a string or symbol representing - # the object we are concerned with: - # - # <%= form_for :person do |f| %> - # First name: <%= f.text_field :first_name %><br /> - # Last name : <%= f.text_field :last_name %><br /> - # Biography : <%= f.text_area :biography %><br /> - # Admin? : <%= f.check_box :admin %><br /> - # <%= f.submit %> - # <% end %> - # - # The variable +f+ yielded to the block is a FormBuilder object that - # incorporates the knowledge about the model object represented by - # <tt>:person</tt> passed to +form_for+. Methods defined on the FormBuilder - # are used to generate fields bound to this model. Thus, for example, - # - # <%= f.text_field :first_name %> - # - # will get expanded to - # - # <%= text_field :person, :first_name %> - # which results in an html <tt><input></tt> tag whose +name+ attribute is - # <tt>person[first_name]</tt>. This means that when the form is submitted, - # the value entered by the user will be available in the controller as - # <tt>params[:person][:first_name]</tt>. - # - # For fields generated in this way using the FormBuilder, - # if <tt>:person</tt> also happens to be the name of an instance variable - # <tt>@person</tt>, the default value of the field shown when the form is - # initially displayed (e.g. in the situation where you are editing an - # existing record) will be the value of the corresponding attribute of - # <tt>@person</tt>. - # - # The rightmost argument to +form_for+ is an - # optional hash of options - - # - # * <tt>:url</tt> - The URL the form is to be submitted to. This may be - # represented in the same way as values passed to +url_for+ or +link_to+. - # So for example you may use a named route directly. When the model is - # represented by a string or symbol, as in the example above, if the - # <tt>:url</tt> option is not specified, by default the form will be - # sent back to the current url (We will describe below an alternative - # resource-oriented usage of +form_for+ in which the URL does not need - # to be specified explicitly). - # * <tt>:namespace</tt> - A namespace for your form to ensure uniqueness of - # id attributes on form elements. The namespace attribute will be prefixed - # with underscore on the generated HTML id. - # * <tt>:html</tt> - Optional HTML attributes for the form tag. - # - # Also note that +form_for+ doesn't create an exclusive scope. It's still - # possible to use both the stand-alone FormHelper methods and methods - # from FormTagHelper. For example: - # - # <%= form_for :person do |f| %> - # First name: <%= f.text_field :first_name %> - # Last name : <%= f.text_field :last_name %> - # Biography : <%= text_area :person, :biography %> - # Admin? : <%= check_box_tag "person[admin]", "1", @person.company.admin? %> - # <%= f.submit %> - # <% end %> - # - # This also works for the methods in FormOptionHelper and DateHelper that - # are designed to work with an object as base, like - # FormOptionHelper#collection_select and DateHelper#datetime_select. - # - # === #form_for with a model object - # - # In the examples above, the object to be created or edited was - # represented by a symbol passed to +form_for+, and we noted that - # a string can also be used equivalently. It is also possible, however, - # to pass a model object itself to +form_for+. For example, if <tt>@post</tt> - # is an existing record you wish to edit, you can create the form using - # - # <%= form_for @post do |f| %> - # ... - # <% end %> - # - # This behaves in almost the same way as outlined previously, with a - # couple of small exceptions. First, the prefix used to name the input - # elements within the form (hence the key that denotes them in the +params+ - # hash) is actually derived from the object's _class_, e.g. <tt>params[:post]</tt> - # if the object's class is +Post+. However, this can be overwritten using - # the <tt>:as</tt> option, e.g. - - # - # <%= form_for(@person, as: :client) do |f| %> - # ... - # <% end %> - # - # would result in <tt>params[:client]</tt>. - # - # Secondly, the field values shown when the form is initially displayed - # are taken from the attributes of the object passed to +form_for+, - # regardless of whether the object is an instance - # variable. So, for example, if we had a _local_ variable +post+ - # representing an existing record, - # - # <%= form_for post do |f| %> - # ... - # <% end %> - # - # would produce a form with fields whose initial state reflect the current - # values of the attributes of +post+. - # - # === Resource-oriented style - # - # In the examples just shown, although not indicated explicitly, we still - # need to use the <tt>:url</tt> option in order to specify where the - # form is going to be sent. However, further simplification is possible - # if the record passed to +form_for+ is a _resource_, i.e. it corresponds - # to a set of RESTful routes, e.g. defined using the +resources+ method - # in <tt>config/routes.rb</tt>. In this case Rails will simply infer the - # appropriate URL from the record itself. For example, - # - # <%= form_for @post do |f| %> - # ... - # <% end %> - # - # is then equivalent to something like: - # - # <%= form_for @post, as: :post, url: post_path(@post), method: :patch, html: { class: "edit_post", id: "edit_post_45" } do |f| %> - # ... - # <% end %> - # - # And for a new record - # - # <%= form_for(Post.new) do |f| %> - # ... - # <% end %> - # - # is equivalent to something like: - # - # <%= form_for @post, as: :post, url: posts_path, html: { class: "new_post", id: "new_post" } do |f| %> - # ... - # <% end %> - # - # However you can still overwrite individual conventions, such as: - # - # <%= form_for(@post, url: super_posts_path) do |f| %> - # ... - # <% end %> - # - # You can also set the answer format, like this: - # - # <%= form_for(@post, format: :json) do |f| %> - # ... - # <% end %> - # - # For namespaced routes, like +admin_post_url+: - # - # <%= form_for([:admin, @post]) do |f| %> - # ... - # <% end %> - # - # If your resource has associations defined, for example, you want to add comments - # to the document given that the routes are set correctly: - # - # <%= form_for([@document, @comment]) do |f| %> - # ... - # <% end %> - # - # Where <tt>@document = Document.find(params[:id])</tt> and - # <tt>@comment = Comment.new</tt>. - # - # === Setting the method - # - # You can force the form to use the full array of HTTP verbs by setting - # - # method: (:get|:post|:patch|:put|:delete) - # - # in the options hash. If the verb is not GET or POST, which are natively - # supported by HTML forms, the form will be set to POST and a hidden input - # called _method will carry the intended verb for the server to interpret. - # - # === Unobtrusive JavaScript - # - # Specifying: - # - # remote: true - # - # in the options hash creates a form that will allow the unobtrusive JavaScript drivers to modify its - # behavior. The expected default behavior is an XMLHttpRequest in the background instead of the regular - # POST arrangement, but ultimately the behavior is the choice of the JavaScript driver implementor. - # Even though it's using JavaScript to serialize the form elements, the form submission will work just like - # a regular submission as viewed by the receiving side (all elements available in <tt>params</tt>). - # - # Example: - # - # <%= form_for(@post, remote: true) do |f| %> - # ... - # <% end %> - # - # The HTML generated for this would be: - # - # <form action='http://www.example.com' method='post' data-remote='true'> - # <div style='margin:0;padding:0;display:inline'> - # <input name='_method' type='hidden' value='patch' /> - # </div> - # ... - # </form> - # - # === Setting HTML options - # - # You can set data attributes directly by passing in a data hash, but all other HTML options must be wrapped in - # the HTML key. Example: - # - # <%= form_for(@post, data: { behavior: "autosave" }, html: { name: "go" }) do |f| %> - # ... - # <% end %> - # - # The HTML generated for this would be: - # - # <form action='http://www.example.com' method='post' data-behavior='autosave' name='go'> - # <div style='margin:0;padding:0;display:inline'> - # <input name='_method' type='hidden' value='patch' /> - # </div> - # ... - # </form> - # - # === Removing hidden model id's - # - # The form_for method automatically includes the model id as a hidden field in the form. - # This is used to maintain the correlation between the form data and its associated model. - # Some ORM systems do not use IDs on nested models so in this case you want to be able - # to disable the hidden id. - # - # In the following example the Post model has many Comments stored within it in a NoSQL database, - # thus there is no primary key for comments. - # - # Example: - # - # <%= form_for(@post) do |f| %> - # <%= f.fields_for(:comments, include_id: false) do |cf| %> - # ... - # <% end %> - # <% end %> - # - # === Customized form builders - # - # You can also build forms using a customized FormBuilder class. Subclass - # FormBuilder and override or define some more helpers, then use your - # custom builder. For example, let's say you made a helper to - # automatically add labels to form inputs. - # - # <%= form_for @person, url: { action: "create" }, builder: LabellingFormBuilder do |f| %> - # <%= f.text_field :first_name %> - # <%= f.text_field :last_name %> - # <%= f.text_area :biography %> - # <%= f.check_box :admin %> - # <%= f.submit %> - # <% end %> - # - # In this case, if you use this: - # - # <%= render f %> - # - # The rendered template is <tt>people/_labelling_form</tt> and the local - # variable referencing the form builder is called - # <tt>labelling_form</tt>. - # - # The custom FormBuilder class is automatically merged with the options - # of a nested fields_for call, unless it's explicitly set. - # - # In many cases you will want to wrap the above in another helper, so you - # could do something like the following: - # - # def labelled_form_for(record_or_name_or_array, *args, &block) - # options = args.extract_options! - # form_for(record_or_name_or_array, *(args << options.merge(builder: LabellingFormBuilder)), &block) - # end - # - # If you don't need to attach a form to a model instance, then check out - # FormTagHelper#form_tag. - # - # === Form to external resources - # - # When you build forms to external resources sometimes you need to set an authenticity token or just render a form - # without it, for example when you submit data to a payment gateway number and types of fields could be limited. - # - # To set an authenticity token you need to pass an <tt>:authenticity_token</tt> parameter - # - # <%= form_for @invoice, url: external_url, authenticity_token: 'external_token' do |f| - # ... - # <% end %> - # - # If you don't want to an authenticity token field be rendered at all just pass <tt>false</tt>: - # - # <%= form_for @invoice, url: external_url, authenticity_token: false do |f| - # ... - # <% end %> - def form_for(record, options = {}, &block) - raise ArgumentError, "Missing block" unless block_given? - html_options = options[:html] ||= {} - - case record - when String, Symbol - object_name = record - object = nil - else - object = record.is_a?(Array) ? record.last : record - raise ArgumentError, "First argument in form cannot contain nil or be empty" unless object - object_name = options[:as] || model_name_from_record_or_class(object).param_key - apply_form_for_options!(record, object, options) - end - - html_options[:data] = options.delete(:data) if options.has_key?(:data) - html_options[:remote] = options.delete(:remote) if options.has_key?(:remote) - html_options[:method] = options.delete(:method) if options.has_key?(:method) - html_options[:authenticity_token] = options.delete(:authenticity_token) - - builder = instantiate_builder(object_name, object, options) - output = capture(builder, &block) - html_options[:multipart] ||= builder.multipart? - - form_tag(options[:url] || {}, html_options) { output } - end - - def apply_form_for_options!(record, object, options) #:nodoc: - object = convert_to_model(object) - - as = options[:as] - action, method = object.respond_to?(:persisted?) && object.persisted? ? [:edit, :patch] : [:new, :post] - options[:html].reverse_merge!( - class: as ? "#{action}_#{as}" : dom_class(object, action), - id: as ? "#{action}_#{as}" : [options[:namespace], dom_id(object, action)].compact.join("_").presence, - method: method - ) - - options[:url] ||= polymorphic_path(record, format: options.delete(:format)) - end - private :apply_form_for_options! - - # Creates a scope around a specific model object like form_for, but - # doesn't create the form tags themselves. This makes fields_for suitable - # for specifying additional model objects in the same form. - # - # Although the usage and purpose of +field_for+ is similar to +form_for+'s, - # its method signature is slightly different. Like +form_for+, it yields - # a FormBuilder object associated with a particular model object to a block, - # and within the block allows methods to be called on the builder to - # generate fields associated with the model object. Fields may reflect - # a model object in two ways - how they are named (hence how submitted - # values appear within the +params+ hash in the controller) and what - # default values are shown when the form the fields appear in is first - # displayed. In order for both of these features to be specified independently, - # both an object name (represented by either a symbol or string) and the - # object itself can be passed to the method separately - - # - # <%= form_for @person do |person_form| %> - # First name: <%= person_form.text_field :first_name %> - # Last name : <%= person_form.text_field :last_name %> - # - # <%= fields_for :permission, @person.permission do |permission_fields| %> - # Admin? : <%= permission_fields.check_box :admin %> - # <% end %> - # - # <%= f.submit %> - # <% end %> - # - # In this case, the checkbox field will be represented by an HTML +input+ - # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted - # value will appear in the controller as <tt>params[:permission][:admin]</tt>. - # If <tt>@person.permission</tt> is an existing record with an attribute - # +admin+, the initial state of the checkbox when first displayed will - # reflect the value of <tt>@person.permission.admin</tt>. - # - # Often this can be simplified by passing just the name of the model - # object to +fields_for+ - - # - # <%= fields_for :permission do |permission_fields| %> - # Admin?: <%= permission_fields.check_box :admin %> - # <% end %> - # - # ...in which case, if <tt>:permission</tt> also happens to be the name of an - # instance variable <tt>@permission</tt>, the initial state of the input - # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>. - # - # Alternatively, you can pass just the model object itself (if the first - # argument isn't a string or symbol +fields_for+ will realize that the - # name has been omitted) - - # - # <%= fields_for @person.permission do |permission_fields| %> - # Admin?: <%= permission_fields.check_box :admin %> - # <% end %> - # - # and +fields_for+ will derive the required name of the field from the - # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is - # of class +Permission+, the field will still be named <tt>permission[admin]</tt>. - # - # Note: This also works for the methods in FormOptionHelper and - # DateHelper that are designed to work with an object as base, like - # FormOptionHelper#collection_select and DateHelper#datetime_select. - # - # === Nested Attributes Examples - # - # When the object belonging to the current scope has a nested attribute - # writer for a certain attribute, fields_for will yield a new scope - # for that attribute. This allows you to create forms that set or change - # the attributes of a parent object and its associations in one go. - # - # Nested attribute writers are normal setter methods named after an - # association. The most common way of defining these writers is either - # with +accepts_nested_attributes_for+ in a model definition or by - # defining a method with the proper name. For example: the attribute - # writer for the association <tt>:address</tt> is called - # <tt>address_attributes=</tt>. - # - # Whether a one-to-one or one-to-many style form builder will be yielded - # depends on whether the normal reader method returns a _single_ object - # or an _array_ of objects. - # - # ==== One-to-one - # - # Consider a Person class which returns a _single_ Address from the - # <tt>address</tt> reader method and responds to the - # <tt>address_attributes=</tt> writer method: - # - # class Person - # def address - # @address - # end - # - # def address_attributes=(attributes) - # # Process the attributes hash - # end - # end - # - # This model can now be used with a nested fields_for, like so: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :address do |address_fields| %> - # Street : <%= address_fields.text_field :street %> - # Zip code: <%= address_fields.text_field :zip_code %> - # <% end %> - # ... - # <% end %> - # - # When address is already an association on a Person you can use - # +accepts_nested_attributes_for+ to define the writer method for you: - # - # class Person < ActiveRecord::Base - # has_one :address - # accepts_nested_attributes_for :address - # end - # - # If you want to destroy the associated model through the form, you have - # to enable it first using the <tt>:allow_destroy</tt> option for - # +accepts_nested_attributes_for+: - # - # class Person < ActiveRecord::Base - # has_one :address - # accepts_nested_attributes_for :address, allow_destroy: true - # end - # - # Now, when you use a form element with the <tt>_destroy</tt> parameter, - # with a value that evaluates to +true+, you will destroy the associated - # model (eg. 1, '1', true, or 'true'): - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :address do |address_fields| %> - # ... - # Delete: <%= address_fields.check_box :_destroy %> - # <% end %> - # ... - # <% end %> - # - # ==== One-to-many - # - # Consider a Person class which returns an _array_ of Project instances - # from the <tt>projects</tt> reader method and responds to the - # <tt>projects_attributes=</tt> writer method: - # - # class Person - # def projects - # [@project1, @project2] - # end - # - # def projects_attributes=(attributes) - # # Process the attributes hash - # end - # end - # - # Note that the <tt>projects_attributes=</tt> writer method is in fact - # required for fields_for to correctly identify <tt>:projects</tt> as a - # collection, and the correct indices to be set in the form markup. - # - # When projects is already an association on Person you can use - # +accepts_nested_attributes_for+ to define the writer method for you: - # - # class Person < ActiveRecord::Base - # has_many :projects - # accepts_nested_attributes_for :projects - # end - # - # This model can now be used with a nested fields_for. The block given to - # the nested fields_for call will be repeated for each instance in the - # collection: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # <% if project_fields.object.active? %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # <% end %> - # ... - # <% end %> - # - # It's also possible to specify the instance to be used: - # - # <%= form_for @person do |person_form| %> - # ... - # <% @person.projects.each do |project| %> - # <% if project.active? %> - # <%= person_form.fields_for :projects, project do |project_fields| %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # <% end %> - # <% end %> - # ... - # <% end %> - # - # Or a collection to be used: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects, @active_projects do |project_fields| %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # ... - # <% end %> - # - # If you want to destroy any of the associated models through the - # form, you have to enable it first using the <tt>:allow_destroy</tt> - # option for +accepts_nested_attributes_for+: - # - # class Person < ActiveRecord::Base - # has_many :projects - # accepts_nested_attributes_for :projects, allow_destroy: true - # end - # - # This will allow you to specify which models to destroy in the - # attributes hash by adding a form element for the <tt>_destroy</tt> - # parameter with a value that evaluates to +true+ - # (eg. 1, '1', true, or 'true'): - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # Delete: <%= project_fields.check_box :_destroy %> - # <% end %> - # ... - # <% end %> - # - # When a collection is used you might want to know the index of each - # object into the array. For this purpose, the <tt>index</tt> method - # is available in the FormBuilder object. - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # Project #<%= project_fields.index %> - # ... - # <% end %> - # ... - # <% end %> - # - # Note that fields_for will automatically generate a hidden field - # to store the ID of the record. There are circumstances where this - # hidden field is not needed and you can pass <tt>include_id: false</tt> - # to prevent fields_for from rendering it automatically. - def fields_for(record_name, record_object = nil, options = {}, &block) - builder = instantiate_builder(record_name, record_object, options) - capture(builder, &block) - end - - # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). The text of label will default to the attribute name unless a translation - # is found in the current I18n locale (through helpers.label.<modelname>.<attribute>) or you specify it explicitly. - # Additional options on the label tag can be passed as a hash with +options+. These options will be tagged - # onto the HTML as an HTML element attribute as in the example shown, except for the <tt>:value</tt> option, which is designed to - # target labels for radio_button tags (where the value is used in the ID of the input tag). - # - # ==== Examples - # label(:post, :title) - # # => <label for="post_title">Title</label> - # - # You can localize your labels based on model and attribute names. - # For example you can define the following in your locale (e.g. en.yml) - # - # helpers: - # label: - # post: - # body: "Write your entire text here" - # - # Which then will result in - # - # label(:post, :body) - # # => <label for="post_body">Write your entire text here</label> - # - # Localization can also be based purely on the translation of the attribute-name - # (if you are using ActiveRecord): - # - # activerecord: - # attributes: - # post: - # cost: "Total cost" - # - # label(:post, :cost) - # # => <label for="post_cost">Total cost</label> - # - # label(:post, :title, "A short title") - # # => <label for="post_title">A short title</label> - # - # label(:post, :title, "A short title", class: "title_label") - # # => <label for="post_title" class="title_label">A short title</label> - # - # label(:post, :privacy, "Public Post", value: "public") - # # => <label for="post_privacy_public">Public Post</label> - # - # label(:post, :terms) do - # 'Accept <a href="/terms">Terms</a>.'.html_safe - # end - def label(object_name, method, content_or_options = nil, options = nil, &block) - Tags::Label.new(object_name, method, self, content_or_options, options).render(&block) - end - - # Returns an input tag of the "text" type tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. - # - # ==== Examples - # text_field(:post, :title, size: 20) - # # => <input type="text" id="post_title" name="post[title]" size="20" value="#{@post.title}" /> - # - # text_field(:post, :title, class: "create_input") - # # => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" class="create_input" /> - # - # text_field(:session, :user, onchange: "if ($('#session_user').val() === 'admin') { alert('Your login can not be admin!'); }") - # # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange="if ($('#session_user').val() === 'admin') { alert('Your login can not be admin!'); }"/> - # - # text_field(:snippet, :code, size: 20, class: 'code_input') - # # => <input type="text" id="snippet_code" name="snippet[code]" size="20" value="#{@snippet.code}" class="code_input" /> - def text_field(object_name, method, options = {}) - Tags::TextField.new(object_name, method, self, options).render - end - - # Returns an input tag of the "password" type tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. For security reasons this field is blank by default; pass in a value via +options+ if this is not desired. - # - # ==== Examples - # password_field(:login, :pass, size: 20) - # # => <input type="password" id="login_pass" name="login[pass]" size="20" /> - # - # password_field(:account, :secret, class: "form_input", value: @account.secret) - # # => <input type="password" id="account_secret" name="account[secret]" value="#{@account.secret}" class="form_input" /> - # - # password_field(:user, :password, onchange: "if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }") - # # => <input type="password" id="user_password" name="user[password]" onchange="if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }"/> - # - # password_field(:account, :pin, size: 20, class: 'form_input') - # # => <input type="password" id="account_pin" name="account[pin]" size="20" class="form_input" /> - def password_field(object_name, method, options = {}) - Tags::PasswordField.new(object_name, method, self, options).render - end - - # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. - # - # ==== Examples - # hidden_field(:signup, :pass_confirm) - # # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" /> - # - # hidden_field(:post, :tag_list) - # # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" /> - # - # hidden_field(:user, :token) - # # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" /> - def hidden_field(object_name, method, options = {}) - Tags::HiddenField.new(object_name, method, self, options).render - end - - # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. - # - # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>. - # - # ==== Options - # * Creates standard HTML attributes for the tag. - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files. - # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations. - # - # ==== Examples - # file_field(:user, :avatar) - # # => <input type="file" id="user_avatar" name="user[avatar]" /> - # - # file_field(:post, :image, :multiple => true) - # # => <input type="file" id="post_image" name="post[image]" multiple="true" /> - # - # file_field(:post, :attached, accept: 'text/html') - # # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" /> - # - # file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg') - # # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" /> - # - # file_field(:attachment, :file, class: 'file_input') - # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" /> - def file_field(object_name, method, options = {}) - Tags::FileField.new(object_name, method, self, options).render - end - - # Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by +method+) - # on an object assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. - # - # ==== Examples - # text_area(:post, :body, cols: 20, rows: 40) - # # => <textarea cols="20" rows="40" id="post_body" name="post[body]"> - # # #{@post.body} - # # </textarea> - # - # text_area(:comment, :text, size: "20x30") - # # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]"> - # # #{@comment.text} - # # </textarea> - # - # text_area(:application, :notes, cols: 40, rows: 15, class: 'app_input') - # # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input"> - # # #{@application.notes} - # # </textarea> - # - # text_area(:entry, :body, size: "20x20", disabled: 'disabled') - # # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled"> - # # #{@entry.body} - # # </textarea> - def text_area(object_name, method, options = {}) - Tags::TextArea.new(object_name, method, self, options).render - end - - # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object. - # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked. - # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1 - # while the default +unchecked_value+ is set to 0 which is convenient for boolean values. - # - # ==== Gotcha - # - # The HTML specification says unchecked check boxes are not successful, and - # thus web browsers do not send them. Unfortunately this introduces a gotcha: - # if an +Invoice+ model has a +paid+ flag, and in the form that edits a paid - # invoice the user unchecks its check box, no +paid+ parameter is sent. So, - # any mass-assignment idiom like - # - # @invoice.update(params[:invoice]) - # - # wouldn't update the flag. - # - # To prevent this the helper generates an auxiliary hidden field before - # the very check box. The hidden field has the same name and its - # attributes mimic an unchecked check box. - # - # This way, the client either sends only the hidden field (representing - # the check box is unchecked), or both fields. Since the HTML specification - # says key/value pairs have to be sent in the same order they appear in the - # form, and parameters extraction gets the last occurrence of any repeated - # key in the query string, that works for ordinary forms. - # - # Unfortunately that workaround does not work when the check box goes - # within an array-like parameter, as in - # - # <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %> - # <%= form.check_box :paid %> - # ... - # <% end %> - # - # because parameter name repetition is precisely what Rails seeks to distinguish - # the elements of the array. For each item with a checked check box you - # get an extra ghost item with only that attribute, assigned to "0". - # - # In that case it is preferable to either use +check_box_tag+ or to use - # hashes instead of arrays. - # - # # Let's say that @post.validated? is 1: - # check_box("post", "validated") - # # => <input name="post[validated]" type="hidden" value="0" /> - # # <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" /> - # - # # Let's say that @puppy.gooddog is "no": - # check_box("puppy", "gooddog", {}, "yes", "no") - # # => <input name="puppy[gooddog]" type="hidden" value="no" /> - # # <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" /> - # - # check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no") - # # => <input name="eula[accepted]" type="hidden" value="no" /> - # # <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" /> - def check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0") - Tags::CheckBox.new(object_name, method, self, checked_value, unchecked_value, options).render - end - - # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the - # radio button will be checked. - # - # To force the radio button to be checked pass <tt>checked: true</tt> in the - # +options+ hash. You may pass HTML options there as well. - # - # # Let's say that @post.category returns "rails": - # radio_button("post", "category", "rails") - # radio_button("post", "category", "java") - # # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" /> - # # <input type="radio" id="post_category_java" name="post[category]" value="java" /> - # - # radio_button("user", "receive_newsletter", "yes") - # radio_button("user", "receive_newsletter", "no") - # # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" /> - # # <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" /> - def radio_button(object_name, method, tag_value, options = {}) - Tags::RadioButton.new(object_name, method, self, tag_value, options).render - end - - # Returns a text_field of type "color". - # - # color_field("car", "color") - # # => <input id="car_color" name="car[color]" type="color" value="#000000" /> - def color_field(object_name, method, options = {}) - Tags::ColorField.new(object_name, method, self, options).render - end - - # Returns an input of type "search" for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object_name+). Inputs of type "search" may be styled differently by - # some browsers. - # - # search_field(:user, :name) - # # => <input id="user_name" name="user[name]" type="search" /> - # search_field(:user, :name, autosave: false) - # # => <input autosave="false" id="user_name" name="user[name]" type="search" /> - # search_field(:user, :name, results: 3) - # # => <input id="user_name" name="user[name]" results="3" type="search" /> - # # Assume request.host returns "www.example.com" - # search_field(:user, :name, autosave: true) - # # => <input autosave="com.example.www" id="user_name" name="user[name]" results="10" type="search" /> - # search_field(:user, :name, onsearch: true) - # # => <input id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" /> - # search_field(:user, :name, autosave: false, onsearch: true) - # # => <input autosave="false" id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" /> - # search_field(:user, :name, autosave: true, onsearch: true) - # # => <input autosave="com.example.www" id="user_name" incremental="true" name="user[name]" onsearch="true" results="10" type="search" /> - def search_field(object_name, method, options = {}) - Tags::SearchField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "tel". - # - # telephone_field("user", "phone") - # # => <input id="user_phone" name="user[phone]" type="tel" /> - # - def telephone_field(object_name, method, options = {}) - Tags::TelField.new(object_name, method, self, options).render - end - # aliases telephone_field - alias phone_field telephone_field - - # Returns a text_field of type "date". - # - # date_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="date" /> - # - # The default value is generated by trying to call "to_date" - # on the object's value, which makes it behave as expected for instances - # of DateTime and ActiveSupport::TimeWithZone. You can still override that - # by passing the "value" option explicitly, e.g. - # - # @user.born_on = Date.new(1984, 1, 27) - # date_field("user", "born_on", value: "1984-05-12") - # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-05-12" /> - # - def date_field(object_name, method, options = {}) - Tags::DateField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "time". - # - # The default value is generated by trying to call +strftime+ with "%T.%L" - # on the objects's value. It is still possible to override that - # by passing the "value" option. - # - # === Options - # * Accepts same options as time_field_tag - # - # === Example - # time_field("task", "started_at") - # # => <input id="task_started_at" name="task[started_at]" type="time" /> - # - def time_field(object_name, method, options = {}) - Tags::TimeField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "datetime". - # - # datetime_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="datetime" /> - # - # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T.%L%z" - # on the object's value, which makes it behave as expected for instances - # of DateTime and ActiveSupport::TimeWithZone. - # - # @user.born_on = Date.new(1984, 1, 12) - # datetime_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="datetime" value="1984-01-12T00:00:00.000+0000" /> - # - def datetime_field(object_name, method, options = {}) - Tags::DatetimeField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "datetime-local". - # - # datetime_local_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="datetime-local" /> - # - # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T" - # on the object's value, which makes it behave as expected for instances - # of DateTime and ActiveSupport::TimeWithZone. - # - # @user.born_on = Date.new(1984, 1, 12) - # datetime_local_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="datetime-local" value="1984-01-12T00:00:00" /> - # - def datetime_local_field(object_name, method, options = {}) - Tags::DatetimeLocalField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "month". - # - # month_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="month" /> - # - # The default value is generated by trying to call +strftime+ with "%Y-%m" - # on the object's value, which makes it behave as expected for instances - # of DateTime and ActiveSupport::TimeWithZone. - # - # @user.born_on = Date.new(1984, 1, 27) - # month_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-01" /> - # - def month_field(object_name, method, options = {}) - Tags::MonthField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "week". - # - # week_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="week" /> - # - # The default value is generated by trying to call +strftime+ with "%Y-W%W" - # on the object's value, which makes it behave as expected for instances - # of DateTime and ActiveSupport::TimeWithZone. - # - # @user.born_on = Date.new(1984, 5, 12) - # week_field("user", "born_on") - # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-W19" /> - # - def week_field(object_name, method, options = {}) - Tags::WeekField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "url". - # - # url_field("user", "homepage") - # # => <input id="user_homepage" name="user[homepage]" type="url" /> - # - def url_field(object_name, method, options = {}) - Tags::UrlField.new(object_name, method, self, options).render - end - - # Returns a text_field of type "email". - # - # email_field("user", "address") - # # => <input id="user_address" name="user[address]" type="email" /> - # - def email_field(object_name, method, options = {}) - Tags::EmailField.new(object_name, method, self, options).render - end - - # Returns an input tag of type "number". - # - # ==== Options - # * Accepts same options as number_field_tag - def number_field(object_name, method, options = {}) - Tags::NumberField.new(object_name, method, self, options).render - end - - # Returns an input tag of type "range". - # - # ==== Options - # * Accepts same options as range_field_tag - def range_field(object_name, method, options = {}) - Tags::RangeField.new(object_name, method, self, options).render - end - - private - - def instantiate_builder(record_name, record_object, options) - case record_name - when String, Symbol - object = record_object - object_name = record_name - else - object = record_name - object_name = model_name_from_record_or_class(object).param_key - end - - builder = options[:builder] || default_form_builder - builder.new(object_name, object, self, options) - end - - def default_form_builder - builder = ActionView::Base.default_form_builder - builder.respond_to?(:constantize) ? builder.constantize : builder - end - end - - # A +FormBuilder+ object is associated with a particular model object and - # allows you to generate fields associated with the model object. The - # +FormBuilder+ object is yielded when using +form_for+ or +fields_for+. - # For example: - # - # <%= form_for @person do |person_form| %> - # Name: <%= person_form.text_field :name %> - # Admin: <%= person_form.check_box :admin %> - # <% end %> - # - # In the above block, the a +FormBuilder+ object is yielded as the - # +person_form+ variable. This allows you to generate the +text_field+ - # and +check_box+ fields by specifying their eponymous methods, which - # modify the underlying template and associates the +@person+ model object - # with the form. - # - # The +FormBuilder+ object can be thought of as serving as a proxy for the - # methods in the +FormHelper+ module. This class, however, allows you to - # call methods with the model object you are building the form for. - # - # You can create your own custom FormBuilder templates by subclasses this - # class. For example: - # - # class MyFormBuilder < ActionView::Helpers::FormBuilder - # def div_radio_button(method, tag_value, options = {}) - # @template.content_tag(:div, - # @template.radio_button( - # @object_name, method, tag_value, objectify_options(options) - # ) - # ) - # end - # - # The above code creates a new method +div_radio_button+ which wraps a div - # around the a new radio button. Note that when options are passed in, you - # must called +objectify_options+ in order for the model object to get - # correctly passed to the method. If +objectify_options+ is not called, - # then the newly created helper will not be linked back to the model. - # - # The +div_radio_button+ code from above can now be used as follows: - # - # <%= form_for @person, :builder => MyFormBuilder do |f| %> - # I am a child: <%= f.div_radio_button(:admin, "child") %> - # I am an adult: <%= f.div_radio_button(:admin, "adult") %> - # <% end -%> - # - # The standard set of helper methods for form building are located in the - # +field_helpers+ class attribute. - class FormBuilder - include ModelNaming - - # The methods which wrap a form helper call. - class_attribute :field_helpers - self.field_helpers = [:fields_for, :label, :text_field, :password_field, - :hidden_field, :file_field, :text_area, :check_box, - :radio_button, :color_field, :search_field, - :telephone_field, :phone_field, :date_field, - :time_field, :datetime_field, :datetime_local_field, - :month_field, :week_field, :url_field, :email_field, - :number_field, :range_field] - - attr_accessor :object_name, :object, :options - - attr_reader :multipart, :index - alias :multipart? :multipart - - def multipart=(multipart) - @multipart = multipart - - if parent_builder = @options[:parent_builder] - parent_builder.multipart = multipart - end - end - - def self._to_partial_path - @_to_partial_path ||= name.demodulize.underscore.sub!(/_builder$/, '') - end - - def to_partial_path - self.class._to_partial_path - end - - def to_model - self - end - - def initialize(object_name, object, template, options, block=nil) - if block - ActiveSupport::Deprecation.warn "Giving a block to FormBuilder is deprecated and has no effect anymore." - end - - @nested_child_index = {} - @object_name, @object, @template, @options = object_name, object, template, options - @default_options = @options ? @options.slice(:index, :namespace) : {} - if @object_name.to_s.match(/\[\]$/) - if object ||= @template.instance_variable_get("@#{Regexp.last_match.pre_match}") and object.respond_to?(:to_param) - @auto_index = 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 - @multipart = nil - @index = options[:index] || options[:child_index] - end - - (field_helpers - [:label, :check_box, :radio_button, :fields_for, :hidden_field, :file_field]).each do |selector| - class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1 - def #{selector}(method, options = {}) # def text_field(method, options = {}) - @template.send( # @template.send( - #{selector.inspect}, # "text_field", - @object_name, # @object_name, - method, # method, - objectify_options(options)) # objectify_options(options)) - end # end - RUBY_EVAL - end - - # Creates a scope around a specific model object like form_for, but - # doesn't create the form tags themselves. This makes fields_for suitable - # for specifying additional model objects in the same form. - # - # Although the usage and purpose of +field_for+ is similar to +form_for+'s, - # its method signature is slightly different. Like +form_for+, it yields - # a FormBuilder object associated with a particular model object to a block, - # and within the block allows methods to be called on the builder to - # generate fields associated with the model object. Fields may reflect - # a model object in two ways - how they are named (hence how submitted - # values appear within the +params+ hash in the controller) and what - # default values are shown when the form the fields appear in is first - # displayed. In order for both of these features to be specified independently, - # both an object name (represented by either a symbol or string) and the - # object itself can be passed to the method separately - - # - # <%= form_for @person do |person_form| %> - # First name: <%= person_form.text_field :first_name %> - # Last name : <%= person_form.text_field :last_name %> - # - # <%= fields_for :permission, @person.permission do |permission_fields| %> - # Admin? : <%= permission_fields.check_box :admin %> - # <% end %> - # - # <%= person_form.submit %> - # <% end %> - # - # In this case, the checkbox field will be represented by an HTML +input+ - # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted - # value will appear in the controller as <tt>params[:permission][:admin]</tt>. - # If <tt>@person.permission</tt> is an existing record with an attribute - # +admin+, the initial state of the checkbox when first displayed will - # reflect the value of <tt>@person.permission.admin</tt>. - # - # Often this can be simplified by passing just the name of the model - # object to +fields_for+ - - # - # <%= fields_for :permission do |permission_fields| %> - # Admin?: <%= permission_fields.check_box :admin %> - # <% end %> - # - # ...in which case, if <tt>:permission</tt> also happens to be the name of an - # instance variable <tt>@permission</tt>, the initial state of the input - # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>. - # - # Alternatively, you can pass just the model object itself (if the first - # argument isn't a string or symbol +fields_for+ will realize that the - # name has been omitted) - - # - # <%= fields_for @person.permission do |permission_fields| %> - # Admin?: <%= permission_fields.check_box :admin %> - # <% end %> - # - # and +fields_for+ will derive the required name of the field from the - # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is - # of class +Permission+, the field will still be named <tt>permission[admin]</tt>. - # - # Note: This also works for the methods in FormOptionHelper and - # DateHelper that are designed to work with an object as base, like - # FormOptionHelper#collection_select and DateHelper#datetime_select. - # - # === Nested Attributes Examples - # - # When the object belonging to the current scope has a nested attribute - # writer for a certain attribute, fields_for will yield a new scope - # for that attribute. This allows you to create forms that set or change - # the attributes of a parent object and its associations in one go. - # - # Nested attribute writers are normal setter methods named after an - # association. The most common way of defining these writers is either - # with +accepts_nested_attributes_for+ in a model definition or by - # defining a method with the proper name. For example: the attribute - # writer for the association <tt>:address</tt> is called - # <tt>address_attributes=</tt>. - # - # Whether a one-to-one or one-to-many style form builder will be yielded - # depends on whether the normal reader method returns a _single_ object - # or an _array_ of objects. - # - # ==== One-to-one - # - # Consider a Person class which returns a _single_ Address from the - # <tt>address</tt> reader method and responds to the - # <tt>address_attributes=</tt> writer method: - # - # class Person - # def address - # @address - # end - # - # def address_attributes=(attributes) - # # Process the attributes hash - # end - # end - # - # This model can now be used with a nested fields_for, like so: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :address do |address_fields| %> - # Street : <%= address_fields.text_field :street %> - # Zip code: <%= address_fields.text_field :zip_code %> - # <% end %> - # ... - # <% end %> - # - # When address is already an association on a Person you can use - # +accepts_nested_attributes_for+ to define the writer method for you: - # - # class Person < ActiveRecord::Base - # has_one :address - # accepts_nested_attributes_for :address - # end - # - # If you want to destroy the associated model through the form, you have - # to enable it first using the <tt>:allow_destroy</tt> option for - # +accepts_nested_attributes_for+: - # - # class Person < ActiveRecord::Base - # has_one :address - # accepts_nested_attributes_for :address, allow_destroy: true - # end - # - # Now, when you use a form element with the <tt>_destroy</tt> parameter, - # with a value that evaluates to +true+, you will destroy the associated - # model (eg. 1, '1', true, or 'true'): - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :address do |address_fields| %> - # ... - # Delete: <%= address_fields.check_box :_destroy %> - # <% end %> - # ... - # <% end %> - # - # ==== One-to-many - # - # Consider a Person class which returns an _array_ of Project instances - # from the <tt>projects</tt> reader method and responds to the - # <tt>projects_attributes=</tt> writer method: - # - # class Person - # def projects - # [@project1, @project2] - # end - # - # def projects_attributes=(attributes) - # # Process the attributes hash - # end - # end - # - # Note that the <tt>projects_attributes=</tt> writer method is in fact - # required for fields_for to correctly identify <tt>:projects</tt> as a - # collection, and the correct indices to be set in the form markup. - # - # When projects is already an association on Person you can use - # +accepts_nested_attributes_for+ to define the writer method for you: - # - # class Person < ActiveRecord::Base - # has_many :projects - # accepts_nested_attributes_for :projects - # end - # - # This model can now be used with a nested fields_for. The block given to - # the nested fields_for call will be repeated for each instance in the - # collection: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # <% if project_fields.object.active? %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # <% end %> - # ... - # <% end %> - # - # It's also possible to specify the instance to be used: - # - # <%= form_for @person do |person_form| %> - # ... - # <% @person.projects.each do |project| %> - # <% if project.active? %> - # <%= person_form.fields_for :projects, project do |project_fields| %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # <% end %> - # <% end %> - # ... - # <% end %> - # - # Or a collection to be used: - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects, @active_projects do |project_fields| %> - # Name: <%= project_fields.text_field :name %> - # <% end %> - # ... - # <% end %> - # - # If you want to destroy any of the associated models through the - # form, you have to enable it first using the <tt>:allow_destroy</tt> - # option for +accepts_nested_attributes_for+: - # - # class Person < ActiveRecord::Base - # has_many :projects - # accepts_nested_attributes_for :projects, allow_destroy: true - # end - # - # This will allow you to specify which models to destroy in the - # attributes hash by adding a form element for the <tt>_destroy</tt> - # parameter with a value that evaluates to +true+ - # (eg. 1, '1', true, or 'true'): - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # Delete: <%= project_fields.check_box :_destroy %> - # <% end %> - # ... - # <% end %> - # - # When a collection is used you might want to know the index of each - # object into the array. For this purpose, the <tt>index</tt> method - # is available in the FormBuilder object. - # - # <%= form_for @person do |person_form| %> - # ... - # <%= person_form.fields_for :projects do |project_fields| %> - # Project #<%= project_fields.index %> - # ... - # <% end %> - # ... - # <% end %> - # - # Note that fields_for will automatically generate a hidden field - # to store the ID of the record. There are circumstances where this - # hidden field is not needed and you can pass <tt>include_id: false</tt> - # to prevent fields_for from rendering it automatically. - def fields_for(record_name, record_object = nil, fields_options = {}, &block) - fields_options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options? - fields_options[:builder] ||= options[:builder] - fields_options[:namespace] = options[:namespace] - fields_options[:parent_builder] = self - - case record_name - when String, Symbol - if nested_attributes_association?(record_name) - return fields_for_with_nested_attributes(record_name, record_object, fields_options, block) - end - else - record_object = record_name.is_a?(Array) ? record_name.last : record_name - record_name = model_name_from_record_or_class(record_object).param_key - end - - index = if options.has_key?(:index) - options[:index] - elsif defined?(@auto_index) - self.object_name = @object_name.to_s.sub(/\[\]$/,"") - @auto_index - end - - record_name = index ? "#{object_name}[#{index}][#{record_name}]" : "#{object_name}[#{record_name}]" - fields_options[:child_index] = index - - @template.fields_for(record_name, record_object, fields_options, &block) - end - - # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). The text of label will default to the attribute name unless a translation - # is found in the current I18n locale (through helpers.label.<modelname>.<attribute>) or you specify it explicitly. - # Additional options on the label tag can be passed as a hash with +options+. These options will be tagged - # onto the HTML as an HTML element attribute as in the example shown, except for the <tt>:value</tt> option, which is designed to - # target labels for radio_button tags (where the value is used in the ID of the input tag). - # - # ==== Examples - # label(:post, :title) - # # => <label for="post_title">Title</label> - # - # You can localize your labels based on model and attribute names. - # For example you can define the following in your locale (e.g. en.yml) - # - # helpers: - # label: - # post: - # body: "Write your entire text here" - # - # Which then will result in - # - # label(:post, :body) - # # => <label for="post_body">Write your entire text here</label> - # - # Localization can also be based purely on the translation of the attribute-name - # (if you are using ActiveRecord): - # - # activerecord: - # attributes: - # post: - # cost: "Total cost" - # - # label(:post, :cost) - # # => <label for="post_cost">Total cost</label> - # - # label(:post, :title, "A short title") - # # => <label for="post_title">A short title</label> - # - # label(:post, :title, "A short title", class: "title_label") - # # => <label for="post_title" class="title_label">A short title</label> - # - # label(:post, :privacy, "Public Post", value: "public") - # # => <label for="post_privacy_public">Public Post</label> - # - # label(:post, :terms) do - # 'Accept <a href="/terms">Terms</a>.'.html_safe - # end - def label(method, text = nil, options = {}, &block) - @template.label(@object_name, method, text, objectify_options(options), &block) - end - - # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object. - # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked. - # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1 - # while the default +unchecked_value+ is set to 0 which is convenient for boolean values. - # - # ==== Gotcha - # - # The HTML specification says unchecked check boxes are not successful, and - # thus web browsers do not send them. Unfortunately this introduces a gotcha: - # if an +Invoice+ model has a +paid+ flag, and in the form that edits a paid - # invoice the user unchecks its check box, no +paid+ parameter is sent. So, - # any mass-assignment idiom like - # - # @invoice.update(params[:invoice]) - # - # wouldn't update the flag. - # - # To prevent this the helper generates an auxiliary hidden field before - # the very check box. The hidden field has the same name and its - # attributes mimic an unchecked check box. - # - # This way, the client either sends only the hidden field (representing - # the check box is unchecked), or both fields. Since the HTML specification - # says key/value pairs have to be sent in the same order they appear in the - # form, and parameters extraction gets the last occurrence of any repeated - # key in the query string, that works for ordinary forms. - # - # Unfortunately that workaround does not work when the check box goes - # within an array-like parameter, as in - # - # <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %> - # <%= form.check_box :paid %> - # ... - # <% end %> - # - # because parameter name repetition is precisely what Rails seeks to distinguish - # the elements of the array. For each item with a checked check box you - # get an extra ghost item with only that attribute, assigned to "0". - # - # In that case it is preferable to either use +check_box_tag+ or to use - # hashes instead of arrays. - # - # # Let's say that @post.validated? is 1: - # check_box("post", "validated") - # # => <input name="post[validated]" type="hidden" value="0" /> - # # <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" /> - # - # # Let's say that @puppy.gooddog is "no": - # check_box("puppy", "gooddog", {}, "yes", "no") - # # => <input name="puppy[gooddog]" type="hidden" value="no" /> - # # <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" /> - # - # check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no") - # # => <input name="eula[accepted]" type="hidden" value="no" /> - # # <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" /> - def check_box(method, options = {}, checked_value = "1", unchecked_value = "0") - @template.check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value) - end - - # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the - # radio button will be checked. - # - # To force the radio button to be checked pass <tt>checked: true</tt> in the - # +options+ hash. You may pass HTML options there as well. - # - # # Let's say that @post.category returns "rails": - # radio_button("post", "category", "rails") - # radio_button("post", "category", "java") - # # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" /> - # # <input type="radio" id="post_category_java" name="post[category]" value="java" /> - # - # radio_button("user", "receive_newsletter", "yes") - # radio_button("user", "receive_newsletter", "no") - # # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" /> - # # <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" /> - def radio_button(method, tag_value, options = {}) - @template.radio_button(@object_name, method, tag_value, objectify_options(options)) - end - - # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. - # - # ==== Examples - # hidden_field(:signup, :pass_confirm) - # # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" /> - # - # hidden_field(:post, :tag_list) - # # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" /> - # - # hidden_field(:user, :token) - # # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" /> - # - def hidden_field(method, options = {}) - @emitted_hidden_id = true if method == :id - @template.hidden_field(@object_name, method, objectify_options(options)) - end - - # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object - # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a - # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example - # shown. - # - # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>. - # - # ==== Options - # * Creates standard HTML attributes for the tag. - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files. - # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations. - # - # ==== Examples - # file_field(:user, :avatar) - # # => <input type="file" id="user_avatar" name="user[avatar]" /> - # - # file_field(:post, :image, :multiple => true) - # # => <input type="file" id="post_image" name="post[image]" multiple="true" /> - # - # file_field(:post, :attached, accept: 'text/html') - # # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" /> - # - # file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg') - # # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" /> - # - # file_field(:attachment, :file, class: 'file_input') - # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" /> - def file_field(method, options = {}) - self.multipart = true - @template.file_field(@object_name, method, objectify_options(options)) - end - - # Add the submit button for the given form. When no value is given, it checks - # if the object is a new resource or not to create the proper label: - # - # <%= form_for @post do |f| %> - # <%= f.submit %> - # <% end %> - # - # In the example above, if @post is a new record, it will use "Create Post" as - # submit button label, otherwise, it uses "Update Post". - # - # Those labels can be customized using I18n, under the helpers.submit key and accept - # the %{model} as translation interpolation: - # - # en: - # helpers: - # submit: - # create: "Create a %{model}" - # update: "Confirm changes to %{model}" - # - # It also searches for a key specific for the given object: - # - # en: - # helpers: - # submit: - # post: - # create: "Add %{model}" - # - def submit(value=nil, options={}) - value, options = nil, value if value.is_a?(Hash) - value ||= submit_default_value - @template.submit_tag(value, options) - end - - # Add the submit button for the given form. When no value is given, it checks - # if the object is a new resource or not to create the proper label: - # - # <%= form_for @post do |f| %> - # <%= f.button %> - # <% end %> - # - # In the example above, if @post is a new record, it will use "Create Post" as - # button label, otherwise, it uses "Update Post". - # - # Those labels can be customized using I18n, under the helpers.submit key - # (the same as submit helper) and accept the %{model} as translation interpolation: - # - # en: - # helpers: - # submit: - # create: "Create a %{model}" - # update: "Confirm changes to %{model}" - # - # It also searches for a key specific for the given object: - # - # en: - # helpers: - # submit: - # post: - # create: "Add %{model}" - # - # ==== Examples - # button("Create a post") - # # => <button name='button' type='submit'>Create post</button> - # - # button do - # content_tag(:strong, 'Ask me!') - # end - # # => <button name='button' type='submit'> - # # <strong>Ask me!</strong> - # # </button> - # - def button(value = nil, options = {}, &block) - value, options = nil, value if value.is_a?(Hash) - value ||= submit_default_value - @template.button_tag(value, options, &block) - end - - def emitted_hidden_id? - @emitted_hidden_id ||= nil - end - - private - def objectify_options(options) - @default_options.merge(options.merge(object: @object)) - end - - def submit_default_value - object = convert_to_model(@object) - key = object ? (object.persisted? ? :update : :create) : :submit - - model = if object.class.respond_to?(:model_name) - object.class.model_name.human - else - @object_name.to_s.humanize - end - - defaults = [] - defaults << :"helpers.submit.#{object_name}.#{key}" - defaults << :"helpers.submit.#{key}" - defaults << "#{key.to_s.humanize} #{model}" - - I18n.t(defaults.shift, model: model, default: defaults) - end - - def nested_attributes_association?(association_name) - @object.respond_to?("#{association_name}_attributes=") - end - - def fields_for_with_nested_attributes(association_name, association, options, block) - name = "#{object_name}[#{association_name}_attributes]" - association = convert_to_model(association) - - if association.respond_to?(:persisted?) - association = [association] if @object.send(association_name).respond_to?(:to_ary) - elsif !association.respond_to?(:to_ary) - association = @object.send(association_name) - end - - if association.respond_to?(:to_ary) - explicit_child_index = options[:child_index] - output = ActiveSupport::SafeBuffer.new - association.each do |child| - options[:child_index] = nested_child_index(name) unless explicit_child_index - output << fields_for_nested_model("#{name}[#{options[:child_index]}]", child, options, block) - end - output - elsif association - fields_for_nested_model(name, association, options, block) - end - end - - def fields_for_nested_model(name, object, fields_options, block) - object = convert_to_model(object) - emit_hidden_id = object.persisted? && fields_options.fetch(:include_id) { - options.fetch(:include_id, true) - } - - @template.fields_for(name, object, fields_options) do |f| - output = @template.capture(f, &block) - output.concat f.hidden_field(:id) if output && emit_hidden_id && !f.emitted_hidden_id? - output - end - end - - def nested_child_index(name) - @nested_child_index[name] ||= -1 - @nested_child_index[name] += 1 - end - end - end - - ActiveSupport.on_load(:action_view) do - cattr_accessor(:default_form_builder) { ::ActionView::Helpers::FormBuilder } - end -end diff --git a/actionpack/lib/action_view/helpers/form_options_helper.rb b/actionpack/lib/action_view/helpers/form_options_helper.rb deleted file mode 100644 index ad26505086..0000000000 --- a/actionpack/lib/action_view/helpers/form_options_helper.rb +++ /dev/null @@ -1,832 +0,0 @@ -require 'cgi' -require 'erb' -require 'action_view/helpers/form_helper' -require 'active_support/core_ext/string/output_safety' -require 'active_support/core_ext/array/extract_options' -require 'active_support/core_ext/array/wrap' - -module ActionView - # = Action View Form Option Helpers - module Helpers - # Provides a number of methods for turning different kinds of containers into a set of option tags. - # - # The <tt>collection_select</tt>, <tt>select</tt> and <tt>time_zone_select</tt> methods take an <tt>options</tt> parameter, a hash: - # - # * <tt>:include_blank</tt> - set to true or a prompt string if the first option element of the select element is a blank. Useful if there is not a default value required for the select element. - # - # select("post", "category", Post::CATEGORIES, {include_blank: true}) - # - # could become: - # - # <select name="post[category]"> - # <option></option> - # <option>joke</option> - # <option>poem</option> - # </select> - # - # Another common case is a select tag for a <tt>belongs_to</tt>-associated object. - # - # Example with @post.person_id => 2: - # - # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {include_blank: 'None'}) - # - # could become: - # - # <select name="post[person_id]"> - # <option value="">None</option> - # <option value="1">David</option> - # <option value="2" selected="selected">Sam</option> - # <option value="3">Tobias</option> - # </select> - # - # * <tt>:prompt</tt> - set to true or a prompt string. When the select element doesn't have a value yet, this prepends an option with a generic prompt -- "Please select" -- or the given prompt string. - # - # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {prompt: 'Select Person'}) - # - # could become: - # - # <select name="post[person_id]"> - # <option value="">Select Person</option> - # <option value="1">David</option> - # <option value="2">Sam</option> - # <option value="3">Tobias</option> - # </select> - # - # Like the other form helpers, +select+ can accept an <tt>:index</tt> option to manually set the ID used in the resulting output. Unlike other helpers, +select+ expects this - # option to be in the +html_options+ parameter. - # - # select("album[]", "genre", %w[rap rock country], {}, { index: nil }) - # - # becomes: - # - # <select name="album[][genre]" id="album__genre"> - # <option value="rap">rap</option> - # <option value="rock">rock</option> - # <option value="country">country</option> - # </select> - # - # * <tt>:disabled</tt> - can be a single value or an array of values that will be disabled options in the final output. - # - # select("post", "category", Post::CATEGORIES, {disabled: 'restricted'}) - # - # could become: - # - # <select name="post[category]"> - # <option></option> - # <option>joke</option> - # <option>poem</option> - # <option disabled="disabled">restricted</option> - # </select> - # - # When used with the <tt>collection_select</tt> helper, <tt>:disabled</tt> can also be a Proc that identifies those options that should be disabled. - # - # collection_select(:post, :category_id, Category.all, :id, :name, {disabled: lambda{|category| category.archived? }}) - # - # If the categories "2008 stuff" and "Christmas" return true when the method <tt>archived?</tt> is called, this would return: - # <select name="post[category_id]"> - # <option value="1" disabled="disabled">2008 stuff</option> - # <option value="2" disabled="disabled">Christmas</option> - # <option value="3">Jokes</option> - # <option value="4">Poems</option> - # </select> - # - module FormOptionsHelper - # ERB::Util can mask some helpers like textilize. Make sure to include them. - include TextHelper - - # Create a select tag and a series of contained option tags for the provided object and method. - # The option currently held by the object will be selected, provided that the object is available. - # - # There are two possible formats for the choices parameter, corresponding to other helpers' output: - # * A flat collection: see options_for_select - # * A nested collection: see grouped_options_for_select - # - # Example with @post.person_id => 1: - # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { include_blank: true }) - # - # could become: - # - # <select name="post[person_id]"> - # <option value=""></option> - # <option value="1" selected="selected">David</option> - # <option value="2">Sam</option> - # <option value="3">Tobias</option> - # </select> - # - # This can be used to provide a default set of options in the standard way: before rendering the create form, a - # new model instance is assigned the default options and bound to @model_name. Usually this model is not saved - # to the database. Instead, a second model object is created when the create request is received. - # This allows the user to submit a form page more than once with the expected results of creating multiple records. - # In addition, this allows a single partial to be used to generate form inputs for both edit and create forms. - # - # By default, <tt>post.person_id</tt> is the selected option. Specify <tt>selected: value</tt> to use a different selection - # or <tt>selected: nil</tt> to leave all options unselected. Similarly, you can specify values to be disabled in the option - # tags by specifying the <tt>:disabled</tt> option. This can either be a single value or an array of values to be disabled. - # - # ==== Gotcha - # - # The HTML specification says when +multiple+ parameter passed to select and all options got deselected - # web browsers do not send any value to server. Unfortunately this introduces a gotcha: - # if an +User+ model has many +roles+ and have +role_ids+ accessor, and in the form that edits roles of the user - # the user deselects all roles from +role_ids+ multiple select box, no +role_ids+ parameter is sent. So, - # any mass-assignment idiom like - # - # @user.update(params[:user]) - # - # wouldn't update roles. - # - # To prevent this the helper generates an auxiliary hidden field before - # every multiple select. The hidden field has the same name as multiple select and blank value. - # - # This way, the client either sends only the hidden field (representing - # the deselected multiple select box), or both fields. Since the HTML specification - # says key/value pairs have to be sent in the same order they appear in the - # form, and parameters extraction gets the last occurrence of any repeated - # key in the query string, that works for ordinary forms. - # - # In case if you don't want the helper to generate this hidden field you can specify - # <tt>include_hidden: false</tt> option. - # - def select(object, method, choices, options = {}, html_options = {}) - Tags::Select.new(object, method, self, choices, options, html_options).render - end - - # Returns <tt><select></tt> and <tt><option></tt> tags for the collection of existing return values of - # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will - # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt> - # or <tt>:include_blank</tt> in the +options+ hash. - # - # The <tt>:value_method</tt> and <tt>:text_method</tt> parameters are methods to be called on each member - # of +collection+. The return values are used as the +value+ attribute and contents of each - # <tt><option></tt> tag, respectively. They can also be any object that responds to +call+, such - # as a +proc+, that will be called for each member of the +collection+ to - # retrieve the value/text. - # - # Example object structure for use with this method: - # - # class Post < ActiveRecord::Base - # belongs_to :author - # end - # - # class Author < ActiveRecord::Base - # has_many :posts - # def name_with_initial - # "#{first_name.first}. #{last_name}" - # end - # end - # - # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>): - # - # collection_select(:post, :author_id, Author.all, :id, :name_with_initial, prompt: true) - # - # If <tt>@post.author_id</tt> is already <tt>1</tt>, this would return: - # <select name="post[author_id]"> - # <option value="">Please select</option> - # <option value="1" selected="selected">D. Heinemeier Hansson</option> - # <option value="2">D. Thomas</option> - # <option value="3">M. Clark</option> - # </select> - def collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {}) - Tags::CollectionSelect.new(object, method, self, collection, value_method, text_method, options, html_options).render - end - - # Returns <tt><select></tt>, <tt><optgroup></tt> and <tt><option></tt> tags for the collection of existing return values of - # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will - # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt> - # or <tt>:include_blank</tt> in the +options+ hash. - # - # Parameters: - # * +object+ - The instance of the class to be used for the select tag - # * +method+ - The attribute of +object+ corresponding to the select tag - # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags. - # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an - # array of child objects representing the <tt><option></tt> tags. - # * +group_label_method+ - The name of a method which, when called on a member of +collection+, returns a - # string to be used as the +label+ attribute for its <tt><optgroup></tt> tag. - # * +option_key_method+ - The name of a method which, when called on a child object of a member of - # +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag. - # * +option_value_method+ - The name of a method which, when called on a child object of a member of - # +collection+, returns a value to be used as the contents of its <tt><option></tt> tag. - # - # Example object structure for use with this method: - # - # class Continent < ActiveRecord::Base - # has_many :countries - # # attribs: id, name - # end - # - # class Country < ActiveRecord::Base - # belongs_to :continent - # # attribs: id, name, continent_id - # end - # - # class City < ActiveRecord::Base - # belongs_to :country - # # attribs: id, name, country_id - # end - # - # Sample usage: - # - # grouped_collection_select(:city, :country_id, @continents, :countries, :name, :id, :name) - # - # Possible output: - # - # <select name="city[country_id]"> - # <optgroup label="Africa"> - # <option value="1">South Africa</option> - # <option value="3">Somalia</option> - # </optgroup> - # <optgroup label="Europe"> - # <option value="7" selected="selected">Denmark</option> - # <option value="2">Ireland</option> - # </optgroup> - # </select> - # - def grouped_collection_select(object, method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {}) - Tags::GroupedCollectionSelect.new(object, method, self, collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options).render - end - - # Return select and option tags for the given object and method, using - # #time_zone_options_for_select to generate the list of option tags. - # - # In addition to the <tt>:include_blank</tt> option documented above, - # this method also supports a <tt>:model</tt> option, which defaults - # to ActiveSupport::TimeZone. This may be used by users to specify a - # different time zone model object. (See +time_zone_options_for_select+ - # for more information.) - # - # You can also supply an array of ActiveSupport::TimeZone objects - # as +priority_zones+, so that they will be listed above the rest of the - # (long) list. (You can use ActiveSupport::TimeZone.us_zones as a convenience - # for obtaining a list of the US time zones, or a Regexp to select the zones - # of your choice) - # - # Finally, this method supports a <tt>:default</tt> option, which selects - # a default ActiveSupport::TimeZone if the object's time zone is +nil+. - # - # time_zone_select( "user", "time_zone", nil, include_blank: true) - # - # time_zone_select( "user", "time_zone", nil, default: "Pacific Time (US & Canada)" ) - # - # time_zone_select( "user", 'time_zone', ActiveSupport::TimeZone.us_zones, default: "Pacific Time (US & Canada)") - # - # time_zone_select( "user", 'time_zone', [ ActiveSupport::TimeZone['Alaska'], ActiveSupport::TimeZone['Hawaii'] ]) - # - # time_zone_select( "user", 'time_zone', /Australia/) - # - # time_zone_select( "user", "time_zone", ActiveSupport::TimeZone.all.sort, model: ActiveSupport::TimeZone) - def time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {}) - Tags::TimeZoneSelect.new(object, method, self, priority_zones, options, html_options).render - end - - # Accepts a container (hash, array, enumerable, your type) and returns a string of option tags. Given a container - # where the elements respond to first and last (such as a two-element array), the "lasts" serve as option values and - # the "firsts" as option text. Hashes are turned into this form automatically, so the keys become "firsts" and values - # become lasts. If +selected+ is specified, the matching "last" or element will get the selected option-tag. +selected+ - # may also be an array of values to be selected when using a multiple select. - # - # options_for_select([["Dollar", "$"], ["Kroner", "DKK"]]) - # # => <option value="$">Dollar</option> - # # => <option value="DKK">Kroner</option> - # - # options_for_select([ "VISA", "MasterCard" ], "MasterCard") - # # => <option>VISA</option> - # # => <option selected="selected">MasterCard</option> - # - # options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40") - # # => <option value="$20">Basic</option> - # # => <option value="$40" selected="selected">Plus</option> - # - # options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"]) - # # => <option selected="selected">VISA</option> - # # => <option>MasterCard</option> - # # => <option selected="selected">Discover</option> - # - # You can optionally provide html attributes as the last element of the array. - # - # options_for_select([ "Denmark", ["USA", {class: 'bold'}], "Sweden" ], ["USA", "Sweden"]) - # # => <option value="Denmark">Denmark</option> - # # => <option value="USA" class="bold" selected="selected">USA</option> - # # => <option value="Sweden" selected="selected">Sweden</option> - # - # options_for_select([["Dollar", "$", {class: "bold"}], ["Kroner", "DKK", {onclick: "alert('HI');"}]]) - # # => <option value="$" class="bold">Dollar</option> - # # => <option value="DKK" onclick="alert('HI');">Kroner</option> - # - # If you wish to specify disabled option tags, set +selected+ to be a hash, with <tt>:disabled</tt> being either a value - # or array of values to be disabled. In this case, you can use <tt>:selected</tt> to specify selected option tags. - # - # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], disabled: "Super Platinum") - # # => <option value="Free">Free</option> - # # => <option value="Basic">Basic</option> - # # => <option value="Advanced">Advanced</option> - # # => <option value="Super Platinum" disabled="disabled">Super Platinum</option> - # - # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], disabled: ["Advanced", "Super Platinum"]) - # # => <option value="Free">Free</option> - # # => <option value="Basic">Basic</option> - # # => <option value="Advanced" disabled="disabled">Advanced</option> - # # => <option value="Super Platinum" disabled="disabled">Super Platinum</option> - # - # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], selected: "Free", disabled: "Super Platinum") - # # => <option value="Free" selected="selected">Free</option> - # # => <option value="Basic">Basic</option> - # # => <option value="Advanced">Advanced</option> - # # => <option value="Super Platinum" disabled="disabled">Super Platinum</option> - # - # NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag. - def options_for_select(container, selected = nil) - return container if String === container - - selected, disabled = extract_selected_and_disabled(selected).map do |r| - Array(r).map { |item| item.to_s } - end - - container.map do |element| - html_attributes = option_html_attributes(element) - text, value = option_text_and_value(element).map { |item| item.to_s } - - html_attributes[:selected] = 'selected' if option_value_selected?(value, selected) - html_attributes[:disabled] = 'disabled' if disabled && option_value_selected?(value, disabled) - html_attributes[:value] = value - - content_tag_string(:option, text, html_attributes) - end.join("\n").html_safe - end - - # Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning - # the result of a call to the +value_method+ as the option value and the +text_method+ as the option text. - # - # options_from_collection_for_select(@people, 'id', 'name') - # # => <option value="#{person.id}">#{person.name}</option> - # - # This is more often than not used inside a #select_tag like this example: - # - # select_tag 'person', options_from_collection_for_select(@people, 'id', 'name') - # - # If +selected+ is specified as a value or array of values, the element(s) returning a match on +value_method+ - # will be selected option tag(s). - # - # If +selected+ is specified as a Proc, those members of the collection that return true for the anonymous - # function are the selected values. - # - # +selected+ can also be a hash, specifying both <tt>:selected</tt> and/or <tt>:disabled</tt> values as required. - # - # Be sure to specify the same class as the +value_method+ when specifying selected or disabled options. - # Failure to do this will produce undesired results. Example: - # options_from_collection_for_select(@people, 'id', 'name', '1') - # Will not select a person with the id of 1 because 1 (an Integer) is not the same as '1' (a string) - # options_from_collection_for_select(@people, 'id', 'name', 1) - # should produce the desired results. - def options_from_collection_for_select(collection, value_method, text_method, selected = nil) - options = collection.map do |element| - [value_for_collection(element, text_method), value_for_collection(element, value_method), option_html_attributes(element)] - end - selected, disabled = extract_selected_and_disabled(selected) - select_deselect = { - :selected => extract_values_from_collection(collection, value_method, selected), - :disabled => extract_values_from_collection(collection, value_method, disabled) - } - - options_for_select(options, select_deselect) - end - - # Returns a string of <tt><option></tt> tags, like <tt>options_from_collection_for_select</tt>, but - # groups them by <tt><optgroup></tt> tags based on the object relationships of the arguments. - # - # Parameters: - # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags. - # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an - # array of child objects representing the <tt><option></tt> tags. - # * group_label_method+ - The name of a method which, when called on a member of +collection+, returns a - # string to be used as the +label+ attribute for its <tt><optgroup></tt> tag. - # * +option_key_method+ - The name of a method which, when called on a child object of a member of - # +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag. - # * +option_value_method+ - The name of a method which, when called on a child object of a member of - # +collection+, returns a value to be used as the contents of its <tt><option></tt> tag. - # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags, - # which will have the +selected+ attribute set. Corresponds to the return value of one of the calls - # to +option_key_method+. If +nil+, no selection is made. Can also be a hash if disabled values are - # to be specified. - # - # Example object structure for use with this method: - # - # class Continent < ActiveRecord::Base - # has_many :countries - # # attribs: id, name - # end - # - # class Country < ActiveRecord::Base - # belongs_to :continent - # # attribs: id, name, continent_id - # end - # - # Sample usage: - # option_groups_from_collection_for_select(@continents, :countries, :name, :id, :name, 3) - # - # Possible output: - # <optgroup label="Africa"> - # <option value="1">Egypt</option> - # <option value="4">Rwanda</option> - # ... - # </optgroup> - # <optgroup label="Asia"> - # <option value="3" selected="selected">China</option> - # <option value="12">India</option> - # <option value="5">Japan</option> - # ... - # </optgroup> - # - # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to - # wrap the output in an appropriate <tt><select></tt> tag. - def option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil) - collection.map do |group| - option_tags = options_from_collection_for_select( - group.send(group_method), option_key_method, option_value_method, selected_key) - - content_tag(:optgroup, option_tags, :label => group.send(group_label_method)) - end.join.html_safe - end - - # Returns a string of <tt><option></tt> tags, like <tt>options_for_select</tt>, but - # wraps them with <tt><optgroup></tt> tags. - # - # Parameters: - # * +grouped_options+ - Accepts a nested array or hash of strings. The first value serves as the - # <tt><optgroup></tt> label while the second value must be an array of options. The second value can be a - # nested array of text-value pairs. See <tt>options_for_select</tt> for more info. - # Ex. ["North America",[["United States","US"],["Canada","CA"]]] - # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags, - # which will have the +selected+ attribute set. Note: It is possible for this value to match multiple options - # as you might have the same option in multiple groups. Each will then get <tt>selected="selected"</tt>. - # - # Options: - # * <tt>:prompt</tt> - set to true or a prompt string. When the select element doesn't have a value yet, this - # prepends an option with a generic prompt - "Please select" - or the given prompt string. - # * <tt>:divider</tt> - the divider for the options groups. - # - # grouped_options = [ - # ['North America', - # [['United States','US'],'Canada']], - # ['Europe', - # ['Denmark','Germany','France']] - # ] - # grouped_options_for_select(grouped_options) - # - # grouped_options = { - # 'North America' => [['United States','US'], 'Canada'], - # 'Europe' => ['Denmark','Germany','France'] - # } - # grouped_options_for_select(grouped_options) - # - # Possible output: - # <optgroup label="North America"> - # <option value="US">United States</option> - # <option value="Canada">Canada</option> - # </optgroup> - # <optgroup label="Europe"> - # <option value="Denmark">Denmark</option> - # <option value="Germany">Germany</option> - # <option value="France">France</option> - # </optgroup> - # - # grouped_options = [ - # [['United States','US'], 'Canada'], - # ['Denmark','Germany','France'] - # ] - # grouped_options_for_select(grouped_options, nil, divider: '---------') - # - # Possible output: - # <optgroup label="---------"> - # <option value="US">United States</option> - # <option value="Canada">Canada</option> - # </optgroup> - # <optgroup label="---------"> - # <option value="Denmark">Denmark</option> - # <option value="Germany">Germany</option> - # <option value="France">France</option> - # </optgroup> - # - # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to - # wrap the output in an appropriate <tt><select></tt> tag. - def grouped_options_for_select(grouped_options, selected_key = nil, options = {}) - if options.is_a?(Hash) - prompt = options[:prompt] - divider = options[:divider] - else - prompt = options - message = "Passing the prompt to grouped_options_for_select as an argument is deprecated. " \ - "Please use an options hash like `{ prompt: #{prompt.inspect} }`." - ActiveSupport::Deprecation.warn message - end - - body = "".html_safe - - if prompt - body.safe_concat content_tag(:option, prompt_text(prompt), :value => "") - end - - grouped_options.each do |container| - if divider - label = divider - else - label, container = container - end - body.safe_concat content_tag(:optgroup, options_for_select(container, selected_key), :label => label) - end - - body - end - - # Returns a string of option tags for pretty much any time zone in the - # world. Supply a ActiveSupport::TimeZone name as +selected+ to have it - # marked as the selected option tag. You can also supply an array of - # ActiveSupport::TimeZone objects as +priority_zones+, so that they will - # be listed above the rest of the (long) list. (You can use - # ActiveSupport::TimeZone.us_zones as a convenience for obtaining a list - # of the US time zones, or a Regexp to select the zones of your choice) - # - # The +selected+ parameter must be either +nil+, or a string that names - # a ActiveSupport::TimeZone. - # - # By default, +model+ is the ActiveSupport::TimeZone constant (which can - # be obtained in Active Record as a value object). The only requirement - # is that the +model+ parameter be an object that responds to +all+, and - # returns an array of objects that represent time zones. - # - # NOTE: Only the option tags are returned, you have to wrap this call in - # a regular HTML select tag. - def time_zone_options_for_select(selected = nil, priority_zones = nil, model = ::ActiveSupport::TimeZone) - zone_options = "".html_safe - - zones = model.all - convert_zones = lambda { |list| list.map { |z| [ z.to_s, z.name ] } } - - if priority_zones - if priority_zones.is_a?(Regexp) - priority_zones = zones.select { |z| z =~ priority_zones } - end - - zone_options.safe_concat options_for_select(convert_zones[priority_zones], selected) - zone_options.safe_concat content_tag(:option, '-------------', :value => '', :disabled => 'disabled') - zone_options.safe_concat "\n" - - zones = zones - priority_zones - end - - zone_options.safe_concat options_for_select(convert_zones[zones], selected) - end - - # Returns radio button tags for the collection of existing return values - # of +method+ for +object+'s class. The value returned from calling - # +method+ on the instance +object+ will be selected. If calling +method+ - # returns +nil+, no selection is made. - # - # The <tt>:value_method</tt> and <tt>:text_method</tt> parameters are - # methods to be called on each member of +collection+. The return values - # are used as the +value+ attribute and contents of each radio button tag, - # respectively. They can also be any object that responds to +call+, such - # as a +proc+, that will be called for each member of the +collection+ to - # retrieve the value/text. - # - # Example object structure for use with this method: - # class Post < ActiveRecord::Base - # belongs_to :author - # end - # class Author < ActiveRecord::Base - # has_many :posts - # def name_with_initial - # "#{first_name.first}. #{last_name}" - # end - # end - # - # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>): - # collection_radio_buttons(:post, :author_id, Author.all, :id, :name_with_initial) - # - # If <tt>@post.author_id</tt> is already <tt>1</tt>, this would return: - # <input id="post_author_id_1" name="post[author_id]" type="radio" value="1" checked="checked" /> - # <label for="post_author_id_1">D. Heinemeier Hansson</label> - # <input id="post_author_id_2" name="post[author_id]" type="radio" value="2" /> - # <label for="post_author_id_2">D. Thomas</label> - # <input id="post_author_id_3" name="post[author_id]" type="radio" value="3" /> - # <label for="post_author_id_3">M. Clark</label> - # - # It is also possible to customize the way the elements will be shown by - # giving a block to the method: - # collection_radio_buttons(:post, :author_id, Author.all, :id, :name_with_initial) do |b| - # b.label { b.radio_button } - # end - # - # The argument passed to the block is a special kind of builder for this - # collection, which has the ability to generate the label and radio button - # for the current item in the collection, with proper text and value. - # Using it, you can change the label and radio button display order or - # even use the label as wrapper, as in the example above. - # - # The builder methods <tt>label</tt> and <tt>radio_button</tt> also accept - # extra html options: - # collection_radio_buttons(:post, :author_id, Author.all, :id, :name_with_initial) do |b| - # b.label(class: "radio_button") { b.radio_button(class: "radio_button") } - # end - # - # There are also three special methods available: <tt>object</tt>, <tt>text</tt> and - # <tt>value</tt>, which are the current item being rendered, its text and value methods, - # respectively. You can use them like this: - # collection_radio_buttons(:post, :author_id, Author.all, :id, :name_with_initial) do |b| - # b.label(:"data-value" => b.value) { b.radio_button + b.text } - # end - def collection_radio_buttons(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block) - Tags::CollectionRadioButtons.new(object, method, self, collection, value_method, text_method, options, html_options).render(&block) - end - - # Returns check box tags for the collection of existing return values of - # +method+ for +object+'s class. The value returned from calling +method+ - # on the instance +object+ will be selected. If calling +method+ returns - # +nil+, no selection is made. - # - # The <tt>:value_method</tt> and <tt>:text_method</tt> parameters are - # methods to be called on each member of +collection+. The return values - # are used as the +value+ attribute and contents of each check box tag, - # respectively. They can also be any object that responds to +call+, such - # as a +proc+, that will be called for each member of the +collection+ to - # retrieve the value/text. - # - # Example object structure for use with this method: - # class Post < ActiveRecord::Base - # has_and_belongs_to_many :author - # end - # class Author < ActiveRecord::Base - # has_and_belongs_to_many :posts - # def name_with_initial - # "#{first_name.first}. #{last_name}" - # end - # end - # - # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>): - # collection_check_boxes(:post, :author_ids, Author.all, :id, :name_with_initial) - # - # If <tt>@post.author_ids</tt> is already <tt>[1]</tt>, this would return: - # <input id="post_author_ids_1" name="post[author_ids][]" type="checkbox" value="1" checked="checked" /> - # <label for="post_author_ids_1">D. Heinemeier Hansson</label> - # <input id="post_author_ids_2" name="post[author_ids][]" type="checkbox" value="2" /> - # <label for="post_author_ids_2">D. Thomas</label> - # <input id="post_author_ids_3" name="post[author_ids][]" type="checkbox" value="3" /> - # <label for="post_author_ids_3">M. Clark</label> - # <input name="post[author_ids][]" type="hidden" value="" /> - # - # It is also possible to customize the way the elements will be shown by - # giving a block to the method: - # collection_check_boxes(:post, :author_ids, Author.all, :id, :name_with_initial) do |b| - # b.label { b.check_box } - # end - # - # The argument passed to the block is a special kind of builder for this - # collection, which has the ability to generate the label and check box - # for the current item in the collection, with proper text and value. - # Using it, you can change the label and check box display order or even - # use the label as wrapper, as in the example above. - # - # The builder methods <tt>label</tt> and <tt>check_box</tt> also accept - # extra html options: - # collection_check_boxes(:post, :author_ids, Author.all, :id, :name_with_initial) do |b| - # b.label(class: "check_box") { b.check_box(class: "check_box") } - # end - # - # There are also three special methods available: <tt>object</tt>, <tt>text</tt> and - # <tt>value</tt>, which are the current item being rendered, its text and value methods, - # respectively. You can use them like this: - # collection_check_boxes(:post, :author_ids, Author.all, :id, :name_with_initial) do |b| - # b.label(:"data-value" => b.value) { b.check_box + b.text } - # end - def collection_check_boxes(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block) - Tags::CollectionCheckBoxes.new(object, method, self, collection, value_method, text_method, options, html_options).render(&block) - end - - private - def option_html_attributes(element) - if Array === element - element.select { |e| Hash === e }.reduce({}, :merge!) - else - {} - end - end - - def option_text_and_value(option) - # Options are [text, value] pairs or strings used for both. - if !option.is_a?(String) && option.respond_to?(:first) && option.respond_to?(:last) - option = option.reject { |e| Hash === e } if Array === option - [option.first, option.last] - else - [option, option] - end - end - - def option_value_selected?(value, selected) - Array(selected).include? value - end - - def extract_selected_and_disabled(selected) - if selected.is_a?(Proc) - [selected, nil] - else - selected = Array.wrap(selected) - options = selected.extract_options!.symbolize_keys - selected_items = options.fetch(:selected, selected) - [selected_items, options[:disabled]] - end - end - - def extract_values_from_collection(collection, value_method, selected) - if selected.is_a?(Proc) - collection.map do |element| - element.send(value_method) if selected.call(element) - end.compact - else - selected - end - end - - def value_for_collection(item, value) - value.respond_to?(:call) ? value.call(item) : item.send(value) - end - - def prompt_text(prompt) - prompt.kind_of?(String) ? prompt : I18n.translate('helpers.select.prompt', :default => 'Please select') - end - end - - class FormBuilder - # Wraps ActionView::Helpers::FormOptionsHelper#select for form builders: - # - # <%= form_for @post do |f| %> - # <%= f.select :person_id, Person.all.collect {|p| [ p.name, p.id ] }, { include_blank: true }) %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def select(method, choices, options = {}, html_options = {}) - @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options)) - end - - # Wraps ActionView::Helpers::FormOptionsHelper#collection_select for form builders: - # - # <%= form_for @post do |f| %> - # <%= f.collection_select :person_id, Author.all, :id, :name_with_initial, prompt: true %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def collection_select(method, collection, value_method, text_method, options = {}, html_options = {}) - @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options)) - end - - # Wraps ActionView::Helpers::FormOptionsHelper#grouped_collection_select for form builders: - # - # <%= form_for @city do |f| %> - # <%= f.grouped_collection_select :country_id, :country_id, @continents, :countries, :name, :id, :name %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {}) - @template.grouped_collection_select(@object_name, method, collection, group_method, group_label_method, option_key_method, option_value_method, objectify_options(options), @default_options.merge(html_options)) - end - - # Wraps ActionView::Helpers::FormOptionsHelper#time_zone_select for form builders: - # - # <%= form_for @user do |f| %> - # <%= f.time_zone_select :time_zone, nil, include_blank: true %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def time_zone_select(method, priority_zones = nil, options = {}, html_options = {}) - @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_options.merge(html_options)) - end - - # Wraps ActionView::Helpers::FormOptionsHelper#collection_check_boxes for form builders: - # - # <%= form_for @post do |f| %> - # <%= f.collection_check_boxes :author_ids, Author.all, :id, :name_with_initial %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block) - @template.collection_check_boxes(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options), &block) - end - - # Wraps ActionView::Helpers::FormOptionsHelper#collection_radio_buttons for form builders: - # - # <%= form_for @post do |f| %> - # <%= f.collection_radio_buttons :author_id, Author.all, :id, :name_with_initial %> - # <%= f.submit %> - # <% end %> - # - # Please refer to the documentation of the base helper for details. - def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block) - @template.collection_radio_buttons(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options), &block) - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/form_tag_helper.rb b/actionpack/lib/action_view/helpers/form_tag_helper.rb deleted file mode 100644 index 3fa7696b83..0000000000 --- a/actionpack/lib/action_view/helpers/form_tag_helper.rb +++ /dev/null @@ -1,744 +0,0 @@ -require 'cgi' -require 'action_view/helpers/tag_helper' -require 'active_support/core_ext/string/output_safety' -require 'active_support/core_ext/module/attribute_accessors' - -module ActionView - # = Action View Form Tag Helpers - module Helpers - # Provides a number of methods for creating form tags that don't rely on an Active Record object assigned to the template like - # FormHelper does. Instead, you provide the names and values manually. - # - # NOTE: The HTML options <tt>disabled</tt>, <tt>readonly</tt>, and <tt>multiple</tt> can all be treated as booleans. So specifying - # <tt>disabled: true</tt> will give <tt>disabled="disabled"</tt>. - module FormTagHelper - extend ActiveSupport::Concern - - include UrlHelper - include TextHelper - - mattr_accessor :embed_authenticity_token_in_remote_forms - self.embed_authenticity_token_in_remote_forms = false - - # Starts a form tag that points the action to an url configured with <tt>url_for_options</tt> just like - # ActionController::Base#url_for. The method for the form defaults to POST. - # - # ==== Options - # * <tt>:multipart</tt> - If set to true, the enctype is set to "multipart/form-data". - # * <tt>:method</tt> - The method to use when submitting the form, usually either "get" or "post". - # If "patch", "put", "delete", or another verb is used, a hidden input with name <tt>_method</tt> - # is added to simulate the verb over post. - # * <tt>:authenticity_token</tt> - Authenticity token to use in the form. Use only if you need to - # pass custom authenticity token string, or to not add authenticity_token field at all - # (by passing <tt>false</tt>). Remote forms may omit the embedded authenticity token - # by setting <tt>config.action_view.embed_authenticity_token_in_remote_forms = false</tt>. - # This is helpful when you're fragment-caching the form. Remote forms get the - # authenticity token from the <tt>meta</tt> tag, so embedding is unnecessary unless you - # support browsers without JavaScript. - # * A list of parameters to feed to the URL the form will be posted to. - # * <tt>:remote</tt> - If set to true, will allow the Unobtrusive JavaScript drivers to control the - # submit behavior. By default this behavior is an ajax submit. - # - # ==== Examples - # form_tag('/posts') - # # => <form action="/posts" method="post"> - # - # form_tag('/posts/1', method: :put) - # # => <form action="/posts/1" method="post"> ... <input name="_method" type="hidden" value="put" /> ... - # - # form_tag('/upload', multipart: true) - # # => <form action="/upload" method="post" enctype="multipart/form-data"> - # - # <%= form_tag('/posts') do -%> - # <div><%= submit_tag 'Save' %></div> - # <% end -%> - # # => <form action="/posts" method="post"><div><input type="submit" name="commit" value="Save" /></div></form> - # - # <%= form_tag('/posts', remote: true) %> - # # => <form action="/posts" method="post" data-remote="true"> - # - # form_tag('http://far.away.com/form', authenticity_token: false) - # # form without authenticity token - # - # form_tag('http://far.away.com/form', authenticity_token: "cf50faa3fe97702ca1ae") - # # form with custom authenticity token - # - def form_tag(url_for_options = {}, options = {}, &block) - html_options = html_options_for_form(url_for_options, options) - if block_given? - form_tag_in_block(html_options, &block) - else - form_tag_html(html_options) - end - end - - # Creates a dropdown selection box, or if the <tt>:multiple</tt> option is set to true, a multiple - # choice selection box. - # - # Helpers::FormOptions can be used to create common select boxes such as countries, time zones, or - # associated records. <tt>option_tags</tt> is a string containing the option tags for the select box. - # - # ==== Options - # * <tt>:multiple</tt> - If set to true the selection will allow multiple choices. - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:include_blank</tt> - If set to true, an empty option will be created. - # * <tt>:prompt</tt> - Create a prompt option with blank value and the text asking user to select something - # * Any other key creates standard HTML attributes for the tag. - # - # ==== Examples - # select_tag "people", options_from_collection_for_select(@people, "id", "name") - # # <select id="people" name="people"><option value="1">David</option></select> - # - # select_tag "people", "<option>David</option>".html_safe - # # => <select id="people" name="people"><option>David</option></select> - # - # select_tag "count", "<option>1</option><option>2</option><option>3</option><option>4</option>".html_safe - # # => <select id="count" name="count"><option>1</option><option>2</option> - # # <option>3</option><option>4</option></select> - # - # select_tag "colors", "<option>Red</option><option>Green</option><option>Blue</option>".html_safe, multiple: true - # # => <select id="colors" multiple="multiple" name="colors[]"><option>Red</option> - # # <option>Green</option><option>Blue</option></select> - # - # select_tag "locations", "<option>Home</option><option selected='selected'>Work</option><option>Out</option>".html_safe - # # => <select id="locations" name="locations"><option>Home</option><option selected='selected'>Work</option> - # # <option>Out</option></select> - # - # select_tag "access", "<option>Read</option><option>Write</option>".html_safe, multiple: true, class: 'form_input' - # # => <select class="form_input" id="access" multiple="multiple" name="access[]"><option>Read</option> - # # <option>Write</option></select> - # - # select_tag "people", options_from_collection_for_select(@people, "id", "name"), include_blank: true - # # => <select id="people" name="people"><option value=""></option><option value="1">David</option></select> - # - # select_tag "people", options_from_collection_for_select(@people, "id", "name"), prompt: "Select something" - # # => <select id="people" name="people"><option value="">Select something</option><option value="1">David</option></select> - # - # select_tag "destination", "<option>NYC</option><option>Paris</option><option>Rome</option>".html_safe, disabled: true - # # => <select disabled="disabled" id="destination" name="destination"><option>NYC</option> - # # <option>Paris</option><option>Rome</option></select> - # - # select_tag "credit_card", options_for_select([ "VISA", "MasterCard" ], "MasterCard") - # # => <select id="credit_card" name="credit_card"><option>VISA</option> - # # <option selected="selected">MasterCard</option></select> - def select_tag(name, option_tags = nil, options = {}) - option_tags ||= "" - html_name = (options[:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name - - if options.delete(:include_blank) - option_tags = content_tag(:option, '', :value => '').safe_concat(option_tags) - end - - if prompt = options.delete(:prompt) - option_tags = content_tag(:option, prompt, :value => '').safe_concat(option_tags) - end - - content_tag :select, option_tags, { "name" => html_name, "id" => sanitize_to_id(name) }.update(options.stringify_keys) - end - - # Creates a standard text field; use these text fields to input smaller chunks of text like a username - # or a search query. - # - # ==== Options - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:size</tt> - The number of visible characters that will fit in the input. - # * <tt>:maxlength</tt> - The maximum number of characters that the browser will allow the user to enter. - # * <tt>:placeholder</tt> - The text contained in the field by default which is removed when the field receives focus. - # * Any other key creates standard HTML attributes for the tag. - # - # ==== Examples - # text_field_tag 'name' - # # => <input id="name" name="name" type="text" /> - # - # text_field_tag 'query', 'Enter your search query here' - # # => <input id="query" name="query" type="text" value="Enter your search query here" /> - # - # text_field_tag 'search', nil, placeholder: 'Enter search term...' - # # => <input id="search" name="search" placeholder="Enter search term..." type="text" /> - # - # text_field_tag 'request', nil, class: 'special_input' - # # => <input class="special_input" id="request" name="request" type="text" /> - # - # text_field_tag 'address', '', size: 75 - # # => <input id="address" name="address" size="75" type="text" value="" /> - # - # text_field_tag 'zip', nil, maxlength: 5 - # # => <input id="zip" maxlength="5" name="zip" type="text" /> - # - # text_field_tag 'payment_amount', '$0.00', disabled: true - # # => <input disabled="disabled" id="payment_amount" name="payment_amount" type="text" value="$0.00" /> - # - # text_field_tag 'ip', '0.0.0.0', maxlength: 15, size: 20, class: "ip-input" - # # => <input class="ip-input" id="ip" maxlength="15" name="ip" size="20" type="text" value="0.0.0.0" /> - def text_field_tag(name, value = nil, options = {}) - tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) - end - - # Creates a label element. Accepts a block. - # - # ==== Options - # * Creates standard HTML attributes for the tag. - # - # ==== Examples - # label_tag 'name' - # # => <label for="name">Name</label> - # - # label_tag 'name', 'Your name' - # # => <label for="name">Your name</label> - # - # label_tag 'name', nil, class: 'small_label' - # # => <label for="name" class="small_label">Name</label> - def label_tag(name = nil, content_or_options = nil, options = nil, &block) - if block_given? && content_or_options.is_a?(Hash) - options = content_or_options = content_or_options.stringify_keys - else - options ||= {} - options = options.stringify_keys - end - options["for"] = sanitize_to_id(name) unless name.blank? || options.has_key?("for") - content_tag :label, content_or_options || name.to_s.humanize, options, &block - end - - # Creates a hidden form input field used to transmit data that would be lost due to HTTP's statelessness or - # data that should be hidden from the user. - # - # ==== Options - # * Creates standard HTML attributes for the tag. - # - # ==== Examples - # hidden_field_tag 'tags_list' - # # => <input id="tags_list" name="tags_list" type="hidden" /> - # - # hidden_field_tag 'token', 'VUBJKB23UIVI1UU1VOBVI@' - # # => <input id="token" name="token" type="hidden" value="VUBJKB23UIVI1UU1VOBVI@" /> - # - # hidden_field_tag 'collected_input', '', onchange: "alert('Input collected!')" - # # => <input id="collected_input" name="collected_input" onchange="alert('Input collected!')" - # # type="hidden" value="" /> - def hidden_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "hidden")) - end - - # Creates a file upload field. If you are using file uploads then you will also need - # to set the multipart option for the form tag: - # - # <%= form_tag '/upload', multipart: true do %> - # <label for="file">File to Upload</label> <%= file_field_tag "file" %> - # <%= submit_tag %> - # <% end %> - # - # The specified URL will then be passed a File object containing the selected file, or if the field - # was left blank, a StringIO object. - # - # ==== Options - # * Creates standard HTML attributes for the tag. - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files. - # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations. - # - # ==== Examples - # file_field_tag 'attachment' - # # => <input id="attachment" name="attachment" type="file" /> - # - # file_field_tag 'avatar', class: 'profile_input' - # # => <input class="profile_input" id="avatar" name="avatar" type="file" /> - # - # file_field_tag 'picture', disabled: true - # # => <input disabled="disabled" id="picture" name="picture" type="file" /> - # - # file_field_tag 'resume', value: '~/resume.doc' - # # => <input id="resume" name="resume" type="file" value="~/resume.doc" /> - # - # file_field_tag 'user_pic', accept: 'image/png,image/gif,image/jpeg' - # # => <input accept="image/png,image/gif,image/jpeg" id="user_pic" name="user_pic" type="file" /> - # - # file_field_tag 'file', accept: 'text/html', class: 'upload', value: 'index.html' - # # => <input accept="text/html" class="upload" id="file" name="file" type="file" value="index.html" /> - def file_field_tag(name, options = {}) - text_field_tag(name, nil, options.update("type" => "file")) - end - - # Creates a password field, a masked text field that will hide the users input behind a mask character. - # - # ==== Options - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:size</tt> - The number of visible characters that will fit in the input. - # * <tt>:maxlength</tt> - The maximum number of characters that the browser will allow the user to enter. - # * Any other key creates standard HTML attributes for the tag. - # - # ==== Examples - # password_field_tag 'pass' - # # => <input id="pass" name="pass" type="password" /> - # - # password_field_tag 'secret', 'Your secret here' - # # => <input id="secret" name="secret" type="password" value="Your secret here" /> - # - # password_field_tag 'masked', nil, class: 'masked_input_field' - # # => <input class="masked_input_field" id="masked" name="masked" type="password" /> - # - # password_field_tag 'token', '', size: 15 - # # => <input id="token" name="token" size="15" type="password" value="" /> - # - # password_field_tag 'key', nil, maxlength: 16 - # # => <input id="key" maxlength="16" name="key" type="password" /> - # - # password_field_tag 'confirm_pass', nil, disabled: true - # # => <input disabled="disabled" id="confirm_pass" name="confirm_pass" type="password" /> - # - # password_field_tag 'pin', '1234', maxlength: 4, size: 6, class: "pin_input" - # # => <input class="pin_input" id="pin" maxlength="4" name="pin" size="6" type="password" value="1234" /> - def password_field_tag(name = "password", value = nil, options = {}) - text_field_tag(name, value, options.update("type" => "password")) - end - - # Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions. - # - # ==== Options - # * <tt>:size</tt> - A string specifying the dimensions (columns by rows) of the textarea (e.g., "25x10"). - # * <tt>:rows</tt> - Specify the number of rows in the textarea - # * <tt>:cols</tt> - Specify the number of columns in the textarea - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * <tt>:escape</tt> - By default, the contents of the text input are HTML escaped. - # If you need unescaped contents, set this to false. - # * Any other key creates standard HTML attributes for the tag. - # - # ==== Examples - # text_area_tag 'post' - # # => <textarea id="post" name="post"></textarea> - # - # text_area_tag 'bio', @user.bio - # # => <textarea id="bio" name="bio">This is my biography.</textarea> - # - # text_area_tag 'body', nil, rows: 10, cols: 25 - # # => <textarea cols="25" id="body" name="body" rows="10"></textarea> - # - # text_area_tag 'body', nil, size: "25x10" - # # => <textarea name="body" id="body" cols="25" rows="10"></textarea> - # - # text_area_tag 'description', "Description goes here.", disabled: true - # # => <textarea disabled="disabled" id="description" name="description">Description goes here.</textarea> - # - # text_area_tag 'comment', nil, class: 'comment_input' - # # => <textarea class="comment_input" id="comment" name="comment"></textarea> - def text_area_tag(name, content = nil, options = {}) - options = options.stringify_keys - - if size = options.delete("size") - options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split) - end - - escape = options.delete("escape") { true } - content = ERB::Util.html_escape(content) if escape - - content_tag :textarea, content.to_s.html_safe, { "name" => name, "id" => sanitize_to_id(name) }.update(options) - end - - # Creates a check box form input tag. - # - # ==== Options - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * Any other key creates standard HTML options for the tag. - # - # ==== Examples - # check_box_tag 'accept' - # # => <input id="accept" name="accept" type="checkbox" value="1" /> - # - # check_box_tag 'rock', 'rock music' - # # => <input id="rock" name="rock" type="checkbox" value="rock music" /> - # - # check_box_tag 'receive_email', 'yes', true - # # => <input checked="checked" id="receive_email" name="receive_email" type="checkbox" value="yes" /> - # - # check_box_tag 'tos', 'yes', false, class: 'accept_tos' - # # => <input class="accept_tos" id="tos" name="tos" type="checkbox" value="yes" /> - # - # check_box_tag 'eula', 'accepted', false, disabled: true - # # => <input disabled="disabled" id="eula" name="eula" type="checkbox" value="accepted" /> - def check_box_tag(name, value = "1", checked = false, options = {}) - html_options = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) - html_options["checked"] = "checked" if checked - tag :input, html_options - end - - # Creates a radio button; use groups of radio buttons named the same to allow users to - # select from a group of options. - # - # ==== Options - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * Any other key creates standard HTML options for the tag. - # - # ==== Examples - # radio_button_tag 'gender', 'male' - # # => <input id="gender_male" name="gender" type="radio" value="male" /> - # - # radio_button_tag 'receive_updates', 'no', true - # # => <input checked="checked" id="receive_updates_no" name="receive_updates" type="radio" value="no" /> - # - # radio_button_tag 'time_slot', "3:00 p.m.", false, disabled: true - # # => <input disabled="disabled" id="time_slot_300_pm" name="time_slot" type="radio" value="3:00 p.m." /> - # - # radio_button_tag 'color', "green", true, class: "color_input" - # # => <input checked="checked" class="color_input" id="color_green" name="color" type="radio" value="green" /> - def radio_button_tag(name, value, checked = false, options = {}) - html_options = { "type" => "radio", "name" => name, "id" => "#{sanitize_to_id(name)}_#{sanitize_to_id(value)}", "value" => value }.update(options.stringify_keys) - html_options["checked"] = "checked" if checked - tag :input, html_options - end - - # Creates a submit button with the text <tt>value</tt> as the caption. - # - # ==== Options - # * <tt>:data</tt> - This option can be used to add custom data attributes. - # * <tt>:disabled</tt> - If true, the user will not be able to use this input. - # * Any other key creates standard HTML options for the tag. - # - # ==== Data attributes - # - # * <tt>confirm: 'question?'</tt> - If present the unobtrusive JavaScript - # drivers will provide a prompt with the question specified. If the user accepts, - # the form is processed normally, otherwise no action is taken. - # * <tt>:disable_with</tt> - Value of this parameter will be used as the value for a - # disabled version of the submit button when the form is submitted. This feature is - # provided by the unobtrusive JavaScript driver. - # - # ==== Examples - # submit_tag - # # => <input name="commit" type="submit" value="Save changes" /> - # - # submit_tag "Edit this article" - # # => <input name="commit" type="submit" value="Edit this article" /> - # - # submit_tag "Save edits", disabled: true - # # => <input disabled="disabled" name="commit" type="submit" value="Save edits" /> - # - # submit_tag "Complete sale", data: { disable_with: "Please wait..." } - # # => <input name="commit" data-disable-with="Please wait..." type="submit" value="Complete sale" /> - # - # submit_tag nil, class: "form_submit" - # # => <input class="form_submit" name="commit" type="submit" /> - # - # submit_tag "Edit", class: "edit_button" - # # => <input class="edit_button" name="commit" type="submit" value="Edit" /> - # - # submit_tag "Save", data: { confirm: "Are you sure?" } - # # => <input name='commit' type='submit' value='Save' data-confirm="Are you sure?" /> - # - def submit_tag(value = "Save changes", options = {}) - options = options.stringify_keys - - tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(options) - end - - # Creates a button element that defines a <tt>submit</tt> button, - # <tt>reset</tt>button or a generic button which can be used in - # JavaScript, for example. You can use the button tag as a regular - # submit tag but it isn't supported in legacy browsers. However, - # the button tag allows richer labels such as images and emphasis, - # so this helper will also accept a block. - # - # ==== Options - # * <tt>:data</tt> - This option can be used to add custom data attributes. - # * <tt>:disabled</tt> - If true, the user will not be able to - # use this input. - # * Any other key creates standard HTML options for the tag. - # - # ==== Data attributes - # - # * <tt>confirm: 'question?'</tt> - If present, the - # unobtrusive JavaScript drivers will provide a prompt with - # the question specified. If the user accepts, the form is - # processed normally, otherwise no action is taken. - # * <tt>:disable_with</tt> - Value of this parameter will be - # used as the value for a disabled version of the submit - # button when the form is submitted. This feature is provided - # by the unobtrusive JavaScript driver. - # - # ==== Examples - # button_tag - # # => <button name="button" type="submit">Button</button> - # - # button_tag(type: 'button') do - # content_tag(:strong, 'Ask me!') - # end - # # => <button name="button" type="button"> - # # <strong>Ask me!</strong> - # # </button> - # - # button_tag "Checkout", data: { disable_with => "Please wait..." } - # # => <button data-disable-with="Please wait..." name="button" type="submit">Checkout</button> - # - def button_tag(content_or_options = nil, options = nil, &block) - options = content_or_options if block_given? && content_or_options.is_a?(Hash) - options ||= {} - options = options.stringify_keys - - options.reverse_merge! 'name' => 'button', 'type' => 'submit' - - content_tag :button, content_or_options || 'Button', options, &block - end - - # Displays an image which when clicked will submit the form. - # - # <tt>source</tt> is passed to AssetTagHelper#path_to_image - # - # ==== Options - # * <tt>:data</tt> - This option can be used to add custom data attributes. - # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input. - # * Any other key creates standard HTML options for the tag. - # - # ==== Data attributes - # - # * <tt>confirm: 'question?'</tt> - This will add a JavaScript confirm - # prompt with the question specified. If the user accepts, the form is - # processed normally, otherwise no action is taken. - # - # ==== Examples - # image_submit_tag("login.png") - # # => <input alt="Login" src="/images/login.png" type="image" /> - # - # image_submit_tag("purchase.png", disabled: true) - # # => <input alt="Purchase" disabled="disabled" src="/images/purchase.png" type="image" /> - # - # image_submit_tag("search.png", class: 'search_button', alt: 'Find') - # # => <input alt="Find" class="search_button" src="/images/search.png" type="image" /> - # - # image_submit_tag("agree.png", disabled: true, class: "agree_disagree_button") - # # => <input alt="Agree" class="agree_disagree_button" disabled="disabled" src="/images/agree.png" type="image" /> - # - # image_submit_tag("save.png", data: { confirm: "Are you sure?" }) - # # => <input alt="Save" src="/images/save.png" data-confirm="Are you sure?" type="image" /> - def image_submit_tag(source, options = {}) - options = options.stringify_keys - tag :input, { "alt" => image_alt(source), "type" => "image", "src" => path_to_image(source) }.update(options) - end - - # Creates a field set for grouping HTML form elements. - # - # <tt>legend</tt> will become the fieldset's title (optional as per W3C). - # <tt>options</tt> accept the same values as tag. - # - # ==== Examples - # <%= field_set_tag do %> - # <p><%= text_field_tag 'name' %></p> - # <% end %> - # # => <fieldset><p><input id="name" name="name" type="text" /></p></fieldset> - # - # <%= field_set_tag 'Your details' do %> - # <p><%= text_field_tag 'name' %></p> - # <% end %> - # # => <fieldset><legend>Your details</legend><p><input id="name" name="name" type="text" /></p></fieldset> - # - # <%= field_set_tag nil, class: 'format' do %> - # <p><%= text_field_tag 'name' %></p> - # <% end %> - # # => <fieldset class="format"><p><input id="name" name="name" type="text" /></p></fieldset> - def field_set_tag(legend = nil, options = nil, &block) - output = tag(:fieldset, options, true) - output.safe_concat(content_tag(:legend, legend)) unless legend.blank? - output.concat(capture(&block)) if block_given? - output.safe_concat("</fieldset>") - end - - # Creates a text field of type "color". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def color_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "color")) - end - - # Creates a text field of type "search". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def search_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "search")) - end - - # Creates a text field of type "tel". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def telephone_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "tel")) - end - alias phone_field_tag telephone_field_tag - - # Creates a text field of type "date". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def date_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "date")) - end - - # Creates a text field of type "time". - # - # === Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - def time_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "time")) - end - - # Creates a text field of type "datetime". - # - # === Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - def datetime_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "datetime")) - end - - # Creates a text field of type "datetime-local". - # - # === Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - def datetime_local_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "datetime-local")) - end - - # Creates a text field of type "month". - # - # === Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - def month_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "month")) - end - - # Creates a text field of type "week". - # - # === Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - def week_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "week")) - end - - # Creates a text field of type "url". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def url_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "url")) - end - - # Creates a text field of type "email". - # - # ==== Options - # * Accepts the same options as text_field_tag. - def email_field_tag(name, value = nil, options = {}) - text_field_tag(name, value, options.stringify_keys.update("type" => "email")) - end - - # Creates a number field. - # - # ==== Options - # * <tt>:min</tt> - The minimum acceptable value. - # * <tt>:max</tt> - The maximum acceptable value. - # * <tt>:in</tt> - A range specifying the <tt>:min</tt> and - # <tt>:max</tt> values. - # * <tt>:step</tt> - The acceptable value granularity. - # * Otherwise accepts the same options as text_field_tag. - # - # ==== Examples - # number_field_tag 'quantity', nil, in: 1...10 - # # => <input id="quantity" name="quantity" min="1" max="9" type="number" /> - def number_field_tag(name, value = nil, options = {}) - options = options.stringify_keys - options["type"] ||= "number" - if range = options.delete("in") || options.delete("within") - options.update("min" => range.min, "max" => range.max) - end - text_field_tag(name, value, options) - end - - # Creates a range form element. - # - # ==== Options - # * Accepts the same options as number_field_tag. - def range_field_tag(name, value = nil, options = {}) - number_field_tag(name, value, options.stringify_keys.update("type" => "range")) - end - - # Creates the hidden UTF8 enforcer tag. Override this method in a helper - # to customize the tag. - def utf8_enforcer_tag - tag(:input, :type => "hidden", :name => "utf8", :value => "✓".html_safe) - end - - private - def html_options_for_form(url_for_options, options) - options.stringify_keys.tap do |html_options| - html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart") - # The following URL is unescaped, this is just a hash of options, and it is the - # responsibility of the caller to escape all the values. - html_options["action"] = url_for(url_for_options) - html_options["accept-charset"] = "UTF-8" - - html_options["data-remote"] = true if html_options.delete("remote") - - if html_options["data-remote"] && - !embed_authenticity_token_in_remote_forms && - html_options["authenticity_token"].blank? - # The authenticity token is taken from the meta tag in this case - html_options["authenticity_token"] = false - elsif html_options["authenticity_token"] == true - # Include the default authenticity_token, which is only generated when its set to nil, - # but we needed the true value to override the default of no authenticity_token on data-remote. - html_options["authenticity_token"] = nil - end - end - end - - def extra_tags_for_form(html_options) - authenticity_token = html_options.delete("authenticity_token") - method = html_options.delete("method").to_s - - method_tag = case method - when /^get$/i # must be case-insensitive, but can't use downcase as might be nil - html_options["method"] = "get" - '' - when /^post$/i, "", nil - html_options["method"] = "post" - token_tag(authenticity_token) - else - html_options["method"] = "post" - method_tag(method) + token_tag(authenticity_token) - end - - tags = utf8_enforcer_tag << method_tag - content_tag(:div, tags, :style => 'margin:0;padding:0;display:inline') - end - - def form_tag_html(html_options) - extra_tags = extra_tags_for_form(html_options) - tag(:form, html_options, true) + extra_tags - end - - def form_tag_in_block(html_options, &block) - content = capture(&block) - output = form_tag_html(html_options) - output << content - output.safe_concat("</form>") - end - - # see http://www.w3.org/TR/html4/types.html#type-name - def sanitize_to_id(name) - name.to_s.delete(']').gsub(/[^-a-zA-Z0-9:.]/, "_") - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/javascript_helper.rb b/actionpack/lib/action_view/helpers/javascript_helper.rb deleted file mode 100644 index e475d5b018..0000000000 --- a/actionpack/lib/action_view/helpers/javascript_helper.rb +++ /dev/null @@ -1,75 +0,0 @@ -require 'action_view/helpers/tag_helper' - -module ActionView - module Helpers - module JavaScriptHelper - JS_ESCAPE_MAP = { - '\\' => '\\\\', - '</' => '<\/', - "\r\n" => '\n', - "\n" => '\n', - "\r" => '\n', - '"' => '\\"', - "'" => "\\'" - } - - JS_ESCAPE_MAP["\342\200\250".force_encoding(Encoding::UTF_8).encode!] = '
' - JS_ESCAPE_MAP["\342\200\251".force_encoding(Encoding::UTF_8).encode!] = '
' - - # Escapes carriage returns and single and double quotes for JavaScript segments. - # - # Also available through the alias j(). This is particularly helpful in JavaScript - # responses, like: - # - # $('some_element').replaceWith('<%=j render 'some/element_template' %>'); - def escape_javascript(javascript) - if javascript - result = javascript.gsub(/(\\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] } - javascript.html_safe? ? result.html_safe : result - else - '' - end - end - - alias_method :j, :escape_javascript - - # Returns a JavaScript tag with the +content+ inside. Example: - # javascript_tag "alert('All is good')" - # - # Returns: - # <script> - # //<![CDATA[ - # alert('All is good') - # //]]> - # </script> - # - # +html_options+ may be a hash of attributes for the <tt>\<script></tt> - # tag. - # - # javascript_tag "alert('All is good')", defer: 'defer' - # # => <script defer="defer">alert('All is good')</script> - # - # Instead of passing the content as an argument, you can also use a block - # in which case, you pass your +html_options+ as the first parameter. - # - # <%= javascript_tag defer: 'defer' do -%> - # alert('All is good') - # <% end -%> - def javascript_tag(content_or_options_with_block = nil, html_options = {}, &block) - content = - if block_given? - html_options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash) - capture(&block) - else - content_or_options_with_block - end - - content_tag(:script, javascript_cdata_section(content), html_options) - end - - def javascript_cdata_section(content) #:nodoc: - "\n//#{cdata_section("\n#{content}\n//")}\n".html_safe - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/number_helper.rb b/actionpack/lib/action_view/helpers/number_helper.rb deleted file mode 100644 index fda7038a5d..0000000000 --- a/actionpack/lib/action_view/helpers/number_helper.rb +++ /dev/null @@ -1,441 +0,0 @@ -# encoding: utf-8 - -require 'active_support/core_ext/hash/keys' -require 'active_support/core_ext/string/output_safety' -require 'active_support/number_helper' - -module ActionView - # = Action View Number Helpers - module Helpers #:nodoc: - - # Provides methods for converting numbers into formatted strings. - # Methods are provided for phone numbers, currency, percentage, - # precision, positional notation, file size and pretty printing. - # - # Most methods expect a +number+ argument, and will return it - # unchanged if can't be converted into a valid number. - module NumberHelper - - # Raised when argument +number+ param given to the helpers is invalid and - # the option :raise is set to +true+. - class InvalidNumberError < StandardError - attr_accessor :number - def initialize(number) - @number = number - end - end - - # Formats a +number+ into a US phone number (e.g., (555) - # 123-9876). You can customize the format in the +options+ hash. - # - # ==== Options - # - # * <tt>:area_code</tt> - Adds parentheses around the area code. - # * <tt>:delimiter</tt> - Specifies the delimiter to use - # (defaults to "-"). - # * <tt>:extension</tt> - Specifies an extension to add to the - # end of the generated number. - # * <tt>:country_code</tt> - Sets the country code for the phone - # number. - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_to_phone(5551234) # => 555-1234 - # number_to_phone("5551234") # => 555-1234 - # number_to_phone(1235551234) # => 123-555-1234 - # number_to_phone(1235551234, area_code: true) # => (123) 555-1234 - # number_to_phone(1235551234, delimiter: " ") # => 123 555 1234 - # number_to_phone(1235551234, area_code: true, extension: 555) # => (123) 555-1234 x 555 - # number_to_phone(1235551234, country_code: 1) # => +1-123-555-1234 - # number_to_phone("123a456") # => 123a456 - # number_to_phone("1234a567", raise: true) # => InvalidNumberError - # - # number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: ".") - # # => +1.123.555.1234 x 1343 - def number_to_phone(number, options = {}) - return unless number - options = options.symbolize_keys - - parse_float(number, true) if options.delete(:raise) - ERB::Util.html_escape(ActiveSupport::NumberHelper.number_to_phone(number, options)) - end - - # Formats a +number+ into a currency string (e.g., $13.65). You - # can customize the format in the +options+ hash. - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:precision</tt> - Sets the level of precision (defaults - # to 2). - # * <tt>:unit</tt> - Sets the denomination of the currency - # (defaults to "$"). - # * <tt>:separator</tt> - Sets the separator between the units - # (defaults to "."). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ","). - # * <tt>:format</tt> - Sets the format for non-negative numbers - # (defaults to "%u%n"). Fields are <tt>%u</tt> for the - # currency, and <tt>%n</tt> for the number. - # * <tt>:negative_format</tt> - Sets the format for negative - # numbers (defaults to prepending an hyphen to the formatted - # number given by <tt>:format</tt>). Accepts the same fields - # than <tt>:format</tt>, except <tt>%n</tt> is here the - # absolute value of the number. - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_to_currency(1234567890.50) # => $1,234,567,890.50 - # number_to_currency(1234567890.506) # => $1,234,567,890.51 - # number_to_currency(1234567890.506, precision: 3) # => $1,234,567,890.506 - # number_to_currency(1234567890.506, locale: :fr) # => 1 234 567 890,51 € - # number_to_currency("123a456") # => $123a456 - # - # number_to_currency("123a456", raise: true) # => InvalidNumberError - # - # number_to_currency(-1234567890.50, negative_format: "(%u%n)") - # # => ($1,234,567,890.50) - # number_to_currency(1234567890.50, unit: "£", separator: ",", delimiter: "") - # # => £1234567890,50 - # number_to_currency(1234567890.50, unit: "£", separator: ",", delimiter: "", format: "%n %u") - # # => 1234567890,50 £ - def number_to_currency(number, options = {}) - return unless number - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_currency(number, options) - } - end - - # Formats a +number+ as a percentage string (e.g., 65%). You can - # customize the format in the +options+ hash. - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:precision</tt> - Sets the precision of the number - # (defaults to 3). - # * <tt>:significant</tt> - If +true+, precision will be the # - # of significant_digits. If +false+, the # of fractional - # digits (defaults to +false+). - # * <tt>:separator</tt> - Sets the separator between the - # fractional and integer digits (defaults to "."). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ""). - # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes - # insignificant zeros after the decimal separator (defaults to - # +false+). - # * <tt>:format</tt> - Specifies the format of the percentage - # string The number field is <tt>%n</tt> (defaults to "%n%"). - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_to_percentage(100) # => 100.000% - # number_to_percentage("98") # => 98.000% - # number_to_percentage(100, precision: 0) # => 100% - # number_to_percentage(1000, delimiter: '.', separator: ',') # => 1.000,000% - # number_to_percentage(302.24398923423, precision: 5) # => 302.24399% - # number_to_percentage(1000, locale: :fr) # => 1 000,000% - # number_to_percentage("98a") # => 98a% - # number_to_percentage(100, format: "%n %") # => 100 % - # - # number_to_percentage("98a", raise: true) # => InvalidNumberError - def number_to_percentage(number, options = {}) - return unless number - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_percentage(number, options) - } - end - - # Formats a +number+ with grouped thousands using +delimiter+ - # (e.g., 12,324). You can customize the format in the +options+ - # hash. - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ","). - # * <tt>:separator</tt> - Sets the separator between the - # fractional and integer digits (defaults to "."). - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_with_delimiter(12345678) # => 12,345,678 - # number_with_delimiter("123456") # => 123,456 - # number_with_delimiter(12345678.05) # => 12,345,678.05 - # number_with_delimiter(12345678, delimiter: ".") # => 12.345.678 - # number_with_delimiter(12345678, delimiter: ",") # => 12,345,678 - # number_with_delimiter(12345678.05, separator: " ") # => 12,345,678 05 - # number_with_delimiter(12345678.05, locale: :fr) # => 12 345 678,05 - # number_with_delimiter("112a") # => 112a - # number_with_delimiter(98765432.98, delimiter: " ", separator: ",") - # # => 98 765 432,98 - # - # number_with_delimiter("112a", raise: true) # => raise InvalidNumberError - def number_with_delimiter(number, options = {}) - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_delimited(number, options) - } - end - - # Formats a +number+ with the specified level of - # <tt>:precision</tt> (e.g., 112.32 has a precision of 2 if - # +:significant+ is +false+, and 5 if +:significant+ is +true+). - # You can customize the format in the +options+ hash. - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:precision</tt> - Sets the precision of the number - # (defaults to 3). - # * <tt>:significant</tt> - If +true+, precision will be the # - # of significant_digits. If +false+, the # of fractional - # digits (defaults to +false+). - # * <tt>:separator</tt> - Sets the separator between the - # fractional and integer digits (defaults to "."). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ""). - # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes - # insignificant zeros after the decimal separator (defaults to - # +false+). - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_with_precision(111.2345) # => 111.235 - # number_with_precision(111.2345, precision: 2) # => 111.23 - # number_with_precision(13, precision: 5) # => 13.00000 - # number_with_precision(389.32314, precision: 0) # => 389 - # number_with_precision(111.2345, significant: true) # => 111 - # number_with_precision(111.2345, precision: 1, significant: true) # => 100 - # number_with_precision(13, precision: 5, significant: true) # => 13.000 - # number_with_precision(111.234, locale: :fr) # => 111,234 - # - # number_with_precision(13, precision: 5, significant: true, strip_insignificant_zeros: true) - # # => 13 - # - # number_with_precision(389.32314, precision: 4, significant: true) # => 389.3 - # number_with_precision(1111.2345, precision: 2, separator: ',', delimiter: '.') - # # => 1.111,23 - def number_with_precision(number, options = {}) - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_rounded(number, options) - } - end - - # Formats the bytes in +number+ into a more understandable - # representation (e.g., giving it 1500 yields 1.5 KB). This - # method is useful for reporting file sizes to users. You can - # customize the format in the +options+ hash. - # - # See <tt>number_to_human</tt> if you want to pretty-print a - # generic number. - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:precision</tt> - Sets the precision of the number - # (defaults to 3). - # * <tt>:significant</tt> - If +true+, precision will be the # - # of significant_digits. If +false+, the # of fractional - # digits (defaults to +true+) - # * <tt>:separator</tt> - Sets the separator between the - # fractional and integer digits (defaults to "."). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ""). - # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes - # insignificant zeros after the decimal separator (defaults to - # +true+) - # * <tt>:prefix</tt> - If +:si+ formats the number using the SI - # prefix (defaults to :binary) - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_to_human_size(123) # => 123 Bytes - # number_to_human_size(1234) # => 1.21 KB - # number_to_human_size(12345) # => 12.1 KB - # number_to_human_size(1234567) # => 1.18 MB - # number_to_human_size(1234567890) # => 1.15 GB - # number_to_human_size(1234567890123) # => 1.12 TB - # number_to_human_size(1234567, precision: 2) # => 1.2 MB - # number_to_human_size(483989, precision: 2) # => 470 KB - # number_to_human_size(1234567, precision: 2, separator: ',') # => 1,2 MB - # - # Non-significant zeros after the fractional separator are - # stripped out by default (set - # <tt>:strip_insignificant_zeros</tt> to +false+ to change - # that): - # - # number_to_human_size(1234567890123, precision: 5) # => "1.1229 TB" - # number_to_human_size(524288000, precision: 5) # => "500 MB" - def number_to_human_size(number, options = {}) - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_human_size(number, options) - } - end - - # Pretty prints (formats and approximates) a number in a way it - # is more readable by humans (eg.: 1200000000 becomes "1.2 - # Billion"). This is useful for numbers that can get very large - # (and too hard to read). - # - # See <tt>number_to_human_size</tt> if you want to print a file - # size. - # - # You can also define you own unit-quantifier names if you want - # to use other decimal units (eg.: 1500 becomes "1.5 - # kilometers", 0.150 becomes "150 milliliters", etc). You may - # define a wide range of unit quantifiers, even fractional ones - # (centi, deci, mili, etc). - # - # ==== Options - # - # * <tt>:locale</tt> - Sets the locale to be used for formatting - # (defaults to current locale). - # * <tt>:precision</tt> - Sets the precision of the number - # (defaults to 3). - # * <tt>:significant</tt> - If +true+, precision will be the # - # of significant_digits. If +false+, the # of fractional - # digits (defaults to +true+) - # * <tt>:separator</tt> - Sets the separator between the - # fractional and integer digits (defaults to "."). - # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults - # to ""). - # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes - # insignificant zeros after the decimal separator (defaults to - # +true+) - # * <tt>:units</tt> - A Hash of unit quantifier names. Or a - # string containing an i18n scope where to find this hash. It - # might have the following keys: - # * *integers*: <tt>:unit</tt>, <tt>:ten</tt>, - # *<tt>:hundred</tt>, <tt>:thousand</tt>, <tt>:million</tt>, - # *<tt>:billion</tt>, <tt>:trillion</tt>, - # *<tt>:quadrillion</tt> - # * *fractionals*: <tt>:deci</tt>, <tt>:centi</tt>, - # *<tt>:mili</tt>, <tt>:micro</tt>, <tt>:nano</tt>, - # *<tt>:pico</tt>, <tt>:femto</tt> - # * <tt>:format</tt> - Sets the format of the output string - # (defaults to "%n %u"). The field types are: - # * %u - The quantifier (ex.: 'thousand') - # * %n - The number - # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when - # the argument is invalid. - # - # ==== Examples - # - # number_to_human(123) # => "123" - # number_to_human(1234) # => "1.23 Thousand" - # number_to_human(12345) # => "12.3 Thousand" - # number_to_human(1234567) # => "1.23 Million" - # number_to_human(1234567890) # => "1.23 Billion" - # number_to_human(1234567890123) # => "1.23 Trillion" - # number_to_human(1234567890123456) # => "1.23 Quadrillion" - # number_to_human(1234567890123456789) # => "1230 Quadrillion" - # number_to_human(489939, precision: 2) # => "490 Thousand" - # number_to_human(489939, precision: 4) # => "489.9 Thousand" - # number_to_human(1234567, precision: 4, - # significant: false) # => "1.2346 Million" - # number_to_human(1234567, precision: 1, - # separator: ',', - # significant: false) # => "1,2 Million" - # - # Non-significant zeros after the decimal separator are stripped - # out by default (set <tt>:strip_insignificant_zeros</tt> to - # +false+ to change that): - # number_to_human(12345012345, significant_digits: 6) # => "12.345 Billion" - # number_to_human(500000000, precision: 5) # => "500 Million" - # - # ==== Custom Unit Quantifiers - # - # You can also use your own custom unit quantifiers: - # number_to_human(500000, units: {unit: "ml", thousand: "lt"}) # => "500 lt" - # - # If in your I18n locale you have: - # distance: - # centi: - # one: "centimeter" - # other: "centimeters" - # unit: - # one: "meter" - # other: "meters" - # thousand: - # one: "kilometer" - # other: "kilometers" - # billion: "gazillion-distance" - # - # Then you could do: - # - # number_to_human(543934, units: :distance) # => "544 kilometers" - # number_to_human(54393498, units: :distance) # => "54400 kilometers" - # number_to_human(54393498000, units: :distance) # => "54.4 gazillion-distance" - # number_to_human(343, units: :distance, precision: 1) # => "300 meters" - # number_to_human(1, units: :distance) # => "1 meter" - # number_to_human(0.34, units: :distance) # => "34 centimeters" - # - def number_to_human(number, options = {}) - options = escape_unsafe_delimiters_and_separators(options.symbolize_keys) - - wrap_with_output_safety_handling(number, options.delete(:raise)) { - ActiveSupport::NumberHelper.number_to_human(number, options) - } - end - - private - - def escape_unsafe_delimiters_and_separators(options) - options[:separator] = ERB::Util.html_escape(options[:separator]) if options[:separator] && !options[:separator].html_safe? - options[:delimiter] = ERB::Util.html_escape(options[:delimiter]) if options[:delimiter] && !options[:delimiter].html_safe? - options - end - - def wrap_with_output_safety_handling(number, raise_on_invalid, &block) - valid_float = valid_float?(number) - raise InvalidNumberError, number if raise_on_invalid && !valid_float - - formatted_number = yield - - if valid_float || number.html_safe? - formatted_number.html_safe - else - formatted_number - end - end - - def valid_float?(number) - !parse_float(number, false).nil? - end - - def parse_float(number, raise_error) - Float(number) - rescue ArgumentError, TypeError - raise InvalidNumberError, number if raise_error - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/output_safety_helper.rb b/actionpack/lib/action_view/helpers/output_safety_helper.rb deleted file mode 100644 index 60a4478c26..0000000000 --- a/actionpack/lib/action_view/helpers/output_safety_helper.rb +++ /dev/null @@ -1,38 +0,0 @@ -require 'active_support/core_ext/string/output_safety' - -module ActionView #:nodoc: - # = Action View Raw Output Helper - module Helpers #:nodoc: - module OutputSafetyHelper - # This method outputs without escaping a string. Since escaping tags is - # now default, this can be used when you don't want Rails to automatically - # escape tags. This is not recommended if the data is coming from the user's - # input. - # - # For example: - # - # raw @user.name - # # => 'Jimmy <alert>Tables</alert>' - def raw(stringish) - stringish.to_s.html_safe - end - - # This method returns a html safe string similar to what <tt>Array#join</tt> - # would return. All items in the array, including the supplied separator, are - # html escaped unless they are html safe, and the returned string is marked - # as html safe. - # - # safe_join(["<p>foo</p>".html_safe, "<p>bar</p>"], "<br />") - # # => "<p>foo</p><br /><p>bar</p>" - # - # safe_join(["<p>foo</p>".html_safe, "<p>bar</p>".html_safe], "<br />".html_safe) - # # => "<p>foo</p><br /><p>bar</p>" - # - def safe_join(array, sep=$,) - sep = ERB::Util.html_escape(sep) - - array.map { |i| ERB::Util.html_escape(i) }.join(sep).html_safe - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/record_tag_helper.rb b/actionpack/lib/action_view/helpers/record_tag_helper.rb deleted file mode 100644 index f767957fa9..0000000000 --- a/actionpack/lib/action_view/helpers/record_tag_helper.rb +++ /dev/null @@ -1,106 +0,0 @@ -module ActionView - # = Action View Record Tag Helpers - module Helpers - module RecordTagHelper - 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 %> - # <%= @person.name %> - # <% end %> - # - # produces: - # - # <div id="person_123" class="person foo"> Joe Bloggs </div> - # - # You can also pass an array of Active Record objects, which will then - # get iterated over and yield each record as an argument for the block. - # For example: - # - # <%= div_for(@people, class: "foo") do |person| %> - # <%= person.name %> - # <% end %> - # - # produces: - # - # <div id="person_123" class="person foo"> Joe Bloggs </div> - # <div id="person_124" class="person foo"> Jane Bloggs </div> - # - def div_for(record, *args, &block) - content_tag_for(:div, record, *args, &block) - end - - # content_tag_for creates an HTML element with id and class parameters - # that relate to the specified Active Record object. For example: - # - # <%= content_tag_for(:tr, @person) do %> - # <td><%= @person.first_name %></td> - # <td><%= @person.last_name %></td> - # <% end %> - # - # would produce the following HTML (assuming @person is an instance of - # a Person object, with an id value of 123): - # - # <tr id="person_123" class="person">....</tr> - # - # If you require the HTML id attribute to have a prefix, you can specify it: - # - # <%= content_tag_for(:tr, @person, :foo) do %> ... - # - # produces: - # - # <tr id="foo_person_123" class="person">... - # - # You can also pass an array of objects which this method will loop through - # and yield the current object to the supplied block, reducing the need for - # having to iterate through the object (using <tt>each</tt>) beforehand. - # For example (assuming @people is an array of Person objects): - # - # <%= content_tag_for(:tr, @people) do |person| %> - # <td><%= person.first_name %></td> - # <td><%= person.last_name %></td> - # <% end %> - # - # produces: - # - # <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") %>... - # - # produces: - # - # <li id="person_123" class="person bar">... - # - def content_tag_for(tag_name, single_or_multiple_records, prefix = nil, options = nil, &block) - 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 - - # 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 = options ? options.dup : {} - 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 - end -end diff --git a/actionpack/lib/action_view/helpers/rendering_helper.rb b/actionpack/lib/action_view/helpers/rendering_helper.rb deleted file mode 100644 index 458086de96..0000000000 --- a/actionpack/lib/action_view/helpers/rendering_helper.rb +++ /dev/null @@ -1,90 +0,0 @@ -module ActionView - module Helpers - # = Action View Rendering - # - # Implements methods that allow rendering from a view context. - # In order to use this module, all you need is to implement - # view_renderer that returns an ActionView::Renderer object. - module RenderingHelper - # Returns the result of a render that's dictated by the options hash. The primary options are: - # - # * <tt>:partial</tt> - See <tt>ActionView::PartialRenderer</tt>. - # * <tt>:file</tt> - Renders an explicit template file (this used to be the old default), add :locals to pass in those. - # * <tt>:inline</tt> - Renders an inline template similar to how it's done in the controller. - # * <tt>:text</tt> - Renders the text passed in out. - # - # If no options hash is passed or :update specified, the default is to render a partial and use the second parameter - # as the locals hash. - def render(options = {}, locals = {}, &block) - case options - when Hash - if block_given? - view_renderer.render_partial(self, options.merge(:partial => options[:layout]), &block) - else - view_renderer.render(self, options) - end - else - view_renderer.render_partial(self, :partial => options, :locals => locals) - end - end - - # Overwrites _layout_for in the context object so it supports the case a block is - # passed to a partial. Returns the contents that are yielded to a layout, given a - # name or a block. - # - # You can think of a layout as a method that is called with a block. If the user calls - # <tt>yield :some_name</tt>, the block, by default, returns <tt>content_for(:some_name)</tt>. - # If the user calls simply +yield+, the default block returns <tt>content_for(:layout)</tt>. - # - # The user can override this default by passing a block to the layout: - # - # # The template - # <%= render layout: "my_layout" do %> - # Content - # <% end %> - # - # # The layout - # <html> - # <%= yield %> - # </html> - # - # In this case, instead of the default block, which would return <tt>content_for(:layout)</tt>, - # this method returns the block that was passed in to <tt>render :layout</tt>, and the response - # would be - # - # <html> - # Content - # </html> - # - # Finally, the block can take block arguments, which can be passed in by +yield+: - # - # # The template - # <%= render layout: "my_layout" do |customer| %> - # Hello <%= customer.name %> - # <% end %> - # - # # The layout - # <html> - # <%= yield Struct.new(:name).new("David") %> - # </html> - # - # In this case, the layout would receive the block passed into <tt>render :layout</tt>, - # and the struct specified would be passed into the block as an argument. The result - # would be - # - # <html> - # Hello David - # </html> - # - def _layout_for(*args, &block) - name = args.first - - if block && !name.is_a?(Symbol) - capture(*args, &block) - else - super - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/sanitize_helper.rb b/actionpack/lib/action_view/helpers/sanitize_helper.rb deleted file mode 100644 index e5cb843670..0000000000 --- a/actionpack/lib/action_view/helpers/sanitize_helper.rb +++ /dev/null @@ -1,256 +0,0 @@ -require 'active_support/core_ext/object/try' -require 'action_view/vendor/html-scanner' - -module ActionView - # = Action View Sanitize Helpers - 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 - extend ActiveSupport::Concern - # This +sanitize+ helper will html encode all tags and strip all attributes that - # aren't specifically allowed. - # - # It also strips href/src tags with invalid protocols, like javascript: especially. - # It does its best to counter any tricks that hackers may use, like throwing in - # unicode/ascii/hex values to get past the javascript: filters. Check out - # the extensive test suite. - # - # <%= sanitize @article.body %> - # - # You can add or remove tags/attributes if you want to customize it a bit. - # See ActionView::Base for full docs on the available options. You can add - # tags/attributes for single uses of +sanitize+ by passing either the - # <tt>:attributes</tt> or <tt>:tags</tt> options: - # - # Normal Use - # - # <%= sanitize @article.body %> - # - # 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) %> - # - # Add table tags to the default allowed tags - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_tags = 'table', 'tr', 'td' - # end - # - # Remove tags to the default allowed tags - # - # class Application < Rails::Application - # config.after_initialize do - # ActionView::Base.sanitized_allowed_tags.delete 'div' - # end - # end - # - # Change allowed default attributes - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_attributes = 'id', 'class', 'style' - # end - # - # Please note that sanitizing user-provided text does not guarantee that the - # resulting markup is valid (conforming to a document type) or even well-formed. - # The output may still contain e.g. unescaped '<', '>', '&' characters and - # confuse browsers. - # - def sanitize(html, options = {}) - self.class.white_list_sanitizer.sanitize(html, options).try(:html_safe) - end - - # Sanitizes a block of CSS code. Used by +sanitize+ when it comes across a style attribute. - def sanitize_css(style) - self.class.white_list_sanitizer.sanitize_css(style) - end - - # Strips all HTML tags from the +html+, including comments. This uses the - # html-scanner tokenizer and so its HTML parsing ability is limited by - # that of html-scanner. - # - # strip_tags("Strip <i>these</i> tags!") - # # => Strip these tags! - # - # strip_tags("<b>Bold</b> no more! <a href='more.html'>See more here</a>...") - # # => Bold no more! See more here... - # - # strip_tags("<div id='top-bar'>Welcome to my website!</div>") - # # => Welcome to my website! - def strip_tags(html) - self.class.full_sanitizer.sanitize(html) - end - - # Strips all link tags from +text+ leaving just the link text. - # - # strip_links('<a href="http://www.rubyonrails.org">Ruby on Rails</a>') - # # => Ruby on Rails - # - # strip_links('Please e-mail me at <a href="mailto:me@email.com">me@email.com</a>.') - # # => Please e-mail me at me@email.com. - # - # strip_links('Blog: <a href="http://www.myblog.com/" class="nav" target=\"_blank\">Visit</a>.') - # # => Blog: Visit. - def strip_links(html) - self.class.link_sanitizer.sanitize(html) - end - - module ClassMethods #:nodoc: - attr_writer :full_sanitizer, :link_sanitizer, :white_list_sanitizer - - def sanitized_protocol_separator - white_list_sanitizer.protocol_separator - end - - def sanitized_uri_attributes - white_list_sanitizer.uri_attributes - end - - def sanitized_bad_tags - white_list_sanitizer.bad_tags - end - - def sanitized_allowed_tags - white_list_sanitizer.allowed_tags - end - - def sanitized_allowed_attributes - white_list_sanitizer.allowed_attributes - end - - def sanitized_allowed_css_properties - white_list_sanitizer.allowed_css_properties - end - - def sanitized_allowed_css_keywords - white_list_sanitizer.allowed_css_keywords - end - - def sanitized_shorthand_css_properties - white_list_sanitizer.shorthand_css_properties - end - - def sanitized_allowed_protocols - white_list_sanitizer.allowed_protocols - end - - def sanitized_protocol_separator=(value) - white_list_sanitizer.protocol_separator = value - end - - # Gets the HTML::FullSanitizer instance used by +strip_tags+. Replace with - # any object that responds to +sanitize+. - # - # class Application < Rails::Application - # config.action_view.full_sanitizer = MySpecialSanitizer.new - # end - # - def full_sanitizer - @full_sanitizer ||= HTML::FullSanitizer.new - end - - # Gets the HTML::LinkSanitizer instance used by +strip_links+. Replace with - # any object that responds to +sanitize+. - # - # class Application < Rails::Application - # config.action_view.link_sanitizer = MySpecialSanitizer.new - # end - # - def link_sanitizer - @link_sanitizer ||= HTML::LinkSanitizer.new - end - - # Gets the HTML::WhiteListSanitizer instance used by sanitize and +sanitize_css+. - # Replace with any object that responds to +sanitize+. - # - # class Application < Rails::Application - # config.action_view.white_list_sanitizer = MySpecialSanitizer.new - # end - # - def white_list_sanitizer - @white_list_sanitizer ||= HTML::WhiteListSanitizer.new - end - - # Adds valid HTML attributes that the +sanitize+ helper checks for URIs. - # - # class Application < Rails::Application - # config.action_view.sanitized_uri_attributes = 'lowsrc', 'target' - # end - # - def sanitized_uri_attributes=(attributes) - HTML::WhiteListSanitizer.uri_attributes.merge(attributes) - end - - # Adds to the Set of 'bad' tags for the +sanitize+ helper. - # - # class Application < Rails::Application - # config.action_view.sanitized_bad_tags = 'embed', 'object' - # end - # - def sanitized_bad_tags=(attributes) - HTML::WhiteListSanitizer.bad_tags.merge(attributes) - end - - # Adds to the Set of allowed tags for the +sanitize+ helper. - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_tags = 'table', 'tr', 'td' - # end - # - def sanitized_allowed_tags=(attributes) - HTML::WhiteListSanitizer.allowed_tags.merge(attributes) - end - - # Adds to the Set of allowed HTML attributes for the +sanitize+ helper. - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_attributes = 'onclick', 'longdesc' - # end - # - def sanitized_allowed_attributes=(attributes) - HTML::WhiteListSanitizer.allowed_attributes.merge(attributes) - end - - # Adds to the Set of allowed CSS properties for the #sanitize and +sanitize_css+ helpers. - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_css_properties = 'expression' - # end - # - def sanitized_allowed_css_properties=(attributes) - HTML::WhiteListSanitizer.allowed_css_properties.merge(attributes) - end - - # Adds to the Set of allowed CSS keywords for the +sanitize+ and +sanitize_css+ helpers. - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_css_keywords = 'expression' - # end - # - def sanitized_allowed_css_keywords=(attributes) - HTML::WhiteListSanitizer.allowed_css_keywords.merge(attributes) - end - - # Adds to the Set of allowed shorthand CSS properties for the +sanitize+ and +sanitize_css+ helpers. - # - # class Application < Rails::Application - # config.action_view.sanitized_shorthand_css_properties = 'expression' - # end - # - def sanitized_shorthand_css_properties=(attributes) - HTML::WhiteListSanitizer.shorthand_css_properties.merge(attributes) - end - - # Adds to the Set of allowed protocols for the +sanitize+ helper. - # - # class Application < Rails::Application - # config.action_view.sanitized_allowed_protocols = 'ssh', 'feed' - # end - # - def sanitized_allowed_protocols=(attributes) - HTML::WhiteListSanitizer.allowed_protocols.merge(attributes) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tag_helper.rb b/actionpack/lib/action_view/helpers/tag_helper.rb deleted file mode 100644 index 732f35643a..0000000000 --- a/actionpack/lib/action_view/helpers/tag_helper.rb +++ /dev/null @@ -1,176 +0,0 @@ -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 & shut.png" /> - # - # tag("img", {src: "open & shut.png"}, false, false) - # # => <img src="open & shut.png" /> - # - # tag("div", data: {name: 'Stephen', city_state: %w(Chicago IL)}) - # # => <div data-name="Stephen" data-city-state="["Chicago","IL"]" /> - 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.gsub(']]>', ']]]]><![CDATA[>') - "<![CDATA[#{splitted}]]>".html_safe - end - - # Returns an escaped version of +html+ without affecting existing escaped entities. - # - # escape_once("1 < 2 & 3") - # # => "1 < 2 & 3" - # - # escape_once("<< Accept & Checkout") - # # => "<< Accept & 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! * ' '}".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 -end diff --git a/actionpack/lib/action_view/helpers/tags.rb b/actionpack/lib/action_view/helpers/tags.rb deleted file mode 100644 index a05e16979a..0000000000 --- a/actionpack/lib/action_view/helpers/tags.rb +++ /dev/null @@ -1,39 +0,0 @@ -module ActionView - module Helpers - module Tags #:nodoc: - extend ActiveSupport::Autoload - - 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 diff --git a/actionpack/lib/action_view/helpers/tags/base.rb b/actionpack/lib/action_view/helpers/tags/base.rb deleted file mode 100644 index 3fe3f4e9df..0000000000 --- a/actionpack/lib/action_view/helpers/tags/base.rb +++ /dev/null @@ -1,147 +0,0 @@ -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 diff --git a/actionpack/lib/action_view/helpers/tags/check_box.rb b/actionpack/lib/action_view/helpers/tags/check_box.rb deleted file mode 100644 index 6d51f2629a..0000000000 --- a/actionpack/lib/action_view/helpers/tags/check_box.rb +++ /dev/null @@ -1,64 +0,0 @@ -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 diff --git a/actionpack/lib/action_view/helpers/tags/checkable.rb b/actionpack/lib/action_view/helpers/tags/checkable.rb deleted file mode 100644 index 052e9df662..0000000000 --- a/actionpack/lib/action_view/helpers/tags/checkable.rb +++ /dev/null @@ -1,16 +0,0 @@ -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 diff --git a/actionpack/lib/action_view/helpers/tags/collection_check_boxes.rb b/actionpack/lib/action_view/helpers/tags/collection_check_boxes.rb deleted file mode 100644 index 52006d856b..0000000000 --- a/actionpack/lib/action_view/helpers/tags/collection_check_boxes.rb +++ /dev/null @@ -1,43 +0,0 @@ -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 diff --git a/actionpack/lib/action_view/helpers/tags/collection_helpers.rb b/actionpack/lib/action_view/helpers/tags/collection_helpers.rb deleted file mode 100644 index 388dcf1f13..0000000000 --- a/actionpack/lib/action_view/helpers/tags/collection_helpers.rb +++ /dev/null @@ -1,84 +0,0 @@ -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) - additional_html_options = option_html_attributes(item) - - yield item, value, text, default_html_options.merge(additional_html_options) - end.join.html_safe - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/collection_radio_buttons.rb b/actionpack/lib/action_view/helpers/tags/collection_radio_buttons.rb deleted file mode 100644 index 20be34c1f2..0000000000 --- a/actionpack/lib/action_view/helpers/tags/collection_radio_buttons.rb +++ /dev/null @@ -1,36 +0,0 @@ -require 'action_view/helpers/tags/collection_helpers' - -module ActionView - module Helpers - module Tags # :nodoc: - class CollectionRadioButtons < Base # :nodoc: - include CollectionHelpers - - class RadioButtonBuilder < Builder # :nodoc: - def radio_button(extra_html_options={}) - html_options = extra_html_options.merge(@input_html_options) - @template_object.radio_button(@object_name, @method_name, @value, html_options) - end - end - - def render(&block) - render_collection do |item, value, text, default_html_options| - builder = instantiate_builder(RadioButtonBuilder, item, value, text, default_html_options) - - if block_given? - @template_object.capture(builder, &block) - else - render_component(builder) - end - end - end - - private - - def render_component(builder) - builder.radio_button + builder.label - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/collection_select.rb b/actionpack/lib/action_view/helpers/tags/collection_select.rb deleted file mode 100644 index 6cb2b2e0d3..0000000000 --- a/actionpack/lib/action_view/helpers/tags/collection_select.rb +++ /dev/null @@ -1,28 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class CollectionSelect < Base #:nodoc: - 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 - - def render - option_tags_options = { - :selected => @options.fetch(:selected) { value(@object) }, - :disabled => @options[:disabled] - } - - select_content_tag( - options_from_collection_for_select(@collection, @value_method, @text_method, option_tags_options), - @options, @html_options - ) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/color_field.rb b/actionpack/lib/action_view/helpers/tags/color_field.rb deleted file mode 100644 index d8fc797035..0000000000 --- a/actionpack/lib/action_view/helpers/tags/color_field.rb +++ /dev/null @@ -1,25 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class ColorField < TextField # :nodoc: - def render - options = @options.stringify_keys - options["value"] = @options.fetch("value") { validate_color_string(value(object)) } - @options = options - super - end - - private - - def validate_color_string(string) - regex = /#[0-9a-fA-F]{6}/ - if regex.match(string) - string.downcase - else - "#000000" - end - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/date_field.rb b/actionpack/lib/action_view/helpers/tags/date_field.rb deleted file mode 100644 index c22be0db29..0000000000 --- a/actionpack/lib/action_view/helpers/tags/date_field.rb +++ /dev/null @@ -1,13 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class DateField < DatetimeField # :nodoc: - private - - def format_date(value) - value.try(:strftime, "%Y-%m-%d") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/date_select.rb b/actionpack/lib/action_view/helpers/tags/date_select.rb deleted file mode 100644 index 0c4ac40070..0000000000 --- a/actionpack/lib/action_view/helpers/tags/date_select.rb +++ /dev/null @@ -1,72 +0,0 @@ -require 'active_support/core_ext/time/calculations' - -module ActionView - module Helpers - module Tags # :nodoc: - class DateSelect < Base # :nodoc: - def initialize(object_name, method_name, template_object, options, html_options) - @html_options = html_options - - super(object_name, method_name, template_object, options) - end - - def render - error_wrapping(datetime_selector(@options, @html_options).send("select_#{select_type}").html_safe) - end - - class << self - def select_type - @select_type ||= self.name.split("::").last.sub("Select", "").downcase - end - end - - private - - def select_type - self.class.select_type - end - - def datetime_selector(options, html_options) - datetime = options.fetch(:selected) { value(object) || default_datetime(options) } - @auto_index ||= nil - - options = options.dup - options[:field_name] = @method_name - options[:include_position] = true - options[:prefix] ||= @object_name - options[:index] = @auto_index if @auto_index && !options.has_key?(:index) - - DateTimeSelector.new(datetime, options, html_options) - end - - def default_datetime(options) - return if options[:include_blank] || options[:prompt] - - case options[:default] - when nil - Time.current - when Date, Time - options[:default] - else - default = options[:default].dup - - # Rename :minute and :second to :min and :sec - default[:min] ||= default[:minute] - default[:sec] ||= default[:second] - - time = Time.current - - [:year, :month, :day, :hour, :min, :sec].each do |key| - default[key] ||= time.send(key) - end - - Time.utc( - default[:year], default[:month], default[:day], - default[:hour], default[:min], default[:sec] - ) - end - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/datetime_field.rb b/actionpack/lib/action_view/helpers/tags/datetime_field.rb deleted file mode 100644 index 9a2279c611..0000000000 --- a/actionpack/lib/action_view/helpers/tags/datetime_field.rb +++ /dev/null @@ -1,22 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class DatetimeField < TextField # :nodoc: - def render - options = @options.stringify_keys - options["value"] = @options.fetch("value") { format_date(value(object)) } - options["min"] = format_date(options["min"]) - options["max"] = format_date(options["max"]) - @options = options - super - end - - private - - def format_date(value) - value.try(:strftime, "%Y-%m-%dT%T.%L%z") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/datetime_local_field.rb b/actionpack/lib/action_view/helpers/tags/datetime_local_field.rb deleted file mode 100644 index b4a74185d1..0000000000 --- a/actionpack/lib/action_view/helpers/tags/datetime_local_field.rb +++ /dev/null @@ -1,19 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class DatetimeLocalField < DatetimeField # :nodoc: - class << self - def field_type - @field_type ||= "datetime-local" - end - end - - private - - def format_date(value) - value.try(:strftime, "%Y-%m-%dT%T") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/datetime_select.rb b/actionpack/lib/action_view/helpers/tags/datetime_select.rb deleted file mode 100644 index 563de1840e..0000000000 --- a/actionpack/lib/action_view/helpers/tags/datetime_select.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class DatetimeSelect < DateSelect # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/email_field.rb b/actionpack/lib/action_view/helpers/tags/email_field.rb deleted file mode 100644 index 7ce3ccb9bf..0000000000 --- a/actionpack/lib/action_view/helpers/tags/email_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class EmailField < TextField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/file_field.rb b/actionpack/lib/action_view/helpers/tags/file_field.rb deleted file mode 100644 index 476b820d84..0000000000 --- a/actionpack/lib/action_view/helpers/tags/file_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class FileField < TextField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/grouped_collection_select.rb b/actionpack/lib/action_view/helpers/tags/grouped_collection_select.rb deleted file mode 100644 index 2ed4712dac..0000000000 --- a/actionpack/lib/action_view/helpers/tags/grouped_collection_select.rb +++ /dev/null @@ -1,29 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class GroupedCollectionSelect < Base # :nodoc: - def initialize(object_name, method_name, template_object, collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options) - @collection = collection - @group_method = group_method - @group_label_method = group_label_method - @option_key_method = option_key_method - @option_value_method = option_value_method - @html_options = html_options - - super(object_name, method_name, template_object, options) - end - - def render - option_tags_options = { - :selected => @options.fetch(:selected) { value(@object) }, - :disabled => @options[:disabled] - } - - select_content_tag( - option_groups_from_collection_for_select(@collection, @group_method, @group_label_method, @option_key_method, @option_value_method, option_tags_options), @options, @html_options - ) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/hidden_field.rb b/actionpack/lib/action_view/helpers/tags/hidden_field.rb deleted file mode 100644 index c3757c2461..0000000000 --- a/actionpack/lib/action_view/helpers/tags/hidden_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class HiddenField < TextField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/label.rb b/actionpack/lib/action_view/helpers/tags/label.rb deleted file mode 100644 index 35d3ba8434..0000000000 --- a/actionpack/lib/action_view/helpers/tags/label.rb +++ /dev/null @@ -1,65 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class Label < Base # :nodoc: - def initialize(object_name, method_name, template_object, content_or_options = nil, options = nil) - options ||= {} - - content_is_options = content_or_options.is_a?(Hash) - if content_is_options - options.merge! content_or_options - @content = nil - else - @content = content_or_options - end - - super(object_name, method_name, template_object, options) - end - - def render(&block) - options = @options.stringify_keys - tag_value = options.delete("value") - name_and_id = options.dup - - if name_and_id["for"] - name_and_id["id"] = name_and_id["for"] - else - name_and_id.delete("id") - end - - add_default_name_and_id_for_value(tag_value, name_and_id) - options.delete("index") - options.delete("namespace") - options["for"] = name_and_id["id"] unless options.key?("for") - - if block_given? - content = @template_object.capture(&block) - else - content = if @content.blank? - @object_name.gsub!(/\[(.*)_attributes\]\[\d\]/, '.\1') - method_and_value = tag_value.present? ? "#{@method_name}.#{tag_value}" : @method_name - - if object.respond_to?(:to_model) - key = object.class.model_name.i18n_key - i18n_default = ["#{key}.#{method_and_value}".to_sym, ""] - end - - i18n_default ||= "" - I18n.t("#{@object_name}.#{method_and_value}", :default => i18n_default, :scope => "helpers.label").presence - else - @content.to_s - end - - content ||= if object && object.class.respond_to?(:human_attribute_name) - object.class.human_attribute_name(@method_name) - end - - content ||= @method_name.humanize - end - - label_tag(name_and_id["id"], content, options) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/month_field.rb b/actionpack/lib/action_view/helpers/tags/month_field.rb deleted file mode 100644 index 4c0fb846ee..0000000000 --- a/actionpack/lib/action_view/helpers/tags/month_field.rb +++ /dev/null @@ -1,13 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class MonthField < DatetimeField # :nodoc: - private - - def format_date(value) - value.try(:strftime, "%Y-%m") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/number_field.rb b/actionpack/lib/action_view/helpers/tags/number_field.rb deleted file mode 100644 index 4f95b1b4de..0000000000 --- a/actionpack/lib/action_view/helpers/tags/number_field.rb +++ /dev/null @@ -1,18 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class NumberField < TextField # :nodoc: - def render - options = @options.stringify_keys - - if range = options.delete("in") || options.delete("within") - options.update("min" => range.min, "max" => range.max) - end - - @options = options - super - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/password_field.rb b/actionpack/lib/action_view/helpers/tags/password_field.rb deleted file mode 100644 index 6099fa6f19..0000000000 --- a/actionpack/lib/action_view/helpers/tags/password_field.rb +++ /dev/null @@ -1,12 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class PasswordField < TextField # :nodoc: - def render - @options = {:value => nil}.merge!(@options) - super - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/radio_button.rb b/actionpack/lib/action_view/helpers/tags/radio_button.rb deleted file mode 100644 index 4849c537a5..0000000000 --- a/actionpack/lib/action_view/helpers/tags/radio_button.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'action_view/helpers/tags/checkable' - -module ActionView - module Helpers - module Tags # :nodoc: - class RadioButton < Base # :nodoc: - include Checkable - - def initialize(object_name, method_name, template_object, tag_value, options) - @tag_value = tag_value - super(object_name, method_name, template_object, options) - end - - def render - options = @options.stringify_keys - options["type"] = "radio" - options["value"] = @tag_value - options["checked"] = "checked" if input_checked?(object, options) - add_default_name_and_id_for_value(@tag_value, options) - tag("input", options) - end - - private - - def checked?(value) - value.to_s == @tag_value.to_s - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/range_field.rb b/actionpack/lib/action_view/helpers/tags/range_field.rb deleted file mode 100644 index f98ae88043..0000000000 --- a/actionpack/lib/action_view/helpers/tags/range_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class RangeField < NumberField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/search_field.rb b/actionpack/lib/action_view/helpers/tags/search_field.rb deleted file mode 100644 index c09e2f1be7..0000000000 --- a/actionpack/lib/action_view/helpers/tags/search_field.rb +++ /dev/null @@ -1,24 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class SearchField < TextField # :nodoc: - def render - options = @options.stringify_keys - - if options["autosave"] - if options["autosave"] == true - options["autosave"] = request.host.split(".").reverse.join(".") - end - options["results"] ||= 10 - end - - if options["onsearch"] - options["incremental"] = true unless options.has_key?("incremental") - end - - super - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/select.rb b/actionpack/lib/action_view/helpers/tags/select.rb deleted file mode 100644 index d64e2f68ef..0000000000 --- a/actionpack/lib/action_view/helpers/tags/select.rb +++ /dev/null @@ -1,40 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class Select < Base # :nodoc: - def initialize(object_name, method_name, template_object, choices, options, html_options) - @choices = choices - @choices = @choices.to_a if @choices.is_a?(Range) - @html_options = html_options - - super(object_name, method_name, template_object, options) - end - - def render - option_tags_options = { - :selected => @options.fetch(:selected) { value(@object) }, - :disabled => @options[:disabled] - } - - option_tags = if grouped_choices? - grouped_options_for_select(@choices, option_tags_options) - else - options_for_select(@choices, option_tags_options) - end - - select_content_tag(option_tags, @options, @html_options) - end - - private - - # Grouped choices look like this: - # - # [nil, []] - # { nil => [] } - def grouped_choices? - !@choices.empty? && @choices.first.respond_to?(:last) && Array === @choices.first.last - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/tel_field.rb b/actionpack/lib/action_view/helpers/tags/tel_field.rb deleted file mode 100644 index 987bb9e67a..0000000000 --- a/actionpack/lib/action_view/helpers/tags/tel_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TelField < TextField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/text_area.rb b/actionpack/lib/action_view/helpers/tags/text_area.rb deleted file mode 100644 index c81156c0c8..0000000000 --- a/actionpack/lib/action_view/helpers/tags/text_area.rb +++ /dev/null @@ -1,18 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TextArea < Base # :nodoc: - def render - options = @options.stringify_keys - add_default_name_and_id(options) - - if size = options.delete("size") - options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split) - end - - content_tag("textarea", options.delete('value') || value_before_type_cast(object), options) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/text_field.rb b/actionpack/lib/action_view/helpers/tags/text_field.rb deleted file mode 100644 index baa5ff768e..0000000000 --- a/actionpack/lib/action_view/helpers/tags/text_field.rb +++ /dev/null @@ -1,29 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TextField < Base # :nodoc: - def render - options = @options.stringify_keys - options["size"] = options["maxlength"] unless options.key?("size") - options["type"] ||= field_type - options["value"] = options.fetch("value"){ value_before_type_cast(object) } unless field_type == "file" - options["value"] &&= ERB::Util.html_escape(options["value"]) - add_default_name_and_id(options) - tag("input", options) - end - - class << self - def field_type - @field_type ||= self.name.split("::").last.sub("Field", "").downcase - end - end - - private - - def field_type - self.class.field_type - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/time_field.rb b/actionpack/lib/action_view/helpers/tags/time_field.rb deleted file mode 100644 index 0e90a3aed7..0000000000 --- a/actionpack/lib/action_view/helpers/tags/time_field.rb +++ /dev/null @@ -1,13 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TimeField < DatetimeField # :nodoc: - private - - def format_date(value) - value.try(:strftime, "%T.%L") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/time_select.rb b/actionpack/lib/action_view/helpers/tags/time_select.rb deleted file mode 100644 index 0b06311d25..0000000000 --- a/actionpack/lib/action_view/helpers/tags/time_select.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TimeSelect < DateSelect # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/time_zone_select.rb b/actionpack/lib/action_view/helpers/tags/time_zone_select.rb deleted file mode 100644 index 80d165ec7e..0000000000 --- a/actionpack/lib/action_view/helpers/tags/time_zone_select.rb +++ /dev/null @@ -1,20 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class TimeZoneSelect < Base # :nodoc: - def initialize(object_name, method_name, template_object, priority_zones, options, html_options) - @priority_zones = priority_zones - @html_options = html_options - - super(object_name, method_name, template_object, options) - end - - def render - select_content_tag( - time_zone_options_for_select(value(@object) || @options[:default], @priority_zones, @options[:model] || ActiveSupport::TimeZone), @options, @html_options - ) - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/url_field.rb b/actionpack/lib/action_view/helpers/tags/url_field.rb deleted file mode 100644 index d76340178d..0000000000 --- a/actionpack/lib/action_view/helpers/tags/url_field.rb +++ /dev/null @@ -1,8 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class UrlField < TextField # :nodoc: - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/tags/week_field.rb b/actionpack/lib/action_view/helpers/tags/week_field.rb deleted file mode 100644 index 5b3d0494e9..0000000000 --- a/actionpack/lib/action_view/helpers/tags/week_field.rb +++ /dev/null @@ -1,13 +0,0 @@ -module ActionView - module Helpers - module Tags # :nodoc: - class WeekField < DatetimeField # :nodoc: - private - - def format_date(value) - value.try(:strftime, "%Y-W%W") - end - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/text_helper.rb b/actionpack/lib/action_view/helpers/text_helper.rb deleted file mode 100644 index 147f9fd8ed..0000000000 --- a/actionpack/lib/action_view/helpers/text_helper.rb +++ /dev/null @@ -1,442 +0,0 @@ -require 'active_support/core_ext/string/filters' -require 'active_support/core_ext/array/extract_options' - -module ActionView - # = Action View Text Helpers - module Helpers #:nodoc: - # The TextHelper module provides a set of methods for filtering, formatting - # and transforming strings, which can reduce the amount of inline Ruby code in - # your views. These helper methods extend Action View making them callable - # within your template files. - # - # ==== Sanitization - # - # Most text helpers by default sanitize the given content, but do not escape it. - # This means HTML tags will appear in the page but all malicious code will be removed. - # Let's look at some examples using the +simple_format+ method: - # - # simple_format('<a href="http://example.com/">Example</a>') - # # => "<p><a href=\"http://example.com/\">Example</a></p>" - # - # simple_format('<a href="javascript:alert(\'no!\')">Example</a>') - # # => "<p><a>Example</a></p>" - # - # If you want to escape all content, you should invoke the +h+ method before - # calling the text helper. - # - # simple_format h('<a href="http://example.com/">Example</a>') - # # => "<p><a href=\"http://example.com/\">Example</a></p>" - module TextHelper - extend ActiveSupport::Concern - - include SanitizeHelper - include TagHelper - # The preferred method of outputting text in your views is to use the - # <%= "text" %> eRuby syntax. The regular _puts_ and _print_ methods - # do not operate as expected in an eRuby code block. If you absolutely must - # output text within a non-output code block (i.e., <% %>), you can use the concat method. - # - # <% - # concat "hello" - # # is the equivalent of <%= "hello" %> - # - # if logged_in - # concat "Logged in!" - # else - # concat link_to('login', action: :login) - # end - # # will either display "Logged in!" or a login link - # %> - def concat(string) - output_buffer << string - end - - def safe_concat(string) - output_buffer.respond_to?(:safe_concat) ? output_buffer.safe_concat(string) : concat(string) - end - - # Truncates a given +text+ after a given <tt>:length</tt> if +text+ is longer than <tt>:length</tt> - # (defaults to 30). The last characters will be replaced with the <tt>:omission</tt> (defaults to "...") - # for a total length not exceeding <tt>:length</tt>. - # - # Pass a <tt>:separator</tt> to truncate +text+ at a natural break. - # - # Pass a block if you want to show extra content when the text is truncated. - # - # The result is marked as HTML-safe, but it is escaped by default, unless <tt>:escape</tt> is - # +false+. Care should be taken if +text+ contains HTML tags or entities, because truncation - # may produce invalid HTML (such as unbalanced or incomplete tags). - # - # truncate("Once upon a time in a world far far away") - # # => "Once upon a time in a world..." - # - # truncate("Once upon a time in a world far far away", length: 17) - # # => "Once upon a ti..." - # - # truncate("Once upon a time in a world far far away", length: 17, separator: ' ') - # # => "Once upon a..." - # - # truncate("And they found that many people were sleeping better.", length: 25, omission: '... (continued)') - # # => "And they f... (continued)" - # - # truncate("<p>Once upon a time in a world far far away</p>") - # # => "<p>Once upon a time in a wo..." - # - # truncate("Once upon a time in a world far far away") { link_to "Continue", "#" } - # # => "Once upon a time in a wo...<a href="#">Continue</a>" - def truncate(text, options = {}, &block) - if text - length = options.fetch(:length, 30) - - content = text.truncate(length, options) - content = options[:escape] == false ? content.html_safe : ERB::Util.html_escape(content) - content << capture(&block) if block_given? && text.length > length - content - end - end - - # Highlights one or more +phrases+ everywhere in +text+ by inserting it into - # a <tt>:highlighter</tt> string. The highlighter can be specialized by passing <tt>:highlighter</tt> - # as a single-quoted string with <tt>\1</tt> where the phrase is to be inserted (defaults to - # '<mark>\1</mark>') - # - # highlight('You searched for: rails', 'rails') - # # => You searched for: <mark>rails</mark> - # - # highlight('You searched for: ruby, rails, dhh', 'actionpack') - # # => You searched for: ruby, rails, dhh - # - # highlight('You searched for: rails', ['for', 'rails'], highlighter: '<em>\1</em>') - # # => You searched <em>for</em>: <em>rails</em> - # - # highlight('You searched for: rails', 'rails', highlighter: '<a href="search?q=\1">\1</a>') - # # => You searched for: <a href="search?q=rails">rails</a> - def highlight(text, phrases, options = {}) - text = sanitize(text) if options.fetch(:sanitize, true) - - if text.blank? || phrases.blank? - text - else - highlighter = options.fetch(:highlighter, '<mark>\1</mark>') - match = Array(phrases).map { |p| Regexp.escape(p) }.join('|') - text.gsub(/(#{match})(?![^<]*?>)/i, highlighter) - end.html_safe - end - - # Extracts an excerpt from +text+ that matches the first instance of +phrase+. - # The <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters - # defined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+, - # then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. Use the - # <tt>:separator</tt> option to choose the delimitation. The resulting string will be stripped in any case. If the +phrase+ - # isn't found, nil is returned. - # - # excerpt('This is an example', 'an', radius: 5) - # # => ...s is an exam... - # - # excerpt('This is an example', 'is', radius: 5) - # # => This is a... - # - # excerpt('This is an example', 'is') - # # => This is an example - # - # excerpt('This next thing is an example', 'ex', radius: 2) - # # => ...next... - # - # excerpt('This is also an example', 'an', radius: 8, omission: '<chop> ') - # # => <chop> is also an example - # - # excerpt('This is a very beautiful morning', 'very', separator: ' ', radius: 1) - # # => ...a very beautiful... - def excerpt(text, phrase, options = {}) - return unless text && phrase - - separator = options.fetch(:separator, "") - phrase = Regexp.escape(phrase) - regex = /#{phrase}/i - - return unless matches = text.match(regex) - phrase = matches[0] - - text.split(separator).each do |value| - if value.match(regex) - regex = phrase = value - break - end - end - - first_part, second_part = text.split(regex, 2) - - prefix, first_part = cut_excerpt_part(:first, first_part, separator, options) - postfix, second_part = cut_excerpt_part(:second, second_part, separator, options) - - prefix + (first_part + separator + phrase + separator + second_part).strip + postfix - end - - # Attempts to pluralize the +singular+ word unless +count+ is 1. If - # +plural+ is supplied, it will use that when count is > 1, otherwise - # it will use the Inflector to determine the plural form. - # - # pluralize(1, 'person') - # # => 1 person - # - # pluralize(2, 'person') - # # => 2 people - # - # pluralize(3, 'person', 'users') - # # => 3 users - # - # pluralize(0, 'person') - # # => 0 people - def pluralize(count, singular, plural = nil) - word = if (count == 1 || count =~ /^1(\.0+)?$/) - singular - else - plural || singular.pluralize - end - - "#{count || 0} #{word}" - end - - # Wraps the +text+ into lines no longer than +line_width+ width. This method - # breaks on the first whitespace character that does not exceed +line_width+ - # (which is 80 by default). - # - # word_wrap('Once upon a time') - # # => Once upon a time - # - # word_wrap('Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding a successor to the throne turned out to be more trouble than anyone could have imagined...') - # # => Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding\na successor to the throne turned out to be more trouble than anyone could have\nimagined... - # - # word_wrap('Once upon a time', line_width: 8) - # # => Once\nupon a\ntime - # - # word_wrap('Once upon a time', line_width: 1) - # # => Once\nupon\na\ntime - def word_wrap(text, options = {}) - line_width = options.fetch(:line_width, 80) - - text.split("\n").collect do |line| - line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line - end * "\n" - end - - # Returns +text+ transformed into HTML using simple formatting rules. - # Two or more consecutive newlines(<tt>\n\n</tt>) are considered as a - # paragraph and wrapped in <tt><p></tt> tags. One newline (<tt>\n</tt>) is - # considered as a linebreak and a <tt><br /></tt> tag is appended. This - # method does not remove the newlines from the +text+. - # - # You can pass any HTML attributes into <tt>html_options</tt>. These - # will be added to all created paragraphs. - # - # ==== Options - # * <tt>:sanitize</tt> - If +false+, does not sanitize +text+. - # * <tt>:wrapper_tag</tt> - String representing the wrapper tag, defaults to <tt>"p"</tt> - # - # ==== Examples - # my_text = "Here is some basic text...\n...with a line break." - # - # simple_format(my_text) - # # => "<p>Here is some basic text...\n<br />...with a line break.</p>" - # - # simple_format(my_text, {}, wrapper_tag: "div") - # # => "<div>Here is some basic text...\n<br />...with a line break.</div>" - # - # more_text = "We want to put a paragraph...\n\n...right there." - # - # simple_format(more_text) - # # => "<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>" - # - # simple_format("Look ma! A class!", class: 'description') - # # => "<p class='description'>Look ma! A class!</p>" - # - # simple_format("<blink>Unblinkable.</blink>") - # # => "<p>Unblinkable.</p>" - # - # simple_format("<blink>Blinkable!</blink> It's true.", {}, sanitize: false) - # # => "<p><blink>Blinkable!</span> It's true.</p>" - def simple_format(text, html_options = {}, options = {}) - wrapper_tag = options.fetch(:wrapper_tag, :p) - - text = sanitize(text) if options.fetch(:sanitize, true) - paragraphs = split_paragraphs(text) - - if paragraphs.empty? - content_tag(wrapper_tag, nil, html_options) - else - paragraphs.map { |paragraph| - content_tag(wrapper_tag, paragraph, html_options, options[:sanitize]) - }.join("\n\n").html_safe - end - end - - # Creates a Cycle object whose _to_s_ method cycles through elements of an - # array every time it is called. This can be used for example, to alternate - # classes for table rows. You can use named cycles to allow nesting in loops. - # Passing a Hash as the last parameter with a <tt>:name</tt> key will create a - # named cycle. The default name for a cycle without a +:name+ key is - # <tt>"default"</tt>. You can manually reset a cycle by calling reset_cycle - # and passing the name of the cycle. The current cycle string can be obtained - # anytime using the current_cycle method. - # - # # Alternate CSS classes for even and odd numbers... - # @items = [1,2,3,4] - # <table> - # <% @items.each do |item| %> - # <tr class="<%= cycle("odd", "even") -%>"> - # <td>item</td> - # </tr> - # <% end %> - # </table> - # - # - # # Cycle CSS classes for rows, and text colors for values within each row - # @items = x = [{first: 'Robert', middle: 'Daniel', last: 'James'}, - # {first: 'Emily', middle: 'Shannon', maiden: 'Pike', last: 'Hicks'}, - # {first: 'June', middle: 'Dae', last: 'Jones'}] - # <% @items.each do |item| %> - # <tr class="<%= cycle("odd", "even", name: "row_class") -%>"> - # <td> - # <% item.values.each do |value| %> - # <%# Create a named cycle "colors" %> - # <span style="color:<%= cycle("red", "green", "blue", name: "colors") -%>"> - # <%= value %> - # </span> - # <% end %> - # <% reset_cycle("colors") %> - # </td> - # </tr> - # <% end %> - def cycle(first_value, *values) - options = values.extract_options! - name = options.fetch(:name, 'default') - - values.unshift(first_value) - - cycle = get_cycle(name) - unless cycle && cycle.values == values - cycle = set_cycle(name, Cycle.new(*values)) - end - cycle.to_s - end - - # Returns the current cycle string after a cycle has been started. Useful - # for complex table highlighting or any other design need which requires - # the current cycle string in more than one place. - # - # # Alternate background colors - # @items = [1,2,3,4] - # <% @items.each do |item| %> - # <div style="background-color:<%= cycle("red","white","blue") %>"> - # <span style="background-color:<%= current_cycle %>"><%= item %></span> - # </div> - # <% end %> - def current_cycle(name = "default") - cycle = get_cycle(name) - cycle.current_value if cycle - end - - # Resets a cycle so that it starts from the first element the next time - # it is called. Pass in +name+ to reset a named cycle. - # - # # Alternate CSS classes for even and odd numbers... - # @items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]] - # <table> - # <% @items.each do |item| %> - # <tr class="<%= cycle("even", "odd") -%>"> - # <% item.each do |value| %> - # <span style="color:<%= cycle("#333", "#666", "#999", name: "colors") -%>"> - # <%= value %> - # </span> - # <% end %> - # - # <% reset_cycle("colors") %> - # </tr> - # <% end %> - # </table> - def reset_cycle(name = "default") - cycle = get_cycle(name) - cycle.reset if cycle - end - - class Cycle #:nodoc: - attr_reader :values - - def initialize(first_value, *values) - @values = values.unshift(first_value) - reset - end - - def reset - @index = 0 - end - - def current_value - @values[previous_index].to_s - end - - def to_s - value = @values[@index].to_s - @index = next_index - return value - end - - private - - def next_index - step_index(1) - end - - def previous_index - step_index(-1) - end - - def step_index(n) - (@index + n) % @values.size - end - end - - private - # The cycle helpers need to store the cycles in a place that is - # guaranteed to be reset every time a page is rendered, so it - # uses an instance variable of ActionView::Base. - def get_cycle(name) - @_cycles = Hash.new unless defined?(@_cycles) - return @_cycles[name] - end - - def set_cycle(name, cycle_object) - @_cycles = Hash.new unless defined?(@_cycles) - @_cycles[name] = cycle_object - end - - def split_paragraphs(text) - return [] if text.blank? - - text.to_str.gsub(/\r\n?/, "\n").split(/\n\n+/).map! do |t| - t.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') || t - end - end - - def cut_excerpt_part(part_position, part, separator, options) - return "", "" unless part - - radius = options.fetch(:radius, 100) - omission = options.fetch(:omission, "...") - - part = part.split(separator) - part.delete("") - affix = part.size > radius ? omission : "" - - part = if part_position == :first - drop_index = [part.length - radius, 0].max - part.drop(drop_index) - else - part.first(radius) - end - - return affix, part.join(separator) - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/translation_helper.rb b/actionpack/lib/action_view/helpers/translation_helper.rb deleted file mode 100644 index ad8eb47f1f..0000000000 --- a/actionpack/lib/action_view/helpers/translation_helper.rb +++ /dev/null @@ -1,107 +0,0 @@ -require 'action_view/helpers/tag_helper' -require 'i18n/exceptions' - -module I18n - class ExceptionHandler - include Module.new { - def call(exception, locale, key, options) - exception.is_a?(MissingTranslation) && options[:rescue_format] == :html ? super.html_safe : super - end - } - end -end - -module ActionView - # = Action View Translation Helpers - module Helpers - module TranslationHelper - # Delegates to <tt>I18n#translate</tt> but also performs three additional functions. - # - # First, it'll pass the <tt>rescue_format: :html</tt> option to I18n so that any - # thrown +MissingTranslation+ messages will be turned into inline spans that - # - # * have a "translation-missing" class set, - # * contain the missing key as a title attribute and - # * a titleized version of the last key segment as a text. - # - # E.g. the value returned for a missing translation key :"blog.post.title" will be - # <span class="translation_missing" title="translation missing: en.blog.post.title">Title</span>. - # This way your views will display rather reasonable strings but it will still - # be easy to spot missing translations. - # - # Second, it'll scope the key by the current partial if the key starts - # with a period. So if you call <tt>translate(".foo")</tt> from the - # <tt>people/index.html.erb</tt> template, you'll actually be calling - # <tt>I18n.translate("people.index.foo")</tt>. This makes it less repetitive - # to translate many keys within the same partials and gives you a simple framework - # for scoping them consistently. If you don't prepend the key with a period, - # nothing is converted. - # - # Third, it'll mark the translation as safe HTML if the key has the suffix - # "_html" or the last element of the key is the word "html". For example, - # calling translate("footer_html") or translate("footer.html") will return - # a safe HTML string that won't be escaped by other HTML helper methods. This - # naming convention helps to identify translations that include HTML tags so that - # you know what kind of output to expect when you call translate in a template. - def translate(key, options = {}) - options.merge!(:rescue_format => :html) unless options.key?(:rescue_format) - options[:default] = wrap_translate_defaults(options[:default]) if options[:default] - if html_safe_translation_key?(key) - html_safe_options = options.dup - options.except(*I18n::RESERVED_KEYS).each do |name, value| - unless name == :count && value.is_a?(Numeric) - html_safe_options[name] = ERB::Util.html_escape(value.to_s) - end - end - translation = I18n.translate(scope_key_by_partial(key), html_safe_options) - - translation.respond_to?(:html_safe) ? translation.html_safe : translation - else - I18n.translate(scope_key_by_partial(key), options) - end - end - alias :t :translate - - # Delegates to <tt>I18n.localize</tt> with no additional functionality. - # - # See http://rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/Base:localize - # for more information. - def localize(*args) - I18n.localize(*args) - end - alias :l :localize - - private - def scope_key_by_partial(key) - if key.to_s.first == "." - if @virtual_path - @virtual_path.gsub(%r{/_?}, ".") + key.to_s - else - raise "Cannot use t(#{key.inspect}) shortcut because path is not available" - end - else - key - end - end - - def html_safe_translation_key?(key) - key.to_s =~ /(\b|_|\.)html$/ - end - - def wrap_translate_defaults(defaults) - new_defaults = [] - defaults = Array(defaults) - while key = defaults.shift - if key.is_a?(Symbol) - new_defaults << lambda { |_, options| translate key, options.merge(:default => defaults) } - break - else - new_defaults << key - end - end - - new_defaults - end - end - end -end diff --git a/actionpack/lib/action_view/helpers/url_helper.rb b/actionpack/lib/action_view/helpers/url_helper.rb deleted file mode 100644 index 19e5941971..0000000000 --- a/actionpack/lib/action_view/helpers/url_helper.rb +++ /dev/null @@ -1,616 +0,0 @@ -require 'action_view/helpers/javascript_helper' -require 'active_support/core_ext/array/access' -require 'active_support/core_ext/hash/keys' -require 'active_support/core_ext/string/output_safety' - -module ActionView - # = Action View URL Helpers - module Helpers #:nodoc: - # Provides a set of methods for making links and getting URLs that - # depend on the routing subsystem (see ActionDispatch::Routing). - # This allows you to use the same format for links in views - # and controllers. - module UrlHelper - # This helper may be included in any class that includes the - # URL helpers of a routes (routes.url_helpers). Some methods - # provided here will only work in the context of a request - # (link_to_unless_current, for instance), which must be provided - # as a method called #request on the context. - - extend ActiveSupport::Concern - - include TagHelper - - module ClassMethods - def _url_for_modules - ActionView::RoutingUrlFor - end - end - - # Basic implementation of url_for to allow use helpers without routes existence - def url_for(options = nil) # :nodoc: - case options - when String - options - when :back - _back_url - else - raise ArgumentError, "arguments passed to url_for can't be handled. Please require " + - "routes or provide your own implementation" - end - end - - def _back_url # :nodoc: - referrer = controller.respond_to?(:request) && controller.request.env["HTTP_REFERER"] - referrer || 'javascript:history.back()' - end - protected :_back_url - - # Creates a link tag of the given +name+ using a URL created by the set of +options+. - # See the valid options in the documentation for +url_for+. It's also possible to - # pass a String instead of an options hash, which generates a link tag that uses the - # value of the String as the href for the link. Using a <tt>:back</tt> Symbol instead - # of an options hash will generate a link to the referrer (a JavaScript back link - # will be used in place of a referrer if none exists). If +nil+ is passed as the name - # the value of the link itself will become the name. - # - # ==== Signatures - # - # link_to(body, url, html_options = {}) - # # url is a String; you can use URL helpers like - # # posts_path - # - # link_to(body, url_options = {}, html_options = {}) - # # url_options, except :method, is passed to url_for - # - # link_to(options = {}, html_options = {}) do - # # name - # end - # - # link_to(url, html_options = {}) do - # # name - # end - # - # ==== Options - # * <tt>:data</tt> - This option can be used to add custom data attributes. - # * <tt>method: symbol of HTTP verb</tt> - This modifier will dynamically - # create an HTML form and immediately submit the form for processing using - # the HTTP verb specified. Useful for having links perform a POST operation - # in dangerous actions like deleting a record (which search bots can follow - # while spidering your site). Supported verbs are <tt>:post</tt>, <tt>:delete</tt>, <tt>:patch</tt>, and <tt>:put</tt>. - # Note that if the user has JavaScript disabled, the request will fall back - # to using GET. If <tt>href: '#'</tt> is used and the user has JavaScript - # disabled clicking the link will have no effect. If you are relying on the - # POST behavior, you should check for it in your controller's action by using - # the request object's methods for <tt>post?</tt>, <tt>delete?</tt>, <tt>:patch</tt>, or <tt>put?</tt>. - # * <tt>remote: true</tt> - This will allow the unobtrusive JavaScript - # driver to make an Ajax request to the URL in question instead of following - # the link. The drivers each provide mechanisms for listening for the - # completion of the Ajax request and performing JavaScript operations once - # they're complete - # - # ==== Data attributes - # - # * <tt>confirm: 'question?'</tt> - This will allow the unobtrusive JavaScript - # driver to prompt with the question specified. If the user accepts, the link is - # processed normally, otherwise no action is taken. - # * <tt>:disable_with</tt> - Value of this parameter will be - # used as the value for a disabled version of the submit - # button when the form is submitted. This feature is provided - # by the unobtrusive JavaScript driver. - # - # ==== Examples - # Because it relies on +url_for+, +link_to+ supports both older-style controller/action/id arguments - # and newer RESTful routes. Current Rails style favors RESTful routes whenever possible, so base - # your application on resources and use - # - # link_to "Profile", profile_path(@profile) - # # => <a href="/profiles/1">Profile</a> - # - # or the even pithier - # - # link_to "Profile", @profile - # # => <a href="/profiles/1">Profile</a> - # - # in place of the older more verbose, non-resource-oriented - # - # link_to "Profile", controller: "profiles", action: "show", id: @profile - # # => <a href="/profiles/show/1">Profile</a> - # - # Similarly, - # - # link_to "Profiles", profiles_path - # # => <a href="/profiles">Profiles</a> - # - # is better than - # - # link_to "Profiles", controller: "profiles" - # # => <a href="/profiles">Profiles</a> - # - # You can use a block as well if your link target is hard to fit into the name parameter. ERB example: - # - # <%= link_to(@profile) do %> - # <strong><%= @profile.name %></strong> -- <span>Check it out!</span> - # <% end %> - # # => <a href="/profiles/1"> - # <strong>David</strong> -- <span>Check it out!</span> - # </a> - # - # Classes and ids for CSS are easy to produce: - # - # link_to "Articles", articles_path, id: "news", class: "article" - # # => <a href="/articles" class="article" id="news">Articles</a> - # - # Be careful when using the older argument style, as an extra literal hash is needed: - # - # link_to "Articles", { controller: "articles" }, id: "news", class: "article" - # # => <a href="/articles" class="article" id="news">Articles</a> - # - # Leaving the hash off gives the wrong link: - # - # link_to "WRONG!", controller: "articles", id: "news", class: "article" - # # => <a href="/articles/index/news?class=article">WRONG!</a> - # - # +link_to+ can also produce links with anchors or query strings: - # - # link_to "Comment wall", profile_path(@profile, anchor: "wall") - # # => <a href="/profiles/1#wall">Comment wall</a> - # - # link_to "Ruby on Rails search", controller: "searches", query: "ruby on rails" - # # => <a href="/searches?query=ruby+on+rails">Ruby on Rails search</a> - # - # link_to "Nonsense search", searches_path(foo: "bar", baz: "quux") - # # => <a href="/searches?foo=bar&baz=quux">Nonsense search</a> - # - # The only option specific to +link_to+ (<tt>:method</tt>) is used as follows: - # - # link_to("Destroy", "http://www.example.com", method: :delete) - # # => <a href='http://www.example.com' rel="nofollow" data-method="delete">Destroy</a> - # - # You can also use custom data attributes using the <tt>:data</tt> option: - # - # link_to "Visit Other Site", "http://www.rubyonrails.org/", data: { confirm: "Are you sure?" } - # # => <a href="http://www.rubyonrails.org/" data-confirm="Are you sure?">Visit Other Site</a> - def link_to(name = nil, options = nil, html_options = nil, &block) - html_options, options = options, name if block_given? - options ||= {} - - html_options = convert_options_to_data_attributes(options, html_options) - - url = url_for(options) - html_options['href'] ||= url - - content_tag(:a, name || url, html_options, &block) - end - - # Generates a form containing a single button that submits to the URL created - # by the set of +options+. This is the safest method to ensure links that - # cause changes to your data are not triggered by search bots or accelerators. - # If the HTML button does not work with your layout, you can also consider - # using the +link_to+ method with the <tt>:method</tt> modifier as described in - # the +link_to+ documentation. - # - # By default, the generated form element has a class name of <tt>button_to</tt> - # to allow styling of the form itself and its children. This can be changed - # using the <tt>:form_class</tt> modifier within +html_options+. You can control - # the form submission and input element behavior using +html_options+. - # This method accepts the <tt>:method</tt> modifier described in the +link_to+ documentation. - # If no <tt>:method</tt> modifier is given, it will default to performing a POST operation. - # You can also disable the button by passing <tt>disabled: true</tt> in +html_options+. - # If you are using RESTful routes, you can pass the <tt>:method</tt> - # to change the HTTP verb used to submit the form. - # - # ==== Options - # The +options+ hash accepts the same options as +url_for+. - # - # There are a few special +html_options+: - # * <tt>:method</tt> - Symbol of HTTP verb. Supported verbs are <tt>:post</tt>, <tt>:get</tt>, - # <tt>:delete</tt>, <tt>:patch</tt>, and <tt>:put</tt>. By default it will be <tt>:post</tt>. - # * <tt>:disabled</tt> - If set to true, it will generate a disabled button. - # * <tt>:data</tt> - This option can be used to add custom data attributes. - # * <tt>:remote</tt> - If set to true, will allow the Unobtrusive JavaScript drivers to control the - # submit behavior. By default this behavior is an ajax submit. - # * <tt>:form</tt> - This hash will be form attributes - # * <tt>:form_class</tt> - This controls the class of the form within which the submit button will - # be placed - # - # ==== Data attributes - # - # * <tt>:confirm</tt> - This will use the unobtrusive JavaScript driver to - # prompt with the question specified. If the user accepts, the link is - # processed normally, otherwise no action is taken. - # * <tt>:disable_with</tt> - Value of this parameter will be - # used as the value for a disabled version of the submit - # button when the form is submitted. This feature is provided - # by the unobtrusive JavaScript driver. - # - # ==== Examples - # <%= button_to "New", action: "new" %> - # # => "<form method="post" action="/controller/new" class="button_to"> - # # <div><input value="New" type="submit" /></div> - # # </form>" - # - # <%= button_to [:make_happy, @user] do %> - # Make happy <strong><%= @user.name %></strong> - # <% end %> - # # => "<form method="post" action="/users/1/make_happy" class="button_to"> - # # <div> - # # <button type="submit"> - # # Make happy <strong><%= @user.name %></strong> - # # </button> - # # </div> - # # </form>" - # - # <%= button_to "New", { action: "new" }, form_class: "new-thing" %> - # # => "<form method="post" action="/controller/new" class="new-thing"> - # # <div><input value="New" type="submit" /></div> - # # </form>" - # - # - # <%= button_to "Create", { action: "create" }, remote: true, form: { "data-type" => "json" } %> - # # => "<form method="post" action="/images/create" class="button_to" data-remote="true" data-type="json"> - # # <div> - # # <input value="Create" type="submit" /> - # # <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/> - # # </div> - # # </form>" - # - # - # <%= button_to "Delete Image", { action: "delete", id: @image.id }, - # method: :delete, data: { confirm: "Are you sure?" } %> - # # => "<form method="post" action="/images/delete/1" class="button_to"> - # # <div> - # # <input type="hidden" name="_method" value="delete" /> - # # <input data-confirm='Are you sure?' value="Delete Image" type="submit" /> - # # <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/> - # # </div> - # # </form>" - # - # - # <%= button_to('Destroy', 'http://www.example.com', - # method: "delete", remote: true, data: { confirm: 'Are you sure?', disable_with: 'loading...' }) %> - # # => "<form class='button_to' method='post' action='http://www.example.com' data-remote='true'> - # # <div> - # # <input name='_method' value='delete' type='hidden' /> - # # <input value='Destroy' type='submit' data-disable-with='loading...' data-confirm='Are you sure?' /> - # # <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/> - # # </div> - # # </form>" - # # - def button_to(name = nil, options = nil, html_options = nil, &block) - html_options, options = options, name if block_given? - options ||= {} - html_options ||= {} - - html_options = html_options.stringify_keys - convert_boolean_attributes!(html_options, %w(disabled)) - - url = options.is_a?(String) ? options : url_for(options) - remote = html_options.delete('remote') - - method = html_options.delete('method').to_s - method_tag = %w{patch put delete}.include?(method) ? method_tag(method) : ''.html_safe - - form_method = method == 'get' ? 'get' : 'post' - form_options = html_options.delete('form') || {} - form_options[:class] ||= html_options.delete('form_class') || 'button_to' - form_options.merge!(method: form_method, action: url) - form_options.merge!("data-remote" => "true") if remote - - request_token_tag = form_method == 'post' ? token_tag : '' - - html_options = convert_options_to_data_attributes(options, html_options) - html_options['type'] = 'submit' - - button = if block_given? - content_tag('button', html_options, &block) - else - html_options['value'] = name || url - tag('input', html_options) - end - - inner_tags = method_tag.safe_concat(button).safe_concat(request_token_tag) - content_tag('form', content_tag('div', inner_tags), form_options) - end - - # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ unless the current request URI is the same as the links, in - # which case only the name is returned (or the given block is yielded, if - # one exists). You can give +link_to_unless_current+ a block which will - # specialize the default behavior (e.g., show a "Start Here" link rather - # than the link's text). - # - # ==== Examples - # Let's say you have a navigation menu... - # - # <ul id="navbar"> - # <li><%= link_to_unless_current("Home", { action: "index" }) %></li> - # <li><%= link_to_unless_current("About Us", { action: "about" }) %></li> - # </ul> - # - # If in the "about" action, it will render... - # - # <ul id="navbar"> - # <li><a href="/controller/index">Home</a></li> - # <li>About Us</li> - # </ul> - # - # ...but if in the "index" action, it will render: - # - # <ul id="navbar"> - # <li>Home</li> - # <li><a href="/controller/about">About Us</a></li> - # </ul> - # - # The implicit block given to +link_to_unless_current+ is evaluated if the current - # action is the action given. So, if we had a comments page and wanted to render a - # "Go Back" link instead of a link to the comments page, we could do something like this... - # - # <%= - # link_to_unless_current("Comment", { controller: "comments", action: "new" }) do - # link_to("Go back", { controller: "posts", action: "index" }) - # end - # %> - def link_to_unless_current(name, options = {}, html_options = {}, &block) - link_to_unless current_page?(options), name, options, html_options, &block - end - - # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ unless +condition+ is true, in which case only the name is - # returned. To specialize the default behavior (i.e., show a login link rather - # than just the plaintext link text), you can pass a block that - # accepts the name or the full argument list for +link_to_unless+. - # - # ==== Examples - # <%= link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) %> - # # If the user is logged in... - # # => <a href="/controller/reply/">Reply</a> - # - # <%= - # link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) do |name| - # link_to(name, { controller: "accounts", action: "signup" }) - # end - # %> - # # If the user is logged in... - # # => <a href="/controller/reply/">Reply</a> - # # If not... - # # => <a href="/accounts/signup">Reply</a> - def link_to_unless(condition, name, options = {}, html_options = {}, &block) - if condition - if block_given? - block.arity <= 1 ? capture(name, &block) : capture(name, options, html_options, &block) - else - ERB::Util.html_escape(name) - end - else - link_to(name, options, html_options) - end - end - - # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ if +condition+ is true, otherwise only the name is - # returned. To specialize the default behavior, you can pass a block that - # accepts the name or the full argument list for +link_to_unless+ (see the examples - # in +link_to_unless+). - # - # ==== Examples - # <%= link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) %> - # # If the user isn't logged in... - # # => <a href="/sessions/new/">Login</a> - # - # <%= - # link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) do - # link_to(@current_user.login, { controller: "accounts", action: "show", id: @current_user }) - # end - # %> - # # If the user isn't logged in... - # # => <a href="/sessions/new/">Login</a> - # # If they are logged in... - # # => <a href="/accounts/show/3">my_username</a> - def link_to_if(condition, name, options = {}, html_options = {}, &block) - link_to_unless !condition, name, options, html_options, &block - end - - # Creates a mailto link tag to the specified +email_address+, which is - # also used as the name of the link unless +name+ is specified. Additional - # HTML attributes for the link can be passed in +html_options+. - # - # +mail_to+ has several methods for customizing the email itself by - # passing special keys to +html_options+. - # - # ==== Options - # * <tt>:subject</tt> - Preset the subject line of the email. - # * <tt>:body</tt> - Preset the body of the email. - # * <tt>:cc</tt> - Carbon Copy additional recipients on the email. - # * <tt>:bcc</tt> - Blind Carbon Copy additional recipients on the email. - # - # ==== Obfuscation - # Prior to Rails 4.0, +mail_to+ provided options for encoding the address - # in order to hinder email harvesters. To take advantage of these options, - # install the +actionview-encoded_mail_to+ gem. - # - # ==== Examples - # mail_to "me@domain.com" - # # => <a href="mailto:me@domain.com">me@domain.com</a> - # - # mail_to "me@domain.com", "My email" - # # => <a href="mailto:me@domain.com">My email</a> - # - # mail_to "me@domain.com", "My email", cc: "ccaddress@domain.com", - # subject: "This is an example email" - # # => <a href="mailto:me@domain.com?cc=ccaddress@domain.com&subject=This%20is%20an%20example%20email">My email</a> - # - # You can use a block as well if your link target is hard to fit into the name parameter. ERB example: - # - # <%= mail_to "me@domain.com" do %> - # <strong>Email me:</strong> <span>me@domain.com</span> - # <% end %> - # # => <a href="mailto:me@domain.com"> - # <strong>Email me:</strong> <span>me@domain.com</span> - # </a> - def mail_to(email_address, name = nil, html_options = {}, &block) - email_address = ERB::Util.html_escape(email_address) - - html_options, name = name, nil if block_given? - html_options = (html_options || {}).stringify_keys - - extras = %w{ cc bcc body subject }.map { |item| - option = html_options.delete(item) || next - "#{item}=#{Rack::Utils.escape_path(option)}" - }.compact - extras = extras.empty? ? '' : '?' + ERB::Util.html_escape(extras.join('&')) - - html_options["href"] = "mailto:#{email_address}#{extras}".html_safe - - content_tag(:a, name || email_address.html_safe, html_options, &block) - end - - # True if the current request URI was generated by the given +options+. - # - # ==== Examples - # Let's say we're in the <tt>http://www.example.com/shop/checkout?order=desc</tt> action. - # - # current_page?(action: 'process') - # # => false - # - # current_page?(controller: 'shop', action: 'checkout') - # # => true - # - # current_page?(controller: 'shop', action: 'checkout', order: 'asc') - # # => false - # - # current_page?(action: 'checkout') - # # => true - # - # current_page?(controller: 'library', action: 'checkout') - # # => false - # - # current_page?('http://www.example.com/shop/checkout') - # # => true - # - # current_page?('/shop/checkout') - # # => true - # - # Let's say we're in the <tt>http://www.example.com/shop/checkout?order=desc&page=1</tt> action. - # - # current_page?(action: 'process') - # # => false - # - # current_page?(controller: 'shop', action: 'checkout') - # # => true - # - # current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '1') - # # => true - # - # current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '2') - # # => false - # - # current_page?(controller: 'shop', action: 'checkout', order: 'desc') - # # => false - # - # current_page?(action: 'checkout') - # # => true - # - # current_page?(controller: 'library', action: 'checkout') - # # => false - # - # Let's say we're in the <tt>http://www.example.com/products</tt> action with method POST in case of invalid product. - # - # current_page?(controller: 'product', action: 'index') - # # => false - # - def current_page?(options) - unless request - raise "You cannot use helpers that need to determine the current " \ - "page unless your view context provides a Request object " \ - "in a #request method" - end - - return false unless request.get? || request.head? - - url_string = url_for(options) - - # We ignore any extra parameters in the request_uri if the - # submitted url doesn't have any either. This lets the function - # work with things like ?order=asc - request_uri = url_string.index("?") ? request.fullpath : request.path - - if url_string =~ /^\w+:\/\// - url_string == "#{request.protocol}#{request.host_with_port}#{request_uri}" - else - url_string == request_uri - end - end - - private - def convert_options_to_data_attributes(options, html_options) - if html_options - html_options = html_options.stringify_keys - html_options['data-remote'] = 'true' if link_to_remote_options?(options) || link_to_remote_options?(html_options) - - method = html_options.delete('method') - - add_method_to_attributes!(html_options, method) if method - - html_options - else - link_to_remote_options?(options) ? {'data-remote' => 'true'} : {} - end - end - - def link_to_remote_options?(options) - if options.is_a?(Hash) - options.delete('remote') || options.delete(:remote) - end - end - - def add_method_to_attributes!(html_options, method) - if method && method.to_s.downcase != "get" && html_options["rel"] !~ /nofollow/ - html_options["rel"] = "#{html_options["rel"]} nofollow".lstrip - end - html_options["data-method"] = method - end - - # Processes the +html_options+ hash, converting the boolean - # attributes from true/false form into the form required by - # HTML/XHTML. (An attribute is considered to be boolean if - # its name is listed in the given +bool_attrs+ array.) - # - # More specifically, for each boolean attribute in +html_options+ - # given as: - # - # "attr" => bool_value - # - # if the associated +bool_value+ evaluates to true, it is - # replaced with the attribute's name; otherwise the attribute is - # removed from the +html_options+ hash. (See the XHTML 1.0 spec, - # section 4.5 "Attribute Minimization" for more: - # http://www.w3.org/TR/xhtml1/#h-4.5) - # - # Returns the updated +html_options+ hash, which is also modified - # in place. - # - # Example: - # - # convert_boolean_attributes!( html_options, - # %w( checked disabled readonly ) ) - def convert_boolean_attributes!(html_options, bool_attrs) - bool_attrs.each { |x| html_options[x] = x if html_options.delete(x) } - html_options - end - - def token_tag(token=nil) - if token != false && protect_against_forgery? - token ||= form_authenticity_token - tag(:input, type: "hidden", name: request_forgery_protection_token.to_s, value: token) - else - '' - end - end - - def method_tag(method) - tag('input', type: 'hidden', name: '_method', value: method.to_s) - end - end - end -end |