Merge pull request #1287 from hydephp/remove-test-links

Remove test class references from main codebase
hydephp · Mar 14, 2023 · 5b5ae46 · 5b5ae46
2 parents 251e042 + 287f54f
commit 5b5ae46
Show file tree

Hide file tree

Showing 76 changed files with 7 additions and 154 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -19,7 +19,7 @@ This serves two purposes:
 - for soon-to-be removed features.
 
 ### Removed
-- for now removed features.
+- Removed test class references from main codebase https://github.com/hydephp/develop/pull/1287
 
 ### Fixed
 - Fixed "ReadingTime calculation should never be under one minute" [#1286](https://github.com/hydephp/develop/issues/1286) in [#1285](https://github.com/hydephp/develop/pull/1285)

diff --git a/monorepo/HydeStan/HydeStan.php b/monorepo/HydeStan/HydeStan.php
@@ -103,6 +103,12 @@ private function analyseFile(string $file, string $contents): void
                 }
                 $this->errors[] = $error;
             }
+
+            foreach (explode("\n", $contents) as $lineNumber => $line) {
+                if (str_starts_with($line, ' * @see') && str_ends_with($line, 'Test')) {
+                    $this->errors[] = sprintf('Test class %s is referenced in %s:%s', trim(substr($line, 7)), realpath(__DIR__.'/../../packages/framework/'.$file) ?: $file, $lineNumber + 1);
+                }
+            }
         }
 
         $this->scannedLines += substr_count($contents, "\n");

diff --git a/packages/framework/src/Console/Commands/BuildRssFeedCommand.php b/packages/framework/src/Console/Commands/BuildRssFeedCommand.php
@@ -9,8 +9,6 @@
 
 /**
  * Hyde command to run the build process for the RSS feed.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\BuildRssFeedCommandTest
  */
 class BuildRssFeedCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/BuildSearchCommand.php b/packages/framework/src/Console/Commands/BuildSearchCommand.php
@@ -9,8 +9,6 @@
 
 /**
  * Hyde command to run the build process for the documentation search index.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\BuildSearchCommandTest
  */
 class BuildSearchCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/BuildSiteCommand.php b/packages/framework/src/Console/Commands/BuildSiteCommand.php
@@ -21,8 +21,6 @@
 
 /**
  * Hyde Command to run the Build Process.
- *
- * @see \Hyde\Framework\Testing\Feature\StaticSiteServiceTest
  */
 class BuildSiteCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/BuildSitemapCommand.php b/packages/framework/src/Console/Commands/BuildSitemapCommand.php
@@ -9,8 +9,6 @@
 
 /**
  * Hyde command to run the build process for the sitemap.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\BuildSitemapCommandTest
  */
 class BuildSitemapCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php b/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php
@@ -20,9 +20,6 @@
 use function basename;
 use function realpath;
 
