Redo directory structure to match current coding style, rename classes to match directory style, fix up naming conventions

Chris Boulton · Chris Boulton · commit 5c5c17964525 · 2010-03-11T20:16:22.000+11:00
diff --git a/README b/README
@@ -1,9 +1,10 @@
-PHP DiffLib
+PHP Diff Class
+--------------
 
 Introduction
 ------------
-PHP DiffLib is a comprehensive library for generating differences between
-two hasable objects (strings or arrays). Generated differences can be
+A comprehensive library for generating differences between
+two hashable objects (strings or arrays). Generated differences can be
 rendered in all of the standard formats including:
  * Unified
  * Context
@@ -40,7 +41,7 @@ modification, are permitted provided that the following conditions are met:
  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
- - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ - Neither the name of the Chris Boulton nor the names of its contributors 
    may be used to endorse or promote products derived from this software 
    without specific prior written permission.
 
diff --git a/example/example.php b/example/example.php
@@ -12,7 +12,7 @@
 		<?php
 
 		// Include the diff class
-		require_once dirname(__FILE__).'/../difflib.php';
+		require_once dirname(__FILE__).'/../lib/Diff.php';
 
 		// Include two sample files for comparison
 		$a = explode("\n", file_get_contents(dirname(__FILE__).'/a.txt'));
@@ -23,44 +23,44 @@
 		);
 
 		// Initialize the diff class
-		$diff = new DiffLib($a, $b, $options);
+		$diff = new Diff($a, $b, $options);
 
 		?>
 		<h2>Side by Side Diff</h2>
 		<?php
 
 		// Generate a side by side diff
-		require_once dirname(__FILE__).'/../renderer/sidebyside_html.php';
-		$renderer = new DiffLib_Renderer_SideBySide_Html;
+		require_once dirname(__FILE__).'/../lib/Diff/Renderer/Html/SideBySide.php';
+		$renderer = new Diff_Renderer_Html_SideBySide;
 		echo $diff->Render($renderer);
 
 		?>
 		<h2>Inline Diff</h2>
 		<?php
 
 		// Generate an inline diff
-		require_once dirname(__FILE__).'/../renderer/inline_html.php';
-		$renderer = new DiffLib_Renderer_Inline_Html;
-		echo $diff->Render($renderer);
+		require_once dirname(__FILE__).'/../lib/Diff/Renderer/Html/Inline.php';
+		$renderer = new Diff_Renderer_Html_Inline;
+		echo $diff->render($renderer);
 
 		?>
 		<h2>Unified Diff</h2>
 		<pre><?php
 
 		// Generate a unified diff
-		require_once dirname(__FILE__).'/../renderer/unified.php';
-		$renderer = new DiffLib_Renderer_Unified;
-		echo htmlspecialchars($diff->Render($renderer));
+		require_once dirname(__FILE__).'/../lib/Diff/Renderer/Text/Unified.php';
+		$renderer = new Diff_Renderer_Text_Unified;
+		echo htmlspecialchars($diff->render($renderer));
 
 		?>
 		</pre>
 		<h2>Context Diff</h2>
 		<pre><?php
 
 		// Generate a context diff
-		require_once dirname(__FILE__).'/../renderer/context.php';
-		$renderer = new DiffLib_Renderer_Context;
-		echo htmlspecialchars($diff->Render($renderer));
+		require_once dirname(__FILE__).'/../lib/Diff/Renderer/Text/Context.php';
+		$renderer = new Diff_Renderer_Text_Context;
+		echo htmlspecialchars($diff->render($renderer));
 		?>
 		</pre>
 	</body>
diff --git a/lib/Diff.php b/lib/Diff.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * PHP LibDiff
+ * Diff
  *
  * A comprehensive library for generating differences between two strings
  * in multiple formats (unified, side by side HTML etc)
@@ -19,7 +19,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -35,15 +35,15 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  * POSSIBILITY OF SUCH DAMAGE.
  *
