Merge pull request #8 from DirectoryTree/v3

V3

Author: stevebauman

.github/workflows/run-tests.yml

@@ -8,34 +8,14 @@ on:
 
 jobs:
   run-tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        php: [8.1, 8.0, 7.4, 7.3, 7.2]
-        lumen: [9.*, 8.*, 7.*, 6.*, 5.8.*]
+        os: [ubuntu-latest]
+        php: [8.2, 8.1]
+        lumen: [10.*, 9.*, 8.*]
         dependency-version: [prefer-stable]
-        exclude:
-          - lumen: 9.*
-            php: 7.4
-          - lumen: 9.*
-            php: 7.3
-          - lumen: 9.*
-            php: 7.2
-          - lumen: 8.*
-            php: 7.2
-          - lumen: 7.*
-            php: 8.1
-          - lumen: 7.*
-            php: 8.0
-          - lumen: 6.*
-            php: 8.1
-          - lumen: 6.*
-            php: 8.0
-          - lumen: 5.8.*
-            php: 8.1
-          - lumen: 5.8.*
-            php: 8.0
 
     name: P${{ matrix.php }} - L${{ matrix.lumen }} - ${{ matrix.dependency-version }}
 

.gitignore

@@ -1,2 +1,3 @@
 composer.lock
 vendor/
+.phpunit.result.cache

.scrutinizer.yml

@@ -4,6 +4,9 @@ filter:
 build:
     nodes:
         analysis:
+            environment:
+                php:
+                    version: 8.1
             tests:
                 override:
                     - command: php-scrutinizer-run

composer.json

