Add support for a country token

Any Updates ?

Still No Solutions For This
I have opened another issue

First attempt at a country name token patch, with tests.

Update to try to get tests to run.

Continuing to work on test code.

missing use statement fixed.

explicitly enable token module

Added to kernel test annotation:
* @requires module token

Country name has been added as an option for any address field.

In order to get the address implementation of hook_tokens to execute after the hook_tokens function for the field module (in token.tokens.inc), I needed to implement hook_module_implements_alter.

Great job on the tests!

Could we have used hook_token_info_alter() to avoid needing address_module_implements_alter()?

+      $types[$token_type . '-' . $field_name . '-country_name'] = [
+        'name' => 'Country name',
+        'description' => NULL,
+        'needs-data' => $token_type . '-' . $field_name . '-country_name',
+      ];

Why do we need a custom type? Shouldn't we be able to reuse an existing field token type, as defined in https://cgit.drupalcode.org/token/tree/token.tokens.inc#n1391?

@bojanz Thank you. I did try using hook_token_info_alter() instead of hook_token_info(), but it didn't seem to make any difference. I can try again, though, if you think it might. I tried so many different things that it's quite possible I missed some simple combination.

As for the custom type, initially, I just created the country_name tokens as if country_name was just another property of the address field and for the token type, I just used:
\Drupal::service('token.entity_mapper')->getTokenTypeForEntityType($entity_type_id)

That worked fine, but I thought that maybe creating a custom type would somehow differentiate country_name from the actual address field properties, to help with my hook_tokens not getting overridden by logic in the token.tokens.inc field_tokens() method. Also, it seemed like everything I read about, "how to create custom tokens", started by explaining how to create a custom type. So I thought perhaps my code would be somehow incomplete if I didn't. (Even though it worked without it.) I'll happily remove the custom type to simplify the code.

As for getting rid of address_module_implements_alter(), my issues that field_tokens() (in token.tokens.inc) treats 'country_name' as if it's just another address field property and does this to my tokens (line 1695):

$replacements[$original] = $field_item->$property_name;

Since $field_name->country_name doesn't exist, and since field_tokens() executes after address_tokens(), my country_name replacement values are overwritten.

Essentially, I think my issue is that I want country_name tokens to behave as if they're address field properties so that they'll show up nicely in the tokens UI as part of address fields. But then when it comes time to replace the tokens with the actual values, I'd like for field_tokens() to just leave them alone and not try to set a replacement value for a field property that doesn't actually exist.

I did some experimenting. If I change the field type to an existing type like this:

'type' => $token_type . '-' . $field_name,

Then a weird little drop-down triangle appears next to the country name token (with nothing underneath it when clicked.)

For normal field properties, the 'type' is omitted from the definition:

          $info['tokens'][$field_token_name][$property] = [
            'name' => $property_definition->getLabel(),
            'description' => $property_definition->getDescription(),
            'module' => 'token',
          ];

If I omit type from the token definition for the country_name, everything seems to work fine, and the funny triangle does not appear. So I think I can either 1) get rid of the custom type and the 'type' part of the country_name tokens definition. Or 2) leave it as it is with the custom type.

Less code is always a good idea.

Removed the custom token type.

+    if (!$entity_type->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface')) {

isSubclassOf() is deprecated.
String references to classes/interfaces should be replaced by class references (ContentEntityInterface::class) in this case.

The test is not passing, the build is green here because it was skipped (probably due to the optional dependency.)

$this->installEntitySchema('address');

There is no "address" entity type.

    $this->installEntitySchema('node');
    $this->installEntitySchema('taxonomy_term');

This crashes without the "text" and "filter" modules listed in $modules.

$this->enableModules(['token']);

I get "2x: KernelTestBase::enableModules() should not be called from setUp(). Use the $modules property instead."

$entity = Node::create([

The test has no use statement for Node.

I fixed the above, but the test is still crashing, so setting to "needs work". Uploading updated patch.

Fixed various errors in the Kernel test including an incorrect use statement, missing setUp items, and a token name typo.

Kernel test was passing locally but failed here. Trying a changed base class.

Kernel test doesn't seem happy with including any test base code from token module. Removed it in this patch.

A little coding standards cleanup now that testbot is happy with test.

EDIT: actually...just looked more carefully: the test was skipped.

Removed from the annotation: @requires module token

Patch #24 has in its class annotation:
@requires module token

Patch #26 does not have that in its annotation.

Patch #24 does not run the CountryNameTokenTest kernel tests.
Patch #26 fails because the token module is unavailable (and says the test class needs to be annotated with '@requires module token')

So I'm not sure what I can do at this point.

I don't think this is the intended usage for the test_dependencies property in the info.yml file, but perhaps it will encourage testbot to include the token dependency.

I just learned that test_dependencies will work but only if it's committed first.

The alternative is to add token to require-dev in the module's composer.json file, which I've done here.

Documentation for this was just added here: Managing dependencies for a contributed project

Changed base class to reduce code by reusing token module test code.

Thank you, Lisa.

I've removed the require-dev, now that test_dependencies should be recognized post-commit.