Merge branch 'release/0.4.0'

.github/workflows/ci.yml

@@ -12,6 +12,8 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - operating-system: 'ubuntu-latest'
+            php-version: '8.2'
           - operating-system: 'ubuntu-latest'
             php-version: '8.1'
           - operating-system: 'ubuntu-latest'

.github/workflows/t.yml

@@ -26,6 +26,8 @@ jobs:
           XDEBUG_MODE: coverage
       - run: |
           find src -name "*.php" -exec ./bin/metrics annotate ./coverage.xml {} \;
+      - run: |
+          ./vendor/bin/rector process src
       - run: |
           find tests -name "*.php" -exec ./vendor/bin/phptidy.php replace {} \;
           find src -name "*.php" -exec ./vendor/bin/phptidy.php replace {} \;

.phptidy-config.php

@@ -4,6 +4,6 @@
 $fix_round_bracket_space = true;
 $add_file_docblock = false;
 $add_function_docblocks = true;
-$add_doctags = true;
+$add_doctags = false;
 $fix_docblock_format = true;
 $fix_docblock_space = true;

README.md

@@ -1,21 +1,17 @@
 # Metrics
 
-A package of utilities for making use of coverage metrics in PHP.
+A command line utility for making better use of coverage metrics in PHP.
+Chiefly, allows you to update your source code with docblock annotations that
+present method coverage/complexity. Use with your CI process to keep your
+metrics in front of you as you develop.
 
 ## Installation
 
 ```shell
 composer require logicbrush/metrics
 ```
 
