method

current_page?

v8.1.1 - Show latest stable - Class: ActionView::Helpers::UrlHelper

current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs)

public

True if the current request URI was generated by the given options.

Examples

Let’s say we’re in the http://www.example.com/shop/checkout?order=desc&page=1 action.

current_page?(action: 'process')
# => false

current_page?(action: 'checkout')
# => true

current_page?(controller: 'library', action: 'checkout')
# => false

current_page?(controller: 'shop', action: 'checkout')
# => true

current_page?(controller: 'shop', action: 'checkout', order: 'asc')
# => false

current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '1')
# => true

current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '2')
# => false

current_page?('http://www.example.com/shop/checkout')
# => true

current_page?('http://www.example.com/shop/checkout', check_parameters: true)
# => false

current_page?('/shop/checkout')
# => true

current_page?('http://www.example.com/shop/checkout?order=desc&page=1')
# => true

Different actions may share the same URL path but have a different HTTP method. Let’s say we sent a POST to http://www.example.com/products and rendered a validation error.

current_page?(controller: 'product', action: 'index')
# => false

current_page?(controller: 'product', action: 'create')
# => false

current_page?(controller: 'product', action: 'create', method: :post)
# => true

current_page?(controller: 'product', action: 'index', method: [:get, :post])
# => true

We can also pass in the symbol arguments instead of strings.

# File actionview/lib/action_view/helpers/url_helper.rb, line 559
      def current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs)
        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

        if options.is_a?(Hash)
          check_parameters = options.delete(:check_parameters) { check_parameters }
          method = options.delete(:method) { method }
        else
          options ||= options_as_kwargs
        end

        method_matches = case method
        when :get
          request.get? || request.head?
        when Array
          method.include?(request.method_symbol) || (method.include?(:get) && request.head?)
        else
          method == request.method_symbol
        end
        return false unless method_matches

        url_string = URI::RFC2396_PARSER.unescape(url_for(options)).force_encoding(Encoding::BINARY)

        # 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
        # the behavior can be disabled with check_parameters: true
        request_uri = url_string.index("?") || check_parameters ? request.fullpath : request.path
        request_uri = URI::RFC2396_PARSER.unescape(request_uri).force_encoding(Encoding::BINARY)

        if %{^\w+://}.match?(url_string)
          request_uri = +"#{request.protocol}#{request.host_with_port}#{request_uri}"
        end

        remove_trailing_slash!(url_string)
        remove_trailing_slash!(request_uri)

        url_string == request_uri
      end

4Notes

/products/1

bansalakhil · Jan 16, 20097 thanks

==== Code example

current_page?(product_path(@product))
# => true

with resources

Finist · Dec 11, 20083 thanks

/products

==== current_page?(products_path) # => true

current_action? and current_controller?

qoobaa · Jan 2, 20093 thanks

I use them in link_unless_current_controller helper.

def current_action?(options)
url_string = CGI.escapeHTML(url_for(options))
params = ActionController::Routing::Routes.recognize_path(url_string, :method => :get)
params[:controller] == @controller.controller_name && params[:action] == @controller.action_name
end

def current_controller?(options)
url_string = CGI.escapeHTML(url_for(options))
params = ActionController::Routing::Routes.recognize_path(url_string, :method => :get)
params[:controller] == @controller.controller_name
end

active_link_to helper gem

tordans · Nov 4, 20111 thank

You should also have a look at https://github.com/twg/active_link_to if you need an 'active' class on your links.