Merge remote-tracking branch 'origin/main'

Author: Bram Ceulemans

.gitignore

@@ -16,3 +16,6 @@ testbench.yaml
 # ide
 /.idea
 /.vscode
+
+# mac
+.DS_Store

.styleci.yml

@@ -5,7 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/BlameButton/laravel-changelog/compare/v1.0.1...main)
+## [Unreleased](https://github.com/BlameButton/laravel-changelog/compare/v1.0.4...main)
+
+## [v1.0.4](https://github.com/BlameButton/laravel-changelog/compare/v1.0.3...v1.0.4) - 2021-11-05
+
+### Fixed
+
+- Storage facade does not work outside of storage directory
+
+## [v1.0.3](https://github.com/BlameButton/laravel-changelog/compare/v1.0.2...v1.0.3) - 2021-11-05
+
+### Fixed
+
+- Filename is retrieved using the wrong key
 
 ## [v1.0.2](https://github.com/BlameButton/laravel-changelog/compare/v1.0.1...v1.0.2) - 2021-11-05
 

CHANGELOG.md

@@ -24,6 +24,11 @@ use BlameButton\Laravel\Changelog\ChangelogFacade;
  * Get the raw content of your changelog file. 
  */
 ChangelogFacade::raw();
+
+/**
+ * Get the HTML version of your changelog file.
+ */
+ChangelogFacade::html();
 ```
 
 ### Testing

README.md

@@ -3,23 +3,45 @@
 namespace BlameButton\Laravel\Changelog;
 
 use BlameButton\Laravel\Changelog\Exceptions\ChangelogNotFoundException;
-use Illuminate\Support\Facades\Storage;
+use Illuminate\Mail\Markdown;
+use Illuminate\Support\HtmlString;
 
 class Changelog
 {
-    private function getFile(): string
+    /**
+     * Get the location of the changelog file.
+     *
+     * @return string
+     */
+    public function path(): string
     {
-        return config('config.file', base_path('CHANGELOG.md'));
+        return config('changelog.file', base_path('CHANGELOG.md'));
     }
 
+    /**
+     * Get the raw content of the changelog.
+     *
+     * @return string
+     * @throws ChangelogNotFoundException when the changelog file can not be found.
+     */
     public function raw(): string
     {
-        $file = $this->getFile();
+        $file = $this->path();
 
-        if (! Storage::exists($file)) {
+        if (! file_exists($file)) {
             throw new ChangelogNotFoundException();
         }
 
-        return Storage::get($file);
+        return file_get_contents($file);
+    }
+
+    /**
+     * Generate a HTML version of your changelog.
+     *
+     * @return HtmlString
+     */
+    public function html(): HtmlString
+    {
+        return Markdown::parse($this->raw());
     }
 }

config/config.php renamed to config/changelog.php

@@ -21,7 +21,7 @@ public function boot()
 
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../config/config.php' => config_path('changelog.php'),
+                __DIR__ . '/../config/changelog.php' => config_path('changelog.php'),
             ], 'config');
 
             // Publishing the views.
@@ -50,7 +50,7 @@ public function boot()
     public function register()
     {
         // Automatically apply the package configuration
-        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'changelog');
+        $this->mergeConfigFrom(__DIR__ . '/../config/changelog.php', 'changelog');
 
         // Register the main class to use with the facade
         $this->app->singleton('changelog', function () {

src/Changelog.php

@@ -2,9 +2,10 @@
 
 namespace BlameButton\Laravel\Changelog\Tests;
 
-use BlameButton\Laravel\Changelog\ChangelogFacade;
+use BlameButton\Laravel\Changelog\Changelog;
 use BlameButton\Laravel\Changelog\ChangelogServiceProvider;
 use Illuminate\Support\Facades\Storage;
+use Mockery\MockInterface;
 use Orchestra\Testbench\TestCase;
 
 class ChangelogTest extends TestCase
@@ -29,7 +30,13 @@ public function testRaw(): void
 
         Storage::put(base_path('CHANGELOG.md'), $expected);
 
-        $content = ChangelogFacade::raw();
+        /** @var Changelog $changelog */
+        $changelog = $this->mock(Changelog::class, function (MockInterface $mock) {
+            $mock->shouldReceive('path')->andReturn(Storage::path(base_path('CHANGELOG.md')));
+            $mock->shouldReceive('raw')->passthru();
+        });
+
+        $content = $changelog->raw();
 
         self::assertNotNull($content);
         self::assertEquals($expected, $content);