-## Command Line Functions
-
-A number of metrics-related functions are accessible via the command line.
-
-### Annotate
-
-Use to annotate source code with metric information from a `coverage.xml` file.
-Use with your CI process to keep your metrics in front of you as you develop.
+## Usage
 
 ```shell
 php ./vendor/bin/metrics annotate «path to coverage.xml» «path to source file»
@@ -33,4 +29,4 @@ This will annotate your code with a `@Metrics` annotation, e.g:
  public function someMethod() : void {
     ...
  }
- ```
+ ```

TODO.txt

@@ -0,0 +1,8 @@
+# A list of things to do, in taskpaper format...
+
+Version 0.4.0:
+    - PHP 8.2 support. @done(24-07-26 07:56)
+    - Update documenation. @done(24-07-26 08:22)
+    - Rector support. @done(24-07-26 08:17)
+
+Archive:

composer.json

@@ -16,7 +16,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0||^9.5",
-        "cmrcx/phptidy": "^3.3"
+        "cmrcx/phptidy": "^3.3",
+        "rector/rector": "^1.2"
     },
     "prefer-stable": true,
     "autoload": {

rector.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ *
+ * @package default
+ */
+
+
+declare( strict_types = 1 );
+
+use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+
+return static function ( RectorConfig $rectorConfig ): void {
+
+	$rectorConfig->sets( [
+			LevelSetList::UP_TO_PHP_72,
+			SetList::CODE_QUALITY,
+			SetList::DEAD_CODE,
+		] );
+
+	$rectorConfig->skip( [
+			RemoveUnusedPrivatePropertyRector::class,
+			ExplicitBoolCompareRector::class,
+		] );
+
+	$rectorConfig->importShortClasses();
+	$rectorConfig->importNames();
+
+};

src/Metrics/Annotator.php

@@ -14,10 +14,9 @@ interface Annotator
 
 
 
+
 	/**
 	 *
-	 * @param string  $clover
-	 * @param string  $file
 	 */
 	public function __construct(  string $clover, string $file );
 

src/Metrics/Bootstrap.php

@@ -19,13 +19,10 @@ class Bootstrap {
 	/**
 	 *
 	 * @Metrics( crap = 2, uncovered = true )
-	 * @param string  $clover
-	 * @param string  $file
 	 * @return unknown
 	 */
 	public static function createAnnotator( string $clover, string $file ) {
-		$annotator = new AnnotatorImpl( $clover, $file );
-		return $annotator;
+		return new AnnotatorImpl( $clover, $file );
 	}
 
 

src/Metrics/Impl/AnnotatorImpl.php

@@ -6,7 +6,7 @@
 use SimpleXMLElement;
 
 // These constants are only defined in PHP 8.0+.
-defined( 'T_NAME_QUALIFIED' ) or define( 'T_NAME_QUALIFIED', -1 );
+defined( 'T_NAME_QUALIFIED' ) || define( 'T_NAME_QUALIFIED', -1 );
 
 /**
  * Metrics implementation of the Annotator interfce
@@ -28,8 +28,6 @@ class AnnotatorImpl implements Annotator
 	/**
 	 *
 	 * @Metrics( crap = 1 )
-	 * @param string  $clover
-	 * @param string  $file
 	 */
 	public function __construct( string $clover, string $file ) {
 		$this->path_to_clover = $clover;
@@ -42,7 +40,7 @@ public function __construct( string $clover, string $file ) {
 	 * @Metrics( crap = 26.12 )
 	 */
 	public function run() {
-		defined( 'STDIN' ) or die( 'command line only.' );
+		defined( 'STDIN' ) || die( 'command line only.' );
 
 
 		$file = $this->path_to_file;
@@ -108,7 +106,7 @@ public function run() {
 						case T_WHITESPACE:
 							break;
 						default:
-							if ( ( $metrics = $this->metrics( $clover, $function, $class, $namespace ) ) !== null ) {
+							if ( ( $metrics = $this->metrics( $clover, $function, $class, $namespace ) ) instanceof SimpleXMLElement ) {
 								$this->annotate( $tokens, $key, $metrics );
 							}
 							goto handle_token;
@@ -126,9 +124,7 @@ public function run() {
 	/**
 	 *
 	 * @Metrics( crap = 19.15 )
-	 * @param array            $tokens  (reference)
-	 * @param int              $key
-	 * @param SimpleXMLElement $metrics
+	 * @param array   $tokens (reference)
 	 * @return unknown
 	 */
 	protected function annotate( array &$tokens, int $key, SimpleXMLElement $metrics ) {
@@ -177,10 +173,9 @@ function( $array ) use ( &$first, $tag ) {
 	/**
 	 *
 	 * @Metrics( crap = 5 )
-	 * @param SimpleXMLElement $clover
-	 * @param string           $function
-	 * @param string           $class
-	 * @param string           $namespace
+	 * @param string  $function
+	 * @param string  $class
+	 * @param string  $namespace
 	 * @return unknown
 	 */
 	protected function metrics( SimpleXMLElement $clover, ?string $function, ?string $class, ?string $namespace ): ?SimpleXMLElement {

src/bootstrap.php

@@ -1,5 +1,6 @@
 <?php
 
+use Logicbrush\Metrics\Bootstrap;
 /**
  *
  * @noRector
@@ -9,20 +10,21 @@
 
 require_once $GLOBALS['_composer_autoload_path'];
 
-if ( ! class_exists( 'Logicbrush\Metrics\Bootstrap' ) ) {
+if ( ! class_exists( Bootstrap::class ) ) {
 	require_once __DIR__ . '/Metrics/Bootstrap.php';
 }
 
+
 try {
 	// if (version_compare(PHP_VERSION, '8.0.0', '<')) {
 	//     throw new \ErrorException('PHP Version is lower than 8.0.0. Please upgrade your runtime.');
 	// }
-	if ( isset( $argv[1] ) && ( $argv[1] == 'annotate' ) &&
+	if ( isset( $argv[1] ) && ( $argv[1] === 'annotate' ) &&
 		isset( $argv[2] ) && ( $clover = $argv[2] ) &&
 		isset( $argv[3] ) && ( $file = $argv[3] ) ) {
-		return Logicbrush\Metrics\Bootstrap::createAnnotator( $clover, $file );
+		return Bootstrap::createAnnotator( $clover, $file );
 	}
-	throw new \ErrorException( 'You must include path to coverage file and file to be annotated as arg 1 and arg 2 respectively.' );
+	throw new ErrorException( 'You must include path to coverage file and file to be annotated as arg 1 and arg 2 respectively.' );
 
 } catch ( Exception $e ) {
 	printf( $e->getMessage() );