WIP

Author: orkhanahmadov

README.md

@@ -1,15 +1,13 @@
 # WIP
 
-# Info
+# Laravel "Accept-Language" middleware
 
 [![Latest Stable Version](https://poser.pugx.org/orkhanahmadov/laravel-accept-language-middleware/v/stable)](https://packagist.org/packages/orkhanahmadov/laravel-accept-language-middleware)
 [![Latest Unstable Version](https://poser.pugx.org/orkhanahmadov/laravel-accept-language-middleware/v/unstable)](https://packagist.org/packages/orkhanahmadov/laravel-accept-language-middleware)
 [![Total Downloads](https://img.shields.io/packagist/dt/orkhanahmadov/laravel-accept-language-middleware)](https://packagist.org/packages/orkhanahmadov/laravel-accept-language-middleware)
 [![GitHub license](https://img.shields.io/github/license/orkhanahmadov/laravel-accept-language-middleware.svg)](https://github.com/orkhanahmadov/laravel-accept-language-middleware/blob/master/LICENSE.md)
 
-
-
-Description
+Laravel middleware for automatically setting application locale based on [HTTP "Accept-Language"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) header
 
 ## Installation
 
@@ -21,8 +19,42 @@ composer require orkhanahmadov/laravel-accept-language-middleware
 
 ## Usage
 
+Register `\Orkhanahmadov\LaravelAcceptLanguageMiddleware\Middleware::class` middleware in application's HTTP Kernel.
+
+You can install it as global middleware in Kernel's `$middleware` property:
+
+``` php
+protected $middleware = [
+    ...
+    \Orkhanahmadov\LaravelAcceptLanguageMiddleware\Middleware::class
+];
+```
+
+You can install it to specific middleware groups in Kernel's `$middlewareGroups` property:
+
+``` php
+protected $middlewareGroups = [
+    'web' => [
+        ...
+        \Orkhanahmadov\LaravelAcceptLanguageMiddleware\Middleware::class
+    ]
+];
+```
+
+Or you can install is as route middleware in Kernel's `$routeMiddleware` and use it manually in routes:
+
+Kernel:
+
+``` php
+protected $routeMiddleware = [
+    ...
+    'accept-language' => \Orkhanahmadov\LaravelAcceptLanguageMiddleware\Middleware::class
+];
+```
+
+Route file
 ``` php
-// Usage description here
+Route::middleware(['accept-language'])->get('/', 'MyController@index');
 ```
 
 ### Testing

src/HttpLocaleMiddleware.php src/Middleware.phpsrc/HttpLocaleMiddleware.php renamed to src/Middleware.php

@@ -7,7 +7,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
 
-class HttpLocaleMiddleware
+class Middleware
 {
     /**
      * @var Application

tests/HttpLocaleMiddlewareTest.php tests/MiddlewareTest.phptests/HttpLocaleMiddlewareTest.php renamed to tests/MiddlewareTest.php

@@ -4,13 +4,13 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\App;
-use Orkhanahmadov\LaravelAcceptLanguageMiddleware\HttpLocaleMiddleware;
+use Orkhanahmadov\LaravelAcceptLanguageMiddleware\Middleware;
 
-class HttpLocaleMiddlewareTest extends TestCase
+class MiddlewareTest extends TestCase
 {
     public function test_with_single_locale()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es'
         ]);
@@ -23,7 +23,7 @@ public function test_with_single_locale()
 
     public function test_with_single_with_country()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es-US'
         ]);
@@ -36,7 +36,7 @@ public function test_with_single_with_country()
 
     public function test_with_single_with_country_and_quality_value()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es-US;q=0.5'
         ]);
@@ -49,7 +49,7 @@ public function test_with_single_with_country_and_quality_value()
 
     public function test_with_multiple_locales()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es, de'
         ]);
@@ -62,7 +62,7 @@ public function test_with_multiple_locales()
 
     public function test_with_multiple_locales_with_countries()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es-US, de-DE'
         ]);
@@ -75,7 +75,7 @@ public function test_with_multiple_locales_with_countries()
 
     public function test_with_multiple_locales_with_countries_and_quality_value()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'es-AZ;q=0.7, de-DE;q=0.8'
         ]);
@@ -88,7 +88,7 @@ public function test_with_multiple_locales_with_countries_and_quality_value()
 
     public function test_with_mixed_locale_values()
     {
-        $middleware = $this->app->make(HttpLocaleMiddleware::class);
+        $middleware = $this->app->make(Middleware::class);
         $request = Request::create('whatever', 'GET', [], [], [], [
             'HTTP_ACCEPT_LANGUAGE' => 'fr-CH, de;q=0.7, fr;q=0.9, en;q=0.8, *;q=0.5'
         ]);