Merge pull request #42 from markwalet/current-changes-command

Current changes command

Author: markwalet

CHANGELOG.md

@@ -5,6 +5,7 @@
 ## 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.
+- Add a `changelog:current` artisan command.
 
 ## [v1.6.1 (2022-03-27)](https://github.com/markwalet/laravel-changelog/compare/v1.6.0...v1.6.1)
 

README.md

@@ -28,11 +28,12 @@ After installation, verify and change the config for your specific needs and run
 
 ## Usage
 
-The main functionality of this package consists of 5 commands:
+The main functionality of this package consists of 6 commands:
 
 - `php artisan changelog:add {--type=} {--message=}` (Add a change to the current feature entry)
 - `php artisan changelog:list` (Show a list of changes for all versions)
 - `php artisan changelog:unreleased` (Show a list of unreleased changes)
+- `php artisan changelog:current` (Show a list of unreleased changes for your current branch)
 - `php artisan changelog:release` (Move all unreleased changes to a new version)
 - `php artisan changelog:generate {--dry-run} {--path=}` (Generate a markdown file based on your changes. The path option can be empty)
 
@@ -43,4 +44,4 @@ The default configuration is defined in `changelog.php`. If you want to edit thi
 php artisan vendor:publish --provider="MarkWalet\Changelog\ChangelogServiceProvider"
 ```
 
-When you publish these vendor assets, you can also edit the default template that is used when generating the changelog. The template file can be found in `resources/views/vendor/changelog/changelog.blade.php`.
+When you publish these vendor assets, you can also edit the default template that is used when generating the changelog markdown file. The template file can be found in `resources/views/vendor/changelog/changelog.blade.php`.

src/ChangelogServiceProvider.php

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

src/Commands/ChangelogCurrentCommand.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace MarkWalet\Changelog\Commands;
+
+use Illuminate\Console\Command;
+use MarkWalet\Changelog\Adapters\FeatureAdapter;
+use MarkWalet\GitState\Drivers\GitDriver;
+
+class ChangelogCurrentCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'changelog:current';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Show a list of unreleased changes for the current branch.';
+
+    /**
+     * Execute the command.
+     *
+     * @param FeatureAdapter $adapter
+     * @param GitDriver $gitState
+     */
+    public function handle(FeatureAdapter $adapter, GitDriver $gitState)
+    {
+        $branch = $gitState->currentBranch();
+        $path = config('changelog.path').DIRECTORY_SEPARATOR.'unreleased'.DIRECTORY_SEPARATOR.$branch.'.xml';
+
+        if (! $adapter->exists($path)) {
+            $this->warn("No changes found for $branch");
+
+            return;
+        }
+        $feature = $adapter->read($path);
+        $this->line("Changes for $branch:");
+
+        foreach ($feature->changes() as $change) {
+            $type = ucfirst($change->type());
+            $this->line(" - $type: {$change->message()}");
+        }
+    }
+}

tests/Commands/ChangelogCurrentCommandTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace MarkWalet\Changelog\Tests\Commands;
+
+use MarkWalet\Changelog\Adapters\FeatureAdapter;
+use MarkWalet\Changelog\Change;
+use MarkWalet\Changelog\Feature;
+use MarkWalet\Changelog\Tests\LaravelTestCase;
+use MarkWalet\GitState\Drivers\GitDriver;
+use Mockery\MockInterface;
+
+class ChangelogCurrentCommandTest extends LaravelTestCase
+{
+    /**
+     * Setup the test environment.
+     *
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        config()->set('changelog.path', 'fake-path');
+        $this->mock(GitDriver::class, function (MockInterface $git) {
+            $git->expects('currentBranch')->once()->andReturn('test-branch');
+        });
+    }
+
+    /** @test */
+    public function it_can_list_all_changes_for_all_releases()
+    {
+        $this->mock(FeatureAdapter::class, function (MockInterface $adapter) {
+            $adapter->allows('exists')->andReturnUsing(function (string $branch) {
+                return $branch === 'fake-path/unreleased/test-branch.xml';
+            });
+
+            $adapter->allows('read')->andReturn(tap(new Feature(), function (Feature $feature) {
+                $feature->add(new Change('added', 'Added a new feature.'));
+                $feature->add(new Change('fixed', 'Fixed a bug.'));
+            }));
+        });
+
+        $this->artisan('changelog:current')
+            ->expectsOutput('Changes for test-branch:')
+            ->expectsOutput(' - Added: Added a new feature.')
+            ->expectsOutput(' - Fixed: Fixed a bug.');
+    }
+
+    /** @test */
+    public function it_shows_a_warning_when_there_are_no_unreleased_changes_found_yet(): void
+    {
+        config()->set('changelog.path', 'fake-path');
+        $this->mock(FeatureAdapter::class, function (MockInterface $adapter) {
+            $adapter->allows('exists')->andReturn(false);
+        });
+
+        $this->artisan('changelog:current')
+            ->expectsOutput('No changes found for test-branch');
+    }
+}