wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-23 22:45:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change order of elements in the refs call stack

Browse source 
The main benefit is this nifty call: `$this->rollbackRef( ...$call )`

To make this possible, the minimal change I needed to do was to move
the two $argv and $text arguments to the end.

I also tried to order all other arguments as good as I could: Required
first, optional later. Group and name together. Name and extends
together.

All this is private implementation and should not affect anything.

Change-Id: I7af7636c465769aa53122eb40d964eabdd1289ba
This commit is contained in:
Thiemo Kreuz 2019-12-19 09:23:16 +01:00
parent 6d55f9e8cc
commit 38fe3665e5
2 changed files with 49 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/ReferenceStack.php
View file

@ -164,7 +164,7 @@ class ReferenceStack {
// array index is constant, preventing O(N) searches. // array index is constant, preventing O(N) searches.
array_splice( $this->refs[$group], $k, 0, [ $ref ] ); array_splice( $this->refs[$group], $k, 0, [ $ref ] );
array_splice( $this->refCallStack, $k, 0, array_splice( $this->refCallStack, $k, 0,
[ [ 'new', $argv, $text, $name, $extends, $group, $this->refSequence ] ] ); [ [ 'new', $this->refSequence, $group, $name, $extends, $argv, $text ] ] );
// A "follow" never gets its own footnote marker // A "follow" never gets its own footnote marker
return null; return null;
@ -237,7 +237,7 @@ class ReferenceStack {
} }
} }
$this->refCallStack[] = [ $action, $argv, $text, $name, $extends, $group, $ref['key'] ]; $this->refCallStack[] = [ $action, $ref['key'], $group, $name, $extends, $argv, $text ];
return $ref; return $ref;
} }
@ -246,7 +246,7 @@ class ReferenceStack {
* last few tags were actually inside of a references tag. * last few tags were actually inside of a references tag.
* *
* @param int $count * @param int $count
* @return array Refs to restore under the correct context. [ $argv, $text ] * @return array[] Refs to restore under the correct context, as a list of [ $argv, $text ]
*/ */
public function rollbackRefs( int $count ) : array { public function rollbackRefs( int $count ) : array {
$redoStack = []; $redoStack = [];
@ -256,10 +256,9 @@ class ReferenceStack {
} }
$call = array_pop( $this->refCallStack ); $call = array_pop( $this->refCallStack );
if ( $call !== false ) { if ( $call ) {
[ $action, $argv, $text, $name, $extends, $group, $key ] = $call; $this->rollbackRef( ...$call );
$this->rollbackRef( $action, $name, $extends, $group, $key ); $redoStack[] = array_slice( $call, -2 );
$redoStack[] = [ $argv, $text ];
} }
} }
// Drop unused rollbacks, this group is finished. // Drop unused rollbacks, this group is finished.
@ -285,17 +284,17 @@ class ReferenceStack {
* corrupting certain links. * corrupting certain links.
* *
* @param string $action * @param string $action
* @param string|null $name The name attribute passed in the ref tag.
* @param string|null $extends
* @param string $group
* @param int $key Autoincrement counter for this ref. * @param int $key Autoincrement counter for this ref.
* @param string $group
* @param ?string $name The name attribute passed in the ref tag.
* @param ?string $extends
*/ */
private function rollbackRef( private function rollbackRef(
string $action, string $action,
?string $name, int $key,
?string $extends,
string $group, string $group,
int $key ?string $name,
?string $extends
) { ) {
if ( !$this->hasGroup( $group ) ) { if ( !$this->hasGroup( $group ) ) {
return; return;

74
tests/phpunit/unit/ReferenceStackTest.php
View file

@ -85,7 +85,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', null, null, '', 1 ] [ 'new', 1, '', null, null, [], 'text' ],
] ]
], ],
'Anonymous ref in named group' => [ 'Anonymous ref in named group' => [
@ -115,7 +115,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ] [ 'new', 1, 'foo', null, null, [], 'text' ],
] ]
], ],
'Ref with text' => [ 'Ref with text' => [
@ -145,7 +145,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ] [ 'new', 1, 'foo', null, null, [], 'text' ],
] ]
], ],
'Named ref with text' => [ 'Named ref with text' => [
@ -175,7 +175,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', 'name', null, 'foo', 1 ] [ 'new', 1, 'foo', 'name', null, [], 'text' ],
] ]
], ],
'Follow after base' => [ 'Follow after base' => [
@ -207,7 +207,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ] [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
] ]
], ],
'Follow with no base' => [ 'Follow with no base' => [
@ -230,7 +230,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ] [ 'new', 1, 'foo', null, null, [], 'text' ],
] ]
], ],
'Follow pointing to later ref' => [ 'Follow pointing to later ref' => [
@ -287,9 +287,9 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-b', null, null, 'foo', 2 ], [ 'new', 2, 'foo', null, null, [], 'text-b' ],
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
[ 'new', [], 'text-c', 'c', null, 'foo', 3 ] [ 'new', 3, 'foo', 'c', null, [], 'text-c' ],
] ]
], ],
'Repeated ref, text in first tag' => [ 'Repeated ref, text in first tag' => [
@ -328,8 +328,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text' ],
[ 'increment', [], null, 'a', null, 'foo', 1 ] [ 'increment', 1, 'foo', 'a', null, [], null ],
] ]
], ],
'Repeated ref, text in second tag' => [ 'Repeated ref, text in second tag' => [
@ -368,8 +368,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], null, 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], null ],
[ 'assign', [], 'text', 'a', null, 'foo', 1 ] [ 'assign', 1, 'foo', 'a', null, [], 'text' ],
] ]
], ],
'Repeated ref, mismatched text' => [ 'Repeated ref, mismatched text' => [
@ -408,8 +408,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-1', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-1' ],
[ 'increment', [], 'text-2', 'a', null, 'foo', 1 ] [ 'increment', 1, 'foo', 'a', null, [], 'text-2' ],
] ]
], ],
'Named extends with no parent' => [ 'Named extends with no parent' => [
@ -447,7 +447,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', 'b', 'foo', 1 ], [ 'new', 1, 'foo', 'a', 'b', [], 'text-a' ],
] ]
], ],
'Named extends before parent' => [ 'Named extends before parent' => [
@ -498,8 +498,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', 'b', 'foo', 1 ], [ 'new', 1, 'foo', 'a', 'b', [], 'text-a' ],
[ 'new', [], 'text-b', 'b', null, 'foo', 2 ], [ 'new', 2, 'foo', 'b', null, [], 'text-b' ],
] ]
], ],
'Named extends after parent' => [ 'Named extends after parent' => [
@ -550,8 +550,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
[ 'new', [], 'text-b', 'b', 'a', 'foo', 2 ], [ 'new', 2, 'foo', 'b', 'a', [], 'text-b' ],
] ]
], ],
'Anonymous extends with no parent' => [ 'Anonymous extends with no parent' => [
@ -589,7 +589,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
], ],
[ [
[ 'new', [], 'text-a', null, 'b', 'foo', 1 ], [ 'new', 1, 'foo', null, 'b', [], 'text-a' ],
] ]
], ],
'Anonymous extends before parent' => [ 'Anonymous extends before parent' => [
@ -640,8 +640,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', null, 'b', 'foo', 1 ], [ 'new', 1, 'foo', null, 'b', [], 'text-a' ],
[ 'new', [], 'text-b', 'b', null, 'foo', 2 ], [ 'new', 2, 'foo', 'b', null, [], 'text-b' ],
] ]
], ],
'Anonymous extends after parent' => [ 'Anonymous extends after parent' => [
@ -692,8 +692,8 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
[ 'new', [], 'text-b', null, 'a', 'foo', 2 ], [ 'new', 2, 'foo', null, 'a', [], 'text-b' ],
] ]
], ],
'Normal after extends' => [ 'Normal after extends' => [
@ -761,9 +761,9 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
[ 'new', [], 'text-b', null, 'a', 'foo', 2 ], [ 'new', 2, 'foo', null, 'a', [], 'text-b' ],
[ 'new', [], 'text-c', 'c', null, 'foo', 3 ], [ 'new', 3, 'foo', 'c', null, [], 'text-c' ],
] ]
], ],
'Two broken follows' => [ 'Two broken follows' => [
@ -813,9 +813,9 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
] ]
], ],
[ [
[ 'new', [], 'text-b', null, null, 'foo', 2 ], [ 'new', 2, 'foo', null, null, [], 'text-b' ],
[ 'new', [], 'text-c', null, null, 'foo', 3 ], [ 'new', 3, 'foo', null, null, [], 'text-c' ],
[ 'new', [], 'text-a', 'a', null, 'foo', 1 ], [ 'new', 1, 'foo', 'a', null, [], 'text-a' ],
] ]
], ],
]; ];
@ -855,7 +855,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
'Skip invalid refs' => [ [ false ], [], 1, [], [] ], 'Skip invalid refs' => [ [ false ], [], 1, [], [] ],
'Missing group' => [ 'Missing group' => [
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ], [ 'new', 1, 'foo', null, null, [], 'text' ],
], ],
[], [],
1, 1,
@ -866,7 +866,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
'Find anonymous ref by key' => [ 'Find anonymous ref by key' => [
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ], [ 'new', 1, 'foo', null, null, [], 'text' ],
], ],
[ [
'foo' => [ 'foo' => [
@ -883,7 +883,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
'Missing anonymous ref' => [ 'Missing anonymous ref' => [
[ [
[ 'new', [], 'text', null, null, 'foo', 1 ], [ 'new', 1, 'foo', null, null, [], 'text' ],
], ],
[ [
'foo' => [ 'foo' => [
@ -906,7 +906,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
'Assign text' => [ 'Assign text' => [
[ [
[ 'assign', [], 'text-2', null, null, 'foo', 1 ], [ 'assign', 1, 'foo', null, null, [], 'text-2' ],
], ],
[ [
'foo' => [ 'foo' => [
@ -933,7 +933,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
'Increment' => [ 'Increment' => [
[ [
[ 'increment', [], null, null, null, 'foo', 1 ], [ 'increment', 1, 'foo', null, null, [], null ],
], ],
[ [
'foo' => [ 'foo' => [
@ -958,7 +958,7 @@ class ReferenceStackTest extends \MediaWikiUnitTestCase {
], ],
'Safely ignore placeholder' => [ 'Safely ignore placeholder' => [
[ [
[ 'increment', [], null, null, null, 'foo', 1 ], [ 'increment', 1, 'foo', null, null, [], null ],
], ],
[ [
'foo' => [ 'foo' => [