Changed title of /query page to manage navigation menu

Author: bmispelon

DjangoPlugin/tracdjangoplugin/plugins.py

@@ -6,6 +6,7 @@
 from trac.web.api import IRequestFilter, IRequestHandler, RequestDone
 from trac.web.auth import LoginModule
 from trac.wiki.web_ui import WikiModule
+from trac.ticket.query import QueryModule
 from trac.util.html import tag
 from tracext.github import GitHubLoginModule, GitHubBrowser
 
@@ -190,3 +191,14 @@ def force_logout_and_redirect(self, req):
 
     def post_process_request(self, req, template, data, metadata):
         return template, data, metadata  # required by Trac to exist
+
+
+class RenameQueryTitleComponent(QueryModule):
+    """
+    Change the title of the /query page so that the navmenu entry matches the
+    page's <h1>.
+    """
+    def display_html(self, req, query):
+        template_name, context = super().display_html(req, query)
+        context["title"] = "View Tickets"
+        return template_name, context

DjangoPlugin/tracdjangoplugin/tests.py

@@ -12,7 +12,10 @@
     ReStructuredTextRenderer,  # noqa: needed for RSTWikiTestCase to work
 )
 from trac.test import EnvironmentStub, MockRequest
+from trac.ticket.web_ui import TicketModule  # Imported for side effects
+from trac.ticket.query import QueryModule  # Imported for side effects
 from trac.web.api import RequestDone
+from trac.web.main import RequestDispatcher
 
 from tracdjangoplugin.middlewares import DjangoDBManagementMiddleware
 from tracdjangoplugin.plugins import PlainLoginComponent, ReservedUsernamesComponent
@@ -258,3 +261,56 @@ def test_wiki_can_render_rst(self):
             str(output),
             '<div class="document" id="test"><h1 class="title">TEST</h1></div>',
         )
+
+
+class _TracRequestWrapper:
+    """
+    Wrap a Trac request object to make it look like a Django response (so it
+    can be used with assertContains)
+    """
+    streaming = False
+    charset = "utf8"
+
+    def __init__(self, request):
+        self._request = request
+
+    @property
+    def status_code(self):
+        status_str, _ = self._request._status.split(" ", 1)
+        return int(status_str)
+
+    @property
+    def content(self):
+        return self._request.response_sent.getvalue()
+
+
+class RenameQueryTitleComponentTestCase(TestCase):
+    def setUp(self):
+        self.env = EnvironmentStub(
+            enable=[
+                "trac.ticket.*",
+                "trac.ticket.query.*",
+                "trac.web.*",
+                "tracdjangoplugin.plugins.renamequerytitlecomponent",
+            ],
+            disable=[
+                "trac.ticket.query.querymodule",
+            ],
+        )
+        self.request_factory = partial(MockRequest, self.env)
+        self.dispatcher = RequestDispatcher(self.env)
+
+    def get_response(self, **kwargs):
+        """
+        Build a request using the given kwargs and return a Django-like
+        response object.
+        """
+        request = self.request_factory(**kwargs)
+        self.assertRaises(RequestDone, self.dispatcher.dispatch, request)
+        return _TracRequestWrapper(request)
+
+    def test_new_title(self):
+        response = self.get_response(path_info="/query")
+
+        self.assertContains(response, '<h1>View Tickets <span class="numrows">(0 matches)</span></h1>', html=True)
+        self.assertNotContains(response, '<h1>Custom Query <span class="numrows">(0 matches)</span></h1>', html=True)

trac-env/conf/trac.ini

@@ -13,7 +13,8 @@ wiki_format_messages = enabled
 trac.about.* = disabled
 trac.admin.web_ui.PluginAdminPanel = disabled
 trac.ticket.query.* = enabled
-trac.ticket.query.querymodule = enabled
+# replaced by tracdjangoplugin.plugins.RenameQueryTitleComponent
+trac.ticket.query.querymodule = disabled
 trac.ticket.query.ticketquerymacro = enabled
 trac.ticket.report.* = disabled
 trac.ticket.report.reportmodule = disabled