Add newline between blocks if missing.

horde · Mar 23, 2017 · ce0bb41 · ce0bb41
1 parent b479b09
commit ce0bb41
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 0 deletions.
diff --git a/framework/Refactor/lib/Horde/Refactor/Rule/FileLevelDocBlock.php b/framework/Refactor/lib/Horde/Refactor/Rule/FileLevelDocBlock.php
@@ -120,6 +120,9 @@ public function run()
         $this->_first = $this->_tokens->key();
         $this->_firstBlock = new DocBlock($this->_tokens->current()[1]);
         $this->_processDocBlock($this->_firstBlock);
+        $this->_tokens->next();
+        $separator = $this->_tokens->key();
+        $emptyLine = $this->_tokens->matches(T_WHITESPACE, "\n\n");
         $this->_tokens->skipWhitespace();
         while ($this->_tokens->matches(T_NAMESPACE) ||
                $this->_tokens->matches(T_USE) ||
@@ -139,6 +142,10 @@ public function run()
             $this->_processDocBlockText($this->_firstBlock, 'file');
             $this->_processDocBlockText($this->_secondBlock, 'class');
             $this->_checkDocBlocks();
+            // Make sure there is a double newline between the DocBlocks.
+            if (!$emptyLine) {
+                $this->_tokens = $this->_tokens->splice($separator, 1, "\n\n");
+            }
             return;
         }
 

diff --git a/framework/Refactor/package.xml b/framework/Refactor/package.xml
@@ -178,6 +178,7 @@
          <file name="ConfiguredNoFileLevelDocBlock.php" role="test" />
          <file name="ExtractYearFixTagOrder.php" role="test" />
          <file name="FileLevelDocsInClassLevel.php" role="test" />
+         <file name="MissingLinebreak.php" role="test" />
          <file name="NoFileLevelDocBlock.php" role="test" />
          <file name="OtherCopyright.php" role="test" />
          <file name="RemoveForbiddenTags.php" role="test" />
@@ -194,6 +195,7 @@
         <file name="ExtractYearFixTagOrder.php" role="test" />
         <file name="FileLevelDocsInClassLevel.php" role="test" />
         <file name="IncorrectDocBlocks.php" role="test" />
+        <file name="MissingLinebreak.php" role="test" />
         <file name="NoFileLevelDocBlock.php" role="test" />
         <file name="OtherCopyright.php" role="test" />
         <file name="RemoveForbiddenTags.php" role="test" />
@@ -358,6 +360,7 @@
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/ExtractYearFixTagOrder.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/ExtractYearFixTagOrder.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/FileLevelDocsInClassLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/FileLevelDocsInClassLevel.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/IncorrectDocBlocks.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/IncorrectDocBlocks.php" />
+   <install as="Horde/Refactor/fixtures/FileLevelDocBlock/MissingLinebreak.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/MissingLinebreak.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/NoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/NoFileLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/OtherCopyright.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/OtherCopyright.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/RemoveForbiddenTags.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/RemoveForbiddenTags.php" />
@@ -369,6 +372,7 @@
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ConfiguredNoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ConfiguredNoFileLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ExtractYearFixTagOrder.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ExtractYearFixTagOrder.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/FileLevelDocsInClassLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/FileLevelDocsInClassLevel.php" />
+   <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/MissingLinebreak.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/MissingLinebreak.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/NoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/NoFileLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/OtherCopyright.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/OtherCopyright.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveForbiddenTags.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveForbiddenTags.php" />

diff --git a/framework/Refactor/test/Horde/Refactor/FileLevelDocBlockTest.php b/framework/Refactor/test/Horde/Refactor/FileLevelDocBlockTest.php
@@ -172,6 +172,7 @@ public function getFileNames()
             array('FileLevelDocsInClassLevel.php', false),
             array('RemoveForbiddenTags.php', false),
             array('RemoveStripText.php', false),
+            array('MissingLinebreak.php', false),
         );
     }
 }
diff --git a/framework/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/MissingLinebreak.php b/framework/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/MissingLinebreak.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright 2017 Horde LLC (http://www.horde.org/)
+ *
+ * See the enclosed file LICENSE for license information (BSD). If you
+ * did not receive this file, see http://www.horde.org/licenses/bsd.
+ *
+ * @author   Jan Schneider <jan@horde.org>
+ * @category Horde
+ * @license  http://www.horde.org/licenses/bsd BSD
+ * @package  Foobar
+ */
+/**
+ * Summary.
+ *
+ * Descriptions.
+ *
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2017 Horde LLC
+ * @license   http://www.horde.org/licenses/bsd BSD
+ * @package   Foobar
+ */
+class Foo
+{
+}
diff --git a/...k/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/MissingLinebreak.php b/...k/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/MissingLinebreak.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright 2017 Horde LLC (http://www.horde.org/)
+ *
+ * See the enclosed file LICENSE for license information (BSD). If you
+ * did not receive this file, see http://www.horde.org/licenses/bsd.
+ *
+ * @author   Jan Schneider <jan@horde.org>
+ * @category Horde
+ * @license  http://www.horde.org/licenses/bsd BSD
+ * @package  Foobar
+ */
+
+/**
+ * Summary.
+ *
+ * Descriptions.
+ *
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2017 Horde LLC
+ * @license   http://www.horde.org/licenses/bsd BSD
+ * @package   Foobar
+ */
+class Foo
+{
+}