Add view_wiki_show_action_dropdown hook via Deface and comprehensive hook tests for wiki, issues and contacts controllers

Author: alexandermeindl

app/overrides/wiki_show.rb

@@ -7,4 +7,10 @@ module WikiShow
                        insert_before: 'p.wiki-update-info',
                        original: '39c0ff8f0b6a468264526af5046c3c6db7e94997',
                        partial: 'hooks/view_wiki_show_bottom'
+
+  Deface::Override.new virtual_path: 'wiki/show',
+                       name: 'wiki-show-action-dropdown',
+                       insert_after: 'erb[loud]:contains("label_history")',
+                       original: '83d97f2d91c682d3329bc2df00856cc6f6cc4b09',
+                       partial: 'hooks/view_wiki_show_action_dropdown'
 end

app/views/hooks/_view_wiki_show_action_dropdown.html.slim

@@ -0,0 +1 @@
+= call_hook :view_wiki_show_action_dropdown, page: @page, project: @project

test/fixtures/contacts.yml

@@ -0,0 +1,94 @@
+adam:
+  id: 1
+  first_name: Adam
+  last_name: Ondra
+  middle_name: Superstar
+  company: Ocun
+  email: adam@mail.com
+  website: https://www.adamondra.com/
+  primary_city: Brno
+  primary_country_code: CZ
+  primary_postcode: 602 00
+  other_city: Arco
+  other_country_code: IT
+  author_id: 1
+  assigned_to_id: 3
+  created_on: <%= 2.days.ago.to_fs(:db) %>
+
+kurt:
+  id: 2
+  first_name: Kurt
+  last_name: Albert
+  middle_name: Superstar
+  job_title: CEO
+  company: Ocun
+  birthday: 1954-01-28
+  email: kurt@mail.de,kurt@mail.com
+  description: Kurt was the infentor of redpoint
+  primary_city: Ebermannstadt
+  primary_country_code: DE
+  primary_street1: Gasseldorf
+  primary_state: Bayern
+  primary_postcode: 91320
+  other_city: Oberschellenbach
+  other_country_code: DE
+  other_street1: Unbekannt 2
+  other_state: Bayern
+  other_postcode: 90321
+  created_on: <%= 3.days.ago.to_fs(:db) %>
+  author_id: 1
+
+ocun:
+  id: 3
+  first_name: Ocun
+  job_title: web project
+  is_company: true
+  company_contact_id: 1
+  email: info@global.ocun.com
+  invoice_email: billing@ocun.com
+  description: Realy cool project
+  website: https://www.ocun.com
+  author_id: 3
+
+john:
+  id: 4
+  first_name: John
+  last_name: Smith
+  job_title: CEO
+  is_company: false
+  email: jsmith@somenet.foo
+  description: "Contact with user realation\nUser id = 2"
+  author_id: 2
+
+blackdiamond:
+  id: 5
+  first_name: 'Black Diamond'
+  job_title: web project
+  is_company: true
+  visibility: <%= Contact::VISIBILITY_PRIVATE %>
+  email: company@8a.nu
+  description: "Here at Black Diamond it's all about climbing and skiing. We share the same experiences that you do on rock, ice and snow and these experiences push us to make the best gear possible for our worldwide family of climbers and skiers."
+  website: "https://www.blackdiamondequipment.com"
+  phone: "1-800-775-5552"
+  author_id: 2
+
+spammer:
+  id: 6
+  first_name: Spammer
+  email: spam@junk.com
+  created_on: <%= 2.days.ago.to_fs(:db) %>
+  spam: true
+  author_id: 1
+
+without_mail:
+  id: 7
+  first_name: Seppi
+  created_on: <%= 2.days.ago.to_fs(:db) %>
+  email: ''
+  author_id: 1
+
+noone:
+  id: 8
+  first_name: Project2 Only
+  created_on: <%= 2.days.ago.to_fs(:db) %>
+  author_id: 1

test/fixtures/contacts_projects.yml

@@ -0,0 +1,23 @@
+contact_project_one:
+  project_id: 1
+  contact_id: 1
+
+contact_project_two:
+  project_id: 1
+  contact_id: 2
+
+contact_project_three:
+  project_id: 1
+  contact_id: 3
+
+contact_project_004:
+  project_id: 2
+  contact_id: 1
+
+contact_project_005:
+  project_id: 1
+  contact_id: 4
+
+contact_project_006:
+  project_id: 1
+  contact_id: 5