- * @package DiffLib
+ * @package Diff
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-class DiffLib
+class Diff
 {
 	/**
 	 * @var array The "old" sequence to use as the basis for the comparison.
@@ -95,7 +95,7 @@ public function __construct($a, $b, $options=array())
 	 * @param object $renderer An instance of the rendering object to use for generating the diff.
 	 * @return mixed The generated diff. Exact return value depends on the rendered.
 	 */
-	public function Render(DiffLib_Renderer_Base $renderer)
+	public function render(Diff_Renderer_Abstract $renderer)
 	{
 		$renderer->diff = $this;
 		return $renderer->Render();
@@ -111,7 +111,7 @@ public function Render(DiffLib_Renderer_Base $renderer)
 	 * @param int $end The ending number. If not supplied, only the item in $start will be returned.
 	 * @return array Array of all of the lines between the specified range.
 	 */
-	public function GetA($start=0, $end=null)
+	public function getA($start=0, $end=null)
 	{
 		if($start == 0 && $end === null) {
 			return $this->a;
@@ -138,7 +138,7 @@ public function GetA($start=0, $end=null)
 	 * @param int $end The ending number. If not supplied, only the item in $start will be returned.
 	 * @return array Array of all of the lines between the specified range.
 	 */
-	public function GetB($start=0, $end=null)
+	public function getB($start=0, $end=null)
 	{
 		if($start == 0 && $end === null) {
 			return $this->b;
@@ -162,15 +162,15 @@ public function GetB($start=0, $end=null)
 	 *
 	 * @return array Array of the grouped opcodes for the generated diff.
 	 */
-	public function GetGroupedOpcodes()
+	public function getGroupedOpcodes()
 	{
 		if(!is_null($this->groupedCodes)) {
 			return $this->groupedCodes;
 		}
 
-		require_once dirname(__FILE__).'/sequencematcher.php';
-		$sequenceMatcher = new DiffLib_SequenceMatcher($this->a, $this->b);
-		$this->groupedCodes = $sequenceMatcher->GetGroupedOpCodes();
+		require_once dirname(__FILE__).'/Diff/SequenceMatcher.php';
+		$sequenceMatcher = new Diff_SequenceMatcher($this->a, $this->b);
+		$this->groupedCodes = $sequenceMatcher->getGroupedOpcodes();
 		return $this->groupedCodes;
 	}
 }
diff --git a/lib/Diff/Renderer/Abstract.php b/lib/Diff/Renderer/Abstract.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,10 +37,10 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-abstract class DiffLib_Renderer_Base
+abstract class Diff_Renderer_Abstract
 {
 	/**
 	 * @var object Instance of the diff class that this renderer is generating the rendered diff for.
diff --git a/lib/Diff/Renderer/Html/Array.php b/lib/Diff/Renderer/Html/Array.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,12 +37,12 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-require_once dirname(__FILE__).'/base.php';
+require_once dirname(__FILE__).'/../Abstract.php';
 
-class DiffLib_Renderer_Array_Html extends DiffLib_Renderer_Base
+class Diff_Renderer_Html_Array extends Diff_Renderer_Abstract
 {
 	/**
 	 * @var array Array of the default options that apply to this renderer.
@@ -67,7 +67,7 @@ public function Render()
 		$b = $this->diff->GetB();
 
 		$changes = array();
-		$opCodes = $this->diff->GetGroupedOpCodes();
+		$opCodes = $this->diff->getGroupedOpcodes();
 		foreach($opCodes as $group) {
 			$blocks = array();
 			$lastTag = null;
diff --git a/lib/Diff/Renderer/Html/Inline.php b/lib/Diff/Renderer/Html/Inline.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,12 +37,12 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-require_once dirname(__FILE__).'/array_html.php';
+require_once dirname(__FILE__).'/Array.php';
 
-class DiffLib_Renderer_Inline_Html extends DiffLib_Renderer_Array_Html
+class Diff_Renderer_Html_Inline extends Diff_Renderer_Html_Array
 {
 	/**
 	 * Render a and return diff with changes between the two sequences
diff --git a/lib/Diff/Renderer/Html/SideBySide.php b/lib/Diff/Renderer/Html/SideBySide.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,12 +37,12 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-require_once dirname(__FILE__).'/array_html.php';
+require_once dirname(__FILE__).'/Array.php';
 
-class DiffLib_Renderer_SideBySide_Html extends DiffLib_Renderer_Array_Html
+class Diff_Renderer_Html_SideBySide extends Diff_Renderer_Html_Array
 {
 	/**
 	 * Render a and return diff with changes between the two sequences
diff --git a/lib/Diff/Renderer/Text/Context.php b/lib/Diff/Renderer/Text/Context.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,12 +37,12 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-require_once dirname(__FILE__).'/base.php';
+require_once dirname(__FILE__).'/../Abstract.php';
 
-class DiffLib_Renderer_Context extends DiffLib_Renderer_Base
+class Diff_Renderer_Text_Context extends Diff_Renderer_Abstract
 {
 	/**
 	 * @var array Array of the different opcode tags and how they map to the context diff equivalent.
@@ -62,7 +62,7 @@ class DiffLib_Renderer_Context extends DiffLib_Renderer_Base
 	public function Render()
 	{
 		$diff = '';
-		$opCodes = $this->diff->GetGroupedOpCodes();
+		$opCodes = $this->diff->getGroupedOpcodes();
 		foreach($opCodes as $group) {
 			$diff .= "***************\n";
 			$lastItem = count($group)-1;
diff --git a/lib/Diff/Renderer/Text/Unified.php b/lib/Diff/Renderer/Text/Unified.php
@@ -16,7 +16,7 @@
  *  - Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- *  - Neither the name of the Chris Boulton, Inc. nor the names of its contributors 
+ *  - Neither the name of the Chris Boulton nor the names of its contributors 
  *    may be used to endorse or promote products derived from this software 
  *    without specific prior written permission.
  *
@@ -37,12 +37,12 @@
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
  * @version 1.0
- * @link http://github.com/chrisboulton/phpdifflib/
+ * @link http://github.com/chrisboulton/phpdiff
  */
 
-require_once dirname(__FILE__).'/base.php';
+require_once dirname(__FILE__).'/../Abstract.php';
 
-class DiffLib_Renderer_Unified extends DiffLib_Renderer_Base
+class Diff_Renderer_Text_Unified extends Diff_Renderer_Abstract
 {
 	/**
 	 * Render and return a unified diff.
@@ -52,7 +52,7 @@ class DiffLib_Renderer_Unified extends DiffLib_Renderer_Base
 	public function Render()
 	{
 		$diff = '';
-		$opCodes = $this->diff->GetGroupedOpCodes();
+		$opCodes = $this->diff->getGroupedOpcodes();
 		foreach($opCodes as $group) {
 			$lastItem = count($group)-1;
 			$i1 = $group[0][1];
diff --git a/lib/Diff/SequenceMatcher.php b/lib/Diff/SequenceMatcher.php
