Package renaming

Author: seniortaco05

README.md

@@ -8,53 +8,45 @@ Logger is a lightweight, opinionated activity logging package for Laravel that a
 You can install the package via composer:
 
 ```bash
-composer require gott/logger
+composer require gottvergessen/activity
 ```
 
 You can publish and run the migrations with:
 
 ```bash
-php artisan logger:install
+php artisan activity:install
 ```
 
-
-### config/logger.php
+### config/activity.php
 
 ```php
-    return [
-        'enabled' => env('LOGGER_ENABLED', true),
-
-        'table' => 'activity_logs',
-
-        'default_log' => env('LOGGER_DEFAULT_LOG', 'default'),
-
-        'origin' => env('LOGGER_ORIGIN', 'web'),
-
-        'events' => [
-            'created',
-            'updated',
-            'deleted',
-            'restored',
-        ],
-
-        'ignore_attributes' => [
-            'created_at',
-            'updated_at',
-            'deleted_at',
-            'remember_token',
-        ],
+return [
+    'enabled' => true,
 
-        'use_diffs' => true,
+    'table' => 'activity_logs',
 
-        'driver' => 'database',
-    ];
+    'default_log' => 'default',
 
+    'events' => [
+        'created',
+        'updated',
+        'deleted',
+        'restored',
+    ],
+
+    'ignore_attributes' => [
+        'created_at',
+        'updated_at',
+        'deleted_at',
+        'remember_token',
+    ],
+];
 ```
 
 ## Basic usage
 
 ```php
-use Gottvergessen\Logger\Traits\TracksModelActivity;
+use Gottvergessen\Activity\Traits\TracksModelActivity;
 
 class User extends Authenticatable
 {
@@ -64,8 +56,9 @@ class User extends Authenticatable
 ```
 
 ## Ignore Specific Fields per Model
+
 ```php
-use Gottvergessen\Logger\Traits\TracksModelActivity;
+use Gottvergessen\Activity\Traits\TracksModelActivity;
 
 class User extends Authenticatable
 {
@@ -77,14 +70,61 @@ class User extends Authenticatable
     ];
 
     /*
-    *  Changes to the listed attributes will not appear in the activity properties
-    *  If only ignored attributes change, no activity log entry is created
+    * Changes to the listed attributes will not appear in the activity properties
+    * If only ignored attributes change, no activity log entry is created
     */
 }
 ```
+
+## Database Schema
+
+The `activity_logs` table tracks the following information:
+
+| Column | Type | Description |
+|--------|------|-------------|
+| id | ID | Primary key |
+| event | string | The event type (created, updated, deleted, restored) |
+| action | string | Custom semantic action defined by the model (optional) |
+| log | string | Log category for grouping activities |
+| description | string | Description of the activity (optional) |
+| subject_type | string | The model class that was changed |
+| subject_id | int | The ID of the model that was changed |
+| causer_type | string | The model class of the user who made the change (optional) |
+| causer_id | int | The ID of the user who made the change (optional) |
+| properties | json | The model attributes that changed |
+| meta | json | Metadata including IP, user agent, HTTP method, and host |
+| batch_id | string | Batch ID for grouping related changes (optional) |
+| created_at | timestamp | When the activity was recorded |
+| updated_at | timestamp | When the activity record was last updated |
+
+## Eloquent Friendly
+
+```php
+use Gottvergessen\Activity\Traits\TracksModelActivity;
+use Gottvergessen\Activity\Traits\InteractsWithActivity;
+
+class User extends Authenticatable
+{
+    use TracksModelActivity, InteractsWithActivity;
+}
+```
+
+With the `InteractsWithActivity` trait, you can easily query a model's activities:
+
+```php
+$users = User::with('activities')->get();
+
+// Access activities for a specific model
+$userActivities = $user->activities()->get();
+$userActivities = $user->activities()->where('event', 'updated')->get();
+```
+
+The `InteractsWithActivity` trait is optional and only required if you want to access `$model->activities()`.
+
 ## Per-Model Event Control
+
 ```php
-use Gottvergessen\Logger\Traits\TracksModelActivity;
+use Gottvergessen\Activity\Traits\TracksModelActivity;
 
 class User extends Authenticatable
 {
@@ -96,29 +136,63 @@ class User extends Authenticatable
     ];
 
     /*
-    *  Limit which events are tracked:
-    *  
+    * Limit which events are tracked for this model
     */
 }
 ```
-### Custom description per Model
+## Advanced Usage
+
+### Custom Log Name per Model
+
 ```php
+use Gottvergessen\Activity\Traits\TracksModelActivity;
+
+class Invoice extends Model
+{
+    use TracksModelActivity;
+
+    public function activityLog(): string
+    {
+        return 'invoices';
+    }
+}
+```
+
+### Custom Action per Model
+
+```php
+use Gottvergessen\Activity\Traits\TracksModelActivity;
+
 class Appointment extends Model
 {
     use TracksModelActivity;
 
-    public function activityDescription(string $event): string
+    public function activityAction(string $event): string
     {
         return match ($event) {
-            'created' => "Appointment scheduled for {$this->scheduled_at}",
-            'updated' => "Appointment updated for {$this->scheduled_at}",
-            'deleted' => "Appointment cancelled",
-            default   => "Appointment {$event}",
+            'created' => "Appointment was scheduled for {$this->scheduled_at}",
+            'updated' => "Appointment has been updated to {$this->new_appointment_date}",
+            default   => $event,
         };
     }
 }
 ```
 
