Skip to content

R1C1 conversion should handle absolute A1 references #2060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MarkBaker merged 4 commits into from
May 7, 2021
Merged

R1C1 conversion should handle absolute A1 references #2060

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aeb21f7
R1C1 conversion should handle absolute A1 references
ndench May 4, 2021
c7f65bb
Update CHANGELOG.md with R1C1 conversion change
ndench May 4, 2021
c2fa059
Remove complexity from AddressHelper::convertToR1C1
ndench May 5, 2021
1adc188
Use named regex groups and constants for regex strings
ndench May 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
R1C1 conversion should handle absolute A1 references
  • Loading branch information
@ndench
ndench committed May 4, 2021
commit aeb21f7537a1a07247c27e41750622b2fbd85caf
19 changes: 16 additions & 3 deletions src/PhpSpreadsheet/Cell/AddressHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,27 @@ public static function convertToR1C1(
?int $currentRowNumber = null,
?int $currentColumnNumber = null
): string {
$validityCheck = preg_match('/^\$?([A-Z]{1,3})\$?(\d{1,7})$/i', $address, $cellReference);
$validityCheck = preg_match('/^(\$?[A-Z]{1,3})(\$?\d{1,7})$/i', $address, $cellReference);

if ($validityCheck === 0) {
throw new Exception('Invalid A1-format Cell Reference');
}

$columnId = Coordinate::columnIndexFromString($cellReference[1]);
$rowId = (int) $cellReference[2];
if ($cellReference[1][0] === '$') {
$columnId = Coordinate::columnIndexFromString(substr($cellReference[1], 1));
Copy link
Member

@MarkBaker MarkBaker May 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be easier to extract the $ for absolutes, the column address and row id directly through individual capture groups in the regexp rather than using substring? Then you can also eliminate the else condition in these if statements, which reduces the complexity of the code for path coverage

Copy link
Contributor Author

@ndench ndench May 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point. I originally went this way to not increase the complexity of the regex, but I think your way is cleaner. I'll push an update today.

Copy link
Contributor Author

@ndench ndench May 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed that change now. Much cleaner 👍

Copy link
Member

@MarkBaker MarkBaker May 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those changes to the regex don't add any significant cost to execution, as you're already executing the regex anyway; but do eliminate the substr() function calls.

The only thing I'd be tempted to change now would be to use named capture groups in the regex, so you could reference

$rowId = (int) $cellReference['row_id'];

or

if ($cellReference['absolute_column_ref'] === '$') {

as associative rather than enumerated, which adds to the readability of the code.

I've only recently started using named capture groups myself. It gives the benefit of improved readability of purpose, but It does add to the complexity of the expression. I can understand if you wouldn't want to use them though.

One last change I'd suggest would be to extract the regex to a class constant, which can then be made public, because potentially there's other places in the codebase that could use it (such as the coordinateFromString() method in Cell\Coordinate... it might be better located there as a public class constant anyway).

Copy link
Contributor Author

@ndench ndench May 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that named groups are much more readable, I just stuck with non-named to match the existing code style.

I've updated it to use named groups and also moved the regex into a constant and reused it in Cell\Coordinate. Which is outside of scope for this PR, but I think the regexes should be reused constants which will minimize future bugs. Happy to undo this change if you want, but the tests still pass so it should be fine?

// Column must be absolute address
$currentColumnNumber = null;
} else {
$columnId = Coordinate::columnIndexFromString($cellReference[1]);
}

if ($cellReference[2][0] === '$') {
$rowId = (int) substr($cellReference[2], 1);
// Row must be absolute address
$currentRowNumber = null;
} else {
$rowId = (int) $cellReference[2];
}

if ($currentRowNumber !== null) {
if ($rowId === $currentRowNumber) {
Expand Down
15 changes: 15 additions & 0 deletions tests/data/Cell/A1ConversionToR1C1Relative.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,33 @@

return [
['R[2]C[2]', 'O18', 16, 13],
['R18C15', '$O$18', 16, 13],
['R[-2]C[2]', 'O14', 16, 13],
['R[-2]C15', '$O14', 16, 13],
['R[2]C[-2]', 'K18', 16, 13],
['R18C[-2]', 'K$18', 16, 13],
['R[-2]C[-2]', 'K14', 16, 13],
['RC[3]', 'P16', 16, 13],
['R16C[3]', 'P$16', 16, 13],
['RC[-3]', 'J16', 16, 13],
['RC10', '$J16', 16, 13],
['R[4]C', 'M20', 16, 13],
['R[4]C13', '$M20', 16, 13],
['R[-4]C', 'M12', 16, 13],
['R12C', 'M$12', 16, 13],
['RC', 'E5', 5, 5],
['R5C5', '$E$5', 5, 5],
['R5C', 'E5', null, 5],
['R5C5', '$E5', null, 5],
['R5C', 'E$5', null, 5],
['RC5', 'E5', 5, null],
['RC5', '$E5', 5, null],
['R5C5', 'E$5', 5, null],
['R5C[2]', 'E5', null, 3],
['R5C5', '$E5', null, 3],
['R5C[2]', 'E$5', null, 3],
['R[2]C5', 'E5', 3, null],
['R5C5', '$E$5', 3, null],
['R5C[-2]', 'E5', null, 7],
['R[-2]C5', 'E5', 7, null],
];