Updated README.md to reflect recent changes to the console output.

Added docs/Ruleset.md which serves as a reference to list all the potential rules that may trigger semantic versioning of code.
Separated getLine from getLocation in the subclasses of Operation. This allows us to format the location using short/full path if we want to. Short path will be used by default when displaying on the console.
Added logic in Reporter to format the location according to the optional input "full-path".

Author: tomzx

README.md

@@ -10,48 +10,86 @@ PHP Semantic Versioning Checker is a console/library which allows you to inspect
 
 After the inspection is completed, you are given a list of changes that have occurred between the two changesets. For each of these changes, the level of the change (MAJOR, MINOR, PATCH, NONE) will be given, as well as the location of the change (file and line number) and a reason as to why this level change is suggested.
 
-## Current checks & ruleset
-
-- Functions
-	- Function added -> **MINOR**
-	- Function removed -> **MAJOR**
-	- Function parameter mismatch -> **MAJOR**
-	- Function implementation changed -> **PATCH**
-- Classes
-	- Class added -> **MINOR**
-	- Class removed -> **MAJOR**
-	- Public class method added -> **MINOR**
-	- Public class method removed -> **MAJOR**
-	- Public class method parameter mismatch -> **MAJOR**
-	- Public class method implementation changed -> **PATCH**
+## Getting started
+
+As this is still an alpha package, it is not suggested to include `php-semver-checker` directly in your composer.phar. There are however a couple ways to use the tool:
+
+1. `php composer.phar create-project tomzx/php-semver-checker --stability=dev` will clone to a new php-semver-checker folder in your current working directory
+2. `php composer.phar global require tomzx/php-semver-checker --stability=dev` will clone it to your global composer location, so you can use it from anywhere.
+3. `git clone https://github.com/tomzx/php-semver-checker.git` and `php composer.phar install` in the newly cloned directory.
+
+As the package gets more stable, other means of distribution may become available (such as a .phar).
+
+## Current ruleset & verification codes
+
+See `docs/Ruleset.md` for an exhaustive list of currently supported (and to come) ruleset.
+
+Verification codes are a mean to uniquely identify a semantic versioning trigger (a condition which upon detection, requires your code changes to be versioned).
 
 ## Example
 
 ```bash
-php bin/php-semver-checker compare factory-muffin-1.6.4 factory-muffin-2.0.0
+php bin/php-semver-checker compare tests/fixtures/before tests/fixtures/after
 
 Suggested semantic versioning change: MAJOR
 
-Class
-+-------+-------------------------------------------------------------------------------------------------------------------+--------------------+
-| Level | Location                                                                                                          | Reason             |
-+-------+-------------------------------------------------------------------------------------------------------------------+--------------------+
-| MAJOR | src/Zizaco/FactoryMuff/Facade/FactoryMuff.php#8 Zizaco\FactoryMuff\Facade\FactoryMuff                             | Class was removed. |
-| MAJOR | src/Zizaco/FactoryMuff/FactoryMuff.php#13 Zizaco\FactoryMuff\FactoryMuff                                          | Class was removed. |
-| MAJOR | src/Zizaco/FactoryMuff/Kind.php#7 Zizaco\FactoryMuff\Kind                                                         | Class was removed. |
-[...]
-| MINOR | src/Exceptions/DeleteFailedException.php#17 League\FactoryMuffin\Exceptions\DeleteFailedException                 | Class was added.   |
-| MINOR | src/Exceptions/DeleteMethodNotFoundException.php#17 League\FactoryMuffin\Exceptions\DeleteMethodNotFoundException | Class was added.   |
-| MINOR | src/Exceptions/DeletingFailedException.php#21 League\FactoryMuffin\Exceptions\DeletingFailedException             | Class was added.   |
-[... cut for brievity ...]
-+-------+-------------------------------------------------------------------------------------------------------------------+--------------------+
-
-Function
-+-------+----------+--------+
-| Level | Location | Reason |
-+-------+----------+--------+
-```
+Class (MAJOR)
++-------+-----------------------------------------+-----------------------+--------------------+------+
+| Level | Location                                | Target                | Reason             | Code |
++-------+-----------------------------------------+-----------------------+--------------------+------+
+| MAJOR | tests\fixtures\before\ClassRemoved.php# | fixtures\ClassRemoved | Class was removed. | V005 |
+| MINOR | tests\fixtures\after\ClassAdded.php#5   | fixtures\ClassAdded   | Class was added.   | V014 |
++-------+-----------------------------------------+-----------------------+--------------------+------+
+
+Function (MAJOR)
++-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+
+| Level | Location                                                 | Target                                                                | Reason                           | Code |
++-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+
+| MAJOR | tests\fixtures\before\FunctionRemoved.php#5              | fixtures\functionRemoved::functionRemoved                             | Function has been removed.       | V001 |
+| MAJOR | tests\fixtures\before\FunctionParameterMismatch.php#5    | fixtures\functionParameterMismatch::functionParameterMismatch         | Function parameter changed.      | V002 |
+| MINOR | tests\fixtures\after\FunctionAdded.php#5                 | fixtures\functionAdded::functionAdded                                 | Function has been added.         | V003 |
+| PATCH | tests\fixtures\after\FunctionImplementationChanged.php#5 | fixtures\functionImplementationChanged::functionImplementationChanged | Function implementation changed. | V004 |
++-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+
+
+Interface (MAJOR)
++-------+----------------------------------------------+---------------------------+------------------------+------+
+| Level | Location                                     | Target                    | Reason                 | Code |
++-------+----------------------------------------------+---------------------------+------------------------+------+
+| MAJOR | tests\fixtures\before\InterfaceRemoved.php#5 | fixtures\InterfaceRemoved | Interface was removed. | V033 |
+| MAJOR | tests\fixtures\after\InterfaceAdded.php#5    | fixtures\InterfaceAdded   | Interface was added.   | V032 |
++-------+----------------------------------------------+---------------------------+------------------------+------+
 
