Merge pull request #52 from me-shaon/refactor-service-provider

refactor: Modernize service provider using Laravel Package Tools features

Author: me-shaon

README.md

@@ -22,25 +22,30 @@ Built with performance and privacy in mind, the package offers intelligent bot d
 - Laravel 10.0 or higher
 - MySQL 5.7+ / PostgreSQL 10+ / SQLite 3.8+
 
-### Install via Composer
+### Quick Installation (Recommended) ✨
 
-Install the package using Composer:
+Get up and running in just two commands:
 
 ```bash
+# Install the package
 composer require me-shaon/laravel-request-analytics
-```
 
-### Automated Setup (Recommended) ✨
+# Run the interactive installer
+php artisan request-analytics:install
+```
 
-For the fastest installation, use the interactive `setup` command. It handles all the boilerplate configuration in one step. **(This method is the recommended way to get started and replaces the manual steps outlined below)**
+This interactive installer will:
+- Welcome you with helpful information about the package
+- Automatically publish configuration files, assets, and views
+- Publish and optionally run database migrations
+- Optionally prompt you to star our GitHub repository
+- Provide next steps and dashboard access information
 
-```bash
-php artisan laravel-request-analytics:setup
-```
+After running the installer, your analytics dashboard will be ready at `/analytics`!
 
-This single command publishes the necessary configuration, assets, and migration files. It will then interactively prompt you to run the database migrations, providing a safe option that only affects this package's tables.
+### Manual Setup (Advanced)
 
-### Manual Setup
+For users who prefer manual control over the installation process or need custom configurations:
 
 #### Database Setup
 
@@ -140,6 +145,21 @@ Optionally, publish the views for customization:
 php artisan vendor:publish --tag="request-analytics-views"
 ```
 
+#### Publishing Options
+
+The package supports granular publishing of individual components:
+
+```bash
+# Publish specific components
+php artisan vendor:publish --tag="request-analytics-config"
+php artisan vendor:publish --tag="request-analytics-migrations" 
+php artisan vendor:publish --tag="request-analytics-assets"
+php artisan vendor:publish --tag="request-analytics-views"
+
+# Or publish everything at once
+php artisan vendor:publish --provider="MeShaon\RequestAnalytics\RequestAnalyticsServiceProvider"
+```
+
 ### Automated Data Pruning
 
 The package includes automatic data cleanup to manage database size. Configure pruning in your scheduler:
@@ -205,6 +225,26 @@ protected function schedule(Schedule $schedule): void
 
 ## Usage
 
+### Getting Started
+
+After installation, the package automatically starts tracking requests based on your configuration. Here's what happens next:
+
+1. **Dashboard Access**: Visit `/analytics` (or your configured pathname) to view the analytics dashboard
+2. **Automatic Tracking**: Request data is captured automatically for web and API routes
+
+### Quick Commands
+
+```bash
+# Run the interactive installer
+php artisan request-analytics:install
+
+# View available analytics commands
+php artisan list | grep analytics
+
+# Clear old analytics data (if pruning is enabled)
+php artisan model:prune --model="MeShaon\RequestAnalytics\Models\RequestAnalytics"
+```
+
 ## Configuration Options
 
 ### Route Configuration

composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php": "^8.1 | ^8.2 | ^8.3",
         "illuminate/contracts": "^10.0 | ^11.0 | ^12.0",
-        "spatie/laravel-package-tools": "^1.14.0"
+        "spatie/laravel-package-tools": "^1.16.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",

src/Commands/RequestAnalyticsCommand.php

@@ -3,53 +3,51 @@
 namespace MeShaon\RequestAnalytics;
 
 use Illuminate\Contracts\Http\Kernel;
-use MeShaon\RequestAnalytics\Commands\RequestAnalyticsCommand;
-use MeShaon\RequestAnalytics\Commands\SetupCommand;
 use MeShaon\RequestAnalytics\Http\Middleware\AnalyticsDashboardMiddleware;
 use MeShaon\RequestAnalytics\Http\Middleware\APIRequestCapture;
 use MeShaon\RequestAnalytics\Http\Middleware\WebRequestCapture;
+use Spatie\LaravelPackageTools\Commands\InstallCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
 class RequestAnalyticsServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
     {
-        // Manually publish migrations with proper timestamp
-        $this->publishes([
-            __DIR__.'/../database/migrations/create_request_analytics_table.php' => database_path('migrations/'.date('Y_m_d_His').'_create_request_analytics_table.php'),
-        ], 'laravel-request-analytics-migrations');
-
-        // Manually publish config with correct tag
-        $this->publishes([
-            __DIR__.'/../config/request-analytics.php' => config_path('request-analytics.php'),
-        ], 'laravel-request-analytics-config');
-
-        // Manually publish assets with correct tag
-        $this->publishes([
-            __DIR__.'/../resources/assets' => public_path('/'),
-        ], 'laravel-request-analytics-assets');
-
         $package
             ->name('laravel-request-analytics')
+            ->hasConfigFile()
             ->hasViews()
-            ->hasRoute('web')
-            ->hasRoute('api')
-            ->hasCommand(RequestAnalyticsCommand::class);
+            ->hasRoutes(['web', 'api'])
+            ->hasAssets()
+            ->hasMigrations(['create_request_analytics_table', 'add_indexes_to_request_analytics_table'])
+            ->hasInstallCommand(function (InstallCommand $command): void {
+                $command
+                    ->startWith(function (InstallCommand $command): void {
+                        $command->info('Installing Laravel Request Analytics...');
+                        $command->info('This package will help you track and analyze your application requests.');
+                    })
+                    ->publishConfigFile()
+                    ->publishMigrations()
+                    ->publishAssets()
+                    ->askToRunMigrations()
+                    ->endWith(function (InstallCommand $command): void {
+                        $command->info('Laravel Request Analytics has been installed successfully!');
+                        $command->info('You can now visit /analytics to view your dashboard.');
+                        $command->info('Check the documentation for configuration options.');
+                    })
+                    ->askToStarRepoOnGitHub('me-shaon/laravel-request-analytics');
+            });
+    }
 
+    public function packageRegistered(): void
+    {
         $this->registerMiddlewareAsAliases();
     }
 
-    public function boot(): void
+    public function packageBooted(): void
     {
-        parent::boot();
         $this->pushMiddlewareToPipeline();
-
-        if ($this->app->runningInConsole()) {
-            $this->commands([
-                SetupCommand::class,
-            ]);
-        }
     }
 
     private function registerMiddlewareAsAliases(): void

src/Commands/SetupCommand.php

@@ -126,6 +126,8 @@ public function it_validates_end_date_before_start_date(): void
     #[Test]
     public function it_returns_empty_overview_data(): void
     {
+        \Illuminate\Support\Facades\Cache::flush();
+
         $response = $this->getJson(route('request-analytics.api.overview'));
 
         $response->assertOk()