Merge pull request #177 from hydephp/170-dont-display-estimated-search-index-generation-time-if-the-time-is-less-than-one-or-a-few-seconds

Don't display estimated search index generation time if it's less than 1 second hydephp/develop@8f24fae

Author: github-actions

src/Commands/HydeBuildSearchCommand.php

@@ -40,7 +40,11 @@ public function handle(): int
         $actionTime = microtime(true);
 
         $this->comment('Generating documentation site search index...');
-        $this->line('<fg=gray> > This will take an estimated '.round($this->guesstimateGenerationTime() / 1000).' seconds. Terminal may seem non-responsive.</>');
+        $expected = $this->guesstimateGenerationTime();
+
+        if ($expected > 0) {
+            $this->line("<fg=gray> > This will take an estimated $expected seconds. Terminal may seem non-responsive.</>");
+        }
         GeneratesDocumentationSearchIndexFile::run();
 
         $this->line(' > Created <info>'.GeneratesDocumentationSearchIndexFile::$filePath.'</> in '.
@@ -67,9 +71,12 @@ protected function createSearchPage(): void
         $this->getExecutionTimeInMs($actionTime)."ms\n");
     }
 
-    protected function guesstimateGenerationTime(): float
+    /** @internal Estimated processing time per file in ms */
+    public static float $guesstimationFactor = 52.5;
+
+    protected function guesstimateGenerationTime(): int
     {
-        return count(CollectionService::getDocumentationPageFiles()) * 52.5;
+        return round(count(CollectionService::getDocumentationPageFiles()) * static::$guesstimationFactor) / 1000;
     }
 
     protected function getExecutionTimeInMs(float $timeStart): string

tests/Feature/Commands/HydeBuildSearchCommandTest.php

@@ -2,6 +2,7 @@
 
 namespace Hyde\Framework\Testing\Feature\Commands;
 
+use Hyde\Framework\Commands\HydeBuildSearchCommand;
 use Hyde\Framework\Hyde;
 use Hyde\Testing\TestCase;
 
@@ -10,14 +11,67 @@
  */
 class HydeBuildSearchCommandTest extends TestCase
 {
-    public function test_it_creates_the_search_json_file()
+    protected function setUp(): void
+    {
+        parent::setUp();
+        unlinkIfExists(Hyde::path('_site/docs/search.json'));
+        unlinkIfExists(Hyde::path('_site/docs/search.html'));
+    }
+
+    protected function tearDown(): void
     {
+        unlinkIfExists(Hyde::path('_site/docs/search.html'));
         unlinkIfExists(Hyde::path('_site/docs/search.json'));
+        HydeBuildSearchCommand::$guesstimationFactor = 52.5;
+        parent::tearDown();
+    }
+
+    public function test_it_creates_the_search_json_file()
+    {
         $this->artisan('build:search')
             ->expectsOutput('Generating documentation site search index...')
             ->assertExitCode(0);
 
         $this->assertFileExists(Hyde::path('_site/docs/search.json'));
-        unlink(Hyde::path('_site/docs/search.json'));
+    }
+
+    public function test_it_creates_the_search_page()
+    {
+        $this->artisan('build:search')
+            ->expectsOutput('Generating documentation site search index...')
+            ->assertExitCode(0);
+
+        $this->assertFileExists(Hyde::path('_site/docs/search.html'));
+    }
+
+    public function test_it_does_not_create_the_search_page_if_disabled()
+    {
+        config(['docs.create_search_page' => false]);
+        $this->artisan('build:search')
+            ->expectsOutput('Generating documentation site search index...')
+            ->assertExitCode(0);
+
+        $this->assertFileDoesNotExist(Hyde::path('_site/docs/search.html'));
+    }
+
+    public function test_it_does_not_display_the_estimation_message_when_it_is_less_than_1_second()
+    {
+        HydeBuildSearchCommand::$guesstimationFactor = 0;
+
+        $this->artisan('build:search')
+            ->expectsOutput('Generating documentation site search index...')
+            ->doesntExpectOutputToContain('> This will take an estimated')
+            ->assertExitCode(0);
+    }
+
+    public function test_it_displays_the_estimation_message_when_it_is_greater_than_1_second()
+    {
+        HydeBuildSearchCommand::$guesstimationFactor = 1000;
+        touch(Hyde::path('_docs/foo.md'));
+        $this->artisan('build:search')
+            ->expectsOutput('Generating documentation site search index...')
+            ->expectsOutputToContain('> This will take an estimated')
+            ->assertExitCode(0);
+        unlink(Hyde::path('_docs/foo.md'));
     }
 }