Refactoring to v2

Author: jakubboucek

.gitattributes

@@ -1,5 +1,4 @@
 .gitattributes export-ignore
 .gitignore export-ignore
-phpstan.neon export-ignore
-.travis.yml export-ignore
+.github export-ignore
 tests export-ignore

.github/workflows/code_analysis.yaml

@@ -0,0 +1,41 @@
+name: Code Analysis
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  code_analysis:
+    strategy:
+      fail-fast: false
+      matrix:
+        actions:
+          - name: PHPStan
+            run: composer phpstan
+
+          - name: Easy Coding Standard
+            run: composer ecs
+
+          - name: Unit tests
+            run: composer tests
+
+    name: ${{ matrix.actions.name }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        # see https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.3
+          coverage: none
+
+      - name: Install Composer
+        run: composer install --no-progress
+
+      - run: ${{ matrix.actions.run }}

.phpstorm.meta.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace PHPSTORM_META {
+
+    expectedArguments(
+        \JakubBoucek\ComposerConsistency\ComposerConsistency::__construct(),
+        5,
+        true,
+        false,
+        E_USER_ERROR,
+        E_USER_WARNING,
+        E_USER_NOTICE,
+    );
+
+    expectedArguments(
+        \JakubBoucek\ComposerConsistency\Builder::errorMode(),
+        0,
+        E_USER_ERROR,
+        E_USER_WARNING,
+        E_USER_NOTICE,
+    );
+}

.travis.yml

@@ -7,76 +7,112 @@ Package for your app – it allows your App to check himself has consistent vend
 For small teams can be difficult to cooperate and keep `/vendor` directory synchronized with requirements
 in `composer.json`. Your colleagues can be a junior or can be not accustomed to right use the Composer.
 
-You can force refresh Composer via git-hooks, or push all `/vendor` into your repo, but it's very dirty way.
-Don't do it!
+You can force refresh Composer via git-hooks, but it requires careful preparation on each developer station.  
+You can push all `/vendor` into your repo, but it's very very dirty way. Don't do it!
 
 Or… just add this package to you project. It checks if you `/vendor` is consistent with project and can
 notify you and your colleagues to forgotten refresh.
 
 ## Usage
 Add this package to project as dev-dependency:
-```bash
-composer require --dev jakubboucek/composer-vendor-checker
+```shell
+composer require --dev jakubboucek/composer-consistency-checker
 ```
 
-In your app just call `validateReqs()` method:
+In your app just call `validate()` method:
 ```php
 <?php
-use JakubBoucek\ComposerConsistency\Checker;
+use JakubBoucek\ComposerConsistency\ComposerConsistency;
 
-Checker::validateReqs(__DIR__);
+ComposerConsistency::rootDir(__DIR__)->validate();
 ```
 
 When `/vendor` is not consistent with `composer.json`, checker throws an Exception.
 
 ![Exception from Checker](https://cdn.jakub-boucek.cz/screenshot/190703-jptvw.png)
 
-## Modes
+## Usage
+
+```php
+use JakubBoucek\ComposerConsistency\ComposerConsistency;
+
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->validate();
+```
+
+### Directories
+- **Root dir** - directory which contains `composer.json`, rspt. `composer.lock` file,
+usually root directory od project.
+- **Vendor dir** - directory which contains Composer's `autoload.php` file.
+
+By default checker is assumes Verdor dir at `vendor/` from root dir, you can change by method `vendorDir()`.
 
-### Strict/Lax mode
-Nehlásí chybu, pokud nenajde soubory
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->vendorDir(__DIR__ . '/../vendor')
+    ->validate();
+```
 
-POPZOR? výchozéí stan není striktní - vysvětlit v readme
+### Error severity
+When checker detects incosistence, it throws `ComposerInconsitencyException`. 
 
-### Silent mode
-Vyhodí pouze chybu E_USER_ERROR, ne vyjímku
+You can change exception throwing to emit user error by method `errorMode($severity)` where `$severity` is Severity of
+emitted error, default is `E_USER_ERROR`, you can change it to any of `E_USER` family severity
+([read more](https://www.php.net/manual/en/function.trigger-error.php#refsect1-function.trigger-error-parameters)).
 
 ```php
-Composer::validateConsistency($rootDir, $vendorDir, true, false);
-(new Composer($rootDir))->strict(false)->validate($debugMode, E_USER_ERROR);
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->errorMode(E_USER_WARNING)
+    ->validate();
 ```
 
-### Warning
-Because you install Checker as dev-dependency, you should be very careful to hard-linking dependency
-insinde your App. Is highly recommended to call validation only on development stage, not on production:
+Also you can disable checking by `errorMode(false)` – that's cause to completelly disable checking.
 
 ```php
-if(Debugger::$productionMode === false) {
-   Checker::validateReqs(__DIR__);
-}
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->errorMode(false)
+    ->validate();
 ```
 
-Or check if dependency exists:
+### Strict mode
+In strict mode Checker throws Exception when is unable to read Composer's files used to
+compute vendor consistency. Default value: `off`. 
+
+Turn on Strict mode:
 ```php
-if(class_exists(Checker::class)) {
-   Checker::validateReqs(__DIR__);
-}
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->strict()
+    ->validate();
 ```
 
-## Reference
+Scrict mode is by default disabled, because: 
+- it can break production if you ignore some files (like `composer.lock`) during deploy - 
+that's false positive,
+- is not important to guard these files, for example when is missing whole `vendor/` directory, 
+is unable to load this package too,
+- main purpose of package is watching to subtle nuances in packages consistency, not fatals
+in Composer's file system.
 
-### Class `Checker`
+### Cache
+Checking vendor consistency on every request consume unnecessarily huge CPU power. Ceche is store last success check
+only check is composer files stay without change. It does not check consincy of packages until these files keep same
+content. Default value: off.
 
-#### `__constructor($rootDir, ?string $vendorDir = null)`
-Contructor creates Checker instance.\
-Only required argument is absolute path to root directory (directory where checker search the `composer.lock` file).\
-Optional argument is absolute path do `vendor` directory. Default is `{$rootDir}/vendor`.
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->cache(__DIR__ . '/temp')
+    ->validate();
+```
 
-#### `validate(): void`
-Check if `/vendor` is consitent with app requirements and throw an Exception if is not.
+### Froze mode
+Checking vendor consistency on every request consume unnecessarily huge CPU power. Froze mode is usable when you
+guarantee the deploy process to production is always purge the temp directory. Default value: off.
 
-#### `isReqsValid(): bool`
-Check if `/vendor` is consitent with app requirements and return boolean of consistency status.
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->froze(__DIR__ . '/temp')
+    ->validate();
+```
 
-#### `validateReqs(string $rootDir, ?string $vendorDir = null): void`
-Shortcut to call `validate()` without creating Checker instance before.
+In Froze mode is vendor consistenty checked only once, then is state saved to temp directory and
+no more checks are performed until is temp directory purged.

README.md

@@ -19,8 +19,15 @@
         }
     },
     "require-dev": {
-        "phpstan/phpstan": "^0.12.10",
-        "nette/tester": "^2.3"
+        "phpstan/phpstan": "^0.12.48",
+        "nette/tester": "^2.3",
+        "symplify/easy-coding-standard": "^8.3"
+    },
+    "scripts": {
+        "phpstan": "phpstan analyze src --level 6",
+        "ecs": "ecs check src --set psr12",
+        "ecs-fix": "ecs check src --set psr12 --fix",
+        "tests": "tester tests"
     },
     "replace": {
         "jakubboucek/composer-vendor-checker": "self.version"

composer.json

@@ -0,0 +1,85 @@
+## Usage
+
+```php
+use JakubBoucek\ComposerConsistency\ComposerConsistency;
+
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->validate();
+```
+
+### Directories
+- **Root dir** - directory which contains `composer.json`, rspt. `composer.lock` file,
+usually root directory od project.
+- **Vendor dir** - directory which contains Composer's `autoload.php` file.
+
+By default checker is assumes Verdor dir at `vendor/` from root dir, you can change by method `vendorDir()`.
+
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->vendorDir(__DIR__ . '/../vendor')
+    ->validate();
+```
+
+### Error severity
+When checker detects incosistence, it throws `ComposerInconsitencyException`. 
+
+You can change exception throwing to emit user error by method `errorMode($severity)` where `$severity` is Severity of
+emitted error, default is `E_USER_ERROR`, you can change it to any of `E_USER` family severity
+([read more](https://www.php.net/manual/en/function.trigger-error.php#refsect1-function.trigger-error-parameters)).
+
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->errorMode(E_USER_WARNING)
+    ->validate();
+```
+
+Also you can disable checking by `errorMode(false)` – that's cause to completelly disable checking.
+
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->errorMode(false)
+    ->validate();
+```
+
+### Strict mode
+In strict mode Checker throws Exception when is unable to read Composer's files used to
+compute vendor consistency. Default value: `off`. 
+
+Turn on Strict mode:
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->strict()
+    ->validate();
+```
+
+Scrict mode is by default disabled, because: 
+- it can break production if you ignore some files (like `composer.lock`) during deploy - 
+that's false positive,
+- is not important to guard these files, for example when is missing whole `vendor/` directory, 
+is unable to load this package too,
+- main purpose of package is watching to subtle nuances in packages consistency, not fatals
+in Composer's file system.
+
+### Cache
+Checking vendor consistency on every request consume unnecessarily huge CPU power. Ceche is store last success check
+only check is composer files stay without change. It does not check consincy of packages until these files keep same
+content. Default value: off.
+
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->cache(__DIR__ . '/temp')
+    ->validate();
+```
+
+### Froze mode
+Checking vendor consistency on every request consume unnecessarily huge CPU power. Froze mode is usable when you
+guarantee the deploy process to production is always purge the temp directory. Default value: off.
+
+```php
+\JakubBoucek\ComposerConsistency\ComposerConsistency::rootDir(__DIR__)
+    ->froze(__DIR__ . '/temp')
+    ->validate();
+```
+
+In Froze mode is vendor consistenty checked only once, then is state saved to temp directory and
+no more checks are performed until is temp directory purged.