BigW Consortium Gitlab

tab_helper.rb 3.69 KB
Newer Older
1
module TabHelper
2 3 4
  # Navigation link helper
  #
  # Returns an `li` element with an 'active' class if the supplied
Robert Speicher committed
5
  # controller(s) and/or action(s) are currently active. The content of the
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
  # 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 (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).
  # 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" }
  #   # => '<li>Hello</li>'
  #
  #   # Controller matches
  #   nav_link(controller: [:tree, :refs]) { "Hello" }
  #   # => '<li class="active">Hello</li>'
  #
31 32 33 34
  #   # Several paths
  #   nav_link(path: ['tree#show', 'profile#show']) { "Hello" }
  #   # => '<li class="active">Hello</li>'
  #
35 36 37 38 39 40 41 42 43 44
  #   # Shorthand path
  #   nav_link(path: 'tree#show') { "Hello" }
  #   # => '<li class="active">Hello</li>'
  #
  #   # Supplying custom options for the list element
  #   nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" }
  #   # => '<li class="home active">Hello</li>'
  #
  # Returns a list item element String
  def nav_link(options = {}, &block)
45
    klass = active_nav_link?(options) ? 'active' : ''
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

    # 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
    o[:class].strip!

    if block_given?
      content_tag(:li, capture(&block), o)
    else
      content_tag(:li, nil, o)
    end
  end

61 62 63 64 65 66 67 68 69
  def active_nav_link?(options)
    if path = options.delete(:path)
      unless path.respond_to?(:each)
        path = [path]
      end

      path.any? do |single_path|
        current_path?(single_path)
      end
70
    elsif page = options.delete(:page)
71 72 73 74 75 76 77
      unless page.respond_to?(:each)
        page = [page]
      end

      page.any? do |single_page|
        current_page?(single_page)
      end
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    else
      c = options.delete(:controller)
      a = options.delete(:action)

      if c && a
        # When given both options, make sure BOTH are true
        current_controller?(*c) && current_action?(*a)
      else
        # Otherwise check EITHER option
        current_controller?(*c) || current_action?(*a)
      end
    end
  end

  def current_path?(path)
    c, a, _ = path.split('#')
    current_controller?(c) && current_action?(a)
  end

97
  def project_tab_class
98
    if controller.controller_path.start_with?('projects')
99 100
      return 'active'
    end
101

Douwe Maan committed
102
    if %w(services hooks deploy_keys protected_branches).include? controller.controller_name
103
      "active"
104 105 106
    end
  end

107
  def branches_tab_class
108
    if current_controller?(:protected_branches) ||
109 110 111
        current_controller?(:branches) ||
        current_page?(namespace_project_repository_path(@project.namespace,
                                                        @project))
112
      'active'
113 114
    end
  end
115 116

  def profile_tab_class
117
    if controller.controller_path.start_with?('profiles')
118 119 120 121 122
      return 'active'
    end

    'active' if current_controller?('oauth/applications')
  end
123
end