update some structure

Author: farhadzand

README.md

@@ -1,38 +1,7 @@
-# Laravel Audit Logger
-
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/iamfarhad/laravel-audit-log.svg?style=flat-square)](https://packagist.org/packages/iamfarhad/laravel-audit-log)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/iamfarhad/laravel-audit-log/run-tests?label=tests)](https://github.com/iamfarhad/laravel-audit-log/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/iamfarhad/laravel-audit-log/Check%20&%20fix%20styling?label=code%20style)](https://github.com/iamfarhad/laravel-audit-log/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/iamfarhad/laravel-audit-log.svg?style=flat-square)](https://packagist.org/packages/iamfarhad/laravel-audit-log)
+# Laravel Audit Log
 
 A comprehensive entity-level audit logging package for Laravel with support for MySQL and MongoDB databases.
 
-## Table of Contents
-
-- [Features](#features)
-- [Requirements](#requirements)
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Basic Usage](#basic-usage)
-  - [Making Models Auditable](#making-models-auditable)
-  - [Automatic Logging](#automatic-logging)
-  - [Manual Logging](#manual-logging)
-  - [Retrieving Audit Logs](#retrieving-audit-logs)
-  - [Disabling Auditing](#disabling-auditing)
-- [Advanced Features](#advanced-features)
-  - [Custom Metadata](#custom-metadata)
-  - [Field Filtering](#field-filtering)
-  - [Batch Processing](#batch-processing)
-  - [Custom Causer Resolver](#custom-causer-resolver)
-  - [Using Different Drivers](#using-different-drivers)
-  - [Event-Driven Architecture](#event-driven-architecture)
-- [Database Schema](#database-schema)
-- [Troubleshooting](#troubleshooting)
-- [Performance Considerations](#performance-considerations)
-- [Testing](#testing)
-- [Changelog](#changelog)
-- [License](#license)
-
 ## Features
 
 - ✅ **Multiple Entity Support**: Audit any number of entities with dedicated log tables/collections
@@ -41,8 +10,6 @@ A comprehensive entity-level audit logging package for Laravel with support for
 - ✅ **Field Inclusion/Exclusion**: Fine-grained control over which fields to audit
 - ✅ **Causer Identification**: Automatic tracking of who made the changes
 - ✅ **Auto-Migration**: Automatic table/collection creation for new entities
-- ✅ **Batch Processing**: Optional batching of audit logs for improved performance
-- ✅ **Queue Support**: Option to process audit logs via Laravel queues
 - ✅ **SOLID Principles**: Clean, maintainable, and extensible architecture
 
 ## Requirements
@@ -104,13 +71,6 @@ return [
     // Auto-migration for new entities
     'auto_migration' => env('AUDIT_AUTO_MIGRATION', true),
 
-    // Batch processing configuration
-    'batch' => [
-        'enabled' => env('AUDIT_BATCH_ENABLED', false),
-        'size' => env('AUDIT_BATCH_SIZE', 50),
-        'timeout' => env('AUDIT_BATCH_TIMEOUT', 10), // seconds
-    ],
-
     // Global field configuration
     'fields' => [
         'exclude' => ['password', 'remember_token', 'api_token'],
@@ -130,42 +90,45 @@ return [
 
 ### Making Models Auditable
 
-To make a model auditable, implement the `AuditableInterface` and use the `Auditable` trait:
+To make a model auditable, simply use the `Auditable` trait:
 
 ```php
 <?php
 
-declare(strict_types=1);
-
 namespace App\Models;
 
-use iamfarhad\LaravelAuditLog\Contracts\AuditableInterface;
 use iamfarhad\LaravelAuditLog\Traits\Auditable;
 use Illuminate\Database\Eloquent\Model;
 
-class Product extends Model implements AuditableInterface
+class Product extends Model
 {
     use Auditable;
 
-    // Your model code...
-
+    // Simply define properties to configure auditing
+    
     /**
-     * Get fields to exclude from audit logging.
+     * Fields to exclude from audit logging.
      *
-     * @return array<string>
+     * @var array<string>
      */
-    public function getAuditExclude(): array
-    {
-        return [
-            'internal_notes',
-            'updated_at',
-        ];
-    }
+    protected array $auditExclude = [
+        'password',
+        'remember_token',
+        'updated_at',
+    ];
+    
+    /**
+     * Fields to include in audit logging.
+     * Default ['*'] means include all fields except excluded ones.
+     * If you specify fields here, only these fields will be audited.
+     *
+     * @var array<string>
+     */
+    protected array $auditInclude = ['*'];
 
     /**
      * Get custom metadata for audit logs.
-     *
-     * @return array<string, mixed>
+     * Optional - Override this method to add custom metadata.
      */
     public function getAuditMetadata(): array
     {
@@ -174,14 +137,6 @@ class Product extends Model implements AuditableInterface
             'user_agent' => request()->userAgent(),
         ];
     }
-
-    /**
-     * Determine if auditing should be queued.
-     */
-    public function shouldQueueAudit(): bool
-    {
-        return true; // Process audit logs in queue
-    }
 }
 ```
 
@@ -235,8 +190,6 @@ $logs = AuditLogger::getLogsForEntity(
         'action' => 'updated',
         'from_date' => '2024-01-01',
         'to_date' => '2024-12-31',
-        'order_by' => 'created_at',
-        'order_direction' => 'desc',
     ]
 );
 ```
@@ -260,6 +213,32 @@ $product->enableAuditing();
 
 ## Advanced Features
 
+### Field Filtering
+
+Control which fields are audited using properties:
+
+```php
+// Exclude specific fields
+protected array $auditExclude = [
+    'password', 
+    'remember_token', 
+    'secret_key'
+];
+
+// Or explicitly include only certain fields
+protected array $auditInclude = [
+    'name', 
+    'email', 
+    'role', 
+    'status'
+];
+```
+
+The field filtering works as follows:
+1. If `$auditInclude` is `['*']` (default), all fields except those in `$auditExclude` will be audited
+2. If `$auditInclude` has specific fields, only those fields (minus any in `$auditExclude`) will be audited
+3. Global exclusions from `config('audit-logger.fields.exclude')` are always applied
+
 ### Custom Metadata
 
 Add context to your audit logs by implementing `getAuditMetadata()`:
@@ -276,53 +255,6 @@ public function getAuditMetadata(): array
 }
 ```
 
-### Field Filtering
-
-Control which fields are audited:
-
-```php
-// Exclude specific fields
-protected array $auditExclude = ['password', 'remember_token', 'secret_key'];
-
-// Or explicitly include only certain fields
-protected array $auditInclude = ['name', 'email', 'role', 'status'];
-
-// You can also implement getAuditExclude() or getAuditInclude() methods 
-// for more dynamic control
-public function getAuditExclude(): array
-{
-    $fields = ['password', 'remember_token'];
-    
-    if (!auth()->user()->isAdmin()) {
-        $fields[] = 'admin_notes';
-    }
-    
-    return $fields;
-}
-```
-
-### Batch Processing
-
-Enable batch processing in your config to improve performance:
-
-```php
-// In config/audit-logger.php
-'batch' => [
-    'enabled' => env('AUDIT_BATCH_ENABLED', true),
-    'size' => env('AUDIT_BATCH_SIZE', 50),
-    'timeout' => env('AUDIT_BATCH_TIMEOUT', 10), // seconds
-],
-```
-
-With batching enabled, audit logs are stored in memory and written to the database in batches. You can manually flush the batch:
-
-```php
-use iamfarhad\LaravelAuditLog\Facades\AuditLogger;
-
-// Manually flush the batch
-AuditLogger::flush();
-```
-
 ### Custom Causer Resolver
 
 Create a custom causer resolver if you need special logic for determining who made a change:
@@ -370,25 +302,49 @@ AuditLogger::driver('mongodb')->log(...);
 AuditLogger::driver('mysql')->log(...);
 ```
 
-### Event-Driven Architecture
+### Helper Methods for Retrieving Logs
 
-The package uses Laravel events. You can listen for audit events:
+You can add helper methods to your models to make retrieving audit logs easier:
 
 ```php
-// In a service provider
-use iamfarhad\LaravelAuditLog\Events\ModelAudited;
-use Illuminate\Support\Facades\Event;
-
-Event::listen(ModelAudited::class, function (ModelAudited $event) {
-    // Access event properties
-    $entity = $event->entity;
-    $action = $event->action;
-    $oldValues = $event->oldValues;
-    $newValues = $event->newValues;
-    
-    // Your custom logic
-    // For example, send notifications, update cache, etc.
-});
+/**
+ * Get the audit logs for this model.
+ */
+public function auditLogs(array $options = [])
+{
+    return AuditLogger::getLogsForEntity(
+        entityType: static::class,
+        entityId: $this->getKey(),
+        options: $options
+    );
+}
+
+/**
+ * Get the most recent audit logs for this model.
+ */
+public function recentAuditLogs(int $limit = 10)
+{
+    return AuditLogger::getLogsForEntity(
+        entityType: static::class,
+        entityId: $this->getKey(),
+        options: [
+            'limit' => $limit,
+            'from_date' => now()->subDays(30)->toDateString(),
+        ]
+    );
+}
+
+/**
+ * Get audit logs for a specific action.
+ */
+public function getActionLogs(string $action)
+{
+    return AuditLogger::getLogsForEntity(
+        entityType: static::class,
+        entityId: $this->getKey(),
+        options: ['action' => $action]
+    );
+}
 ```
 
 ## Database Schema
@@ -409,28 +365,14 @@ CREATE TABLE audit_products_logs (
     metadata JSON NULL,
     created_at TIMESTAMP NOT NULL,
     INDEX idx_entity_id (entity_id),
-    INDEX idx_action (action),
-    INDEX idx_created_at (created_at),
-    INDEX idx_causer (causer_type, causer_id),
-    INDEX idx_entity_created (entity_id, created_at),
-    INDEX idx_entity_action (entity_id, action)
+    INDEX idx_causer_id (causer_id),
+    INDEX idx_created_at (created_at)
 );
 ```
 
 ### MongoDB
 
-For MongoDB, collections are created with appropriate indexes:
-
-```php
-// Collection: audit_products_logs
-// Indexes:
-// - entity_id: 1
-// - action: 1
-// - created_at: 1
-// - causer_type: 1, causer_id: 1
-// - entity_id: 1, created_at: 1
-// - entity_id: 1, action: 1
-```
+For MongoDB, collections are created with similar fields and appropriate indexes.
 
 ## Troubleshooting
 
@@ -450,44 +392,14 @@ For MongoDB, collections are created with appropriate indexes:
    ```
 
 2. **Logs not appearing**: Check if:
-   - Model implements `AuditableInterface`
    - Model uses `Auditable` trait
    - Auditing is enabled on the model instance
-   - Batch processing might be holding logs (call `AuditLogger::flush()`)
-   - Check if queue is running (if using queued audits)
 
 3. **MongoDB driver issues**: Ensure you've installed the MongoDB package:
    ```bash
    composer require mongodb/laravel-mongodb
    ```
 
-### Debugging
-
-Enable debug mode in your Laravel application to see more information about audit logging:
-
-```php
-// In .env
-APP_DEBUG=true
-```
-
-## Performance Considerations
-
-- Use batch processing for high-volume applications
-- Consider using queued listeners for audit events (implement `shouldQueueAudit()`)
-- Create appropriate indexes if you have custom query patterns
-- Regularly archive old audit logs
-- For extremely high-volume applications, consider a separate database for audit logs
-
-## Testing
-
-```bash
-composer test
-```
-
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.