diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index db63d350..5b24a1c7 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -17,7 +17,7 @@ jobs: steps: - uses: actions/checkout@v2 - - uses: shivammathur/setup-php@a36e1e52ff4a1c9e9c9be31551ee4712a6cb6bd0 + - uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} extensions: fileinfo, zip diff --git a/config/docs.php b/config/docs.php index c26d702e..fab400e9 100644 --- a/config/docs.php +++ b/config/docs.php @@ -30,7 +30,8 @@ // When using a grouped sidebar, should the groups be collapsible? 'collapsible' => true, - // Should the sidebar footer be shown? + // Should the sidebar footer be shown? You can also set this to a string + // of Markdown to show in the footer. Set to `false` to disable. 'footer' => true, ], @@ -43,10 +44,11 @@ | default to sort alphabetically. You can reorder the page identifiers | in the list below, and the links will get sorted in that order. | - | Internally, the items listed will get a position priority of 500 + the order its found in the list. - | Link items without an entry here will have fall back to the default priority of 999, putting them last. + | The items will get a priority of 500 plus the order its found in the list. + | Pages without a priority will fall back to the default priority of 999. | - | You can also set explicit priorities in front matter. + | You can also set explicit priorities in front matter or by specifying + | a value to the array key in the list to override the inferred value. | */ diff --git a/config/hyde.php b/config/hyde.php index f9126cb3..b05f8683 100644 --- a/config/hyde.php +++ b/config/hyde.php @@ -300,13 +300,17 @@ | | If you are looking to customize the main navigation menu, this is the place! | + | All these settings uses Route Keys to identify the page you want to configure. + | A route key is simply the URL path to the page, without the file extension. + | So `_site/posts/hello-world.html` has the route key 'posts/hello-world'. + | */ 'navigation' => [ // This configuration sets the priorities used to determine the order of the menu. // The default values have been added below for reference and easy editing. - // The array key should match the page's route key (slug). - // Lower values show up first in the menu. + // The array key is the page's route key, the value is the priority. + // Lower values show up first in the menu. The default is 999. 'order' => [ 'index' => 0, 'posts' => 10, @@ -314,13 +318,13 @@ ], // In case you want to customize the labels for the menu items, you can do so here. - // Simply add the route key (slug) as the key, and the label as the value. + // Simply add the route key as the array key, and the label as the value. 'labels' => [ 'index' => 'Home', 'docs/index' => 'Docs', ], - // These are the pages that should not show up in the navigation menu. + // These are the route keys of pages that should not show up in the navigation menu. 'exclude' => [ '404', ], @@ -414,6 +418,9 @@ // Should preview pages be saved to the output directory? 'save_preview' => true, + // Should the live edit feature be enabled? + 'live_edit' => env('SERVER_LIVE_EDIT', true), + // Configure the realtime compiler dashboard 'dashboard' => [ // Should the realtime compiler dashboard be enabled? diff --git a/resources/views/components/docs/sidebar-footer-text.blade.php b/resources/views/components/docs/sidebar-footer-text.blade.php index 4bafb848..6b49ca39 100644 --- a/resources/views/components/docs/sidebar-footer-text.blade.php +++ b/resources/views/components/docs/sidebar-footer-text.blade.php @@ -1,3 +1,7 @@

- Back to home page + @if(is_bool(config('docs.sidebar.footer', true))) + Back to home page + @else + {{ Hyde::markdown(config('docs.sidebar.footer')) }} + @endif

