Rename Diff to Differ

Signed-off-by: Jack Cherng <jfcherng@gmail.com>

Author: jfcherng

README.md

@@ -39,7 +39,7 @@ See [example/demo.php](https://github.com/jfcherng/php-diff/blob/master/example/
 
 include __DIR__ . '/vendor/autoload.php';
 
-use Jfcherng\Diff\Diff;
+use Jfcherng\Diff\Differ;
 use Jfcherng\Diff\DiffHelper;
 use Jfcherng\Diff\Factory\RendererFactory;
 
@@ -53,7 +53,7 @@ $new = 'And this is the new one.';
 $template = 'Unified';
 
 // the Diff class options
-$diffOptions = [
+$differOptions = [
     // show how many neighbor lines
     'context' => 3,
     // ignore case difference
@@ -82,16 +82,16 @@ $templateOptions = [
 ];
 
 // one-line simply compare two files
-$result = DiffHelper::calculateFiles($oldFile, $newFile, $diffOptions, $templateOptions);
+$result = DiffHelper::calculateFiles($oldFile, $newFile, $differOptions, $templateOptions);
 // one-line simply compare two strings
-$result = DiffHelper::calculate($old, $new, $template, $diffOptions, $templateOptions);
+$result = DiffHelper::calculate($old, $new, $template, $differOptions, $templateOptions);
 // or even shorter if you are happy with default options
 $result = DiffHelper::calculate($old, $new, $template);
 
 // custom usage
-$diff = new Diff(explode("\n", $old), explode("\n", $new), $diffOptions);
+$differ = new Differ(explode("\n", $old), explode("\n", $new), $differOptions);
 $renderer = RendererFactory::make($template, $templateOptions); // or your own renderers
-$result = $renderer->render($diff);
+$result = $renderer->render($differ);
 ```
 
 

UPGRADING/UPGRADING_v6.md

@@ -1,14 +1,15 @@
 ## Upgrading to v6
 
-- Now `Renderer` has `::render()` API, but a `Diff` does not.
+- `Diff` has been renamed to `Differ`.
+- Now a `Renderer` has `render()` API, but a `Differ` does not.
   If you are only using the `DiffHelper`, there should be nothing changed for you.
   But if you combine those classes by yourself, it should be wrote like below.
 
   ```php
-  use Jfcherng\Diff\Diff;
+  use Jfcherng\Diff\Differ;
   use Jfcherng\Diff\Factory\RendererFactory;
 
-  $diff = new Diff(explode("\n", $old), explode("\n", $new), $diffOptions);
+  $differ = new Differ(explode("\n", $old), explode("\n", $new), $diffOptions);
   $renderer = RendererFactory::make($template, $templateOptions);
-  $result = $renderer->render($diff); // <-- this has been changed
+  $result = $renderer->render($differ); // <-- this has been changed
   ```

src/DiffHelper.php

@@ -116,7 +116,7 @@ public static function getStyleSheet(): string
      * @param string|string[] $old             the old string (or array of lines)
      * @param string|string[] $new             the new string (or array of lines)
      * @param string          $template        the template name
-     * @param array           $diffOptions     the options for Diff object
+     * @param array           $differOptions   the options for Differ object
      * @param array           $templateOptions the options for template object
      *
      * @return string the rendered differences
@@ -125,7 +125,7 @@ public static function calculate(
         $old,
         $new,
         string $template = 'Unified',
-        array $diffOptions = [],
+        array $differOptions = [],
         array $templateOptions = []
     ): string {
         // always convert into array form
@@ -135,9 +135,9 @@ public static function calculate(
         return RendererFactory::getInstance($template)
             ->setOptions($templateOptions)
             ->render(
-                Diff::getInstance()
+                Differ::getInstance()
                     ->setOldNew($old, $new)
-                    ->setOptions($diffOptions)
+                    ->setOptions($differOptions)
             );
     }
 
@@ -147,7 +147,7 @@ public static function calculate(
      * @param string $old             the path of the old file
      * @param string $new             the path of the new file
      * @param string $template        the template name
-     * @param array  $diffOptions     the options for Diff object
+     * @param array  $differOptions   the options for Differ object
      * @param array  $templateOptions the options for template object
      *
      * @throws \LogicException   path is a directory
@@ -159,7 +159,7 @@ public static function calculateFiles(
         string $old,
         string $new,
         string $template = 'Unified',
-        array $diffOptions = [],
+        array $differOptions = [],
         array $templateOptions = []
     ): string {
         // we want to leave the line-ending problem to static::calculate()
@@ -172,7 +172,7 @@ public static function calculateFiles(
             $oldFile->fread($oldFile->getSize()),
             $newFile->fread($newFile->getSize()),
             $template,
-            $diffOptions,
+            $differOptions,
             $templateOptions
         );
     }

src/Diff.php renamed to src/Differ.php

@@ -15,7 +15,7 @@
  *
  * @see http://github.com/chrisboulton/php-diff
  */
-final class Diff
+final class Differ
 {
     /**
      * @var array cached properties and their default values
@@ -61,7 +61,7 @@ final class Diff
     private $groupedCodes = [];
 
     /**
-     * @var array associative array of the default options available for the diff class and their default value
+     * @var array associative array of the default options available for the Differ class and their default value
      */
     private static $defaultOptions = [
         // show how many neighbor lines
@@ -218,7 +218,7 @@ public static function getInstance(): self
      * Generate a list of the compiled and grouped opcodes for the differences between the
      * two strings. Generally called by the renderer, this class instantiates the sequence
      * matcher and performs the actual diff generation and return an array of the opcodes
-     * for it. Once generated, the results are cached in the diff class instance.
+     * for it. Once generated, the results are cached in the Differ class instance.
      *
      * @return array[] array of the grouped opcodes for the generated diff
      */

src/Renderer/AbstractRenderer.php

@@ -4,7 +4,7 @@
 
 namespace Jfcherng\Diff\Renderer;
 
-use Jfcherng\Diff\Diff;
+use Jfcherng\Diff\Differ;
 use Jfcherng\Diff\Utility\Language;
 
 /**
@@ -26,9 +26,9 @@ abstract class AbstractRenderer implements RendererInterface
     const IS_HTML_TEMPLATE = true;
 
     /**
-     * @var Diff the instance of the diff class that this renderer is generating the rendered diff for
+     * @var Differ the instance of the Differ class that this renderer is generating the rendered diff for
      */
-    protected $diff;
+    protected $differ;
 
     /**
      * @var Language the language translation object
@@ -73,15 +73,15 @@ public function __construct(array $options = [])
     }
 
     /**
-     * Set the diff object.
+     * Set the Differ object.
      *
-     * @param Diff $diff the diff object
+     * @param Differ $differ the Differ object
      *
      * @return self
      */
-    public function setDiff(Diff $diff): self
+    public function setDiff(Differ $differ): self
     {
-        $this->diff = $diff;
+        $this->differ = $differ;
 
         return $this;
     }
@@ -107,13 +107,13 @@ public function setOptions(array $options): self
     }
 
     /**
-     * Get the diff object.
+     * Get the Differ object.
      *
-     * @return Diff the diff object
+     * @return Differ the Differ object
      */
-    public function getDiff(): Diff
+    public function getDiffer(): Differ
     {
-        return $this->diff;
+        return $this->differ;
     }
 
     /**
@@ -139,12 +139,12 @@ public static function getIdenticalResult(): string
     /**
      * {@inheritdoc}
      */
-    public function render(Diff $diff): string
+    public function render(Differ $differ): string
     {
-        $this->diff = $diff->finalize();
+        $this->differ = $differ->finalize();
 
         // the "no difference" situation may happen frequently
-        return $this->diff->getOldNewComparison() === 0
+        return $this->differ->getOldNewComparison() === 0
             ? static::getIdenticalResult()
             : $this->renderWoker();
     }

src/Renderer/Html/AbstractHtml.php

@@ -42,19 +42,19 @@ public function getChanges(): array
     {
         $lineRenderer = LineRendererFactory::make(
             $this->options['detailLevel'],
-            $this->diff->getOptions(),
+            $this->differ->getOptions(),
             $this->options
         );
 
         // As we'll be modifying old & new to include our change markers,
         // we need to get the contents and store them here. That way
         // we're not going to destroy the original data
-        $old = $this->diff->getOld();
-        $new = $this->diff->getNew();
+        $old = $this->differ->getOld();
+        $new = $this->differ->getNew();
 
         $changes = [];
 
-        foreach ($this->diff->getGroupedOpcodes() as $opcodes) {
+        foreach ($this->differ->getGroupedOpcodes() as $opcodes) {
             $blocks = [];
             $lastTag = SequenceMatcher::OP_NOP;
             $lastBlock = 0;

src/Renderer/Html/LineRenderer/AbstractLineRenderer.php

@@ -17,9 +17,9 @@ abstract class AbstractLineRenderer implements LineRendererInterface
     protected $sequenceMatcher;
 
     /**
-     * @var array the diff options
+     * @var array the differ options
      */
-    protected $diffOptions = [];
+    protected $differOptions = [];
 
     /**
      * @var array the template options
@@ -29,29 +29,29 @@ abstract class AbstractLineRenderer implements LineRendererInterface
     /**
      * The constructor.
      *
-     * @param array $diffOptions     the diff options
+     * @param array $differOptions   the differ options
      * @param array $templateOptions the template options
      */
-    public function __construct(array $diffOptions, array $templateOptions)
+    public function __construct(array $differOptions, array $templateOptions)
     {
         $this->sequenceMatcher = new SequenceMatcher([], []);
 
         $this
-            ->setDiffOptions($diffOptions)
+            ->setDifferOptions($differOptions)
             ->setTemplateOptions($templateOptions);
     }
 
     /**
-     * Set the diff options.
+     * Set the differ options.
      *
-     * @param array $diffOptions the diff options
+     * @param array $differOptions the differ options
      *
      * @return self
      */
-    public function setDiffOptions(array $diffOptions): self
+    public function setDifferOptions(array $differOptions): self
     {
-        $this->diffOptions = $diffOptions;
-        $this->sequenceMatcher->setOptions($diffOptions);
+        $this->differOptions = $differOptions;
+        $this->sequenceMatcher->setOptions($differOptions);
 
         return $this;
     }
@@ -71,13 +71,13 @@ public function setTemplateOptions(array $templateOptions): self
     }
 
     /**
-     * Gets the diff options.
+     * Gets the differ options.
      *
-     * @return array the diff options
+     * @return array the differ options
      */
-    public function getDiffOptions(): array
+    public function getDifferOptions(): array
     {
-        return $this->diffOptions;
+        return $this->differOptions;
     }
 
     /**

src/Renderer/RendererInterface.php

@@ -4,19 +4,19 @@
 
 namespace Jfcherng\Diff\Renderer;
 
-use Jfcherng\Diff\Diff;
+use Jfcherng\Diff\Differ;
 
 /**
  * Renderer Interface.
  */
 interface RendererInterface
 {
     /**
-     * Render and return diff.
+     * Render the differ and return the result.
      *
-     * @param Diff $diff the diff object to be rendered
+     * @param Differ $differ the Differ object to be rendered
      *
      * @return string
      */
-    public function render(Diff $diff): string;
+    public function render(Differ $differ): string;
 }

src/Renderer/Text/Context.php

@@ -38,7 +38,7 @@ protected function renderWoker(): string
     {
         $ret = '';
 
-        foreach ($this->diff->getGroupedOpcodes() as $opcodes) {
+        foreach ($this->differ->getGroupedOpcodes() as $opcodes) {
             $lastItem = \count($opcodes) - 1;
 
             $i1 = $opcodes[0][1];
@@ -92,7 +92,7 @@ protected function renderBlockOld(array $opcodes): string
 
             $ret .= $this->renderContext(
                 self::TAG_MAP[$tag],
-                $this->diff->getOld($i1, $i2)
+                $this->differ->getOld($i1, $i2)
             );
         }
 
@@ -117,7 +117,7 @@ protected function renderBlockNew(array $opcodes): string
 
             $ret .= $this->renderContext(
                 self::TAG_MAP[$tag],
-                $this->diff->getNew($j1, $j2)
+                $this->differ->getNew($j1, $j2)
             );
         }
 

src/Renderer/Text/Unified.php

@@ -28,7 +28,7 @@ protected function renderWoker(): string
     {
         $ret = '';
 
-        foreach ($this->diff->getGroupedOpcodes() as $opcodes) {
+        foreach ($this->differ->getGroupedOpcodes() as $opcodes) {
             $lastItem = \count($opcodes) - 1;
 
             $i1 = $opcodes[0][1];
@@ -44,17 +44,17 @@ protected function renderWoker(): string
 
             foreach ($opcodes as [$tag, $i1, $i2, $j1, $j2]) {
                 if ($tag === SequenceMatcher::OP_EQ) {
-                    $ret .= $this->renderContext(' ', $this->diff->getOld($i1, $i2));
+                    $ret .= $this->renderContext(' ', $this->differ->getOld($i1, $i2));
 
                     continue;
                 }
 
                 if ($tag & (SequenceMatcher::OP_REP | SequenceMatcher::OP_DEL)) {
-                    $ret .= $this->renderContext('-', $this->diff->getOld($i1, $i2));
+                    $ret .= $this->renderContext('-', $this->differ->getOld($i1, $i2));
                 }
 
                 if ($tag & (SequenceMatcher::OP_REP | SequenceMatcher::OP_INS)) {
-                    $ret .= $this->renderContext('+', $this->diff->getNew($j1, $j2));
+                    $ret .= $this->renderContext('+', $this->differ->getNew($j1, $j2));
                 }
             }
         }