RAILS 3: nav_link helper for adding 'selected' class to navigation elements

README.markdown

#Behold, the nav_link:

The nav_link helper works just like the standard Rails link_to helper, but adds a 'selected' class to your link (or its wrapper) if certain criteria are met. By default, if the link's destination url is the same url as the url of the current page, a default class of 'selected' is added to the link.

For full usage details, see: http://viget.com/extend/rails-selected-nav-link-helper

Drop nav_link_helper.rb into app/helpers in your Rails 3.x app and enjoy.

#About this fork

This particular fork allows you to pass a block to the helper method like so:

= nav_link "News", articles_path, {class: "btn btn-small"}, {selected_class: 'active'} do
  %i.icon-home

Which would create the following html:

<a href="/articles" class="btn btn-small active">
  <i class="icon-home"></i>
  News
</a>

If no block is given, then nav_link helper behaves as normal.

Yay. Thanks to Viget labs for doing all the hard-work on this.

nav_link_helper.rb

module NavLinkHelper

  def nav_link(title, path, html_options = {}, options = {}, &block)
    LinkGenerator.new(request, title, path, html_options, options, (capture(&block) if block_given?)).to_html
  end

  class LinkGenerator
    include ActionView::Helpers::UrlHelper
    # to stop "undefined method 'output_buffer='" error message when
    # passing a block to link_to later on
    include ActionView::Context

    def initialize(request, title, path, html_options = {}, options = {}, block)
      @request      = request
      @title        = title
      @path         = path
      @html_options = html_options
      @options      = options
      @block        = block unless block.nil?
    end

    def to_html
      html = link

      if @options[:wrapper]
        html = content_tag(@options[:wrapper], html, :class => wrapper_classes)
      end

      html.html_safe
    end

    private

    def current_path
      comparable_path_for(@request.fullpath)
    end

    def link_path
      comparable_path_for(url_for(@path))
    end

    def segment_position
      if @options[:controller_segment]
        @options[:controller_segment] - 1
      elsif @options[:url_segment]
        @options[:url_segment]
      end
    end

    def path_controller
      controller_for(@path)
    end

    def current_controller
      controller_for(@request.path)
    end

    def segment_for(controller, path)
      if @options[:controller_segment]
        controller.split('/')[segment_position]
      elsif @options[:url_segment]
        path.split('/')[segment_position]
      end
    end

    def path_segment
      segment_for(path_controller, current_path)
    end

    def current_segment
      segment_for(current_controller, link_path)
    end

    def paths_match?
      current_path == link_path
    end

    def segments_match?
      path_segment && path_segment == current_segment
    end

    def selected?
      paths_match? || segments_match?
    end

    def selected_class
      @options[:selected_class] || 'selected'
    end

    def link_classes
      if @html_options[:class]
        @html_options[:class] + " #{selected_class}"
      else
        selected_class
      end
    end

    def html_options
      selected? ? @html_options.merge(:class => link_classes) : @html_options
    end

    def link
      if @block.present?
        link_to(@path, html_options) do
          @block.concat(@title)
        end
      else
        link_to(@title, @path, html_options)
      end
    end

    def wrapper_classes
      if selected?
        "#{selected_class} #{@options[:wrapper_class]}"
      else
        @options[:wrapper_class]
      end
    end

    def controller_for(path)
      Rails.application.routes.recognize_path(path)[:controller]
    end

    def comparable_path_for(path)
      if @options[:ignore_params]
        path.gsub(/\?.*/, '')
      else
        path
      end
    end
  end

end