Restructure and cache contexts

CHANGELOG.md

@@ -9,43 +9,56 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- `ArrayShapeRule` - allows processing of arrays with predefined keys
-- `ArgsFieldContext` - args validation context which adds access to the property's default value
-- `Processor` - `reset()` method for resetting to initial state (clearing meta cache)
-
-### Changed
-
 - Composer
 	- Allow PHP 8.4
 	- Allow benmorel/weakmap-polyfill:^0.5.0
+- Rules
+	- `ArrayShapeRule` - allows processing of arrays with predefined keys
+- Processing
+	- `Processor` - `reset()` method for resetting to initial state (clearing meta cache)
+
+### Changed
+
 - Metadata
 	- Improved accuracy of metadata-related error messages
 	- `ReflectorMetaSource` is marked as `@internal`
 	- Check that `Callback` returns correct `Args` class type
 	- Callbacks in `NodeRuntimeMeta` are grouped by type (performance optimization)
-- `Rule`
-	- `resolveArgs()` accepts `ArgsFieldContext` instead of `ArgsContext`
-	- all rules initialize `Type` lazily (performance optimization)
-- `ArrayOfRule`
-	- check during metadata parsing that default value is an array when `mergeDefaults` is enabled
-- `ArrayOfRule`, `ListOfRule`
-	- skip 2nd and 3rd validation phase for item rules that don't require it
-	- pass values with keys included to phase 2 (previously keys were stripped)
-- `FieldContext`, `MappedObjectContext`
-	- initializes `Type` lazily (performance optimization)
-- `ArrayShapeType`
-	- `getFields()` always returns the same instances
-- `DefaultProcessor`
-	- creates `MappedObjectType` only when necessary (performance optimization)
-- `MultiValueEfficientRule`
-	- renamed to `PhasedRule`
-- `MultiValueEfficientRuleAdapter`
-	- renamed to `PhasedRuleAdapter`
-	- marked as internal
+- Callbacks
+	- receive `FieldContext` (callback-specific) instead of `FieldContext` and `ObjectContext` instead of
+	  `MappedObjectContext`
+- Contexts
+	- `TypeContext`, `MappedObjectContext` and `FieldContext` replaced with `ServicesContext`, `DynamicContext`,
+	  `PropertyContext`, `FieldContext` (for callbacks) and `ObjectContext` (callback-specific)
+		- performance and memory optimization to significantly reduce number of created objects
+	- `ArgsContext` renamed to `MetaContext`
+		- added child class `MetaFieldContext` with access to property's default value
+- Rules
+	- `Rule`
+		- accepts `ServicesContext`, `DynamicContext` and `PropertyContext` instead of `TypeContext` and `FieldContext`
+		- accepts `MetaFieldContext` instead of `ArgsContext`
+		- all rules initialize `Type` lazily (performance optimization)
+	- `ArrayOfRule`
+		- check during metadata parsing that default value is an array when `mergeDefaults` is enabled
+	- `ArrayOfRule`, `ListOfRule`
+		- skip 2nd and 3rd validation phase for item rules that don't require it
+		- pass values with keys included to phase 2 (previously keys were stripped)
+	- `MultiValueEfficientRule`
+		- renamed to `PhasedRule`
+	- `MultiValueEfficientRuleAdapter`
+		- renamed to `PhasedRuleAdapter`
+		- marked as internal
+- Types
+	- `ArrayShapeType`
+		- `getFields()` always returns the same instances
+- Processing
+	- `DefaultProcessor`
+		- creates `MappedObjectType` only when necessary (performance optimization)
+		- automatic meta cache reset after main `process()` call (performance optimization) replaced with `reset()`
+		  method
 
 ### Removed
 
-- `DefaultProcessor` - automatic meta cache reset after main `process()` call (performance optimization)
 - `Skipped` modifier and the related code - it was an undocumented feature that is no longer necessary
 
 ## [0.2.0](https://github.com/orisai/object-mapper/compare/0.1.0...0.2.0) - 2024-06-22

docs/README.md

@@ -2166,7 +2166,7 @@ Define callbacks before and after mapped objects and their fields:
 
 ```php
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
 
@@ -2191,7 +2191,7 @@ final class WithCallbackInput implements MappedObject
 
 ```php
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
 
