Module: TabHelper

Defined in:
app/helpers/tab_helper.rb

Instance Method Summary collapse

Instance Method Details

#active_nav_link?(options) ⇒ Boolean

Returns:

  • (Boolean)

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'app/helpers/tab_helper.rb', line 61

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
  elsif page = options.delete(:page)
    unless page.respond_to?(:each)
      page = [page]
    end

    page.any? do |single_page|
      current_page?(single_page)
    end
  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

#branches_tab_classObject


105
106
107
108
109
110
111
112
# File 'app/helpers/tab_helper.rb', line 105

def branches_tab_class
  if current_controller?(:protected_branches) ||
    current_controller?(:branches) ||
    current_page?(namespace_project_repository_path(@project.namespace,
                                                    @project))
    'active'
  end
end

#current_path?(path) ⇒ Boolean

Returns:

  • (Boolean)

92
93
94
95
# File 'app/helpers/tab_helper.rb', line 92

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

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 (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>'

# Several paths
nav_link(path: ['tree#show', 'profile#show']) { "Hello" }
# => '<li class="active">Hello</li>'

# 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


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'app/helpers/tab_helper.rb', line 44

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

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

#profile_tab_classObject


114
115
116
117
118
119
120
# File 'app/helpers/tab_helper.rb', line 114

def profile_tab_class
  if controller.controller_path =~ /\Aprofiles/
    return 'active'
  end

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

#project_tab_classObject


97
98
99
100
101
102
103
# File 'app/helpers/tab_helper.rb', line 97

def project_tab_class
  return "active" if current_page?(controller: "/projects", action: :edit, id: @project)

  if ['services', 'hooks', 'deploy_keys', 'protected_branches'].include? controller.controller_name
    "active"
  end
end