HtmxRequestInfoTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Htmx;

use Drupal\Core\Htmx\HtmxRequestInfoTrait;
use Drupal\Tests\UnitTestCase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use Symfony\Component\HttpFoundation\Request;

/**
 * Test all HtmxRequestInfoTrait methods.
 */
class HtmxRequestInfoTest extends UnitTestCase {
  use HtmxRequestInfoTrait;
  
  /**
   * A simulated request.
   */
  protected Request $request;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->request = new Request();
  }
  
  /**
   * Tests the isHtmxRequest method.
   */
  public function testIsHtmxRequest() : void {
    // Test with the header not present.
    $this->assertFalse($this->isHtmxRequest());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Request', 'true');
    $this->assertTrue($this->isHtmxRequest());
  }
  
  /**
   * Tests the isHtmxBoosted method.
   */
  public function testIsHtmxBoosted() : void {
    // Test with the header not present.
    $this->assertFalse($this->isHtmxBoosted());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Boosted', 'true');
    $this->assertTrue($this->isHtmxBoosted());
  }
  
  /**
   * Tests the getHtmxCurrentUrl method.
   */
  public function testGetHtmxCurrentUrl() : void {
    // Test with the header not present.
    $this->assertEquals('', $this->getHtmxCurrentUrl());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Current-URL', 'https://example.com/page');
    $this->assertEquals('https://example.com/page', $this->getHtmxCurrentUrl());
  }
  
  /**
   * Tests the isHtmxHistoryRestoration method.
   */
  public function testIsHtmxHistoryRestoration() : void {
    // Test with the header not present.
    $this->assertFalse($this->isHtmxHistoryRestoration());
    // Test with the header present.
    $this->request->headers
      ->set('HX-History-Restore-Request', 'true');
    $this->assertTrue($this->isHtmxHistoryRestoration());
  }
  
  /**
   * Tests the getHtmxPrompt method.
   */
  public function testGetHtmxPrompt() : void {
    // Test with the header not present.
    $this->assertEquals('', $this->getHtmxPrompt());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Prompt', 'Enter a value');
    $this->assertEquals('Enter a value', $this->getHtmxPrompt());
  }
  
  /**
   * Tests the getHtmxTarget method.
   */
  public function testGetHtmxTarget() : void {
    // Test with the header not present.
    $this->assertEquals('', $this->getHtmxTarget());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Target', 'submit-button');
    $this->assertEquals('submit-button', $this->getHtmxTarget());
  }
  
  /**
   * Tests the getHtmxTrigger method.
   */
  public function testGetHtmxTrigger() : void {
    // Test with the header not present.
    $this->assertEquals('', $this->getHtmxTrigger());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Trigger', 'submit-button');
    $this->assertEquals('submit-button', $this->getHtmxTrigger());
  }
  
  /**
   * Tests the getHtmxTriggerName method.
   */
  public function testGetHtmxTriggerName() : void {
    // Test with the header not present.
    $this->assertEquals('', $this->getHtmxTriggerName());
    // Test with the header present.
    $this->request->headers
      ->set('HX-Trigger-Name', 'submit-button');
    $this->assertEquals('submit-button', $this->getHtmxTriggerName());
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getRequest() {
    return $this->request;
  }

}