Share Feature and Shareable Metrics

.github/workflows/tests.yml

@@ -10,9 +10,11 @@ jobs:
       fail-fast: true
       matrix:
         php: [7.3, 7.4]
-        laravel: [7.*]
+        laravel: [6.*, 7.*]
         dependency-version: [prefer-lowest, prefer-stable]
         include:
+          - laravel: 6.*
+            testbench: 4.*
           - laravel: 7.*
             testbench: 5.*
 

README.md

@@ -26,9 +26,7 @@
 
 ### Installing
 
-The easiest way to install the package is by using composer. The package requires PHP 7.3, Laravel 7.0 or higher or Lumen 7.0 or higher.  
-
-Due to version conflicts, `stats` can't be installed in Laravel 7 projects which are running with phpunit 8. **Phpunit 9 is required.**
+The easiest way to install the package is by using composer. The package requires PHP 7.3, Laravel 6.0 or higher or Lumen 6.0 or higher.  
 
 ```shell
 composer require "wnx/laravel-stats" --dev
@@ -42,78 +40,12 @@ If you're using Lumen you have to manually register the Service Provider in your
 $app->register(\Wnx\LaravelStats\StatsServiceProvider::class);
 ```
 
-Optionally, you can publish the config file of this package with this command (Laravel only):
+Optionally, you can publish the config file in your Laravel applications with the following command:
 
 ```shell
 php artisan vendor:publish --provider="Wnx\LaravelStats\StatsServiceProvider"
 ```
 
-The following config file will be published in `config/stats.php`
-
-```php
-<?php
-
-return [
-
-    /*
-     * List of folders to be analyzed.
-     */
-    'paths' => [
-        base_path('app'),
-        base_path('database'),
-        base_path('tests'),
-    ],
-
-    /*
-     * List of files/folders to be excluded from analysis.
-     */
-    'exclude' => [
-        // base_path('app/helpers.php'),
-        // base_path('app/Services'),
-    ],
-
-    /*
-     * List of your custom Classifiers
-     */
-    'custom_component_classifier' => [
-        // \App\Classifiers\CustomerExportClassifier::class
-    ],
-
-    /*
-     * The Strategy used to reject Classes from the project statistics.
-     *
-     * By default all Classes located in
-     * the vendor directory are being rejected and don't
-     * count to the statistics.
-     *
-     * The package ships with 2 strategies:
-     * - \Wnx\LaravelStats\RejectionStrategies\RejectVendorClasses::class
-     * - \Wnx\LaravelStats\RejectionStrategies\RejectInternalClasses::class
-     *
-     * If none of the default strategies fit for your usecase, you can
-     * write your own class which implements the RejectionStrategy Contract.
-     */
-    'rejection_strategy' => \Wnx\LaravelStats\RejectionStrategies\RejectVendorClasses::class,
-
-    /*
-     * Namespaces which should be ignored.
-     * Laravel Stats uses the `Str::startsWith()`class to
-     * check if a Namespace should be ignored.
-     *
-     * You can use `Illuminate` to ignore the entire `Illuminate`-namespace
-     * or `Illuminate\Support` to ignore a subset of the namespace.
-     */
-    'ignored_namespaces' => [
-        'Wnx\LaravelStats',
-        'Illuminate',
-        'Symfony',
-    ],
-
-];
-
-```
-
-
 ## Usage
 
 After installing you can generate the statistics by running the following Artisan Command.
@@ -134,14 +66,13 @@ If you want a more detailed report and see which classes have been grouped into
 php artisan stats --verbose
 ```
 
-The verbose option is also available for the JSON format.
+The verbose option is available for the JSON format also.
 
 ```
 php artisan stats --json --verbose
 ```
 
 
-
 ## How does this package detect certain Laravel Components?
 
 The package scans the files defined in the `paths`-array in the configuration file. It then applies [Classifiers](https://github.com/stefanzweifel/laravel-stats/tree/master/src/Classifiers) to those classes to determine which Laravel Component the class represents.
@@ -225,6 +156,68 @@ class RepositoryClassifier implements Classifier
     ...
 ```
 
