assertEquals($expected, $actual);
+ }
+
+ public function testBasicText()
+ {
+ $this->assertEquals('"', $this->render('"'), 'Double-quotes are left alone');
+ $this->assertEquals("'", $this->render("'"), 'Single-quotes are left alone');
+ $this->assertEquals('A', $this->render('\\A'), 'Escaped characters are unescaped');
+ $this->assertEquals('\\A', $this->render('\\\\A'), 'Escaped back-slashed are correctly unescaped');
+ }
+
+ public function testBasicInjection()
+ {
+ $this->assertEquals('[out:Test]', $this->render('$Test'), 'Basic stand-alone injection');
+ $this->assertEquals('[out:Test]', $this->render('{$Test}'), 'Basic stand-alone wrapped injection');
+ $this->assertEquals('A[out:Test]!', $this->render('A$Test!'), 'Basic surrounded injection');
+ $this->assertEquals('A[out:Test]B', $this->render('A{$Test}B'), 'Basic surrounded wrapped injection');
+
+ $this->assertEquals('A$B', $this->render('A\\$B'), 'No injection as $ escaped');
+ $this->assertEquals('A$ B', $this->render('A$ B'), 'No injection as $ not followed by word character');
+ $this->assertEquals('A{$ B', $this->render('A{$ B'), 'No injection as {$ not followed by word character');
+
+ $this->assertEquals('{$Test}', $this->render('{\\$Test}'), 'Escapes can be used to avoid injection');
+ $this->assertEquals(
+ '{\\[out:Test]}',
+ $this->render('{\\\\$Test}'),
+ 'Escapes before injections are correctly unescaped'
+ );
+ }
+
+ public function testBasicInjectionMismatchedBrackets()
+ {
+ $this->expectException(SSTemplateParseException::class);
+ $this->expectExceptionMessageMatches('/Malformed bracket injection {\$Value(.*)/');
+ $this->render('A {$Value here');
+ $this->fail("Parser didn't error when encountering mismatched brackets in an injection");
+ }
+
+ public function testGlobalVariableCalls()
+ {
+ $this->assertEquals('automatic', $this->render('$SSTemplateEngineTest_GlobalAutomatic'));
+ $this->assertEquals('reference', $this->render('$SSTemplateEngineTest_GlobalReferencedByString'));
+ $this->assertEquals('reference', $this->render('$SSTemplateEngineTest_GlobalReferencedInArray'));
+ }
+
+ public function testGlobalVariableCallsWithArguments()
+ {
+ $this->assertEquals('zz', $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments'));
+ $this->assertEquals('zFooz', $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments("Foo")'));
+ $this->assertEquals(
+ 'zFoo:Bar:Bazz',
+ $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments("Foo", "Bar", "Baz")')
+ );
+ $this->assertEquals(
+ 'zreferencez',
+ $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalReferencedByString)')
+ );
+ }
+
+ public function testGlobalVariablesAreEscaped()
+ {
+ $this->assertEquals('', $this->render('$SSTemplateEngineTest_GlobalHTMLFragment'));
+ $this->assertEquals('<div></div>', $this->render('$SSTemplateEngineTest_GlobalHTMLEscaped'));
+
+ $this->assertEquals(
+ 'zz',
+ $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalHTMLFragment)')
+ );
+ // Don't escape value when passing into a method call
+ $this->assertEquals(
+ 'zz',
+ $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalHTMLEscaped)')
+ );
+ }
+
+ public function testGlobalVariablesReturnNull()
+ {
+ $this->assertEquals('', $this->render('$SSTemplateEngineTest_GlobalReturnsNull
'));
+ $this->assertEquals('', $this->render('$SSTemplateEngineTest_GlobalReturnsNull.Chained.Properties
'));
+ }
+
+ public function testCoreGlobalVariableCalls()
+ {
+ $this->assertEquals(
+ Director::absoluteBaseURL(),
+ $this->render('{$absoluteBaseURL}'),
+ 'Director::absoluteBaseURL can be called from within template'
+ );
+ $this->assertEquals(
+ Director::absoluteBaseURL(),
+ $this->render('{$AbsoluteBaseURL}'),
+ 'Upper-case %AbsoluteBaseURL can be called from within template'
+ );
+
+ $this->assertEquals(
+ Director::is_ajax(),
+ $this->render('{$isAjax}'),
+ 'All variations of is_ajax result in the correct call'
+ );
+ $this->assertEquals(
+ Director::is_ajax(),
+ $this->render('{$IsAjax}'),
+ 'All variations of is_ajax result in the correct call'
+ );
+ $this->assertEquals(
+ Director::is_ajax(),
+ $this->render('{$is_ajax}'),
+ 'All variations of is_ajax result in the correct call'
+ );
+ $this->assertEquals(
+ Director::is_ajax(),
+ $this->render('{$Is_ajax}'),
+ 'All variations of is_ajax result in the correct call'
+ );
+
+ $this->assertEquals(
+ i18n::get_locale(),
+ $this->render('{$i18nLocale}'),
+ 'i18n template functions result correct result'
+ );
+ $this->assertEquals(
+ i18n::get_locale(),
+ $this->render('{$get_locale}'),
+ 'i18n template functions result correct result'
+ );
+
+ $this->assertEquals(
+ Security::getCurrentUser()->ID,
+ $this->render('{$CurrentMember.ID}'),
+ 'Member template functions result correct result'
+ );
+ $this->assertEquals(
+ Security::getCurrentUser()->ID,
+ $this->render('{$CurrentUser.ID}'),
+ 'Member template functions result correct result'
+ );
+ $this->assertEquals(
+ Security::getCurrentUser()->ID,
+ $this->render('{$currentMember.ID}'),
+ 'Member template functions result correct result'
+ );
+ $this->assertEquals(
+ Security::getCurrentUser()->ID,
+ $this->render('{$currentUser.ID}'),
+ 'Member template functions result correct result'
+ );
+
+ $this->assertEquals(
+ SecurityToken::getSecurityID(),
+ $this->render('{$getSecurityID}'),
+ 'SecurityToken template functions result correct result'
+ );
+ $this->assertEquals(
+ SecurityToken::getSecurityID(),
+ $this->render('{$SecurityID}'),
+ 'SecurityToken template functions result correct result'
+ );
+
+ $this->assertEquals(
+ Permission::check("ADMIN"),
+ (bool)$this->render('{$HasPerm(\'ADMIN\')}'),
+ 'Permissions template functions result correct result'
+ );
+ $this->assertEquals(
+ Permission::check("ADMIN"),
+ (bool)$this->render('{$hasPerm(\'ADMIN\')}'),
+ 'Permissions template functions result correct result'
+ );
+ }
+
+ public function testNonFieldCastingHelpersNotUsedInHasValue()
+ {
+ // check if Link without $ in front of variable
+ $result = $this->render(
+ 'A<% if Link %>$Link<% end_if %>B',
+ new SSTemplateEngineTest\TestObject()
+ );
+ $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if Link %>');
+
+ // check if Link with $ in front of variable
+ $result = $this->render(
+ 'A<% if $Link %>$Link<% end_if %>B',
+ new SSTemplateEngineTest\TestObject()
+ );
+ $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if $Link %>');
+ }
+
+ public function testLocalFunctionsTakePriorityOverGlobals()
+ {
+ $data = new ArrayData([
+ 'Page' => new SSTemplateEngineTest\TestObject()
+ ]);
+
+ //call method with lots of arguments
+ $result = $this->render(
+ '<% with Page %>$lotsOfArguments11("a","b","c","d","e","f","g","h","i","j","k")<% end_with %>',
+ $data
+ );
+ $this->assertEquals("abcdefghijk", $result, "public function can accept up to 11 arguments");
+
+ //call method that does not exist
+ $result = $this->render('<% with Page %><% if IDoNotExist %>hello<% end_if %><% end_with %>', $data);
+ $this->assertEquals("", $result, "Method does not exist - empty result");
+
+ //call if that does not exist
+ $result = $this->render('<% with Page %>$IDoNotExist("hello")<% end_with %>', $data);
+ $this->assertEquals("", $result, "Method does not exist - empty result");
+
+ //call method with same name as a global method (local call should take priority)
+ $result = $this->render('<% with Page %>$absoluteBaseURL<% end_with %>', $data);
+ $this->assertEquals(
+ "testLocalFunctionPriorityCalled",
+ $result,
+ "Local Object's public function called. Did not return the actual baseURL of the current site"
+ );
+ }
+
+ public function testCurrentScopeLoop(): void
+ {
+ $data = new ArrayList([['Val' => 'one'], ['Val' => 'two'], ['Val' => 'three']]);
+ $this->assertEqualIgnoringWhitespace(
+ 'one two three',
+ $this->render('<% loop %>$Val<% end_loop %>', $data)
+ );
+ }
+
+ public function testCurrentScopeLoopWith()
+ {
+ // Data to run the loop tests on - one sequence of three items, each with a subitem
+ $data = new ArrayData([
+ 'Foo' => new ArrayList([
+ 'Subocean' => new ArrayData([
+ 'Name' => 'Higher'
+ ]),
+ new ArrayData([
+ 'Sub' => new ArrayData([
+ 'Name' => 'SubKid1'
+ ])
+ ]),
+ new ArrayData([
+ 'Sub' => new ArrayData([
+ 'Name' => 'SubKid2'
+ ])
+ ]),
+ new SSTemplateEngineTest\TestObject('Number6')
+ ])
+ ]);
+
+ $result = $this->render(
+ '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>',
+ $data
+ );
+ $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works");
+
+ $result = $this->render(
+ '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>',
+ $data
+ );
+ $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works");
+
+ $result = $this->render('<% with Foo %>$Count<% end_with %>', $data);
+ $this->assertEquals("4", $result, "4 items in the DataObjectSet");
+
+ $result = $this->render(
+ '<% with Foo %><% loop Up.Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>'
+ . '<% end_if %><% end_loop %><% end_with %>',
+ $data
+ );
+ $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in with Up.Foo scope works");
+
+ $result = $this->render(
+ '<% with Foo %><% loop %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>'
+ . '<% end_if %><% end_loop %><% end_with %>',
+ $data
+ );
+ $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in current scope works");
+ }
+
+ public static function provideArgumentTypes()
+ {
+ return [
+ [
+ 'arg0:0,arg1:"string",arg2:true',
+ '$methodWithTypedArguments(0, "string", true).RAW',
+ ],
+ [
+ 'arg0:false,arg1:"string",arg2:true',
+ '$methodWithTypedArguments(false, "string", true).RAW',
+ ],
+ [
+ 'arg0:null,arg1:"string",arg2:true',
+ '$methodWithTypedArguments(null, "string", true).RAW',
+ ],
+ [
+ 'arg0:"",arg1:"string",arg2:true',
+ '$methodWithTypedArguments("", "string", true).RAW',
+ ],
+ [
+ 'arg0:0,arg1:1,arg2:2',
+ '$methodWithTypedArguments(0, 1, 2).RAW',
+ ],
+ ];
+ }
+
+ #[DataProvider('provideArgumentTypes')]
+ public function testArgumentTypes(string $expected, string $template)
+ {
+ $this->assertEquals($expected, $this->render($template, new TestModelData()));
+ }
+
+ public static function provideEvaluatedArgumentTypes(): array
+ {
+ $stdobj = new stdClass();
+ $stdobj->key = 'value';
+ $scenarios = [
+ 'null value' => [
+ 'data' => ['Value' => null],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:null',
+ ],
+ 'int value' => [
+ 'data' => ['Value' => 1],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:1',
+ ],
+ 'string value' => [
+ 'data' => ['Value' => '1'],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:"1"',
+ ],
+ 'boolean true' => [
+ 'data' => ['Value' => true],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:true',
+ ],
+ 'boolean false' => [
+ 'data' => ['Value' => false],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:false',
+ ],
+ 'object value' => [
+ 'data' => ['Value' => $stdobj],
+ 'useOverlay' => true,
+ 'expected' => 'arg0:{"key":"value"}',
+ ],
+ ];
+ foreach ($scenarios as $key => $scenario) {
+ $scenario['useOverlay'] = false;
+ $scenarios[$key . ' no overlay'] = $scenario;
+ }
+ return $scenarios;
+ }
+
+ #[DataProvider('provideEvaluatedArgumentTypes')]
+ public function testEvaluatedArgumentTypes(array $data, bool $useOverlay, string $expected): void
+ {
+ $template = '$methodWithTypedArguments($Value).RAW';
+ $model = new TestModelData();
+ $overlay = $data;
+ if (!$useOverlay) {
+ $model = $model->customise($data);
+ $overlay = [];
+ }
+ $this->assertEquals($expected, $this->render($template, $model, $overlay));
+ }
+
+ public function testObjectDotArguments()
+ {
+ $this->assertEquals(
+ '[out:TestObject.methodWithOneArgument(one)]
+ [out:TestObject.methodWithTwoArguments(one,two)]
+ [out:TestMethod(Arg1,Arg2).Bar.Val]
+ [out:TestMethod(Arg1,Arg2).Bar]
+ [out:TestMethod(Arg1,Arg2)]
+ [out:TestMethod(Arg1).Bar.Val]
+ [out:TestMethod(Arg1).Bar]
+ [out:TestMethod(Arg1)]',
+ $this->render(
+ '$TestObject.methodWithOneArgument(one)
+ $TestObject.methodWithTwoArguments(one,two)
+ $TestMethod(Arg1, Arg2).Bar.Val
+ $TestMethod(Arg1, Arg2).Bar
+ $TestMethod(Arg1, Arg2)
+ $TestMethod(Arg1).Bar.Val
+ $TestMethod(Arg1).Bar
+ $TestMethod(Arg1)'
+ )
+ );
+ }
+
+ public function testEscapedArguments()
+ {
+ $this->assertEquals(
+ '[out:Foo(Arg1,Arg2).Bar.Val].Suffix
+ [out:Foo(Arg1,Arg2).Val]_Suffix
+ [out:Foo(Arg1,Arg2)]/Suffix
+ [out:Foo(Arg1).Bar.Val]textSuffix
+ [out:Foo(Arg1).Bar].Suffix
+ [out:Foo(Arg1)].Suffix
+ [out:Foo.Bar.Val].Suffix
+ [out:Foo.Bar].Suffix
+ [out:Foo].Suffix',
+ $this->render(
+ '{$Foo(Arg1, Arg2).Bar.Val}.Suffix
+ {$Foo(Arg1, Arg2).Val}_Suffix
+ {$Foo(Arg1, Arg2)}/Suffix
+ {$Foo(Arg1).Bar.Val}textSuffix
+ {$Foo(Arg1).Bar}.Suffix
+ {$Foo(Arg1)}.Suffix
+ {$Foo.Bar.Val}.Suffix
+ {$Foo.Bar}.Suffix
+ {$Foo}.Suffix'
+ )
+ );
+ }
+
+ public function testLoopWhitespace()
+ {
+ $data = new ArrayList([new SSTemplateEngineTest\TestFixture()]);
+ $this->assertEquals(
+ 'before[out:Test]after
+ beforeTestafter',
+ $this->render(
+ 'before<% loop %>$Test<% end_loop %>after
+ before<% loop %>Test<% end_loop %>after',
+ $data
+ )
+ );
+
+ // The control tags are removed from the output, but no whitespace
+ // This is a quirk that could be changed, but included in the test to make the current
+ // behaviour explicit
+ $this->assertEquals(
+ 'before
+
+[out:ItemOnItsOwnLine]
+
+after',
+ $this->render(
+ 'before
+<% loop %>
+$ItemOnItsOwnLine
+<% end_loop %>
+after',
+ $data
+ )
+ );
+
+ // The whitespace within the control tags is preserve in a loop
+ // This is a quirk that could be changed, but included in the test to make the current
+ // behaviour explicit
+ $this->assertEquals(
+ 'before
+
+[out:Loop3.ItemOnItsOwnLine]
+
+[out:Loop3.ItemOnItsOwnLine]
+
+[out:Loop3.ItemOnItsOwnLine]
+
+after',
+ $this->render(
+ 'before
+<% loop Loop3 %>
+$ItemOnItsOwnLine
+<% end_loop %>
+after'
+ )
+ );
+ }
+
+ public static function typePreservationDataProvider()
+ {
+ return [
+ // Null
+ ['NULL:', 'null'],
+ ['NULL:', 'NULL'],
+ // Booleans
+ ['boolean:1', 'true'],
+ ['boolean:1', 'TRUE'],
+ ['boolean:', 'false'],
+ ['boolean:', 'FALSE'],
+ // Strings which may look like booleans/null to the parser
+ ['string:nullish', 'nullish'],
+ ['string:notnull', 'notnull'],
+ ['string:truethy', 'truethy'],
+ ['string:untrue', 'untrue'],
+ ['string:falsey', 'falsey'],
+ // Integers
+ ['integer:0', '0'],
+ ['integer:1', '1'],
+ ['integer:15', '15'],
+ ['integer:-15', '-15'],
+ // Octal integers
+ ['integer:83', '0123'],
+ ['integer:-83', '-0123'],
+ // Hexadecimal integers
+ ['integer:26', '0x1A'],
+ ['integer:-26', '-0x1A'],
+ // Binary integers
+ ['integer:255', '0b11111111'],
+ ['integer:-255', '-0b11111111'],
+ // Floats (aka doubles)
+ ['double:0', '0.0'],
+ ['double:1', '1.0'],
+ ['double:15.25', '15.25'],
+ ['double:-15.25', '-15.25'],
+ ['double:1200', '1.2e3'],
+ ['double:-1200', '-1.2e3'],
+ ['double:0.07', '7E-2'],
+ ['double:-0.07', '-7E-2'],
+ // Explicitly quoted strings
+ ['string:0', '"0"'],
+ ['string:1', '\'1\''],
+ ['string:foobar', '"foobar"'],
+ ['string:foo bar baz', '"foo bar baz"'],
+ ['string:false', '\'false\''],
+ ['string:true', '\'true\''],
+ ['string:null', '\'null\''],
+ ['string:false', '"false"'],
+ ['string:true', '"true"'],
+ ['string:null', '"null"'],
+ // Implicit strings
+ ['string:foobar', 'foobar'],
+ ['string:foo bar baz', 'foo bar baz']
+ ];
+ }
+
+ #[DataProvider('typePreservationDataProvider')]
+ public function testTypesArePreserved($expected, $templateArg)
+ {
+ $data = new ArrayData([
+ 'Test' => new TestModelData()
+ ]);
+
+ $this->assertEquals($expected, $this->render("\$Test.Type({$templateArg})", $data));
+ }
+
+ #[DataProvider('typePreservationDataProvider')]
+ public function testTypesArePreservedAsIncludeArguments($expected, $templateArg)
+ {
+ $data = new ArrayData([
+ 'Test' => new TestModelData()
+ ]);
+
+ $this->assertEquals(
+ $expected,
+ $this->render("<% include SSTemplateEngineTestTypePreservation Argument={$templateArg} %>", $data)
+ );
+ }
+
+ public function testTypePreservationInConditionals()
+ {
+ $data = new ArrayData([
+ 'Test' => new TestModelData()
+ ]);
+
+ // Types in conditionals
+ $this->assertEquals('pass', $this->render('<% if true %>pass<% else %>fail<% end_if %>', $data));
+ $this->assertEquals('pass', $this->render('<% if false %>fail<% else %>pass<% end_if %>', $data));
+ $this->assertEquals('pass', $this->render('<% if 1 %>pass<% else %>fail<% end_if %>', $data));
+ $this->assertEquals('pass', $this->render('<% if 0 %>fail<% else %>pass<% end_if %>', $data));
+ }
+
+ public function testControls()
+ {
+ // Single item controls
+ $this->assertEquals(
+ 'a[out:Foo.Bar.Item]b
+ [out:Foo.Bar(Arg1).Item]
+ [out:Foo(Arg1).Item]
+ [out:Foo(Arg1,Arg2).Item]
+ [out:Foo(Arg1,Arg2,Arg3).Item]',
+ $this->render(
+ '<% with Foo.Bar %>a{$Item}b<% end_with %>
+ <% with Foo.Bar(Arg1) %>$Item<% end_with %>
+ <% with Foo(Arg1) %>$Item<% end_with %>
+ <% with Foo(Arg1, Arg2) %>$Item<% end_with %>
+ <% with Foo(Arg1, Arg2, Arg3) %>$Item<% end_with %>'
+ )
+ );
+
+ // Loop controls
+ $this->assertEquals(
+ 'a[out:Foo.Loop2.Item]ba[out:Foo.Loop2.Item]b',
+ $this->render('<% loop Foo.Loop2 %>a{$Item}b<% end_loop %>')
+ );
+
+ $this->assertEquals(
+ '[out:Foo.Loop2(Arg1).Item][out:Foo.Loop2(Arg1).Item]',
+ $this->render('<% loop Foo.Loop2(Arg1) %>$Item<% end_loop %>')
+ );
+
+ $this->assertEquals(
+ '[out:Loop2(Arg1).Item][out:Loop2(Arg1).Item]',
+ $this->render('<% loop Loop2(Arg1) %>$Item<% end_loop %>')
+ );
+
+ $this->assertEquals(
+ '[out:Loop2(Arg1,Arg2).Item][out:Loop2(Arg1,Arg2).Item]',
+ $this->render('<% loop Loop2(Arg1, Arg2) %>$Item<% end_loop %>')
+ );
+
+ $this->assertEquals(
+ '[out:Loop2(Arg1,Arg2,Arg3).Item][out:Loop2(Arg1,Arg2,Arg3).Item]',
+ $this->render('<% loop Loop2(Arg1, Arg2, Arg3) %>$Item<% end_loop %>')
+ );
+ }
+
+ public function testIfBlocks()
+ {
+ // Basic test
+ $this->assertEquals(
+ 'AC',
+ $this->render('A<% if NotSet %>B$NotSet<% end_if %>C')
+ );
+
+ // Nested test
+ $this->assertEquals(
+ 'AB1C',
+ $this->render('A<% if IsSet %>B$NotSet<% if IsSet %>1<% else %>2<% end_if %><% end_if %>C')
+ );
+
+ // else_if
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if NotSet %>B<% else_if IsSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ADE',
+ $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E')
+ );
+
+ $this->assertEquals(
+ 'ADE',
+ $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E')
+ );
+
+ // Dot syntax
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if Foo.NotSet %>B<% else_if Foo.IsSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if Foo.Bar.NotSet %>B<% else_if Foo.Bar.IsSet %>C<% end_if %>D')
+ );
+
+ // Params
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if NotSet(Param) %>B<% else %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ABD',
+ $this->render('A<% if IsSet(Param) %>B<% else %>C<% end_if %>D')
+ );
+
+ // Negation
+ $this->assertEquals(
+ 'AC',
+ $this->render('A<% if not IsSet %>B<% end_if %>C')
+ );
+ $this->assertEquals(
+ 'ABC',
+ $this->render('A<% if not NotSet %>B<% end_if %>C')
+ );
+
+ // Or
+ $this->assertEquals(
+ 'ABD',
+ $this->render('A<% if IsSet || NotSet %>B<% else_if A %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet3 %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet || NotSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet2 || NotSet3 %>C<% end_if %>D')
+ );
+
+ // Negated Or
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if not IsSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ABD',
+ $this->render('A<% if not NotSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ABD',
+ $this->render('A<% if NotSet || not AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
+ );
+
+ // And
+ $this->assertEquals(
+ 'ABD',
+ $this->render('A<% if IsSet && AlsoSet %>B<% else_if A %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet && NotSet2 %>B<% else_if NotSet3 %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet && AlsoSet %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet && NotSet2 %>B<% else_if IsSet && NotSet3 %>C<% end_if %>D')
+ );
+
+ // Equality
+ $this->assertEquals(
+ 'ABC',
+ $this->render('A<% if RawVal == RawVal %>B<% end_if %>C')
+ );
+ $this->assertEquals(
+ 'ACD',
+ $this->render('A<% if Right == Wrong %>B<% else_if RawVal == RawVal %>C<% end_if %>D')
+ );
+ $this->assertEquals(
+ 'ABC',
+ $this->render('A<% if Right != Wrong %>B<% end_if %>C')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% end_if %>D')
+ );
+
+ // test inequalities with simple numbers
+ $this->assertEquals('ABD', $this->render('A<% if 5 > 3 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ABD', $this->render('A<% if 5 >= 3 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 3 > 5 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 3 >= 5 %>B<% else %>C<% end_if %>D'));
+
+ $this->assertEquals('ABD', $this->render('A<% if 3 < 5 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ABD', $this->render('A<% if 3 <= 5 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 5 < 3 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 5 <= 3 %>B<% else %>C<% end_if %>D'));
+
+ $this->assertEquals('ABD', $this->render('A<% if 4 <= 4 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ABD', $this->render('A<% if 4 >= 4 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 4 > 4 %>B<% else %>C<% end_if %>D'));
+ $this->assertEquals('ACD', $this->render('A<% if 4 < 4 %>B<% else %>C<% end_if %>D'));
+
+ // empty else_if and else tags, if this would not be supported,
+ // the output would stop after A, thereby failing the assert
+ $this->assertEquals('AD', $this->render('A<% if IsSet %><% else %><% end_if %>D'));
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet %><% else_if IsSet %><% else %><% end_if %>D')
+ );
+ $this->assertEquals(
+ 'AD',
+ $this->render('A<% if NotSet %><% else_if AlsoNotSet %><% else %><% end_if %>D')
+ );
+
+ // Bare words with ending space
+ $this->assertEquals(
+ 'ABC',
+ $this->render('A<% if "RawVal" == RawVal %>B<% end_if %>C')
+ );
+
+ // Else
+ $this->assertEquals(
+ 'ADE',
+ $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% else %>D<% end_if %>E')
+ );
+
+ // Empty if with else
+ $this->assertEquals(
+ 'ABC',
+ $this->render('A<% if NotSet %><% else %>B<% end_if %>C')
+ );
+ }
+
+ public static function provideIfBlockWithIterable(): array
+ {
+ $scenarios = [
+ 'empty array' => [
+ 'iterable' => [],
+ 'inScope' => false,
+ ],
+ 'array' => [
+ 'iterable' => [1, 2, 3],
+ 'inScope' => false,
+ ],
+ 'ArrayList' => [
+ 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]),
+ 'inScope' => false,
+ ],
+ ];
+ foreach ($scenarios as $name => $scenario) {
+ $scenario['inScope'] = true;
+ $scenarios[$name . ' in scope'] = $scenario;
+ }
+ return $scenarios;
+ }
+
+ #[DataProvider('provideIfBlockWithIterable')]
+ public function testIfBlockWithIterable(iterable $iterable, bool $inScope): void
+ {
+ $expected = count($iterable) ? 'has value' : 'no value';
+ $data = new ArrayData(['Iterable' => $iterable]);
+ if ($inScope) {
+ $template = '<% with $Iterable %><% if $Me %>has value<% else %>no value<% end_if %><% end_with %>';
+ } else {
+ $template = '<% if $Iterable %>has value<% else %>no value<% end_if %>';
+ }
+ $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
+ }
+
+ public function testBaseTagGeneration()
+ {
+ // XHTML will have a closed base tag
+ $tmpl1 = '
+
+
+ <% base_tag %>
+ test
+ ';
+ $this->assertMatchesRegularExpression('/<\/head>/', $this->render($tmpl1));
+
+ // HTML4 and 5 will only have it for IE
+ $tmpl2 = '
+
+ <% base_tag %>
+ test
+ ';
+ $this->assertMatchesRegularExpression(
+ '/<\/head>/',
+ $this->render($tmpl2)
+ );
+
+
+ $tmpl3 = '
+
+ <% base_tag %>
+ test
+ ';
+ $this->assertMatchesRegularExpression(
+ '/<\/head>/',
+ $this->render($tmpl3)
+ );
+
+ // Check that the content negotiator converts to the equally legal formats
+ $negotiator = new ContentNegotiator();
+
+ $response = new HTTPResponse($this->render($tmpl1));
+ $negotiator->html($response);
+ $this->assertMatchesRegularExpression(
+ '/<\/head>/',
+ $response->getBody()
+ );
+
+ $response = new HTTPResponse($this->render($tmpl1));
+ $negotiator->xhtml($response);
+ $this->assertMatchesRegularExpression('/<\/head>/', $response->getBody());
+ }
+
+ public function testIncludeWithArguments()
+ {
+ $this->assertEquals(
+ '[out:Arg1]
[out:Arg2]
[out:Arg2.Count]
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments %>')
+ );
+
+ $this->assertEquals(
+ 'A
[out:Arg2]
[out:Arg2.Count]
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A %>')
+ );
+
+ $this->assertEquals(
+ 'A
B
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A, Arg2=B %>')
+ );
+
+ $this->assertEquals(
+ 'A Bare String
B Bare String
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A Bare String, Arg2=B Bare String %>')
+ );
+
+ $this->assertEquals(
+ 'A
Bar
',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=$B %>',
+ new ArrayData(['B' => 'Bar'])
+ )
+ );
+
+ $this->assertEquals(
+ 'A
Bar
',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeWithArguments Arg1="A" %>',
+ new ArrayData(['Arg1' => 'Foo', 'Arg2' => 'Bar'])
+ )
+ );
+
+ $this->assertEquals(
+ 'A
0
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=0 %>')
+ );
+
+ $this->assertEquals(
+ 'A
',
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=false %>')
+ );
+
+ $this->assertEquals(
+ 'A
',
+ // Note Arg2 is explicitly overridden with null
+ $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=null %>')
+ );
+
+ $this->assertEquals(
+ 'SomeArg - Foo - Bar - SomeArg',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInLoop Title="SomeArg" %>',
+ new ArrayData(
+ ['Items' => new ArrayList(
+ [
+ new ArrayData(['Title' => 'Foo']),
+ new ArrayData(['Title' => 'Bar'])
+ ]
+ )]
+ )
+ )
+ );
+
+ $this->assertEquals(
+ 'A - B - A',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInWith Title="A" %>',
+ new ArrayData(['Item' => new ArrayData(['Title' =>'B'])])
+ )
+ );
+
+ $this->assertEquals(
+ 'A - B - C - B - A',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInNestedWith Title="A" %>',
+ new ArrayData(
+ [
+ 'Item' => new ArrayData(
+ [
+ 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C'])
+ ]
+ )]
+ )
+ )
+ );
+
+ $this->assertEquals(
+ 'A - A - A',
+ $this->render(
+ '<% include SSTemplateEngineTestIncludeScopeInheritanceWithUpAndTop Title="A" %>',
+ new ArrayData(
+ [
+ 'Item' => new ArrayData(
+ [
+ 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C'])
+ ]
+ )]
+ )
+ )
+ );
+
+ $data = new ArrayData(
+ [
+ 'Nested' => new ArrayData(
+ [
+ 'Object' => new ArrayData(['Key' => 'A'])
+ ]
+ ),
+ 'Object' => new ArrayData(['Key' => 'B'])
+ ]
+ );
+
+ $res = $this->render('<% include SSTemplateEngineTestIncludeObjectArguments A=$Nested.Object, B=$Object %>', $data);
+ $this->assertEqualIgnoringWhitespace('A B', $res, 'Objects can be passed as named arguments');
+ }
+
+ public function testNamespaceInclude()
+ {
+ $data = new ArrayData([]);
+
+ $this->assertEquals(
+ "tests:( NamespaceInclude\n )",
+ $this->render('tests:( <% include Namespace\NamespaceInclude %> )', $data),
+ 'Backslashes work for namespace references in includes'
+ );
+
+ $this->assertEquals(
+ "tests:( NamespaceInclude\n )",
+ $this->render('tests:( <% include Namespace\\NamespaceInclude %> )', $data),
+ 'Escaped backslashes work for namespace references in includes'
+ );
+
+ $this->assertEquals(
+ "tests:( NamespaceInclude\n )",
+ $this->render('tests:( <% include Namespace/NamespaceInclude %> )', $data),
+ 'Forward slashes work for namespace references in includes'
+ );
+ }
+
+ /**
+ * Test search for includes fallback to non-includes folder
+ */
+ public function testIncludeFallbacks()
+ {
+ $data = new ArrayData([]);
+
+ $this->assertEquals(
+ "tests:( Namespace/Includes/IncludedTwice.ss\n )",
+ $this->render('tests:( <% include Namespace\\IncludedTwice %> )', $data),
+ 'Prefer Includes in the Includes folder'
+ );
+
+ $this->assertEquals(
+ "tests:( Namespace/Includes/IncludedOnceSub.ss\n )",
+ $this->render('tests:( <% include Namespace\\IncludedOnceSub %> )', $data),
+ 'Includes in only Includes folder can be found'
+ );
+
+ $this->assertEquals(
+ "tests:( Namespace/IncludedOnceBase.ss\n )",
+ $this->render('tests:( <% include Namespace\\IncludedOnceBase %> )', $data),
+ 'Includes outside of Includes folder can be found'
+ );
+ }
+
+ public function testRecursiveInclude()
+ {
+ $data = new ArrayData(
+ [
+ 'Title' => 'A',
+ 'Children' => new ArrayList(
+ [
+ new ArrayData(
+ [
+ 'Title' => 'A1',
+ 'Children' => new ArrayList(
+ [
+ new ArrayData([ 'Title' => 'A1 i', ]),
+ new ArrayData([ 'Title' => 'A1 ii', ]),
+ ]
+ ),
+ ]
+ ),
+ new ArrayData([ 'Title' => 'A2', ]),
+ new ArrayData([ 'Title' => 'A3', ]),
+ ]
+ ),
+ ]
+ );
+
+ $engine = new SSTemplateEngine('Includes/SSTemplateEngineTestRecursiveInclude');
+ $result = $engine->render(new ViewLayerData($data));
+ // We don't care about whitespace
+ $rationalisedResult = trim(preg_replace('/\s+/', ' ', $result ?? '') ?? '');
+
+ $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
+ }
+
+ /**
+ * See {@link ModelDataTest} for more extensive casting tests,
+ * this test just ensures that basic casting is correctly applied during template parsing.
+ */
+ public function testCastingHelpers()
+ {
+ $vd = new SSTemplateEngineTest\TestModelData();
+ $vd->TextValue = 'html';
+ $vd->HTMLValue = 'html';
+ $vd->UncastedValue = 'html';
+
+ // Value casted as "Text"
+ $this->assertEquals(
+ '<b>html</b>',
+ $this->render('$TextValue', $vd)
+ );
+ $this->assertEquals(
+ 'html',
+ $this->render('$TextValue.RAW', $vd)
+ );
+ $this->assertEquals(
+ '<b>html</b>',
+ $this->render('$TextValue.XML', $vd)
+ );
+
+ // Value casted as "HTMLText"
+ $this->assertEquals(
+ 'html',
+ $this->render('$HTMLValue', $vd)
+ );
+ $this->assertEquals(
+ 'html',
+ $this->render('$HTMLValue.RAW', $vd)
+ );
+ $this->assertEquals(
+ '<b>html</b>',
+ $this->render('$HTMLValue.XML', $vd)
+ );
+
+ // Uncasted value (falls back to the relevant DBField class for the data type)
+ $vd = new SSTemplateEngineTest\TestModelData();
+ $vd->UncastedValue = 'html';
+ $this->assertEquals(
+ '<b>html</b>',
+ $this->render('$UncastedValue', $vd)
+ );
+ $this->assertEquals(
+ 'html',
+ $this->render('$UncastedValue.RAW', $vd)
+ );
+ $this->assertEquals(
+ '<b>html</b>',
+ $this->render('$UncastedValue.XML', $vd)
+ );
+ }
+
+ public static function provideLoop(): array
+ {
+ return [
+ 'nested array and iterator' => [
+ 'iterable' => [
+ [
+ 'value 1',
+ 'value 2',
+ ],
+ new ArrayList([
+ 'value 3',
+ 'value 4',
+ ]),
+ ],
+ 'template' => '<% loop $Iterable %><% loop $Me %>$Me<% end_loop %><% end_loop %>',
+ 'expected' => 'value 1 value 2 value 3 value 4',
+ ],
+ 'nested associative arrays' => [
+ 'iterable' => [
+ [
+ 'Foo' => 'one',
+ ],
+ [
+ 'Foo' => 'two',
+ ],
+ [
+ 'Foo' => 'three',
+ ],
+ ],
+ 'template' => '<% loop $Iterable %>$Foo<% end_loop %>',
+ 'expected' => 'one two three',
+ ],
+ ];
+ }
+
+ #[DataProvider('provideLoop')]
+ public function testLoop(iterable $iterable, string $template, string $expected): void
+ {
+ $data = new ArrayData(['Iterable' => $iterable]);
+ $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
+ }
+
+ public static function provideCountIterable(): array
+ {
+ $scenarios = [
+ 'empty array' => [
+ 'iterable' => [],
+ 'inScope' => false,
+ ],
+ 'array' => [
+ 'iterable' => [1, 2, 3],
+ 'inScope' => false,
+ ],
+ 'ArrayList' => [
+ 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]),
+ 'inScope' => false,
+ ],
+ ];
+ foreach ($scenarios as $name => $scenario) {
+ $scenario['inScope'] = true;
+ $scenarios[$name . ' in scope'] = $scenario;
+ }
+ return $scenarios;
+ }
+
+ #[DataProvider('provideCountIterable')]
+ public function testCountIterable(iterable $iterable, bool $inScope): void
+ {
+ $expected = count($iterable);
+ $data = new ArrayData(['Iterable' => $iterable]);
+ if ($inScope) {
+ $template = '<% with $Iterable %>$Count<% end_with %>';
+ } else {
+ $template = '$Iterable.Count';
+ }
+ $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
+ }
+
+ public function testSSViewerBasicIteratorSupport()
+ {
+ $data = new ArrayData(
+ [
+ 'Set' => new ArrayList(
+ [
+ new SSTemplateEngineTest\TestObject("1"),
+ new SSTemplateEngineTest\TestObject("2"),
+ new SSTemplateEngineTest\TestObject("3"),
+ new SSTemplateEngineTest\TestObject("4"),
+ new SSTemplateEngineTest\TestObject("5"),
+ new SSTemplateEngineTest\TestObject("6"),
+ new SSTemplateEngineTest\TestObject("7"),
+ new SSTemplateEngineTest\TestObject("8"),
+ new SSTemplateEngineTest\TestObject("9"),
+ new SSTemplateEngineTest\TestObject("10"),
+ ]
+ )
+ ]
+ );
+
+ //base test
+ $result = $this->render('<% loop Set %>$Number<% end_loop %>', $data);
+ $this->assertEquals("12345678910", $result, "Numbers rendered in order");
+
+ //test First
+ $result = $this->render('<% loop Set %><% if $IsFirst %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("1", $result, "Only the first number is rendered");
+
+ //test Last
+ $result = $this->render('<% loop Set %><% if $IsLast %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("10", $result, "Only the last number is rendered");
+
+ //test Even
+ $result = $this->render('<% loop Set %><% if $Even() %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("246810", $result, "Even numbers rendered in order");
+
+ //test Even with quotes
+ $result = $this->render('<% loop Set %><% if $Even("1") %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("246810", $result, "Even numbers rendered in order");
+
+ //test Even without quotes
+ $result = $this->render('<% loop Set %><% if $Even(1) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("246810", $result, "Even numbers rendered in order");
+
+ //test Even with zero-based start index
+ $result = $this->render('<% loop Set %><% if $Even("0") %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("13579", $result, "Even (with zero-based index) numbers rendered in order");
+
+ //test Odd
+ $result = $this->render('<% loop Set %><% if $Odd %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("13579", $result, "Odd numbers rendered in order");
+
+ //test FirstLast
+ $result = $this->render('<% loop Set %><% if $FirstLast %>$Number$FirstLast<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("1first10last", $result, "First and last numbers rendered in order");
+
+ //test Middle
+ $result = $this->render('<% loop Set %><% if $Middle %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("23456789", $result, "Middle numbers rendered in order");
+
+ //test MiddleString
+ $result = $this->render(
+ '<% loop Set %><% if MiddleString == "middle" %>$Number$MiddleString<% end_if %>'
+ . '<% end_loop %>',
+ $data
+ );
+ $this->assertEquals(
+ "2middle3middle4middle5middle6middle7middle8middle9middle",
+ $result,
+ "Middle numbers rendered in order"
+ );
+
+ //test EvenOdd
+ $result = $this->render('<% loop Set %>$EvenOdd<% end_loop %>', $data);
+ $this->assertEquals(
+ "oddevenoddevenoddevenoddevenoddeven",
+ $result,
+ "Even and Odd is returned in sequence numbers rendered in order"
+ );
+
+ //test Pos
+ $result = $this->render('<% loop Set %>$Pos<% end_loop %>', $data);
+ $this->assertEquals("12345678910", $result, '$Pos is rendered in order');
+
+ //test Pos
+ $result = $this->render('<% loop Set %>$Pos(0)<% end_loop %>', $data);
+ $this->assertEquals("0123456789", $result, '$Pos(0) is rendered in order');
+
+ //test FromEnd
+ $result = $this->render('<% loop Set %>$FromEnd<% end_loop %>', $data);
+ $this->assertEquals("10987654321", $result, '$FromEnd is rendered in order');
+
+ //test FromEnd
+ $result = $this->render('<% loop Set %>$FromEnd(0)<% end_loop %>', $data);
+ $this->assertEquals("9876543210", $result, '$FromEnd(0) rendered in order');
+
+ //test Total
+ $result = $this->render('<% loop Set %>$TotalItems<% end_loop %>', $data);
+ $this->assertEquals("10101010101010101010", $result, "10 total items X 10 are returned");
+
+ //test Modulus
+ $result = $this->render('<% loop Set %>$Modulus(2,1)<% end_loop %>', $data);
+ $this->assertEquals("1010101010", $result, "1-indexed pos modular divided by 2 rendered in order");
+
+ //test MultipleOf 3
+ $result = $this->render('<% loop Set %><% if MultipleOf(3) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("369", $result, "Only numbers that are multiples of 3 are returned");
+
+ //test MultipleOf 4
+ $result = $this->render('<% loop Set %><% if MultipleOf(4) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("48", $result, "Only numbers that are multiples of 4 are returned");
+
+ //test MultipleOf 5
+ $result = $this->render('<% loop Set %><% if MultipleOf(5) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("510", $result, "Only numbers that are multiples of 5 are returned");
+
+ //test MultipleOf 10
+ $result = $this->render('<% loop Set %><% if MultipleOf(10,1) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("10", $result, "Only numbers that are multiples of 10 (with 1-based indexing) are returned");
+
+ //test MultipleOf 9 zero-based
+ $result = $this->render('<% loop Set %><% if MultipleOf(9,0) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals(
+ "110",
+ $result,
+ "Only numbers that are multiples of 9 with zero-based indexing are returned. (The first and last item)"
+ );
+
+ //test MultipleOf 11
+ $result = $this->render('<% loop Set %><% if MultipleOf(11) %>$Number<% end_if %><% end_loop %>', $data);
+ $this->assertEquals("", $result, "Only numbers that are multiples of 11 are returned. I.e. nothing returned");
+ }
+
+ /**
+ * Test $Up works when the scope $Up refers to was entered with a "with" block
+ */
+ public function testUpInWith()
+ {
+
+ // Data to run the loop tests on - three levels deep
+ $data = new ArrayData(
+ [
+ 'Name' => 'Top',
+ 'Foo' => new ArrayData(
+ [
+ 'Name' => 'Foo',
+ 'Bar' => new ArrayData(
+ [
+ 'Name' => 'Bar',
+ 'Baz' => new ArrayData(
+ [
+ 'Name' => 'Baz'
+ ]
+ ),
+ 'Qux' => new ArrayData(
+ [
+ 'Name' => 'Qux'
+ ]
+ )
+ ]
+ )
+ ]
+ )
+ ]
+ );
+
+ // Basic functionality
+ $this->assertEquals(
+ 'BarFoo',
+ $this->render('<% with Foo %><% with Bar %>{$Name}{$Up.Name}<% end_with %><% end_with %>', $data)
+ );
+
+ // Two level with block, up refers to internally referenced Bar
+ $this->assertEquals(
+ 'BarTop',
+ $this->render('<% with Foo.Bar %>{$Name}{$Up.Name}<% end_with %>', $data)
+ );
+
+ // Stepping up & back down the scope tree
+ $this->assertEquals(
+ 'BazFooBar',
+ $this->render('<% with Foo.Bar.Baz %>{$Name}{$Up.Foo.Name}{$Up.Foo.Bar.Name}<% end_with %>', $data)
+ );
+
+ // Using $Up in a with block
+ $this->assertEquals(
+ 'BazTopBar',
+ $this->render(
+ '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}{$Foo.Bar.Name}<% end_with %>'
+ . '<% end_with %>',
+ $data
+ )
+ );
+
+ // Stepping up & back down the scope tree with with blocks
+ $this->assertEquals(
+ 'BazTopBarTopBaz',
+ $this->render(
+ '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}<% with Foo.Bar %>{$Name}<% end_with %>'
+ . '{$Name}<% end_with %>{$Name}<% end_with %>',
+ $data
+ )
+ );
+
+ // Using $Up.Up, where first $Up points to a previous scope entered using $Up, thereby skipping up to Foo
+ $this->assertEquals(
+ 'Foo',
+ $this->render(
+ '<% with Foo %><% with Bar %><% with Baz %>{$Up.Up.Name}<% end_with %><% end_with %>'
+ . '<% end_with %>',
+ $data
+ )
+ );
+
+ // Using $Up as part of a lookup chain in <% with %>
+ $this->assertEquals(
+ 'Top',
+ $this->render('<% with Foo.Bar.Baz.Up.Qux %>{$Up.Name}<% end_with %>', $data)
+ );
+ }
+
+ public function testTooManyUps()
+ {
+ $this->expectException(LogicException::class);
+ $this->expectExceptionMessage("Up called when we're already at the top of the scope");
+ $data = new ArrayData([
+ 'Foo' => new ArrayData([
+ 'Name' => 'Foo',
+ 'Bar' => new ArrayData([
+ 'Name' => 'Bar'
+ ])
+ ])
+ ]);
+
+ $this->assertEquals(
+ 'Foo',
+ $this->render('<% with Foo.Bar %>{$Up.Up.Name}<% end_with %>', $data)
+ );
+ }
+
+ /**
+ * Test $Up works when the scope $Up refers to was entered with a "loop" block
+ */
+ public function testUpInLoop()
+ {
+
+ // Data to run the loop tests on - one sequence of three items, each with a subitem
+ $data = new ArrayData(
+ [
+ 'Name' => 'Top',
+ 'Foo' => new ArrayList(
+ [
+ new ArrayData(
+ [
+ 'Name' => '1',
+ 'Sub' => new ArrayData(
+ [
+ 'Name' => 'Bar'
+ ]
+ )
+ ]
+ ),
+ new ArrayData(
+ [
+ 'Name' => '2',
+ 'Sub' => new ArrayData(
+ [
+ 'Name' => 'Baz'
+ ]
+ )
+ ]
+ ),
+ new ArrayData(
+ [
+ 'Name' => '3',
+ 'Sub' => new ArrayData(
+ [
+ 'Name' => 'Qux'
+ ]
+ )
+ ]
+ )
+ ]
+ )
+ ]
+ );
+
+ // Make sure inside a loop, $Up refers to the current item of the loop
+ $this->assertEqualIgnoringWhitespace(
+ '111 222 333',
+ $this->render(
+ '<% loop $Foo %>$Name<% with $Sub %>$Up.Name<% end_with %>$Name<% end_loop %>',
+ $data
+ )
+ );
+
+ // Make sure inside a loop, looping over $Up uses a separate iterator,
+ // and doesn't interfere with the original iterator
+ $this->assertEqualIgnoringWhitespace(
+ '1Bar123Bar1 2Baz123Baz2 3Qux123Qux3',
+ $this->render(
+ '<% loop $Foo %>
+ $Name
+ <% with $Sub %>
+ $Name
+ <% loop $Up %>$Name<% end_loop %>
+ $Name
+ <% end_with %>
+ $Name
+ <% end_loop %>',
+ $data
+ )
+ );
+
+ // Make sure inside a loop, looping over $Up uses a separate iterator,
+ // and doesn't interfere with the original iterator or local lookups
+ $this->assertEqualIgnoringWhitespace(
+ '1 Bar1 123 1Bar 1 2 Baz2 123 2Baz 2 3 Qux3 123 3Qux 3',
+ $this->render(
+ '<% loop $Foo %>
+ $Name
+ <% with $Sub %>
+ {$Name}{$Up.Name}
+ <% loop $Up %>$Name<% end_loop %>
+ {$Up.Name}{$Name}
+ <% end_with %>
+ $Name
+ <% end_loop %>',
+ $data
+ )
+ );
+ }
+
+ /**
+ * Test that nested loops restore the loop variables correctly when pushing and popping states
+ */
+ public function testNestedLoops()
+ {
+
+ // Data to run the loop tests on - one sequence of three items, one with child elements
+ // (of a different size to the main sequence)
+ $data = new ArrayData(
+ [
+ 'Foo' => new ArrayList(
+ [
+ new ArrayData(
+ [
+ 'Name' => '1',
+ 'Children' => new ArrayList(
+ [
+ new ArrayData(
+ [
+ 'Name' => 'a'
+ ]
+ ),
+ new ArrayData(
+ [
+ 'Name' => 'b'
+ ]
+ ),
+ ]
+ ),
+ ]
+ ),
+ new ArrayData(
+ [
+ 'Name' => '2',
+ 'Children' => new ArrayList(),
+ ]
+ ),
+ new ArrayData(
+ [
+ 'Name' => '3',
+ 'Children' => new ArrayList(),
+ ]
+ ),
+ ]
+ ),
+ ]
+ );
+
+ // Make sure that including a loop inside a loop will not destroy the internal count of
+ // items, checked by using "Last"
+ $this->assertEqualIgnoringWhitespace(
+ '1ab23last',
+ $this->render(
+ '<% loop $Foo %>$Name<% loop Children %>$Name<% end_loop %><% if $IsLast %>last<% end_if %>'
+ . '<% end_loop %>',
+ $data
+ )
+ );
+ }
+
+ public function testLayout()
+ {
+ $this->useTestTheme(
+ __DIR__ . '/SSTemplateEngineTest',
+ 'layouttest',
+ function () {
+ $engine = new SSTemplateEngine('Page');
+ $this->assertEquals("Foo\n\n", $engine->render(new ViewLayerData([])));
+
+ $engine = new SSTemplateEngine(['Shortcodes', 'Page']);
+ $this->assertEquals("[file_link]\n\n", $engine->render(new ViewLayerData([])));
+ }
+ );
+ }
+
+ public static function provideRenderWithSourceFileComments(): array
+ {
+ $i = __DIR__ . '/SSTemplateEngineTest/templates/Includes';
+ $f = __DIR__ . '/SSTemplateEngineTest/templates/SSTemplateEngineTestComments';
+ return [
+ [
+ 'name' => 'SSTemplateEngineTestCommentsFullSource',
+ 'expected' => ""
+ . ""
+ . ""
+ . ""
+ . "\t"
+ . "\t"
+ . ""
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsFullSourceHTML4Doctype',
+ 'expected' => ""
+ . ""
+ . ""
+ . ""
+ . "\t"
+ . "\t"
+ . ""
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsFullSourceNoDoctype',
+ 'expected' => ""
+ . ""
+ . "\t"
+ . "\t"
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsFullSourceIfIE',
+ 'expected' => ""
+ . ""
+ . ""
+ . ""
+ . ""
+ . " "
+ . "\t"
+ . "\t"
+ . ""
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsFullSourceIfIENoDoctype',
+ 'expected' => ""
+ . ""
+ . ""
+ . " "
+ . ""
+ . " "
+ . "\t"
+ . "\t"
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsPartialSource',
+ 'expected' =>
+ ""
+ . ""
+ . "",
+ ],
+ [
+ 'name' => 'SSTemplateEngineTestCommentsWithInclude',
+ 'expected' =>
+ ""
+ . ""
+ . ""
+ . ""
+ . "Included"
+ . ""
+ . ""
+ . "
"
+ . "",
+ ],
+ ];
+ }
+
+ #[DataProvider('provideRenderWithSourceFileComments')]
+ public function testRenderWithSourceFileComments(string $name, string $expected)
+ {
+ SSViewer::config()->set('source_file_comments', true);
+ $this->_renderWithSourceFileComments('SSTemplateEngineTestComments/' . $name, $expected);
+ }
+
+ public static function provideRenderWithMissingTemplate(): array
+ {
+ return [
+ [
+ 'templateCandidates' => [],
+ ],
+ [
+ 'templateCandidates' => '',
+ ],
+ [
+ 'templateCandidates' => ['noTemplate'],
+ ],
+ [
+ 'templateCandidates' => 'noTemplate',
+ ],
+ ];
+ }
+
+ #[DataProvider('provideRenderWithMissingTemplate')]
+ public function testRenderWithMissingTemplate(string|array $templateCandidates): void
+ {
+ if (empty($templateCandidates)) {
+ $message = 'No template to render. Try calling setTemplate() or passing template candidates into the constructor.';
+ } else {
+ $message = 'None of the following templates could be found: '
+ . print_r($templateCandidates, true)
+ . ' in themes "' . print_r(SSViewer::get_themes(), true) . '"';
+ }
+ $engine = new SSTemplateEngine($templateCandidates);
+ $this->expectException(MissingTemplateException::class);
+ $this->expectExceptionMessage($message);
+ $engine->render(new ViewLayerData([]));
+ }
+
+ public function testLoopIteratorIterator()
+ {
+ $list = new PaginatedList(new ArrayList());
+ $result = $this->render(
+ '<% loop List %>$ID - $FirstName
<% end_loop %>',
+ new ArrayData(['List' => $list])
+ );
+ $this->assertEquals('', $result);
+ }
+
+ public static function provideCallsWithArguments(): array
+ {
+ return [
+ [
+ 'template' => '$Level.output(1)',
+ 'expected' => '1-1',
+ ],
+ [
+ 'template' => '$Nest.Level.output($Set.First.Number)',
+ 'expected' => '2-1',
+ ],
+ [
+ 'template' => '<% with $Set %>$Up.Level.output($First.Number)<% end_with %>',
+ 'expected' => '1-1',
+ ],
+ [
+ 'template' => '<% with $Set %>$Top.Nest.Level.output($First.Number)<% end_with %>',
+ 'expected' => '2-1',
+ ],
+ [
+ 'template' => '<% loop $Set %>$Up.Nest.Level.output($Number)<% end_loop %>',
+ 'expected' => '2-12-22-32-42-5',
+ ],
+ [
+ 'template' => '<% loop $Set %>$Top.Level.output($Number)<% end_loop %>',
+ 'expected' => '1-11-21-31-41-5',
+ ],
+ [
+ 'template' => '<% with $Nest %>$Level.output($Top.Set.First.Number)<% end_with %>',
+ 'expected' => '2-1',
+ ],
+ [
+ 'template' => '<% with $Level %>$output($Up.Set.Last.Number)<% end_with %>',
+ 'expected' => '1-5',
+ ],
+ [
+ 'template' => '<% with $Level.forWith($Set.Last.Number) %>$output("hi")<% end_with %>',
+ 'expected' => '5-hi',
+ ],
+ [
+ 'template' => '<% loop $Level.forLoop($Set.First.Number) %>$Number<% end_loop %>',
+ 'expected' => '!0',
+ ],
+ [
+ 'template' => '<% with $Nest %>
+ <% with $Level.forWith($Up.Set.First.Number) %>$output("hi")<% end_with %>
+ <% end_with %>',
+ 'expected' => '1-hi',
+ ],
+ [
+ 'template' => '<% with $Nest %>
+ <% loop $Level.forLoop($Top.Set.Last.Number) %>$Number<% end_loop %>
+ <% end_with %>',
+ 'expected' => '!0!1!2!3!4',
+ ],
+ ];
+ }
+
+ #[DataProvider('provideCallsWithArguments')]
+ public function testCallsWithArguments(string $template, string $expected): void
+ {
+ $data = new ArrayData(
+ [
+ 'Set' => new ArrayList(
+ [
+ new SSTemplateEngineTest\TestObject("1"),
+ new SSTemplateEngineTest\TestObject("2"),
+ new SSTemplateEngineTest\TestObject("3"),
+ new SSTemplateEngineTest\TestObject("4"),
+ new SSTemplateEngineTest\TestObject("5"),
+ ]
+ ),
+ 'Level' => new SSTemplateEngineTest\LevelTestData(1),
+ 'Nest' => [
+ 'Level' => new SSTemplateEngineTest\LevelTestData(2),
+ ],
+ ]
+ );
+
+ $this->assertEquals($expected, trim($this->render($template, $data) ?? ''));
+ }
+
+ public function testRepeatedCallsAreCached()
+ {
+ $data = new SSTemplateEngineTest\CacheTestData();
+ $template = '
+ <% if $TestWithCall %>
+ <% with $TestWithCall %>
+ {$Message}
+ <% end_with %>
+
+ {$TestWithCall.Message}
+ <% end_if %>';
+
+ $this->assertEquals('HiHi', preg_replace('/\s+/', '', $this->render($template, $data) ?? ''));
+ $this->assertEquals(
+ 1,
+ $data->testWithCalls,
+ 'SSTemplateEngineTest_CacheTestData::TestWithCall() should only be called once. Subsequent calls should be cached'
+ );
+
+ $data = new SSTemplateEngineTest\CacheTestData();
+ $template = '
+ <% if $TestLoopCall %>
+ <% loop $TestLoopCall %>
+ {$Message}
+ <% end_loop %>
+ <% end_if %>';
+
+ $this->assertEquals('OneTwo', preg_replace('/\s+/', '', $this->render($template, $data) ?? ''));
+ $this->assertEquals(
+ 1,
+ $data->testLoopCalls,
+ 'SSTemplateEngineTest_CacheTestData::TestLoopCall() should only be called once. Subsequent calls should be cached'
+ );
+ }
+
+ public function testClosedBlockExtension()
+ {
+ $count = 0;
+ $parser = new SSTemplateParser();
+ $parser->addClosedBlock(
+ 'test',
+ function () use (&$count) {
+ $count++;
+ }
+ );
+
+ $engine = new SSTemplateEngine('SSTemplateEngineTestRecursiveInclude');
+ $engine->setParser($parser);
+ $engine->renderString('<% test %><% end_test %>', new ViewLayerData([]));
+
+ $this->assertEquals(1, $count);
+ }
+
+ public function testOpenBlockExtension()
+ {
+ $count = 0;
+ $parser = new SSTemplateParser();
+ $parser->addOpenBlock(
+ 'test',
+ function () use (&$count) {
+ $count++;
+ }
+ );
+
+ $engine = new SSTemplateEngine('SSTemplateEngineTestRecursiveInclude');
+ $engine->setParser($parser);
+ $engine->renderString('<% test %>', new ViewLayerData([]));
+
+ $this->assertEquals(1, $count);
+ }
+
+ public function testFromStringCaching()
+ {
+ $content = 'Test content';
+ $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache.' . sha1($content ?? '');
+ if (file_exists($cacheFile ?? '')) {
+ unlink($cacheFile ?? '');
+ }
+
+ // Test instance behaviors
+ $this->render($content, cache: false);
+ $this->assertFileDoesNotExist($cacheFile, 'Cache file was created when caching was off');
+
+ $this->render($content, cache: true);
+ $this->assertFileExists($cacheFile, 'Cache file wasn\'t created when it was meant to');
+ unlink($cacheFile ?? '');
+ }
+
+ public function testPrimitivesConvertedToDBFields()
+ {
+ $data = new ArrayData([
+ // null value should not be rendered, though should also not throw exception
+ 'Foo' => new ArrayList(['hello', true, 456, 7.89, null])
+ ]);
+ $this->assertEqualIgnoringWhitespace(
+ 'hello 1 456 7.89',
+ $this->render('<% loop $Foo %>$Me<% end_loop %>', $data)
+ );
+ }
+
+ #[DoesNotPerformAssertions]
+ public function testMe(): void
+ {
+ $myArrayData = new class extends ArrayData {
+ public function forTemplate(): string
+ {
+ return '';
+ }
+ };
+ $this->render('$Me', $myArrayData);
+ }
+
+ public function testLoopingThroughArrayInOverlay(): void
+ {
+ $modelData = new ModelData();
+ $theArray = [
+ ['Val' => 'one'],
+ ['Val' => 'two'],
+ ['Val' => 'red'],
+ ['Val' => 'blue'],
+ ];
+ $engine = new SSTemplateEngine('SSTemplateEngineTestLoopArray');
+ $output = $engine->render(new ViewLayerData($modelData), ['MyArray' => $theArray]);
+ $this->assertEqualIgnoringWhitespace('one two red blue', $output);
+ }
+
+ public static function provideGetterMethod(): array
+ {
+ return [
+ 'as property (not getter)' => [
+ 'template' => '$MyProperty',
+ 'expected' => 'Nothing passed in',
+ ],
+ 'as method (not getter)' => [
+ 'template' => '$MyProperty()',
+ 'expected' => 'Nothing passed in',
+ ],
+ 'as method (not getter), with arg' => [
+ 'template' => '$MyProperty("Some Value")',
+ 'expected' => 'Was passed in: Some Value',
+ ],
+ 'as property (getter)' => [
+ 'template' => '$getMyProperty',
+ 'expected' => 'Nothing passed in',
+ ],
+ 'as method (getter)' => [
+ 'template' => '$getMyProperty()',
+ 'expected' => 'Nothing passed in',
+ ],
+ 'as method (getter), with arg' => [
+ 'template' => '$getMyProperty("Some Value")',
+ 'expected' => 'Was passed in: Some Value',
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetterMethod')]
+ public function testGetterMethod(string $template, string $expected): void
+ {
+ $model = new SSTemplateEngineTest\TestObject();
+ $this->assertSame($expected, $this->render($template, $model));
+ }
+
+ /**
+ * Small helper to render templates from strings
+ */
+ private function render(string $templateString, mixed $data = null, array $overlay = [], bool $cache = false): string
+ {
+ $engine = new SSTemplateEngine();
+ if ($data === null) {
+ $data = new SSTemplateEngineTest\TestFixture();
+ }
+ $data = new ViewLayerData($data);
+ return trim('' . $engine->renderString($templateString, $data, $overlay, $cache));
+ }
+
+ private function _renderWithSourceFileComments($name, $expected)
+ {
+ $viewer = new SSViewer([$name]);
+ $data = new ArrayData([]);
+ $result = $viewer->process($data);
+ $expected = str_replace(["\r", "\n"], '', $expected ?? '');
+ $result = str_replace(["\r", "\n"], '', $result ?? '');
+ $this->assertEquals($result, $expected);
+ }
+
+ private function getScopeInheritanceTestData()
+ {
+ return new ArrayData([
+ 'Title' => 'TopTitleValue',
+ 'Items' => new ArrayList([
+ new ArrayData(['Title' => 'Item 1']),
+ new ArrayData(['Title' => 'Item 2']),
+ new ArrayData(['Title' => 'Item 3']),
+ new ArrayData(['Title' => 'Item 4']),
+ new ArrayData(['Title' => 'Item 5']),
+ new ArrayData(['Title' => 'Item 6'])
+ ])
+ ]);
+ }
+
+ private function assertExpectedStrings($result, $expected)
+ {
+ foreach ($expected as $expectedStr) {
+ $this->assertTrue(
+ (boolean) preg_match("/{$expectedStr}/", $result ?? ''),
+ "Didn't find '{$expectedStr}' in:\n{$result}"
+ );
+ }
+ }
+
+ private function assertEqualIgnoringWhitespace($a, $b, $message = '')
+ {
+ $this->assertEquals(preg_replace('/\s+/', '', $a ?? ''), preg_replace('/\s+/', '', $b ?? ''), $message);
+ }
+}
diff --git a/tests/php/View/SSViewerTest/CacheTestData.php b/tests/php/View/SSTemplateEngineTest/CacheTestData.php
similarity index 92%
rename from tests/php/View/SSViewerTest/CacheTestData.php
rename to tests/php/View/SSTemplateEngineTest/CacheTestData.php
index 3be03ae74..b155b9826 100644
--- a/tests/php/View/SSViewerTest/CacheTestData.php
+++ b/tests/php/View/SSTemplateEngineTest/CacheTestData.php
@@ -1,6 +1,6 @@
name = $name;
+ }
+
+ public function __call(string $name, array $arguments = []): static|array|null
+ {
+ return $this->getValue($name, $arguments);
+ }
+
+ public function __get(string $name): static|array|null
+ {
+ return $this->getValue($name);
+ }
+
+ public function __isset(string $name): bool
+ {
+ if (preg_match('/NotSet/i', $name)) {
+ return false;
+ }
+ $reflectionScope = new ReflectionClass(SSViewer_Scope::class);
+ $globalProperties = $reflectionScope->getStaticPropertyValue('globalProperties');
+ if (array_key_exists($name, $globalProperties)) {
+ return false;
+ }
+ return true;
+ }
+
+ public function __toString(): string
+ {
+ if (preg_match('/NotSet/i', $this->name ?? '')) {
+ return '';
+ }
+ if (preg_match('/Raw/i', $this->name ?? '')) {
+ return $this->name ?? '';
+ }
+ return '[out:' . $this->name . ']';
+ }
+
+ private function getValue(string $name, array $arguments = []): static|array|null
+ {
+ $childName = $this->argedName($name, $arguments);
+
+ // Special field name Loop### to create a list
+ if (preg_match('/^Loop([0-9]+)$/', $name ?? '', $matches)) {
+ $output = [];
+ for ($i = 0; $i < $matches[1]; $i++) {
+ $output[] = new TestFixture($childName);
+ }
+ return $output;
+ }
+
+ if (preg_match('/NotSet/i', $name)) {
+ return null;
+ }
+
+ return new TestFixture($childName);
+ }
+
+ private function argedName(string $fieldName, array $arguments): string
+ {
+ $childName = $this->name ? "$this->name.$fieldName" : $fieldName;
+ if ($arguments) {
+ return $childName . '(' . implode(',', $arguments) . ')';
+ } else {
+ return $childName;
+ }
+ }
+}
diff --git a/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php b/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php
new file mode 100644
index 000000000..6896f43ba
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php
@@ -0,0 +1,51 @@
+ ['method' => 'get_html', 'casting' => 'HTMLFragment'],
+ 'SSTemplateEngineTest_GlobalHTMLEscaped' => ['method' => 'get_html'],
+
+ 'SSTemplateEngineTest_GlobalAutomatic',
+ 'SSTemplateEngineTest_GlobalReferencedByString' => 'get_reference',
+ 'SSTemplateEngineTest_GlobalReferencedInArray' => ['method' => 'get_reference'],
+
+ 'SSTemplateEngineTest_GlobalThatTakesArguments' => ['method' => 'get_argmix', 'casting' => 'HTMLFragment'],
+ 'SSTemplateEngineTest_GlobalReturnsNull' => 'getNull',
+ ];
+ }
+
+ public static function get_html()
+ {
+ return '';
+ }
+
+ public static function SSTemplateEngineTest_GlobalAutomatic()
+ {
+ return 'automatic';
+ }
+
+ public static function get_reference()
+ {
+ return 'reference';
+ }
+
+ public static function get_argmix()
+ {
+ $args = func_get_args();
+ return 'z' . implode(':', $args) . 'z';
+ }
+
+ public static function getNull()
+ {
+ return null;
+ }
+}
diff --git a/tests/php/View/SSViewerTest/TestViewableData.php b/tests/php/View/SSTemplateEngineTest/TestModelData.php
similarity index 71%
rename from tests/php/View/SSViewerTest/TestViewableData.php
rename to tests/php/View/SSTemplateEngineTest/TestModelData.php
index febbbe9b4..15c9bd98e 100644
--- a/tests/php/View/SSViewerTest/TestViewableData.php
+++ b/tests/php/View/SSTemplateEngineTest/TestModelData.php
@@ -1,6 +1,6 @@
$arg) {
+ $ret[] = "arg$i:" . json_encode($arg);
+ }
+ return implode(',', $ret);
}
public function Type($arg)
diff --git a/tests/php/View/SSViewerTest/TestObject.php b/tests/php/View/SSTemplateEngineTest/TestObject.php
similarity index 70%
rename from tests/php/View/SSViewerTest/TestObject.php
rename to tests/php/View/SSTemplateEngineTest/TestObject.php
index dc0d948b4..5698fcf38 100644
--- a/tests/php/View/SSViewerTest/TestObject.php
+++ b/tests/php/View/SSTemplateEngineTest/TestObject.php
@@ -1,13 +1,13 @@
<% loop Children %>
-<% include SSViewerTestRecursiveInclude %>
+<% include SSTemplateEngineTestRecursiveInclude %>
<% end_loop %>
<% end_if %>
diff --git a/tests/php/View/SSViewerTest/templates/Includes/SSViewerTestTypePreservation.ss b/tests/php/View/SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestTypePreservation.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Includes/SSViewerTestTypePreservation.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestTypePreservation.ss
diff --git a/tests/php/View/SSViewerTest/templates/Namespace/IncludedOnceBase.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedOnceBase.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Namespace/IncludedOnceBase.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedOnceBase.ss
diff --git a/tests/php/View/SSViewerTest/templates/Namespace/IncludedTwice.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedTwice.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Namespace/IncludedTwice.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedTwice.ss
diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedOnceSub.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedOnceSub.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedOnceSub.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedOnceSub.ss
diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedTwice.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedTwice.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedTwice.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedTwice.ss
diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/NamespaceInclude.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/NamespaceInclude.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/NamespaceInclude.ss
rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/NamespaceInclude.ss
diff --git a/tests/php/View/SSViewerTest/templates/RSSFeedTest.ss b/tests/php/View/SSTemplateEngineTest/templates/RSSFeedTest.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/RSSFeedTest.ss
rename to tests/php/View/SSTemplateEngineTest/templates/RSSFeedTest.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSource.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSource.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSource.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSource.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceHTML4Doctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceHTML4Doctype.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceHTML4Doctype.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceHTML4Doctype.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIE.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIE.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIE.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIE.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIENoDoctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIENoDoctype.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIENoDoctype.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIENoDoctype.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceNoDoctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceNoDoctype.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceNoDoctype.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceNoDoctype.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsPartialSource.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsPartialSource.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsPartialSource.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsPartialSource.ss
diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss
new file mode 100644
index 000000000..a3a494945
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss
@@ -0,0 +1 @@
+<% include SSTemplateEngineTestCommentsInclude %>
diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss
new file mode 100644
index 000000000..f588c9d46
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss
@@ -0,0 +1,3 @@
+<% loop Items %>
+ <% include SSTemplateEngineTestIncludeScopeInheritanceInclude %>
+<% end_loop %>
diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss
new file mode 100644
index 000000000..772f76ae4
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss
@@ -0,0 +1,3 @@
+<% loop Items %>
+ <% include SSTemplateEngineTestIncludeScopeInheritanceInclude ArgA=$Title %>
+<% end_loop %>
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestLoopArray.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestLoopArray.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestLoopArray.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestLoopArray.ss
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestPartialTemplate.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestPartialTemplate.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/templates/SSViewerTestPartialTemplate.ss
rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestPartialTemplate.ss
diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss
new file mode 100644
index 000000000..7486f81db
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss
@@ -0,0 +1,6 @@
+
+ <% include SSTemplateEngineTestProcessHead %>
+
+
+
+
diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Controller.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Controller.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Controller.ss
rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Controller.ss
diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Page.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Page.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Page.ss
rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Page.ss
diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Shortcodes.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Shortcodes.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Shortcodes.ss
rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Shortcodes.ss
diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Page.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Page.ss
similarity index 100%
rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Page.ss
rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Page.ss
diff --git a/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss
new file mode 100644
index 000000000..b3b85b793
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss
@@ -0,0 +1 @@
+SSTemplateEngineTest
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/subfolder/templates/Subfolder.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/_manifest_exclude
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/subfolder/templates/Subfolder.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/_manifest_exclude
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/CustomPage.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/Root.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/CustomPage.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/Root.ss
diff --git a/tests/php/View/SSTemplateEngineTest_findTemplate/module/composer.json b/tests/php/View/SSTemplateEngineTest_findTemplate/module/composer.json
new file mode 100644
index 000000000..5d9e5da73
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest_findTemplate/module/composer.json
@@ -0,0 +1,4 @@
+{
+ "name": "silverstripe/module",
+ "type": "silverstripe-vendormodule"
+}
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/CustomThemePage.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/subfolder/templates/Subfolder.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/CustomThemePage.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/subfolder/templates/Subfolder.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/CustomTemplate.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/CustomTemplate.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/CustomTemplate.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/CustomTemplate.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/Page.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/CustomPage.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Layout/Page.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/CustomPage.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/themes/theme/templates/CustomThemePage.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/CustomThemePage.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/themes/theme/templates/CustomThemePage.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/CustomThemePage.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Page.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/Page.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/Page.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Layout/Page.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/Layout/MyClass.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/Layout/MyClass.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/Layout/MyClass.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/Layout/MyClass.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/MyClass.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/MyClass.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/MyClass.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/MyClass.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/MySubnamespace/MySubclass.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/MySubnamespace/MySubclass.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/templates/MyNamespace/MySubnamespace/MySubclass.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/MyNamespace/MySubnamespace/MySubclass.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/themes/theme/templates/Layout/Page.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Page.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/themes/theme/templates/Layout/Page.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/templates/Page.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/tests/templates/Test.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/tests/templates/Test.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/tests/templates/Test.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/tests/templates/Test.ss
diff --git a/tests/php/Core/Manifest/fixtures/templatemanifest/module/themes/subtheme/templates/NestedThemePage.ss b/tests/php/View/SSTemplateEngineTest_findTemplate/module/themes/subtheme/templates/NestedThemePage.ss
similarity index 100%
rename from tests/php/Core/Manifest/fixtures/templatemanifest/module/themes/subtheme/templates/NestedThemePage.ss
rename to tests/php/View/SSTemplateEngineTest_findTemplate/module/themes/subtheme/templates/NestedThemePage.ss
diff --git a/tests/php/View/SSTemplateEngineTest_findTemplate/myproject/_config.php b/tests/php/View/SSTemplateEngineTest_findTemplate/myproject/_config.php
new file mode 100644
index 000000000..b3d9bbc7f
--- /dev/null
+++ b/tests/php/View/SSTemplateEngineTest_findTemplate/myproject/_config.php
@@ -0,0 +1 @@
+set('source_file_comments', false);
- SSViewer_FromString::config()->set('cache_template', false);
- TestAssetStore::activate('SSViewerTest');
- $this->oldServer = $_SERVER;
- }
-
- protected function tearDown(): void
- {
- $_SERVER = $this->oldServer;
- TestAssetStore::reset();
- parent::tearDown();
- }
+ protected $usesDatabase = false;
/**
* Tests for themes helper functions, ensuring they behave as defined in the RFC at
@@ -85,1786 +35,28 @@ class SSViewerTest extends SapphireTest
$this->assertEquals(['mytheme', 'my_more_important_theme', '$default'], SSViewer::get_themes());
}
- /**
- * Test that a template without a tag still renders.
- */
- public function testTemplateWithoutHeadRenders()
+ public function testRequirementsInjected()
{
- $data = new ArrayData([ 'Var' => 'var value' ]);
- $result = $data->renderWith("SSViewerTestPartialTemplate");
- $this->assertEquals('Test partial template: var value', trim(preg_replace("//U", '', $result ?? '') ?? ''));
- }
+ Requirements::clear();
- /**
- * Ensure global methods aren't executed
- */
- public function testTemplateExecution()
- {
- $data = new ArrayData([ 'Var' => 'phpinfo' ]);
- $result = $data->renderWith("SSViewerTestPartialTemplate");
- $this->assertEquals('Test partial template: phpinfo', trim(preg_replace("//U", '', $result ?? '') ?? ''));
- }
-
- public function testIncludeScopeInheritance()
- {
- $data = $this->getScopeInheritanceTestData();
- $expected = [
- 'Item 1 - First-ODD top:Item 1',
- 'Item 2 - EVEN top:Item 2',
- 'Item 3 - ODD top:Item 3',
- 'Item 4 - EVEN top:Item 4',
- 'Item 5 - ODD top:Item 5',
- 'Item 6 - Last-EVEN top:Item 6',
- ];
-
- $result = $data->renderWith('SSViewerTestIncludeScopeInheritance');
- $this->assertExpectedStrings($result, $expected);
-
- // reset results for the tests that include arguments (the title is passed as an arg)
- $expected = [
- 'Item 1 _ Item 1 - First-ODD top:Item 1',
- 'Item 2 _ Item 2 - EVEN top:Item 2',
- 'Item 3 _ Item 3 - ODD top:Item 3',
- 'Item 4 _ Item 4 - EVEN top:Item 4',
- 'Item 5 _ Item 5 - ODD top:Item 5',
- 'Item 6 _ Item 6 - Last-EVEN top:Item 6',
- ];
-
- $result = $data->renderWith('SSViewerTestIncludeScopeInheritanceWithArgs');
- $this->assertExpectedStrings($result, $expected);
- }
-
- public function testIncludeTruthyness()
- {
- $data = new ArrayData([
- 'Title' => 'TruthyTest',
- 'Items' => new ArrayList([
- new ArrayData(['Title' => 'Item 1']),
- new ArrayData(['Title' => '']),
- new ArrayData(['Title' => true]),
- new ArrayData(['Title' => false]),
- new ArrayData(['Title' => null]),
- new ArrayData(['Title' => 0]),
- new ArrayData(['Title' => 7])
- ])
- ]);
- $result = $data->renderWith('SSViewerTestIncludeScopeInheritanceWithArgs');
-
- // We should not end up with empty values appearing as empty
- $expected = [
- 'Item 1 _ Item 1 - First-ODD top:Item 1',
- 'Untitled - EVEN top:',
- '1 _ 1 - ODD top:1',
- 'Untitled - EVEN top:',
- 'Untitled - ODD top:',
- 'Untitled - EVEN top:0',
- '7 _ 7 - Last-ODD top:7',
- ];
- $this->assertExpectedStrings($result, $expected);
- }
-
- private function getScopeInheritanceTestData()
- {
- return new ArrayData([
- 'Title' => 'TopTitleValue',
- 'Items' => new ArrayList([
- new ArrayData(['Title' => 'Item 1']),
- new ArrayData(['Title' => 'Item 2']),
- new ArrayData(['Title' => 'Item 3']),
- new ArrayData(['Title' => 'Item 4']),
- new ArrayData(['Title' => 'Item 5']),
- new ArrayData(['Title' => 'Item 6'])
- ])
- ]);
- }
-
- private function assertExpectedStrings($result, $expected)
- {
- foreach ($expected as $expectedStr) {
- $this->assertTrue(
- (boolean) preg_match("/{$expectedStr}/", $result ?? ''),
- "Didn't find '{$expectedStr}' in:\n{$result}"
- );
+ try {
+ Requirements::customCSS('pretend this is real css');
+ $viewer = new SSViewer([], new DummyTemplateEngine());
+ $result1 = $viewer->process('pretend this is a model')->getValue();
+ // if we disable the requirements then we should get nothing
+ $viewer->includeRequirements(false);
+ $result2 = $viewer->process('pretend this is a model')->getValue();
+ } finally {
+ Requirements::restore();
}
- }
- /**
- * Small helper to render templates from strings
- *
- * @param string $templateString
- * @param null $data
- * @param bool $cacheTemplate
- * @return string
- */
- public function render($templateString, $data = null, $cacheTemplate = false)
- {
- $t = SSViewer::fromString($templateString, $cacheTemplate);
- if (!$data) {
- $data = new SSViewerTest\TestFixture();
- }
- return trim('' . $t->process($data));
- }
-
- public function testRequirements()
- {
- /** @var Requirements_Backend|MockObject $requirements */
- $requirements = $this
- ->getMockBuilder(Requirements_Backend::class)
- ->onlyMethods(["javascript", "css"])
- ->getMock();
- $jsFile = FRAMEWORK_DIR . '/tests/forms/a.js';
- $cssFile = FRAMEWORK_DIR . '/tests/forms/a.js';
-
- $requirements->expects($this->once())->method('javascript')->with($jsFile);
- $requirements->expects($this->once())->method('css')->with($cssFile);
-
- $origReq = Requirements::backend();
- Requirements::set_backend($requirements);
- $template = $this->render(
- "<% require javascript($jsFile) %>
- <% require css($cssFile) %>"
- );
- Requirements::set_backend($origReq);
-
- $this->assertFalse((bool)trim($template ?? ''), "Should be no content in this return.");
- }
-
- public function testRequirementsCombine()
- {
- /** @var Requirements_Backend $testBackend */
- $testBackend = Injector::inst()->create(Requirements_Backend::class);
- $testBackend->setSuffixRequirements(false);
- $testBackend->setCombinedFilesEnabled(true);
-
- //$combinedTestFilePath = BASE_PATH . '/' . $testBackend->getCombinedFilesFolder() . '/testRequirementsCombine.js';
-
- $jsFile = $this->getCurrentRelativePath() . '/SSViewerTest/javascript/bad.js';
- $jsFileContents = file_get_contents(BASE_PATH . '/' . $jsFile);
- $testBackend->combineFiles('testRequirementsCombine.js', [$jsFile]);
-
- // secondly, make sure that requirements is generated, even though minification failed
- $testBackend->processCombinedFiles();
- $js = array_keys($testBackend->getJavascript() ?? []);
- $combinedTestFilePath = Director::publicFolder() . reset($js);
- $this->assertStringContainsString('_combinedfiles/testRequirementsCombine-4c0e97a.js', $combinedTestFilePath);
-
- // and make sure the combined content matches the input content, i.e. no loss of functionality
- if (!file_exists($combinedTestFilePath ?? '')) {
- $this->fail('No combined file was created at expected path: ' . $combinedTestFilePath);
- }
- $combinedTestFileContents = file_get_contents($combinedTestFilePath ?? '');
- $this->assertStringContainsString($jsFileContents, $combinedTestFileContents);
- }
-
- public function testComments()
- {
- $input = <<This is some content<%-- this is another comment --%>Final content
-<%-- Alone multi
- line comment --%>
-Some more content
-Mixing content and <%-- multi
- line comment --%> Final final
-content
-<%--commentwithoutwhitespace--%>last content
-SS;
- $actual = $this->render($input);
- $expected = <<assertEquals($expected, $actual);
-
- $input = <<empty comment1
-<%-- --%>empty comment2
-<%----%>empty comment3
-SS;
- $actual = $this->render($input);
- $expected = <<assertEquals($expected, $actual);
- }
-
- public function testBasicText()
- {
- $this->assertEquals('"', $this->render('"'), 'Double-quotes are left alone');
- $this->assertEquals("'", $this->render("'"), 'Single-quotes are left alone');
- $this->assertEquals('A', $this->render('\\A'), 'Escaped characters are unescaped');
- $this->assertEquals('\\A', $this->render('\\\\A'), 'Escaped back-slashed are correctly unescaped');
- }
-
- public function testBasicInjection()
- {
- $this->assertEquals('[out:Test]', $this->render('$Test'), 'Basic stand-alone injection');
- $this->assertEquals('[out:Test]', $this->render('{$Test}'), 'Basic stand-alone wrapped injection');
- $this->assertEquals('A[out:Test]!', $this->render('A$Test!'), 'Basic surrounded injection');
- $this->assertEquals('A[out:Test]B', $this->render('A{$Test}B'), 'Basic surrounded wrapped injection');
-
- $this->assertEquals('A$B', $this->render('A\\$B'), 'No injection as $ escaped');
- $this->assertEquals('A$ B', $this->render('A$ B'), 'No injection as $ not followed by word character');
- $this->assertEquals('A{$ B', $this->render('A{$ B'), 'No injection as {$ not followed by word character');
-
- $this->assertEquals('{$Test}', $this->render('{\\$Test}'), 'Escapes can be used to avoid injection');
- $this->assertEquals(
- '{\\[out:Test]}',
- $this->render('{\\\\$Test}'),
- 'Escapes before injections are correctly unescaped'
- );
- }
-
- public function testBasicInjectionMismatchedBrackets()
- {
- $this->expectException(SSTemplateParseException::class);
- $this->expectExceptionMessageMatches('/Malformed bracket injection {\$Value(.*)/');
- $this->render('A {$Value here');
- $this->fail("Parser didn't error when encountering mismatched brackets in an injection");
- }
-
- public function testGlobalVariableCalls()
- {
- $this->assertEquals('automatic', $this->render('$SSViewerTest_GlobalAutomatic'));
- $this->assertEquals('reference', $this->render('$SSViewerTest_GlobalReferencedByString'));
- $this->assertEquals('reference', $this->render('$SSViewerTest_GlobalReferencedInArray'));
- }
-
- public function testGlobalVariableCallsWithArguments()
- {
- $this->assertEquals('zz', $this->render('$SSViewerTest_GlobalThatTakesArguments'));
- $this->assertEquals('zFooz', $this->render('$SSViewerTest_GlobalThatTakesArguments("Foo")'));
- $this->assertEquals(
- 'zFoo:Bar:Bazz',
- $this->render('$SSViewerTest_GlobalThatTakesArguments("Foo", "Bar", "Baz")')
- );
- $this->assertEquals(
- 'zreferencez',
- $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalReferencedByString)')
- );
- }
-
- public function testGlobalVariablesAreEscaped()
- {
- $this->assertEquals('', $this->render('$SSViewerTest_GlobalHTMLFragment'));
- $this->assertEquals('<div></div>', $this->render('$SSViewerTest_GlobalHTMLEscaped'));
-
- $this->assertEquals(
- 'zz',
- $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalHTMLFragment)')
- );
- $this->assertEquals(
- 'z<div></div>z',
- $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalHTMLEscaped)')
- );
- }
-
- public function testGlobalVariablesReturnNull()
- {
- $this->assertEquals('', $this->render('$SSViewerTest_GlobalReturnsNull
'));
- $this->assertEquals('', $this->render('$SSViewerTest_GlobalReturnsNull.Chained.Properties
'));
- }
-
- public function testCoreGlobalVariableCalls()
- {
- $this->assertEquals(
- Director::absoluteBaseURL(),
- $this->render('{$absoluteBaseURL}'),
- 'Director::absoluteBaseURL can be called from within template'
- );
- $this->assertEquals(
- Director::absoluteBaseURL(),
- $this->render('{$AbsoluteBaseURL}'),
- 'Upper-case %AbsoluteBaseURL can be called from within template'
- );
-
- $this->assertEquals(
- Director::is_ajax(),
- $this->render('{$isAjax}'),
- 'All variations of is_ajax result in the correct call'
- );
- $this->assertEquals(
- Director::is_ajax(),
- $this->render('{$IsAjax}'),
- 'All variations of is_ajax result in the correct call'
- );
- $this->assertEquals(
- Director::is_ajax(),
- $this->render('{$is_ajax}'),
- 'All variations of is_ajax result in the correct call'
- );
- $this->assertEquals(
- Director::is_ajax(),
- $this->render('{$Is_ajax}'),
- 'All variations of is_ajax result in the correct call'
- );
-
- $this->assertEquals(
- i18n::get_locale(),
- $this->render('{$i18nLocale}'),
- 'i18n template functions result correct result'
- );
- $this->assertEquals(
- i18n::get_locale(),
- $this->render('{$get_locale}'),
- 'i18n template functions result correct result'
- );
-
- $this->assertEquals(
- (string)Security::getCurrentUser(),
- $this->render('{$CurrentMember}'),
- 'Member template functions result correct result'
- );
- $this->assertEquals(
- (string)Security::getCurrentUser(),
- $this->render('{$CurrentUser}'),
- 'Member template functions result correct result'
- );
- $this->assertEquals(
- (string)Security::getCurrentUser(),
- $this->render('{$currentMember}'),
- 'Member template functions result correct result'
- );
- $this->assertEquals(
- (string)Security::getCurrentUser(),
- $this->render('{$currentUser}'),
- 'Member template functions result correct result'
- );
-
- $this->assertEquals(
- SecurityToken::getSecurityID(),
- $this->render('{$getSecurityID}'),
- 'SecurityToken template functions result correct result'
- );
- $this->assertEquals(
- SecurityToken::getSecurityID(),
- $this->render('{$SecurityID}'),
- 'SecurityToken template functions result correct result'
- );
-
- $this->assertEquals(
- Permission::check("ADMIN"),
- (bool)$this->render('{$HasPerm(\'ADMIN\')}'),
- 'Permissions template functions result correct result'
- );
- $this->assertEquals(
- Permission::check("ADMIN"),
- (bool)$this->render('{$hasPerm(\'ADMIN\')}'),
- 'Permissions template functions result correct result'
- );
- }
-
- public function testNonFieldCastingHelpersNotUsedInHasValue()
- {
- // check if Link without $ in front of variable
- $result = $this->render(
- 'A<% if Link %>$Link<% end_if %>B',
- new SSViewerTest\TestObject()
- );
- $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if Link %>');
-
- // check if Link with $ in front of variable
- $result = $this->render(
- 'A<% if $Link %>$Link<% end_if %>B',
- new SSViewerTest\TestObject()
- );
- $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if $Link %>');
- }
-
- public function testLocalFunctionsTakePriorityOverGlobals()
- {
- $data = new ArrayData([
- 'Page' => new SSViewerTest\TestObject()
- ]);
-
- //call method with lots of arguments
- $result = $this->render(
- '<% with Page %>$lotsOfArguments11("a","b","c","d","e","f","g","h","i","j","k")<% end_with %>',
- $data
- );
- $this->assertEquals("abcdefghijk", $result, "public function can accept up to 11 arguments");
-
- //call method that does not exist
- $result = $this->render('<% with Page %><% if IDoNotExist %>hello<% end_if %><% end_with %>', $data);
- $this->assertEquals("", $result, "Method does not exist - empty result");
-
- //call if that does not exist
- $result = $this->render('<% with Page %>$IDoNotExist("hello")<% end_with %>', $data);
- $this->assertEquals("", $result, "Method does not exist - empty result");
-
- //call method with same name as a global method (local call should take priority)
- $result = $this->render('<% with Page %>$absoluteBaseURL<% end_with %>', $data);
- $this->assertEquals(
- "testLocalFunctionPriorityCalled",
- $result,
- "Local Object's public function called. Did not return the actual baseURL of the current site"
- );
- }
-
- public function testCurrentScopeLoop(): void
- {
- $data = new ArrayList([['Val' => 'one'], ['Val' => 'two'], ['Val' => 'three']]);
$this->assertEqualIgnoringWhitespace(
- 'one two three',
- $this->render('<% loop %>$Val<% end_loop %>', $data)
+ '',
+ $result1
);
- }
-
- public function testCurrentScopeLoopWith()
- {
- // Data to run the loop tests on - one sequence of three items, each with a subitem
- $data = new ArrayData([
- 'Foo' => new ArrayList([
- 'Subocean' => new ArrayData([
- 'Name' => 'Higher'
- ]),
- new ArrayData([
- 'Sub' => new ArrayData([
- 'Name' => 'SubKid1'
- ])
- ]),
- new ArrayData([
- 'Sub' => new ArrayData([
- 'Name' => 'SubKid2'
- ])
- ]),
- new SSViewerTest\TestObject('Number6')
- ])
- ]);
-
- $result = $this->render(
- '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>',
- $data
- );
- $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works");
-
- $result = $this->render(
- '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>',
- $data
- );
- $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works");
-
- $result = $this->render('<% with Foo %>$Count<% end_with %>', $data);
- $this->assertEquals("4", $result, "4 items in the DataObjectSet");
-
- $result = $this->render(
- '<% with Foo %><% loop Up.Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>'
- . '<% end_if %><% end_loop %><% end_with %>',
- $data
- );
- $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in with Up.Foo scope works");
-
- $result = $this->render(
- '<% with Foo %><% loop %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>'
- . '<% end_if %><% end_loop %><% end_with %>',
- $data
- );
- $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in current scope works");
- }
-
- public static function provideArgumentTypes()
- {
- return [
- [
- 'arg1:0,arg2:"string",arg3:true',
- '$methodWithTypedArguments(0, "string", true).RAW',
- ],
- [
- 'arg1:false,arg2:"string",arg3:true',
- '$methodWithTypedArguments(false, "string", true).RAW',
- ],
- [
- 'arg1:null,arg2:"string",arg3:true',
- '$methodWithTypedArguments(null, "string", true).RAW',
- ],
- [
- 'arg1:"",arg2:"string",arg3:true',
- '$methodWithTypedArguments("", "string", true).RAW',
- ],
- [
- 'arg1:0,arg2:1,arg3:2',
- '$methodWithTypedArguments(0, 1, 2).RAW',
- ],
- ];
- }
-
- #[DataProvider('provideArgumentTypes')]
- public function testArgumentTypes(string $expected, string $template)
- {
- $this->assertEquals($expected, $this->render($template, new TestModelData()));
- }
-
- public function testObjectDotArguments()
- {
- $this->assertEquals(
- '[out:TestObject.methodWithOneArgument(one)]
- [out:TestObject.methodWithTwoArguments(one,two)]
- [out:TestMethod(Arg1,Arg2).Bar.Val]
- [out:TestMethod(Arg1,Arg2).Bar]
- [out:TestMethod(Arg1,Arg2)]
- [out:TestMethod(Arg1).Bar.Val]
- [out:TestMethod(Arg1).Bar]
- [out:TestMethod(Arg1)]',
- $this->render(
- '$TestObject.methodWithOneArgument(one)
- $TestObject.methodWithTwoArguments(one,two)
- $TestMethod(Arg1, Arg2).Bar.Val
- $TestMethod(Arg1, Arg2).Bar
- $TestMethod(Arg1, Arg2)
- $TestMethod(Arg1).Bar.Val
- $TestMethod(Arg1).Bar
- $TestMethod(Arg1)'
- )
- );
- }
-
- public function testEscapedArguments()
- {
- $this->assertEquals(
- '[out:Foo(Arg1,Arg2).Bar.Val].Suffix
- [out:Foo(Arg1,Arg2).Val]_Suffix
- [out:Foo(Arg1,Arg2)]/Suffix
- [out:Foo(Arg1).Bar.Val]textSuffix
- [out:Foo(Arg1).Bar].Suffix
- [out:Foo(Arg1)].Suffix
- [out:Foo.Bar.Val].Suffix
- [out:Foo.Bar].Suffix
- [out:Foo].Suffix',
- $this->render(
- '{$Foo(Arg1, Arg2).Bar.Val}.Suffix
- {$Foo(Arg1, Arg2).Val}_Suffix
- {$Foo(Arg1, Arg2)}/Suffix
- {$Foo(Arg1).Bar.Val}textSuffix
- {$Foo(Arg1).Bar}.Suffix
- {$Foo(Arg1)}.Suffix
- {$Foo.Bar.Val}.Suffix
- {$Foo.Bar}.Suffix
- {$Foo}.Suffix'
- )
- );
- }
-
- public function testLoopWhitespace()
- {
- $data = new ArrayList([new SSViewerTest\TestFixture()]);
- $this->assertEquals(
- 'before[out:Test]after
- beforeTestafter',
- $this->render(
- 'before<% loop %>$Test<% end_loop %>after
- before<% loop %>Test<% end_loop %>after',
- $data
- )
- );
-
- // The control tags are removed from the output, but no whitespace
- // This is a quirk that could be changed, but included in the test to make the current
- // behaviour explicit
- $this->assertEquals(
- 'before
-
-[out:ItemOnItsOwnLine]
-
-after',
- $this->render(
- 'before
-<% loop %>
-$ItemOnItsOwnLine
-<% end_loop %>
-after',
- $data
- )
- );
-
- // The whitespace within the control tags is preserve in a loop
- // This is a quirk that could be changed, but included in the test to make the current
- // behaviour explicit
- $this->assertEquals(
- 'before
-
-[out:Loop3.ItemOnItsOwnLine]
-
-[out:Loop3.ItemOnItsOwnLine]
-
-[out:Loop3.ItemOnItsOwnLine]
-
-after',
- $this->render(
- 'before
-<% loop Loop3 %>
-$ItemOnItsOwnLine
-<% end_loop %>
-after'
- )
- );
- }
-
- public static function typePreservationDataProvider()
- {
- return [
- // Null
- ['NULL:', 'null'],
- ['NULL:', 'NULL'],
- // Booleans
- ['boolean:1', 'true'],
- ['boolean:1', 'TRUE'],
- ['boolean:', 'false'],
- ['boolean:', 'FALSE'],
- // Strings which may look like booleans/null to the parser
- ['string:nullish', 'nullish'],
- ['string:notnull', 'notnull'],
- ['string:truethy', 'truethy'],
- ['string:untrue', 'untrue'],
- ['string:falsey', 'falsey'],
- // Integers
- ['integer:0', '0'],
- ['integer:1', '1'],
- ['integer:15', '15'],
- ['integer:-15', '-15'],
- // Octal integers
- ['integer:83', '0123'],
- ['integer:-83', '-0123'],
- // Hexadecimal integers
- ['integer:26', '0x1A'],
- ['integer:-26', '-0x1A'],
- // Binary integers
- ['integer:255', '0b11111111'],
- ['integer:-255', '-0b11111111'],
- // Floats (aka doubles)
- ['double:0', '0.0'],
- ['double:1', '1.0'],
- ['double:15.25', '15.25'],
- ['double:-15.25', '-15.25'],
- ['double:1200', '1.2e3'],
- ['double:-1200', '-1.2e3'],
- ['double:0.07', '7E-2'],
- ['double:-0.07', '-7E-2'],
- // Explicitly quoted strings
- ['string:0', '"0"'],
- ['string:1', '\'1\''],
- ['string:foobar', '"foobar"'],
- ['string:foo bar baz', '"foo bar baz"'],
- ['string:false', '\'false\''],
- ['string:true', '\'true\''],
- ['string:null', '\'null\''],
- ['string:false', '"false"'],
- ['string:true', '"true"'],
- ['string:null', '"null"'],
- // Implicit strings
- ['string:foobar', 'foobar'],
- ['string:foo bar baz', 'foo bar baz']
- ];
- }
-
- #[DataProvider('typePreservationDataProvider')]
- public function testTypesArePreserved($expected, $templateArg)
- {
- $data = new ArrayData([
- 'Test' => new TestModelData()
- ]);
-
- $this->assertEquals($expected, $this->render("\$Test.Type({$templateArg})", $data));
- }
-
- #[DataProvider('typePreservationDataProvider')]
- public function testTypesArePreservedAsIncludeArguments($expected, $templateArg)
- {
- $data = new ArrayData([
- 'Test' => new TestModelData()
- ]);
-
- $this->assertEquals(
- $expected,
- $this->render("<% include SSViewerTestTypePreservation Argument={$templateArg} %>", $data)
- );
- }
-
- public function testTypePreservationInConditionals()
- {
- $data = new ArrayData([
- 'Test' => new TestModelData()
- ]);
-
- // Types in conditionals
- $this->assertEquals('pass', $this->render('<% if true %>pass<% else %>fail<% end_if %>', $data));
- $this->assertEquals('pass', $this->render('<% if false %>fail<% else %>pass<% end_if %>', $data));
- $this->assertEquals('pass', $this->render('<% if 1 %>pass<% else %>fail<% end_if %>', $data));
- $this->assertEquals('pass', $this->render('<% if 0 %>fail<% else %>pass<% end_if %>', $data));
- }
-
- public function testControls()
- {
- // Single item controls
- $this->assertEquals(
- 'a[out:Foo.Bar.Item]b
- [out:Foo.Bar(Arg1).Item]
- [out:Foo(Arg1).Item]
- [out:Foo(Arg1,Arg2).Item]
- [out:Foo(Arg1,Arg2,Arg3).Item]',
- $this->render(
- '<% with Foo.Bar %>a{$Item}b<% end_with %>
- <% with Foo.Bar(Arg1) %>$Item<% end_with %>
- <% with Foo(Arg1) %>$Item<% end_with %>
- <% with Foo(Arg1, Arg2) %>$Item<% end_with %>
- <% with Foo(Arg1, Arg2, Arg3) %>$Item<% end_with %>'
- )
- );
-
- // Loop controls
- $this->assertEquals(
- 'a[out:Foo.Loop2.Item]ba[out:Foo.Loop2.Item]b',
- $this->render('<% loop Foo.Loop2 %>a{$Item}b<% end_loop %>')
- );
-
- $this->assertEquals(
- '[out:Foo.Loop2(Arg1).Item][out:Foo.Loop2(Arg1).Item]',
- $this->render('<% loop Foo.Loop2(Arg1) %>$Item<% end_loop %>')
- );
-
- $this->assertEquals(
- '[out:Loop2(Arg1).Item][out:Loop2(Arg1).Item]',
- $this->render('<% loop Loop2(Arg1) %>$Item<% end_loop %>')
- );
-
- $this->assertEquals(
- '[out:Loop2(Arg1,Arg2).Item][out:Loop2(Arg1,Arg2).Item]',
- $this->render('<% loop Loop2(Arg1, Arg2) %>$Item<% end_loop %>')
- );
-
- $this->assertEquals(
- '[out:Loop2(Arg1,Arg2,Arg3).Item][out:Loop2(Arg1,Arg2,Arg3).Item]',
- $this->render('<% loop Loop2(Arg1, Arg2, Arg3) %>$Item<% end_loop %>')
- );
- }
-
- public function testIfBlocks()
- {
- // Basic test
- $this->assertEquals(
- 'AC',
- $this->render('A<% if NotSet %>B$NotSet<% end_if %>C')
- );
-
- // Nested test
- $this->assertEquals(
- 'AB1C',
- $this->render('A<% if IsSet %>B$NotSet<% if IsSet %>1<% else %>2<% end_if %><% end_if %>C')
- );
-
- // else_if
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if NotSet %>B<% else_if IsSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ADE',
- $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E')
- );
-
- $this->assertEquals(
- 'ADE',
- $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E')
- );
-
- // Dot syntax
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if Foo.NotSet %>B<% else_if Foo.IsSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if Foo.Bar.NotSet %>B<% else_if Foo.Bar.IsSet %>C<% end_if %>D')
- );
-
- // Params
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if NotSet(Param) %>B<% else %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ABD',
- $this->render('A<% if IsSet(Param) %>B<% else %>C<% end_if %>D')
- );
-
- // Negation
- $this->assertEquals(
- 'AC',
- $this->render('A<% if not IsSet %>B<% end_if %>C')
- );
- $this->assertEquals(
- 'ABC',
- $this->render('A<% if not NotSet %>B<% end_if %>C')
- );
-
- // Or
- $this->assertEquals(
- 'ABD',
- $this->render('A<% if IsSet || NotSet %>B<% else_if A %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet3 %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet || NotSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet2 || NotSet3 %>C<% end_if %>D')
- );
-
- // Negated Or
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if not IsSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ABD',
- $this->render('A<% if not NotSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ABD',
- $this->render('A<% if NotSet || not AlsoNotSet %>B<% else_if A %>C<% end_if %>D')
- );
-
- // And
- $this->assertEquals(
- 'ABD',
- $this->render('A<% if IsSet && AlsoSet %>B<% else_if A %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet && NotSet2 %>B<% else_if NotSet3 %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet && AlsoSet %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet && NotSet2 %>B<% else_if IsSet && NotSet3 %>C<% end_if %>D')
- );
-
- // Equality
- $this->assertEquals(
- 'ABC',
- $this->render('A<% if RawVal == RawVal %>B<% end_if %>C')
- );
- $this->assertEquals(
- 'ACD',
- $this->render('A<% if Right == Wrong %>B<% else_if RawVal == RawVal %>C<% end_if %>D')
- );
- $this->assertEquals(
- 'ABC',
- $this->render('A<% if Right != Wrong %>B<% end_if %>C')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% end_if %>D')
- );
-
- // test inequalities with simple numbers
- $this->assertEquals('ABD', $this->render('A<% if 5 > 3 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ABD', $this->render('A<% if 5 >= 3 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 3 > 5 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 3 >= 5 %>B<% else %>C<% end_if %>D'));
-
- $this->assertEquals('ABD', $this->render('A<% if 3 < 5 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ABD', $this->render('A<% if 3 <= 5 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 5 < 3 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 5 <= 3 %>B<% else %>C<% end_if %>D'));
-
- $this->assertEquals('ABD', $this->render('A<% if 4 <= 4 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ABD', $this->render('A<% if 4 >= 4 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 4 > 4 %>B<% else %>C<% end_if %>D'));
- $this->assertEquals('ACD', $this->render('A<% if 4 < 4 %>B<% else %>C<% end_if %>D'));
-
- // empty else_if and else tags, if this would not be supported,
- // the output would stop after A, thereby failing the assert
- $this->assertEquals('AD', $this->render('A<% if IsSet %><% else %><% end_if %>D'));
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet %><% else_if IsSet %><% else %><% end_if %>D')
- );
- $this->assertEquals(
- 'AD',
- $this->render('A<% if NotSet %><% else_if AlsoNotSet %><% else %><% end_if %>D')
- );
-
- // Bare words with ending space
- $this->assertEquals(
- 'ABC',
- $this->render('A<% if "RawVal" == RawVal %>B<% end_if %>C')
- );
-
- // Else
- $this->assertEquals(
- 'ADE',
- $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% else %>D<% end_if %>E')
- );
-
- // Empty if with else
- $this->assertEquals(
- 'ABC',
- $this->render('A<% if NotSet %><% else %>B<% end_if %>C')
- );
- }
-
- public static function provideIfBlockWithIterable(): array
- {
- $scenarios = [
- 'empty array' => [
- 'iterable' => [],
- 'inScope' => false,
- ],
- 'array' => [
- 'iterable' => [1, 2, 3],
- 'inScope' => false,
- ],
- 'ArrayList' => [
- 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]),
- 'inScope' => false,
- ],
- ];
- foreach ($scenarios as $name => $scenario) {
- $scenario['inScope'] = true;
- $scenarios[$name . ' in scope'] = $scenario;
- }
- return $scenarios;
- }
-
- #[DataProvider('provideIfBlockWithIterable')]
- public function testIfBlockWithIterable(iterable $iterable, bool $inScope): void
- {
- $expected = count($iterable) ? 'has value' : 'no value';
- $data = new ArrayData(['Iterable' => $iterable]);
- if ($inScope) {
- $template = '<% with $Iterable %><% if $Me %>has value<% else %>no value<% end_if %><% end_with %>';
- } else {
- $template = '<% if $Iterable %>has value<% else %>no value<% end_if %>';
- }
- $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
- }
-
- public function testBaseTagGeneration()
- {
- // XHTML will have a closed base tag
- $tmpl1 = '
-
-
- <% base_tag %>
- test
- ';
- $this->assertMatchesRegularExpression('/<\/head>/', $this->render($tmpl1));
-
- // HTML4 and 5 will only have it for IE
- $tmpl2 = '
-
- <% base_tag %>
- test
- ';
- $this->assertMatchesRegularExpression(
- '/<\/head>/',
- $this->render($tmpl2)
- );
-
-
- $tmpl3 = '
-
- <% base_tag %>
- test
- ';
- $this->assertMatchesRegularExpression(
- '/<\/head>/',
- $this->render($tmpl3)
- );
-
- // Check that the content negotiator converts to the equally legal formats
- $negotiator = new ContentNegotiator();
-
- $response = new HTTPResponse($this->render($tmpl1));
- $negotiator->html($response);
- $this->assertMatchesRegularExpression(
- '/<\/head>/',
- $response->getBody()
- );
-
- $response = new HTTPResponse($this->render($tmpl1));
- $negotiator->xhtml($response);
- $this->assertMatchesRegularExpression('/<\/head>/', $response->getBody());
- }
-
- public function testIncludeWithArguments()
- {
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments %>'),
- '[out:Arg1]
[out:Arg2]
[out:Arg2.Count]
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A %>'),
- 'A
[out:Arg2]
[out:Arg2.Count]
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A, Arg2=B %>'),
- 'A
B
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A Bare String, Arg2=B Bare String %>'),
- 'A Bare String
B Bare String
'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=$B %>',
- new ArrayData(['B' => 'Bar'])
- ),
- 'A
Bar
'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeWithArguments Arg1="A" %>',
- new ArrayData(['Arg1' => 'Foo', 'Arg2' => 'Bar'])
- ),
- 'A
Bar
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=0 %>'),
- 'A
0
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=false %>'),
- 'A
'
- );
-
- $this->assertEquals(
- $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=null %>'),
- 'A
'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeScopeInheritanceWithArgsInLoop Title="SomeArg" %>',
- new ArrayData(
- ['Items' => new ArrayList(
- [
- new ArrayData(['Title' => 'Foo']),
- new ArrayData(['Title' => 'Bar'])
- ]
- )]
- )
- ),
- 'SomeArg - Foo - Bar - SomeArg'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeScopeInheritanceWithArgsInWith Title="A" %>',
- new ArrayData(['Item' => new ArrayData(['Title' =>'B'])])
- ),
- 'A - B - A'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeScopeInheritanceWithArgsInNestedWith Title="A" %>',
- new ArrayData(
- [
- 'Item' => new ArrayData(
- [
- 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C'])
- ]
- )]
- )
- ),
- 'A - B - C - B - A'
- );
-
- $this->assertEquals(
- $this->render(
- '<% include SSViewerTestIncludeScopeInheritanceWithUpAndTop Title="A" %>',
- new ArrayData(
- [
- 'Item' => new ArrayData(
- [
- 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C'])
- ]
- )]
- )
- ),
- 'A - A - A'
- );
-
- $data = new ArrayData(
- [
- 'Nested' => new ArrayData(
- [
- 'Object' => new ArrayData(['Key' => 'A'])
- ]
- ),
- 'Object' => new ArrayData(['Key' => 'B'])
- ]
- );
-
- $tmpl = SSViewer::fromString('<% include SSViewerTestIncludeObjectArguments A=$Nested.Object, B=$Object %>');
- $res = $tmpl->process($data);
- $this->assertEqualIgnoringWhitespace('A B', $res, 'Objects can be passed as named arguments');
- }
-
- public function testNamespaceInclude()
- {
- $data = new ArrayData([]);
-
- $this->assertEquals(
- "tests:( NamespaceInclude\n )",
- $this->render('tests:( <% include Namespace\NamespaceInclude %> )', $data),
- 'Backslashes work for namespace references in includes'
- );
-
- $this->assertEquals(
- "tests:( NamespaceInclude\n )",
- $this->render('tests:( <% include Namespace\\NamespaceInclude %> )', $data),
- 'Escaped backslashes work for namespace references in includes'
- );
-
- $this->assertEquals(
- "tests:( NamespaceInclude\n )",
- $this->render('tests:( <% include Namespace/NamespaceInclude %> )', $data),
- 'Forward slashes work for namespace references in includes'
- );
- }
-
- /**
- * Test search for includes fallback to non-includes folder
- */
- public function testIncludeFallbacks()
- {
- $data = new ArrayData([]);
-
- $this->assertEquals(
- "tests:( Namespace/Includes/IncludedTwice.ss\n )",
- $this->render('tests:( <% include Namespace\\IncludedTwice %> )', $data),
- 'Prefer Includes in the Includes folder'
- );
-
- $this->assertEquals(
- "tests:( Namespace/Includes/IncludedOnceSub.ss\n )",
- $this->render('tests:( <% include Namespace\\IncludedOnceSub %> )', $data),
- 'Includes in only Includes folder can be found'
- );
-
- $this->assertEquals(
- "tests:( Namespace/IncludedOnceBase.ss\n )",
- $this->render('tests:( <% include Namespace\\IncludedOnceBase %> )', $data),
- 'Includes outside of Includes folder can be found'
- );
- }
-
- public function testRecursiveInclude()
- {
- $view = new SSViewer(['Includes/SSViewerTestRecursiveInclude']);
-
- $data = new ArrayData(
- [
- 'Title' => 'A',
- 'Children' => new ArrayList(
- [
- new ArrayData(
- [
- 'Title' => 'A1',
- 'Children' => new ArrayList(
- [
- new ArrayData([ 'Title' => 'A1 i', ]),
- new ArrayData([ 'Title' => 'A1 ii', ]),
- ]
- ),
- ]
- ),
- new ArrayData([ 'Title' => 'A2', ]),
- new ArrayData([ 'Title' => 'A3', ]),
- ]
- ),
- ]
- );
-
- $result = $view->process($data);
- // We don't care about whitespace
- $rationalisedResult = trim(preg_replace('/\s+/', ' ', $result ?? '') ?? '');
-
- $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
- }
-
- public function assertEqualIgnoringWhitespace($a, $b, $message = '')
- {
- $this->assertEquals(preg_replace('/\s+/', '', $a ?? ''), preg_replace('/\s+/', '', $b ?? ''), $message);
- }
-
- /**
- * See {@link ModelDataTest} for more extensive casting tests,
- * this test just ensures that basic casting is correctly applied during template parsing.
- */
- public function testCastingHelpers()
- {
- $vd = new SSViewerTest\TestModelData();
- $vd->TextValue = 'html';
- $vd->HTMLValue = 'html';
- $vd->UncastedValue = 'html';
-
- // Value casted as "Text"
- $this->assertEquals(
- '<b>html</b>',
- $t = SSViewer::fromString('$TextValue')->process($vd)
- );
- $this->assertEquals(
- 'html',
- $t = SSViewer::fromString('$TextValue.RAW')->process($vd)
- );
- $this->assertEquals(
- '<b>html</b>',
- $t = SSViewer::fromString('$TextValue.XML')->process($vd)
- );
-
- // Value casted as "HTMLText"
- $this->assertEquals(
- 'html',
- $t = SSViewer::fromString('$HTMLValue')->process($vd)
- );
- $this->assertEquals(
- 'html',
- $t = SSViewer::fromString('$HTMLValue.RAW')->process($vd)
- );
- $this->assertEquals(
- '<b>html</b>',
- $t = SSViewer::fromString('$HTMLValue.XML')->process($vd)
- );
-
- // Uncasted value (falls back to ModelData::$default_cast="Text")
- $vd = new SSViewerTest\TestModelData();
- $vd->UncastedValue = 'html';
- $this->assertEquals(
- '<b>html</b>',
- $t = SSViewer::fromString('$UncastedValue')->process($vd)
- );
- $this->assertEquals(
- 'html',
- $t = SSViewer::fromString('$UncastedValue.RAW')->process($vd)
- );
- $this->assertEquals(
- '<b>html</b>',
- $t = SSViewer::fromString('$UncastedValue.XML')->process($vd)
- );
- }
-
- public static function provideLoop(): array
- {
- return [
- 'nested array and iterator' => [
- 'iterable' => [
- [
- 'value 1',
- 'value 2',
- ],
- new ArrayList([
- 'value 3',
- 'value 4',
- ]),
- ],
- 'template' => '<% loop $Iterable %><% loop $Me %>$Me<% end_loop %><% end_loop %>',
- 'expected' => 'value 1 value 2 value 3 value 4',
- ],
- 'nested associative arrays' => [
- 'iterable' => [
- [
- 'Foo' => 'one',
- ],
- [
- 'Foo' => 'two',
- ],
- [
- 'Foo' => 'three',
- ],
- ],
- 'template' => '<% loop $Iterable %>$Foo<% end_loop %>',
- 'expected' => 'one two three',
- ],
- ];
- }
-
- #[DataProvider('provideLoop')]
- public function testLoop(iterable $iterable, string $template, string $expected): void
- {
- $data = new ArrayData(['Iterable' => $iterable]);
- $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
- }
-
- public static function provideCountIterable(): array
- {
- $scenarios = [
- 'empty array' => [
- 'iterable' => [],
- 'inScope' => false,
- ],
- 'array' => [
- 'iterable' => [1, 2, 3],
- 'inScope' => false,
- ],
- 'ArrayList' => [
- 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]),
- 'inScope' => false,
- ],
- ];
- foreach ($scenarios as $name => $scenario) {
- $scenario['inScope'] = true;
- $scenarios[$name . ' in scope'] = $scenario;
- }
- return $scenarios;
- }
-
- #[DataProvider('provideCountIterable')]
- public function testCountIterable(iterable $iterable, bool $inScope): void
- {
- $expected = count($iterable);
- $data = new ArrayData(['Iterable' => $iterable]);
- if ($inScope) {
- $template = '<% with $Iterable %>$Count<% end_with %>';
- } else {
- $template = '$Iterable.Count';
- }
- $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data));
- }
-
- public function testSSViewerBasicIteratorSupport()
- {
- $data = new ArrayData(
- [
- 'Set' => new ArrayList(
- [
- new SSViewerTest\TestObject("1"),
- new SSViewerTest\TestObject("2"),
- new SSViewerTest\TestObject("3"),
- new SSViewerTest\TestObject("4"),
- new SSViewerTest\TestObject("5"),
- new SSViewerTest\TestObject("6"),
- new SSViewerTest\TestObject("7"),
- new SSViewerTest\TestObject("8"),
- new SSViewerTest\TestObject("9"),
- new SSViewerTest\TestObject("10"),
- ]
- )
- ]
- );
-
- //base test
- $result = $this->render('<% loop Set %>$Number<% end_loop %>', $data);
- $this->assertEquals("12345678910", $result, "Numbers rendered in order");
-
- //test First
- $result = $this->render('<% loop Set %><% if $IsFirst %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("1", $result, "Only the first number is rendered");
-
- //test Last
- $result = $this->render('<% loop Set %><% if $IsLast %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("10", $result, "Only the last number is rendered");
-
- //test Even
- $result = $this->render('<% loop Set %><% if $Even() %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("246810", $result, "Even numbers rendered in order");
-
- //test Even with quotes
- $result = $this->render('<% loop Set %><% if $Even("1") %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("246810", $result, "Even numbers rendered in order");
-
- //test Even without quotes
- $result = $this->render('<% loop Set %><% if $Even(1) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("246810", $result, "Even numbers rendered in order");
-
- //test Even with zero-based start index
- $result = $this->render('<% loop Set %><% if $Even("0") %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("13579", $result, "Even (with zero-based index) numbers rendered in order");
-
- //test Odd
- $result = $this->render('<% loop Set %><% if $Odd %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("13579", $result, "Odd numbers rendered in order");
-
- //test FirstLast
- $result = $this->render('<% loop Set %><% if $FirstLast %>$Number$FirstLast<% end_if %><% end_loop %>', $data);
- $this->assertEquals("1first10last", $result, "First and last numbers rendered in order");
-
- //test Middle
- $result = $this->render('<% loop Set %><% if $Middle %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("23456789", $result, "Middle numbers rendered in order");
-
- //test MiddleString
- $result = $this->render(
- '<% loop Set %><% if MiddleString == "middle" %>$Number$MiddleString<% end_if %>'
- . '<% end_loop %>',
- $data
- );
- $this->assertEquals(
- "2middle3middle4middle5middle6middle7middle8middle9middle",
- $result,
- "Middle numbers rendered in order"
- );
-
- //test EvenOdd
- $result = $this->render('<% loop Set %>$EvenOdd<% end_loop %>', $data);
- $this->assertEquals(
- "oddevenoddevenoddevenoddevenoddeven",
- $result,
- "Even and Odd is returned in sequence numbers rendered in order"
- );
-
- //test Pos
- $result = $this->render('<% loop Set %>$Pos<% end_loop %>', $data);
- $this->assertEquals("12345678910", $result, '$Pos is rendered in order');
-
- //test Pos
- $result = $this->render('<% loop Set %>$Pos(0)<% end_loop %>', $data);
- $this->assertEquals("0123456789", $result, '$Pos(0) is rendered in order');
-
- //test FromEnd
- $result = $this->render('<% loop Set %>$FromEnd<% end_loop %>', $data);
- $this->assertEquals("10987654321", $result, '$FromEnd is rendered in order');
-
- //test FromEnd
- $result = $this->render('<% loop Set %>$FromEnd(0)<% end_loop %>', $data);
- $this->assertEquals("9876543210", $result, '$FromEnd(0) rendered in order');
-
- //test Total
- $result = $this->render('<% loop Set %>$TotalItems<% end_loop %>', $data);
- $this->assertEquals("10101010101010101010", $result, "10 total items X 10 are returned");
-
- //test Modulus
- $result = $this->render('<% loop Set %>$Modulus(2,1)<% end_loop %>', $data);
- $this->assertEquals("1010101010", $result, "1-indexed pos modular divided by 2 rendered in order");
-
- //test MultipleOf 3
- $result = $this->render('<% loop Set %><% if MultipleOf(3) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("369", $result, "Only numbers that are multiples of 3 are returned");
-
- //test MultipleOf 4
- $result = $this->render('<% loop Set %><% if MultipleOf(4) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("48", $result, "Only numbers that are multiples of 4 are returned");
-
- //test MultipleOf 5
- $result = $this->render('<% loop Set %><% if MultipleOf(5) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("510", $result, "Only numbers that are multiples of 5 are returned");
-
- //test MultipleOf 10
- $result = $this->render('<% loop Set %><% if MultipleOf(10,1) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("10", $result, "Only numbers that are multiples of 10 (with 1-based indexing) are returned");
-
- //test MultipleOf 9 zero-based
- $result = $this->render('<% loop Set %><% if MultipleOf(9,0) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals(
- "110",
- $result,
- "Only numbers that are multiples of 9 with zero-based indexing are returned. (The first and last item)"
- );
-
- //test MultipleOf 11
- $result = $this->render('<% loop Set %><% if MultipleOf(11) %>$Number<% end_if %><% end_loop %>', $data);
- $this->assertEquals("", $result, "Only numbers that are multiples of 11 are returned. I.e. nothing returned");
- }
-
- /**
- * Test $Up works when the scope $Up refers to was entered with a "with" block
- */
- public function testUpInWith()
- {
-
- // Data to run the loop tests on - three levels deep
- $data = new ArrayData(
- [
- 'Name' => 'Top',
- 'Foo' => new ArrayData(
- [
- 'Name' => 'Foo',
- 'Bar' => new ArrayData(
- [
- 'Name' => 'Bar',
- 'Baz' => new ArrayData(
- [
- 'Name' => 'Baz'
- ]
- ),
- 'Qux' => new ArrayData(
- [
- 'Name' => 'Qux'
- ]
- )
- ]
- )
- ]
- )
- ]
- );
-
- // Basic functionality
- $this->assertEquals(
- 'BarFoo',
- $this->render('<% with Foo %><% with Bar %>{$Name}{$Up.Name}<% end_with %><% end_with %>', $data)
- );
-
- // Two level with block, up refers to internally referenced Bar
- $this->assertEquals(
- 'BarTop',
- $this->render('<% with Foo.Bar %>{$Name}{$Up.Name}<% end_with %>', $data)
- );
-
- // Stepping up & back down the scope tree
- $this->assertEquals(
- 'BazFooBar',
- $this->render('<% with Foo.Bar.Baz %>{$Name}{$Up.Foo.Name}{$Up.Foo.Bar.Name}<% end_with %>', $data)
- );
-
- // Using $Up in a with block
- $this->assertEquals(
- 'BazTopBar',
- $this->render(
- '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}{$Foo.Bar.Name}<% end_with %>'
- . '<% end_with %>',
- $data
- )
- );
-
- // Stepping up & back down the scope tree with with blocks
- $this->assertEquals(
- 'BazTopBarTopBaz',
- $this->render(
- '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}<% with Foo.Bar %>{$Name}<% end_with %>'
- . '{$Name}<% end_with %>{$Name}<% end_with %>',
- $data
- )
- );
-
- // Using $Up.Up, where first $Up points to a previous scope entered using $Up, thereby skipping up to Foo
- $this->assertEquals(
- 'Foo',
- $this->render(
- '<% with Foo %><% with Bar %><% with Baz %>{$Up.Up.Name}<% end_with %><% end_with %>'
- . '<% end_with %>',
- $data
- )
- );
-
- // Using $Up as part of a lookup chain in <% with %>
- $this->assertEquals(
- 'Top',
- $this->render('<% with Foo.Bar.Baz.Up.Qux %>{$Up.Name}<% end_with %>', $data)
- );
- }
-
- public function testTooManyUps()
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage("Up called when we're already at the top of the scope");
- $data = new ArrayData([
- 'Foo' => new ArrayData([
- 'Name' => 'Foo',
- 'Bar' => new ArrayData([
- 'Name' => 'Bar'
- ])
- ])
- ]);
-
- $this->assertEquals(
- 'Foo',
- $this->render('<% with Foo.Bar %>{$Up.Up.Name}<% end_with %>', $data)
- );
- }
-
- /**
- * Test $Up works when the scope $Up refers to was entered with a "loop" block
- */
- public function testUpInLoop()
- {
-
- // Data to run the loop tests on - one sequence of three items, each with a subitem
- $data = new ArrayData(
- [
- 'Name' => 'Top',
- 'Foo' => new ArrayList(
- [
- new ArrayData(
- [
- 'Name' => '1',
- 'Sub' => new ArrayData(
- [
- 'Name' => 'Bar'
- ]
- )
- ]
- ),
- new ArrayData(
- [
- 'Name' => '2',
- 'Sub' => new ArrayData(
- [
- 'Name' => 'Baz'
- ]
- )
- ]
- ),
- new ArrayData(
- [
- 'Name' => '3',
- 'Sub' => new ArrayData(
- [
- 'Name' => 'Qux'
- ]
- )
- ]
- )
- ]
- )
- ]
- );
-
- // Make sure inside a loop, $Up refers to the current item of the loop
$this->assertEqualIgnoringWhitespace(
- '111 222 333',
- $this->render(
- '<% loop $Foo %>$Name<% with $Sub %>$Up.Name<% end_with %>$Name<% end_loop %>',
- $data
- )
- );
-
- // Make sure inside a loop, looping over $Up uses a separate iterator,
- // and doesn't interfere with the original iterator
- $this->assertEqualIgnoringWhitespace(
- '1Bar123Bar1 2Baz123Baz2 3Qux123Qux3',
- $this->render(
- '<% loop $Foo %>
- $Name
- <% with $Sub %>
- $Name
- <% loop $Up %>$Name<% end_loop %>
- $Name
- <% end_with %>
- $Name
- <% end_loop %>',
- $data
- )
- );
-
- // Make sure inside a loop, looping over $Up uses a separate iterator,
- // and doesn't interfere with the original iterator or local lookups
- $this->assertEqualIgnoringWhitespace(
- '1 Bar1 123 1Bar 1 2 Baz2 123 2Baz 2 3 Qux3 123 3Qux 3',
- $this->render(
- '<% loop $Foo %>
- $Name
- <% with $Sub %>
- {$Name}{$Up.Name}
- <% loop $Up %>$Name<% end_loop %>
- {$Up.Name}{$Name}
- <% end_with %>
- $Name
- <% end_loop %>',
- $data
- )
- );
- }
-
- /**
- * Test that nested loops restore the loop variables correctly when pushing and popping states
- */
- public function testNestedLoops()
- {
-
- // Data to run the loop tests on - one sequence of three items, one with child elements
- // (of a different size to the main sequence)
- $data = new ArrayData(
- [
- 'Foo' => new ArrayList(
- [
- new ArrayData(
- [
- 'Name' => '1',
- 'Children' => new ArrayList(
- [
- new ArrayData(
- [
- 'Name' => 'a'
- ]
- ),
- new ArrayData(
- [
- 'Name' => 'b'
- ]
- ),
- ]
- ),
- ]
- ),
- new ArrayData(
- [
- 'Name' => '2',
- 'Children' => new ArrayList(),
- ]
- ),
- new ArrayData(
- [
- 'Name' => '3',
- 'Children' => new ArrayList(),
- ]
- ),
- ]
- ),
- ]
- );
-
- // Make sure that including a loop inside a loop will not destroy the internal count of
- // items, checked by using "Last"
- $this->assertEqualIgnoringWhitespace(
- '1ab23last',
- $this->render(
- '<% loop $Foo %>$Name<% loop Children %>$Name<% end_loop %><% if $IsLast %>last<% end_if %>'
- . '<% end_loop %>',
- $data
- )
- );
- }
-
- public function testLayout()
- {
- $this->useTestTheme(
- __DIR__ . '/SSViewerTest',
- 'layouttest',
- function () {
- $template = new SSViewer(['Page']);
- $this->assertEquals("Foo\n\n", $template->process(new ArrayData([])));
-
- $template = new SSViewer(['Shortcodes', 'Page']);
- $this->assertEquals("[file_link]\n\n", $template->process(new ArrayData([])));
- }
+ '',
+ $result2
);
}
@@ -1874,7 +66,7 @@ after'
__DIR__ . '/SSViewerTest',
'layouttest',
function () {
- // Test passing a string
+ // Test passing a string
$templates = SSViewer::get_templates_by_class(
SSViewerTestModelController::class,
'',
@@ -1897,7 +89,7 @@ after'
$templates
);
- // Test to ensure we're stopping at the base class.
+ // Test to ensure we're stopping at the base class.
$templates = SSViewer::get_templates_by_class(
SSViewerTestModelController::class,
'',
@@ -1915,7 +107,7 @@ after'
$templates
);
- // Make sure we can search templates by suffix.
+ // Make sure we can search templates by suffix.
$templates = SSViewer::get_templates_by_class(
SSViewerTestModel::class,
'Controller',
@@ -1939,7 +131,7 @@ after'
// Let's throw something random in there.
$this->expectException(\InvalidArgumentException::class);
- SSViewer::get_templates_by_class(null);
+ SSViewer::get_templates_by_class('no-class');
}
);
}
@@ -1947,94 +139,74 @@ after'
public function testRewriteHashlinks()
{
SSViewer::setRewriteHashLinksDefault(true);
+ $oldServerVars = $_SERVER;
- $_SERVER['HTTP_HOST'] = 'www.mysite.com';
- $_SERVER['REQUEST_URI'] = '//file.com?foo"onclick="alert(\'xss\')""';
+ try {
+ $_SERVER['REQUEST_URI'] = '//file.com?foo"onclick="alert(\'xss\')""';
- // Emulate SSViewer::process()
- // Note that leading double slashes have been rewritten to prevent these being mis-interepreted
- // as protocol-less absolute urls
- $base = Convert::raw2att('/file.com?foo"onclick="alert(\'xss\')""');
+ // Note that leading double slashes have been rewritten to prevent these being mis-interepreted
+ // as protocol-less absolute urls
+ $base = Convert::raw2att('/file.com?foo"onclick="alert(\'xss\')""');
- $tmplFile = TEMP_PATH . DIRECTORY_SEPARATOR . 'SSViewerTest_testRewriteHashlinks_' . sha1(rand()) . '.ss';
-
- // Note: SSViewer_FromString doesn't rewrite hash links.
- file_put_contents(
- $tmplFile ?? '',
- '
-
- <% base_tag %>
-
- ExternalInlineLink
- $ExternalInsertedLink
- InlineLink
- $InsertedLink
-
-
- '
- );
- $tmpl = new SSViewer($tmplFile);
- $obj = new ModelData();
- $obj->InsertedLink = DBField::create_field(
- 'HTMLFragment',
- 'InsertedLink'
- );
- $obj->ExternalInsertedLink = DBField::create_field(
- 'HTMLFragment',
- 'ExternalInsertedLink'
- );
- $result = $tmpl->process($obj);
- $this->assertStringContainsString(
- 'InsertedLink',
- $result
- );
- $this->assertStringContainsString(
- 'ExternalInsertedLink',
- $result
- );
- $this->assertStringContainsString(
- 'InlineLink',
- $result
- );
- $this->assertStringContainsString(
- 'ExternalInlineLink',
- $result
- );
- $this->assertStringContainsString(
- '',
- $result,
- 'SSTemplateParser should only rewrite anchor hrefs'
- );
-
- unlink($tmplFile ?? '');
+ $engine = new DummyTemplateEngine();
+ $engine->setOutput(
+ '
+
+
+
+ ExternalInlineLink
+ ExternalInsertedLink
+ InlineLink
+ InsertedLink
+
+
+ '
+ );
+ $tmpl = new SSViewer([], $engine);
+ $result = $tmpl->process('pretend this is a model');
+ $this->assertStringContainsString(
+ 'InsertedLink',
+ $result
+ );
+ $this->assertStringContainsString(
+ 'ExternalInsertedLink',
+ $result
+ );
+ $this->assertStringContainsString(
+ 'InlineLink',
+ $result
+ );
+ $this->assertStringContainsString(
+ 'ExternalInlineLink',
+ $result
+ );
+ $this->assertStringContainsString(
+ '',
+ $result,
+ 'SSTemplateParser should only rewrite anchor hrefs'
+ );
+ } finally {
+ $_SERVER = $oldServerVars;
+ }
}
public function testRewriteHashlinksInPhpMode()
{
SSViewer::setRewriteHashLinksDefault('php');
-
- $tmplFile = TEMP_PATH . DIRECTORY_SEPARATOR . 'SSViewerTest_testRewriteHashlinksInPhpMode_' . sha1(rand()) . '.ss';
-
- // Note: SSViewer_FromString doesn't rewrite hash links.
- file_put_contents(
- $tmplFile ?? '',
+ $engine = new DummyTemplateEngine();
+ $engine->setOutput(
'
-
- <% base_tag %>
-
- InlineLink
- $InsertedLink
-
-
- '
+
+
+
+ InlineLink
+ InsertedLink
+
+
+ '
);
- $tmpl = new SSViewer($tmplFile);
- $obj = new ModelData();
- $obj->InsertedLink = DBField::create_field(
- 'HTMLFragment',
- 'InsertedLink'
- );
- $result = $tmpl->process($obj);
+ $tmpl = new SSViewer([], $engine);
+ $result = $tmpl->process('pretend this is a model');
$code = <<<'EOC'
#anchor">InsertedLink
@@ -2045,339 +217,10 @@ EOC;
$result,
'SSTemplateParser should only rewrite anchor hrefs'
);
-
- unlink($tmplFile ?? '');
}
- public function testRenderWithSourceFileComments()
+ private function assertEqualIgnoringWhitespace(string $a, string $b, string $message = ''): void
{
- SSViewer::config()->set('source_file_comments', true);
- $i = __DIR__ . '/SSViewerTest/templates/Includes';
- $f = __DIR__ . '/SSViewerTest/templates/SSViewerTestComments';
- $templates = [
- [
- 'name' => 'SSViewerTestCommentsFullSource',
- 'expected' => ""
- . ""
- . ""
- . ""
- . "\t"
- . "\t"
- . ""
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsFullSourceHTML4Doctype',
- 'expected' => ""
- . ""
- . ""
- . ""
- . "\t"
- . "\t"
- . ""
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsFullSourceNoDoctype',
- 'expected' => ""
- . ""
- . "\t"
- . "\t"
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsFullSourceIfIE',
- 'expected' => ""
- . ""
- . ""
- . ""
- . ""
- . " "
- . "\t"
- . "\t"
- . ""
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsFullSourceIfIENoDoctype',
- 'expected' => ""
- . ""
- . ""
- . " "
- . ""
- . " "
- . "\t"
- . "\t"
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsPartialSource',
- 'expected' =>
- ""
- . ""
- . "",
- ],
- [
- 'name' => 'SSViewerTestCommentsWithInclude',
- 'expected' =>
- ""
- . ""
- . ""
- . ""
- . "Included"
- . ""
- . ""
- . "
"
- . "",
- ],
- ];
- foreach ($templates as $template) {
- $this->_renderWithSourceFileComments('SSViewerTestComments/' . $template['name'], $template['expected']);
- }
- }
- private function _renderWithSourceFileComments($name, $expected)
- {
- $viewer = new SSViewer([$name]);
- $data = new ArrayData([]);
- $result = $viewer->process($data);
- $expected = str_replace(["\r", "\n"], '', $expected ?? '');
- $result = str_replace(["\r", "\n"], '', $result ?? '');
- $this->assertEquals($result, $expected);
- }
-
- public function testLoopIteratorIterator()
- {
- $list = new PaginatedList(new ArrayList());
- $viewer = new SSViewer_FromString('<% loop List %>$ID - $FirstName
<% end_loop %>');
- $result = $viewer->process(new ArrayData(['List' => $list]));
- $this->assertEquals($result, '');
- }
-
- public function testProcessOnlyIncludesRequirementsOnce()
- {
- $template = new SSViewer(['SSViewerTestProcess']);
- $basePath = $this->getCurrentRelativePath() . '/SSViewerTest';
-
- $backend = Injector::inst()->create(Requirements_Backend::class);
- $backend->setCombinedFilesEnabled(false);
- $backend->combineFiles(
- 'RequirementsTest_ab.css',
- [
- $basePath . '/css/RequirementsTest_a.css',
- $basePath . '/css/RequirementsTest_b.css'
- ]
- );
-
- Requirements::set_backend($backend);
-
- $this->assertEquals(1, substr_count($template->process(new ModelData()) ?? '', "a.css"));
- $this->assertEquals(1, substr_count($template->process(new ModelData()) ?? '', "b.css"));
-
- // if we disable the requirements then we should get nothing
- $template->includeRequirements(false);
- $this->assertEquals(0, substr_count($template->process(new ModelData()) ?? '', "a.css"));
- $this->assertEquals(0, substr_count($template->process(new ModelData()) ?? '', "b.css"));
- }
-
- public function testRequireCallInTemplateInclude()
- {
- if (FRAMEWORK_DIR === 'framework') {
- $template = new SSViewer(['SSViewerTestProcess']);
-
- Requirements::set_suffix_requirements(false);
-
- $this->assertEquals(
- 1,
- substr_count(
- $template->process(new ModelData()) ?? '',
- "tests/php/View/SSViewerTest/javascript/RequirementsTest_a.js"
- )
- );
- } else {
- $this->markTestSkipped(
- 'Requirement will always fail if the framework dir is not ' .
- 'named \'framework\', since templates require hard coded paths'
- );
- }
- }
-
- public function testCallsWithArguments()
- {
- $data = new ArrayData(
- [
- 'Set' => new ArrayList(
- [
- new SSViewerTest\TestObject("1"),
- new SSViewerTest\TestObject("2"),
- new SSViewerTest\TestObject("3"),
- new SSViewerTest\TestObject("4"),
- new SSViewerTest\TestObject("5"),
- ]
- ),
- 'Level' => new SSViewerTest\LevelTestData(1),
- 'Nest' => [
- 'Level' => new SSViewerTest\LevelTestData(2),
- ],
- ]
- );
-
- $tests = [
- '$Level.output(1)' => '1-1',
- '$Nest.Level.output($Set.First.Number)' => '2-1',
- '<% with $Set %>$Up.Level.output($First.Number)<% end_with %>' => '1-1',
- '<% with $Set %>$Top.Nest.Level.output($First.Number)<% end_with %>' => '2-1',
- '<% loop $Set %>$Up.Nest.Level.output($Number)<% end_loop %>' => '2-12-22-32-42-5',
- '<% loop $Set %>$Top.Level.output($Number)<% end_loop %>' => '1-11-21-31-41-5',
- '<% with $Nest %>$Level.output($Top.Set.First.Number)<% end_with %>' => '2-1',
- '<% with $Level %>$output($Up.Set.Last.Number)<% end_with %>' => '1-5',
- '<% with $Level.forWith($Set.Last.Number) %>$output("hi")<% end_with %>' => '5-hi',
- '<% loop $Level.forLoop($Set.First.Number) %>$Number<% end_loop %>' => '!0',
- '<% with $Nest %>
- <% with $Level.forWith($Up.Set.First.Number) %>$output("hi")<% end_with %>
- <% end_with %>' => '1-hi',
- '<% with $Nest %>
- <% loop $Level.forLoop($Top.Set.Last.Number) %>$Number<% end_loop %>
- <% end_with %>' => '!0!1!2!3!4',
- ];
-
- foreach ($tests as $template => $expected) {
- $this->assertEquals($expected, trim($this->render($template, $data) ?? ''));
- }
- }
-
- public function testRepeatedCallsAreCached()
- {
- $data = new SSViewerTest\CacheTestData();
- $template = '
- <% if $TestWithCall %>
- <% with $TestWithCall %>
- {$Message}
- <% end_with %>
-
- {$TestWithCall.Message}
- <% end_if %>';
-
- $this->assertEquals('HiHi', preg_replace('/\s+/', '', $this->render($template, $data) ?? ''));
- $this->assertEquals(
- 1,
- $data->testWithCalls,
- 'SSViewerTest_CacheTestData::TestWithCall() should only be called once. Subsequent calls should be cached'
- );
-
- $data = new SSViewerTest\CacheTestData();
- $template = '
- <% if $TestLoopCall %>
- <% loop $TestLoopCall %>
- {$Message}
- <% end_loop %>
- <% end_if %>';
-
- $this->assertEquals('OneTwo', preg_replace('/\s+/', '', $this->render($template, $data) ?? ''));
- $this->assertEquals(
- 1,
- $data->testLoopCalls,
- 'SSViewerTest_CacheTestData::TestLoopCall() should only be called once. Subsequent calls should be cached'
- );
- }
-
- public function testClosedBlockExtension()
- {
- $count = 0;
- $parser = new SSTemplateParser();
- $parser->addClosedBlock(
- 'test',
- function ($res) use (&$count) {
- $count++;
- }
- );
-
- $template = new SSViewer_FromString("<% test %><% end_test %>", $parser);
- $template->process(new SSViewerTest\TestFixture());
-
- $this->assertEquals(1, $count);
- }
-
- public function testOpenBlockExtension()
- {
- $count = 0;
- $parser = new SSTemplateParser();
- $parser->addOpenBlock(
- 'test',
- function ($res) use (&$count) {
- $count++;
- }
- );
-
- $template = new SSViewer_FromString("<% test %>", $parser);
- $template->process(new SSViewerTest\TestFixture());
-
- $this->assertEquals(1, $count);
- }
-
- /**
- * Tests if caching for SSViewer_FromString is working
- */
- public function testFromStringCaching()
- {
- $content = 'Test content';
- $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache.' . sha1($content ?? '');
- if (file_exists($cacheFile ?? '')) {
- unlink($cacheFile ?? '');
- }
-
- // Test global behaviors
- $this->render($content, null, null);
- $this->assertFalse(file_exists($cacheFile ?? ''), 'Cache file was created when caching was off');
-
- SSViewer_FromString::config()->set('cache_template', true);
- $this->render($content, null, null);
- $this->assertTrue(file_exists($cacheFile ?? ''), 'Cache file wasn\'t created when it was meant to');
- unlink($cacheFile ?? '');
-
- // Test instance behaviors
- $this->render($content, null, false);
- $this->assertFalse(file_exists($cacheFile ?? ''), 'Cache file was created when caching was off');
-
- $this->render($content, null, true);
- $this->assertTrue(file_exists($cacheFile ?? ''), 'Cache file wasn\'t created when it was meant to');
- unlink($cacheFile ?? '');
- }
-
- public function testPrimitivesConvertedToDBFields()
- {
- $data = new ArrayData([
- // null value should not be rendered, though should also not throw exception
- 'Foo' => new ArrayList(['hello', true, 456, 7.89, null])
- ]);
- $this->assertEqualIgnoringWhitespace(
- 'hello 1 456 7.89',
- $this->render('<% loop $Foo %>$Me<% end_loop %>', $data)
- );
- }
-
- #[DoesNotPerformAssertions]
- public function testMe(): void
- {
- $myArrayData = new class extends ArrayData {
- public function forTemplate()
- {
- return '';
- }
- };
- $this->render('$Me', $myArrayData);
- }
-
- public function testLoopingThroughArrayInOverlay(): void
- {
- $modelData = new ModelData();
- $theArray = [
- ['Val' => 'one'],
- ['Val' => 'two'],
- ['Val' => 'red'],
- ['Val' => 'blue'],
- ];
- $output = $modelData->renderWith('SSViewerTestLoopArray', ['MyArray' => $theArray]);
- $this->assertEqualIgnoringWhitespace('one two red blue', $output);
+ $this->assertEquals(preg_replace('/\s+/', '', $a ), preg_replace('/\s+/', '', $b), $message);
}
}
diff --git a/tests/php/View/SSViewerTest/DummyTemplateEngine.php b/tests/php/View/SSViewerTest/DummyTemplateEngine.php
new file mode 100644
index 000000000..9800aaf4d
--- /dev/null
+++ b/tests/php/View/SSViewerTest/DummyTemplateEngine.php
@@ -0,0 +1,45 @@
+';
+
+ public function __construct(string|array $templateCandidates = [])
+ {
+ // no-op
+ }
+
+ public function setTemplate(string|array $templateCandidates): static
+ {
+ return $this;
+ }
+
+ public function hasTemplate(string|array $templateCandidates): bool
+ {
+ return true;
+ }
+
+ public function renderString(string $template, ViewLayerData $model, array $overlay = [], bool $cache = true): string
+ {
+ return $this->output;
+ }
+
+ public function render(ViewLayerData $model, array $overlay = []): string
+ {
+ return $this->output;
+ }
+
+ public function setOutput(string $output): void
+ {
+ $this->output = $output;
+ }
+}
diff --git a/tests/php/View/SSViewerTest/TestFixture.php b/tests/php/View/SSViewerTest/TestFixture.php
deleted file mode 100644
index f0abb39bc..000000000
--- a/tests/php/View/SSViewerTest/TestFixture.php
+++ /dev/null
@@ -1,72 +0,0 @@
-name = $name;
- parent::__construct();
- }
-
- private function argedName($fieldName, $arguments)
- {
- $childName = $this->name ? "$this->name.$fieldName" : $fieldName;
- if ($arguments) {
- return $childName . '(' . implode(',', $arguments) . ')';
- } else {
- return $childName;
- }
- }
-
- public function obj(
- string $fieldName,
- array $arguments = [],
- bool $cache = false,
- ?string $cacheName = null
- ): ?object {
- $childName = $this->argedName($fieldName, $arguments);
-
- // Special field name Loop### to create a list
- if (preg_match('/^Loop([0-9]+)$/', $fieldName ?? '', $matches)) {
- $output = new ArrayList();
- for ($i = 0; $i < $matches[1]; $i++) {
- $output->push(new TestFixture($childName));
- }
- return $output;
- } else {
- if (preg_match('/NotSet/i', $fieldName ?? '')) {
- return new ModelData();
- } else {
- return new TestFixture($childName);
- }
- }
- }
-
- public function XML_val(string $fieldName, array $arguments = [], bool $cache = false): string
- {
- if (preg_match('/NotSet/i', $fieldName ?? '')) {
- return '';
- } else {
- if (preg_match('/Raw/i', $fieldName ?? '')) {
- return $fieldName;
- } else {
- return '[out:' . $this->argedName($fieldName, $arguments) . ']';
- }
- }
- }
-
- public function hasValue(string $fieldName, array $arguments = [], bool $cache = true): bool
- {
- return (bool)$this->XML_val($fieldName, $arguments);
- }
-}
diff --git a/tests/php/View/SSViewerTest/TestGlobalProvider.php b/tests/php/View/SSViewerTest/TestGlobalProvider.php
deleted file mode 100644
index f005f24ce..000000000
--- a/tests/php/View/SSViewerTest/TestGlobalProvider.php
+++ /dev/null
@@ -1,51 +0,0 @@
- ['method' => 'get_html', 'casting' => 'HTMLFragment'],
- 'SSViewerTest_GlobalHTMLEscaped' => ['method' => 'get_html'],
-
- 'SSViewerTest_GlobalAutomatic',
- 'SSViewerTest_GlobalReferencedByString' => 'get_reference',
- 'SSViewerTest_GlobalReferencedInArray' => ['method' => 'get_reference'],
-
- 'SSViewerTest_GlobalThatTakesArguments' => ['method' => 'get_argmix', 'casting' => 'HTMLFragment'],
- 'SSViewerTest_GlobalReturnsNull' => 'getNull',
- ];
- }
-
- public static function get_html()
- {
- return '';
- }
-
- public static function SSViewerTest_GlobalAutomatic()
- {
- return 'automatic';
- }
-
- public static function get_reference()
- {
- return 'reference';
- }
-
- public static function get_argmix()
- {
- $args = func_get_args();
- return 'z' . implode(':', $args) . 'z';
- }
-
- public static function getNull()
- {
- return null;
- }
-}
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss
deleted file mode 100644
index 1a3cb8443..000000000
--- a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss
+++ /dev/null
@@ -1 +0,0 @@
-<% include SSViewerTestCommentsInclude %>
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss
deleted file mode 100644
index 6c106c703..000000000
--- a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss
+++ /dev/null
@@ -1,3 +0,0 @@
-<% loop Items %>
- <% include SSViewerTestIncludeScopeInheritanceInclude %>
-<% end_loop %>
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss
deleted file mode 100644
index d897bf044..000000000
--- a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss
+++ /dev/null
@@ -1,3 +0,0 @@
-<% loop Items %>
- <% include SSViewerTestIncludeScopeInheritanceInclude ArgA=$Title %>
-<% end_loop %>
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss
deleted file mode 100644
index 60561e017..000000000
--- a/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss
+++ /dev/null
@@ -1,6 +0,0 @@
-
- <% include SSViewerTestProcessHead %>
-
-
-
-
diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss b/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss
deleted file mode 100644
index e4284ad10..000000000
--- a/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss
+++ /dev/null
@@ -1 +0,0 @@
-SSViewerTest
diff --git a/tests/php/View/ViewLayerDataTest.php b/tests/php/View/ViewLayerDataTest.php
new file mode 100644
index 000000000..8718f111a
--- /dev/null
+++ b/tests/php/View/ViewLayerDataTest.php
@@ -0,0 +1,751 @@
+ [
+ ExtensibleObjectExtension::class
+ ],
+ ];
+
+ public static function provideGetIterator(): array
+ {
+ return [
+ 'non-iterable object' => [
+ 'data' => new ArrayData(['Field1' => 'value1', 'Field2' => 'value2']),
+ 'expected' => BadMethodCallException::class,
+ ],
+ 'non-iterable scalar' => [
+ 'data' => 'This is some text, aint iterable',
+ 'expected' => BadMethodCallException::class,
+ ],
+ 'empty array' => [
+ 'data' => [],
+ 'expected' => [],
+ ],
+ 'single item array' => [
+ 'data' => ['one value'],
+ 'expected' => ['one value'],
+ ],
+ 'multi-item array' => [
+ 'data' => ['one', 'two', 'three'],
+ 'expected' => ['one', 'two', 'three'],
+ ],
+ 'object implements an Iterable interface' => [
+ 'data' => new ArrayList(['one', 'two', 'three']),
+ 'expected' => ['one', 'two', 'three'],
+ ],
+ 'built-in PHP iterator' => [
+ 'data' => new ArrayIterator(['one', 'two', 'three']),
+ 'expected' => ['one', 'two', 'three'],
+ ],
+ 'non-iterable object with getIterator method' => [
+ 'data' => new NonIterableObject(),
+ 'expected' => ['some value', 'another value', 'isnt this nice'],
+ ],
+ 'extensible object with getIterator extension' => [
+ 'data' => new ExtensibleObject(),
+ 'expected' => ['1','2','3','4','5','6','7','8','9','a','b','c','d','e'],
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetIterator')]
+ public function testGetIterator(mixed $data, string|array $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ if ($expected === BadMethodCallException::class) {
+ $this->expectException(BadMethodCallException::class);
+ $this->expectExceptionMessageMatches('/is not iterable.$/');
+ }
+ $this->assertEquals($expected, iterator_to_array($viewLayerData->getIterator()));
+ // Ensure the iterator is always wrapping values
+ foreach ($viewLayerData as $value) {
+ $this->assertInstanceOf(ViewLayerData::class, $value);
+ }
+ }
+
+ public static function provideGetIteratorCount(): array
+ {
+ return [
+ 'uncountable object' => [
+ 'data' => new ArrayData(['Field1' => 'value1', 'Field2' => 'value2']),
+ 'expected' => 0,
+ ],
+ 'uncountable object - has count field' => [
+ 'data' => new ArrayData(['count' => 12, 'Field2' => 'value2']),
+ 'expected' => 12,
+ ],
+ 'uncountable object - has count field (non-int)' => [
+ 'data' => new ArrayData(['count' => 'aahhh', 'Field2' => 'value2']),
+ 'expected' => 0,
+ ],
+ 'empty array' => [
+ 'data' => [],
+ 'expected' => 0,
+ ],
+ 'array with values' => [
+ 'data' => [1, 2],
+ 'expected' => 2,
+ ],
+ 'explicitly countable object' => [
+ 'data' => new CountableObject(),
+ 'expected' => 53,
+ ],
+ 'non-countable object with getCount method' => [
+ 'data' => new GetCountObject(),
+ 'expected' => 12,
+ ],
+ 'non-countable object with getIterator method' => [
+ 'data' => new NonIterableObject(),
+ 'expected' => 3,
+ ],
+ 'extensible object with getIterator extension' => [
+ 'data' => new ExtensibleObject(),
+ 'expected' => 14,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetIteratorCount')]
+ public function testGetIteratorCount(mixed $data, int $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ $this->assertSame($expected, $viewLayerData->getIteratorCount());
+ }
+
+ public static function provideIsSet(): array
+ {
+ return [
+ 'list array' => [
+ 'data' => ['anything'],
+ 'name' => 'anything',
+ 'expected' => false,
+ ],
+ 'associative array has key' => [
+ 'data' => ['anything' => 'some value'],
+ 'name' => 'anything',
+ 'expected' => true,
+ ],
+ 'ModelData without field' => [
+ 'data' => new ArrayData(['nothing' => 'some value']),
+ 'name' => 'anything',
+ 'expected' => false,
+ ],
+ 'ModelData with field' => [
+ 'data' => new ArrayData(['anything' => 'some value']),
+ 'name' => 'anything',
+ 'expected' => true,
+ ],
+ 'extensible class with getter extension' => [
+ 'data' => new ExtensibleObject(),
+ 'name' => 'anything',
+ 'expected' => true,
+ ],
+ 'extensible class not set' => [
+ 'data' => new ExtensibleObject(),
+ 'name' => 'anythingelse',
+ 'expected' => false,
+ ],
+ 'class with method' => [
+ 'data' => new CountableObject(),
+ 'name' => 'count',
+ 'expected' => true,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideIsSet')]
+ public function testIsSet(mixed $data, string $name, bool $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ $this->assertSame($expected, isset($viewLayerData->$name));
+ }
+
+ public static function provideGet(): array
+ {
+ return [
+ 'basic field' => [
+ 'name' => 'SomeField',
+ 'throwException' => true,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'SomeField',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'method',
+ 'name' => 'getSomeField',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'property',
+ 'name' => 'SomeField',
+ ],
+ ],
+ ],
+ 'getter as property' => [
+ 'name' => 'getSomeField',
+ 'throwException' => true,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'getSomeField',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'method',
+ 'name' => 'getgetSomeField',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'property',
+ 'name' => 'getSomeField',
+ ],
+ ],
+ ],
+ 'basic field (lowercase)' => [
+ 'name' => 'somefield',
+ 'throwException' => true,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'somefield',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'method',
+ 'name' => 'getsomefield',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'property',
+ 'name' => 'somefield',
+ ],
+ ],
+ ],
+ 'property not set, dont even try it' => [
+ 'name' => 'NotSet',
+ 'throwException' => true,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'NotSet',
+ 'args' => [],
+ ],
+ [
+ 'type' => 'method',
+ 'name' => 'getNotSet',
+ 'args' => [],
+ ],
+ ],
+ ],
+ 'stops after method when not throwing' => [
+ 'name' => 'SomeField',
+ 'throwException' => false,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'SomeField',
+ 'args' => [],
+ ],
+ ],
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGet')]
+ public function testGet(string $name, bool $throwException, array $expected): void
+ {
+ $fixture = new TestFixture();
+ $fixture->throwException = $throwException;
+ $viewLayerData = new ViewLayerData($fixture);
+ $value = $viewLayerData->$name;
+ $this->assertSame($expected, $fixture->getRequested());
+ $this->assertNull($value);
+ }
+
+ public static function provideGetComplex(): array
+ {
+ // Note the actual value checks aren't very comprehensive here because that's done
+ // in more detail in testGetRawDataValue
+ return [
+ 'exception gets thrown if not __call() method' => [
+ 'name' => 'badMethodCall',
+ 'expectRequested' => BadMethodCallException::class,
+ 'expected' => null,
+ ],
+ 'returning nothing is like returning null' => [
+ 'name' => 'voidMethod',
+ 'expectRequested' => [
+ [
+ 'type' => 'method',
+ 'name' => 'voidMethod',
+ 'args' => [],
+ ],
+ ],
+ 'expected' => null,
+ ],
+ 'returned value is caught' => [
+ 'name' => 'justCallMethod',
+ 'expectRequested' => [
+ [
+ 'type' => 'method',
+ 'name' => 'justCallMethod',
+ 'args' => [],
+ ],
+ ],
+ 'expected' => 'This is a method value',
+ ],
+ 'getter is used' => [
+ 'name' => 'ActualValue',
+ 'expectRequested' => [
+ [
+ 'type' => 'method',
+ 'name' => 'getActualValue',
+ 'args' => [],
+ ],
+ ],
+ 'expected' => 'this is the value',
+ ],
+ 'if no method exists, only property is fetched' => [
+ 'name' => 'NoMethod',
+ 'expectRequested' => [
+ [
+ 'type' => 'property',
+ 'name' => 'NoMethod',
+ ],
+ ],
+ 'expected' => null,
+ ],
+ 'property value is caught' => [
+ 'name' => 'ActualValueField',
+ 'expectRequested' => [
+ [
+ 'type' => 'property',
+ 'name' => 'ActualValueField',
+ ],
+ ],
+ 'expected' => 'the value is here',
+ ],
+ 'not set and no method' => [
+ 'name' => 'NotSet',
+ 'expectRequested' => [],
+ 'expected' => null,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetComplex')]
+ public function testGetComplex(string $name, string|array $expectRequested, ?string $expected): void
+ {
+ $fixture = new TestFixtureComplex();
+ $viewLayerData = new ViewLayerData($fixture);
+ if ($expectRequested === BadMethodCallException::class) {
+ $this->expectException(BadMethodCallException::class);
+ }
+ $value = $viewLayerData->$name;
+ $this->assertSame($expectRequested, $fixture->getRequested());
+ $this->assertEquals($expected, $value);
+ // Ensure value is being wrapped when not null
+ if ($value !== null) {
+ $this->assertInstanceOf(ViewLayerData::class, $value);
+ }
+ }
+
+ public static function provideCall(): array
+ {
+ // Currently there is no distinction between trying to get a property or call a method from ViewLayerData
+ // so the "get" examples should produce the same results when calling a method.
+ $scenarios = static::provideGet();
+ foreach ($scenarios as &$scenario) {
+ $scenario['args'] = [];
+ }
+ return [
+ ...$scenarios,
+ 'basic field with args' => [
+ 'name' => 'SomeField',
+ 'args' => ['abc', 123],
+ 'throwException' => true,
+ 'expected' => [
+ [
+ 'type' => 'method',
+ 'name' => 'SomeField',
+ 'args' => ['abc', 123],
+ ],
+ [
+ 'type' => 'method',
+ 'name' => 'getSomeField',
+ 'args' => ['abc', 123],
+ ],
+ [
+ 'type' => 'property',
+ 'name' => 'SomeField',
+ ],
+ ],
+ ],
+ ];
+ }
+
+ #[DataProvider('provideCall')]
+ public function testCall(string $name, array $args, bool $throwException, array $expected): void
+ {
+ $fixture = new TestFixture();
+ $fixture->throwException = $throwException;
+ $viewLayerData = new ViewLayerData($fixture);
+ $value = $viewLayerData->$name(...$args);
+ $this->assertSame($expected, $fixture->getRequested());
+ $this->assertNull($value);
+ }
+
+ public static function provideCallComplex(): array
+ {
+ // Currently there is no distinction between trying to get a property or call a method from ViewLayerData
+ // so the "get" examples should produce the same results when calling a method.
+ return static::provideGetComplex();
+ }
+
+ #[DataProvider('provideCallComplex')]
+ public function testCallComplex(string $name, string|array $expectRequested, ?string $expected): void
+ {
+ $fixture = new TestFixtureComplex();
+ $viewLayerData = new ViewLayerData($fixture);
+ if ($expectRequested === BadMethodCallException::class) {
+ $this->expectException(BadMethodCallException::class);
+ }
+ $value = $viewLayerData->$name();
+ $this->assertSame($expectRequested, $fixture->getRequested());
+ $this->assertEquals($expected, $value);
+ // Ensure value is being wrapped when not null
+ if ($value !== null) {
+ $this->assertInstanceOf(ViewLayerData::class, $value);
+ }
+ }
+
+ public static function provideToString(): array
+ {
+ return [
+ // These three all evaluate to ArrayList or ArrayData, which don't have templates to render
+ 'empty array' => [
+ 'data' => [],
+ 'expected' => MissingTemplateException::class,
+ ],
+ 'array with values' => [
+ 'data' => ['value1', 'value2'],
+ 'expected' => MissingTemplateException::class,
+ ],
+ 'Class with no template' => [
+ // Note we won't check classes WITH templates because we're not testing the template engine here
+ 'data' => new ArrayData(['Field1' => 'value1', 'Field2' => 'value2']),
+ 'expected' => MissingTemplateException::class,
+ ],
+ 'string value' => [
+ 'data' => 'just a string',
+ 'expected' => 'just a string',
+ ],
+ 'html gets escaped by default' => [
+ 'data' => 'HTML string',
+ 'expected' => '<span>HTML string</span>',
+ ],
+ 'explicit HTML text not escaped' => [
+ 'data' => (new DBHTMLText())->setValue('HTML string'),
+ 'expected' => 'HTML string',
+ ],
+ 'DBField' => [
+ 'data' => (new DBDate())->setValue('2024-03-24'),
+ 'expected' => (new DBDate())->setValue('2024-03-24')->forTemplate(),
+ ],
+ '__toString() method' => [
+ 'data' => new StringableObject(),
+ 'expected' => 'This is the string representation',
+ ],
+ 'forTemplate called from extension' => [
+ 'data' => new ExtensibleObject(),
+ 'expected' => 'This text comes from the extension class',
+ ],
+ 'cannot convert this class to string' => [
+ 'data' => new CountableObject(),
+ 'expected' => Error::class,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideToString')]
+ public function testToString(mixed $data, string $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ if (is_a($expected, Throwable::class, true)) {
+ $this->expectException($expected);
+ }
+ $this->assertSame($expected, (string) $viewLayerData);
+ }
+
+ public static function provideHasDataValue(): array
+ {
+ return [
+ 'empty array' => [
+ 'data' => [],
+ 'name' => null,
+ 'expected' => false,
+ ],
+ 'empty ArrayList' => [
+ 'data' => new ArrayList(),
+ 'name' => null,
+ 'expected' => false,
+ ],
+ 'empty ArrayData' => [
+ 'data' => new ArrayData(),
+ 'name' => null,
+ 'expected' => false,
+ ],
+ 'empty ArrayIterator' => [
+ 'data' => new ArrayIterator(),
+ 'name' => null,
+ 'expected' => false,
+ ],
+ 'empty ModelData' => [
+ 'data' => new ModelData(),
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'non-countable object' => [
+ 'data' => new ExtensibleObject(),
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'array with data' => [
+ 'data' => [1,2,3],
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'associative array' => [
+ 'data' => ['one' => 1, 'two' => 2],
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'ArrayList with data' => [
+ 'data' => new ArrayList([1,2,3]),
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'ArrayData with data' => [
+ 'data' => new ArrayData(['one' => 1, 'two' => 2]),
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'ArrayIterator with data' => [
+ 'data' => new ArrayIterator([1,2,3]),
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'ArrayData missing value' => [
+ 'data' => new ArrayData(['one' => 1, 'two' => 2]),
+ 'name' => 'three',
+ 'expected' => false,
+ ],
+ 'ArrayData with truthy value' => [
+ 'data' => new ArrayData(['one' => 1, 'two' => 2]),
+ 'name' => 'one',
+ 'expected' => true,
+ ],
+ 'ArrayData with null value' => [
+ 'data' => new ArrayData(['nullVal' => null, 'two' => 2]),
+ 'name' => 'nullVal',
+ 'expected' => false,
+ ],
+ 'ArrayData with falsy value' => [
+ 'data' => new ArrayData(['zero' => 0, 'two' => 2]),
+ 'name' => 'zero',
+ 'expected' => false,
+ ],
+ 'Empty string' => [
+ 'data' => '',
+ 'name' => null,
+ 'expected' => false,
+ ],
+ 'Truthy string' => [
+ 'data' => 'has a value',
+ 'name' => null,
+ 'expected' => true,
+ ],
+ 'Field on a string' => [
+ 'data' => 'has a value',
+ 'name' => 'SomeField',
+ 'expected' => false,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideHasDataValue')]
+ public function testHasDataValue(mixed $data, ?string $name, bool $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ $this->assertSame($expected, $viewLayerData->hasDataValue($name));
+ }
+
+ public static function provideGetRawDataValue(): array
+ {
+ $dbHtml = (new DBHTMLText())->setValue('Some html text');
+ // Note we're not checking the fetch order or passing args here - see testGet and testCall for that.
+ return [
+ [
+ 'data' => ['MyField' => 'some value'],
+ 'name' => 'MissingField',
+ 'expected' => null,
+ ],
+ [
+ 'data' => ['MyField' => null],
+ 'name' => 'MyField',
+ 'expected' => null,
+ ],
+ [
+ 'data' => ['MyField' => 'some value'],
+ 'name' => 'MyField',
+ 'expected' => 'some value',
+ ],
+ [
+ 'data' => ['MyField' => 123],
+ 'name' => 'MyField',
+ 'expected' => 123,
+ ],
+ [
+ 'data' => ['MyField' => true],
+ 'name' => 'MyField',
+ 'expected' => true,
+ ],
+ [
+ 'data' => ['MyField' => false],
+ 'name' => 'MyField',
+ 'expected' => false,
+ ],
+ [
+ 'data' => ['MyField' => $dbHtml],
+ 'name' => 'MyField',
+ 'expected' => $dbHtml,
+ ],
+ [
+ 'data' => (new ArrayData(['MyField' => 1234]))->customise(new ArrayData(['MyField' => 'overridden value'])),
+ 'name' => 'MyField',
+ 'expected' => 'overridden value',
+ ],
+ [
+ 'data' => (new ArrayData(['MyField' => 1234]))->customise(new ArrayData(['FieldTwo' => 'checks here'])),
+ 'name' => 'FieldTwo',
+ 'expected' => 'checks here',
+ ],
+ [
+ 'data' => (new ArrayData(['MyField' => 1234]))->customise(new ArrayData(['FieldTwo' => 'not here'])),
+ 'name' => 'MyField',
+ 'expected' => 1234,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetRawDataValue')]
+ public function testGetRawDataValue(mixed $data, string $name, mixed $expected): void
+ {
+ $viewLayerData = new ViewLayerData($data);
+ $this->assertSame($expected, $viewLayerData->getRawDataValue($name));
+ }
+
+ public static function provideGetRawDataValueType(): array
+ {
+ // The types aren't currently used, but are passed in so we can use them later
+ // if we find the distinction useful. We should test they do what we expect
+ // in the meantime.
+ return [
+ [
+ 'type' => 'property',
+ 'shouldThrow' => false,
+ ],
+ [
+ 'type' => 'method',
+ 'shouldThrow' => false,
+ ],
+ [
+ 'type' => 'any',
+ 'shouldThrow' => false,
+ ],
+ [
+ 'type' => 'constant',
+ 'shouldThrow' => true,
+ ],
+ [
+ 'type' => 'randomtext',
+ 'shouldThrow' => true,
+ ],
+ ];
+ }
+
+ #[DataProvider('provideGetRawDataValueType')]
+ public function testGetRawDataValueType(string $type, bool $shouldThrow): void
+ {
+ $viewLayerData = new ViewLayerData([]);
+ if ($shouldThrow) {
+ $this->expectException(InvalidArgumentException::class);
+ } else {
+ $this->expectNotToPerformAssertions();
+ }
+ $viewLayerData->getRawDataValue('something', type: $type);
+ }
+
+ public function testCache(): void
+ {
+ $data = new ArrayData(['MyField' => 'some value']);
+ $viewLayerData = new ViewLayerData($data);
+
+ // No cache because we haven't fetched anything
+ $this->assertNull($data->objCacheGet('MyField'));
+
+ // Fetching the value caches it
+ $viewLayerData->MyField;
+ $this->assertSame('some value', $data->objCacheGet('MyField'));
+ }
+
+ public function testSpecialNames(): void
+ {
+ $data = new stdClass;
+ $viewLayerData = new ViewLayerData($data);
+
+ // Metadata values are available when there's nothing in the actual data
+ $this->assertTrue(isset($viewLayerData->ClassName));
+ $this->assertTrue(isset($viewLayerData->Me));
+ $this->assertSame(stdClass::class, $viewLayerData->getRawDataValue('ClassName')->getValue());
+ $this->assertSame($data, $viewLayerData->getRawDataValue('Me'));
+
+ // Metadata values are lower priority than real values in the actual data
+ $data->ClassName = 'some other class';
+ $data->Me = 'something else';
+ $this->assertTrue(isset($viewLayerData->ClassName));
+ $this->assertTrue(isset($viewLayerData->Me));
+ $this->assertSame('some other class', $viewLayerData->getRawDataValue('ClassName'));
+ $this->assertSame('something else', $viewLayerData->getRawDataValue('Me'));
+ }
+}
diff --git a/tests/php/View/ViewLayerDataTest/CountableObject.php b/tests/php/View/ViewLayerDataTest/CountableObject.php
new file mode 100644
index 000000000..3fd843f61
--- /dev/null
+++ b/tests/php/View/ViewLayerDataTest/CountableObject.php
@@ -0,0 +1,14 @@
+requested[] = [
+ 'type' => 'method',
+ 'name' => $name,
+ 'args' => $arguments,
+ ];
+ if ($this->throwException) {
+ throw new BadMethodCallException('We need this so ViewLayerData will try the next step');
+ } else {
+ return null;
+ }
+ }
+
+ public function __get(string $name): null
+ {
+ $this->requested[] = [
+ 'type' => 'property',
+ 'name' => $name,
+ ];
+ return null;
+ }
+
+ public function __isset(string $name): bool
+ {
+ return $name !== 'NotSet';
+ }
+
+ public function getRequested(): array
+ {
+ return $this->requested;
+ }
+}
diff --git a/tests/php/View/ViewLayerDataTest/TestFixtureComplex.php b/tests/php/View/ViewLayerDataTest/TestFixtureComplex.php
new file mode 100644
index 000000000..5f2fca993
--- /dev/null
+++ b/tests/php/View/ViewLayerDataTest/TestFixtureComplex.php
@@ -0,0 +1,79 @@
+requested[] = [
+ 'type' => 'method',
+ 'name' => __FUNCTION__,
+ 'args' => func_get_args(),
+ ];
+ throw new BadMethodCallException('Without a __call() method this will actually be thrown');
+ }
+
+ public function voidMethod(): void
+ {
+ $this->requested[] = [
+ 'type' => 'method',
+ 'name' => __FUNCTION__,
+ 'args' => func_get_args(),
+ ];
+ }
+
+ public function justCallMethod(): string
+ {
+ $this->requested[] = [
+ 'type' => 'method',
+ 'name' => __FUNCTION__,
+ 'args' => func_get_args(),
+ ];
+ return 'This is a method value';
+ }
+
+ public function getActualValue(): string
+ {
+ $this->requested[] = [
+ 'type' => 'method',
+ 'name' => __FUNCTION__,
+ 'args' => func_get_args(),
+ ];
+ return 'this is the value';
+ }
+
+ public function __get(string $name): ?string
+ {
+ $this->requested[] = [
+ 'type' => 'property',
+ 'name' => $name,
+ ];
+ if ($name === 'ActualValueField') {
+ return 'the value is here';
+ }
+ return null;
+ }
+
+ /**
+ * We need this so we always try to fetch a property.
+ */
+ public function __isset(string $name): bool
+ {
+ return $name !== 'NotSet';
+ }
+
+ public function getRequested(): array
+ {
+ return $this->requested;
+ }
+}
diff --git a/tests/php/i18n/i18nTest.php b/tests/php/i18n/i18nTest.php
index d96e9c2f1..4d2c7e40c 100644
--- a/tests/php/i18n/i18nTest.php
+++ b/tests/php/i18n/i18nTest.php
@@ -308,7 +308,7 @@ class i18nTest extends SapphireTest
}
/**
- * See @i18nTestModule.ss for the template that is being used for this test
+ * See i18nTestModule.ss for the template that is being used for this test
* */
public function testNewTemplateTranslation()
{
diff --git a/tests/php/i18n/i18nTestManifest.php b/tests/php/i18n/i18nTestManifest.php
index d2fd62a13..a6afdeeff 100644
--- a/tests/php/i18n/i18nTestManifest.php
+++ b/tests/php/i18n/i18nTestManifest.php
@@ -17,10 +17,11 @@ use SilverStripe\i18n\Tests\i18nTest\MyObject;
use SilverStripe\i18n\Tests\i18nTest\MySubObject;
use SilverStripe\i18n\Tests\i18nTest\TestDataObject;
use SilverStripe\View\SSViewer;
-use SilverStripe\View\SSViewer_DataPresenter;
use SilverStripe\View\ThemeResourceLoader;
use SilverStripe\View\ThemeManifest;
use SilverStripe\Model\ModelData;
+use SilverStripe\View\SSViewer_Scope;
+use SilverStripe\View\ViewLayerData;
use Symfony\Component\Translation\Loader\ArrayLoader;
use Symfony\Component\Translation\Translator;
@@ -71,9 +72,9 @@ trait i18nTestManifest
public function setupManifest()
{
- // force SSViewer_DataPresenter to cache global template vars before we switch to the
+ // force SSViewer_Scope to cache global template vars before we switch to the
// test-project class manifest (since it will lose visibility of core classes)
- $presenter = new SSViewer_DataPresenter(new ModelData());
+ $presenter = new SSViewer_Scope(new ViewLayerData([]));
unset($presenter);
// Switch to test manifest