Rename "context" to "mapping context"

Author: SerafimArts

example/03.types/02.custom-type.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use TypeLang\Mapper\Context\Context;
+use TypeLang\Mapper\Context\MappingContext;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\StandardPlatform;
@@ -14,12 +14,12 @@
 // Add new type (must implement TypeInterface)
 class MyNonEmptyStringType implements TypeInterface
 {
-    public function match(mixed $value, Context $context): bool
+    public function match(mixed $value, MappingContext $context): bool
     {
         return \is_string($value) && $value !== '';
     }
 
-    public function cast(mixed $value, Context $context): string
+    public function cast(mixed $value, MappingContext $context): string
     {
         if (\is_string($value) && $value !== '') {
             return $value;

example/03.types/03.custom-type-template-arguments.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use TypeLang\Mapper\Context\Context;
+use TypeLang\Mapper\Context\MappingContext;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\DelegatePlatform;
@@ -52,12 +52,12 @@ public function __construct(
         private readonly TypeInterface $type,
     ) {}
 
-    public function match(mixed $value, Context $context): bool
+    public function match(mixed $value, MappingContext $context): bool
     {
         return !empty($value);
     }
 
-    public function cast(mixed $value, Context $context): mixed
+    public function cast(mixed $value, MappingContext $context): mixed
     {
         if (!empty($value)) {
             return $this->type->cast($value, $context);

example/03.types/05.custom-type-callable.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Psr\Container\ContainerInterface;
-use TypeLang\Mapper\Context\Context;
+use TypeLang\Mapper\Context\MappingContext;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\DelegatePlatform;
@@ -45,12 +45,12 @@ public function has(string $id): bool
 // Add new type (must implement TypeInterface)
 class MyNonEmptyStringType implements TypeInterface
 {
-    public function match(mixed $value, Context $context): bool
+    public function match(mixed $value, MappingContext $context): bool
     {
         return \is_string($value) && $value !== '';
     }
 
-    public function cast(mixed $value, Context $context): string
+    public function cast(mixed $value, MappingContext $context): string
     {
         if (\is_string($value) && $value !== '') {
             return $value;

example/03.types/06.custom-type-psr-container.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Psr\Container\ContainerInterface;
-use TypeLang\Mapper\Context\Context;
+use TypeLang\Mapper\Context\MappingContext;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\DelegatePlatform;
@@ -43,12 +43,12 @@ public function has(string $id): bool
 // Add new type (must implement TypeInterface)
 class MyNonEmptyStringType implements TypeInterface
 {
-    public function match(mixed $value, Context $context): bool
+    public function match(mixed $value, MappingContext $context): bool
     {
         return \is_string($value) && $value !== '';
     }
 
-    public function cast(mixed $value, Context $context): string
+    public function cast(mixed $value, MappingContext $context): string
     {
         if (\is_string($value) && $value !== '') {
             return $value;

src/Context/BuildContext.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Context;
+
+final class BuildContext extends Context {}

src/Context/ChildContext.php src/Context/ChildMappingContext.phpsrc/Context/ChildContext.php renamed to src/Context/ChildMappingContext.php

@@ -12,10 +12,10 @@
 use TypeLang\Mapper\Type\Parser\TypeParserInterface;
 use TypeLang\Mapper\Type\Repository\TypeRepositoryInterface;
 
-final class ChildContext extends Context
+final class ChildMappingContext extends MappingContext
 {
     protected function __construct(
-        public readonly Context $parent,
+        public readonly MappingContext $parent,
         public readonly EntryInterface $entry,
         mixed $value,
         Direction $direction,

src/Context/Context.php

@@ -6,68 +6,26 @@
 
 use JetBrains\PhpStorm\Language;
 use TypeLang\Mapper\Configuration;
-use TypeLang\Mapper\Context\Path\Entry\ArrayIndexEntry;
-use TypeLang\Mapper\Context\Path\Entry\EntryInterface;
-use TypeLang\Mapper\Context\Path\Entry\ObjectEntry;
-use TypeLang\Mapper\Context\Path\Entry\ObjectPropertyEntry;
-use TypeLang\Mapper\Context\Path\Entry\UnionLeafEntry;
-use TypeLang\Mapper\Context\Path\PathInterface;
-use TypeLang\Mapper\Type\Coercer\TypeCoercerInterface;
 use TypeLang\Mapper\Type\Extractor\TypeExtractorInterface;
 use TypeLang\Mapper\Type\Parser\TypeParserInterface;
 use TypeLang\Mapper\Type\Repository\TypeRepositoryInterface;
 use TypeLang\Mapper\Type\TypeInterface;
 use TypeLang\Parser\Node\Stmt\TypeStatement;
 
-/**
- * @template-implements \IteratorAggregate<array-key, Context>
- */
 abstract class Context implements
     TypeExtractorInterface,
     TypeParserInterface,
-    TypeRepositoryInterface,
-    \IteratorAggregate,
-    \Countable
+    TypeRepositoryInterface
 {
-    protected function __construct(
-        /**
-         * Gets original (unmodified) value.
-         *
-         * Please note that the value may be changed during type manipulation
-         * (casting), for example, using {@see TypeCoercerInterface}.
-         *
-         * In this case, the `$value` in the {@see Context} remains the original
-         * value, without any mutations from type coercions.
-         */
-        public readonly mixed $value,
-        /**
-         * Gets data transformation direction.
-         */
-        public readonly Direction $direction,
+    public function __construct(
         /**
          * Gets current configuration.
          *
-         * Please note that types can modify configuration settings while
-         * processing a value and pass this modified configuration down the
-         * mapping stack.
-         *
-         * In this case, the original configuration settings will be located in
-         * the {@see $original} context's field.
-         *
-         * During further processing, the configuration values will be reset to
-         * their initial configuration values.
-         *
          * If you need to retrieve configuration's settings, it is recommended
          * to use the following methods:
          *
-         * - {@see Context::isObjectAsArray()}
-         * - {@see Context::isStrictTypesEnabled()}
-         *
-         * To modify the configuration's settings, it is recommended to use the
-         * following methods, which guarantees correct operation:
-         *
-         * - {@see Context::withObjectAsArray()}
-         * - {@see Context::withStrictTypes()}
+         * - {@see MappingContext::isObjectAsArray()}
+         * - {@see MappingContext::isStrictTypesEnabled()}
          */
         public readonly Configuration $config,
         /**
@@ -79,7 +37,7 @@ protected function __construct(
          * You can safely use all the methods of this interface, but for ease of
          * use, the following methods are available to you:
          *
-         * - {@see Context::getDefinitionByValue()} - returns definition string
+         * - {@see MappingContext::getDefinitionByValue()} - returns definition string
          *   by the passed value.
          */
         public readonly TypeExtractorInterface $extractor,
@@ -93,9 +51,9 @@ protected function __construct(
          * You can safely use all the methods of this interface, but for ease of
          * use, the following methods are available to you:
          *
-         * - {@see Context::getStatementByValue()} - returns statement node by
+         * - {@see MappingContext::getStatementByValue()} - returns statement node by
          *   the value.
-         * - {@see Context::getStatementByDefinition()} - returns statement node
+         * - {@see MappingContext::getStatementByDefinition()} - returns statement node
          *   by the definition string.
          */
         public readonly TypeParserInterface $parser,
@@ -109,94 +67,16 @@ protected function __construct(
          * You can safely use all the methods of this interface, but for ease of
          * use, the following methods are available to you:
          *
-         * - {@see Context::getTypeByValue()} - returns type instance by the
+         * - {@see MappingContext::getTypeByValue()} - returns type instance by the
          *   passed value.
-         * - {@see Context::getTypeByDefinition()} - returns type instance by
+         * - {@see MappingContext::getTypeByDefinition()} - returns type instance by
          *   the type definition string.
-         * - {@see Context::getTypeByStatement()} - returns type instance by
+         * - {@see MappingContext::getTypeByStatement()} - returns type instance by
          *   the type statement.
          */
         public readonly TypeRepositoryInterface $types,
-        /**
-         * Contains a reference to the original config created during this
-         * context initialization.
-         *
-         * If there is no reference ({@see null}), then the current config in
-         * the {@see $config} context's field is the original.
-         */
-        public readonly ?Configuration $original = null,
     ) {}
 
-    /**
-     * Creates new child context.
-     */
-    public function enter(mixed $value, EntryInterface $entry, ?Configuration $config = null): self
-    {
-        // Original configuration
-        $original = $this->original ?? $this->config;
-
-        // Configuration of the current context
-        $current = $config ?? $original;
-
-        // Do not set "previous" config in case of
-        // "current" config is original
-        if ($current === $original) {
-            $original = null;
-        }
-
-        return new ChildContext(
-            parent: $this,
-            entry: $entry,
-            value: $value,
-            direction: $this->direction,
-            config: $current,
-            extractor: $this->extractor,
-            parser: $this->parser,
-            types: $this->types,
-            original: $current === $original ? null : $original,
-        );
-    }
-
-    /**
-     * Creates an "array index" child context
-     *
-     * @param array-key $index
-     */
-    public function enterIntoArrayIndex(mixed $value, int|string $index, ?Configuration $config = null): self
-    {
-        return $this->enter($value, new ArrayIndexEntry($index), $config);
-    }
-
-    /**
-     * Creates an "object" child context
-     *
-     * @param class-string $class
-     */
-    public function enterIntoObject(mixed $value, string $class, ?Configuration $config = null): self
-    {
-        return $this->enter($value, new ObjectEntry($class), $config);
-    }
-
-    /**
-     * Creates an "object's property" child context
-     *
-     * @param non-empty-string $name
-     */
-    public function enterIntoObjectProperty(mixed $value, string $name, ?Configuration $override = null): self
-    {
-        return $this->enter($value, new ObjectPropertyEntry($name), $override);
-    }
-
-    /**
-     * Creates an "union leaf" child context
-     *
-     * @param int<0, max> $index
-     */
-    public function enterIntoUnionLeaf(mixed $value, int $index, ?Configuration $override = null): self
-    {
-        return $this->enter($value, new UnionLeafEntry($index), $override);
-    }
-
     /**
      * A more convenient and correct way to get current "object as array"
      * configuration value.
@@ -210,25 +90,6 @@ public function isObjectAsArray(): bool
         return $this->config->isObjectAsArray();
     }
 
-    /**
-     * Sets the value of the "object as array" configuration settings using
-     * the original configuration rules.
-     *
-     * Note that the {@see $config} property contains the **current** context
-     * configuration settings, which may differ from the original ones.
-     * Therefore, method {@see Context::withObjectAsArray()} is not equivalent
-     * to calling {@see Configuration::withObjectAsArray()}.
-     */
-    public function withObjectAsArray(?bool $enabled): Configuration
-    {
-        if ($enabled === null) {
-            return $this->original ?? $this->config;
-        }
-
-        return ($this->original ?? $this->config)
-            ->withObjectAsArray($enabled);
-    }
-
     /**
      * A more convenient and correct way to get current "strict types"
      * configuration value.
@@ -242,25 +103,6 @@ public function isStrictTypesEnabled(): bool
         return $this->config->isStrictTypesEnabled();
     }
 
-    /**
-     * Sets the value of the "strict types" configuration settings using
-     * the original configuration rules.
-     *
-     * Note that the {@see $config} property contains the **current** context
-     * configuration settings, which may differ from the original ones.
-     * Therefore, method {@see Context::withStrictTypes()} is not equivalent
-     * to calling {@see Configuration::withStrictTypes()}.
-     */
-    public function withStrictTypes(?bool $enabled): Configuration
-    {
-        if ($enabled === null) {
-            return $this->original ?? $this->config;
-        }
-
-        return ($this->original ?? $this->config)
-            ->withStrictTypes($enabled);
-    }
-
     public function getDefinitionByValue(mixed $value): string
     {
         return $this->extractor->getDefinitionByValue($value);
@@ -343,20 +185,4 @@ public function getTypeByStatement(TypeStatement $statement): TypeInterface
             statement: $statement,
         );
     }
-
-    /**
-     * Returns current context path.
-     *
-     * The {@see PathInterface} contains all occurrences used in "parent"
-     * (composite) types when calling {@see enter()} method.
-     */
-    abstract public function getPath(): PathInterface;
-
-    /**
-     * @return int<1, max>
-     */
-    public function count(): int
-    {
-        return \max(1, \iterator_count($this));
-    }
 }