Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Contains \Drupal\Tests\Component\Utility\VariableTest.
Chris@0:  */
Chris@0: 
Chris@0: namespace Drupal\Tests\Component\Utility;
Chris@0: 
Chris@0: use Drupal\Component\Utility\Variable;
Chris@0: use PHPUnit\Framework\TestCase;
Chris@0: 
Chris@0: /**
Chris@0:  * Test variable export functionality in Variable component.
Chris@0:  *
Chris@0:  * @group Variable
Chris@0:  * @group Utility
Chris@0:  *
Chris@0:  * @coversDefaultClass \Drupal\Component\Utility\Variable
Chris@0:  */
Chris@0: class VariableTest extends TestCase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for testExport().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array containing:
Chris@0:    *     - The expected export string.
Chris@0:    *     - The variable to export.
Chris@0:    */
Chris@0:   public function providerTestExport() {
Chris@0:     return [
Chris@0:       // Array.
Chris@0:       [
Chris@0:         'array()',
Chris@0:         [],
Chris@0:       ],
Chris@0:       [
Chris@0:         // non-associative.
Chris@0:         "array(\n  1,\n  2,\n  3,\n  4,\n)",
Chris@0:         [1, 2, 3, 4],
Chris@0:       ],
Chris@0:       [
Chris@0:         // associative.
Chris@0:         "array(\n  'a' => 1,\n)",
Chris@0:         ['a' => 1],
Chris@0:       ],
Chris@0:       // Bool.
Chris@0:       [
Chris@0:         'TRUE',
Chris@0:         TRUE,
Chris@0:       ],
Chris@0:       [
Chris@0:         'FALSE',
Chris@0:         FALSE,
Chris@0:       ],
Chris@0:       // Strings.
Chris@0:       [
Chris@0:         "'string'",
Chris@0:         'string',
Chris@0:       ],
Chris@0:       [
Chris@0:         '"\n\r\t"',
Chris@0:         "\n\r\t",
Chris@0:       ],
Chris@0:       [
Chris@0:         // 2 backslashes. \\
Chris@0:         "'\\'",
Chris@0:         '\\',
Chris@0:       ],
Chris@0:       [
Chris@0:         // Double-quote "
Chris@0:         "'\"'",
Chris@0:         "\"",
Chris@0:       ],
Chris@0:       [
Chris@0:         // Single-quote '
Chris@0:         '"\'"',
Chris@0:         "'",
Chris@0:       ],
Chris@0:       [
Chris@0:         // Quotes with $ symbols.
Chris@0:         '"\$settings[\'foo\']"',
Chris@0:         '$settings[\'foo\']',
Chris@0:       ],
Chris@0:       // Object.
Chris@0:       [
Chris@0:         // A stdClass object.
Chris@0:         '(object) array()',
Chris@0:         new \stdClass(),
Chris@0:       ],
Chris@0:       [
Chris@0:         // A not-stdClass object.
Chris@0:         "Drupal\Tests\Component\Utility\StubVariableTestClass::__set_state(array(\n))",
Chris@0:         new StubVariableTestClass(),
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests exporting variables.
Chris@0:    *
Chris@0:    * @dataProvider providerTestExport
Chris@0:    * @covers ::export
Chris@0:    *
Chris@0:    * @param string $expected
Chris@0:    *   The expected exported variable.
Chris@0:    * @param mixed $variable
Chris@0:    *   The variable to be exported.
Chris@0:    */
Chris@0:   public function testExport($expected, $variable) {
Chris@0:     $this->assertEquals($expected, Variable::export($variable));
Chris@0:   }
Chris@0: 
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * No-op test class for VariableTest::testExport().
Chris@0:  *
Chris@0:  * @see Drupal\Tests\Component\Utility\VariableTest::testExport()
Chris@0:  * @see Drupal\Tests\Component\Utility\VariableTest::providerTestExport()
Chris@0:  */
Chris@0: class StubVariableTestClass {
Chris@0: 
Chris@0: }