\ No newline at end of file diff --git a/resources/views/components/docs/sidebar-items.blade.php b/resources/views/components/docs/sidebar-items.blade.php index cb9669c9..4c26062c 100644 --- a/resources/views/components/docs/sidebar-items.blade.php +++ b/resources/views/components/docs/sidebar-items.blade.php @@ -11,7 +11,7 @@ @foreach ($sidebar->getGroups() as $group)
  • -

    {{ Hyde::makeTitle($group) }}

    +

    {{ $sidebar->makeGroupTitle($group) }}

    @if($collapsible) @include('hyde::components.docs.sidebar-group-toggle-button') @endif diff --git a/resources/views/components/docs/sidebar.blade.php b/resources/views/components/docs/sidebar.blade.php index 9d8872bc..04b9857a 100644 --- a/resources/views/components/docs/sidebar.blade.php +++ b/resources/views/components/docs/sidebar.blade.php @@ -7,7 +7,7 @@ 'sidebar' => \Hyde\Framework\Features\Navigation\DocumentationSidebar::create(), ]) - @if(config('docs.sidebar.footer', true)) + @if(config('docs.sidebar.footer', true) !== false)
    @include('hyde::components.docs.sidebar-footer-text')
    diff --git a/src/Console/Commands/ServeCommand.php b/src/Console/Commands/ServeCommand.php index fe5ce803..9558fa4f 100644 --- a/src/Console/Commands/ServeCommand.php +++ b/src/Console/Commands/ServeCommand.php @@ -4,12 +4,18 @@ namespace Hyde\Console\Commands; +use Closure; use Hyde\Hyde; use Hyde\Facades\Config; +use Illuminate\Support\Arr; +use InvalidArgumentException; +use Hyde\Console\Concerns\Command; +use Hyde\RealtimeCompiler\ConsoleOutput; use Illuminate\Support\Facades\Process; -use LaravelZero\Framework\Commands\Command; use function sprintf; +use function str_replace; +use function class_exists; /** * Start the realtime compiler server. @@ -19,14 +25,29 @@ class ServeCommand extends Command { /** @var string */ - protected $signature = 'serve {--host= : [default: "localhost"]}} {--port= : [default: 8080]}'; + protected $signature = 'serve + {--host= : [default: "localhost"]}} + {--port= : [default: 8080]} + {--save-preview= : Should the served page be saved to disk? (Overrides config setting)} + {--dashboard= : Enable the realtime compiler dashboard. (Overrides config setting)} + {--pretty-urls= : Enable pretty URLs. (Overrides config setting)} + {--play-cdn= : Enable the Tailwind Play CDN. (Overrides config setting)} + {--open : Open the site preview in the browser.} + '; /** @var string */ protected $description = 'Start the realtime compiler server.'; - public function handle(): int + protected ConsoleOutput $console; + + public function safeHandle(): int { - $this->line('Starting the HydeRC server... Press Ctrl+C to stop'); + $this->configureOutput(); + $this->printStartMessage(); + + if ($this->option('open')) { + $this->openInBrowser(); + } $this->runServerProcess(sprintf('php -S %s:%d %s', $this->getHostSelection(), @@ -37,14 +58,14 @@ public function handle(): int return Command::SUCCESS; } - protected function getPortSelection(): int + protected function getHostSelection(): string { - return (int) ($this->option('port') ?: Config::getInt('hyde.server.port', 8080)); + return (string) $this->option('host') ?: Config::getString('hyde.server.host', 'localhost'); } - protected function getHostSelection(): string + protected function getPortSelection(): int { - return (string) $this->option('host') ?: Config::getString('hyde.server.host', 'localhost'); + return (int) ($this->option('port') ?: Config::getInt('hyde.server.port', 8080)); } protected function getExecutablePath(): string @@ -52,11 +73,90 @@ protected function getExecutablePath(): string return Hyde::path('vendor/hyde/realtime-compiler/bin/server.php'); } - /** @codeCoverageIgnore Until output is testable */ protected function runServerProcess(string $command): void { - Process::forever()->run($command, function (string $type, string $line): void { + Process::forever()->env($this->getEnvironmentVariables())->run($command, $this->getOutputHandler()); + } + + protected function getEnvironmentVariables(): array + { + return Arr::whereNotNull([ + 'HYDE_SERVER_REQUEST_OUTPUT' => ! $this->option('no-ansi'), + 'HYDE_SERVER_SAVE_PREVIEW' => $this->parseEnvironmentOption('save-preview'), + 'HYDE_SERVER_DASHBOARD' => $this->parseEnvironmentOption('dashboard'), + 'HYDE_PRETTY_URLS' => $this->parseEnvironmentOption('pretty-urls'), + 'HYDE_PLAY_CDN' => $this->parseEnvironmentOption('play-cdn'), + ]); + } + + protected function configureOutput(): void + { + if (! $this->useBasicOutput()) { + $this->console = new ConsoleOutput($this->output->isVerbose()); + } + } + + protected function printStartMessage(): void + { + $this->useBasicOutput() + ? $this->output->writeln('Starting the HydeRC server... Press Ctrl+C to stop') + : $this->console->printStartMessage($this->getHostSelection(), $this->getPortSelection(), $this->getEnvironmentVariables()); + } + + protected function getOutputHandler(): Closure + { + return $this->useBasicOutput() ? function (string $type, string $line): void { $this->output->write($line); - }); + } : $this->console->getFormatter(); + } + + protected function useBasicOutput(): bool + { + return $this->option('no-ansi') || ! class_exists(ConsoleOutput::class); + } + + protected function parseEnvironmentOption(string $name): ?string + { + $value = $this->option($name) ?? $this->checkArgvForOption($name); + + if ($value !== null) { + return match ($value) { + 'true', '' => 'enabled', + 'false' => 'disabled', + default => throw new InvalidArgumentException(sprintf('Invalid boolean value for --%s option.', $name)) + }; + } + + return null; + } + + /** Fallback check so that an environment option without a value is acknowledged as true. */ + protected function checkArgvForOption(string $name): ?string + { + if (isset($_SERVER['argv'])) { + if (in_array("--$name", $_SERVER['argv'], true)) { + return 'true'; + } + } + + return null; + } + + protected function openInBrowser(): void + { + $command = match (PHP_OS_FAMILY) { + 'Windows' => 'start', + 'Darwin' => 'open', + 'Linux' => 'xdg-open', + default => null + }; + + $process = $command ? Process::command(sprintf('%s http://%s:%d', $command, $this->getHostSelection(), $this->getPortSelection()))->run() : null; + + if (! $process || $process->failed()) { + $this->warn('Unable to open the site preview in the browser on your system:'); + $this->line(sprintf(' %s', str_replace("\n", "\n ", $process ? $process->errorOutput() : "Missing suitable 'open' binary."))); + $this->newLine(); + } } } diff --git a/src/Foundation/HydeKernel.php b/src/Foundation/HydeKernel.php index 8a9df59f..3b65f666 100644 --- a/src/Foundation/HydeKernel.php +++ b/src/Foundation/HydeKernel.php @@ -49,7 +49,7 @@ class HydeKernel implements SerializableContract use Serializable; use Macroable; - final public const VERSION = '1.3.4'; + final public const VERSION = '1.4.0'; protected static self $instance; diff --git a/src/Foundation/Internal/LoadConfiguration.php b/src/Foundation/Internal/LoadConfiguration.php index b4b51bf4..db1b31e4 100644 --- a/src/Foundation/Internal/LoadConfiguration.php +++ b/src/Foundation/Internal/LoadConfiguration.php @@ -4,15 +4,13 @@ namespace Hyde\Foundation\Internal; -use Phar; use Illuminate\Contracts\Foundation\Application; -use Illuminate\Contracts\Config\Repository as RepositoryContract; +use Illuminate\Contracts\Config\Repository; use Illuminate\Foundation\Bootstrap\LoadConfiguration as BaseLoadConfiguration; +use function getenv; use function array_merge; -use function dirname; use function in_array; -use function is_dir; use function tap; /** @internal */ @@ -23,14 +21,12 @@ protected function getConfigurationFiles(Application $app): array { return (array) tap(parent::getConfigurationFiles($app), function (array &$files) use ($app): void { // Inject our custom config file which is stored in `app/config.php`. - $files['app'] = $app->basePath().DIRECTORY_SEPARATOR.'app'.DIRECTORY_SEPARATOR.'config.php'; - - $this->providePharSupportIfNeeded($files); + $files['app'] ??= $app->basePath().DIRECTORY_SEPARATOR.'app'.DIRECTORY_SEPARATOR.'config.php'; }); } /** Load the configuration items from all the files. */ - protected function loadConfigurationFiles(Application $app, RepositoryContract $repository): void + protected function loadConfigurationFiles(Application $app, Repository $repository): void { parent::loadConfigurationFiles($app, $repository); @@ -39,7 +35,7 @@ protected function loadConfigurationFiles(Application $app, RepositoryContract $ $this->loadRuntimeConfiguration($app, $repository); } - private function mergeConfigurationFiles(RepositoryContract $repository): void + private function mergeConfigurationFiles(Repository $repository): void { // These files do commonly not need to be customized by the user, so to get them out of the way, // we don't include them in the default project install. @@ -49,7 +45,7 @@ private function mergeConfigurationFiles(RepositoryContract $repository): void } } - private function mergeConfigurationFile(RepositoryContract $repository, string $file): void + private function mergeConfigurationFile(Repository $repository, string $file): void { // We of course want the user to be able to customize the config files, // if they're present, so we'll merge their changes here. @@ -60,36 +56,42 @@ private function mergeConfigurationFile(RepositoryContract $repository, string $ )); } - /** - * Provide support for running Hyde in a Phar archive. - * - * @experimental - * - * @codeCoverageIgnore - */ - private static function providePharSupportIfNeeded(array &$files): void + private function loadRuntimeConfiguration(Application $app, Repository $repository): void { - // If we're running in a Phar and no project config directory exists, - // we need to adjust the path to use the bundled static Phar config file. + if ($app->runningInConsole()) { + if ($this->getArgv() !== null) { + $this->mergeCommandLineArguments($repository, '--pretty-urls', 'hyde.pretty_urls', true); + $this->mergeCommandLineArguments($repository, '--no-api', 'hyde.api_calls', false); + } - /** @var array{app: string} $files */ - if (Phar::running() && (! is_dir($files['app']))) { - $files['app'] = dirname(__DIR__, 6).DIRECTORY_SEPARATOR.'config'.DIRECTORY_SEPARATOR.'app.php'; + $this->mergeRealtimeCompilerEnvironment($repository, 'HYDE_SERVER_SAVE_PREVIEW', 'hyde.server.save_preview'); + $this->mergeRealtimeCompilerEnvironment($repository, 'HYDE_SERVER_DASHBOARD', 'hyde.server.dashboard.enabled'); + $this->mergeRealtimeCompilerEnvironment($repository, 'HYDE_PRETTY_URLS', 'hyde.pretty_urls'); + $this->mergeRealtimeCompilerEnvironment($repository, 'HYDE_PLAY_CDN', 'hyde.use_play_cdn'); } } - private function loadRuntimeConfiguration(Application $app, RepositoryContract $repository): void + private function mergeCommandLineArguments(Repository $repository, string $argumentName, string $configKey, bool $value): void { - if ($app->runningInConsole() && isset($_SERVER['argv'])) { - // Check if the `--pretty-urls` CLI argument is set, and if so, set the config value accordingly. - if (in_array('--pretty-urls', $_SERVER['argv'], true)) { - $repository->set('hyde.pretty_urls', true); - } + if (in_array($argumentName, $this->getArgv(), true)) { + $repository->set($configKey, $value); + } + } - // Check if the `--no-api` CLI argument is set, and if so, set the config value accordingly. - if (in_array('--no-api', $_SERVER['argv'], true)) { - $repository->set('hyde.api_calls', false); - } + private function mergeRealtimeCompilerEnvironment(Repository $repository, string $environmentKey, string $configKey): void + { + if ($this->getEnv($environmentKey) !== false) { + $repository->set($configKey, $this->getEnv($environmentKey) === 'enabled'); } } + + protected function getArgv(): ?array + { + return $_SERVER['argv'] ?? null; + } + + protected function getEnv(string $name): string|false|null + { + return getenv($name); + } } diff --git a/src/Foundation/Internal/LoadYamlConfiguration.php b/src/Foundation/Internal/LoadYamlConfiguration.php index 59fcc1da..833f47fb 100644 --- a/src/Foundation/Internal/LoadYamlConfiguration.php +++ b/src/Foundation/Internal/LoadYamlConfiguration.php @@ -6,6 +6,7 @@ use Hyde\Hyde; use Hyde\Facades\Config; +use Illuminate\Support\Arr; use Symfony\Component\Yaml\Yaml; use function array_key_first; @@ -48,7 +49,7 @@ protected function hasYamlConfigFile(): bool /** @return array */ protected function getYaml(): array { - return (array) Yaml::parse(file_get_contents($this->getFile())); + return Arr::undot((array) Yaml::parse(file_get_contents($this->getFile()))); } protected function getFile(): string @@ -67,7 +68,7 @@ protected function mergeParsedConfiguration(): void if ($this->configurationContainsNamespaces($yaml)) { /** @var array> $yaml */ foreach ($yaml as $namespace => $data) { - $this->mergeConfiguration($namespace, (array) $data); + $this->mergeConfiguration($namespace, Arr::undot((array) $data)); } return; diff --git a/src/Framework/Factories/NavigationDataFactory.php b/src/Framework/Factories/NavigationDataFactory.php index dd6d9a8f..d9406d6f 100644 --- a/src/Framework/Factories/NavigationDataFactory.php +++ b/src/Framework/Factories/NavigationDataFactory.php @@ -12,9 +12,11 @@ use Hyde\Framework\Factories\Concerns\CoreDataObject; use Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema; +use function basename; use function array_flip; use function in_array; use function is_a; +use function array_key_exists; /** * Discover data used for navigation menus and the documentation sidebar. @@ -157,31 +159,47 @@ private function searchForPriorityInConfigs(): ?int private function searchForPriorityInSidebarConfig(): ?int { - // Sidebars uses a special syntax where the keys are just the page identifiers in a flat array. - // TODO: In the future we could normalize this with the standard navigation config so both strategies can be auto-detected and used. - - // Adding an offset makes so that pages with a front matter priority that is lower can be shown first. - // This is all to make it easier to mix ways of adding priorities. - - /** @var array $config */ + /** @var array|array $config */ $config = Config::getArray('docs.sidebar_order', []); - return $this->offset( - array_flip($config)[$this->identifier] ?? null, - self::CONFIG_OFFSET - ); + return + // For consistency with the navigation config. + $this->parseNavigationPriorityConfig($config, 'routeKey') + // For backwards compatibility, and ease of use, as the route key prefix + // is redundant due to it being the same for all documentation pages + ?? $this->parseNavigationPriorityConfig($config, 'identifier'); } private function searchForPriorityInNavigationConfig(): ?int { - /** @var array $config */ + /** @var array|array $config */ $config = Config::getArray('hyde.navigation.order', [ 'index' => 0, 'posts' => 10, 'docs/index' => 100, ]); - return $config[$this->routeKey] ?? null; + return $this->parseNavigationPriorityConfig($config, 'routeKey'); + } + + /** @param array|array $config */ + private function parseNavigationPriorityConfig(array $config, string $pageKeyName): ?int + { + $pageKey = $this->{$pageKeyName}; + + // Check if the config entry is a flat array or a keyed array. + if (! array_key_exists($pageKey, $config)) { + // Adding an offset makes so that pages with a front matter priority, or + // explicit keyed priority selection that is lower can be shown first. + // This is all to make it easier to mix ways of adding priorities. + + return $this->offset( + array_flip($config)[$pageKey] ?? null, + self::CONFIG_OFFSET + ); + } + + return $config[$pageKey] ?? null; } private function canUseSubdirectoryForGroups(): bool diff --git a/src/Framework/Features/Navigation/DocumentationSidebar.php b/src/Framework/Features/Navigation/DocumentationSidebar.php index 6cf239a9..919b9343 100644 --- a/src/Framework/Features/Navigation/DocumentationSidebar.php +++ b/src/Framework/Features/Navigation/DocumentationSidebar.php @@ -4,6 +4,8 @@ namespace Hyde\Framework\Features\Navigation; +use Hyde\Hyde; +use Hyde\Facades\Config; use Hyde\Foundation\Facades\Routes; use Hyde\Pages\DocumentationPage; use Hyde\Support\Facades\Render; @@ -56,6 +58,11 @@ public function isGroupActive(string $group): bool || $this->isPageIndexPage() && $this->shouldIndexPageBeActive($group); } + public function makeGroupTitle(string $group): string + { + return Config::getNullableString("docs.sidebar_group_labels.$group") ?? Hyde::makeTitle($group); + } + protected function canAddRoute(Route $route): bool { return parent::canAddRoute($route) && ! $route->is(DocumentationPage::homeRouteName()); diff --git a/src/Framework/Features/XmlGenerators/SitemapGenerator.php b/src/Framework/Features/XmlGenerators/SitemapGenerator.php index 64b5690c..38e53a3a 100644 --- a/src/Framework/Features/XmlGenerators/SitemapGenerator.php +++ b/src/Framework/Features/XmlGenerators/SitemapGenerator.php @@ -17,10 +17,12 @@ use Hyde\Foundation\Facades\Routes; use Hyde\Framework\Concerns\TracksExecutionTime; +use function blank; use function filemtime; use function in_array; use function date; use function time; +use function str_starts_with; /** * @see https://www.sitemaps.org/protocol.html @@ -57,7 +59,7 @@ protected function addRoute(Route $route): void { $urlItem = $this->xmlElement->addChild('url'); - $this->addChild($urlItem, 'loc', Hyde::url($route->getOutputPath())); + $this->addChild($urlItem, 'loc', $this->resolveRouteLink($route)); $this->addChild($urlItem, 'lastmod', $this->getLastModDate($route->getSourcePath())); $this->addChild($urlItem, 'changefreq', 'daily'); @@ -103,4 +105,18 @@ protected function getFormattedProcessingTime(): string { return (string) $this->getExecutionTimeInMs(); } + + protected function resolveRouteLink(Route $route): string + { + $baseUrl = Config::getNullableString('hyde.url'); + + if (blank($baseUrl) || str_starts_with($baseUrl, 'http://localhost')) { + // While the sitemap spec requires a full URL, we rather fall back + // to using relative links instead of using localhost links. + + return $route->getLink(); + } else { + return Hyde::url($route->getOutputPath()); + } + } } diff --git a/tests/Feature/Commands/ServeCommandTest.php b/tests/Feature/Commands/ServeCommandTest.php index db0f4ec0..7aa1cd8d 100644 --- a/tests/Feature/Commands/ServeCommandTest.php +++ b/tests/Feature/Commands/ServeCommandTest.php @@ -4,13 +4,17 @@ namespace Hyde\Framework\Testing\Feature\Commands; +use Closure; use Hyde\Hyde; use Hyde\Testing\TestCase; use Illuminate\Support\Facades\Process; use TypeError; +use Hyde\RealtimeCompiler\ConsoleOutput; /** * @covers \Hyde\Console\Commands\ServeCommand + * + * @see \Hyde\Framework\Testing\Unit\ServeCommandOptionsUnitTest */ class ServeCommandTest extends TestCase { @@ -23,7 +27,7 @@ protected function setUp(): void public function test_hyde_serve_command() { - $this->artisan('serve') + $this->artisan('serve --no-ansi') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -32,7 +36,7 @@ public function test_hyde_serve_command() public function test_hyde_serve_command_with_port_option() { - $this->artisan('serve --port=8081') + $this->artisan('serve --no-ansi --port=8081') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -41,7 +45,7 @@ public function test_hyde_serve_command_with_port_option() public function test_hyde_serve_command_with_host_option() { - $this->artisan('serve --host=foo') + $this->artisan('serve --no-ansi --host=foo') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -50,7 +54,7 @@ public function test_hyde_serve_command_with_host_option() public function test_hyde_serve_command_with_port_and_host_option() { - $this->artisan('serve --port=8081 --host=foo') + $this->artisan('serve --no-ansi --port=8081 --host=foo') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -61,7 +65,7 @@ public function test_hyde_serve_command_with_port_defined_in_config() { config(['hyde.server.port' => 8081]); - $this->artisan('serve') + $this->artisan('serve --no-ansi') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -72,7 +76,7 @@ public function test_hyde_serve_command_with_port_defined_in_config_and_port_opt { config(['hyde.server.port' => 8081]); - $this->artisan('serve --port=8082') + $this->artisan('serve --no-ansi --port=8082') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -83,7 +87,7 @@ public function test_hyde_serve_command_with_port_missing_in_config_and_port_opt { config(['hyde.server.port' => null]); - $this->artisan('serve --port=8081') + $this->artisan('serve --no-ansi --port=8081') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -94,7 +98,7 @@ public function test_hyde_serve_command_with_host_defined_in_config() { config(['hyde.server.host' => 'foo']); - $this->artisan('serve') + $this->artisan('serve --no-ansi') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -105,7 +109,7 @@ public function test_hyde_serve_command_with_host_defined_in_config_and_host_opt { config(['hyde.server.host' => 'foo']); - $this->artisan('serve --host=bar') + $this->artisan('serve --no-ansi --host=bar') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -116,7 +120,7 @@ public function test_hyde_serve_command_with_host_missing_in_config_and_host_opt { config(['hyde.server.host' => null]); - $this->artisan('serve --host=foo') + $this->artisan('serve --no-ansi --host=foo') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); @@ -128,20 +132,48 @@ public function test_hyde_serve_command_with_invalid_config_value() $this->expectException(TypeError::class); config(['hyde.server.port' => 'foo']); - $this->artisan('serve') + $this->artisan('serve --no-ansi') ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') ->assertExitCode(0); } public function test_hyde_serve_command_passes_through_process_output() { - $this->markTestSkipped('Unable to access the output of the process. Assuming vendor bug for now.'); + Process::shouldReceive('forever') + ->once() + ->withNoArgs() + ->andReturnSelf(); + + Process::shouldReceive('env') + ->once() + ->with(['HYDE_SERVER_REQUEST_OUTPUT' => false]) + ->andReturnSelf(); + + Process::shouldReceive('run') + ->once() + ->withArgs(function (string $command, Closure $handle) { + $handle('type', 'foo'); + + return $command === "php -S localhost:8080 {$this->binaryPath()}"; + }) + ->andReturnSelf(); + + $this->artisan('serve --no-ansi') + ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') + ->expectsOutput('foo') + ->assertExitCode(0); + } + + public function testWithFancyOutput() + { + if (! class_exists(ConsoleOutput::class)) { + $this->markTestSkipped('ConsoleOutput class not found.'); + } Process::fake(['php -S localhost:8080 {$this->binaryPath()}' => 'foo']); $this->artisan('serve') - ->expectsOutput('Starting the HydeRC server... Press Ctrl+C to stop') - ->expectsOutput('foo') + ->expectsOutputToContain('HydePHP Realtime Compiler') ->assertExitCode(0); Process::assertRan("php -S localhost:8080 {$this->binaryPath()}"); diff --git a/tests/Feature/LoadYamlConfigurationTest.php b/tests/Feature/LoadYamlConfigurationTest.php index eb461d89..47f199eb 100644 --- a/tests/Feature/LoadYamlConfigurationTest.php +++ b/tests/Feature/LoadYamlConfigurationTest.php @@ -227,6 +227,41 @@ public function testHydeNamespaceCanBlank() $this->assertSame('baz', Config::get('foo.bar')); } + public function testDotNotationCanBeUsed() + { + config(['hyde' => []]); + + $this->file('hyde.yml', <<<'YAML' + foo.bar.baz: qux + YAML); + $this->runBootstrapper(); + + $this->assertSame(['foo' => ['bar' => ['baz' => 'qux']]], Config::get('hyde')); + $this->assertSame('qux', Config::get('hyde.foo.bar.baz')); + } + + public function testDotNotationCanBeUsedWithNamespaces() + { + config(['hyde' => []]); + + $this->file('hyde.yml', <<<'YAML' + hyde: + foo.bar.baz: qux + one: + foo: + bar: + baz: qux + two: + foo.bar.baz: qux + YAML); + $this->runBootstrapper(); + + $expected = ['foo' => ['bar' => ['baz' => 'qux']]]; + $this->assertSame($expected, Config::get('hyde')); + $this->assertSame($expected, Config::get('one')); + $this->assertSame($expected, Config::get('two')); + } + protected function runBootstrapper(): void { $this->app->bootstrapWith([LoadYamlConfiguration::class]); diff --git a/tests/Feature/Services/DocumentationSidebarTest.php b/tests/Feature/Services/DocumentationSidebarTest.php index 9ac37522..5562c1ec 100644 --- a/tests/Feature/Services/DocumentationSidebarTest.php +++ b/tests/Feature/Services/DocumentationSidebarTest.php @@ -337,6 +337,24 @@ public function test_automatic_index_page_group_expansion_respects_custom_naviga $this->assertTrue(DocumentationSidebar::create()->isGroupActive('baz')); } + public function test_make_group_title_turns_group_key_into_title() + { + $this->assertSame('Hello World', DocumentationSidebar::create()->makeGroupTitle('hello world')); + $this->assertSame('Hello World', DocumentationSidebar::create()->makeGroupTitle('hello-world')); + $this->assertSame('Hello World', DocumentationSidebar::create()->makeGroupTitle('hello_world')); + $this->assertSame('Hello World', DocumentationSidebar::create()->makeGroupTitle('helloWorld')); + } + + public function test_make_group_title_uses_configured_sidebar_group_labels_when_available() + { + Config::set('docs.sidebar_group_labels', [ + 'example' => 'Hello world!', + ]); + + $this->assertSame('Hello world!', DocumentationSidebar::create()->makeGroupTitle('example')); + $this->assertSame('Default', DocumentationSidebar::create()->makeGroupTitle('default')); + } + public function test_can_have_multiple_grouped_pages_with_the_same_name_labels() { $this->makePage('foo', ['navigation.group' => 'foo', 'navigation.label' => 'Foo']); diff --git a/tests/Feature/Services/SitemapServiceTest.php b/tests/Feature/Services/SitemapServiceTest.php index dddc5e42..e82342eb 100644 --- a/tests/Feature/Services/SitemapServiceTest.php +++ b/tests/Feature/Services/SitemapServiceTest.php @@ -158,4 +158,26 @@ public function test_all_route_types_are_discovered() copy(Hyde::vendorPath('resources/views/homepages/welcome.blade.php'), Hyde::path('_pages/index.blade.php')); copy(Hyde::vendorPath('resources/views/pages/404.blade.php'), Hyde::path('_pages/404.blade.php')); } + + public function testLinksFallbackToRelativeLinksWhenASiteUrlIsNotSet() + { + config(['hyde.url' => null]); + + $service = new SitemapGenerator(); + $service->generate(); + + $this->assertEquals('404.html', $service->getXmlElement()->url[0]->loc); + $this->assertEquals('index.html', $service->getXmlElement()->url[1]->loc); + } + + public function testLinksFallbackToRelativeLinksWhenSiteUrlIsLocalhost() + { + config(['hyde.url' => 'http://localhost']); + + $service = new SitemapGenerator(); + $service->generate(); + + $this->assertEquals('404.html', $service->getXmlElement()->url[0]->loc); + $this->assertEquals('index.html', $service->getXmlElement()->url[1]->loc); + } } diff --git a/tests/Feature/SidebarViewTest.php b/tests/Feature/SidebarViewTest.php index 53843c6c..44840e64 100644 --- a/tests/Feature/SidebarViewTest.php +++ b/tests/Feature/SidebarViewTest.php @@ -65,6 +65,17 @@ public function testBaseSidebarWithoutFooter() $this->assertViewWasNotRendered(view('hyde::components.docs.sidebar-footer-text')); } + public function testBaseSidebarWithCustomFooterText() + { + config(['docs.sidebar.footer' => 'My **Markdown** Footer Text']); + + $this->renderComponent(view('hyde::components.docs.sidebar')) + ->assertSeeHtml('