Merge pull request #880 from hydephp/datacollections-package-updates

emmadesilva · web-flow · commit f04524f9e366 · 2023-01-28T10:31:53.000+01:00
Make DataCollections part of the Framework core
diff --git a/config/app.php b/config/app.php
@@ -106,6 +106,7 @@
         'MarkdownPost' => \Hyde\Pages\MarkdownPost::class,
         'DocumentationPage' => \Hyde\Pages\DocumentationPage::class,
         'Filesystem' => \Hyde\Facades\Filesystem::class,
+        'MarkdownCollection' => \Hyde\Framework\Features\DataCollections\Facades\MarkdownCollection::class,
     ],
 
 ];
diff --git a/config/hyde.php b/config/hyde.php
@@ -86,7 +86,6 @@
         Features::bladePages(),
         Features::markdownPages(),
         Features::documentationPages(),
-        // Features::dataCollections(),
 
         // Frontend Features
         Features::darkmode(),
diff --git a/docs/digging-deeper/collections.md b/docs/digging-deeper/collections.md
@@ -8,7 +8,6 @@ navigation:
 
 >info This article covers advanced usage intended for those who are writing their own Blade views, and is not required as Hyde comes pre-packaged with many templates for you to use.
 
->warning This feature was added in v0.43.0-beta.
 
 ## Introduction to Hyde Data Collections
 
@@ -18,30 +17,17 @@ You get the have access to all Laravel Collection methods so you are encouraged
 
 Currently only a Markdown collection type is added, but more types like YAML are planned.
 
-### Enabling the feature
-
-You may need to enable the module by adding the feature to your Hyde configuration file's `features` array:
-
-```php
-// filepath config/hyde.php
-
-   'features' => [
-        Features::dataCollections(),
-    ],
-
-```
-
 ### High-Level Concept Overview
 
 To make collections easy to use and understand, Hyde makes a few assumptions about the structure of your collections. Follow these conventions and creating dynamic static sites will be a breeze.
 
 1. Collections are stored in the new `resources/collections` directory.
 2. Each subdirectory in here can be a collection. 
-3. Data collections are automatically generated when you use the Facade you will learn about below.
+3. Data collections are automatically generated from the source files when you use the Facade you will learn about below.
 4. When using one of the facades, you need to specify the collection name, this name is the name of the subdirectory.
 5. Each subdirectory should probably only have the same filetype to prevent developer confusion, but this is not enforced.
 6. Unlike Markdown pages, files starting with underscores are not ignored.
-7. You can customize the base `resources/collections` directory through a service provider.
+7. You can customize the source directory for collections through a service provider.
 
 
 ### Markdown Collections - Hands on Guide
@@ -52,7 +38,7 @@ I think the best way to explain DataCollections is through examples. Let's creat
 
 We start by setting up our directory structure. We will create a `testimonials` subdirectory, which will be the collection name.
 
-In it we will place Markdown files. Each file will be a testimonial. The Markdown will be parsed into a MarkdownDocument object which parses any optional YAML front matter. 
+In it we will place Markdown files. Each file will be a testimonial. The Markdown will be parsed into a `MarkdownDocument` object which parses any optional YAML front matter. 
 
 Here is the sample Markdown we will use:
 
@@ -79,7 +65,7 @@ resources/collections
 
 #### Using the Facade to Access the Collections
 
-Now for the fun part! We will use the `MarkdownCollection` facade to access all our files into a convenient object. The class is already aliased to the facade, so you don't need to use any namespaces.
+Now for the fun part! We will use the `MarkdownCollection` facade to access all our files into a convenient object. The class is registered with an alias, so you don't need to include any namespaces when in a Blade file.
 
 The general syntax to use the facade is as follows:
 
diff --git a/packages/framework/config/hyde.php b/packages/framework/config/hyde.php
@@ -86,7 +86,6 @@
         Features::bladePages(),
         Features::markdownPages(),
         Features::documentationPages(),
-        // Features::dataCollections(),
 
         // Frontend Features
         Features::darkmode(),
diff --git a/packages/framework/src/Facades/Features.php b/packages/framework/src/Facades/Features.php
@@ -80,11 +80,6 @@ public static function hasDocumentationPages(): bool
         return static::enabled(static::documentationPages());
     }
 
