Skip to content

Commit bef962e

Browse files
koriymclaude
koriym
and
claude
committed
Add deprecation warnings and move legacy code to src-deprecated
This commit adds deprecation warnings to the reverted method-level attribute support while keeping src/ clean by isolating legacy code in src-deprecated/. Architecture: - Created LegacyAttributeHelper in src-deprecated/di/ with all legacy logic - Refactored src/di/ classes to use the helper via static method calls - No traits, no inheritance - clean delegation pattern Changes: - Added LegacyAttributeHelper class in src-deprecated/di/ - Removed legacy methods from AnnotatedClassMethods, Name, and Bind - Added minimal calls to LegacyAttributeHelper::* static methods - Added trigger_error() with E_USER_DEPRECATED when legacy features are used - Added @deprecated annotations to all legacy methods Impact: - src/ directory stays clean with minimal legacy code - Legacy implementation fully isolated in src-deprecated/ - Existing code using method-level attributes continues to work - Deprecation warnings guide users toward parameter-level attributes - All 168 tests pass with 13 expected deprecation warnings - No baseline files required Migration path for users: - Old (deprecated): #[Named("var1=name1,var2=name2")] on method - New (recommended): #[Named('name1')] on each parameter 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 73d3317 commit bef962e

File tree

5 files changed

+227
-139
lines changed

5 files changed

+227
-139
lines changed

‎.claude/settings.local.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(git log:*)",
5+
"Bash(git revert:*)",
6+
"Bash(composer cs:*)",
7+
"Bash(composer sa:*)",
8+
"Bash(composer baseline:*)",
9+
"Bash(vendor-bin/tools/vendor/vimeo/psalm/psalm:*)",
10+
"Bash(git restore:*)",
11+
"Bash(composer test:*)"
12+
],
13+
"deny": [],
14+
"ask": []
15+
}
16+
}

‎src-deprecated/di/LegacyAttributeHelper.php‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Ray\Di;
6+
7+
use Ray\Aop\ReflectionMethod;
8+
use Ray\Di\Di\Named;
9+
use Ray\Di\Di\Qualifier;
10+
use Ray\Di\Exception\InvalidToConstructorNameParameter;
11+
use ReflectionClass;
12+
13+
use function array_keys;
14+
use function array_reduce;
15+
use function explode;
16+
use function get_class;
17+
use function implode;
18+
use function is_string;
19+
use function property_exists;
20+
use function str_contains;
21+
use function substr;
22+
use function trigger_error;
23+
use function trim;
24+
25+
use const E_USER_DEPRECATED;
26+
27+
/**
28+
* Legacy attribute helper for backward compatibility
29+
*
30+
* @deprecated This class provides backward compatibility for method-level attributes.
31+
* All methods will be removed in a future version.
32+
* Use parameter-level attributes instead.
33+
*/
34+
final class LegacyAttributeHelper
35+
{
36+
/**
37+
* Extract qualifier information from method-level attributes
38+
*
39+
* @deprecated Method-level qualifier attributes are deprecated. Use parameter-level attributes instead.
40+
*
41+
* @return array<string, string>
42+
*/
43+
public static function getMethodLevelQualifiers(ReflectionMethod $method): array
44+
{
45+
$names = [];
46+
$attributes = $method->getAttributes();
47+
48+
foreach ($attributes as $attribute) {
49+
$instance = $attribute->newInstance();
50+
51+
// Check if this attribute is a qualifier
52+
$refClass = new ReflectionClass($instance);
53+
$qualifierAttrs = $refClass->getAttributes(Qualifier::class);
54+
55+
if ($qualifierAttrs !== []) {
56+
trigger_error(
57+
'Method-level qualifier attributes are deprecated. Use parameter-level attributes instead. ' .
58+
'Found on ' . $method->class . '::' . $method->name . '()',
59+
E_USER_DEPRECATED
60+
);
61+
62+
$qualifierClass = get_class($instance);
63+
64+
// Get the parameter name from the qualifier's value property if it exists
65+
if (property_exists($instance, 'value') && $instance->value !== null) {
66+
$names[(string) $instance->value] = $qualifierClass;
67+
68+
continue;
69+
}
70+
71+
// If no value, apply to all parameters
72+
$names[Name::ANY] = $qualifierClass;
73+
74+
continue;
75+
}
76+
77+
if (! ($instance instanceof Named)) {
78+
continue;
79+
}
80+
81+
trigger_error(
82+
'Method-level #[Named] attribute is deprecated. Use parameter-level #[Named] instead. ' .
83+
'Found on ' . $method->class . '::' . $method->name . '()',
84+
E_USER_DEPRECATED
85+
);
86+
87+
// Handle @Named at method level - parse as var1=name1,var2=name2
88+
$namedValue = $instance->value;
89+
if (str_contains($namedValue, '=')) {
90+
// Multiple variable mapping: var1=name1,var2=name2
91+
$keyValues = explode(',', $namedValue);
92+
foreach ($keyValues as $keyValue) {
93+
$exploded = explode('=', $keyValue);
94+
if (! isset($exploded[1])) {
95+
continue;
96+
}
97+
98+
[$key, $value] = $exploded;
99+
if (isset($key[0]) && $key[0] === '$') {
100+
$key = substr($key, 1);
101+
}
102+
103+
$names[trim($key)] = trim($value);
104+
}
105+
106+
continue;
107+
}
108+
109+
// Single name for all parameters
110+
$names[Name::ANY] = $namedValue;
111+
}
112+
113+
return $names;
114+
}
115+
116+
/**
117+
* Parse legacy string-based name mapping
118+
*
119+
* @deprecated Use parameter-level attributes or array format instead
120+
*
121+
* @return array<string, string>
122+
*
123+
* @psalm-pure
124+
*/
125+
public static function parseName(string $name): array
126+
{
127+
$names = [];
128+
$keyValues = explode(',', $name);
129+
foreach ($keyValues as $keyValue) {
130+
$exploded = explode('=', $keyValue);
131+
if (! isset($exploded[1])) {
132+
continue;
133+
}
134+
135+
[$key, $value] = $exploded;
136+
if (isset($key[0]) && $key[0] === '$') {
137+
$key = substr($key, 1);
138+
}
139+
140+
$trimedKey = trim($key);
141+
142+
$names[$trimedKey] = trim($value);
143+
}
144+
145+
return $names;
146+
}
147+
148+
/**
149+
* Convert array to string format for backward compatibility
150+
*
151+
* input: ['varA' => 'nameA', 'varB' => 'nameB']
152+
* output: "varA=nameA,varB=nameB"
153+
*
154+
* @deprecated Use Name class constructor with array directly instead
155+
*
156+
* @param array<string, string> $name
157+
*/
158+
public static function getStringName(array $name): string
159+
{
160+
$keys = array_keys($name);
161+
162+
$names = array_reduce(
163+
$keys,
164+
/**
165+
* @param list<string> $carry
166+
* @param array-key $key
167+
*/
168+
static function (array $carry, $key) use ($name): array {
169+
if (! is_string($key)) {
170+
throw new InvalidToConstructorNameParameter((string) $key);
171+
}
172+
173+
$varName = $name[$key] ?? '';
174+
$carry[] = $key . '=' . $varName;
175+
176+
return $carry;
177+
},
178+
[]
179+
);
180+
181+
return implode(',', $names);
182+
}
183+
}

