rename repo

Author: chr15k

README.md

@@ -1,16 +1,6 @@
-# Laravel Response Optimizer
+# Laravel Response Compression
 
-Boost your Laravel application's performance by optimizing HTTP responses with middleware for compression and HTML minification.
-
-## Key Features
-
-#### Compression
-
-Shrink response payloads using Gzip or Brotli compression.
-
-#### HTML Minification
-
-Reduce the size of HTML responses by eliminating unnecessary whitespace and formatting.
+Boost your Laravel application's performance by optimizing HTTP responses with middleware for compression.
 
 ---
 
@@ -19,13 +9,13 @@ Reduce the size of HTML responses by eliminating unnecessary whitespace and form
 Install the package via Composer:
 
 ```bash
-composer require chr15k/laravel-response-optimizer
+composer require chr15k/laravel-response-compression
 ```
 
 Publish the configuration file:
 
 ```bash
-php artisan vendor:publish --provider="Chr15k\ResponseOptimizer\ResponseOptimizerServiceProvider"
+php artisan vendor:publish --provider="Chr15k\ResponseCompression\ResponseCompressionServiceProvider"
 ```
 
 ---
@@ -40,10 +30,6 @@ Applies Gzip or Brotli compression to HTTP responses based on client support. Th
 
 **Ideal For**: Large JSON responses, static files, or data-intensive endpoints.
 
-#### 2. HTML Minification Middleware
-
-Minifies HTML responses by removing unnecessary whitespace and formatting to reduce payload size.
-
 ---
 
 ## Setup
@@ -61,8 +47,7 @@ Apply the middleware globally to all requests:
     ...
     $middleware->web(append: [
         ...
-        \Chr15k\ResponseOptimizer\Middleware\MinifyHtml::class,
-        \Chr15k\ResponseOptimizer\Middleware\CompressResponse::class,
+        \Chr15k\ResponseCompression\Middleware\CompressResponse::class,
     ]);
 })
 ```
@@ -72,7 +57,7 @@ Apply the middleware globally to all requests:
 Alternatively, register it as route middleware for selective application:
 
 ```php
