Add a facade

Resolves #3

CHANGELOG.md

@@ -3,7 +3,8 @@
 ## [Unreleased](https://github.com/markwalet/laravel-git-state/compare/v1.0.2...master)
 
 ### Added
-- Added DocBlock for git manager
+- Added DocBlock for git manager.
+- Added a facade.
 
 ## [1.0.2](https://github.com/markwalet/laravel-git-state/compare/v1.0.1...v1.0.2)
 

composer.json

@@ -36,7 +36,10 @@
     "laravel": {
       "providers": [
         "MarkWalet\\GitState\\GitServiceProvider"
-      ]
+      ],
+      "aliases": {
+        "GitState": "MarkWalet\\GitState\\Facades\\GitState"
+      }
     }
   }
 }

src/Facades/GitState.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace MarkWalet\GitState\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use MarkWalet\GitState\Drivers\GitDriver;
+
+/**
+ * Class GitState
+ *
+ * @method static string currentBranch()
+ * @see GitDriver
+ */
+class GitState extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return GitDriver::class;
+    }
+}

src/GitManager.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpHierarchyChecksInspection */
 
 namespace MarkWalet\GitState;
 
@@ -7,11 +7,7 @@
 use MarkWalet\GitState\Exceptions\MissingConfigurationException;
 
 /**
- * Class GitManager
- *
- * @package MarkWalet\GitState
- * @method string currentBranch
- * @see GitDriver
+ * @mixin GitDriver
  */
 class GitManager
 {

src/GitServiceProvider.php

@@ -35,7 +35,7 @@ private function registerGitServices(): void
         });
 
         // Bind default driver to application.
-        $this->app->bind(GitDriver::class, function (Application $app) {
+        $this->app->singleton(GitDriver::class, function (Application $app) {
             /** @var GitManager $manager */
             $manager = $app->make(GitManager::class);
 

tests/GitServiceProviderTest.php

@@ -10,6 +10,7 @@
 use MarkWalet\GitState\Exceptions\MissingDriverException;
 use MarkWalet\GitState\Exceptions\NoGitRepositoryException;
 use MarkWalet\GitState\Exceptions\RuntimeException;
+use MarkWalet\GitState\Facades\GitState;
 use MarkWalet\GitState\GitDriverFactory;
 use MarkWalet\GitState\GitManager;
 use PHPUnit\Framework\TestCase;
@@ -42,4 +43,14 @@ public function it_codec_resolves_to_default_codec()
 
         $this->assertInstanceOf(FakeGitDriver::class, $driver);
     }
+
+    /** @test */
+    public function it_registers_a_facade()
+    {
+        $this->app['config']['git-state.default'] = 'test';
+        $this->app['config']['git-state.drivers.test'] = ['driver' => 'fake'];
+        $branch = GitState::currentBranch();
+
+        $this->assertEquals('master', $branch);
+    }
 }