-    public static function hasDataCollections(): bool
-    {
-        return static::enabled(static::dataCollections());
-    }
-
     public static function hasDocumentationSearch(): bool
     {
         return static::enabled(static::documentationSearch())
@@ -142,11 +137,6 @@ public static function documentationSearch(): string
         return 'documentation-search';
     }
 
-    public static function dataCollections(): string
-    {
-        return 'data-collections';
-    }
-
     public static function darkmode(): string
     {
         return 'darkmode';
diff --git a/packages/framework/src/Framework/Features/DataCollections/DataCollectionServiceProvider.php b/packages/framework/src/Framework/Features/DataCollections/DataCollectionServiceProvider.php
diff --git a/packages/framework/src/Framework/Features/DataCollections/Facades/MarkdownCollection.php b/packages/framework/src/Framework/Features/DataCollections/Facades/MarkdownCollection.php
@@ -8,6 +8,7 @@
 
 /**
  * @see \Hyde\Framework\Testing\Feature\DataCollectionTest
+ * @deprecated Since this class is so simple, it could easily be inlined.
  */
 class MarkdownCollection
 {
diff --git a/packages/framework/src/Framework/HydeServiceProvider.php b/packages/framework/src/Framework/HydeServiceProvider.php
@@ -8,7 +8,6 @@
 use Hyde\Facades\Features;
 use Hyde\Foundation\HydeKernel;
 use Hyde\Framework\Concerns\RegistersFileLocations;
-use Hyde\Framework\Features\DataCollections\DataCollectionServiceProvider;
 use Hyde\Framework\Services\AssetService;
 use Hyde\Framework\Services\YamlConfigurationService;
 use Hyde\Framework\Views\Components\LinkComponent;
@@ -142,6 +141,5 @@ protected function registerPageModels(): void
     protected function registerModuleServiceProviders(): void
     {
         $this->app->register(HydeConsoleServiceProvider::class);
-        $this->app->register(DataCollectionServiceProvider::class);
     }
 }
diff --git a/packages/framework/tests/Feature/ConfigurableFeaturesTest.php b/packages/framework/tests/Feature/ConfigurableFeaturesTest.php
@@ -85,7 +85,7 @@ public function test_to_array_method_contains_all_settings()
         $this->assertArrayHasKey('documentation-search', $array);
         $this->assertArrayHasKey('torchlight', $array);
 
-        $this->assertCount(9, $array);
+        $this->assertCount(8, $array);
     }
 
     public function test_features_can_be_mocked()
diff --git a/packages/framework/tests/Feature/DataCollectionTest.php b/packages/framework/tests/Feature/DataCollectionTest.php
@@ -5,9 +5,7 @@
 namespace Hyde\Framework\Testing\Feature;
 
 use ArgumentCountError;
-use Hyde\Facades\Features;
 use Hyde\Framework\Features\DataCollections\DataCollection;
-use Hyde\Framework\Features\DataCollections\DataCollectionServiceProvider;
 use Hyde\Framework\Features\DataCollections\Facades\MarkdownCollection;
 use Hyde\Hyde;
 use Hyde\Markdown\Models\MarkdownDocument;
@@ -18,7 +16,6 @@
 
 /**
  * @covers \Hyde\Framework\Features\DataCollections\DataCollection
- * @covers \Hyde\Framework\Features\DataCollections\DataCollectionServiceProvider
  * @covers \Hyde\Framework\Features\DataCollections\Facades\MarkdownCollection
  */
 class DataCollectionTest extends TestCase
@@ -27,8 +24,9 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        config(['hyde.features' => [Features::dataCollections()]]);
-        (new DataCollectionServiceProvider($this->app))->boot();
+        if (! is_dir(Hyde::path('resources/collections'))) {
+            mkdir(Hyde::path('resources/collections'));
+        }
     }
 
     public function test_constructor_creates_new_data_collection_instance()
@@ -162,30 +160,6 @@ public function test_data_collection_service_provider_registers_the_facade_as_an
         $this->assertContains(MarkdownCollection::class, AliasLoader::getInstance()->getAliases());
     }
 
