fix: localize attributes properly #2016

chosww · 2023-11-28T22:01:05Z

Resolves #2011.

Prerequisites

If this PR changes PHP code or dependencies:

I've run composer format and fixed any code formatting issues.
I've run composer analyze and addressed any static analysis issues.
I've run php artisan test and ensured that all tests pass.
I've run composer localize to update localization source files and committed any changes.

If this PR changes CSS or JavaScript code or dependencies:

I've run npm run lint and fixed any linting issues.
I've run npm run build and ensured that CSS and JavaScript assets can be compiled.

chosww · 2023-11-28T22:10:08Z

@jobara I think the meeting types error is the one like UpdateProjectRequest; the ones don't use :attribute explicitly. I didn't find any use cases of :attribute for meeting_types, could you tell me in which workflow you got that error message please?

codecov · 2023-11-28T22:44:34Z

Codecov Report

Attention: 14 lines in your changes are missing coverage. Please review.

Comparison is base (4d59c59) 97.65% compared to head (7bb3abf) 97.62%.

❗ Current head 7bb3abf differs from pull request most recent head 6dd8016. Consider uploading reports for the commit 6dd8016 to get more accurate results

Files	Patch %	Lines
app/Http/Requests/StoreDefinedTermRequest.php	0.00%	7 Missing ⚠️
app/Http/Requests/UpdateDefinedTermRequest.php	0.00%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##                dev    #2016      +/-   ##
============================================
- Coverage     97.65%   97.62%   -0.03%     
- Complexity     2055     2103      +48     
============================================
  Files           314      314              
  Lines          8991     9481     +490     
============================================
+ Hits           8780     9256     +476     
- Misses          211      225      +14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jobara · 2023-11-29T12:17:56Z

@jobara I think the meeting types error is the one like UpdateProjectRequest; the ones don't use :attribute explicitly. I didn't find any use cases of :attribute for meeting_types, could you tell me in which workflow you got that error message please?

I believe it's coming from the validation.required text. It's likely the case that a required meeting_types field is empty. An example would be from UpdateIndividualCommunicationAndConsultationPreferencesRequest validation.

My feeling at the moment is that any validated field should have a localized attribute name specified. This would prevent errors if we removed an overridden message, or didn't override one that became needed later (e.g. changed the validation rules).

into accessibility-exchangeGH-2011

jobara · 2023-11-30T15:24:44Z

Tests will be expanded with #1813

jobara · 2023-11-30T15:28:40Z

@chosww could you please run php artisan localize and commit the updates?

into accessibility-exchangeGH-2011

jobara

It looks like you missed doing AcceptInvitationRequest. It looks like the only attribute there is email.

jobara · 2023-11-30T18:19:44Z

app/Http/Requests/SaveOrganizationRolesRequest.php

+    public function attributes(): array
+    {
+        return [
+            'roles' => __('roles'),
+        ];
+    }


Suggested change

public function attributes(): array

{

return [

'roles' => __('roles'),

];

}

public function attributes(): array

{

return [

'roles' => __('roles'),

'roles.*' => __('roles'),

];

}

jobara · 2023-11-30T18:24:56Z

app/Http/Requests/SaveUserLanguagesRequest.php