‎src/di/AnnotatedClassMethods.php‎

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,8 @@
77
use Ray\Aop\ReflectionClass;
88
use Ray\Aop\ReflectionMethod;
99
use Ray\Di\Di\InjectInterface;
10-
use Ray\Di\Di\Named;
11-
use Ray\Di\Di\Qualifier;
1210
use ReflectionAttribute;
1311

14-
use function explode;
15-
use function get_class;
16-
use function property_exists;
17-
use function str_contains;
18-
use function substr;
19-
use function trim;
20-
2112
final class AnnotatedClassMethods
2213
{
2314
/**
@@ -38,8 +29,9 @@ public function getConstructorName(ReflectionClass $class): Name
3829
return $name;
3930
}
4031

41-
// Check for method-level Named and Qualifier attributes
42-
$names = $this->getMethodLevelQualifiers(new ReflectionMethod($class->getName(), '__construct'));
32+
// Check for method-level Named and Qualifier attributes (deprecated)
33+
/** @psalm-suppress DeprecatedMethod, DeprecatedClass */
34+
$names = LegacyAttributeHelper::getMethodLevelQualifiers(new ReflectionMethod($class->getName(), '__construct'));
4335
if ($names !== []) {
4436
return new Name($names);
4537
}
@@ -49,6 +41,7 @@ public function getConstructorName(ReflectionClass $class): Name
4941

5042
public function getSetterMethod(ReflectionMethod $method): ?SetterMethod
5143
{
44+
/** @psalm-suppress TooManyArguments */
5245
$inject = $method->getAnnotation(InjectInterface::class, ReflectionAttribute::IS_INSTANCEOF);
5346
if (! $inject instanceof InjectInterface) {
5447
return null;
@@ -71,66 +64,13 @@ private function getName(ReflectionMethod $method): Name
7164
return $name;
7265
}
7366

74-
// Check for method-level Named and Qualifier attributes
75-
$names = $this->getMethodLevelQualifiers($method);
67+
// Check for method-level Named and Qualifier attributes (deprecated)
68+
/** @psalm-suppress DeprecatedMethod, DeprecatedClass */
69+
$names = LegacyAttributeHelper::getMethodLevelQualifiers($method);
7670
if ($names !== []) {
7771
return new Name($names);
7872
}
7973

8074
return new Name(Name::ANY);
8175
}
82-
83-
/**
84-
* Extract qualifier information from method-level attributes
85-
*
86-
* @return array<string, string>
87-
*/
88-
private function getMethodLevelQualifiers(ReflectionMethod $method): array
89-
{
90-
$names = [];
91-
$attributes = $method->getAttributes();
92-
93-
foreach ($attributes as $attribute) {
94-
$instance = $attribute->newInstance();
95-
96-
// Check if this attribute is a qualifier
97-
$refClass = new ReflectionClass($instance);
98-
$qualifierAttrs = $refClass->getAttributes(Qualifier::class);
99-
100-
if ($qualifierAttrs !== []) {
101-
$qualifierClass = get_class($instance);
102-
103-
// Get the parameter name from the qualifier's value property if it exists
104-
if (property_exists($instance, 'value') && $instance->value !== null) {
105-
$names[(string) $instance->value] = $qualifierClass;
106-
} else {
107-
// If no value, apply to all parameters
108-
$names[Name::ANY] = $qualifierClass;
109-
}
110-
} elseif ($instance instanceof Named) {
111-
// Handle @Named at method level - parse as var1=name1,var2=name2
112-
$namedValue = $instance->value;
113-
if (str_contains($namedValue, '=')) {
114-
// Multiple variable mapping: var1=name1,var2=name2
115-
$keyValues = explode(',', $namedValue);
116-
foreach ($keyValues as $keyValue) {
117-
$exploded = explode('=', $keyValue);
118-
if (isset($exploded[1])) {
119-
[$key, $value] = $exploded;
120-
if (isset($key[0]) && $key[0] === '$') {
121-
$key = substr($key, 1);
122-
}
123-
124-
$names[trim($key)] = trim($value);
125-
}
126-
}
127-
} else {
128-
// Single name for all parameters
129-
$names[Name::ANY] = $namedValue;
130-
}
131-
}
132-
}
133-
134-
return $names;
135-
}
13676
}

