Drupal provides the country list via the CountryManager. Entity properties sometimes have a need to store the country.
There is no constraint/validator that would validate the country against Drupal's country list.
Symfony Form has one, but it only works for symfony/intl, which we aren't using.

So, let's add our own constraint for this.

Beta phase evaluation

This is a non-prioritized normal task. It introduces no disruption, only adds a missing validator.

CommentFileSizeAuthor
#9 2434095-9-add-country-constraint.patch5.56 KBbojanz
#8 interdiff-6-7.txt938 bytesmartin107
#8 2434095-7-add-country-constraint.patch5.56 KBmartin107
#6 2434095-6-add-country-constraint.patch5.56 KBbojanz
#2 2434095-2-add-country-constraint.patch4.77 KBbojanz
#1 2434095-1-add-country-constraint.patch4.83 KBbojanz
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

bojanz’s picture

bojanz CreditAttribution: bojanz commented
Status: Active » Needs review
FileSize
2434095-1-add-country-constraint.patch4.83 KB
bojanz’s picture

bojanz CreditAttribution: bojanz commented
FileSize
2434095-2-add-country-constraint.patch4.77 KB
dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented 
+++ b/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountryConstraintValidator.php
@@ -0,0 +1,64 @@
+    if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {
+      throw new UnexpectedTypeException($value, 'string');
+    }

Do we usually require such a strict policy in validators?

bojanz’s picture

bojanz CreditAttribution: bojanz commented

@dawehner
The validator code is very close to the Symfony class, so I just copied what they do.
In core I see that ComplexDataConstraintValidator throws the same exception, others don't.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented 
+++ b/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountryConstraintValidator.php
@@ -0,0 +1,64 @@
+
+    if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {
+      throw new UnexpectedTypeException($value, 'string');
+    }

Alright, well in case we have the code we should also cover it in the unit test :p

bojanz’s picture

bojanz CreditAttribution: bojanz commented
FileSize
2434095-6-add-country-constraint.patch5.56 KB

Here we go, improved and expanded test.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented
Status: Needs review » Reviewed & tested by the community

Thank you

martin107’s picture

martin107 CreditAttribution: martin107 commented
Status: Reviewed & tested by the community » Needs review
FileSize
2434095-7-add-country-constraint.patch5.56 KB
interdiff-6-7.txt938 bytes

Just brushing up a couple of nits.

bojanz’s picture

bojanz CreditAttribution: bojanz commented
FileSize
2434095-9-add-country-constraint.patch5.56 KB

Good catch martin107, I was too quick in my copy-paste.

The interdiff shows that CountryConstraintValidator needs a newline after {, so I've added it.

pcambra’s picture

pcambra
he/him
Primary language Spanish
Location Asturies
CreditAttribution: pcambra commented
Status: Needs review » Reviewed & tested by the community

Green, let's go back to RTBC

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Category: Bug report » Task
Status: Reviewed & tested by the community » Needs work

Is this really a bug?

I think this issue is a normal task so we need to outline how it fits within the allowable Drupal 8 beta criteria. Can someone add Drupal 8 beta phase evaluation template to the issue summary. Afaics a module which provides an entity could easily add this themselves.

bojanz’s picture

bojanz CreditAttribution: bojanz commented
Issue summary: View changes
Status: Needs work » Reviewed & tested by the community

You're right. I've added the beta phase evaluation, clarifying that this is a non-prioritized, non-disruptive normal task.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Assigned: Unassigned » alexpott

Back to Alex.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Needs review

@bojanz why do you think core should add this validator? We could add hundreds of potential validators. According to the beta policy we shouldn't be making this kind of change, yes there is no disruption but that on it's own is not enough to commit this.

bojanz’s picture

bojanz CreditAttribution: bojanz commented
Status: Needs review » Closed (won't fix)

Symfony provides both a country list (via symfony/intl which we aren't using) and a validator.
Drupal provides only the country list. The validator is missing.

Anyway, this can easily live in Address module, and we can revisit for next release.

martin107’s picture

martin107 CreditAttribution: martin107 commented
Version: 8.0.x-dev » 8.1.x-dev
Assigned: alexpott » Unassigned
Status: Closed (won't fix) » Postponed

This is something I would like to see implemented eventually.

Just kicking can/code down the road.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.