Merge pull request #76 from codedge/#71-branch-version

Update based on branch

Author: codedge

.gitignore

@@ -1,2 +1,3 @@
+clover.xml
 build
 vendor

.styleci.yml

@@ -2,13 +2,6 @@ preset: laravel
 
 risky: false
 
-enabled:
-  - no_useless_else
-  - phpdoc_align
-  - phpdoc_no_empty_return
-  - phpdoc_order
-  - phpdoc_separation
-
 finder:
   exclude:
     - "resources"

README.md

@@ -168,7 +168,7 @@ public function update(UpdaterManager $updater)
     // .. and shorthand for this:
     $updater->source()->update;
 
-    $updater->fetch() // Same as above...
+    $updater->fetch(); // Same as above...
 }
 ```
 
@@ -183,6 +183,28 @@ of your software.
 Just make sure you set the proper repository in your `config/self-updater.php`
 file.
 
+#### Tag-based updates
+
+This is the default. Updates will be fetched by using a tagged commit, aka release.
+
+#### Branch-based updates
+
+Select the branch that should be used via the `use_branch` setting [inside the configuration](https://github.com/codedge/laravel-selfupdater/blob/master/config/self-update.php).
+
+```php
+// ...
+'repository_types' => [
+    'github' => [
+        'type' => 'github',
+        'repository_vendor' => env('SELF_UPDATER_REPO_VENDOR', ''),
+        'repository_name' => env('SELF_UPDATER_REPO_NAME', ''),
+        // ...
+        'use_branch' => 'v2',
+   ],          
+   // ...
+];
+```
+
 ### Using Http archives
 The package comes with an _Http_ source repository type to fetch 
 releases from an HTTP directory listing containing zip archives.

composer.json

@@ -49,13 +49,18 @@
   },
   "require": {
     "php": ">=7.2",
+    "ext-json": "*",
     "ext-zip": "*",
     "laravel/framework": "^5.8|6.*",
     "guzzlehttp/guzzle": "6.*"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0",
+    "dg/bypass-finals": "^1.1",
     "mockery/mockery": "^1.0",
-    "orchestra/testbench": "^4.0"
+    "orchestra/testbench": "^4.0",
+    "phpunit/phpunit": "^8.0"
+  },
+  "scripts": {
+    "test": "./vendor/bin/phpunit"
   }
 }

composer.lock

@@ -44,6 +44,7 @@
             'repository_url' => '',
             'download_path' => env('SELF_UPDATER_DOWNLOAD_PATH', '/tmp'),
             'private_access_token' => env('SELF_UPDATER_GITHUB_PRIVATE_ACCESS_TOKEN', ''),
+            'use_branch' => env('SELF_UPDATER_USE_BRANCH', ''),
         ],
         'http' => [
             'type' => 'http',

config/self-update.php

@@ -10,6 +10,10 @@
          processIsolation="false"
          stopOnFailure="true">
 
+    <extensions>
+        <extension class="Codedge\Updater\Tests\Hooks\BypassFinalHook"/>
+    </extensions>
+
     <testsuites>
         <testsuite name="Laravel Application Self-Updater Test Suite">
             <directory>tests</directory>

phpunit.xml.dist

@@ -5,6 +5,7 @@
 namespace Codedge\Updater;
 
 use Codedge\Updater\Events\HasWrongPermissions;
+use Exception;
 use GuzzleHttp\Client;
 use Illuminate\Support\Facades\File;
 use Symfony\Component\Finder\Finder;
@@ -17,22 +18,20 @@
  */
 abstract class AbstractRepositoryType
 {
-    const ACCESS_TOKEN_PREFIX = 'Bearer ';
-
     /**
      * @var array
      */
     protected $config;
 
     /**
-     * Access token for private repository access.
+     * @var Finder|SplFileInfo[]
      */
-    private $accessToken = '';
+    protected $pathToUpdate;
 
     /**
-     * @var Finder|SplFileInfo[]
+     * @var string
      */
-    protected $pathToUpdate;
+    public $storagePath;
 
     /**
      * Unzip an archive.
@@ -41,7 +40,7 @@ abstract class AbstractRepositoryType
      * @param string $targetDir
      * @param bool   $deleteZipArchive
      *
-     * @throws \Exception
+     * @throws Exception
      *
      * @return bool
      */
@@ -55,7 +54,7 @@ protected function unzipArchive($file = '', $targetDir = '', $deleteZipArchive =
         $res = $zip->open($file);
 
         if (! $res) {
-            throw new \Exception("Cannot open zip archive [{$file}].");
+            throw new Exception("Cannot open zip archive [{$file}].");
         }
 
         if (empty($targetDir)) {
@@ -76,14 +75,14 @@ protected function unzipArchive($file = '', $targetDir = '', $deleteZipArchive =
     /**
      * Check a given directory recursively if all files are writeable.
      *
-     * @throws \Exception
+     * @throws Exception
      *
      * @return bool
      */
     protected function hasCorrectPermissionForUpdate(): bool
     {
         if (! $this->pathToUpdate) {
-            throw new \Exception('No directory set for update. Please set the update with: setPathToUpdate(path).');
+            throw new Exception('No directory set for update. Please set the update with: setPathToUpdate(path).');
         }
 
         $collection = collect($this->pathToUpdate->files())->each(function ($file) { /* @var \SplFileInfo $file */
@@ -101,12 +100,12 @@ protected function hasCorrectPermissionForUpdate(): bool
      * Download a file to a given location.
      *
      * @param Client $client
-     * @param string $source
+     * @param string $source Url for the source (.zip)
      * @param string $storagePath
      *
      * @return mixed|\Psr\Http\Message\ResponseInterface
      */
-    protected function downloadRelease(Client $client, $source, $storagePath)
+    protected function downloadRelease(Client $client, string $source, $storagePath)
     {
         $headers = [];
 
@@ -158,64 +157,24 @@ protected function setPathToUpdate(string $path, array $exclude)
     }
 
     /**
-     * Create a releas sub-folder inside the storage dir.
+     * Create a release sub-folder inside the storage dir.
      *
-     * @param string $storagePath
+     * @param string $releaseFolder
      * @param string $releaseName
      */
-    public function createReleaseFolder($storagePath, $releaseName)
+    public function createReleaseFolder(string $releaseFolder, $releaseName)
     {
-        $subDirName = File::directories($storagePath);
-        $directories = File::directories($subDirName[0]);
-
-        File::makeDirectory($storagePath.'/'.$releaseName);
-
-        foreach ($directories as $directory) { /* @var string $directory */
-            File::moveDirectory($directory, $storagePath.'/'.$releaseName.'/'.File::name($directory));
-        }
+        $folders = File::directories($releaseFolder);
 
-        $files = File::allFiles($subDirName[0], true);
-        foreach ($files as $file) { /* @var \SplFileInfo $file */
-            File::move($file->getRealPath(), $storagePath.'/'.$releaseName.'/'.$file->getFilename());
-        }
-
-        File::deleteDirectory($subDirName[0]);
-    }
-
-    /**
-     * Get the access token.
-     *
-     * @param bool $withPrefix
-     *
-     * @return string
-     */
-    public function getAccessToken($withPrefix = true): string
-    {
-        if ($withPrefix) {
-            return self::ACCESS_TOKEN_PREFIX.$this->accessToken;
+        if (count($folders) === 1) {
+            // Only one sub-folder inside extracted directory
+            File::moveDirectory($folders[0], $this->storagePath.$releaseName);
+            File::deleteDirectory($folders[0]);
+            File::deleteDirectory($releaseFolder);
+        } else {
+            // Release (with all files and folders) is already inside, so we need to only rename the folder
+            File::moveDirectory($releaseFolder, $this->storagePath.$releaseName);
         }
-
-        return $this->accessToken;
-    }
-
-    /**
-     * Set access token.
-     *
-     * @param string $token
-     */
-    public function setAccessToken(string $token): void
-    {
-        $this->accessToken = $token;
-    }
-
-    /**
-     * Check if an access token has been set.
-     *
-     * @return bool
-     */
-    public function hasAccessToken(): bool
-    {
-        return ! empty($this->accessToken);
     }
 
     /**

src/AbstractRepositoryType.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codedge\Updater\Contracts;
+
+interface GithubRepositoryTypeContract extends SourceRepositoryTypeContract
+{
+    const GITHUB_API_URL = 'https://api.github.com';
+    const GITHUB_URL = 'https://github.com';
+}

src/Contracts/GithubRepositoryTypeContract.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Codedge\Updater\Contracts;
 
 interface SourceRepositoryTypeContract
@@ -11,14 +13,16 @@ interface SourceRepositoryTypeContract
      *
      * @return mixed
      */
-    public function fetch($version = '');
+    public function fetch(string $version = '');
 
     /**
      * Perform the actual update process.
      *
+     * @param string $version
+     *
      * @return bool
      */
-    public function update(): bool;
+    public function update(string $version = ''): bool;
 
     /**
      * Check repository if a newer version than the installed one is available.
@@ -29,7 +33,7 @@ public function update(): bool;
      *
      * @return bool
      */
-    public function isNewVersionAvailable($currentVersion = ''): bool;
+    public function isNewVersionAvailable(string $currentVersion = ''): bool;
 
     /**
      * Get the version that is currenly installed.
@@ -40,7 +44,7 @@ public function isNewVersionAvailable($currentVersion = ''): bool;
      *
      * @return string
      */
-    public function getVersionInstalled($prepend = '', $append = ''): string;
+    public function getVersionInstalled(string $prepend = '', string $append = ''): string;
 
     /**
      * Get the latest version that has been published in a certain repository.
@@ -51,5 +55,5 @@ public function getVersionInstalled($prepend = '', $append = ''): string;
      *
      * @return string
      */
-    public function getVersionAvailable($prepend = '', $append = ''): string;
+    public function getVersionAvailable(string $prepend = '', string $append = ''): string;
 }