Fix coding standards in Typogrify

Let's see what the testbot thinks of this patch.

The testbot only reports on files that have changed. Luckily, this patch touches several files. This patch just fixes array syntax:

• Use short array syntax.
• Add commas to the last entry of multi-line arrays.

Here is a second try at the patch. The previous one was 0 bytes, which means I am more tired than I realized.

The testbot noticed several problems. The following patch addresses two:

• Remove an unused use statement.
• Use a single space before =, ==, and =>.

The interdiff shows just these changes.

The attached patch fixes a few more problems:

• Add missing @param, @return comments.
• Add missing type hints.

This patch standardizes line indentation. It means that some of the comments no longer line up nicely, but for now I care more about making the testbot happy.

This patch fixes a few more problems in the doc blocks. I missed these in #5.

This patch fixes a few more indentation errors, doc blocks, and other comments.

I set the status to NR because I wanted to trigger tests. In fact, there is more work to do here, so I am setting the status back to NW.

Here is another patch that fixes one more line. I hope this fixes the failing test with PHP 7.4.

There is still more to do, but I am setting the status to NR to see whether it does fix the test.

So far, so good. Back to NW.

This patch includes several fixes:

1. Do not concatenate literal strings.
2. Use all caps for constants: TRUE and FALSE.
3. Use lowerCamelCase for method names.
4. Avoid gendered language in comments.
5. Remove a report left over from the initial automated port to D8.

IMO the only reason for some of these (such as (1)) is to keep CodeSniffer happy.

I will not fix the remaining indentation errors in src/SmartyPants.php since that is someone else's copyright/license notice. I think this fixes all the other problems the testbot reported on this issue. There are still some files, not touched in this issue, that have problems.

This patch should fix the failing test. I am setting the status to NR to confirm.

There are still several files mentioned on the branch test that need some fixes.

Follow Drupal coding standards in the remaining files:

• Wrap lines to 80 characters in README.md and INSTALL.txt. (Also add some backticks to README.md.)
• Add use statement so that we do not need fully qualified class names later.
• Follow whitespace standards.
• Add missing variable, function, and class doc blocks.
• Add types and comments to @param comments.
• Add ending punctuation to comment lines.
• Add type hints.
• Remove unneeded typogrify.install.
• Ignore indentation errors in the copyright/licanse lines.

With luck, this will be the final patch on this issue.

Add use statement so that we do not need fully qualified class names later.

Do it right this time: avoid a name collision.

After all, there is a reason that the original code had a use statement for SmartyPants but not for Typogrify.

I installed Upgrade Status and checked the Typogrify module. It reported that one of the automated tests had the wrong namespace. I am calling it in scope for this issue, and this patch should fix it.

The other warnings will be handled in #3126073: Drupal 9 compatibility.

I am reviewing this myself. This is not the best practice, but

1. It seems likely that no one else will take the trouble to review this issue.
2. The fix from #17 effectively increases test coverage for this module, so I want to commit it before other pending issues.
3. I will do my best to review the patch with "fresh eyes", just as I would review someone else's patch.

Note that the patch in #17 changes the name of the method to lowerCamelCase:

+++ b/src/Typogrify.php
@@ -128,14 +132,23 @@ class Typogrify {
...
-  public static function initial_quotes($text, $do_guillemets = false) {
+  public static function initialQuotes($text, $do_guillemets = FALSE) {

but not the option for the Twig filter:

+++ b/src/TwigExtension/Typogrify.php
@@ -16,24 +25,26 @@ class Typogrify extends \Twig_Extension {
...
-   *   Possible values: amp, widont, smartypants, caps, initial_quotes, dash
+   *   Possible values: amp, widont, smartypants, caps, initial_quotes, dash.
@@ -41,17 +52,18 @@ class Typogrify extends \Twig_Extension {
...
     if (in_array('initial_quotes', $options)) {
-      $text = \Drupal\typogrify\Typogrify::initial_quotes($text);
+      $text = TypogrifyBase::initialQuotes($text);
     }

The patch in #17 looks good to me.