test: Introduce a Meta object to replace the spec associative array (#985)

At the time the specs were written, there were much less configuration settings and I wanted a clear view of the default settings, not having them declared in an less obvious place (e.g. the spec test case).

Now with the advent of readonly classes, promoted properties and named parameters, I think it is time to reconsider this. This will also make it easier to introduce new settings like needed for #981.

Author: theofidry

specs/binary/simple.php

@@ -12,28 +12,12 @@
  * file that was distributed with this source code.
  */
 
+use Humbug\PhpScoper\Scoper\Spec\Meta;
+
 return [
-    'meta' => [
-        'title' => 'Excerpts of code used for executable PHP files (e.g. for PHPUnit)',
-        // Default values. If not specified will be the one used
-        'prefix' => 'Humbug',
-
-        'expose-global-constants' => false,
-        'expose-global-classes' => false,
-        'expose-global-functions' => false,
-        'expose-namespaces' => [],
-        'expose-constants' => [],
-        'expose-classes' => [],
-        'expose-functions' => [],
-
-        'exclude-namespaces' => [],
-        'exclude-constants' => [],
-        'exclude-classes' => [],
-        'exclude-functions' => [],
-
-        'expected-recorded-classes' => [],
-        'expected-recorded-functions' => [],
-    ],
+    'meta' => new Meta(
+        title: 'Excerpts of code used for executable PHP files (e.g. for PHPUnit)',
+    ),
 
     'Some statements made directly in the global namespace' => <<<'PHP'
         <?php declare(strict_types=1);

specs/class-const/global-scope-single-level-with-single-level-use-statement-and-alias.php

@@ -12,28 +12,13 @@
  * file that was distributed with this source code.
  */
 
+use Humbug\PhpScoper\Scoper\Spec\Meta;
+use Humbug\PhpScoper\Scoper\Spec\SpecWithConfig;
+
 return [
-    'meta' => [
-        'title' => 'Class constant call of a class imported with an aliased use statement in the global scope',
-        // Default values. If not specified will be the one used
-        'prefix' => 'Humbug',
-
-        'expose-global-constants' => false,
-        'expose-global-classes' => false,
-        'expose-global-functions' => false,
-        'expose-namespaces' => [],
-        'expose-constants' => [],
-        'expose-classes' => [],
-        'expose-functions' => [],
-
-        'exclude-namespaces' => [],
-        'exclude-constants' => [],
-        'exclude-classes' => [],
-        'exclude-functions' => [],
-
-        'expected-recorded-classes' => [],
-        'expected-recorded-functions' => [],
-    ],
+    'meta' => new Meta(
+        title: 'Class constant call of a class imported with an aliased use statement in the global scope',
+    ),
 
     'Constant call on a aliased class which is imported via an aliased use statement and which belongs to the global namespace' => <<<'PHP'
         <?php
@@ -118,9 +103,9 @@ class X
 
         PHP,
 
-    'Constant call on an exposed class which is imported via an aliased use statement and which belongs to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'Constant call on an exposed class which is imported via an aliased use statement and which belongs to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             use Foo as X;
@@ -135,11 +120,11 @@ class X
             X::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 
-    'FQ constant call on an excluded class which is imported via an aliased use statement and which belongs to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'FQ constant call on an excluded class which is imported via an aliased use statement and which belongs to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             class X {}
@@ -159,5 +144,5 @@ class X
             \Humbug\X::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 ];

specs/class-const/global-scope-single-level-with-single-level-use-statement.php

@@ -12,28 +12,13 @@
  * file that was distributed with this source code.
  */
 
+use Humbug\PhpScoper\Scoper\Spec\Meta;
+use Humbug\PhpScoper\Scoper\Spec\SpecWithConfig;
+
 return [
-    'meta' => [
-        'title' => 'Class constant call of a class imported with a use statement in the global scope',
-        // Default values. If not specified will be the one used
-        'prefix' => 'Humbug',
-
-        'expose-global-constants' => false,
-        'expose-global-classes' => false,
-        'expose-global-functions' => false,
-        'expose-namespaces' => [],
-        'expose-constants' => [],
-        'expose-classes' => [],
-        'expose-functions' => [],
-
-        'exclude-namespaces' => [],
-        'exclude-constants' => [],
-        'exclude-classes' => [],
-        'exclude-functions' => [],
-
-        'expected-recorded-classes' => [],
-        'expected-recorded-functions' => [],
-    ],
+    'meta' => new Meta(
+        title: 'Class constant call of a class imported with a use statement in the global scope',
+    ),
 
     'Constant call on a class which is imported via a use statement and which belongs to the global namespace' => <<<'PHP'
         <?php
@@ -109,9 +94,9 @@ class Command
 
         PHP,
 
-    'Constant call on an exposed class which is imported via a use statement and which belongs to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'Constant call on an exposed class which is imported via a use statement and which belongs to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             use Foo;
@@ -126,11 +111,11 @@ class Command
             Foo::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 
-    'FQ constant call on an exposed class which is imported via a use statement and which belongs to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'FQ constant call on an exposed class which is imported via a use statement and which belongs to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             use Foo;
@@ -145,5 +130,5 @@ class Command
             \Humbug\Foo::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 ];

specs/class-const/global-scope-single-level.php

@@ -12,28 +12,13 @@
  * file that was distributed with this source code.
  */
 
+use Humbug\PhpScoper\Scoper\Spec\Meta;
+use Humbug\PhpScoper\Scoper\Spec\SpecWithConfig;
+
 return [
-    'meta' => [
-        'title' => 'Class constant call in the global scope',
-        // Default values. If not specified will be the one used
-        'prefix' => 'Humbug',
-
-        'expose-global-constants' => false,
-        'expose-global-classes' => false,
-        'expose-global-functions' => false,
-        'expose-namespaces' => [],
-        'expose-constants' => [],
-        'expose-classes' => [],
-        'expose-functions' => [],
-
-        'exclude-namespaces' => [],
-        'exclude-constants' => [],
-        'exclude-classes' => [],
-        'exclude-functions' => [],
-
-        'expected-recorded-classes' => [],
-        'expected-recorded-functions' => [],
-    ],
+    'meta' => new Meta(
+        title: 'Class constant call in the global scope',
+    ),
 
     'Constant call on a class belonging to the global namespace' => <<<'PHP'
         <?php
@@ -53,12 +38,12 @@ class Command
 
         PHP,
 
-    'Constant call on a class belonging to the global namespace which is excluded' => [
-        'exclude-namespaces' => ['/^$/'],
-        'expected-recorded-classes' => [
+    'Constant call on a class belonging to the global namespace which is excluded' => SpecWithConfig::create(
+        excludeNamespaces: ['/^$/'],
+        expectedRecordedClasses: [
             ['Command', 'Humbug\Command'],
         ],
-        'payload' => <<<'PHP'
+        spec: <<<'PHP'
             <?php
 
             class Command {}
@@ -76,7 +61,7 @@ class Command
             }
 
             PHP,
-    ],
+    ),
 
     'FQ constant call on a class belonging to the global namespace' => <<<'PHP'
         <?php
@@ -122,9 +107,9 @@ class Command
 
         PHP,
 
-    'Constant call on an exposed class belonging to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'Constant call on an exposed class belonging to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             Foo::MAIN_CONST;
@@ -136,11 +121,11 @@ class Command
             \Humbug\Foo::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 
-    'FQ constant call on an exposed class belonging to the global namespace' => [
-        'expose-classes' => ['Foo'],
-        'payload' => <<<'PHP'
+    'FQ constant call on an exposed class belonging to the global namespace' => SpecWithConfig::create(
+        exposeClasses: ['Foo'],
+        spec: <<<'PHP'
             <?php
 
             \Foo::MAIN_CONST;
@@ -152,5 +137,5 @@ class Command
             \Humbug\Foo::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 ];

specs/class-const/global-scope-two-level-with-single-level-use-and-alias.php

@@ -12,28 +12,13 @@
  * file that was distributed with this source code.
  */
 
+use Humbug\PhpScoper\Scoper\Spec\Meta;
+use Humbug\PhpScoper\Scoper\Spec\SpecWithConfig;
+
 return [
-    'meta' => [
-        'title' => 'Class constant call of a namespaced class imported with an aliased use statement in the global scope',
-        // Default values. If not specified will be the one used
-        'prefix' => 'Humbug',
-
-        'expose-global-constants' => false,
-        'expose-global-classes' => false,
-        'expose-global-functions' => false,
-        'expose-namespaces' => [],
-        'expose-constants' => [],
-        'expose-classes' => [],
-        'expose-functions' => [],
-
-        'exclude-namespaces' => [],
-        'exclude-constants' => [],
-        'exclude-classes' => [],
-        'exclude-functions' => [],
-
-        'expected-recorded-classes' => [],
-        'expected-recorded-functions' => [],
-    ],
+    'meta' => new Meta(
+        title: 'Class constant call of a namespaced class imported with an aliased use statement in the global scope',
+    ),
 
     'Constant call on a namespaced class partially imported with an aliased use statement' => <<<'PHP'
         <?php
@@ -134,12 +119,12 @@ class Bar
 
         PHP,
 
-    'FQ Constant call on an exposed namespaced class partially imported with an aliased use statement' => [
-        'expose-classes' => ['Foo\Bar'],
-        'expected-recorded-classes' => [
+    'FQ Constant call on an exposed namespaced class partially imported with an aliased use statement' => SpecWithConfig::create(
+        exposeClasses: ['Foo\Bar'],
+        expectedRecordedClasses: [
             ['Foo\Bar', 'Humbug\Foo\Bar'],
         ],
-        'payload' => <<<'PHP'
+        spec: <<<'PHP'
             <?php
 
             namespace {
@@ -175,11 +160,11 @@ class Bar
             X\Bar::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 
-    'FQ constant call on an exposed namespaced class imported with an aliased use statement' => [
-        'expose-classes' => ['Foo\Bar'],
-        'payload' => <<<'PHP'
+    'FQ constant call on an exposed namespaced class imported with an aliased use statement' => SpecWithConfig::create(
+        exposeClasses: ['Foo\Bar'],
+        spec: <<<'PHP'
             <?php
 
             namespace {
@@ -214,5 +199,5 @@ class Bar
             \Humbug\X\Bar::MAIN_CONST;
 
             PHP,
-    ],
+    ),
 ];