@@ -2246,17 +2246,17 @@ After mapped object
 	<summary><code>#[Attributes()]</code></summary>
 
 ```php
-use Orisai\ObjectMapper\Callbacks\Before;
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\MappedObjectContext;
+use Orisai\ObjectMapper\Callbacks\Before;
+use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
 use Orisai\ObjectMapper\MappedObject;
 
 #[Before('beforeObject')]
 #[After('afterObject')]
 final class WithMappedObjectCallbacksInput implements MappedObject
 {
 
-	private static function beforeObject(mixed $value, MappedObjectContext $context): myInterface
+	private static function beforeObject(mixed $value, ObjectContext $context): myInterface
 	{
 		return $value;
 	}
@@ -2265,7 +2265,7 @@ final class WithMappedObjectCallbacksInput implements MappedObject
 	 * @param array<int|string, mixed> $value
 	 * @return array<int|string, mixed>
 	 */
-	private static function afterObject(array $value, MappedObjectContext $context): array
+	private static function afterObject(array $value, ObjectContext $context): array
 	{
 		return $value;
 	}
@@ -2278,9 +2278,9 @@ final class WithMappedObjectCallbacksInput implements MappedObject
 	<summary><code>@Annotations()</code></summary>
 
 ```php
-use Orisai\ObjectMapper\Callbacks\Before;
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\MappedObjectContext;
+use Orisai\ObjectMapper\Callbacks\Before;
+use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
 use Orisai\ObjectMapper\MappedObject;
 
 /**
@@ -2294,7 +2294,7 @@ final class WithMappedObjectCallbacksInput implements MappedObject
 	 * @param mixed $value
 	 * @return mixed
 	 */
-	private static function beforeObject($value, MappedObjectContext $context)
+	private static function beforeObject($value, ObjectContext $context)
 	{
 		return $value;
 	}
@@ -2303,7 +2303,7 @@ final class WithMappedObjectCallbacksInput implements MappedObject
 	 * @param array<int|string, mixed> $value
 	 * @return array<int|string, mixed>
 	 */
-	private static function afterObject(array $value, MappedObjectContext $context): array
+	private static function afterObject(array $value, ObjectContext $context): array
 	{
 		return $value;
 	}
@@ -2334,9 +2334,9 @@ After field
 	<summary><code>#[Attributes()]</code></summary>
 
 ```php
-use Orisai\ObjectMapper\Callbacks\Before;
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Before;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
 
@@ -2366,9 +2366,9 @@ final class WithFieldCallbacksInput implements MappedObject
 	<summary><code>@Annotations()</code></summary>
 
 ```php
-use Orisai\ObjectMapper\Callbacks\Before;
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Before;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
 
