Allow configuration to override static help link

This commit adds a new static helper for Links now used on more than
location in OpenProject (Homescreen + Help menu).

It allows to override the help link using the `configuration.yml`.
If it is overriden, no dropdown is rendered, but only a single link.
pull/4462/head
Oliver Günther 9 years ago
parent 5263a5e71b
commit 38dee90a47
  1. 2
      app/controllers/homescreen_controller.rb
  2. 6
      config/initializers/homescreen.rb
  3. 2
      config/initializers/menus.rb
  4. 1
      lib/open_project/configuration.rb
  5. 4
      lib/open_project/info.rb
  6. 42
      lib/open_project/static/homescreen.rb
  7. 92
      lib/open_project/static/links.rb
  8. 97
      lib/redmine/menu_manager/help_menu_helper.rb
  9. 58
      lib/redmine/menu_manager/top_menu_helper.rb
  10. 4
      spec_legacy/unit/lib/redmine/menu_manager/mapper_spec.rb

@ -37,7 +37,7 @@ class HomescreenController < ApplicationController
@news = News.latest(count: 3)
@announcement = Announcement.active_and_current
@homescreen = OpenProject::Homescreen
@homescreen = OpenProject::Static::Homescreen
end
def robots

@ -27,9 +27,9 @@
# See doc/COPYRIGHT.rdoc for more details.
#++
require 'open_project/homescreen'
require 'open_project/static/homescreen'
OpenProject::Homescreen.manage :blocks do |blocks|
OpenProject::Static::Homescreen.manage :blocks do |blocks|
blocks.push(
{ partial: 'welcome',
if: Proc.new { Setting.welcome_on_homescreen? && !Setting.welcome_text.empty? } },
@ -46,7 +46,7 @@ OpenProject::Homescreen.manage :blocks do |blocks|
)
end
OpenProject::Homescreen.manage :links do |links|
OpenProject::Static::Homescreen.manage :links do |links|
links.push(
{
label: :user_guides,

@ -56,7 +56,7 @@ Redmine::MenuManager.map :top_menu do |menu|
(User.current.logged? || !Setting.login_required?) &&
User.current.allowed_to?(:view_time_entries, nil, global: true)
}
menu.push :help, OpenProject::Info.help_url,
menu.push :help, OpenProject::Static::Links.help_link,
last: true,
caption: '',
html: { accesskey: OpenProject::AccessKeys.key_for(:help),

@ -43,6 +43,7 @@ module OpenProject
'autologin_cookie_path' => '/',
'autologin_cookie_secure' => false,
'database_cipher_key' => nil,
'force_help_link' => nil,
'scm_git_command' => nil,
'scm_subversion_command' => nil,
'disable_browser_cache' => true,

@ -34,10 +34,6 @@ module OpenProject
def url; Setting.software_url end
def help_url
'https://www.openproject.org/help'
end
def versioned_name; "#{app_name} #{OpenProject::VERSION.to_semver}" end
# Creates the url string to a specific Redmine issue

@ -28,29 +28,31 @@
#++
module OpenProject
module Homescreen
class << self
##
# Access a defined item on the homescreen
# By default, this will likely be :blocks and :links,
# however plugins may define their own blocks and
# render them in the call_hook.
def [](item)
homescreen[item]
end
module Static
module Homescreen
class << self
##
# Access a defined item on the homescreen
# By default, this will likely be :blocks and :links,
# however plugins may define their own blocks and
# render them in the call_hook.
def [](item)
homescreen[item]
end
##
# Manage the given content for this item,
# yielding it.
def manage(item, default = [])
homescreen[item] ||= default
yield homescreen[item]
end
##
# Manage the given content for this item,
# yielding it.
def manage(item, default = [])
homescreen[item] ||= default
yield homescreen[item]
end
private
private
def homescreen
@content ||= {}
def homescreen
@content ||= {}
end
end
end
end

@ -0,0 +1,92 @@
#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See doc/COPYRIGHT.rdoc for more details.
#++
module OpenProject
module Static
module Links
class << self
def help_link_overridden?
OpenProject::Configuration.force_help_link.present?
end
def help_link
OpenProject::Configuration.force_help_link.presence || links[:user_guides]
end
def links
@links ||= begin
{
user_guides: {
href: 'https://www.openproject.org/help/user-guides',
label: I18n.t('homescreen.links.user_guides')
},
faq: {
href: 'https://www.openproject.org/help/faq',
label: I18n.t('homescreen.links.faq')
},
boards: {
href: 'https://community.openproject.com/projects/openproject/boards',
label: I18n.t('homescreen.links.boards')
},
professional_support: {
href: 'https://www.openproject.org/professional-services/',
label: I18n.t(:label_professional_support)
},
blog: {
href: 'https://www.openproject.org/blog',
label: I18n.t('homescreen.links.blog')
},
release_notes: {
href: 'https://www.openproject.org/open-source/release-notes/',
label: I18n.t(:label_release_notes)
},
report_bug: {
href: 'https://www.openproject.org/open-source/report-bug/',
label: I18n.t(:label_report_bug)
},
roadmap: {
href: 'https://community.openproject.org/projects/openproject/roadmap',
label: I18n.t(:label_development_roadmap)
},
crowdin: {
href: 'https://crowdin.com/projects/opf',
label: I18n.t(:label_add_edit_translations)
},
api_docs: {
href: 'https://www.openproject.org/api',
label: I18n.t(:label_api_documentation)
},
}
end
end
end
end
end
end

@ -0,0 +1,97 @@
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See doc/COPYRIGHT.rdoc for more details.
#++
require 'concerns/omniauth_login'
require 'open_project/static/links'
module Redmine::MenuManager::HelpMenuHelper
def render_help_top_menu_node(item = help_menu_item)
if OpenProject::Static::Links.help_link_overridden?
render_menu_node(item)
else
render_help_dropdown
end
end
def render_help_dropdown
link_to_help_pop_up = link_to '', '',
class: 'icon-help1',
aria: { haspopup: 'true' }
result = ''.html_safe
render_drop_down_menu_node(link_to_help_pop_up, class: 'drop-down hidden-for-mobile') do
content_tag :ul, style: 'display:none', class: 'drop-down--help' do
render_help_and_support result
render_additional_resources result
end
end
end
private
def render_help_and_support(result)
result << content_tag(:li) do
content_tag :span, l('top_menu.help_and_support'),
class: 'drop-down--help-headline',
title: l('top_menu.help_and_support')
end
result << static_link_item(:user_guides)
result << static_link_item(:faq)
result << content_tag(:li) do
link_to l('homescreen.links.shortcuts'),
'',
title: l('homescreen.links.shortcuts'),
onClick: 'modalHelperInstance.createModal(\'/help/keyboard_shortcuts\');'
end
result << static_link_item(:boards)
result << static_link_item(:professional_support)
end
def render_additional_resources(result)
result << content_tag(:li) do
content_tag :span,
l('top_menu.additional_resources'),
class: 'drop-down--help-headline',
title: l('top_menu.additional_resources')
end
result << static_link_item(:blog)
result << static_link_item(:release_notes)
result << static_link_item(:report_bug)
result << static_link_item(:roadmap)
result << static_link_item(:crowdin)
result << static_link_item(:api_docs)
end
def static_link_item(key)
link = OpenProject::Static::Links.links[key]
content_tag(:li) do
link_to link[:label], link[:href], title: link[:label]
end
end
end

@ -29,6 +29,7 @@
require 'concerns/omniauth_login'
module Redmine::MenuManager::TopMenuHelper
include HelpMenuHelper
def render_top_menu_left
content_tag :ul, id: 'account-nav-left', class: 'menu_root account-nav hidden-for-mobile' do
[render_main_top_menu_nodes,
@ -151,63 +152,6 @@ module Redmine::MenuManager::TopMenuHelper
id: 'more-menu'
end
def render_help_top_menu_node(item = help_menu_item)
link_to_help_pop_up = link_to '', '',
class: 'icon-help1',
aria: { haspopup: 'true' }
result = ''.html_safe
render_drop_down_menu_node(link_to_help_pop_up, class: 'drop-down hidden-for-mobile') do
content_tag :ul, style: 'display:none', class: 'drop-down--help' do
result << content_tag(:li) do
content_tag(:span, l('top_menu.help_and_support'), class: 'drop-down--help-headline', title: l('top_menu.help_and_support'))
end
result << content_tag(:li) do
link_to l('homescreen.links.user_guides'), 'https://www.openproject.org/help/user-guides', title: l('homescreen.links.user_guides')
end
result << content_tag(:li) do
link_to l('homescreen.links.faq'), 'https://www.openproject.org/help/faq', title: l('homescreen.links.faq')
end
result << content_tag(:li) do
link_to l('homescreen.links.shortcuts'), '', title: l('homescreen.links.shortcuts'), onClick: 'modalHelperInstance.createModal(\'/help/keyboard_shortcuts\');'
end
result << content_tag(:li) do
link_to l('homescreen.links.boards'), 'https://community.openproject.com/projects/openproject/boards', title: l('homescreen.links.boards')
end
result << content_tag(:li) do
link_to l(:label_professional_support), 'https://www.openproject.org/professional-services/', title: l(:label_professional_support)
end
result << content_tag(:hr, '', class: 'form--separator')
result << content_tag(:li) do
content_tag(:span, l('top_menu.additional_resources'), class: 'drop-down--help-headline', title: l('top_menu.additional_resources'))
end
result << content_tag(:li) do
link_to l('homescreen.links.blog'), 'https://www.openproject.org/blog', title: l('homescreen.links.blog')
end
result << content_tag(:li) do
link_to l(:label_release_notes), 'https://www.openproject.org/open-source/release-notes/', title: l(:label_release_notes)
end
result << content_tag(:li) do
link_to l(:label_report_bug), 'https://www.openproject.org/open-source/report-bug/', title: l(:label_report_bug)
end
result << content_tag(:li) do
link_to l(:label_development_roadmap), 'https://community.openproject.org/projects/openproject/roadmap', title: l(:label_development_roadmap)
end
result << content_tag(:li) do
link_to l(:label_add_edit_translations), 'https://crowdin.com/projects/opf', title: l(:label_add_edit_translations)
end
result << content_tag(:li) do
link_to l(:label_api_documentation), 'https://www.openproject.org/api', title: l(:label_api_documentation)
end
result
end
end
end
def render_main_top_menu_nodes(items = main_top_menu_items)
items.map { |item|
render_menu_node(item)

@ -170,9 +170,9 @@ describe Redmine::MenuManager::Mapper do
specify 'deleting all items' do
# Exposed by deleting :last items
Redmine::MenuManager.map :test_menu do |menu|
menu.push :not_last, OpenProject::Info.help_url
menu.push :not_last, OpenProject::Static::Links.help_link
menu.push :administration, { controller: 'projects', action: 'show' }, last: true
menu.push :help, OpenProject::Info.help_url, last: true
menu.push :help, OpenProject::Static::Links.help_link, last: true
end
expect {

Loading…
Cancel
Save