Merge branch 'heading-contains-italics'

* heading-contains-italics:
  Add message text
  Ignore underscores in codeblocks
  Fix typo
  Fix text numbers
  Add more complex edge cases for italic in headings
  Support all test cases in italic_in_heading
  Treat underscore for italic and underscore as text

Author: naokazuterada

markdowntoc/id.py

@@ -18,8 +18,8 @@ def heading_to_id(self, heading):
         if self.markdown_preview == 'github':
             _h1 = self.postprocess_inject_header_id('<h1>%s</h1>' % heading)
             pattern = r'<h1 id="(.*)">.*</h1>'
-            matchs = re.finditer(pattern, _h1)
-            for match in matchs:
+            matches = re.finditer(pattern, _h1)
+            for match in matches:
                 return match.groups()[0]
         elif self.markdown_preview == 'markdown':
             return self.slugify(heading, '-')
@@ -34,6 +34,20 @@ def heading_to_id(self, heading):
             return self.do_id_replacements(_id)
 
     def do_id_replacements(self, _str):
+
+        # **Ignore the texts in codeblocks
+        # **[1] stock and take over codeblocks
+        matches = re.finditer(r'`([^`]*)`', _str)
+        _str = re.sub(r'`([^`]*)`', '[codeblock]', _str)
+
+        # Treat '_' for italic and '_' as text
+        _str = re.sub(r'_([^_ ]{1}.*[^_ ]{1})_', '\\1', _str)
+
+        # **[2] recover codeblocks
+        for match in matches:
+            _str = _str.replace('[codeblock]', match.groups()[0], 1)
+
+        # User setting replacements
         for group in self.id_replacements:
             _str = re.sub(group['pattern'], group['replacement'], _str)
         return _str

messages/3.0.4.md

@@ -0,0 +1,13 @@
+# MarkdownTOC - 3.0.4
+
+---
+
+**NOTE: 3.x has "breacking chnages"**
+
+If you are using 3.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) at first.
+
+---
+
+## Changes
+
+- Fix anchor problem for italic texts Ref: [#136](https://github.com/naokazuterada/MarkdownTOC/issues/136)

tests/italic_in_heading.py

@@ -0,0 +1,75 @@
+# coding:utf-8
+from base import TestBase
+
+class TestItalic(TestBase):
+    """Test for attributes 'bracket'"""
+
+    # for debug
+    # def tearDown(self):
+    #     pass
+
+    # TODO: How can we remove "autolink=true" only in these tests below ?
+
+    bracket_text = \
+"""
+
+<!-- MarkdownTOC autolink=true -->
+
+<!-- /MarkdownTOC -->
+
+# this is _italic_
+# _this is italic_
+# _this is not italic __
+# this _is italic_
+# _ this is not italic _
+# 2 _ this is not italic _
+# _this is not italic with markdown error _
+# 2 _this is not italic with markdown error _
+# `_should ignore underscores in codeblocks_`
+# `_should ignore underscores in codeblocks 2_ `
+# this is ` _more complex_ ` exmaple
+"""
+
+    def test_italic_in_inheading1(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [this is _italic_](#this-is-italic)', toc)
+
+    def test_italic_in_inheading2(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [_this is italic_](#this-is-italic-1)', toc)
+
+    def test_italic_in_inheading3(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [_this is not italic __](#_this-is-not-italic-__)', toc)
+
+    def test_italic_in_inheading4(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [this _is italic_](#this-is-italic-2)', toc)
+
+    def test_italic_in_inheading5(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [_ this is not italic _](#_-this-is-not-italic-_)', toc)
+
+    def test_italic_in_inheading6(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [2 _ this is not italic _](#2-_-this-is-not-italic-_)', toc)
+
+    def test_italic_in_inheading7(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [_this is not italic with markdown error _](#_this-is-not-italic-with-markdown-error-_)', toc)
+
+    def test_italic_in_inheading8(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [2 _this is not italic with markdown error _](#2-_this-is-not-italic-with-markdown-error-_)', toc)
+
+    def test_italic_in_inheading9(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [`_should ignore underscores in codeblocks_`](#_should-ignore-underscores-in-codeblocks_)', toc)
+
+    def test_italic_in_inheading10(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [`_should ignore underscores in codeblocks 2_ `](#_should-ignore-underscores-in-codeblocks-2_-)', toc)
+
+    def test_italic_in_inheading11(self):
+        toc = self.init_update(self.bracket_text)['toc']
+        self.assert_In('- [this is ` _more complex_ ` exmaple](#this-is-_more-complex_-exmaple)', toc)