Merge pull request #22 from binafy/publish-routes

[1.x] Add publish routes

Author: milwad-dev

README.md

@@ -11,6 +11,8 @@
 - [Introduction](#introduction)
 - [Installation](#installation)
 - [Usage](#usage)
+    - [Configuration](#configuration)
+        - [Routes Configuration](#routes-configuration) 
     - [User Configuration](#user-configuration)
         - [Foreign Key Type (UUID, ULID, ID)](#foreign-key-type-uuid-ulid-id)
     - [Visit Monitoring](#visit-monitoring)
@@ -68,13 +70,19 @@ If you want to publish the views you can use this command:
 php artisan vendor:publish --tag="laravel-user-monitoring-views"
 ```
 
-If you want to publish the middlewares you can use this command:
+If you want to publish the middleware you can use this command:
 
 ```shell
 php artisan vendor:publish --tag="laravel-user-monitoring-middlewares"
 ```
 
-For convenience, you can use this command to publish config and migration files:
+If you want to publish the routes you can use this command:
+
+```shell
+php artisan vendor:publish --tag="laravel-user-monitoring-routes"
+```
+
+For convenience, you can use this command to publish config, migration, and ... files:
 
 ```shell
 php artisan vendor:publish --provider="Binafy\LaravelUserMonitoring\Providers\LaravelUserMonitoringServiceProvider"
@@ -85,8 +93,31 @@ After publishing, run the `php artisan migrate` command.
 <a name="usage"></a>
 ## Usage
 
-The `Laravel-User-Monitoring`, just need to use middleware, traits, etc ... and it's not hard, enjoy :)
+The `Laravel-User-Monitoring`, just need to use middleware, traits, etc ... and it's not hard, enjoys :)
 
+<a name="routes-configuration"></a>
+## Routes Configuration
+
+If you want to customize the routes, you can publish the route file with this command:
+
+```shell
+php artisan vendor:publish --tag="laravel-user-monitoring-routes"
+```
+
+After, you can go to the `routes/user-monitoring.php` file and customize the routes.
+
+Also, if you want to change the route file name, you can go to the config file and change the `file_path`:
+
+```php
+/*
+ * Configurations.
+ */
+'config' => [
+    'routes' => [
+        'file_path' => 'routes/user-monitoring.php',
+    ],
+],
+```
 
 <a name="user-configuration"></a>
 ## User Configuration

config/user-monitoring.php

@@ -1,6 +1,15 @@
 <?php
 
 return [
+    /*
+     * Configurations.
+     */
+    'config' => [
+        'routes' => [
+            'file_path' => 'routes/user-monitoring.php',
+        ],
+    ],
+
     /*
      * User properties.
      *

src/Providers/LaravelUserMonitoringRouteServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Binafy\LaravelUserMonitoring\Providers;
+
+use Binafy\LaravelUserMonitoring\Middlewares\VisitMonitoringMiddleware;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider;
+use Illuminate\Support\Facades\Route;
+
+class LaravelUserMonitoringRouteServiceProvider extends RouteServiceProvider
+{
+    /**
+     * Register files.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $path = base_path(
+            config('user-monitoring.config.routes.file_path', 'routes/user-monitoring.php')
+        );
+
+        if (! file_exists($path)) {
+            $path = __DIR__ . '/../../routes/web.php';
+        }
+
+        Route::middleware('web')
+            ->middleware(VisitMonitoringMiddleware::class)
+            ->group($path);
+    }
+}

src/Providers/LaravelUserMonitoringServiceProvider.php

@@ -4,7 +4,6 @@
 
 use Binafy\LaravelUserMonitoring\Commands\RemoveVisitMonitoringRecordsCommand;
 use Binafy\LaravelUserMonitoring\Middlewares\VisitMonitoringMiddleware;
-use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\View\View;
 
@@ -23,11 +22,9 @@ public function register()
         $this->commands(RemoveVisitMonitoringRecordsCommand::class);
 
         $this->app['router']->aliasMiddleware('monitor-visit-middleware', VisitMonitoringMiddleware::class);
-        $this->app->register(LaravelUserMonitoringEventServiceProvider::class);
 
-        Route::middleware('web')
-            ->middleware(VisitMonitoringMiddleware::class)
-            ->group(__DIR__ . '/../../routes/web.php');
+        $this->app->register(LaravelUserMonitoringEventServiceProvider::class);
+        $this->app->register(LaravelUserMonitoringRouteServiceProvider::class);
     }
 
     /**
@@ -41,6 +38,7 @@ public function boot()
         $this->publishMigrations();
         $this->publishViews();
         $this->publishMiddleware();
+        $this->publishRoute();
 
         $this->viewComposer();
     }
@@ -93,6 +91,18 @@ private function publishMiddleware()
         ], 'laravel-user-monitoring-middlewares');
     }
 
+    /**
+     * Publish route files.
+     *
+     * @return void
+     */
+    private function publishRoute()
+    {
+        $this->publishes([
+            __DIR__ . '/../../routes/web.php' => base_path('routes/user-monitoring.php'),
+        ], 'laravel-user-monitoring-routes');
+    }
+
     /**
      * View Composer.
      *