feat: refactor string package reverse

[steff456]

Part of #1062

Description

What is the purpose of this pull request?

This pull request:

• Refactors the string package @stdlib/string/reverse
• Adds @stdlib/string/base/reverse
• Adds @stdlib/string/base/reverse-code-points
• Adds @stdlib/string/base/reverse-grapheme-clusters

Related Issues

Does this pull request have any related issues?

This pull request:

• Is part of Tracking issue: refactor string packages handling grapheme clusters in terms of "base" packages #1062

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

• Read, understood, and followed the contributing guidelines.

---

@stdlib-js/reviewers

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-point	$\color{red}120/134$ $\color{green}+89.55\%$	$\color{red}4/5$ $\color{green}+80.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{red}120/134$ $\color{green}+89.55\%$
string/base/reverse-grapheme-cluster	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}147/147$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

[kgryte]

@steff456 Looks like the tests don't cover all branches for reversing code points. Would you mind adding a few tests to address?

[kgryte]

You can generate a test coverage report locally using make test-cov.

[Planeshifter]

@steff456 @kgryte

Ran make test-cov TESTS_FILTER='.*/string/base/reverse-code-point/.*' locally and am getting the same coverage as in the table.

One can see the uncovered lines online as well: https://coverage.stdlib.io/string/base/reverse-code-point/

[steff456]

Thanks @Planeshifter and @kgryte, I'll check the tests :)

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-point	$\color{red}133/137$ $\color{green}+97.08\%$	$\color{red}7/8$ $\color{green}+87.50\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{red}133/137$ $\color{green}+97.08\%$
string/base/reverse-grapheme-cluster	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}147/147$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-point	$\color{green}137/137$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}137/137$ $\color{green}+100.00\%$
string/base/reverse-grapheme-cluster	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}147/147$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

[steff456]

I'm not sure why the coverage tests failed with the last commit, but when I try it locally it is working 🙃

[kgryte]

@steff456 I believe the test coverage failure is due to a known issue. @Planeshifter can you comment?

[Planeshifter]

@steff456 Will look into it, sorry for that; seems like the job was not able to push the coverage report to the test coverage repo. The table now shows that 100% coverage is achieved, though, so that's awesome!

[steff456]

Perf! Thanks to both 👏🏻

[kgryte]

@steff456 Would you mind renaming the packages from

reverse-code-point
reverse-grapheme-cluster

to

reverse-code-points
reverse-grapheme-clusters

The use of singular is a bit confusing in this context, as, e.g., reverse-code-point, makes it seem as those the function only reverses a single code point, rather than a sequence of code points.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}137/137$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}137/137$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}147/147$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}135/135$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}135/135$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+0.00\%$	$\color{green}12/12$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}147/147$ $\color{green}+0.00\%$

The above coverage report was generated for the changes in this PR.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}135/135$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}135/135$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+0.00\%$	$\color{green}12/12$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}147/147$ $\color{green}+0.00\%$

The above coverage report was generated for the changes in this PR.

[kgryte]

@steff456 Thanks for working on this. Left a few comments. The handling of grapheme clusters looks off to me, based on the expected test values. Additionally, we need to add a couple more TypeScript tests and fix some missing documentation.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}135/135$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}135/135$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}121/121$ $\color{green}+0.00\%$	$\color{green}5/5$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}121/121$ $\color{green}+0.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}147/147$ $\color{green}+0.00\%$	$\color{green}12/12$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}147/147$ $\color{green}+0.00\%$

The above coverage report was generated for the changes in this PR.

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}135/135$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}135/135$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}127/127$ $\color{green}+0.00\%$	$\color{green}6/6$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}127/127$ $\color{green}+0.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}148/148$ $\color{green}+0.00\%$	$\color{green}12/12$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}148/148$ $\color{green}+0.00\%$

The above coverage report was generated for the changes in this PR.

[kgryte]

For future reference, this is not the most memory efficient approach (i.e., prepending strings), but we don't have much choice until the bug in prevGraphemeClusterBreak is resolved (ref: #1092).

[kgryte]

LGTM. Thanks, @steff456!

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
string/base/reverse-code-points	$\color{green}135/135$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}135/135$ $\color{green}+100.00\%$
string/base/reverse-grapheme-clusters	$\color{green}127/127$ $\color{green}+0.00\%$	$\color{green}6/6$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}127/127$ $\color{green}+0.00\%$
string/base/reverse	$\color{green}102/102$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}102/102$ $\color{green}+100.00\%$
string/reverse	$\color{green}148/148$ $\color{green}+0.00\%$	$\color{green}12/12$ $\color{green}+0.00\%$	$\color{green}1/1$ $\color{green}+0.00\%$	$\color{green}148/148$ $\color{green}+0.00\%$

The above coverage report was generated for the changes in this PR.

[kgryte]

The failing CI jobs do not appear related to this PR. As such, will go ahead and merge...