@@ -5,14 +5,14 @@
     "license": "MIT",
     "type": "project",
     "require": {
-        "php": ">=7.2",
-        "ext-ldap": "*",
-        "directorytree/ldaprecord-laravel": "^v2.1.1",
-        "laravel/lumen-framework": "^5.6|^6.0|^7.0|^8.0|^9.0|^10.0"
+        "php": ">=8.1",
+        "directorytree/ldaprecord-laravel": "^v3.0",
+        "laravel/lumen-framework": "^8.0|^9.0|^v10.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.1",
-        "phpunit/phpunit": "^8.5"
+        "phpunit/phpunit": "^8.5",
+        "laravel/pint": "^1.10"
     },
     "archive": {
         "exclude": ["/tests"]

src/LdapAuthServiceProvider.php

@@ -3,32 +3,17 @@
 namespace LdapRecord\Lumen;
 
 use Illuminate\Support\Facades\Auth;
-use Illuminate\Support\Facades\Event;
 use LdapRecord\Laravel\LdapAuthServiceProvider as BaseServiceProvider;
 
 class LdapAuthServiceProvider extends BaseServiceProvider
 {
     /**
      * {@inheritDoc}
      */
-    protected function registerAuthProvider()
+    protected function registerAuthProvider(): void
     {
         if (! is_null(Auth::getFacadeRoot())) {
             parent::registerAuthProvider();
         }
-
-        return $this;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    protected function registerEventListeners()
-    {
-        if (! is_null(Event::getFacadeRoot())) {
-            parent::registerEventListeners();
-        }
-
-        return $this;
     }
 }

src/LdapServiceProvider.php

@@ -2,29 +2,36 @@
 
 namespace LdapRecord\Lumen;
 
+use Illuminate\Support\Facades\Event;
 use LdapRecord\Laravel\LdapServiceProvider as BaseServiceProvider;
 
 class LdapServiceProvider extends BaseServiceProvider
 {
     /**
      * {@inheritDoc}
      */
-    protected function registerConfiguration()
+    protected function registerConfiguration(): void
     {
         $this->app->configure('ldap');
-
-        return $this;
     }
 
     /**
      * {@inheritDoc}
      */
-    protected function registerCommands()
+    protected function registerCommands(): void
     {
         parent::registerCommands();
 
         $this->commands([MakeLdapConfig::class]);
+    }
 
-        return $this;
+    /**
+     * {@inheritDoc}
+     */
+    protected function registerEventListeners(): void
+    {
+        if (! is_null(Event::getFacadeRoot())) {
+            parent::registerEventListeners();
+        }
     }
 }

src/MakeLdapConfig.php

@@ -9,17 +9,15 @@ class MakeLdapConfig extends Command
 {
     /**
      * The filesystem instance.
-     *
-     * @var \Illuminate\Filesystem\Filesystem
      */
-    protected $files;
+    protected Filesystem $files;
 
     /**
      * The console command name.
      *
      * @var string
      */
-    protected $name = 'make:ldap-config';
+    protected $name = 'ldap:make:config';
 
     /**
      * The console command description.
@@ -30,9 +28,6 @@ class MakeLdapConfig extends Command
 
     /**
      * Create a new controller creator command instance.
-     *
-     * @param  Filesystem  $files
-     * @return void
      */
     public function __construct(Filesystem $files)
     {
@@ -44,18 +39,22 @@ public function __construct(Filesystem $files)
     /**
      * Create the LDAP configuration file.
      */
-    public function handle()
+    public function handle(): int
     {
         if (! $this->files->exists($stubPath = $this->getStubPath())) {
-            return $this->error("Unable to retrieve LDAP configuration stub file from path [$stubPath]");
+            $this->error("Unable to retrieve LDAP configuration stub file from path [$stubPath]");
+
+            return static::FAILURE;
         }
 
         $publishPath = $this->getLdapConfigPath(
             $configPath = $this->getConfigPath()
         );
 
         if ($this->alreadyExists($publishPath)) {
-            return $this->error("LDAP configuration file already exists at path [$publishPath]");
+            $this->error("LDAP configuration file already exists at path [$publishPath]");
+
+            return static::INVALID;
         }
 
         if (! $this->alreadyExists($configPath)) {
@@ -65,67 +64,54 @@ public function handle()
         $this->files->put($publishPath, $this->getContents($stubPath));
 
         $this->info("Successfully created LDAP configuration file at path [$publishPath]");
+
+        return static::SUCCESS;
     }
 
     /**
      * Determine if the given file / folder already exists.
-     *
-     * @param  string  $path
-     * @return bool
      */
-    protected function alreadyExists($path)
+    protected function alreadyExists(string $path): bool
     {
         return $this->files->exists($path);
     }
 
     /**
      * Make the given directory path.
-     *
-     * @param  string  $path
      */
-    protected function makeDirectory($path)
+    protected function makeDirectory(string $path): void
     {
         $this->files->makeDirectory($path);
     }
 
     /**
      * Get the contents of the given file.
-     *
-     * @param  string  $path
-     * @return string
      */
-    protected function getContents($path)
+    protected function getContents(string $path): string
     {
         return $this->files->get($path);
     }
 
     /**
      * Get the LDAP configuration file stub.
-     *
-     * @return string
      */
-    protected function getStubPath()
+    protected function getStubPath(): string
     {
         return base_path(implode(DIRECTORY_SEPARATOR, ['vendor', 'directorytree', 'ldaprecord-laravel', 'config', 'ldap.php']));
     }
 
     /**
      * Get the configuration folder path.
-     *
-     * @return string
      */
-    public function getConfigPath()
+    public function getConfigPath(): string
     {
         return base_path('config');
     }
 
     /**
      * Get the full LDAP configuration file path.
-     *
-     * @param  string  $configPath
-     * @return string
      */
-    protected function getLdapConfigPath($configPath)
+    protected function getLdapConfigPath(string $configPath): string
     {
         return $configPath.DIRECTORY_SEPARATOR.'ldap.php';
     }

tests/LdapServiceProviderTest.php

@@ -24,7 +24,7 @@ protected function setUp(): void
 
     public function test_connections_are_auto_loaded()
     {
-        $this->assertIsArray($connections = Container::getInstance()->all());
+        $this->assertIsArray($connections = Container::getInstance()->getConnections());
         $this->assertCount(1, $connections);
 
         $this->assertInstanceOf(Connection::class, $default = $connections['default']);

tests/MakeLdapConfigTest.php

@@ -41,7 +41,7 @@ protected function configFileFolder()
 
     public function test_configuration_file_can_be_published()
     {
-        $this->artisan('make:ldap-config');
+        $this->artisan('ldap:make:config');
 
         $this->assertTrue(file_exists($this->configFilePath()));
         $this->assertTrue(file_exists($this->configFileFolder()));