test/functional/contacts_controller_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require File.expand_path '../../test_helper', __FILE__
+
+class ViewContactsFormDetailsBottomRenderOn < Redmine::Hook::ViewListener
+  render_on :view_contacts_form_details_bottom, inline: '<div class="test-contacts-form">Hook content</div>'
+end
+
+class ContactsControllerTest < Additionals::ControllerTest
+  def setup
+    skip 'Skip test, because redmine_servicedesk is not installed' unless AdditionalsPlugin.active_servicedesk?
+    prepare_tests
+
+    # Enable contacts module for project 1
+    project = Project.find 1
+    project.enable_module! :contacts
+
+    # Add contacts permissions to Manager role
+    manager_role = Role.find 1
+    manager_role.add_permission! :view_contacts
+    manager_role.add_permission! :add_contacts
+    manager_role.add_permission! :edit_contacts
+  end
+
+  def test_new_with_hook_view_contacts_form_details_bottom
+    Redmine::Hook.add_listener ViewContactsFormDetailsBottomRenderOn
+    @request.session[:user_id] = 2
+
+    get :new,
+        params: { project_id: 1 }
+
+    assert_response :success
+    assert_select 'div.test-contacts-form', text: 'Hook content'
+  end
+
+  def test_edit_with_hook_view_contacts_form_details_bottom
+    Redmine::Hook.add_listener ViewContactsFormDetailsBottomRenderOn
+    @request.session[:user_id] = 2
+
+    contact = contacts :adam
+    skip 'No contacts available for edit test' if contact.nil?
+
+    get :edit,
+        params: { id: contact.id }
+
+    assert_response :success
+    assert_select 'div.test-contacts-form', text: 'Hook content'
+  end
+end

test/functional/issues_controller_test.rb

@@ -2,6 +2,14 @@
 
 require File.expand_path '../../test_helper', __FILE__
 
+class ViewIssueActionDropdownRenderOn < Redmine::Hook::ViewListener
+  render_on :view_issue_action_dropdown, inline: '<span class="test-issue-action-dropdown">Hook content</span>'
+end
+
+class ViewIssueActionMenuRenderOn < Redmine::Hook::ViewListener
+  render_on :view_issue_action_menu, inline: '<span class="test-issue-action-menu">Hook content</span>'
+end
+
 class IssuesControllerTest < Additionals::ControllerTest
   def setup
     manager_role = roles :roles_001
@@ -192,4 +200,26 @@ def test_show_attachments_as_hidden
       assert_select 'fieldset.hide-attachments', count: 1
     end
   end
+
+  def test_show_with_hook_view_issue_action_dropdown
+    Redmine::Hook.add_listener ViewIssueActionDropdownRenderOn
+    @request.session[:user_id] = 2
+
+    get :show,
+        params: { id: 1 }
+
+    assert_response :success
+    assert_select 'span.test-issue-action-dropdown', text: 'Hook content'
+  end
+
+  def test_show_with_hook_view_issue_action_menu
+    Redmine::Hook.add_listener ViewIssueActionMenuRenderOn
+    @request.session[:user_id] = 2
+
+    get :show,
+        params: { id: 1 }
+
+    assert_response :success
+    assert_select 'span.test-issue-action-menu', text: 'Hook content'
+  end
 end

test/functional/wiki_controller_test.rb

@@ -2,6 +2,26 @@
 
 require File.expand_path '../../test_helper', __FILE__
 
+class ViewWikiShowActionDropdownRenderOn < Redmine::Hook::ViewListener
+  render_on :view_wiki_show_action_dropdown, inline: '<span class="test-action-dropdown">Hook content</span>'
+end
+
+class ViewWikiShowBottomRenderOn < Redmine::Hook::ViewListener
+  render_on :view_wiki_show_bottom, inline: '<div class="test-wiki-bottom">Hook content</div>'
+end
+
+class ViewWikiFormBottomRenderOn < Redmine::Hook::ViewListener
+  render_on :view_wiki_form_bottom, inline: '<div class="test-wiki-form-bottom">Hook content</div>'
+end
+
+class ViewWikiIndexBottomRenderOn < Redmine::Hook::ViewListener
+  render_on :view_wiki_index_bottom, inline: '<div class="test-wiki-index-bottom">Hook content</div>'
+end
+
+class ViewWikiDateIndexBottomRenderOn < Redmine::Hook::ViewListener
+  render_on :view_wiki_date_index_bottom, inline: '<div class="test-wiki-date-index-bottom">Hook content</div>'
+end
+
 class WikiControllerTest < Additionals::ControllerTest
   WIKI_MACRO_USER_ID = 2
 
