Magiclink support for custom autolinked references

pymdownx/magiclink.py

@@ -86,6 +86,15 @@
 # Internal mention patterns
 RE_INT_MENTIONS = r'(?P<mention>(?<![a-zA-Z])@{})\b'
 
+# Custom references
+RE_CUSTOM_REFS_TEMPLATE = r'''(?xi)
+    (?:(?<=\b)|(?<=_))(?:
+        (?P<prefix>%s)                                      # prefix; to be injected
+        (?P<id>\w+)                                         # identifier
+    )
+'''
+
+
 def create_ext_mentions(name, provider_type):
     """Create external mentions by provider type."""
 
@@ -1036,6 +1045,33 @@ def handleMatch(self, m, data):
         return el, m.start(0), m.end(0)
 
 
+class MagiclinkCustomRefPattern(InlineProcessor):
+    """Return a link Element given a custom prefix."""
+
+    ANCESTOR_EXCLUDES = ('a',)
+
+    def __init__(self, pattern, md, shortname, target_url):
+        """Initialize."""
+
+        self.shortname = shortname
+        self.target_url = target_url
+        InlineProcessor.__init__(self, pattern, md)
+
+    def handleMatch(self, m, data):
+        """Return link."""
+
+        el = etree.Element("a")
+        prefix = m.group(1)
+        identifier = m.group(2)
+        el.set('href', self.target_url.replace('<id>', identifier))
+        el.text = prefix + identifier
+
+        el.set('class', f'magiclink magiclink-customref magiclink-customref-{self.shortname}')
+
+        return el, m.start(0), m.end(0)
+
+
+
 class MagiclinkExtension(Extension):
     """Add auto link and link transformation extensions to Markdown class."""
 
@@ -1097,6 +1133,10 @@ def __init__(self, *args, **kwargs):
             'custom': [
                 {},
                 "Custom repositories hosts - Default {}"
+            ],
+            'custom_refs': [
+                [],
+                "Custom reference patterns - Default []"
             ]
         }
         super().__init__(*args, **kwargs)
@@ -1115,6 +1155,17 @@ def setup_autolinks(self, md, config):
 
         md.inlinePatterns.register(MagiclinkMailPattern(RE_MAIL, md), "magic-mail", 84.9)
 
+    def setup_custom_refs(self, md, config):
+        """Setup custom refs."""
+
+        for custom_ref_config in config.get('custom_refs', []):
+            ref_prefix = custom_ref_config['ref_prefix']
+            target_url = custom_ref_config['target_url']
+            pattern_re = RE_CUSTOM_REFS_TEMPLATE % ref_prefix
+            shortname = re.sub(r'\W+', '', ref_prefix).lower()
+            pattern = MagiclinkCustomRefPattern(pattern_re, md, shortname, target_url)
+            md.inlinePatterns.register(pattern, "customref-" + shortname, 120)
+
     def setup_shorthand(self, md):
         """Setup shorthand."""
 
@@ -1308,6 +1359,7 @@ def extendMarkdown(self, md):
             self.provider = 'github'
 
         self.setup_autolinks(md, config)
+        self.setup_custom_refs(md, config)
 
         if self.git_short or self.social_short:
             self.ext_mentions = []

tests/test_extensions/test_magiclink.py

@@ -399,3 +399,65 @@ def test_deprecated_twitter_shortener(self):
             self.assertTrue(len(w) == 1)
             self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
             self.assertTrue(found)
+
+class TestMagicLinkCustomRefs(util.MdCase):
+    """Test cases for custom references."""
+
+    extension = [
+        'pymdownx.magiclink'
+    ]
+
+    extension_configs = {
+        'pymdownx.magiclink': {
+            'custom_refs': [
+                {
+                    'ref_prefix': 'TICKET-',
+                    'target_url': 'https://ticket.test.com/TICKET-<id>'
+                },
+                {
+                    'ref_prefix': 'go/',
+                    'target_url': 'https://go.test.com/<id>'
+                },
+            ]
+        }
+    }
+
+    def test_numeric(self):
+        """Test numeric identifiers."""
+
+        self.check_markdown(
+            'TICKET-123',
+            '<p><a class="magiclink magiclink-customref magiclink-customref-ticket" href="https://ticket.test.com/TICKET-123">TICKET-123</a></p>'  # noqa: E501
+        )
+
+    def test_word_boundary(self):
+        """Test numeric identifiers."""
+
+        self.check_markdown(
+            'Hello, TICKET-123!',
+            '<p>Hello, <a class="magiclink magiclink-customref magiclink-customref-ticket" href="https://ticket.test.com/TICKET-123">TICKET-123</a>!</p>'  # noqa: E501
+        )
+
+    def test_alphanumeric(self):
+        """Test alphanumeric identifiers."""
+
+        self.check_markdown(
+            'go/abc123',
+            '<p><a class="magiclink magiclink-customref magiclink-customref-go" href="https://go.test.com/abc123">go/abc123</a></p>'  # noqa: E501
+        )
+
+    def test_underscores(self):
+        """Test underscore counts as a word character."""
+
+        self.check_markdown(
+            'go/abc_123',
+            '<p><a class="magiclink magiclink-customref magiclink-customref-go" href="https://go.test.com/abc_123">go/abc_123</a></p>'  # noqa: E501
+        )
+
+    def test_hyphen(self):
+        """Test hyphen breaks matching."""
+
+        self.check_markdown(
+            'go/abc-123',
+            '<p><a class="magiclink magiclink-customref magiclink-customref-go" href="https://go.test.com/abc">go/abc</a>-123</p>'  # noqa: E501
+        )