+## Share Metrics with the Laravel Community
+
+You can optionally share your projects statistic by using the `--share` option. 
+
+```shell
+php artisan stats --share
+```
+
+Your project statistics is shared anonymously with [stats.laravelshift.com](https://stats.laravelshift.com). In regular intervals the dashboard and charts on the site are updated with shared data from other Laravel projects.
+
+To learn more about this feature, please check out PR [#178](https://github.com/stefanzweifel/laravel-stats/pull/178).
+
+### Share statistic through CI
+
+If you would like to share your project statistic in a CI environment you can use the `--no-interaction` and `--name`-options.
+
+Use the following command in your CI script to share your project statistic automatically. (Update `org/repo` with the name of your application (eg. `acme/podcasting-app`))
+
+```shell
+php artisan stats --share --no-interaction --name=org/repo
+```
+
+If you're code is hosted on GitHub, you can integrate `stats` with [GitHub Actions](https://docs.github.com/en/actions).
+Copy the following Workflow to `.github/workflows/laravel-stats.yml`. It will share data when a commit is pushed to the `master` branch. The Action automatically uses your GitHub repository name in the `--name`-option.
+
+```yaml
+name: stats
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  stats:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.4
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-interaction --no-suggest
+
+      - name: Share Stats
+        run: php artisan stats --share --name=$GITHUB_REPOSITORY --no-interaction
+```
+
+### Inspect Data shared with the Community
+
+If you would like to inspect the payload the command is sending to the API you can use the `--dry-run` and `--payload` options.
+
+```shell
+php artisan stats --share  --no-interaction  --name="org/repo" --dry-run --payload
+```
+
 ## Treeware
 
 You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

composer.json

@@ -14,18 +14,20 @@
     ],
     "require": {
         "php": ">=7.3.0",
-        "illuminate/console": "^7.0",
-        "illuminate/support": "^7.0",
-        "phploc/phploc": "~6.0",
-        "symfony/finder": "~5.0"
+        "ext-json": "*",
+        "illuminate/console": "^6.0 || ^7.0",
+        "illuminate/support": "^6.0 || ^7.0",
+        "stefanzweifel/laravel-stats-phploc": "^6.1",
+        "symfony/finder": "^4.3 || ^5.0",
+        "symfony/process": "^4.3 || ^5.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.15",
-        "laravel/browser-kit-testing": "~6.0",
+        "laravel/browser-kit-testing": "~5.0 || ~6.0",
         "laravel/dusk": "~5.0",
         "mockery/mockery": "^1.1",
-        "orchestra/testbench": "^5.0",
-        "phpunit/phpunit": "9.*",
+        "orchestra/testbench": "^4.0 || ^5.0",
+        "phpunit/phpunit": "8.* || 9.*",
         "psalm/plugin-laravel": "^1.3",
         "vimeo/psalm": "^3.12"
     },

config/stats.php

@@ -44,7 +44,7 @@
 
     /*
      * Namespaces which should be ignored.
-     * Laravel Stats uses the `Str::startsWith()`class to
+     * Laravel Stats uses the `Str::startsWith()` helper to
      * check if a Namespace should be ignored.
      *
      * You can use `Illuminate` to ignore the entire `Illuminate`-namespace

src/Classifier.php

@@ -36,7 +36,7 @@
 
 class Classifier
 {
-    private const DEFAULT_CLASSIFIER = [
+    public const DEFAULT_CLASSIFIER = [
         ControllerClassifier::class,
         ModelClassifier::class,
         CommandClassifier::class,

src/Classifiers/BladeComponentClassifier.php

@@ -15,6 +15,10 @@ public function name(): string
 
     public function satisfies(ReflectionClass $class): bool
     {
+        if (! class_exists(Component::class)) {
+            return false;
+        }
+
         return $class->isSubclassOf(Component::class);
     }
 

src/Classifiers/CustomCastClassifier.php

@@ -16,6 +16,10 @@ public function name(): string
 
     public function satisfies(ReflectionClass $class): bool
     {
+        if ((float) app()->version() < 7) {
+            return false;
+        }
+
         return $class->implementsInterface(CastsAttributes::class) ||
             $class->implementsInterface(CastsInboundAttributes::class);
     }

src/Classifiers/ObserverClassifier.php

@@ -20,7 +20,7 @@ public function satisfies(ReflectionClass $class): bool
     {
         return collect($this->getEvents())
             ->filter(function ($listeners, $event) {
-                return Str::of($event)->startsWith('eloquent.');
+                return Str::startsWith($event, 'eloquent.');
             })
             ->map(function ($listeners) {
                 return collect($listeners)->map(function (Closure $closure) {
@@ -30,7 +30,7 @@ public function satisfies(ReflectionClass $class): bool
             ->collapse()
             ->unique()
             ->filter(function ($eventListenerSignature) use ($class) {
-                return Str::of($eventListenerSignature)->contains($class->getName());
+                return Str::contains($eventListenerSignature, $class->getName());
             })
             ->count() > 0;
     }