+Method (MAJOR)
++-------+-------------------------------------------------------------+------------------------------------------------------+--------------------------------+------+
+| Level | Location                                                    | Target                                               | Reason                         | Code |
++-------+-------------------------------------------------------------+------------------------------------------------------+--------------------------------+------+
+| MAJOR | tests\fixtures\after\ClassMethodParameterChanged.php#7      | fixtures\ClassMethodParameterMismatch::newMethod     | Method parameter changed.      | V010 |
+| MAJOR | tests\fixtures\before\ClassMethodRemoved.php#7              | fixtures\ClassMethodRemoved::newMethod               | Method has been removed.       | V006 |
+| MAJOR | tests\fixtures\after\InterfaceMethodParameterMismatch.php#7 | fixtures\InterfaceMethodParameterMismatch::newMethod | Method parameter changed.      | V036 |
+| MAJOR | tests\fixtures\before\InterfaceMethodRemoved.php#7          | fixtures\InterfaceMethodRemoved::newMethod           | Method has been removed.       | V035 |
+| MAJOR | tests\fixtures\after\TraitMethodParameterChanged.php#7      | fixtures\TraitMethodParameterMismatch::newMethod     | Method parameter changed.      | V042 |
+| MAJOR | tests\fixtures\before\TraitMethodRemoved.php#7              | fixtures\TraitMethodRemoved::newMethod               | Method has been removed.       | V038 |
+| MINOR | tests\fixtures\after\ClassMethodAdded.php#7                 | fixtures\ClassMethodAdded::newMethod                 | Method has been added.         | V015 |
+| MINOR | tests\fixtures\after\InterfaceMethodAdded.php#7             | fixtures\InterfaceMethodAdded::newMethod             | Method has been added.         | V034 |
+| MINOR | tests\fixtures\after\TraitAddedRemoved.php#7                | fixtures\TraitMethodAdded::newMethod                 | Method has been added.         | V047 |
+| PATCH | tests\fixtures\after\ClassMethodImplementationChanged.php#7 | fixtures\ClassMethodImplementationChanged::newMethod | Method implementation changed. | V023 |
+| PATCH | tests\fixtures\after\ClassMethodParameterChanged.php#7      | fixtures\ClassMethodParameterMismatch::newMethod     | Method parameter changed.      | V010 |
+| PATCH | tests\fixtures\after\InterfaceMethodParameterMismatch.php#7 | fixtures\InterfaceMethodParameterMismatch::newMethod | Method parameter changed.      | V036 |
+| PATCH | tests\fixtures\after\TraitMethodImplementationChanged.php#7 | fixtures\TraitMethodImplementationChanged::newMethod | Method implementation changed. | V038 |
+| PATCH | tests\fixtures\after\TraitMethodParameterChanged.php#7      | fixtures\TraitMethodParameterMismatch::newMethod     | Method parameter changed.      | V042 |
++-------+-------------------------------------------------------------+------------------------------------------------------+--------------------------------+------+
+
+Trait (MAJOR)
++-------+------------------------------------------+-----------------------+--------------------+------+
+| Level | Location                                 | Target                | Reason             | Code |
++-------+------------------------------------------+-----------------------+--------------------+------+
+| MAJOR | tests\fixtures\before\TraitRemoved.php#5 | fixtures\TraitRemoved | Trait was removed. | V037 |
+| MINOR | tests\fixtures\after\TraitAdded.php#5    | fixtures\TraitAdded   | Trait was added.   | V046 |
++-------+------------------------------------------+-----------------------+--------------------+------+
+
+Time: 0.79 seconds, Memory: 4.28 MB
+```
+ 
 ## License
 
-The code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). See license.txt.
+The code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). See license.txt.

docs/Ruleset.md

@@ -0,0 +1,80 @@
+**Note** In *italic* are the rules that are not implemented yet. Feel free to submit a PR if you implement any of them.
+
+# Functions
+
+Code | Level | Rule
+-----|-------|-------
+V001 | MAJOR | Function removed
+V002 | MAJOR | Function parameter changed
+V003 | MINOR | Function added
+V004 | PATCH | Function implementation changed
+
+# Classes
+
+Code | Level | Rule
+-----|-------|-------
+V005 | MAJOR | Class removed
+V006 | MAJOR | Class public method removed
+V007 | MAJOR | *Class protected method removed*
+V008 | MAJOR | *Class public property removed*
+V009 | MAJOR | *Class protected property removed*
+V010 | MAJOR | Class public method parameter changed
+V011 | MAJOR | *Class protected method parameter changed*
+V012 | MAJOR | *New public constructor (does not match supertype)*
+V013 | MAJOR | *New protected constructor (does not match supertype)*
+V014 | MINOR | Class added
+V015 | MINOR | Class public method added *(display a notice that the method may overlap)* (MAJOR when not final)
+V016 | MINOR | *Class protected method added* *(display a notice that the method may overlap)* (MAJOR when not final)
+V017 | MINOR | *Final class public method added*
+V018 | MINOR | *Final class protected method added*
+V019 | MINOR | *Class public property added*
+V020 | MINOR | *Class protected property added*
+V021 | MINOR | Class protected method parameter changed (MAJOR when not final)
+V022 | MAJOR | Final class protected method removed
+V023 | PATCH | [Final] Class public class method implementation changed
+V024 | PATCH | [Final] Class *protected* class method implementation changed
+V025 | PATCH | [Final] Class *private* class method implementation changed
+V026 | PATCH | *Class private property added*
+V027 | PATCH | *Class private property removed*
+V028 | PATCH | *Class private method added*
+V029 | PATCH | *Class private method removed*
+V030 | PATCH | *Final class protected method added*
+V031 | PATCH | *Class private method parameter changed*
+
+# Interface
+
+Code | Level | Rule
+-----|-------|-------
+V032 | MAJOR | Interface added
+V033 | MAJOR | Interface removed
+V034 | MAJOR | Interface method added
+V035 | MAJOR | Interface method removed
+V036 | MAJOR | Interface method parameter changed
+
+# Trait
+
+Code | Level | Rule
+-----|-------|-------
+V037 | MAJOR | Trait removed
+V038 | MAJOR | Trait public method removed
+V039 | MAJOR | *Trait protected method removed*
+V040 | MAJOR | *Trait public property removed*
+V041 | MAJOR | *Trait protected property removed*
+V042 | MAJOR | Trait public method parameter changed
+V043 | MAJOR | *Trait protected method parameter changed*
+V044 | MAJOR | *New public constructor (does not match supertype)*
+V045 | MAJOR | *New protected constructor (does not match supertype)*
+V046 | MINOR | Trait added
+V047 | MINOR | Trait public method added *(display a notice that the method may overlap)* (MAJOR when not final)
+V048 | MINOR | *Trait protected method added* *(display a notice that the method may overlap)* (MAJOR when not final)*
+V049 | MINOR | *Trait public property added*
+V050 | MINOR | *Trait protected property added*
+V051 | MINOR | *Trait protected method parameter changed (MAJOR when not final)*
+V052 | PATCH | Trait public trait method implementation changed
+V053 | PATCH | *Trait *protected* trait method implementation changed*
+V054 | PATCH | *Trait *private* trait method implementation changed*
+V055 | PATCH | *Trait private property added*
+V056 | PATCH | *Trait private property removed*
+V057 | PATCH | *Trait private method added*
+V058 | PATCH | *Trait private method removed*
+V059 | PATCH | *Trait private method parameter changed*

src/PHPSemVerChecker/Console/Command/CompareCommand.php

@@ -10,6 +10,7 @@
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class CompareCommand extends Command {
@@ -21,6 +22,7 @@ protected function configure()
 			->setDefinition([
 				new InputArgument('source-before', InputArgument::REQUIRED, 'A directory to check'),
 				new InputArgument('source-after', InputArgument::REQUIRED, 'A directory to check against'),
+				new InputOption('full-path', null, InputOption::VALUE_NONE, 'Display the full path to the file instead of the relative path'),
 			]);
 	}
 
@@ -56,7 +58,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 		$analyzer = new Analyzer();
 		$report = $analyzer->analyze($registryBefore, $registryAfter);
 
-		$reporter = new Reporter($report);
+		$reporter = new Reporter($report, $input);
 		$reporter->output($output);
 
 		$duration = microtime(true) - $startTime;

src/PHPSemVerChecker/Operation/ClassAdded.php

@@ -37,7 +37,15 @@ public function __construct($fileAfter, Class_ $classAfter)
 	 */
 	public function getLocation()
 	{
-		return $this->fileAfter . '#' . $this->classAfter->getLine();
+		return $this->fileAfter;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->classAfter->getLine();
 	}
 
 	/**

src/PHPSemVerChecker/Operation/ClassMethodAdded.php

@@ -54,7 +54,15 @@ public function __construct($context, $fileAfter, Stmt $contextAfter, ClassMetho
 	 */
 	public function getLocation()
 	{
-		return $this->fileAfter . '#' . $this->classMethod->getLine();
+		return $this->fileAfter;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->classMethod->getLine();
 	}
 
 	/**

src/PHPSemVerChecker/Operation/ClassMethodImplementationChanged.php

@@ -71,7 +71,15 @@ public function __construct($context, $fileBefore, \PhpParser\Node\Stmt $context
 	 */
 	public function getLocation()
 	{
-		return $this->fileAfter . '#' . $this->classMethodAfter->getLine();
+		return $this->fileAfter;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->classMethodAfter->getLine();
 	}
 
 	/**

src/PHPSemVerChecker/Operation/ClassMethodOperation.php

@@ -2,7 +2,7 @@
 
 namespace PHPSemVerChecker\Operation;
 
-class ClassMethodOperation extends Operation
+abstract class ClassMethodOperation extends Operation
 {
 	public function getCode()
 	{

src/PHPSemVerChecker/Operation/ClassMethodParameterChanged.php

@@ -72,7 +72,15 @@ public function __construct($context, $fileBefore, Stmt $contextBefore, ClassMet
 	 */
 	public function getLocation()
 	{
-		return $this->fileAfter . '#' . $this->classMethodAfter->getLine();
+		return $this->fileAfter;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->classMethodAfter->getLine();
 	}
 
 	/**

src/PHPSemVerChecker/Operation/ClassMethodRemoved.php

@@ -54,7 +54,15 @@ public function __construct($context, $fileBefore, Stmt $contextBefore, ClassMet
 	 */
 	public function getLocation()
 	{
-		return $this->fileBefore . '#' . $this->classMethodBefore->getLine();
+		return $this->fileBefore;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->classMethodBefore->getLine();
 	}
 
 	/**

src/PHPSemVerChecker/Operation/ClassRemoved.php

@@ -37,7 +37,12 @@ public function __construct($fileBefore, Class_ $classBefore)
 	 */
 	public function getLocation()
 	{
-		return $this->fileBefore . '#' . $this->classBefore->getLine();
+		return $this->fileBefore;
+	}
+
+	public function getLine()
+	{
+		$this->classBefore->getLine();
 	}
 
 	/**