@@ -2404,7 +2404,7 @@ Field callbacks are called only when field is sent. Callback is not invoked for
 
 ```php
 use Orisai\ObjectMapper\Callbacks\After;
-use Orisai\ObjectMapper\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
 

src/Callbacks/BaseCallback.php

@@ -6,11 +6,11 @@
 use Orisai\Exceptions\Logic\InvalidArgument;
 use Orisai\ObjectMapper\Args\Args;
 use Orisai\ObjectMapper\Args\ArgsChecker;
-use Orisai\ObjectMapper\Context\ArgsContext;
-use Orisai\ObjectMapper\Context\BaseFieldContext;
-use Orisai\ObjectMapper\Context\FieldContext;
-use Orisai\ObjectMapper\Context\MappedObjectContext;
+use Orisai\ObjectMapper\Callbacks\Context\CallbackBaseContext;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
 use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Meta\Context\MetaContext;
 use Orisai\ObjectMapper\Processing\ObjectHolder;
 use ReflectionClass;
 use ReflectionMethod;
@@ -53,7 +53,7 @@ private function __construct()
 
 	public static function resolveArgs(
 		array $args,
-		ArgsContext $context,
+		MetaContext $context,
 		Reflector $reflector
 	): BaseCallbackArgs
 	{
@@ -225,14 +225,14 @@ private static function validateClassMethodContextParam(
 	{
 		if (
 			($type = self::getTypeName($paramContext->getType())) === null
-			|| !is_a($type, MappedObjectContext::class, true)
+			|| !is_a($type, ObjectContext::class, true)
 		) {
 			throw InvalidArgument::create()
 				->withMessage(sprintf(
 					'Second parameter of class callback method %s::%s should have "%s" type instead of %s',
 					$class->getName(),
 					$method->getName(),
-					MappedObjectContext::class,
+					ObjectContext::class,
 					$type ?? 'none',
 				));
 		}
@@ -317,16 +317,14 @@ public static function getArgsType(): string
 	}
 
 	/**
-	 * @param mixed                            $data
-	 * @param BaseCallbackArgs                 $args
-	 * @param FieldContext|MappedObjectContext $context
+	 * @param BaseCallbackArgs $args
 	 * @return mixed
 	 */
 	public static function invoke(
 		$data,
 		Args $args,
 		ObjectHolder $holder,
-		BaseFieldContext $context,
+		CallbackBaseContext $context,
 		ReflectionClass $declaringClass
 	)
 	{

src/Callbacks/Callback.php

@@ -3,13 +3,13 @@
 namespace Orisai\ObjectMapper\Callbacks;
 
 use Orisai\ObjectMapper\Args\Args;
-use Orisai\ObjectMapper\Context\ArgsContext;
-use Orisai\ObjectMapper\Context\BaseFieldContext;
-use Orisai\ObjectMapper\Context\FieldContext;
-use Orisai\ObjectMapper\Context\MappedObjectContext;
+use Orisai\ObjectMapper\Callbacks\Context\CallbackBaseContext;
+use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
+use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
 use Orisai\ObjectMapper\Exception\InvalidData;
 use Orisai\ObjectMapper\Exception\ValueDoesNotMatch;
 use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Meta\Context\MetaContext;
 use Orisai\ObjectMapper\Processing\ObjectHolder;
 use ReflectionClass;
 use ReflectionProperty;
@@ -22,23 +22,23 @@ interface Callback
 {
 
 	/**
-	 * @param array<int|string, mixed>                         $args
+	 * @param array<int|string, mixed> $args
 	 * @param ReflectionClass<MappedObject>|ReflectionProperty $reflector
 	 * @return T_ARGS
 	 */
-	public static function resolveArgs(array $args, ArgsContext $context, Reflector $reflector): Args;
+	public static function resolveArgs(array $args, MetaContext $context, Reflector $reflector): Args;
 
 	/**
 	 * @return class-string<T_ARGS>
 	 */
 	public static function getArgsType(): string;
 
 	/**
-	 * @param mixed                            $data
-	 * @param T_ARGS                           $args
-	 * @param FieldContext|MappedObjectContext $context
-	 * @param ObjectHolder<MappedObject>       $holder
-	 * @param ReflectionClass<MappedObject>    $declaringClass
+	 * @param mixed $data
+	 * @param T_ARGS $args
+	 * @param ObjectContext|FieldContext $context
+	 * @param ObjectHolder<MappedObject> $holder
+	 * @param ReflectionClass<MappedObject> $declaringClass
 	 * @return mixed
 	 * @throws ValueDoesNotMatch
 	 * @throws InvalidData
@@ -47,7 +47,7 @@ public static function invoke(
 		$data,
 		Args $args,
 		ObjectHolder $holder,
-		BaseFieldContext $context,
+		CallbackBaseContext $context,
 		ReflectionClass $declaringClass
 	);
 

src/Callbacks/Context/CallbackBaseContext.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types = 1);
+
+namespace Orisai\ObjectMapper\Callbacks\Context;
+
+use Orisai\ObjectMapper\Processing\Context\DynamicContext;
+use Orisai\ObjectMapper\Processing\Context\ServicesContext;
+use Orisai\ObjectMapper\Processing\Options;
+use Orisai\ObjectMapper\Processing\Processor;
+use Orisai\ObjectMapper\Types\Type;
+
+abstract class CallbackBaseContext
+{
+
+	private ServicesContext $services;
+
+	private DynamicContext $dynamic;
+
+	public function __construct(
+		ServicesContext $services,
+		DynamicContext $dynamic
+	)
+	{
+		$this->services = $services;
+		$this->dynamic = $dynamic;
+	}
+
+	abstract public function getType(): Type;
+
+	public function getProcessor(): Processor
+	{
+		return $this->services->getProcessor();
+	}
+
+	public function getOptions(): Options
+	{
+		return $this->dynamic->getOptions();
+	}
+
+	public function shouldInitializeObjects(): bool
+	{
+		return $this->dynamic->shouldInitializeObjects();
+	}
+
+}