+### Batch Operations
+
+Feature not yet Implement but it will be:
+Group multiple model changes under a single batch ID:
+
+```php
+use Gottvergessen\Activity\Activity;
+
+Activity::batch(function () {
+    $user->update(['name' => 'John']);
+    $user->profile()->update(['bio' => 'Updated bio']);
+    // Both changes share the same batch_id
+});
+```
+
 
 
 ## Contributing

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "gott/logger",
+    "name": "gottvergessen/activity",
     "description": "This is my package logger",
     "keywords": [
         "Gottvergessen",
@@ -29,13 +29,13 @@
     },
     "autoload": {
         "psr-4": {
-            "Gottvergessen\\Logger\\": "src/",
-            "Gottvergessen\\Logger\\Database\\Factories\\": "database/factories/"
+            "Gottvergessen\\Activity\\": "src/",
+            "Gottvergessen\\Activity\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Gottvergessen\\Logger\\Tests\\": "tests/",
+            "Gottvergessen\\Activity\\Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/"
         }
     },
@@ -57,10 +57,10 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Gottvergessen\\Logger\\LoggerServiceProvider"
+                "Gottvergessen\\Activity\\ActivityServiceProvider"
             ],
             "aliases": {
-                "Logger": "Gottvergessen\\Logger\\Facades\\Logger"
+                "Activity": "Gottvergessen\\Activity\\Facades\\Activity"
             }
         }
     },

config/logger.php config/activity.phpconfig/logger.php renamed to config/activity.php

@@ -10,41 +10,18 @@ return new class extends Migration
     {
         Schema::create('activity_logs', function (Blueprint $table) {
             $table->id();
-
-            /**
-            * WHAT happened
-            */
-            $table->string('event', 32);                 // created | updated | deleted | restored
-            $table->string('action', 64)->nullable();    // optional semantic action (approved, assigned, paid)
-            $table->string('log', 64)->default('default'); // grouping / channel
-            $table->text('description')->nullable();     // human-readable sentence
-
-            /**
-            * SUBJECT (model being acted on)
-            */
-            $table->string('subject_type');              // App\Models\Order
-            $table->unsignedBigInteger('subject_id');    // 123
-
-            /**
-            * ACTOR (who caused it)
-            */
-            $table->string('causer_type')->nullable();   // App\Models\User | system | job
+            $table->string('event', 32);                 
+            $table->string('action', 64)->nullable();
+            $table->string('log', 64)->default('default'); 
+            $table->text('description')->nullable();
+            $table->string('subject_type');
+            $table->unsignedBigInteger('subject_id');
+            $table->string('causer_type')->nullable();
             $table->unsignedBigInteger('causer_id')->nullable();
-
-            /**
-            * CONTEXT / METADATA
-            */
-            $table->json('properties')->nullable();      // before/after values
-            $table->json('meta')->nullable();            // ip, ua, route, request id
-
-            /**
-            * SYSTEM
-            */
-            $table->string('origin', 32)->nullable();    // web | api | console | queue
-            $table->string('batch_id', 36)->nullable();  // UUID for grouped actions
-
+            $table->json('properties')->nullable();
+            $table->json('meta')->nullable();
+            $table->string('batch_id', 36)->nullable();
             $table->timestamps();
-
             $table->index(['subject_type', 'subject_id']);
             $table->index(['causer_type', 'causer_id']);
             $table->index(['event', 'created_at']);
@@ -53,6 +30,6 @@ return new class extends Migration
     }
 
     public function down(){
-        Schema::dropIfExists(config('logger.table'));
+        Schema::dropIfExists('activity_logs');
     }
 };

database/migrations/create_logger_table.php.stub

@@ -1,18 +1,18 @@
 <?php
 
-namespace Gottvergessen\Logger;
+namespace Gottvergessen\Activity;
 
 use Illuminate\Support\Str;
 
-class Logger {
+class Activity {
     public static function batch(callable $callback): mixed
     {
-        app()->instance('logger.batch', (string) Str::uuid());
+        app()->instance('activity.batch', (string) Str::uuid());
 
         try {
             return $callback();
         } finally {
-            app()->forgetInstance('logger.batch');
+            app()->forgetInstance('activity.batch');
         }
     }
 }

src/Logger.php src/Activity.phpsrc/Logger.php renamed to src/Activity.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Gottvergessen\Activity;
+
+
+use Spatie\LaravelPackageTools\Package;
+use Spatie\LaravelPackageTools\PackageServiceProvider;
+use Spatie\LaravelPackageTools\Commands\InstallCommand;
+use Gottvergessen\Activity\Commands\ActivityInstallCommand;
+
+class ActivityServiceProvider extends PackageServiceProvider
+{
+    public function configurePackage(Package $package): void
+    {
+        $package
+            ->name('activity')
+            ->hasConfigFile()
+            ->hasMigration('create_logger_table')
+            ->hasCommand(ActivityInstallCommand::class);
+    }
+
+   
+}