+    public function attributes(): array
+    {
+        return [
+            'locale' => __('locale'),


Suggested change

'locale' => __('locale'),

'locale' => __('website language'),

jobara · 2023-11-30T18:26:03Z

app/Http/Requests/SaveIndividualRolesRequest.php

+    public function attributes(): array
+    {
+        return [
+            'roles' => __('You must select what you would like to do on the website.'),
+        ];
+    }


It looks like you copied the message here instead of adding the attribute value.

Suggested change

public function attributes(): array

{

return [

'roles' => __('You must select what you would like to do on the website.'),

];

}

public function attributes(): array

{

return [

'roles' => __('roles'),

'roles.*' => __('roles'),

];

}

jobara · 2023-11-30T18:27:45Z

app/Http/Requests/MeetingRequest.php

            'start_time' => __('meeting start time'),
            'end_time' => __('meeting end time'),
            'date' => __('meeting date'),
+            'directions' => __('directions'),
            'timezone' => __('meeting time zone'),
            'locality' => __('city or town'),
            'region' => __('province or territory'),
            'meeting_url' => __('link to join the meeting'),
            'meeting_phone' => __('phone number to join the meeting'),
+            'meeting_software' => __('meeting software'),
+            'alternative_meeting_software' => __('alternative meeting software'),
+            'additional_video_information' => __('additional video information'),
+            'additional_phone_information' => __('additional phone information'),
+            'meeting_types' => __('meeting types'),
+            'street_address' => __('Street address'),
+            'postal_code' => __('Postal code'),
+            'unit_suite_floor' => __('Unit, suite, or floor'),


Suggested change

'start_time' => __('meeting start time'),

'end_time' => __('meeting end time'),

'date' => __('meeting date'),

'directions' => __('directions'),

'timezone' => __('meeting time zone'),

'locality' => __('city or town'),

'region' => __('province or territory'),

'meeting_url' => __('link to join the meeting'),

'meeting_phone' => __('phone number to join the meeting'),

'meeting_software' => __('meeting software'),

'alternative_meeting_software' => __('alternative meeting software'),

'additional_video_information' => __('additional video information'),

'additional_phone_information' => __('additional phone information'),

'meeting_types' => __('meeting types'),

'street_address' => __('Street address'),

'postal_code' => __('Postal code'),

'unit_suite_floor' => __('Unit, suite, or floor'),

'title.en' => __('meeting title (English)'),

'title.fr' => __('meeting title (French)'),

'title.*' => __('meeting title'),

'start_time' => __('meeting start time'),

'end_time' => __('meeting end time'),

'date' => __('meeting date'),

'directions' => __('directions'),

'timezone' => __('meeting time zone'),

'locality' => __('city or town'),

'region' => __('province or territory'),

'meeting_url' => __('link to join the meeting'),

'meeting_phone' => __('phone number to join the meeting'),

'meeting_software' => __('meeting software'),

'alternative_meeting_software' => __('alternative meeting software'),

'additional_video_information' => __('additional video information'),

'additional_phone_information' => __('additional phone information'),

'meeting_types' => __('ways to attend'),

'meeting_types.*' => __('ways to attend'),

'street_address' => __('Street address'),

'postal_code' => __('Postal code'),

'unit_suite_floor' => __('Unit, suite, or floor'),

jobara · 2023-11-30T18:29:27Z

app/Http/Requests/StoreDefinedTermRequest.php

@@ -28,4 +28,12 @@ public function rules()
            'definition.*' => 'nullable|string',
        ];
    }
+
+    public function attributes(): array


I don't think this file is used anymore. I think we can delete it. Can you confirm?

It doesn't seems like it, though I think this may be used later? We should confirm with @greatislander

jobara · 2023-11-30T22:08:00Z

app/Http/Requests/UpdateRegulatedOrganizationRequest.php

+            'service_areas' => __('Service areas'),
+            'sectors' => __('Sectors'),


Suggested change

'service_areas' => __('Service areas'),

'sectors' => __('Sectors'),

'service_areas' => __('Service areas'),

'service_areas.*' => __('Service areas'),

'sectors' => __('type of Regulated Organization'),

app/Http/Requests/UpdateRegulatedOrganizationRequest.php

jobara · 2023-11-30T22:08:44Z

app/Http/Requests/UpdateRegulatedOrganizationRequest.php

            'about.fr' => __('"About your organization" (French)'),
            'about.en' => __('"About your organization" (English)'),
            'accessibility_and_inclusion_links.*.title' => __('accessibility and inclusion link title'),
            'accessibility_and_inclusion_links.*.url' => __('accessibility and inclusion link'),
