Added new tests to Script::withLocalize and support back to single cl…

…osure.
inpsyde · Jul 17, 2019 · a46932b · a46932b
1 parent dfbf4d3
commit a46932b
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,8 +35,24 @@ Added new methods:
     * append inline styles
     * set directly `Style::useAsyncFilter()` to attach filter.
 
-### Breaking Change
-`Script::localize()` now does not accept anymore a single closure, instead you can add multiple `$objectValues` which can contain a closoure. For migration have a look at [Migration from 1.3 to 1.4](https://github.com/inpsyde/assets/blob/1.4/docs/99%20-%20Migration.md#from-13-to-14).
+### Script localization
+Script localization accepts now multiple closures as objectValues:
+
+```php
+<?php
+use Inpsyde\Assets\Script;
+
+$script = new Script('handle', 'handle.js');
+$script
+	->withLocalize('objectName', 'objectValue')
+	->withLocalize('posts', function(): array {
+		return get_posts(['post_type' => 'page']);
+	})
+	->withLocalize('foo', function(): string {
+	    return 'bar';
+	});
+```
+
 
 ----
 

diff --git a/docs/99 - Migration.md b/docs/99 - Migration.md
@@ -1,42 +1,5 @@
 # Migration
 
-## From 1.3 to 1.4
-Due the change in version 1.4 to mutable `Style` and `Script`, we've now the possibility to add multiple localized data to an instance. 
-
-**Before:**
-Before it was only possible to add a single callable for lazy evaluation which contained everything. 
-
-```
-<?php
-use Inpsyde\Assets\Script;
-
-$script = new Script( 
-	'handle', 
-	'script.js', 
-	[
-		'localize' => function() : array {
-			return [
-				'objectName'	=> 'objectValue'
-				'posts'		=> get_posts(['post_type' => 'page'])
-			];
-		}
-	]
-```
-
-**After:**
-Now, due the public API `Script::withLocalize`, we can add multiple values - including callables - to different `$objectNames` to be more flexible:
-
-```php
-use Inpsyde\Assets\Script;
-
-$script = new Script('handle', 'handle.js');
-$script
-	->withLocalize('objectName', 'objectValue')
-	->withLocalize('posts', function() {
-		return get_posts(['post_type' => 'page']);
-	});
-```
-
 ## From 1.0 to 1.1
 In version 1.1 we didn't implemented breaking changes, but we're renamend some internals for `Inpsyde\Assets\Asset` to be more clear when using the config-driven approach. In future you'll have to change your Asset-configuration, since we don't want to ship to much legacy code.
 

diff --git a/src/BaseAsset.php b/src/BaseAsset.php
@@ -284,7 +284,7 @@ abstract protected function defaultHandler(): string;
      */
     public function data(): array
     {
-        return $this->config('data', []);
+        return (array)$this->config('data', []);
     }
 
     /**

diff --git a/src/Script.php b/src/Script.php
@@ -24,11 +24,14 @@ public function localize(): array
     {
         $localize = $this->config('localize', []);
 
+        // @deprecated
+        is_callable($localize) and $localize = $localize();
+
         $output = [];
         foreach ($localize as $objectName => $data) {
             $output[$objectName] = is_callable($data)
                 ? $data()
-                : (array) $data;
+                : $data;
         }
 
         return (array) $output;

diff --git a/tests/phpunit/Unit/ScriptTest.php b/tests/phpunit/Unit/ScriptTest.php
@@ -36,16 +36,67 @@ public function testWithTranslation()
         static::assertSame($expected, $testee->translation());
     }
 
-    public function testWithLocalize()
+    /**
+     * @param string $objectName
+     * @param $objectValue
+     * @param $expected
+     *
+     * @dataProvider provideLocalized
+     */
+    public function testWithLocalize(string $objectName, $objectValue, $expected)
     {
-        $expectedKey = 'foo';
-        $expectedValue = ['bar' => 'baz'];
-        $expected = [$expectedKey => $expectedValue];
         $testee = new Script('handle', 'script.js');
 
         static::assertEmpty($testee->localize());
 
-        $testee->withLocalize($expectedKey, $expectedValue);
+        $testee->withLocalize($objectName, $objectValue);
+
+        static::assertSame($expected, $testee->localize());
+    }
+
+    public function provideLocalized()
+    {
+        yield 'string value' => [
+            'objectName',
+            'objectValue',
+            ['objectName' => 'objectValue'],
+        ];
+
+        yield 'int value' => [
+            'objectName',
+            2,
+            ['objectName' => 2],
+        ];
+
+        $expectedValue = ['foo', 'bar' => 'baz'];
+        yield 'array value' => [
+            'objectName',
+            $expectedValue,
+            ['objectName' => $expectedValue],
+        ];
+
+        yield 'closure' => [
+            'objectName',
+            function (): string {
+                return 'objectValue';
+            },
+            ['objectName' => 'objectValue'],
+        ];
+    }
+
+    public function testLocalizedSingleClosure()
+    {
+        $expected = ['foo' => ['bar' => 'baz']];
+        $testee = new Script(
+            'handle',
+            'script.js',
+            Asset::FRONTEND,
+            [
+                'localize' => function () use ($expected): array {
+                    return $expected;
+                },
+            ]
+        );
 
         static::assertSame($expected, $testee->localize());
     }