class HtmxHeadersTest

Test all header-related Htmx public methods.

Attributes

#[CoversClass(Htmx::class)] #[Group('Htmx')]

Hierarchy

class \Drupal\Tests\UnitTestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait extends \PHPUnit\Framework\TestCase
- class \Drupal\Tests\Core\Htmx\HtmxHeadersTest extends \Drupal\Tests\UnitTestCase

Expanded class hierarchy of HtmxHeadersTest

File

core/tests/Drupal/Tests/Core/Htmx/HtmxHeadersTest.php, line 18

Namespace

Drupal\Tests\Core\Htmx

View on git.drupalcode.org

View source

class HtmxHeadersTest extends UnitTestCase {
  
  /**
   * Class under test.
   */
  protected Htmx $htmx;
  
  /**
   * Mocked Url object.
   */
  protected Url $url;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->htmx = new Htmx();
    $generated = new GeneratedUrl();
    $generated->setGeneratedUrl('https://www.example.test/common-test/destination');
    $this->url = $this->getMockBuilder(Url::class)
      ->disableOriginalConstructor()
      ->onlyMethods([
      'toString',
    ])
      ->getMock();
    $this->url
      ->expects($this->any())
      ->method('toString')
      ->willReturn($generated);
  }
  protected function apply(array $render = []) : array {
    $this->htmx
      ->applyTo($render);
    return $render;
  }
  
  /**
   * Test location header with simple URL object.
   */
  public function testLocationHeaderUrl() : void {
    $this->htmx
      ->locationHeader($this->url);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-location', $value[0]);
    $this->assertEquals('https://www.example.test/common-test/destination', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test location header with complex data.
   */
  public function testLocationHeaderResponseData() : void {
    $data = new HtmxLocationResponseData(path: $this->url, source: 'source-value', event: 'event-value', handler: 'handler-value', target: 'target-value', swap: 'swap-value', values: [
      'one' => '1',
      'two' => '2',
    ], headers: [
      'Header-one' => 'one',
    ], select: 'select-value');
    $this->htmx
      ->locationHeader($data);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-location', $value[0]);
    $this->assertEquals('{"path":"https:\\/\\/www.example.test\\/common-test\\/destination","source":"source-value","event":"event-value","headers":{"Header-one":"one"},"handler":"handler-value","target":"target-value","swap":"swap-value","select":"select-value","values":{"one":"1","two":"2"}}', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test push url header with a simple URL object.
   */
  public function testPushUrlHeader() : void {
    $this->htmx
      ->pushUrlHeader($this->url);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-push-url', $value[0]);
    $this->assertEquals('https://www.example.test/common-test/destination', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test replace url header with a simple URL object.
   */
  public function testReplaceUrlHeader() : void {
    $this->htmx
      ->replaceUrlHeader($this->url);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-replace-url', $value[0]);
    $this->assertEquals('https://www.example.test/common-test/destination', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test redirect header with simple URL object.
   */
  public function testRedirectHeader() : void {
    $this->htmx
      ->redirectHeader($this->url);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-redirect', $value[0]);
    $this->assertEquals('https://www.example.test/common-test/destination', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test refresh header.
   */
  public function testRefreshHeader() : void {
    // TRUE case.
    $this->htmx
      ->refreshHeader(TRUE);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-refresh', $value[0]);
    $this->assertEquals('true', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
    // FALSE case.
    $this->htmx
      ->refreshHeader(FALSE);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-refresh', $value[0]);
    $this->assertEquals('false', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test re-swap header.
   */
  public function testReswapHeader() : void {
    $this->htmx
      ->reswapHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-reswap', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test re-target header.
   */
  public function testRetargetHeader() : void {
    $this->htmx
      ->retargetHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-retarget', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test re-select header.
   */
  public function testReselectHeader() : void {
    $this->htmx
      ->reselectHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-reselect', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test trigger header with simple data.
   */
  public function testTriggerHeader() : void {
    $this->htmx
      ->triggerHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test target header with complex data.
   */
  public function testTriggerHeaderComplex() : void {
    $this->htmx
      ->triggerHeader([
      'showMessage' => [
        'level' => 'info',
        'message' => 'Trigger Set',
      ],
    ]);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger', $value[0]);
    $this->assertEquals('{"showMessage":{"level":"info","message":"Trigger Set"}}', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test trigger header with simple data.
   */
  public function testTriggerAfterSettleHeader() : void {
    $this->htmx
      ->triggerAfterSettleHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger-after-settle', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test trigger after settle header is correctly set with provided parameters.
   */
  public function testTriggerAfterSettleHeaderComplex() : void {
    $this->htmx
      ->triggerAfterSettleHeader([
      'showMessage' => [
        'level' => 'info',
        'message' => 'Trigger Set',
      ],
    ]);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger-after-settle', $value[0]);
    $this->assertEquals('{"showMessage":{"level":"info","message":"Trigger Set"}}', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test trigger header with simple data.
   */
  public function testTriggerAfterSwapHeader() : void {
    $this->htmx
      ->triggerAfterSwapHeader('foo');
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger-after-swap', $value[0]);
    $this->assertEquals('foo', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }
  
  /**
   * Test trigger after settle header is correctly set with provided parameters.
   */
  public function testTriggerAfterSwapHeaderComplex() : void {
    $this->htmx
      ->triggerAfterSwapHeader([
      'showMessage' => [
        'level' => 'info',
        'message' => 'Trigger Set',
      ],
    ]);
    $render = $this->apply();
    $this->assertTrue(isset($render['#attached']['http_header']));
    $this->assertIsArray($render['#attached']['http_header']);
    $value = reset($render['#attached']['http_header']);
    $this->assertEquals('hx-trigger-after-swap', $value[0]);
    $this->assertEquals('{"showMessage":{"level":"info","message":"Trigger Set"}}', $value[1]);
    $this->assertEquals(TRUE, $value[2]);
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
ExpectDeprecationTrait::expectDeprecation	public	function	Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler	public	function	Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler	public	function	Tears down the test error handler.
HtmxHeadersTest::$htmx	protected	property	Class under test.
HtmxHeadersTest::$url	protected	property	Mocked Url object.
HtmxHeadersTest::apply	protected	function
HtmxHeadersTest::setUp	protected	function		Overrides UnitTestCase::setUp
HtmxHeadersTest::testLocationHeaderResponseData	public	function	Test location header with complex data.
HtmxHeadersTest::testLocationHeaderUrl	public	function	Test location header with simple URL object.
HtmxHeadersTest::testPushUrlHeader	public	function	Test push url header with a simple URL object.
HtmxHeadersTest::testRedirectHeader	public	function	Test redirect header with simple URL object.
HtmxHeadersTest::testRefreshHeader	public	function	Test refresh header.
HtmxHeadersTest::testReplaceUrlHeader	public	function	Test replace url header with a simple URL object.
HtmxHeadersTest::testReselectHeader	public	function	Test re-select header.
HtmxHeadersTest::testReswapHeader	public	function	Test re-swap header.
HtmxHeadersTest::testRetargetHeader	public	function	Test re-target header.
HtmxHeadersTest::testTriggerAfterSettleHeader	public	function	Test trigger header with simple data.
HtmxHeadersTest::testTriggerAfterSettleHeaderComplex	public	function	Test trigger after settle header is correctly set with provided parameters.
HtmxHeadersTest::testTriggerAfterSwapHeader	public	function	Test trigger header with simple data.
HtmxHeadersTest::testTriggerAfterSwapHeaderComplex	public	function	Test trigger after settle header is correctly set with provided parameters.
HtmxHeadersTest::testTriggerHeader	public	function	Test trigger header with simple data.
HtmxHeadersTest::testTriggerHeaderComplex	public	function	Test target header with complex data.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
UnitTestCase::$root	protected	property	The app root.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::setDebugDumpHandler	public static	function	Registers the dumper CLI handler when the DebugDump extension is enabled.
UnitTestCase::setupMockIterator	protected	function	Set up a traversable class mock to return specific items when iterated.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

class HtmxHeadersTest

Attributes

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation

Breadcrumb

class HtmxHeadersTest

Attributes

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation