Keep unreleased folder (#38)

* Add a gitkeep file to the test data folder
* Keep the .gitkeep file when releasing a new version
* Add a changelog:install command
* Update changelog and documentation

Author: markwalet

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased](https://github.com/markwalet/laravel-changelog/compare/v1.6.1...master)
 
+## Added
+- Make sure the unreleased folder stays in the filesystem for better diff comparisons ([#4](https://github.com/markwalet/laravel-changelog/issues/4))
+- Add a `changelog:install` artisan command.
+
 ## [v1.6.1 (2022-03-27)](https://github.com/markwalet/laravel-changelog/compare/v1.6.0...v1.6.1)
 
 ### Fixed
@@ -10,7 +14,7 @@
 ## [v1.6.0 (2021-12-30)](https://github.com/markwalet/laravel-changelog/compare/v1.5.0...v1.6.0)
 
 ### Added
-- Added Laravel 9 support.
+- Added Laravel 9 support
 
 ## [v1.5.0 (2021-12-30)](https://github.com/markwalet/laravel-changelog/compare/v1.4.1...v1.5.0)
 

README.md

@@ -24,7 +24,7 @@ Laravel >=5.5 uses Package auto-discovery, so you don't have to register the ser
 MarkWalet\Changelog\ChangelogServiceProvider::class
 ```
 
-After installation, you should create a folder where all the changes will be stored in. This defaults to `base_path('.changes')`.
+After installation, verify and change the config for your specific needs and run `php artisan changelog:install`. This creates a folder where all the changes will be stored in. This defaults to `base_path('.changes')`.
 
 ## Usage
 

src/Adapters/XmlReleaseAdapter.php

@@ -2,6 +2,7 @@
 
 namespace MarkWalet\Changelog\Adapters;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\File;
 use MarkWalet\Changelog\Concerns\CanSortReleases;
 use MarkWalet\Changelog\Exceptions\DirectoryNotFoundException;
@@ -24,7 +25,7 @@ class XmlReleaseAdapter implements ReleaseAdapter
      */
     public function __construct()
     {
-        $this->featureAdapter = new XmlFeatureAdapter;
+        $this->featureAdapter = new XmlFeatureAdapter();
     }
 
     /**
@@ -36,14 +37,11 @@ public function __construct()
      */
     public function read(string $path, string $version): Release
     {
-        $fullPath = realpath($path.DIRECTORY_SEPARATOR.$version);
-
         if ($this->exists($path, $version) === false) {
-            throw new FileNotFoundException($fullPath);
+            throw new FileNotFoundException(realpath($path.DIRECTORY_SEPARATOR.$version));
         }
 
-        $files = collect(File::allFiles($fullPath))
-            ->filter(fn (SplFileInfo $file) => $file->getExtension() === 'xml')
+        $files = $this->filesForRelease($path, $version)
             ->map(fn (SplFileInfo $file) => $file->getPathname());
 
         $release = new Release($version);
@@ -63,15 +61,23 @@ public function read(string $path, string $version): Release
      */
     public function release(string $path, string $version): void
     {
-        $old = $path.DIRECTORY_SEPARATOR.'unreleased';
-        $new = $path.DIRECTORY_SEPARATOR.$version;
-
         // Prevent release if the given version already exists.
         if ($this->exists($path, $version)) {
             throw new VersionAlreadyExistsException($version);
         }
 
-        rename($old, $new);
+        $old = $path.DIRECTORY_SEPARATOR.'unreleased';
+        $new = $path.DIRECTORY_SEPARATOR.$version;
+
+        File::makeDirectory($new);
+        collect(File::glob($old.DIRECTORY_SEPARATOR.'**'))
+            ->map(fn (string $path) => substr($path, strlen($old)))
+            ->each(function (string $file) use ($old, $new) {
+                $source = $old.$file;
+                $target = $new.$file;
+
+                File::move($source, $target);
+            });
     }
 
     /**
@@ -113,4 +119,17 @@ public function exists(string $path, string $version): bool
 
         return file_exists($fullPath) && is_dir($fullPath);
     }
+
+    /**
+     * Get all xml files for a given release.
+     *
+     * @param string $path
+     * @param string $version
+     * @return Collection<SplFileInfo>
+     */
+    private function filesForRelease(string $path, string $version): Collection
+    {
+        return collect(File::allFiles($path.DIRECTORY_SEPARATOR.$version))
+            ->filter(fn (SplFileInfo $file) => $file->getExtension() === 'xml');
+    }
 }

src/ChangelogServiceProvider.php

@@ -10,6 +10,7 @@
 use MarkWalet\Changelog\Adapters\XmlReleaseAdapter;
 use MarkWalet\Changelog\Commands\ChangelogAddCommand;
 use MarkWalet\Changelog\Commands\ChangelogGenerateCommand;
+use MarkWalet\Changelog\Commands\ChangelogInstallCommand;
 use MarkWalet\Changelog\Commands\ChangelogListCommand;
 use MarkWalet\Changelog\Commands\ChangelogReleaseCommand;
 use MarkWalet\Changelog\Commands\ChangelogUnreleasedCommand;
@@ -69,6 +70,7 @@ private function bootCommands(): void
     {
         if ($this->app->runningInConsole()) {
             $this->commands([
+                ChangelogInstallCommand::class,
                 ChangelogAddCommand::class,
                 ChangelogListCommand::class,
                 ChangelogUnreleasedCommand::class,

src/Commands/ChangelogInstallCommand.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace MarkWalet\Changelog\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class ChangelogInstallCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'changelog:install';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a folder for the changelog files';
+
+    /**
+     * Execute the command.
+     */
+    public function handle()
+    {
+        $path = $this->folder().DIRECTORY_SEPARATOR.'.gitkeep';
+
+        if (File::exists($path)) {
+            $this->warn('.gitkeep file already exists.');
+
+            return;
+        }
+
+        File::makeDirectory($this->folder(), 0755, true);
+        File::put($this->folder().DIRECTORY_SEPARATOR.'.gitkeep', '');
+
+        $this->info("Created $path");
+    }
+
+    /**
+     * Get the folder where the gitkeep file should be written to.
+     *
+     * @return string
+     */
+    public function folder(): string
+    {
+        return config('changelog.path').DIRECTORY_SEPARATOR.'unreleased';
+    }
+}

tests/Adapters/XmlReleaseAdapterTest.php

@@ -16,7 +16,7 @@ class XmlReleaseAdapterTest extends LaravelTestCase
      */
     public function adapter(): XmlReleaseAdapter
     {
-        return new XmlReleaseAdapter;
+        return new XmlReleaseAdapter();
     }
 
     /** @test */
@@ -25,17 +25,20 @@ public function it_can_execute_a_release()
         $adapter = $this->adapter();
         $path = __DIR__.'/../test-data/release-write-test';
 
-        $unreleasedBefore = $adapter->exists($path, 'unreleased');
-        $versionBefore = $adapter->exists($path, 'v1.0.2');
+        $this->assertFileExists($path.'/unreleased/.gitkeep');
+        $this->assertFileExists($path.'/unreleased/nested/feature-1.xml');
+        $this->assertFileExists($path.'/unreleased/feature-2.xml');
+        $this->assertFileDoesNotExist($path.'/v1.0.2');
+
         $adapter->release($path, 'v1.0.2');
-        $unreleasedAfter = $adapter->exists($path, 'unreleased');
-        $versionAfter = $adapter->exists($path, 'v1.0.2');
 
-        $this->assertTrue($unreleasedBefore);
-        $this->assertFalse($versionBefore);
-        $this->assertFalse($unreleasedAfter);
-        $this->assertTrue($versionAfter);
+        $this->assertFileExists($path.'/unreleased/.gitkeep');
+        $this->assertFileExists($path.'/v1.0.2/nested/feature-1.xml');
+        $this->assertFileExists($path.'/v1.0.2/feature-2.xml');
+        $this->assertFileDoesNotExist($path.'/unreleased/nested');
 
-        rename(__DIR__.'/../test-data/release-write-test/v1.0.2', __DIR__.'/../test-data/release-write-test/unreleased');
+        rename(__DIR__.'/../test-data/release-write-test/v1.0.2/nested', __DIR__.'/../test-data/release-write-test/unreleased/nested');
+        rename(__DIR__.'/../test-data/release-write-test/v1.0.2/feature-2.xml', __DIR__.'/../test-data/release-write-test/unreleased/feature-2.xml');
+        rmdir(__DIR__.'/../test-data/release-write-test/v1.0.2');
     }
 }

tests/Commands/ChangelogInstallCommandTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace MarkWalet\Changelog\Tests\Commands;
+
+use Illuminate\Support\Facades\File;
+use MarkWalet\Changelog\Tests\LaravelTestCase;
+
+class ChangelogInstallCommandTest extends LaravelTestCase
+{
+    /** @test */
+    public function it_creates_a_gitkeep_file_in_the_configured_folder_once()
+    {
+        $this->app['config']['changelog.path'] = __DIR__.'/.changes';
+
+        $this->artisan('changelog:install');
+
+        $this->assertFileExists(__DIR__.'/.changes/unreleased/.gitkeep');
+
+        $this->artisan('changelog:install');
+
+        $this->assertFileExists(__DIR__.'/.changes/unreleased/.gitkeep');
+
+        File::deleteDirectory(__DIR__.'/.changes');
+    }
+}

tests/test-data/release-write-test/unreleased/.gitkeep

@@ -0,0 +1,3 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feature>
+</feature>