‎src/di/Bind.php‎

Lines changed: 9 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@
66

77
use Ray\Aop\MethodInterceptor;
88
use Ray\Aop\ReflectionClass;
9-
use Ray\Di\Exception\InvalidToConstructorNameParameter;
109
use ReflectionException;
1110
use ReflectionMethod;
1211

13-
use function array_keys;
14-
use function array_reduce;
1512
use function assert;
1613
use function class_exists;
17-
use function implode;
1814
use function interface_exists;
1915
use function is_array;
20-
use function is_string;
16+
use function trigger_error;
17+
18+
use const E_USER_DEPRECATED;
2119

2220
/**
2321
* @psalm-import-type BindableInterface from Types
@@ -123,7 +121,12 @@ public function to(string $class): self
123121
public function toConstructor(string $class, $name, ?InjectionPoints $injectionPoints = null, ?string $postConstruct = null): self
124122
{
125123
if (is_array($name)) {
126-
$name = $this->getStringName($name);
124+
trigger_error(
125+
'Array parameter to toConstructor() is deprecated. Use Name class constructor with array directly.',
126+
E_USER_DEPRECATED
127+
);
128+
/** @psalm-suppress DeprecatedMethod, DeprecatedClass */
129+
$name = LegacyAttributeHelper::getStringName($name);
127130
}
128131

129132
$this->untarget = null;
@@ -208,38 +211,4 @@ private function isRegistered(string $interface): bool
208211
{
209212
return isset($this->container->getContainer()[$interface . '-' . Name::ANY]);
210213
}
211-
212-
/**
213-
* Return string
214-
*
215-
* input: ['varA' => 'nameA', 'varB' => 'nameB']
216-
* output: "varA=nameA,varB=nameB"
217-
*
218-
* @param ParameterNameMapping $name
219-
*/
220-
private function getStringName(array $name): string
221-
{
222-
$keys = array_keys($name);
223-
224-
$names = array_reduce(
225-
$keys,
226-
/**
227-
* @param list<string> $carry
228-
* @param array-key $key
229-
*/
230-
static function (array $carry, $key) use ($name): array {
231-
if (! is_string($key)) {
232-
throw new InvalidToConstructorNameParameter((string) $key);
233-
}
234-
235-
$varName = $name[$key] ?? '';
236-
$carry[] = $key . '=' . $varName;
237-
238-
return $carry;
239-
},
240-
[]
241-
);
242-
243-
return implode(',', $names);
244-
}
245214
}

0 commit comments

Comments
 (0)