-/**
- * @see \Hyde\Framework\Testing\Feature\Commands\ChangeSourceDirectoryCommandTest
- */
 class ChangeSourceDirectoryCommand extends Command
 {
     /** @var string */

diff --git a/packages/framework/src/Console/Commands/MakePageCommand.php b/packages/framework/src/Console/Commands/MakePageCommand.php
@@ -16,8 +16,6 @@
 
 /**
  * Hyde Command to scaffold a new Markdown or Blade page file.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\MakePageCommandTest
  */
 class MakePageCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/PackageDiscoverCommand.php b/packages/framework/src/Console/Commands/PackageDiscoverCommand.php
@@ -8,9 +8,6 @@
 use Illuminate\Foundation\Console\PackageDiscoverCommand as BaseCommand;
 use Illuminate\Foundation\PackageManifest;
 
-/**
- * @see \Hyde\Framework\Testing\Feature\Commands\PackageDiscoverCommandTest
- */
 class PackageDiscoverCommand extends BaseCommand
 {
     /** @var true */

diff --git a/packages/framework/src/Console/Commands/PublishConfigsCommand.php b/packages/framework/src/Console/Commands/PublishConfigsCommand.php
@@ -13,8 +13,6 @@
 
 /**
  * Publish the Hyde Config Files.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\UpdateConfigsCommandTest
  */
 class PublishConfigsCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/PublishHomepageCommand.php b/packages/framework/src/Console/Commands/PublishHomepageCommand.php
@@ -19,8 +19,6 @@
 
 /**
  * Publish one of the default homepages.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\PublishHomepageCommandTest
  */
 class PublishHomepageCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/PublishViewsCommand.php b/packages/framework/src/Console/Commands/PublishViewsCommand.php
@@ -13,8 +13,6 @@
 
 /**
  * Publish the Hyde Blade views.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\PublishViewsCommandTest
  */
 class PublishViewsCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/RebuildPageCommand.php b/packages/framework/src/Console/Commands/RebuildPageCommand.php
@@ -25,8 +25,6 @@
 
 /**
  * Hyde Command to build a single static site file.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\RebuildPageCommandTest
  */
 class RebuildPageCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/RouteListCommand.php b/packages/framework/src/Console/Commands/RouteListCommand.php
@@ -16,8 +16,6 @@
 
 /**
  * Hyde command to display the list of site routes.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\RouteListCommandTest
  */
 class RouteListCommand extends Command
 {

diff --git a/packages/framework/src/Console/Commands/ValidateCommand.php b/packages/framework/src/Console/Commands/ValidateCommand.php
@@ -12,9 +12,6 @@
 use function microtime;
 use function sprintf;
 
-/**
- * @see \Hyde\Framework\Testing\Feature\Commands\ValidateCommandTest
- */
 class ValidateCommand extends Command
 {
     use TracksExecutionTime;

diff --git a/packages/framework/src/Console/Commands/VendorPublishCommand.php b/packages/framework/src/Console/Commands/VendorPublishCommand.php
@@ -16,8 +16,6 @@
 
 /**
  * Publish any publishable assets from vendor packages.
- *
- * @see \Hyde\Framework\Testing\Feature\Commands\VendorPublishCommandTest
  */
 class VendorPublishCommand extends BaseCommand
 {

diff --git a/packages/framework/src/Console/Concerns/Command.php b/packages/framework/src/Console/Concerns/Command.php
@@ -19,8 +19,6 @@
 /**
  * A base class for HydeCLI command that adds some extra functionality and output
  * helpers to reduce repeated code and to provide a consistent user interface.
- *
- * @see \Hyde\Framework\Testing\Feature\CommandTest
  */
 abstract class Command extends BaseCommand
 {

diff --git a/packages/framework/src/Facades/Config.php b/packages/framework/src/Facades/Config.php
@@ -12,7 +12,6 @@
  *
  * @see \Illuminate\Config\Repository
  * @see \Illuminate\Support\Facades\Config
- * @see \Hyde\Framework\Testing\Feature\TypedConfigFacadeTest
  */
 class Config extends \Illuminate\Support\Facades\Config
 {

diff --git a/packages/framework/src/Facades/Features.php b/packages/framework/src/Facades/Features.php
@@ -27,9 +27,6 @@
  * @internal Until this class is split into a service/manager class, it should not be used outside of Hyde as the API is subject to change.
  *
  * @todo Split facade logic to service/manager class. (Initial and mock data could be set with boot/set methods)
- *
- * @see \Hyde\Framework\Testing\Feature\ConfigurableFeaturesTest
- *
  * Based entirely on Laravel Jetstream (License MIT)
  * @see https://jetstream.laravel.com/
  */

diff --git a/packages/framework/src/Facades/Filesystem.php b/packages/framework/src/Facades/Filesystem.php
@@ -17,7 +17,6 @@
  *
  * @see \Hyde\Foundation\Kernel\Filesystem
  * @see \Illuminate\Filesystem\Filesystem
- * @see \Hyde\Framework\Testing\Feature\FilesystemFacadeTest
  */
 class Filesystem
 {

diff --git a/packages/framework/src/Facades/Meta.php b/packages/framework/src/Facades/Meta.php
@@ -11,8 +11,6 @@
 
 /**
  * Helpers to fluently declare HTML meta elements using their object representations.
- *
- * @see \Hyde\Framework\Testing\Feature\MetadataHelperTest
  */
 class Meta
 {

diff --git a/packages/framework/src/Facades/Site.php b/packages/framework/src/Facades/Site.php
@@ -8,8 +8,6 @@
 
 /**
  * Facade to quickly get data for the HydePHP site and its configuration.
- *
- * @see \Hyde\Framework\Testing\Feature\SiteTest
  */
 class Site
 {

diff --git a/packages/framework/src/Foundation/Concerns/HydeExtension.php b/packages/framework/src/Foundation/Concerns/HydeExtension.php
@@ -26,8 +26,6 @@
  * which you can access via the Hyde\Hyde facade, or via the service container.
  *
  * @example `$this->app->make(HydeKernel::class)->registerExtension(MyExtension::class);`
- *
- * @see \Hyde\Framework\Testing\Feature\HydeExtensionTest
  */
 abstract class HydeExtension
 {

diff --git a/packages/framework/src/Foundation/HydeCoreExtension.php b/packages/framework/src/Foundation/HydeCoreExtension.php
@@ -15,9 +15,6 @@
 use function array_filter;
 use function array_keys;
 
-/**
- * @see \Hyde\Framework\Testing\Feature\HydeCoreExtensionTest
- */
 class HydeCoreExtension extends HydeExtension
 {
     /** @return array<class-string<\Hyde\Pages\Concerns\HydePage>> */

diff --git a/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php b/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php
@@ -14,8 +14,6 @@
 
 /**
  * @internal
- *
- * @see \Hyde\Framework\Testing\Feature\YamlConfigurationServiceTest
  */
 class LoadYamlConfiguration
 {

diff --git a/packages/framework/src/Foundation/Kernel/Filesystem.php b/packages/framework/src/Foundation/Kernel/Filesystem.php
@@ -26,8 +26,6 @@
  *
  * All paths arguments are relative to the root of the application,
  * and will be automatically resolved to absolute paths.
- *
- * @see \Hyde\Framework\Testing\Feature\Foundation\FilesystemTest
  */
 class Filesystem
 {

diff --git a/packages/framework/src/Foundation/Kernel/Hyperlinks.php b/packages/framework/src/Foundation/Kernel/Hyperlinks.php
@@ -23,8 +23,6 @@
  * Contains helpers and logic for resolving web paths for compiled files.
  *
  * It's bound to the HydeKernel instance, and is an integral part of the framework.
- *
- * @see \Hyde\Framework\Testing\Feature\Foundation\HyperlinksTest
  */
 class Hyperlinks
 {

diff --git a/packages/framework/src/Foundation/PharSupport.php b/packages/framework/src/Foundation/PharSupport.php
@@ -19,8 +19,6 @@
  * @experimental
  *
  * @internal
- *
- * @see \Hyde\Framework\Testing\Feature\PharSupportTest
  */
 class PharSupport
 {

diff --git a/packages/framework/src/Framework/Actions/BladeMatterParser.php b/packages/framework/src/Framework/Actions/BladeMatterParser.php
@@ -21,8 +21,6 @@
  *
  * Accepts a string to make it easier to mock when testing.
  *
- * @see \Hyde\Framework\Testing\Feature\BladeMatterParserTest
- *
  * @phpstan-consistent-constructor
  *
  * === DOCUMENTATION (draft) ===

diff --git a/packages/framework/src/Framework/Actions/ConvertsArrayToFrontMatter.php b/packages/framework/src/Framework/Actions/ConvertsArrayToFrontMatter.php
@@ -8,8 +8,6 @@
 
 /**
  * Convert an array into YAML Front Matter.
- *
- * @see \Hyde\Framework\Testing\Feature\ConvertsArrayToFrontMatterTest
  */
 class ConvertsArrayToFrontMatter
 {

diff --git a/packages/framework/src/Framework/Actions/ConvertsMarkdownToPlainText.php b/packages/framework/src/Framework/Actions/ConvertsMarkdownToPlainText.php
@@ -15,8 +15,6 @@
 
 /**
  * Converts Markdown to plain text.
- *
- * @see \Hyde\Framework\Testing\Feature\Actions\ConvertsMarkdownToPlainTextTest
  */
 class ConvertsMarkdownToPlainText
 {

diff --git a/packages/framework/src/Framework/Actions/CreatesNewPageSourceFile.php b/packages/framework/src/Framework/Actions/CreatesNewPageSourceFile.php
@@ -22,8 +22,6 @@
 
 /**
  * Scaffold a new Markdown, Blade, or documentation page.
- *
- * @see \Hyde\Framework\Testing\Feature\Actions\CreatesNewPageSourceFileTest
  */
 class CreatesNewPageSourceFile
 {

diff --git a/packages/framework/src/Framework/Actions/GeneratesDocumentationSearchIndex.php b/packages/framework/src/Framework/Actions/GeneratesDocumentationSearchIndex.php
@@ -17,8 +17,6 @@
 
 /**
  * @internal Generate a JSON file that can be used as a search index for documentation pages.
- *
- * @see \Hyde\Framework\Testing\Feature\Services\DocumentationSearchServiceTest
  */
 class GeneratesDocumentationSearchIndex
 {

diff --git a/packages/framework/src/Framework/Actions/GeneratesTableOfContents.php b/packages/framework/src/Framework/Actions/GeneratesTableOfContents.php
@@ -17,8 +17,6 @@
 
 /**
  * Generates a table of contents for the Markdown document, most commonly used for the sidebar.
- *
- * @see \Hyde\Framework\Testing\Feature\Actions\GeneratesSidebarTableOfContentsTest
  */
 class GeneratesTableOfContents
 {

diff --git a/packages/framework/src/Framework/Actions/MarkdownFileParser.php b/packages/framework/src/Framework/Actions/MarkdownFileParser.php
@@ -11,8 +11,6 @@
 /**
  * Prepares a Markdown file for further usage by extracting the Front Matter
  * and Markdown body, and creating MarkdownDocument object from them.
- *
- * @see \Hyde\Framework\Testing\Feature\MarkdownFileParserTest
  */
 class MarkdownFileParser
 {

diff --git a/packages/framework/src/Framework/Actions/PostBuildTasks/GenerateBuildManifest.php b/packages/framework/src/Framework/Actions/PostBuildTasks/GenerateBuildManifest.php
@@ -27,8 +27,6 @@
  * may not want to commit the manifest file to their repository or their deployed site.
  * However, a great alternate location is in `_site/build-manifest.json`,
  * if you don't mind it the file being publicly accessible.
- *
- * @see \Hyde\Framework\Testing\Unit\GenerateBuildManifestTest
  */
 class GenerateBuildManifest extends PostBuildTask
 {

diff --git a/packages/framework/src/Framework/Actions/SourceFileParser.php b/packages/framework/src/Framework/Actions/SourceFileParser.php
@@ -18,8 +18,6 @@
  * and may also conduct pre-processing and/or data validation/assembly.
  *
  * Note that the Page Parsers do not compile any HTML or Markdown.
- *
- * @see \Hyde\Framework\Testing\Feature\SourceFileParserTest
  */
 class SourceFileParser
 {

diff --git a/packages/framework/src/Framework/Actions/StaticPageBuilder.php b/packages/framework/src/Framework/Actions/StaticPageBuilder.php
@@ -11,8 +11,6 @@
 
 /**
  * Converts a Page Model into a static HTML page.
- *
- * @see \Hyde\Framework\Testing\Feature\StaticPageBuilderTest
  */
 class StaticPageBuilder
 {

diff --git a/packages/framework/src/Framework/Concerns/InteractsWithDirectories.php b/packages/framework/src/Framework/Concerns/InteractsWithDirectories.php
@@ -8,9 +8,6 @@
 
 use function dirname;
 
-/**
- * @see \Hyde\Framework\Testing\Unit\InteractsWithDirectoriesConcernTest
- */
 trait InteractsWithDirectories
 {
     /**

diff --git a/packages/framework/src/Framework/Concerns/ValidatesExistence.php b/packages/framework/src/Framework/Concerns/ValidatesExistence.php
@@ -9,8 +9,6 @@
 
 /**
  * Validate the existence of a Page class's source file.
- *
- * @see \Hyde\Framework\Testing\Unit\ValidatesExistenceTest
  */
 trait ValidatesExistence
 {

diff --git a/packages/framework/src/Framework/Features/Blogging/Models/PostAuthor.php b/packages/framework/src/Framework/Features/Blogging/Models/PostAuthor.php
@@ -14,8 +14,6 @@
 
 /**
  * The Post Author model object.
- *
- * @see \Hyde\Framework\Testing\Unit\PostAuthorTest
  */
 class PostAuthor implements Stringable
 {

diff --git a/packages/framework/src/Framework/Features/BuildTasks/BuildTask.php b/packages/framework/src/Framework/Features/BuildTasks/BuildTask.php
@@ -14,9 +14,6 @@
 use function str_replace;
 use function sprintf;
 
-/**
- * @see \Hyde\Framework\Testing\Feature\Services\BuildTaskServiceTest
- */
 abstract class BuildTask
 {
     use InteractsWithIO;

diff --git a/packages/framework/src/Framework/Features/Documentation/DocumentationSearchPage.php b/packages/framework/src/Framework/Features/Documentation/DocumentationSearchPage.php
@@ -17,8 +17,6 @@
  * It is not based on a source file, but is dynamically generated when the Search feature is enabled.
  * If you want to override this page, you can create a page with the route key "docs/search",
  * then this class will not be applied. For example, `_pages/docs/search.blade.php`.
- *
- * @see \Hyde\Framework\Testing\Feature\DocumentationSearchPageTest
  */
 class DocumentationSearchPage extends DocumentationPage
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,8 +9,6 @@ @@
     /**
      * Hyde command to run the build process for the RSS feed.
-     *
-     * @see \Hyde\Framework\Testing\Feature\Commands\BuildRssFeedCommandTest
      */
     class BuildRssFeedCommand extends Command
     {
@@ Expand Down @@