Merge pull request #6 from jonassiewertsen/add_documentation

Clean up and bug fixes

Author: jonassiewertsen

src/Commands/Setup.php

@@ -3,8 +3,11 @@
 namespace Jonassiewertsen\Statamic\HowTo\Commands;
 
 use Illuminate\Console\Command;
+use Jonassiewertsen\Statamic\HowTo\Helper\Documentation;
+use Jonassiewertsen\Statamic\HowTo\Helper\Video;
 use Statamic\Facades\Collection;
 use Statamic\Fields\Blueprint;
+use Statamic\Structures\CollectionStructure;
 
 class Setup extends Command
 {
@@ -46,21 +49,22 @@ public function handle()
     }
 
     private function createCollections() {
-        Collection::make(config('howToAddon.collection.videos', 'how_to_addon_videos'))
-            ->entryBlueprints(config('howToAddon.blueprint.videos', 'how_to_addon_videos'))
+        Collection::make(Video::collectionName())
+            ->entryBlueprints(Video::collectionName())
             ->title('How to videos')
             ->save();
 
-        Collection::make(config('howToAddon.collection.documentation', 'how_to_addon_documentation'))
-            ->entryBlueprints(config('howToAddon.blueprint.documentation', 'how_to_addon_documentation'))
+        Collection::make(Documentation::collectionName())
+            ->entryBlueprints(Documentation::collectionName())
             ->title('How to documentation')
+            ->structure((new CollectionStructure)->maxDepth(2))
             ->save();
     }
 
     protected function createBlueprints()
     {
         (new Blueprint)
-            ->setHandle(config('howToAddon.blueprint.videos', 'how_to_addon_videos'))
+            ->setHandle(Video::collectionName())
             ->setContents([
                 'title' => 'How to Video',
                 'sections' => [
@@ -94,7 +98,7 @@ protected function createBlueprints()
             ])->save();
 
         (new Blueprint)
-            ->setHandle(config('howToAddon.blueprint.documentation', 'how_to_addon_documentation'))
+            ->setHandle(Documentation::collectionName())
             ->setContents([
                 'title' => 'How to documentation',
                 'sections' => [
@@ -110,6 +114,7 @@ protected function createBlueprints()
                                 'localizable'           => false,
                                 'listable'              => 'hidden',
                                 'display'               => 'Content',
+                                'validate'              => 'required',
                             ]]
                         ]
                     ],
@@ -128,4 +133,4 @@ protected function createBlueprints()
             ])->save();
 
     }
-}
+}

src/Helper/Documentation.php

@@ -38,6 +38,14 @@ public static function entryChildren($tree, $nav): LaravelCollection
         });
     }
 
+    /**
+     * Fetch the belonging children for the navigation
+     */
+    public static function exists(): bool
+    {
+        return Collection::handleExists(self::collectionName());
+    }
+
     /**
      * Return the entry title
      */

src/Http/Controllers/VideosController.php

@@ -2,19 +2,20 @@
 
 namespace Jonassiewertsen\Statamic\HowTo\Http\Controllers;
 
-use Statamic\Facades\Asset;
 use Statamic\Facades\Entry;
 
 class VideosController {
-    public function index() {
+    public function index()
+    {
         $videos = Entry::whereCollection('how_to_addon_videos');
 
         $videos = $this->sortByTitle($videos);
 
         return view('howToAddon::videos.index', compact('videos'));
     }
 
-    public function show($slug) {
+    public function show($slug)
+    {
         $video = Entry::findBySlug($slug, config('howToAddon.blueprint.videos', 'how_to_addon_videos'));
 
         // TODO: Should be replaced by Asset::findByPath later.
@@ -24,7 +25,8 @@ public function show($slug) {
         return view('howToAddon::videos.show', compact('video', 'url'));
     }
 
-    private function sortByTitle($videos) {
+    private function sortByTitle($videos)
+    {
         return collect($videos)->sortBy('title');
     }
-}
+}

src/ServiceProvider.php

@@ -66,13 +66,15 @@ private function createNavigation(): void
 
         Nav::extend(function ($nav) {
 
-            Documentation::tree()->map(function ($tree) use ($nav) {
-                return $nav->create(Documentation::entryTitle($tree['entry']))
-                           ->route('howToAddon.documentation.show', Documentation::entrySlug($tree['entry']))
-                           ->icon('drawer-file')
-                           ->section('Documentation')
-                           ->children(Documentation::entryChildren($tree, $nav));
-            });
+            if (Documentation::exists()) {
+                Documentation::tree()->map(function ($tree) use ($nav) {
+                    return $nav->create(Documentation::entryTitle($tree['entry']))
+                               ->route('howToAddon.documentation.show', Documentation::entrySlug($tree['entry']))
+                               ->icon('drawer-file')
+                               ->section('Documentation')
+                               ->children(Documentation::entryChildren($tree, $nav));
+                });
+            }
 
             // Only show the Manage button, if the permissions have been set
             if (Gate::allows('edit', Collection::findByHandle(Documentation::collectionName()))) {