Merge pull request #142 from thephpleague/ordered-lists

Ordered list improvements

Author: colinodell

CHANGELOG.md

@@ -4,6 +4,12 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ## [Unreleased][unreleased]
 
+### Added
+ - Added support for ordered lists starting at numbers other than 1
+
+### Fixed
+ - Fixed overly-eager escaping of list-like text (#141)
+
 ## [4.5.0]
 ### Added
  - Added configuration option for list item style (#135, #136)

src/Converter/ListItemConverter.php

@@ -48,7 +48,11 @@ public function convert(ElementInterface $element)
             return $prefix . $list_item_style . ' ' . $value . "\n";
         }
 
-        $number = $element->getSiblingPosition();
+        if ($list_type === 'ol' && $start = $element->getParent()->getAttribute('start')) {
+            $number = $start + $element->getSiblingPosition() - 1;
+        } else {
+            $number = $element->getSiblingPosition();
+        }
 
         return $prefix . $number . '. ' . $value . "\n";
     }

src/Converter/ParagraphConverter.php

@@ -109,7 +109,8 @@ private function escapeOtherCharactersRegex($line)
     {
         $regExs = array(
             // Match numbers ending on ')' or '.' that are at the beginning of the line.
-            '/^[0-9]+(?=\)|\.)/'
+            // They will be escaped if immediately followed by a space or newline.
+            '/^[0-9]+(?=(\)|\.)( |$))/'
         );
 
         foreach ($regExs as $i) {

tests/HtmlConverterTest.php

@@ -133,6 +133,7 @@ public function test_lists()
         $this->html_gives_markdown("<ol>\n    <li>Item A</li>\n    <li>Item B</li>\n</ol>", "1. Item A\n2. Item B");
         $this->html_gives_markdown('<ol><li>   Item A</li><li>   Item B</li></ol>', "1. Item A\n2. Item B");
         $this->html_gives_markdown('<ol><li>  <h3> Item A</h3><p>Description</p></li><li>   Item B</li></ol>', "1. ###  Item A\n  \n  Description\n2. Item B");
+        $this->html_gives_markdown('<ol start="120"><li>Item A</li><li>Item B</li></ol>', "120. Item A\n121. Item B");
     }
 
     public function test_nested_lists()
@@ -142,6 +143,14 @@ public function test_nested_lists()
         $this->html_gives_markdown('<ol><li>Item A<ul><li>Nested A</li></ul></li><li>Item B</li></ol>', "1. Item A\n  - Nested A\n2. Item B");
     }
 
+    public function test_list_like_things_which_arent_lists()
+    {
+        $this->html_gives_markdown('<p>120.<p>', '120\.');
+        $this->html_gives_markdown('<p>120. <p>', '120\.');
+        $this->html_gives_markdown('<p>120.00<p>', '120.00');
+        $this->html_gives_markdown('<p>120.00 USD<p>', '120.00 USD');
+    }
+
     public function test_code_samples()
     {
         $this->html_gives_markdown('<code>&lt;p&gt;Some sample HTML&lt;/p&gt;</code>', '`<p>Some sample HTML</p>`');