Introduce lowercase-string #3438

VincentLanglet · 2024-09-13T10:04:27Z

No description provided.

src/Type/Accessory/AccessoryLowercaseStringType.php

staabm · 2024-09-13T10:19:00Z

src/Type/Php/SubstrDynamicReturnTypeExtension.php

-		if (count($args) === 0) {
+		if (count($args) < 2) {
 			return null;
 		}

-		if (count($args) >= 2) {


this cleanup regarding count-of-args and the indent change over the whole block could be a separate PR to make this diff here more readable

I opened #3439

staabm · 2024-09-13T10:24:57Z

edge-case which came to mind while looking at the PR:

offset-lookup in a lower-case string yields a lower-case string:
https://3v4l.org/1eWRH

VincentLanglet · 2024-09-13T11:15:10Z

There is at least

src/Type/Php/ReplaceFunctionsDynamicReturnTypeExtension.php
src/Type/Php/SprintfFunctionDynamicReturnTypeExtension.php
src/Type/Php/StrPadFunctionReturnTypeExtension.php
src/Type/Php/StrRepeatFunctionReturnTypeExtension.php
src/Type/Php/StrTokFunctionReturnTypeExtension.php

wich can be improved too, but maybe it's better in another PR.

thg2k · 2024-09-13T12:09:01Z

What's the use case? Is there an issue linked explaining why we need this? Why not also uppercase string?

VincentLanglet · 2024-09-13T12:19:13Z

Why not also uppercase string?

lowercase-string is the only one supported by Psalm so far and codebase more often use lowercase-string than uppercase string. https://psalm.dev/r/c4d35bbe26

You can see it's used a lot in their codebase https://github.com/search?q=repo%3Avimeo%2Fpsalm%20lowercase-string&type=code
But it's also used in some others codebase like https://github.com/search?q=repo%3ARoave%2FBetterReflection%20lowercase-string&type=code (and certainly more).

It's useful

For case-insensitive mapping/behavior
When working with case insensitive data, like URL.

I personally work a lot with URL recently, and it's useful to unsure/checks that I always work with lowercase string.

staabm · 2024-09-13T14:11:21Z

Use separate test files in the nsrt/ folder and use a different // lint comment condition in the first line and PhpVersion method for the version check in the impl

phpstan-bot · 2024-09-13T14:36:36Z

This pull request has been marked as ready for review.

VincentLanglet · 2024-09-13T14:37:02Z

I think it will be easier and better to have

src/Type/Php/ReplaceFunctionsDynamicReturnTypeExtension.php
src/Type/Php/SprintfFunctionDynamicReturnTypeExtension.php
src/Type/Php/StrPadFunctionReturnTypeExtension.php
src/Type/Php/StrRepeatFunctionReturnTypeExtension.php
src/Type/Php/StrTokFunctionReturnTypeExtension.php

in another PR.

staabm · 2024-09-13T19:33:32Z

I think this should include str-concatenation of 2 lowercase strings, because its a super low level thing

VincentLanglet · 2024-09-13T21:00:55Z

I think this should include str-concatenation of 2 lowercase strings, because its a super low level thing

Indeed, it's supported now.

staabm · 2024-09-14T06:41:09Z

I think we are missing a rule test for e.g.

/** @param lowercase-string $s */
function doFoo($s) {
  if ($s === 'AB') {}
  if ('AB' === $s) {}
  if ('AB' !== $s) {}
  if ($s === 'ab') {}
  if ($s !== 'ab') {}
  if ($s === 'aBc') {}
  if ($s !== 'aBc') {}
  if ($s === '01') {}
  if ($s === '1e2') {}
  if ($s === MyClass::myConst) {}
  if ($s === A_GLOBAL_CONST) {}
  if (doFoo('hi') === 'AB') {}
}

which asserts rule error(s) when comparing constant with lowercase-string.

as a followup it also can be useful to test comparisons for string-functions

/** @param lowercase-string $s */
function doFoo($s, int $x, int $y) {
  $part = substr($s, $x, $y);
  if ($part === 'AB) {} // always false
}

staabm · 2024-09-14T06:42:09Z

src/PhpDoc/TypeNodeResolver.php

+					new StringType(),
+					new AccessoryNonEmptyStringType(),
+				]);
+
 			case 'non-empty-lowercase-string':


do we have a test somewhere for this type?
(I think I see it the very first time today)

Added in 9636e83

tests/PHPStan/Type/TypeToPhpDocNodeTest.php

VincentLanglet · 2024-09-14T08:18:58Z

After this PR, we may want to introduce check for always false result
StrPosRule/StrStartsWithRule/StrContainRule/StrEndswithRule
cf https://phpstan.org/r/49d9f64f-9488-44ca-81e4-8d73767c4084

ondrejmirtes

There are no tests about accepting lowercase-string. Add a new test method to CallMethodsRuleTest and try passing different things like a constant string, another lowercase-string and general string to a parameter that accepts lowecase-string.
This change is quite disruptive as you can see from the tests that needed changing. We should do this only for bleeding edge, similarly to the list type. This means that all the places that currently do new IntersectionType and add the new accesory type will need to do AccessoryLowercaseStringType::intersectWith() instead. Also, TypeNodeResolver will interpret lowercase-string type the new way only with bleeding edge.

ondrejmirtes · 2024-09-14T18:31:42Z

src/Type/Accessory/AccessoryLowercaseStringType.php

+
+	public function acceptsWithReason(Type $type, bool $strictTypes): AcceptsResult
+	{
+		if ($type instanceof MixedType) {


You copied this from accessory literal string type, but it does not belong here.

ondrejmirtes · 2024-09-14T18:40:49Z

tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php

@@ -1129,19 +1129,19 @@ public function dataArrayDestructuring(): array
 				'$fourthStringArrayForeachList',
 			],
 			[
-				'string',
+				'lowercase-string',


I don't get this change. IMHO it should remain a string.

Or maybe it should be numeric-string.

'2018-12-19' is technically a lowercase-string.

And explode($lowercaseString) is array<lowercase-string>.

So every element of the array is precised from string to lowercase-string.

ondrejmirtes

Also: We need excessive tests in TypeCombinatorTest::dataUnion and dataIntersect about the interaction with other string types.

ondrejmirtes · 2024-09-14T18:46:27Z

src/Type/Accessory/AccessoryNumericStringType.php

@@ -296,6 +296,11 @@ public function isLiteralString(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}

+	public function isLowercaseString(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();


I'd say yes.

"10E4" is a numeric string not lowercase

Yes that is the reason I kept maybe

ondrejmirtes · 2024-09-15T09:30:35Z

Maybe we don't need to do this only for bleeding edgw, just do a better job in VerbosityLevel::getRecommendedLevelByType

VincentLanglet · 2024-09-15T18:49:02Z

Maybe we don't need to do this only for bleeding edgw, just do a better job in VerbosityLevel::getRecommendedLevelByType

Do you have a preferred solution between bleeding edge and changing getRecommendedLevelByType ?

I unsure to understand what is needed to change in getRecommendedLevelByType.

ondrejmirtes · 2024-09-15T18:54:34Z

I'd like for lowercase-string to be in an error message about not-accepted type only if there's lowercase-string on the accepting side.

Please start by showing in a test how IntersectionType::describe() behaves with different VerbosityLevel when there's AccessoryLowercaseStringType involved.

I think we could bump it from value to precise.

And then in getRecommendedLevelByType we should look at $acceptedType and bump the returned level from value to precise only if $acceptingType->isLowecaseString()->yes().

After you do that, the impact on existing rules tests should be minimal. And I could merge it for everyone, not just on bleeding edge.

VincentLanglet · 2024-09-15T21:04:47Z

I'd like for lowercase-string to be in an error message about not-accepted type only if there's lowercase-string on the accepting side.

Please start by showing in a test how IntersectionType::describe() behaves with different VerbosityLevel when there's AccessoryLowercaseStringType involved.

I think we could bump it from value to precise.

And then in getRecommendedLevelByType we should look at $acceptedType and bump the returned level from value to precise only if $acceptingType->isLowecaseString()->yes().

Ok, so If I understood correctly, it should be something like
1c20bb1

I need to update some tests, but still I have some issue with error message like

Strict comparison using === between string and 'AB' will always evaluate to false.

because not every Rules use VerbosityLevel::getRecommendedLevelByType, as an example

phpstan-src/src/Rules/Comparison/StrictComparisonOfDifferentTypesRule.php

Lines 62 to 67 in a42be43

    
           $addTip(RuleErrorBuilder::message(sprintf( 
        
           	'Strict comparison using %s between %s and %s will always evaluate to false.', 
        
           	$node->getOperatorSigil(), 
        
           	$leftType->describe(VerbosityLevel::value()), 
        
           	$rightType->describe(VerbosityLevel::value()), 
        
           )))->identifier(sprintf('%s.alwaysFalse', $node instanceof Node\Expr\BinaryOp\Identical ? 'identical' : 'notIdentical'))->build(),

So I assume such thing need to be changed first...

VincentLanglet · 2024-09-16T14:03:57Z

For testParsingDesiredTypeDescription and testDesiredTypeDescription the VerbosityLevel::value() is used.

Should I bump it to precise @ondrejmirtes ?

Also, do you want me to extract 053e6cd in another PR first ? I dunno if more rule will need the same change.

@staabm You're the one who suggested tests for this rule (#3438 (comment)) do you have more rule with lowercase-string in mind ?

VincentLanglet force-pushed the lowercaseString branch from 726e304 to a776452 Compare September 13, 2024 10:04

staabm reviewed Sep 13, 2024

View reviewed changes

src/Type/Accessory/AccessoryLowercaseStringType.php Outdated Show resolved Hide resolved

staabm reviewed Sep 13, 2024

View reviewed changes

VincentLanglet force-pushed the lowercaseString branch from 4b2513c to 3cbedb0 Compare September 13, 2024 10:41

VincentLanglet mentioned this pull request Sep 13, 2024

Simplify SubstrDynamicReturnTypeExtension #3439

Merged

VincentLanglet force-pushed the lowercaseString branch from 62ef6dd to 669a302 Compare September 13, 2024 14:01

VincentLanglet marked this pull request as ready for review September 13, 2024 14:36

VincentLanglet requested a review from staabm September 13, 2024 21:00

staabm reviewed Sep 14, 2024

View reviewed changes

tests/PHPStan/Type/TypeToPhpDocNodeTest.php Show resolved Hide resolved

VincentLanglet force-pushed the lowercaseString branch from 7c72c6f to 9636e83 Compare September 14, 2024 08:03

mvorisek mentioned this pull request Sep 14, 2024

Add support for lowercase string phpstan/phpstan#11683

Open

VincentLanglet requested a review from staabm September 14, 2024 08:34

ondrejmirtes requested changes Sep 14, 2024

View reviewed changes

VincentLanglet mentioned this pull request Sep 15, 2024

Fix string types sorting #3441

Merged

VincentLanglet added 15 commits September 15, 2024 22:14

Introduce lowercase-string

8c55b51

Update signature

0498440

Update StrCaseReturnType

e1d3f7f

Fix tests

978c581

More dynamicReturnTypes

5edb980

Fix

1b86a48

Fix

e522f3c

Fix

718b38c

Fix cs

3bac471

Fix baseline

b44b3dc

Fix tests

217d7fc

Add support for Concat operator

12ff505

Add tests

7a37690

Wip

a26e696

Add TypeCombinator tests

db923b3

VincentLanglet force-pushed the lowercaseString branch from 9636e83 to db923b3 Compare September 15, 2024 20:19

WIP

1c20bb1

Rework

48754e1

VincentLanglet force-pushed the lowercaseString branch from 9e9ff53 to 48754e1 Compare September 16, 2024 09:32

VincentLanglet added 6 commits September 16, 2024 11:33

Update test

e873b37

fix test

c428855

Fix cs

af78c9b

Fix test

6c0c65b

update rule

053e6cd

Try

487eccd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce lowercase-string #3438

Introduce lowercase-string #3438

VincentLanglet commented Sep 13, 2024

staabm Sep 13, 2024 •

edited

Loading

VincentLanglet Sep 13, 2024

staabm commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

thg2k commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024 •

edited

Loading

staabm commented Sep 13, 2024 •

edited

Loading

phpstan-bot commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

staabm commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

staabm commented Sep 14, 2024 •

edited

Loading

staabm Sep 14, 2024 •

edited

Loading

VincentLanglet Sep 14, 2024

VincentLanglet commented Sep 14, 2024

ondrejmirtes left a comment

ondrejmirtes Sep 14, 2024

ondrejmirtes Sep 14, 2024

ondrejmirtes Sep 14, 2024

VincentLanglet Sep 15, 2024

ondrejmirtes left a comment

ondrejmirtes Sep 14, 2024

thg2k Sep 14, 2024

VincentLanglet Sep 14, 2024

ondrejmirtes commented Sep 15, 2024

VincentLanglet commented Sep 15, 2024

ondrejmirtes commented Sep 15, 2024

VincentLanglet commented Sep 15, 2024

VincentLanglet commented Sep 16, 2024

Introduce lowercase-string #3438

Are you sure you want to change the base?

Introduce lowercase-string #3438

Conversation

VincentLanglet commented Sep 13, 2024

staabm Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

staabm commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

thg2k commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024 • edited Loading

staabm commented Sep 13, 2024 • edited Loading

phpstan-bot commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

staabm commented Sep 13, 2024

VincentLanglet commented Sep 13, 2024

staabm commented Sep 14, 2024 • edited Loading

staabm Sep 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VincentLanglet commented Sep 14, 2024

ondrejmirtes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes commented Sep 15, 2024

VincentLanglet commented Sep 15, 2024

ondrejmirtes commented Sep 15, 2024

VincentLanglet commented Sep 15, 2024

VincentLanglet commented Sep 16, 2024

staabm Sep 13, 2024 •

edited

Loading

VincentLanglet commented Sep 13, 2024 •

edited

Loading

staabm commented Sep 13, 2024 •

edited

Loading

staabm commented Sep 14, 2024 •

edited

Loading

staabm Sep 14, 2024 •

edited

Loading