# frozen_string_literal: true module TabHelper # Navigation link helper # # Returns an `li` element with an 'active' class if the supplied # controller(s) and/or action(s) are currently active. The content of the # element is the value passed to the block. # # options - The options hash used to determine if the element is "active" (default: {}) # :controller - One or more controller names to check, use path notation when namespaced (optional). # :action - One or more action names to check (optional). # :path - A shorthand path, such as 'dashboard#index', to check (optional). # :html_options - Extra options to be passed to the list element (optional). # :unless - Callable object to skip rendering the 'active' class on `li` element (optional). # block - An optional block that will become the contents of the returned # `li` element. # # When both :controller and :action are specified, BOTH must match in order # to be marked as active. When only one is given, either can match. # # Examples # # # Assuming we're on TreeController#show # # # Controller matches, but action doesn't # nav_link(controller: [:tree, :refs], action: :edit) { "Hello" } # # => '
  • Hello
  • ' # # # Controller matches # nav_link(controller: [:tree, :refs]) { "Hello" } # # => '
  • Hello
  • ' # # # Several paths # nav_link(path: ['tree#show', 'profile#show']) { "Hello" } # # => '
  • Hello
  • ' # # # Shorthand path # nav_link(path: 'tree#show') { "Hello" } # # => '
  • Hello
  • ' # # # Supplying custom options for the list element # nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" } # # => '
  • Hello
  • ' # # # For namespaced controllers like Admin::AppearancesController#show # # # Controller and namespace matches # nav_link(controller: 'admin/appearances') { "Hello" } # # => '
  • Hello
  • ' # # # Controller and namespace matches but action doesn't # nav_link(controller: 'admin/appearances', action: :edit) { "Hello" } # # => '
  • Hello
  • ' # # # Shorthand path with namespace # nav_link(path: 'admin/appearances#show') { "Hello"} # # => '
  • Hello
  • ' # # # Shorthand path + unless # # Add `active` class when TreeController is requested, except the `index` action. # nav_link(controller: 'tree', unless: -> { action_name?('index') }) { "Hello" } # # => '
  • Hello
  • ' # # # When `TreeController#index` is requested # # => '
  • Hello
  • ' # # # Paths, controller and actions can be used at the same time # nav_link(path: 'tree#show', controller: 'admin/appearances') { "Hello" } # # nav_link(path: 'foo#bar', controller: 'tree') { "Hello" } # nav_link(path: 'foo#bar', controller: 'tree', action: 'show') { "Hello" } # nav_link(path: 'foo#bar', action: 'show') { "Hello" } # # Returns a list item element String def nav_link(options = {}, &block) klass = active_nav_link?(options) ? 'active' : '' # Add our custom class into the html_options, which may or may not exist # and which may or may not already have a :class key o = options.delete(:html_options) || {} o[:class] = [*o[:class], klass].join(' ') o[:class].strip! if block_given? content_tag(:li, capture(&block), o) else content_tag(:li, nil, o) end end def active_nav_link?(options) return false if options[:unless]&.call controller = options.delete(:controller) action = options.delete(:action) route_matches_paths?(options.delete(:path)) || route_matches_pages?(options.delete(:page)) || route_matches_controllers_and_or_actions?(controller, action) end def current_path?(path) c, a, _ = path.split('#') current_controller?(c) && current_action?(a) end def branches_tab_class if current_controller?(:protected_branches) || current_controller?(:branches) || current_page?(project_repository_path(@project)) 'active' end end private def route_matches_paths?(paths) Array(paths).compact.any? do |single_path| current_path?(single_path) end end def route_matches_pages?(pages) Array(pages).compact.any? do |single_page| current_page?(single_page) end end def route_matches_controllers_and_or_actions?(controller, action) if controller && action current_controller?(*controller) && current_action?(*action) else current_controller?(*controller) || current_action?(*action) end end end