-use Chr15k\ResponseOptimizer\Middleware\CompressResponse;
+use Chr15k\ResponseCompression\Middleware\CompressResponse;
 
 Route::get('/profile', function () {
     // ...
@@ -97,4 +82,4 @@ Contributions are welcome! Submit a pull request or open an issue to discuss new
 
 ## License
 
-The MIT License (MIT). Please see [License File](https://github.com/chr15k/laravel-response-optimizer/blob/main/LICENSE) for more information.
+The MIT License (MIT). Please see [License File](https://github.com/chr15k/laravel-response-compression/blob/main/LICENSE) for more information.

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "chr15k/laravel-response-optimizer",
+    "name": "chr15k/laravel-response-compression",
     "description": "Optimize your Laravel responses for performance",
     "license": "MIT",
     "keywords": [
@@ -20,8 +20,7 @@
         "php": "^8.3.0",
         "ext-zlib": "*",
         "illuminate/http": "^11.0",
-        "illuminate/support": "^11.0",
-        "voku/html-min": "^4.5"
+        "illuminate/support": "^11.0"
     },
     "require-dev": {
         "laravel/pint": "^1.18.1",
@@ -34,12 +33,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Chr15k\\ResponseOptimizer\\": "src"
+            "Chr15k\\ResponseCompression\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Chr15k\\ResponseOptimizer\\Tests\\": "tests"
+            "Chr15k\\ResponseCompression\\Tests\\": "tests"
         }
     },
     "config": {
@@ -52,7 +51,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Chr15k\\ResponseOptimizer\\ResponseOptimizerServiceProvider"
+                "Chr15k\\ResponseCompression\\ResponseCompressionServiceProvider"
             ]
         }
     },

config/response-compression.php

@@ -0,0 +1,42 @@
+<?php
+
+return [
+
+    /**
+     * Enable or disable the response compression.
+     */
+    'enabled' => env('RESPONSE_COMPRESSION_ENABLED', true),
+
+    /**
+     * The compression algorithm to use. Can be either 'gzip' or 'br'.
+     */
+    'algorithm' => env('RESPONSE_COMPRESSION_ALGORITHM', 'gzip'),
+
+    /**
+     * The minimum length of the response content to be compressed.
+     */
+    'min_length' => env('RESPONSE_COMPRESSION_MIN_LENGTH', 1024),
+
+    'gzip' => [
+        /**
+         * The level of compression. Can be given as 0 for no compression up to 9
+         * for maximum compression. If not given, the default compression level will
+         * be the default compression level of the zlib library.
+         *
+         * @see https://www.php.net/manual/en/function.gzencode.php
+         */
+        'level' => env('RESPONSE_COMPRESSION_GZIP_LEVEL', 5),
+    ],
+
+    'br' => [
+        /**
+         * The level of compression. Can be given as 0 for no compression up to 11
+         * for maximum compression. If not given, the default compression level will
+         * be the default compression level of the brotli library.
+         *
+         * @see https://www.php.net/manual/en/function.brotli-compress.php
+         */
+        'level' => env('RESPONSE_COMPRESSION_BROTLI_LEVEL', 5),
+    ],
+
+];

config/response-optimizer.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Chr15k\ResponseOptimizer\Contracts;
+namespace Chr15k\ResponseCompression\Contracts;
 
 use Symfony\Component\HttpFoundation\Response;
 

src/Contracts/Encoder.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace Chr15k\ResponseOptimizer\Encoders;
+namespace Chr15k\ResponseCompression\Encoders;
 
-use Chr15k\ResponseOptimizer\Contracts\Encoder;
+use Chr15k\ResponseCompression\Contracts\Encoder;
 use Symfony\Component\HttpFoundation\Response;
 
 final class BrotliEncoder implements Encoder
@@ -29,7 +29,7 @@ public function handle(Response $response): Response
 
     public function level(): int
     {
-        $level = config('response-optimizer.compression.brotli.level');
+        $level = config('response-compression.brotli.level');
 
         return is_int($level) && $level >= 0 && $level <= 11 ? $level : 5;
     }

src/Encoders/BrotliEncoder.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace Chr15k\ResponseOptimizer\Encoders;
+namespace Chr15k\ResponseCompression\Encoders;
 
-use Chr15k\ResponseOptimizer\Contracts\Encoder;
+use Chr15k\ResponseCompression\Contracts\Encoder;
 use Symfony\Component\HttpFoundation\Response;
 
 final class GzipEncoder implements Encoder
@@ -26,7 +26,7 @@ public function handle(Response $response): Response
 
     public function level(): int
     {
-        $level = config('response-optimizer.compression.gzip.level');
+        $level = config('response-compression.gzip.level');
 
         return is_int($level) && $level >= -1 && $level <= 9 ? $level : 5;
     }

src/Encoders/GzipEncoder.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Chr15k\ResponseOptimizer\Middleware;
+namespace Chr15k\ResponseCompression\Middleware;
 
-use Chr15k\ResponseOptimizer\Encoders\BrotliEncoder;
-use Chr15k\ResponseOptimizer\Encoders\GzipEncoder;
+use Chr15k\ResponseCompression\Encoders\BrotliEncoder;
+use Chr15k\ResponseCompression\Encoders\GzipEncoder;
 use Closure;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -23,7 +23,7 @@ public function handle(Request $request, Closure $next): Response
             return $response;
         }
 
-        return match (config('response-optimizer.compression.algorithm')) {
+        return match (config('response-compression.algorithm')) {
             'gzip' => $response = app(GzipEncoder::class)->handle($response),
             'br' => $response = app(BrotliEncoder::class)->handle($response),
             default => $response,
@@ -49,7 +49,7 @@ private function validateResponse(Response $response): bool
 
         return $response->isSuccessful()
             && is_string($content)
-            && strlen($content) > config('response-optimizer.compression.min_length')
+            && strlen($content) > config('response-compression.min_length')
             && $this->validateResponseType($response);
     }
 
@@ -67,7 +67,7 @@ private function validateResponseType(Response $response): bool
     private function validateRequest(Request $request): bool
     {
         return in_array(
-            config('response-optimizer.compression.algorithm'),
+            config('response-compression.algorithm'),
             $request->getEncodings()
         );
     }
@@ -78,7 +78,7 @@ private function validateRequest(Request $request): bool
     private function enabled(): bool
     {
         return filter_var(
-            config('response-optimizer.compression.enabled'),
+            config('response-compression.enabled'),
             FILTER_VALIDATE_BOOLEAN
         );
     }