Merge pull request #28 from taylornetwork/2.4.0-wip

v2.4.0

README.md

@@ -28,6 +28,12 @@ Easily generate unique usernames for a Laravel User Model
 
 ## Changes
 
+**v2.4**
+
+- This is a minor change but if you're using older versions of Laravel you may need to update your config file.
+- Changed default User model from `App\User` to `App\Models\User` to mirror new Laravel versions (8.0+).
+- Moved the adjective and noun word lists from the config file to a separate file, making the published config smaller and allowing you to create your own word lists if you wish.
+
 **v2.3**
 
 - Added support for random dictionary based usernames if a name is not provided. See the [generate](#generatename) method
@@ -86,6 +92,16 @@ class User extends Authenticatable
 }    
 ```
 
+### Laravel 7 and below
+
+If you're using Laravel 7 or below you'll need to publish the config using 
+
+```bash
+$ php artisan vendor:publish --provider="TaylorNetwork\UsernameGenerator\ServiceProvider"
+```
+
+And update your `config/username_generator.php` file to match your User model namespace (`App\User`).
+
 ### Use username to login
 
 To use the username to login instead of the email you need to add the following to your `LoginController`

src/Support/LoadsConfig.php

@@ -100,6 +100,7 @@ public function loadConfig()
         }
 
         $this->configLoaded = true;
+        $this->checkForDictionary();
     }
 
     /**
@@ -151,4 +152,22 @@ public function withConfig(array $config): self
 
         return $this;
     }
+
+    /**
+     * Adds the the default dictionary words to the config if not set.
+     */
+    private function checkForDictionary()
+    {
+        if ($this->configLoaded) {
+            $dictionary = include __DIR__.'/../config/dictionary.php';
+
+            if (empty($this->config->dictionary['adjectives'])) {
+                $this->config['dictionary']['adjectives'] = $dictionary['adjectives'];
+            }
+
+            if (empty($this->config->dictionary['nouns'])) {
+                $this->config['dictionary']['nouns'] = $dictionary['nouns'];
+            }
+        }
+    }
 }