Workflow macro could read files from the repository

[Ryan J Ollos]

The Image macro and several WikiProcessors on trac-hacks support reading a file from the repository: ​th:CodeExampleMacro, ​th:PlantUmlMacro.

Adding this capability to the Workflow macro and allowing ini files to be read from the repository would make the documentation on the TracWorkflow page could be made more maintainable.

[Ryan J Ollos]

Some work has been done to implement the feature in log:rjollos.git:t11865-workflow-macro. More work is needed to mock out RepositoryManager and develop a thorough set of test cases.

[Ryan J Ollos]

Narrowing focus for milestone:1.2. Please move ticket to milestone:1.2 if you intend to fix it.

[Ryan J Ollos]

TODO Update WorkFlow/Examples to read ini files from repository after this ticket is implemented.

[Ryan J Ollos]

Proposed changes in [acb2ee10/rjollos.git], with the first two changes in the branch targeted for 1.2-stable (log:rjollos.git:t11865_workflow_macro.1).

[Ryan J Ollos]

Replying to Ryan J Ollos:

Adding this capability to the Workflow macro and allowing ini files to be read from the repository would make the documentation on the TracWorkflow page could be made more maintainable.

This actually won't work because the TracWorkflow page is distributed with Trac, however the workflow macro with file argument can be used on the WorkFlow/Examples page.

[Ryan J Ollos]

Ancillary changes committed to 1.2-stable in r15856,r15857; merged to trunk in r15858,r15859.

Committed to trunk in r15860.

[Ryan J Ollos]

After r15859, the following is included in the pot file:

#: trac/wiki/tests/formatter.py:127 trac/wiki/tests/formatter.py:134
#, python-format
msgid "The content: %(content)s"
msgstr ""

Is it good to use the same workaround as in tests/config.py​?

trac/wiki/tests/formatter.py

@@ -123 +123 @@
 class MacroErrorWithFragmentMacro(WikiMacroBase):
 
     def expand_macro(self, formatter, name, content, args=None):
-        raise MacroError(tag_("The content: %(content)s",
-                              content=html.code(content)))
+        raise MacroError((tag_)("The content: %(content)s",
+                                content=html.code(content)))
 
 
 class ProcessorErrorWithFragmentMacro(WikiMacroBase):
 
     def expand_macro(self, formatter, name, content, args=None):
-        raise ProcessorError(tag_("The content: %(content)s",
-                                  content=html.code(content)))
+        raise ProcessorError((tag_)("The content: %(content)s",
+                                    content=html.code(content)))
 
 
 class SampleResolver(Component):

Or is there a better way?

[Jun Omae]

Another way, I think we could use tgettext_noop instead of tag_ to prevent message extraction.

trac/wiki/tests/formatter.py

@@ -16 +16 @@
 
 from trac.core import Component, TracError, implements
 from trac.util.html import genshi, html
-from trac.util.translation import tag_
+from trac.util.translation import tgettext_noop
 from trac.wiki.api import IWikiSyntaxProvider
 from trac.wiki.formatter import MacroError, ProcessorError
 from trac.wiki.macros import WikiMacroBase
@@ -123 +123 @@
 class MacroErrorWithFragmentMacro(WikiMacroBase):
 
     def expand_macro(self, formatter, name, content, args=None):
-        raise MacroError(tag_("The content: %(content)s",
-                              content=html.code(content)))
+        raise MacroError(tgettext_noop("The content: %(content)s",
+                                       content=html.code(content)))
 
 
 class ProcessorErrorWithFragmentMacro(WikiMacroBase):
 
     def expand_macro(self, formatter, name, content, args=None):
-        raise ProcessorError(tag_("The content: %(content)s",
-                                  content=html.code(content)))
+        raise ProcessorError(tgettext_noop("The content: %(content)s",
+                                           content=html.code(content)))
 
 
 class SampleResolver(Component):

[Ryan J Ollos]

That looks useful. I was thinking, there must be a way to ignore files/directories, so did some ​searching. The changes in log:rjollos.git:t11865_no_extract_message ([dbb43165/rjollos.git]) seem to fix the issue. I'm considering it would be good to push changes to 1.2-stable.

[Jun Omae]

Replying to Ryan J Ollos:

That looks useful. I was thinking, there must be a way to ignore files/directories, so did some ​searching. The changes in log:rjollos.git:t11865_no_extract_message ([dbb43165/rjollos.git]) seem to fix the issue.

Ignoring **/tests/** for extraction is good idea!

Also, I've added ignore = babel.messages.extract:extract_nothing line to messages-js.cfg for #12351. However, I noticed the line is not needed by your changes.

messages-js.cfg

@@ -2 +2 @@
 # trac/locale/messages-js.pot (see setup.cfg)
 [extractors]
 javascript_script = trac.dist:extract_javascript_script
-ignore = babel.messages.extract:extract_nothing
 
 [ignore:            **/htdocs/js/jquery.js]
 [ignore:            **/htdocs/js/jquery-ui.js]

I'm considering it would be good to push changes to 1.2-stable.

Agreed.

[Ryan J Ollos]

Replying to Jun Omae:

Also, I've added ignore = babel.messages.extract:extract_nothing line to messages-js.cfg for #12351. However, I noticed the line is not needed by your changes.

Thanks, I'll include that in the changes.

[Ryan J Ollos]

Proposed changes for 1.2-stable: [cdd959a1/rjollos.git].

[Ryan J Ollos]

Changes committed to 1.2-stable in r15888, merged to trunk in r15890.

[Jun Omae]

After [15888], extract_messages command is failing….

$ make extract
python  setup.py  extract_messages  extract_messages_js  extract_messages_tracini
running extract_messages
error: [Errno 2] No such file or directory: 'messages.cfg'
make: *** [extract] Error 1

Added messages.cfg file in [15897] using [cdd959a1/rjollos.git].

[Ryan J Ollos]

Thanks for fixing - I've been overlooking the svn add lately.

[Ryan J Ollos]

Reviewing code in ​IncludeMacro, RepositoryManager.read_file_by_path would be more useful if it returned the content type for the file.