dita-convert 1.2.2__tar.gz → 1.2.3__tar.gz

{dita_convert-1.2.2 → dita_convert-1.2.3}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: dita-convert
-Version: 1.2.2
+Version: 1.2.3
 Summary: Convert a generic DITA topic to a specialized concept, task, or reference.
 Author-email: Jaromir Hradilek <jhradilek@gmail.com>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/jhradilek/dita-custom-xslt
 Project-URL: Repository, https://github.com/jhradilek/dita-custom-xslt
 Project-URL: Issues, https://github.com/jhradilek/dita-custom-xslt/issues
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{dita_convert-1.2.2 → dita_convert-1.2.3}/pyproject.toml

@@ -2,11 +2,12 @@
 name = "dita-convert"
 authors = [{name = "Jaromir Hradilek", email="jhradilek@gmail.com"}]
 description = "Convert a generic DITA topic to a specialized concept, task, or reference."
+license = "MIT"
+license-files = ["LICENSE"]
 readme = "README.md"
 requires-python = ">= 3.10"
 classifiers = [
   "Programming Language :: Python :: 3",
-  "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Development Status :: 5 - Production/Stable",
   "Environment :: Console",

{dita_convert-1.2.2 → dita_convert-1.2.3}/src/dita/convert/__init__.py

@@ -28,7 +28,7 @@ __author__      = 'Jaromir Hradilek'
 __copyright__   = 'Copyright (C) 2024, 2025 Jaromir Hradilek'
 __license__     = 'MIT License'
 __description__ = __doc__
-__version__     = '1.2.2'
+__version__     = '1.2.3'
 
 # Expose general information about the project:
 NAME        = 'dita-convert'

{dita_convert-1.2.2 → dita_convert-1.2.3}/src/dita/convert/cli.py

@@ -32,7 +32,7 @@ from .transform import to_concept, to_reference, to_task, \
                        to_task_generated
 
 # Print a message to standard error output and terminate the script:
-def exit_with_error(error_message, exit_status=errno.EPERM):
+def exit_with_error(error_message: str, exit_status: int = errno.EPERM) -> None:
     # Print the supplied message to standard error output:
     print(f'{NAME}: {error_message}', file=sys.stderr)
 
@@ -40,7 +40,7 @@ def exit_with_error(error_message, exit_status=errno.EPERM):
     sys.exit(exit_status)
 
 # Extract the content type from the root element outputclass:
-def get_type(source_file, source_xml):
+def get_type(source_file: str, source_xml: etree._ElementTree) -> str:
     # Get the root element attributes:
     attributes = source_xml.getroot().attrib
 
@@ -49,17 +49,23 @@ def get_type(source_file, source_xml):
         exit_with_error(f'{source_file}: error: outputclass not found, use -t/--type', errno.EINVAL)
 
     # Get the outputclass attribute value:
-    output_class = attributes['outputclass'].lower()
+    output_class = str(attributes['outputclass'].lower())
 
     # Verify that the outputclass value is supported:
-    if output_class not in ['concept', 'procedure', 'task', 'reference']:
+    if output_class not in ['assembly', 'concept', 'procedure', 'task', 'reference']:
         exit_with_error(f'{source_file}: error: unsupported outputclass "{output_class}", use -t/--type', errno.EINVAL)
 
+    # Adjust the outputclass if needed:
+    if output_class == 'assembly':
+        output_class = output_class.replace('assembly', 'concept')
+    if output_class == 'procedure':
+        output_class = output_class.replace('procedure', 'task')
+
     # Return the adjusted outputclass:
-    return output_class.replace('procedure', 'task')
+    return output_class
 
 # Convert the selected file:
-def convert(source_file, target_type=None, generated=False):
+def convert(source_file: str, target_type: str | None = None, generated: bool = False) -> str:
     # Parse the source file:
     try:
         source_xml = etree.parse(source_file)
@@ -91,14 +97,15 @@ def convert(source_file, target_type=None, generated=False):
         exit_with_error(f'{source_file}: {message}')
 
     # Print any warning messages to standard error output:
-    for error in transform.error_log:
-        print(f'{source_file}: {error.message}', file=sys.stderr)
+    if hasattr(transform, 'error_log'):
+        for error in transform.error_log:
+            print(f'{source_file}: {error.message}', file=sys.stderr)
 
     # Return the result:
     return str(xml)
 
 # Parse supplied command-line options:
-def parse_args(argv=None):
+def parse_args(argv: list[str] | None = None) -> None:
     # Configure the option parser:
     parser = argparse.ArgumentParser(prog=NAME,
         description=DESCRIPTION,
@@ -151,7 +158,7 @@ def parse_args(argv=None):
     try:
         xml = convert(args.file, args.type, args.generated)
     except OSError as message:
-        exit_with_error(message, errno.ENOENT)
+        exit_with_error(str(message), errno.ENOENT)
 
     # Determine whether to write to standard output:
     if args.output == sys.stdout or args.output == '-':

{dita_convert-1.2.2 → dita_convert-1.2.3}/src/dita/convert/xslt/task-generated.xsl

@@ -112,7 +112,7 @@
       <!-- Compose the result element: -->
       <xsl:call-template name="compose-element">
         <xsl:with-param name="name" select="'result'" />
-        <xsl:with-param name="contents" select="*[not(@outputclass='title') and preceding-sibling::p[@outputclass='title'][1][b='Verification']]" />
+        <xsl:with-param name="contents" select="*[not(@outputclass='title') and preceding-sibling::p[@outputclass='title'][1][b='Verification' or b='Result' or b='Results']]" />
       </xsl:call-template>
       <!-- Compose the tasktroubleshooting element: -->
       <xsl:call-template name="compose-element">
@@ -122,7 +122,7 @@
       <!-- Compose the postreq element: -->
       <xsl:call-template name="compose-element">
         <xsl:with-param name="name" select="'postreq'" />
-        <xsl:with-param name="contents" select="*[not(@outputclass='title') and preceding-sibling::p[@outputclass='title'][1][b='Next steps' or b='Next step']]" />
+        <xsl:with-param name="contents" select="*[not(@outputclass='title') and preceding-sibling::p[@outputclass='title'][1][b='Next step' or b='Next steps']]" />
       </xsl:call-template>
     </xsl:element>
     <!-- Compose the related-links element: -->
@@ -132,7 +132,7 @@
 
     <!-- Issue a warning if the converted file contains an unsupported title:  -->
     <xsl:for-each select="p[@outputclass='title']/b/text()">
-      <xsl:variable name="titles" select="'|Prerequisites|Procedure|Verification|Troubleshooting|Troubleshooting steps|Next steps|Next step|Additional resources|'" />
+      <xsl:variable name="titles" select="'|Prerequisites|Procedure|Verification|Result|Results|Troubleshooting|Troubleshooting steps|Next steps|Next step|Additional resources|'" />
       <xsl:if test="not(contains($titles, concat('|', ., '|')))">
         <xsl:message terminate="no">WARNING: Unsupported title '<xsl:copy-of select="." />' found, skipping...</xsl:message>
       </xsl:if>

{dita_convert-1.2.2 → dita_convert-1.2.3}/src/dita_convert.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: dita-convert
-Version: 1.2.2
+Version: 1.2.3
 Summary: Convert a generic DITA topic to a specialized concept, task, or reference.
 Author-email: Jaromir Hradilek <jhradilek@gmail.com>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/jhradilek/dita-custom-xslt
 Project-URL: Repository, https://github.com/jhradilek/dita-custom-xslt
 Project-URL: Issues, https://github.com/jhradilek/dita-custom-xslt/issues
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{dita_convert-1.2.2 → dita_convert-1.2.3}/test/test_convert_cli.py

@@ -206,6 +206,15 @@ class TestDitaCli(unittest.TestCase):
         self.assertEqual(cm.exception.code, errno.ENOENT)
         self.assertRegex(err.getvalue(), rf'^{NAME}:.*topic\.dita')
 
+    def test_get_type_assembly(self):
+        xml = etree.parse(StringIO('<topic outputclass="assembly" />'))
+
+        with contextlib.redirect_stderr(StringIO()) as err:
+            target_type = cli.get_type('topic.dita', xml)
+
+        self.assertEqual(err.getvalue().rstrip(), '')
+        self.assertEqual(target_type, 'concept')
+
     def test_get_type_concept(self):
         xml = etree.parse(StringIO('<topic outputclass="concept" />'))
 

{dita_convert-1.2.2 → dita_convert-1.2.3}/test/test_convert_to_task_generated.py

@@ -308,7 +308,7 @@ class TestDitaConvertToTaskGenerated(unittest.TestCase):
                 <ol>
                     <li>Troubleshooting step</li>
                 </ol>
-                <p outputclass="title"><b>Next steps</b></p>
+                <p outputclass="title"><b>Next step</b></p>
                 <ul>
                     <li>Next step</li>
                 </ul>
@@ -335,6 +335,70 @@ class TestDitaConvertToTaskGenerated(unittest.TestCase):
         self.assertTrue(task.xpath('boolean(/task/taskbody/tasktroubleshooting/ol/li[text()="Troubleshooting step"])'))
         self.assertTrue(task.xpath('boolean(/task/taskbody/postreq/ul/li[text()="Next step"])'))
 
+    def test_result(self):
+        xml = etree.parse(StringIO('''\
+        <topic id="example-topic">
+            <body>
+                <p outputclass="title"><b>Result</b></p>
+                <ul>
+                    <li>Verification step</li>
+                </ul>
+            </body>
+        </topic>
+        '''))
+
+        task = transform.to_task_generated(xml)
+
+        self.assertTrue(task.xpath('boolean(/task/taskbody/result/ul/li[text()="Verification step"])'))
+
+    def test_results(self):
+        xml = etree.parse(StringIO('''\
+        <topic id="example-topic">
+            <body>
+                <p outputclass="title"><b>Results</b></p>
+                <ul>
+                    <li>Verification step</li>
+                </ul>
+            </body>
+        </topic>
+        '''))
+
+        task = transform.to_task_generated(xml)
+
+        self.assertTrue(task.xpath('boolean(/task/taskbody/result/ul/li[text()="Verification step"])'))
+
+    def test_troubleshooting_steps(self):
+        xml = etree.parse(StringIO('''\
+        <topic id="example-topic">
+            <body>
+                <p outputclass="title"><b>Troubleshooting steps</b></p>
+                <ol>
+                    <li>Troubleshooting step</li>
+                </ol>
+            </body>
+        </topic>
+        '''))
+
+        task = transform.to_task_generated(xml)
+
+        self.assertTrue(task.xpath('boolean(/task/taskbody/tasktroubleshooting/ol/li[text()="Troubleshooting step"])'))
+
+    def test_next_steps(self):
+        xml = etree.parse(StringIO('''\
+        <topic id="example-topic">
+            <body>
+                <p outputclass="title"><b>Next steps</b></p>
+                <ul>
+                    <li>Next step</li>
+                </ul>
+            </body>
+        </topic>
+        '''))
+
+        task = transform.to_task_generated(xml)
+
+        self.assertTrue(task.xpath('boolean(/task/taskbody/postreq/ul/li[text()="Next step"])'))
+
     def test_multiple_abstracts(self):
         xml = etree.parse(StringIO('''\
         <topic id="example-topic">