-            'social_links.*.active_url' => __(''),
+            'social_links' => __('Social media links'),


Suggested change

'social_links' => __('Social media links'),

'social_links.*' => __('Social media links'),

jobara · 2023-11-30T22:09:08Z

app/Http/Requests/UpdateRegulatedOrganizationRequest.php

+            'contact_person_name' => __('Contact person'),
+            'contact_person_email' => __('Contact person’s email'),
+            'contact_person_phone' => __('Contact person’s phone number'),
+            'contact_person_vrs' => __('Contact person’s vrs'),


Suggested change

'contact_person_vrs' => __('Contact person’s vrs'),

'contact_person_vrs' => __('Contact person requires Video Relay Service (VRS) for phone calls'),

jobara · 2023-11-30T22:11:22Z

app/Http/Requests/UpdateWebsiteAccessibilityPreferencesRequest.php

+    public function attributes(): array
+    {
+        return [
+            'theme' => __('Theme'),


Suggested change

'theme' => __('Theme'),

'theme' => __('Contrast adjustment'),

jobara · 2023-12-04T14:02:27Z

It looks like you missed doing AcceptInvitationRequest. It looks like the only attribute there is email.

I think this one is still missing. It's being done through withValidator().

chosww · 2023-12-04T16:24:00Z

@jobara this PR is ready for another review, thanks!

into accessibility-exchangeGH-2011

jobara

@chosww could you also re-run composer localize?

app/Http/Requests/DestroyUserRequest.php

jobara · 2023-12-05T13:34:35Z

app/Http/Requests/AcceptInvitationRequest.php

+    public function attributes(): array
+    {
+        return [
+            'email' => __('email address'),


I notice in at least one other location that we've used __('email') instead. If it makes sense, can we make these consistent?

app/Http/Requests/StoreOrganizationRequest.php

jobara · 2023-12-05T13:37:41Z

app/Http/Requests/StoreOrganizationTypeRequest.php

+            'name.en' => __('organization name (English)'),
+            'name.fr' => __('organization name (French)'),


These don't appear to be required here. Perhaps they were added to the wrong file.

app/Http/Requests/UpdateAccessNeedsRequest.php

jobara · 2023-12-05T13:43:16Z

app/Http/Requests/UpdateDefinedTermRequest.php

+            'term' => __('term'),
+            'definition' => __('definition'),


Missing 'term.*' and 'definition.*'.

app/Http/Requests/UpdateNotificationPreferencesRequest.php

into accessibility-exchangeGH-2011

app/Http/Requests/DestroyUserRequest.php

app/Http/Requests/StoreEngagementLanguagesRequest.php

jobara

@chosww could you please run composer localize again. I think that's all that's left.

fix: localize attributes properly

613f789

chosww added the bug Something isn't working label Nov 28, 2023

chosww self-assigned this Nov 28, 2023

chosww added 2 commits November 28, 2023 17:17

fix: decapitalize localization message keys

7812dfc

fix: update error messages

9a8db06

chosww requested a review from jobara November 28, 2023 22:43

chosww added 5 commits November 29, 2023 12:04

fix: add attributes method to all requests

e67e5cc

fix: analyze issues

8d023c5

fix: update tests

501dc17

Merge branch 'dev' of https://github.com/accessibility-exchange/platform

389f03b

into accessibility-exchangeGH-2011

fix: update validation errors

c35464c

chosww added 3 commits November 30, 2023 10:47

fix: run localize

c7db448

Merge branch 'dev' of https://github.com/accessibility-exchange/platform

1bdee8a

into accessibility-exchangeGH-2011

fix: update based on PR feedback

08b6b78

jobara requested changes Nov 30, 2023

View reviewed changes

chosww added 4 commits December 1, 2023 14:58

fix: update based on PR feedback

e5f47a5

fix: analyze issue

46a82ed

fix: update validation errors

ec40713

fix: update validation errors

ebfe295

chosww requested a review from jobara December 1, 2023 21:14

jobara added this to the 1.2.4 milestone Dec 4, 2023

chosww added 3 commits December 4, 2023 09:53

fix: add email attribute to AcceptInvitationRequest

50e0363

fix: update attribute message

3d4c31c

fix: add update attributes for StoreDefinedTermRequest

2ceac1e

Merge branch 'dev' of https://github.com/accessibility-exchange/platform

4bd5052

into accessibility-exchangeGH-2011

jobara modified the milestones: 1.2.4, 1.2.5 Dec 4, 2023

jobara requested changes Dec 5, 2023

View reviewed changes

chosww added 2 commits December 5, 2023 09:34

fix: update based on PR feedback

eab5bab

Merge branch 'dev' of https://github.com/accessibility-exchange/platform

212be19

into accessibility-exchangeGH-2011

chosww requested a review from jobara December 5, 2023 14:45

jobara reviewed Dec 5, 2023

View reviewed changes

app/Http/Requests/DestroyUserRequest.php Outdated Show resolved Hide resolved

fix: update DestroyUserRequest attribute

7bb3abf

jobara requested changes Dec 5, 2023

View reviewed changes

app/Http/Requests/StoreEngagementLanguagesRequest.php Show resolved Hide resolved

fix: update attributes of StoreEngagementLanguagesRequest

ca830d5

chosww requested a review from jobara December 5, 2023 19:06

jobara requested changes Dec 6, 2023

View reviewed changes

fix: run composer localize

6dd8016

jobara enabled auto-merge (squash) December 6, 2023 14:04

jobara self-requested a review December 6, 2023 14:04

jobara approved these changes Dec 6, 2023

View reviewed changes

jobara merged commit fbd95be into accessibility-exchange:dev Dec 6, 2023
6 of 7 checks passed

github-actions bot mentioned this pull request Dec 6, 2023

chore(release): release 1.2.5 #2049

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: localize attributes properly #2016

fix: localize attributes properly #2016

chosww commented Nov 28, 2023 •

edited

Loading

chosww commented Nov 28, 2023

codecov bot commented Nov 28, 2023 •

edited

Loading

jobara commented Nov 29, 2023 •

edited

Loading

jobara commented Nov 30, 2023

jobara commented Nov 30, 2023

jobara left a comment

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

chosww Dec 1, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara Nov 30, 2023

jobara commented Dec 4, 2023

chosww commented Dec 4, 2023

jobara left a comment

jobara Dec 5, 2023

jobara Dec 5, 2023

jobara Dec 5, 2023

jobara left a comment

	'locale' => __('locale'),
	'locale' => __('website language'),

		'service_areas' => __('Service areas'),
		'sectors' => __('Sectors'),

	'social_links' => __('Social media links'),
	'social_links.*' => __('Social media links'),

	'contact_person_vrs' => __('Contact person’s vrs'),
	'contact_person_vrs' => __('Contact person requires Video Relay Service (VRS) for phone calls'),

	'theme' => __('Theme'),
	'theme' => __('Contrast adjustment'),

		'name.en' => __('organization name (English)'),
		'name.fr' => __('organization name (French)'),

fix: localize attributes properly #2016

fix: localize attributes properly #2016

Conversation

chosww commented Nov 28, 2023 • edited Loading

Prerequisites

chosww commented Nov 28, 2023

codecov bot commented Nov 28, 2023 • edited Loading

Codecov Report

jobara commented Nov 29, 2023 • edited Loading

jobara commented Nov 30, 2023

jobara commented Nov 30, 2023

jobara left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jobara commented Dec 4, 2023

chosww commented Dec 4, 2023

jobara left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jobara left a comment

Choose a reason for hiding this comment

chosww commented Nov 28, 2023 •

edited

Loading

codecov bot commented Nov 28, 2023 •

edited

Loading

jobara commented Nov 29, 2023 •

edited

Loading