Merge pull request #366 from thephpleague/finalize-all-the-things

colinodell · web-flow · commit 976c4ebdebdb · 2019-05-25T16:58:26.000-04:00
"Final"ize all the things
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
  - Extracted some new interfaces from base classes:
    - `DocParserInterface` created from `DocParser`
    - `ConfigurationInterface` created from `Configuration`
+   - `ReferenceInterface` created from `Reference`
 
 ### Changed
 
@@ -31,6 +32,9 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
    - `DocParser`
    - `HtmlRenderer`
    - `InlineParserEngine`
+   - `NodeWalker`
+   - `Reference`
+   - All of the block/inline parsers and renderers
  - Reduced visibility of several internal methods to `private`:
     - `DelimiterStack::findEarliest()`
     - All `protected` methods in `InlineParserEngine`
diff --git a/src/Block/Parser/ATXHeadingParser.php b/src/Block/Parser/ATXHeadingParser.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Cursor;
 use League\CommonMark\Util\RegexHelper;
 
-class ATXHeadingParser implements BlockParserInterface
+final class ATXHeadingParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/BlockQuoteParser.php b/src/Block/Parser/BlockQuoteParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\ContextInterface;
 use League\CommonMark\Cursor;
 
-class BlockQuoteParser implements BlockParserInterface
+final class BlockQuoteParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/FencedCodeParser.php b/src/Block/Parser/FencedCodeParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\ContextInterface;
 use League\CommonMark\Cursor;
 
-class FencedCodeParser implements BlockParserInterface
+final class FencedCodeParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/HtmlBlockParser.php b/src/Block/Parser/HtmlBlockParser.php
@@ -20,7 +20,7 @@
 use League\CommonMark\Cursor;
 use League\CommonMark\Util\RegexHelper;
 
-class HtmlBlockParser implements BlockParserInterface
+final class HtmlBlockParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/IndentedCodeParser.php b/src/Block/Parser/IndentedCodeParser.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ContextInterface;
 use League\CommonMark\Cursor;
 
-class IndentedCodeParser implements BlockParserInterface
+final class IndentedCodeParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/LazyParagraphParser.php b/src/Block/Parser/LazyParagraphParser.php
@@ -17,7 +17,7 @@
 use League\CommonMark\ContextInterface;
 use League\CommonMark\Cursor;
 
-class LazyParagraphParser implements BlockParserInterface
+final class LazyParagraphParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/ListParser.php b/src/Block/Parser/ListParser.php
@@ -22,7 +22,7 @@
 use League\CommonMark\Cursor;
 use League\CommonMark\Util\RegexHelper;
 
-class ListParser implements BlockParserInterface
+final class ListParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/SetExtHeadingParser.php b/src/Block/Parser/SetExtHeadingParser.php
@@ -21,7 +21,7 @@
 use League\CommonMark\ReferenceParser;
 use League\CommonMark\Util\RegexHelper;
 
-class SetExtHeadingParser implements BlockParserInterface
+final class SetExtHeadingParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Parser/ThematicBreakParser.php b/src/Block/Parser/ThematicBreakParser.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Cursor;
 use League\CommonMark\Util\RegexHelper;
 
-class ThematicBreakParser implements BlockParserInterface
+final class ThematicBreakParser implements BlockParserInterface
 {
     /**
      * @param ContextInterface $context
diff --git a/src/Block/Renderer/BlockQuoteRenderer.php b/src/Block/Renderer/BlockQuoteRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class BlockQuoteRenderer implements BlockRendererInterface
+final class BlockQuoteRenderer implements BlockRendererInterface
 {
     /**
      * @param BlockQuote               $block
diff --git a/src/Block/Renderer/DocumentRenderer.php b/src/Block/Renderer/DocumentRenderer.php
@@ -18,7 +18,7 @@
 use League\CommonMark\Block\Element\Document;
 use League\CommonMark\ElementRendererInterface;
 
-class DocumentRenderer implements BlockRendererInterface
+final class DocumentRenderer implements BlockRendererInterface
 {
     /**
      * @param AbstractBlock|Document   $block
diff --git a/src/Block/Renderer/FencedCodeRenderer.php b/src/Block/Renderer/FencedCodeRenderer.php
@@ -20,7 +20,7 @@
 use League\CommonMark\HtmlElement;
 use League\CommonMark\Util\Xml;
 
-class FencedCodeRenderer implements BlockRendererInterface
+final class FencedCodeRenderer implements BlockRendererInterface
 {
     /**
      * @param FencedCode               $block
diff --git a/src/Block/Renderer/HeadingRenderer.php b/src/Block/Renderer/HeadingRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class HeadingRenderer implements BlockRendererInterface
+final class HeadingRenderer implements BlockRendererInterface
 {
     /**
      * @param Heading                  $block
diff --git a/src/Block/Renderer/HtmlBlockRenderer.php b/src/Block/Renderer/HtmlBlockRenderer.php
@@ -21,7 +21,7 @@
 use League\CommonMark\Util\ConfigurationAwareInterface;
 use League\CommonMark\Util\ConfigurationInterface;
 
-class HtmlBlockRenderer implements BlockRendererInterface, ConfigurationAwareInterface
+final class HtmlBlockRenderer implements BlockRendererInterface, ConfigurationAwareInterface
 {
     /**
      * @var ConfigurationInterface
diff --git a/src/Block/Renderer/IndentedCodeRenderer.php b/src/Block/Renderer/IndentedCodeRenderer.php
@@ -20,7 +20,7 @@
 use League\CommonMark\HtmlElement;
 use League\CommonMark\Util\Xml;
 
-class IndentedCodeRenderer implements BlockRendererInterface
+final class IndentedCodeRenderer implements BlockRendererInterface
 {
     /**
      * @param AbstractBlock            $block
diff --git a/src/Block/Renderer/ListBlockRenderer.php b/src/Block/Renderer/ListBlockRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class ListBlockRenderer implements BlockRendererInterface
+final class ListBlockRenderer implements BlockRendererInterface
 {
     /**
      * @param ListBlock                $block
diff --git a/src/Block/Renderer/ListItemRenderer.php b/src/Block/Renderer/ListItemRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class ListItemRenderer implements BlockRendererInterface
+final class ListItemRenderer implements BlockRendererInterface
 {
     /**
      * @param ListItem                 $block
diff --git a/src/Block/Renderer/ParagraphRenderer.php b/src/Block/Renderer/ParagraphRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class ParagraphRenderer implements BlockRendererInterface
+final class ParagraphRenderer implements BlockRendererInterface
 {
     /**
      * @param Paragraph                $block
diff --git a/src/Block/Renderer/ThematicBreakRenderer.php b/src/Block/Renderer/ThematicBreakRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\ElementRendererInterface;
 use League\CommonMark\HtmlElement;
 
-class ThematicBreakRenderer implements BlockRendererInterface
+final class ThematicBreakRenderer implements BlockRendererInterface
 {
     /**
      * @param ThematicBreak            $block
diff --git a/src/Inline/Parser/AutolinkParser.php b/src/Inline/Parser/AutolinkParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\InlineParserContext;
 use League\CommonMark\Util\UrlEncoder;
 
-class AutolinkParser implements InlineParserInterface
+final class AutolinkParser implements InlineParserInterface
 {
     const EMAIL_REGEX = '/^<([a-zA-Z0-9.!#$%&\'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*)>/';
     const OTHER_LINK_REGEX = '/^<[A-Za-z][A-Za-z0-9.+-]{1,31}:[^<>\x00-\x20]*>/i';
diff --git a/src/Inline/Parser/BacktickParser.php b/src/Inline/Parser/BacktickParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\Inline\Element\Text;
 use League\CommonMark\InlineParserContext;
 
-class BacktickParser implements InlineParserInterface
+final class BacktickParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/BangParser.php b/src/Inline/Parser/BangParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\Inline\Element\Text;
 use League\CommonMark\InlineParserContext;
 
-class BangParser implements InlineParserInterface
+final class BangParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/CloseBracketParser.php b/src/Inline/Parser/CloseBracketParser.php
@@ -23,17 +23,17 @@
 use League\CommonMark\Inline\Element\Image;
 use League\CommonMark\Inline\Element\Link;
 use League\CommonMark\InlineParserContext;
-use League\CommonMark\Reference\Reference;
+use League\CommonMark\Reference\ReferenceInterface;
 use League\CommonMark\Reference\ReferenceMap;
 use League\CommonMark\Util\LinkParserHelper;
 use League\CommonMark\Util\RegexHelper;
 
-class CloseBracketParser implements InlineParserInterface, EnvironmentAwareInterface
+final class CloseBracketParser implements InlineParserInterface, EnvironmentAwareInterface
 {
     /**
      * @var EnvironmentInterface
      */
-    protected $environment;
+    private $environment;
 
     /**
      * @return string[]
@@ -121,7 +121,7 @@ public function setEnvironment(EnvironmentInterface $environment)
      *
      * @return array|bool
      */
-    protected function tryParseLink(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, int $startPos)
+    private function tryParseLink(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, int $startPos)
     {
         // Check to see if we have a link/image
         // Inline link?
@@ -141,7 +141,7 @@ protected function tryParseLink(Cursor $cursor, ReferenceMap $referenceMap, Deli
      *
      * @return array|bool
      */
-    protected function tryParseInlineLinkAndTitle(Cursor $cursor)
+    private function tryParseInlineLinkAndTitle(Cursor $cursor)
     {
         if ($cursor->getCharacter() !== '(') {
             return false;
@@ -182,9 +182,9 @@ protected function tryParseInlineLinkAndTitle(Cursor $cursor)
      * @param Delimiter    $opener
      * @param int          $startPos
      *
-     * @return Reference|null
+     * @return ReferenceInterface|null
      */
-    protected function tryParseReference(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, int $startPos): ?Reference
+    private function tryParseReference(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, int $startPos): ?ReferenceInterface
     {
         if ($opener->getIndex() === null) {
             return null;
@@ -215,7 +215,7 @@ protected function tryParseReference(Cursor $cursor, ReferenceMap $referenceMap,
      *
      * @return AbstractWebResource
      */
-    protected function createInline(string $url, string $title, bool $isImage)
+    private function createInline(string $url, string $title, bool $isImage)
     {
         if ($isImage) {
             return new Image($url, null, $title);
diff --git a/src/Inline/Parser/EntityParser.php b/src/Inline/Parser/EntityParser.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Util\Html5Entities;
 use League\CommonMark\Util\RegexHelper;
 
-class EntityParser implements InlineParserInterface
+final class EntityParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/EscapableParser.php b/src/Inline/Parser/EscapableParser.php
@@ -19,7 +19,7 @@
 use League\CommonMark\InlineParserContext;
 use League\CommonMark\Util\RegexHelper;
 
-class EscapableParser implements InlineParserInterface
+final class EscapableParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/HtmlInlineParser.php b/src/Inline/Parser/HtmlInlineParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\InlineParserContext;
 use League\CommonMark\Util\RegexHelper;
 
-class HtmlInlineParser implements InlineParserInterface
+final class HtmlInlineParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/NewlineParser.php b/src/Inline/Parser/NewlineParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\Inline\Element\Text;
 use League\CommonMark\InlineParserContext;
 
-class NewlineParser implements InlineParserInterface
+final class NewlineParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Parser/OpenBracketParser.php b/src/Inline/Parser/OpenBracketParser.php
@@ -18,7 +18,7 @@
 use League\CommonMark\Inline\Element\Text;
 use League\CommonMark\InlineParserContext;
 
-class OpenBracketParser implements InlineParserInterface
+final class OpenBracketParser implements InlineParserInterface
 {
     /**
      * @return string[]
diff --git a/src/Inline/Renderer/CodeRenderer.php b/src/Inline/Renderer/CodeRenderer.php
@@ -20,7 +20,7 @@
 use League\CommonMark\Inline\Element\Code;
 use League\CommonMark\Util\Xml;
 
-class CodeRenderer implements InlineRendererInterface
+final class CodeRenderer implements InlineRendererInterface
 {
     /**
      * @param Code                     $inline
diff --git a/src/Inline/Renderer/EmphasisRenderer.php b/src/Inline/Renderer/EmphasisRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Inline\Element\AbstractInline;
 use League\CommonMark\Inline\Element\Emphasis;
 
-class EmphasisRenderer implements InlineRendererInterface
+final class EmphasisRenderer implements InlineRendererInterface
 {
     /**
      * @param Emphasis                 $inline
diff --git a/src/Inline/Renderer/HtmlInlineRenderer.php b/src/Inline/Renderer/HtmlInlineRenderer.php
@@ -21,7 +21,7 @@
 use League\CommonMark\Util\ConfigurationAwareInterface;
 use League\CommonMark\Util\ConfigurationInterface;
 
-class HtmlInlineRenderer implements InlineRendererInterface, ConfigurationAwareInterface
+final class HtmlInlineRenderer implements InlineRendererInterface, ConfigurationAwareInterface
 {
     /**
      * @var ConfigurationInterface
diff --git a/src/Inline/Renderer/ImageRenderer.php b/src/Inline/Renderer/ImageRenderer.php
@@ -22,7 +22,7 @@
 use League\CommonMark\Util\ConfigurationInterface;
 use League\CommonMark\Util\RegexHelper;
 
-class ImageRenderer implements InlineRendererInterface, ConfigurationAwareInterface
+final class ImageRenderer implements InlineRendererInterface, ConfigurationAwareInterface
 {
     /**
      * @var ConfigurationInterface
diff --git a/src/Inline/Renderer/LinkRenderer.php b/src/Inline/Renderer/LinkRenderer.php
@@ -22,7 +22,7 @@
 use League\CommonMark\Util\ConfigurationInterface;
 use League\CommonMark\Util\RegexHelper;
 
-class LinkRenderer implements InlineRendererInterface, ConfigurationAwareInterface
+final class LinkRenderer implements InlineRendererInterface, ConfigurationAwareInterface
 {
     /**
      * @var ConfigurationInterface
diff --git a/src/Inline/Renderer/NewlineRenderer.php b/src/Inline/Renderer/NewlineRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Inline\Element\AbstractInline;
 use League\CommonMark\Inline\Element\Newline;
 
-class NewlineRenderer implements InlineRendererInterface
+final class NewlineRenderer implements InlineRendererInterface
 {
     /**
      * @param Newline                  $inline
diff --git a/src/Inline/Renderer/StrongRenderer.php b/src/Inline/Renderer/StrongRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Inline\Element\AbstractInline;
 use League\CommonMark\Inline\Element\Strong;
 
-class StrongRenderer implements InlineRendererInterface
+final class StrongRenderer implements InlineRendererInterface
 {
     /**
      * @param Strong                   $inline
diff --git a/src/Inline/Renderer/TextRenderer.php b/src/Inline/Renderer/TextRenderer.php
@@ -19,7 +19,7 @@
 use League\CommonMark\Inline\Element\Text;
 use League\CommonMark\Util\Xml;
 
-class TextRenderer implements InlineRendererInterface
+final class TextRenderer implements InlineRendererInterface
 {
     /**
      * @param Text                     $inline
diff --git a/src/Node/NodeWalker.php b/src/Node/NodeWalker.php
diff --git a/src/Reference/Reference.php b/src/Reference/Reference.php
diff --git a/src/Reference/ReferenceInterface.php b/src/Reference/ReferenceInterface.php
diff --git a/src/Reference/ReferenceMap.php b/src/Reference/ReferenceMap.php

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`use League\CommonMark\Cursor;`
`20`	`20`	`use League\CommonMark\Util\RegexHelper;`
`21`	`21`
`22`		`-class ATXHeadingParser implements BlockParserInterface`
	`22`	`+final class ATXHeadingParser implements BlockParserInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`	`25`	`* @param ContextInterface $context`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`use League\CommonMark\ContextInterface;`
`19`	`19`	`use League\CommonMark\Cursor;`
`20`	`20`
`21`		`-class BlockQuoteParser implements BlockParserInterface`
	`21`	`+final class BlockQuoteParser implements BlockParserInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* @param ContextInterface $context`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`use League\CommonMark\Cursor;`
`21`	`21`	`use League\CommonMark\Util\RegexHelper;`
`22`	`22`
`23`		`-class HtmlBlockParser implements BlockParserInterface`
	`23`	`+final class HtmlBlockParser implements BlockParserInterface`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* @param ContextInterface $context`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`use League\CommonMark\ContextInterface;`
`18`	`18`	`use League\CommonMark\Cursor;`
`19`	`19`
`20`		`-class LazyParagraphParser implements BlockParserInterface`
	`20`	`+final class LazyParagraphParser implements BlockParserInterface`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`	`23`	`* @param ContextInterface $context`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`use League\CommonMark\Cursor;`
`23`	`23`	`use League\CommonMark\Util\RegexHelper;`
`24`	`24`
`25`		`-class ListParser implements BlockParserInterface`
	`25`	`+final class ListParser implements BlockParserInterface`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`	`28`	`* @param ContextInterface $context`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`use League\CommonMark\ReferenceParser;`
`22`	`22`	`use League\CommonMark\Util\RegexHelper;`
`23`	`23`
`24`		`-class SetExtHeadingParser implements BlockParserInterface`
	`24`	`+final class SetExtHeadingParser implements BlockParserInterface`
`25`	`25`	`{`
`26`	`26`	`/**`
`27`	`27`	`* @param ContextInterface $context`