Merge pull request #19 from livio/inline-platform-sections

Add Inline platform sections

Author: jemerick

HISTORY.rst

@@ -2,6 +2,11 @@
 History
 =======
 
+0.2.3 (2019-06-06)
+------------------
+
+* Add support for inline platform section tags
+
 0.2.2 (2019-06-05)
 ------------------
 

docdown/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Jason Emerick"""
 __email__ = 'jason@mobelux.com'
-__version__ = '0.2.2'
+__version__ = '0.2.3'

docdown/platform_section.py

@@ -17,32 +17,55 @@
 
 class PlatformSectionPreprocessor(Preprocessor):
 
-    RE = re.compile(r'''
+    BLOCK_RE = re.compile(r'''
 ^@!\[(?P<sections>[\w, ]+)\]\W*\n
 (?P<content>.*?)(?<=\n)
 !@\W*$''', re.MULTILINE | re.DOTALL | re.VERBOSE)
 
+    INLINE_RE = re.compile(r'''@!\[(?P<sections>[\w, ]+)\](?P<content>.*?)!@''', re.DOTALL | re.VERBOSE)
+
     def __init__(self, platform_section, **kwargs):
         self.platform_section = platform_section.lower().strip()
         super(PlatformSectionPreprocessor, self).__init__(**kwargs)
 
     def run(self, lines):
         text = "\n".join(lines)
+        text = self.process_inline(text)
+        text = self.process_block(text)
+        return text.split("\n")
+
+    def split_sections(self, sections_group):
+        return [section.lower().strip() for section in sections_group.split(',')]
+
+    def process_inline(self, text):
         while 1:
-            m = self.RE.search(text)
+            m = self.INLINE_RE.search(text)
             if m:
-                sections = [section.lower().strip() for section in m.group('sections').split(',')]
+                sections = self.split_sections(m.group('sections'))
 
-                content = m.group('content')
+                if self.platform_section in sections:
+                    content = m.group('content')
+                    text = '%s%s%s' % (text[:m.start()], content, text[m.end():])
+                else:
+                    text = '%s%s' % (text[:m.start()], text[m.end():])
+            else:
+                break
+        return text
+
+    def process_block(self, text):
+        while 1:
+            m = self.BLOCK_RE.search(text)
+            if m:
+                sections = self.split_sections(m.group('sections'))
 
                 if self.platform_section in sections:
+                    content = m.group('content')
                     text = '%s\n%s\n%s' % (text[:m.start()], content, text[m.end():])
                 else:
                     text = '%s\n%s' % (text[:m.start()], text[m.end():])
             else:
                 break
-
-        return text.split("\n")
+        return text
 
 
 class PlatformSectionExtension(Extension):

docs/extensions/platform_sections.rst

@@ -37,6 +37,13 @@ In documents
    This section will be displayed for Java SE and EE builds.
    !@
 
+Inline platform section tags are also supported:
+
+.. code-block:: html5
+
+   ### 1. Creating an App Service Manifest
+   The first step to publishing is to create an @![iOS]`SDLAppServiceManifest`!@ @![Android, JavaSE, JavaEE]`AppServiceManifest`!@ object.
+
 Python
 --------------
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.2
+current_version = 0.2.3
 commit = True
 tag = True
 

setup.py

@@ -20,7 +20,7 @@
 
 setup(
     name='docdown',
-    version='0.2.2',
+    version='0.2.3',
     description="DocDown is a Markdown extension for source code documentation.",
     long_description=readme + '\n\n' + history,
     author="Jason Emerick, Justin Michalicek",

tests/test_platform_section_extension.py

@@ -183,3 +183,34 @@ def test_multiple_sections_with_code_snippet(self):
         )
         expected_output = '<p>some Android content shown</p>\n<p><code>java\nString java = "asdf";</code></p>'
         self.assertEqual(expected_output, html)
+
+    def test_inline_platform_section(self):
+        text = ('### 1. Creating an App Service Manifest\n'
+                'The first step to publishing is to create an @![iOS]`SDLAppServiceManifest`!@ @![Android, JavaSE, JavaEE]`AppServiceManifest`!@ object.\n')
+
+        html = markdown.markdown(
+            text,
+            extension_configs=self.build_config_for_platform_section('Android'),
+            extensions=self.MARKDOWN_EXTENSIONS,
+            output_format='html5'
+        )
+        expected_output = '<h3>1. Creating an App Service Manifest</h3>\n<p>The first step to publishing is to create an  <code>AppServiceManifest</code> object.</p>'
+        self.assertEqual(expected_output, html)
+
+        html = markdown.markdown(
+            text,
+            extension_configs=self.build_config_for_platform_section('JavaEE'),
+            extensions=self.MARKDOWN_EXTENSIONS,
+            output_format='html5'
+        )
+        expected_output = '<h3>1. Creating an App Service Manifest</h3>\n<p>The first step to publishing is to create an  <code>AppServiceManifest</code> object.</p>'
+        self.assertEqual(expected_output, html)
+
+        html = markdown.markdown(
+            text,
+            extension_configs=self.build_config_for_platform_section('iOS'),
+            extensions=self.MARKDOWN_EXTENSIONS,
+            output_format='html5'
+        )
+        expected_output = '<h3>1. Creating an App Service Manifest</h3>\n<p>The first step to publishing is to create an <code>SDLAppServiceManifest</code>  object.</p>'
+        self.assertEqual(expected_output, html)