-    public function test_data_collection_service_provider_creates_the__data_directory_if_it_does_not_exist_and_feature_is_enabled()
-    {
-        config(['hyde.features' => [Features::dataCollections()]]);
-
-        File::deleteDirectory(Hyde::path('resources/collections'));
-        $this->assertFileDoesNotExist(Hyde::path('resources/collections'));
-
-        (new DataCollectionServiceProvider($this->app))->boot();
-
-        $this->assertFileExists(Hyde::path('resources/collections'));
-    }
-
-    public function test_data_collection_service_provider_does_not_create_the__data_directory_feature_is_disabled()
-    {
-        File::deleteDirectory(Hyde::path('resources/collections'));
-        $this->assertFileDoesNotExist(Hyde::path('resources/collections'));
-
-        config(['hyde.features' => []]);
-        $this->app['config']->set('hyde.data_collection.enabled', false);
-        (new DataCollectionServiceProvider($this->app))->boot();
-
-        $this->assertFileDoesNotExist(Hyde::path('resources/collections'));
-    }
-
     public function test_class_has_static_source_directory_property()
     {
         $this->assertEquals('resources/collections', DataCollection::$sourceDirectory);
diff --git a/packages/framework/tests/Feature/HydeServiceProviderTest.php b/packages/framework/tests/Feature/HydeServiceProviderTest.php
@@ -13,8 +13,8 @@
 use function get_class;
 use function get_declared_classes;
 use function glob;
+use Hyde\Console\HydeConsoleServiceProvider;
 use Hyde\Facades\Site;
-use Hyde\Framework\Features\DataCollections\DataCollectionServiceProvider;
 use Hyde\Framework\HydeServiceProvider;
 use Hyde\Framework\Services\AssetService;
 use Hyde\Hyde;
@@ -207,7 +207,7 @@ public function test_provider_registers_additional_module_service_providers()
     {
         $this->provider->register();
 
-        $this->assertArrayHasKey(DataCollectionServiceProvider::class, $this->app->getLoadedProviders());
+        $this->assertArrayHasKey(HydeConsoleServiceProvider::class, $this->app->getLoadedProviders());
     }
 
     public function test_provider_registers_all_page_model_source_paths()

Original file line number	Diff line number	Diff line change
`@@ -80,11 +80,6 @@ public static function hasDocumentationPages(): bool`
`80`	`80`	`return static::enabled(static::documentationPages());`
`81`	`81`	`}`
`82`	`82`
`83`		`- public static function hasDataCollections(): bool`
`84`		`- {`
`85`		`- return static::enabled(static::dataCollections());`
`86`		`- }`
`87`		`-`
`88`	`83`	`public static function hasDocumentationSearch(): bool`
`89`	`84`	`{`
`90`	`85`	`return static::enabled(static::documentationSearch())`
`@@ -142,11 +137,6 @@ public static function documentationSearch(): string`
`142`	`137`	`return 'documentation-search';`
`143`	`138`	`}`
`144`	`139`
`145`		`- public static function dataCollections(): string`
`146`		`- {`
`147`		`- return 'data-collections';`
`148`		`- }`
`149`		`-`
`150`	`140`	`public static function darkmode(): string`
`151`	`141`	`{`
`152`	`142`	`return 'darkmode';`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* @see \Hyde\Framework\Testing\Feature\DataCollectionTest`
	`11`	`+ * @deprecated Since this class is so simple, it could easily be inlined.`
`11`	`12`	`*/`
`12`	`13`	`class MarkdownCollection`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@`
`8`	`8`	`use Hyde\Facades\Features;`
`9`	`9`	`use Hyde\Foundation\HydeKernel;`
`10`	`10`	`use Hyde\Framework\Concerns\RegistersFileLocations;`
`11`		`-use Hyde\Framework\Features\DataCollections\DataCollectionServiceProvider;`
`12`	`11`	`use Hyde\Framework\Services\AssetService;`
`13`	`12`	`use Hyde\Framework\Services\YamlConfigurationService;`
`14`	`13`	`use Hyde\Framework\Views\Components\LinkComponent;`
`@@ -142,6 +141,5 @@ protected function registerPageModels(): void`
`142`	`141`	`protected function registerModuleServiceProviders(): void`
`143`	`142`	`{`
`144`	`143`	`$this->app->register(HydeConsoleServiceProvider::class);`
`145`		`- $this->app->register(DataCollectionServiceProvider::class);`
`146`	`144`	`}`
`147`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public function test_to_array_method_contains_all_settings()`
`85`	`85`	`$this->assertArrayHasKey('documentation-search', $array);`
`86`	`86`	`$this->assertArrayHasKey('torchlight', $array);`
`87`	`87`
`88`		`- $this->assertCount(9, $array);`
	`88`	`+ $this->assertCount(8, $array);`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`public function test_features_can_be_mocked()`