@@ -10,6 +30,64 @@ def setup
     EnabledModule.create project_id: 1, name: 'wiki'
   end
 
+  def test_show_with_hook_view_wiki_show_action_dropdown
+    Redmine::Hook.add_listener ViewWikiShowActionDropdownRenderOn
+    @request.session[:user_id] = WIKI_MACRO_USER_ID
+    page = WikiPage.generate! title: __method__.to_s
+
+    get :show,
+        params: { project_id: 1, id: page.title }
+
+    assert_response :success
+    assert_select 'span.test-action-dropdown', text: 'Hook content'
+  end
+
+  def test_show_with_hook_view_wiki_show_bottom
+    Redmine::Hook.add_listener ViewWikiShowBottomRenderOn
+    @request.session[:user_id] = WIKI_MACRO_USER_ID
+    page = WikiPage.generate! title: __method__.to_s
+
+    get :show,
+        params: { project_id: 1, id: page.title }
+
+    assert_response :success
+    assert_select 'div.test-wiki-bottom', text: 'Hook content'
+  end
+
+  def test_edit_with_hook_view_wiki_form_bottom
+    Redmine::Hook.add_listener ViewWikiFormBottomRenderOn
+    @request.session[:user_id] = WIKI_MACRO_USER_ID
+    page = WikiPage.generate! title: __method__.to_s
+
+    get :edit,
+        params: { project_id: 1, id: page.title }
+
+    assert_response :success
+    assert_select 'div.test-wiki-form-bottom', text: 'Hook content'
+  end
+
+  def test_index_with_hook_view_wiki_index_bottom
+    Redmine::Hook.add_listener ViewWikiIndexBottomRenderOn
+    @request.session[:user_id] = WIKI_MACRO_USER_ID
+
+    get :index,
+        params: { project_id: 1 }
+
+    assert_response :success
+    assert_select 'div.test-wiki-index-bottom', text: 'Hook content'
+  end
+
+  def test_date_index_with_hook_view_wiki_date_index_bottom
+    Redmine::Hook.add_listener ViewWikiDateIndexBottomRenderOn
+    @request.session[:user_id] = WIKI_MACRO_USER_ID
+
+    get :date_index,
+        params: { project_id: 1 }
+
+    assert_response :success
+    assert_select 'div.test-wiki-date-index-bottom', text: 'Hook content'
+  end
+
   def test_show_with_youtube_macro
     @request.session[:user_id] = WIKI_MACRO_USER_ID
     page = WikiPage.generate! content: '{{youtube(KMU0tzLwhbE)}}',

test/test_helper.rb

@@ -51,6 +51,7 @@ module PluginFixturesLoader
     def plugin_fixtures_list
       custom = %i[dashboards dashboard_roles]
       custom += %i[hrm_user_types hrm_working_calendars] if AdditionalsPlugin.active_hrm?
+      custom += %i[contacts contacts_projects] if AdditionalsPlugin.active_servicedesk?
       custom
     end
   end

test/unit/user_test.rb

@@ -30,7 +30,7 @@ def test_non_admin_should_can_not_be_admin
   end
 
   def test_sudoer_should_can_be_admin
-    skip 'Skip redmine_sudo test, because redmine_contacts is not installed' unless AdditionalsPlugin.active_sudo?
+    skip 'Skip test, because redmine_sudo is not installed' unless AdditionalsPlugin.active_sudo?
 
     user = users :users_001
     user.sudoer = true
@@ -53,7 +53,7 @@ def test_sudoer_should_can_be_admin
   end
 
   def test_non_sudoer_without_admin_can_not_be_admin
-    skip 'Skip redmine_sudo test, because redmine_contacts is not installed' unless AdditionalsPlugin.active_sudo?
+    skip 'Skip test, because redmine_contacts is not installed' unless AdditionalsPlugin.active_sudo?
 
     assert_not User.where(sudoer: false, admin: false).order(:id).first.can_be_admin?
   end