Merge branch 'develop'

README.md

@@ -47,15 +47,15 @@ convert("[Winston Smith|~accountid:internal-id] woke up with the word 'Shakespea
 |------|----------|
 |`*strong*`|`**strong**`|
 |`_emphasis_`|Not converted (the same syntax)|
-|`??citation??`|Not converted|
+|`??citation??`|`<q>citation</q>`|
 |`-deleted-`|`~~deleted~~`|
 |`+inserted+`|`inserted`|
-|`^superscript^`|Not converted|
-|`~subscript~`|Not converted|
+|`^superscript^`|`<sup>superscript</sup>`|
+|`~subscript~`|`<sub>subscript</sub>`|
 |`{{monospaced}}`|`` `monospaced` ``|
 |`bq. Some block quoted text`|`> Some block quoted text`|
 |`{quote}Content to be quoted{quote}`|`> Content to be quoted`|
-|`{color:red}red text!{color}`|`<font color="red">red text!<font>`|
+|`{color:red}red text!{color}`|`<font color="red">red text!</font>`|
 
 ## Text Breaks
 
@@ -260,12 +260,18 @@ preformatted piece of text
 <td>
 
 ```
+{panel:title=My Title}
+Some text with a title
 {panel}
-Some text
-{panel}
 ```
 </td>
-<td>Not supported</td>
+<td>
+
+```
+> **My Title**
+> Some text with a title
+```
+</td>
 </tr>
 <tr>
 <td>

jira2markdown/markup/advanced.py

@@ -1,4 +1,5 @@
-from pyparsing import Combine, FollowedBy, Optional, ParseResults, ParserElement, QuotedString, SkipTo, Word, alphanums
+from pyparsing import Combine, FollowedBy, Forward, Group, Literal, OneOrMore, Optional, ParseResults, ParserElement, \
+    QuotedString, SkipTo, Suppress, Word, alphanums, alphas
 
 
 class Noformat:
@@ -30,3 +31,34 @@ def expr(self) -> ParserElement:
             + SkipTo("{code}").setResultsName("text")
             + "{code}",
         ).setParseAction(self.action)
+
+
+class Panel:
+    def __init__(self, markup: Forward):
+        self.markup = markup
+
+    def action(self, tokens: ParseResults) -> str:
+        text = self.markup.transformString(tokens.text.strip())
+
+        for param, value in tokens.get("params", []):
+            if param.lower() == "title":
+                text = f"**{value}**\n{text}"
+
+        return "\n".join([f"> {line.lstrip()}" for line in text.splitlines()])
+
+    @property
+    def expr(self) -> ParserElement:
+        PARAM = Word(alphas) \
+            + Suppress("=") \
+            + SkipTo(Literal("|") | Literal("}")) \
+            + Optional("|").suppress()
+
+        return Combine(
+            "{panel"
+            + Optional(
+                ":" + OneOrMore(Group(PARAM), stopOn="}").setResultsName("params"),
+            )
+            + "}"
+            + SkipTo("{panel}").setResultsName("text")
+            + "{panel}",
+        ).setParseAction(self.action)

jira2markdown/markup/images.py

@@ -1,6 +1,7 @@
-from pyparsing import Combine, Optional, ParseResults, ParserElement, SkipTo, Word, printables
+import re
 
-from jira2markdown.tokens import NotUnicodeAlphaNum
+from pyparsing import Combine, Optional, ParseResults, ParserElement, PrecededBy, Regex, SkipTo, StringStart, Word, \
+    printables
 
 
 class Image:
@@ -9,7 +10,7 @@ def action(self, tokens: ParseResults) -> str:
 
     @property
     def expr(self) -> ParserElement:
-        return NotUnicodeAlphaNum() + Combine(
+        return (StringStart() | PrecededBy(Regex(r"\W", flags=re.UNICODE), retreat=1)) + Combine(
             "!"
             + Word(printables + " ", min=3, excludeChars="|!").setResultsName("url")
             + Optional("|")

jira2markdown/markup/links.py

@@ -1,5 +1,7 @@
-from pyparsing import CaselessLiteral, Combine, Forward, Optional, ParseResults, ParserElement, SkipTo, Suppress,\
-    Word, alphanums
+from string import punctuation
+
+from pyparsing import CaselessLiteral, Char, Combine, FollowedBy, Forward, Optional, ParseResults, ParserElement, \
+    PrecededBy, SkipTo, StringEnd, StringStart, Suppress, White, Word, alphanums
 
 
 class MailTo:
@@ -59,7 +61,7 @@ def action(self, tokens: ParseResults) -> str:
 
     @property
     def expr(self) -> ParserElement:
-        return Combine(
+        MENTION = Combine(
             "["
             + Optional(
                 SkipTo("|", failOn="]") + Suppress("|"),
@@ -69,4 +71,8 @@ def expr(self) -> ParserElement:
             + Optional(CaselessLiteral("accountid:"))
             + Word(alphanums + ":-").setResultsName("accountid")
             + "]",
-        ).setParseAction(self.action)
+        )
+        return (StringStart() | Optional(PrecededBy(White(), retreat=1), default=" ")) \
+            + MENTION.setParseAction(self.action) \
+            + (StringEnd()
+               | Optional(FollowedBy(White() | Char(punctuation, excludeChars="[") | MENTION), default=" "))

jira2markdown/markup/tables.py

@@ -1,7 +1,6 @@
-from pyparsing import Forward, Group, LineEnd, LineStart, Literal, OneOrMore, Optional, ParseResults, ParserElement, \
-    SkipTo, StringEnd, ZeroOrMore
+from pyparsing import Combine, Forward, Group, LineEnd, LineStart, Literal, OneOrMore, Optional, ParseResults, \
+    ParserElement, SkipTo, StringEnd, StringStart, White, ZeroOrMore
 
-from jira2markdown.expressions import StepBack
 from jira2markdown.markup.images import Image
 from jira2markdown.markup.links import Link, MailTo, Mention
 
@@ -32,20 +31,21 @@ def action(self, tokens: ParseResults) -> str:
         # Insert header delimiter after the first row
         output.insert(1, "|" + "-|" * max(max_columns_count, 1))
 
-        return "\n" + "\n".join(output) + "\n"
+        return "\n".join(output) + "\n"
 
     @property
     def expr(self) -> ParserElement:
         NL = LineEnd().suppress()
         SEP = (Literal("||") | Literal("|")).suppress()
         ROW_BREAK = NL + SEP | NL + NL | StringEnd()
-        IGNORE = StepBack([Link(self.markup).expr, MailTo().expr, Image().expr, Mention({}).expr])
+        IGNORE = Link(self.markup).expr | MailTo().expr | Image().expr | Mention({}).expr
 
         ROW = SEP + ZeroOrMore(
-            SkipTo(SEP, ignore=IGNORE, failOn=ROW_BREAK) + Optional(SEP),
+            SkipTo(SEP | ROW_BREAK, ignore=IGNORE) + Optional(SEP),
             stopOn=ROW_BREAK | NL + ~SEP,
         )
 
-        return Optional(LineEnd(), default="\n") \
+        EMPTY_LINE = Combine("\n" + White(" \t", min=0) + "\n")
+        return ((StringStart() + Optional("\n")) ^ Optional(EMPTY_LINE, default="\n")) \
             + OneOrMore(LineStart() + Group(ROW) + NL).setParseAction(self.action) \
-            + Optional(LineEnd(), default="\n")
+            + (StringEnd() | Optional(LineEnd(), default="\n"))

jira2markdown/markup/text_effects.py

@@ -1,8 +1,10 @@
+import re
+
 from pyparsing import CaselessLiteral, Char, Combine, Forward, LineEnd, Literal, Optional, ParseResults, \
-    ParserElement, QuotedString, SkipTo, StringStart, Suppress, White, Word, WordEnd, WordStart, alphanums, alphas, \
-    hexnums, nums, replaceWith
+    ParserElement, PrecededBy, QuotedString, Regex, SkipTo, StringStart, Suppress, White, Word, WordEnd, WordStart, \
+    alphanums, alphas, hexnums, nums, replaceWith
 
-from jira2markdown.tokens import NotUnicodeAlphaNum
+from jira2markdown.markup.links import Attachment, Mention
 
 
 class Bold:
@@ -16,7 +18,7 @@ def action(self, tokens: ParseResults) -> str:
     def expr(self) -> ParserElement:
         TOKEN = Suppress("*")
         IGNORE = White() + TOKEN | Color(self.markup).expr
-        return NotUnicodeAlphaNum() + Combine(
+        return (StringStart() | PrecededBy(Regex(r"\W", flags=re.UNICODE), retreat=1)) + Combine(
             TOKEN
             + (~White() & ~TOKEN)
             + SkipTo(TOKEN, ignore=IGNORE, failOn=LineEnd())
@@ -63,6 +65,63 @@ def expr(self) -> ParserElement:
         ).setParseAction(self.action) + WordEnd()
 
 
+class InlineQuote:
+    def __init__(self, markup: Forward):
+        self.markup = markup
+
+    def action(self, tokens: ParseResults) -> str:
+        return "<q>" + self.markup.transformString(tokens[0]) + "</q>"
+
+    @property
+    def expr(self) -> ParserElement:
+        TOKEN = Suppress("??")
+        IGNORE = White() + TOKEN | Color(self.markup).expr
+        return WordStart() + Combine(
+            TOKEN
+            + ~White()
+            + SkipTo(TOKEN, ignore=IGNORE, failOn="\n")
+            + TOKEN,
+        ).setParseAction(self.action) + WordEnd()
+
+
+class Superscript:
+    def __init__(self, markup: Forward):
+        self.markup = markup
+
+    def action(self, tokens: ParseResults) -> str:
+        return "<sup>" + self.markup.transformString(tokens[0]) + "</sup>"
+
+    @property
+    def expr(self) -> ParserElement:
+        TOKEN = Suppress("^")
+        IGNORE = White() + TOKEN | Color(self.markup).expr | Attachment().expr
+        return WordStart() + Combine(
+            TOKEN
+            + ~White()
+            + SkipTo(TOKEN, ignore=IGNORE, failOn="\n")
+            + TOKEN,
+        ).setParseAction(self.action) + WordEnd()
+
+
+class Subscript:
+    def __init__(self, markup: Forward):
+        self.markup = markup
+
+    def action(self, tokens: ParseResults) -> str:
+        return "<sub>" + self.markup.transformString(tokens[0]) + "</sub>"
+
+    @property
+    def expr(self) -> ParserElement:
+        TOKEN = Suppress("~")
+        IGNORE = White() + TOKEN | Color(self.markup).expr | Mention({}).expr
+        return WordStart() + Combine(
+            TOKEN
+            + ~White()
+            + SkipTo(TOKEN, ignore=IGNORE, failOn="\n")
+            + TOKEN,
+        ).setParseAction(self.action) + WordEnd()
+
+
 class Color:
     def __init__(self, markup: Forward):
         self.markup = markup

jira2markdown/parser.py

@@ -2,15 +2,15 @@
 
 from pyparsing import Forward, ParserElement
 
-from jira2markdown.markup.advanced import Code, Noformat
+from jira2markdown.markup.advanced import Code, Noformat, Panel
 from jira2markdown.markup.headings import Headings
 from jira2markdown.markup.images import Image
 from jira2markdown.markup.links import Attachment, Link, MailTo, Mention
 from jira2markdown.markup.lists import OrderedList, UnorderedList
 from jira2markdown.markup.tables import Table
 from jira2markdown.markup.text_breaks import LineBreak, Mdash, Ndash, Ruler
-from jira2markdown.markup.text_effects import BlockQuote, Bold, Color, EscSpecialChars, Monospaced, Quote, \
-    Strikethrough, Underline
+from jira2markdown.markup.text_effects import BlockQuote, Bold, Color, EscSpecialChars, InlineQuote, Monospaced, \
+    Quote, Strikethrough, Subscript, Superscript, Underline
 
 ParserElement.setDefaultWhitespaceChars(" \t")
 
@@ -33,12 +33,16 @@ def convert(text: str, usernames: Optional[dict] = None) -> str:
         Headings().expr | \
         Quote().expr | \
         BlockQuote(markup).expr | \
+        Panel(markup).expr | \
         Bold(markup).expr | \
         Ndash().expr | \
         Mdash().expr | \
         Ruler().expr | \
         Strikethrough(markup).expr | \
         Underline(markup).expr | \
+        InlineQuote(markup).expr | \
+        Superscript(markup).expr | \
+        Subscript(markup).expr | \
         Color(markup).expr | \
         LineBreak().expr | \
         EscSpecialChars().expr

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jira2markdown"
-version = "0.1.7"
+version = "0.1.8"
 description = "Convert text from JIRA markup to Markdown using parsing expression grammars"
 authors = ["Evgeniy Krysanov <[email protected]>"]
 readme = "README.md"