Improving the code readability by importing the classes #33168

tiagosampaio · 2021-06-07T18:13:12Z

Description (*)

Improving the code readability by importing the classes.

Related Pull Requests

Fixed Issues (if relevant)

No issue is fixed with this PR.

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

m2-assistant · 2021-06-07T18:13:14Z

Hi @tiagosampaio. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

tiagosampaio · 2021-06-10T13:45:57Z

@magento run all tests

magento-automated-testing · 2021-06-10T13:46:04Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

tiagosampaio · 2021-07-16T15:17:07Z

@magento run all

magento-automated-testing · 2021-07-16T15:17:10Z

Failed to run the builds. Please try to re-run them later.

tiagosampaio · 2021-07-16T15:17:23Z

@magento run all tests

magento-automated-testing · 2021-07-16T15:17:28Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2023-03-14T21:38:39Z

Pull Requests are not mergeable to the mainline. Please merge the latest mainlines to your Pull Requests and restart the builds.

engcom-Delta · 2024-01-05T15:03:19Z

@tiagosampaio , Please resolve the conflict on the PR to move ahead on this.

engcom-November · 2024-07-01T10:39:05Z

@magento run all tests

engcom-November · 2024-07-03T11:13:16Z

@magento run Functional Tests B2B

hostep · 2024-07-03T12:10:25Z

Honestly, I find that this doesn't improve readability at all, like when you see ManagerInterface, what does it mean?

I think proper aliases should be used if the claim is to improve readability, for example:

use Magento\Framework\Event\ManagerInterface as EventManagerInterface;

And next to ManagerInterface, I think that these ones are too generic and also could use a proper alias:

Element
Field
Group
Loader
Structure

(I maybe have missed some, naming things is hard, I know)

engcom-November · 2024-07-05T07:24:33Z

Thank you @hostep for the input.

I have made the changes as you suggested.
Moving this to Pending review, to make sure everything is good before moving further with the pr.

engcom-November · 2024-10-15T07:21:55Z

@magento run all tests

engcom-November · 2024-10-15T10:52:31Z

As the PR is to improve code quality, manual testing is not applicable.

Since the builds are failed moving this to Extended testing.

engcom-November · 2024-10-15T14:09:47Z

@magento run all tests

fredden · 2024-10-15T15:06:52Z

app/code/Magento/Config/Model/Config.php

     * @param string $fieldId Need for support of clone_field feature
     * @param array $oldConfig Need for compatibility with _processGroup()
     * @param array $extraOldGroups Need for compatibility with _processGroup()
     * @return string
     */
-    private function getFieldPath(Field $field, string $fieldId, array &$oldConfig, array &$extraOldGroups): string
+    private function getFieldPath(FieldElement $field, string $fieldId, array &$oldConfig, array &$extraOldGroups): string // phpcs:ignore Generic.Files.LineLength


Let's not ignore the coding standards.

Suggested change

private function getFieldPath(FieldElement $field, string $fieldId, array &$oldConfig, array &$extraOldGroups): string // phpcs:ignore Generic.Files.LineLength

private function getFieldPath(

FieldElement $field,

string $fieldId,

array &$oldConfig,

array &$extraOldGroups

): string

Have made changes as you suggested.

…ento2 into 2.4-develop-001

engcom-November · 2024-10-16T08:18:55Z

@magento run all tests

engcom-November · 2024-10-16T11:50:36Z

Since there is a SVC failure, we have raised a internal approval jira.
Till we get the approval on the same moving this to Pending approval.

Improving the code readability by importing the classes.

2f35f52

magento-engcom-team added Component: Config Release Line: 2.4 labels Jun 7, 2021

tiagosampaio changed the title ~~Improving the code readability by importing the classes.~~ Improving the code readability by importing the classes Jun 7, 2021

m2-community-project bot added the Progress: pending review label Jun 7, 2021

Merge branch '2.4-develop' into 2.4-develop-001

e292593

gabrieldagama added the Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. label Jun 10, 2021

tiagosampaio added 2 commits June 11, 2021 18:05

Merge branch '2.4-develop' into 2.4-develop-001

62e9025

Merge branch '2.4-develop' into 2.4-develop-001

99322f5

Merge branch '2.4-develop' into 2.4-develop-001

6e42207

fredden approved these changes Mar 14, 2023

View reviewed changes

m2-community-project bot assigned fredden Mar 14, 2023

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Mar 14, 2023

engcom-Delta added the Progress: on hold label Jan 5, 2024

m2-community-project bot removed the Progress: ready for testing label Jan 5, 2024

engcom-November self-assigned this Jul 1, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: on hold labels Jul 1, 2024

resolved merge conflicts

d3d842c

m2-community-project bot added Progress: needs update and removed Progress: extended testing labels Jul 4, 2024

added aliases to generic class names

a63c5d8

engcom-November requested a review from fredden July 5, 2024 07:24

m2-community-project bot added Progress: pending review and removed Progress: needs update labels Jul 5, 2024

fredden approved these changes Jul 16, 2024

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Jul 16, 2024

Merge branch '2.4-develop' into 2.4-develop-001

7579c4f

engcom-November added Progress: extended testing and removed Progress: ready for testing labels Oct 15, 2024

engcom-November and others added 2 commits October 15, 2024 19:38

fix static test

215e1d4

Merge branch '2.4-develop' into 2.4-develop-001

0e1527c

fredden reviewed Oct 15, 2024

View reviewed changes

m2-community-project bot added Progress: review and removed Progress: extended testing labels Oct 15, 2024

engcom-November and others added 3 commits October 16, 2024 13:41

fix static tests while adhering to coding standard

44a0f18

Merge branch '2.4-develop-001' of https://github.com/tiagosampaio/mag…

893d3cb

…ento2 into 2.4-develop-001

Merge branch '2.4-develop' into 2.4-develop-001

967d31d

engcom-November added Progress: pending approval and removed Progress: review labels Oct 16, 2024

Improving the code readability by importing the classes #33168

Are you sure you want to change the base?

Improving the code readability by importing the classes #33168

Uh oh!

Conversation

tiagosampaio commented Jun 7, 2021

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Jun 7, 2021

Uh oh!

tiagosampaio commented Jun 10, 2021

Uh oh!

magento-automated-testing bot commented Jun 10, 2021

Uh oh!

tiagosampaio commented Jul 16, 2021

Uh oh!

magento-automated-testing bot commented Jul 16, 2021

Uh oh!

tiagosampaio commented Jul 16, 2021

Uh oh!

magento-automated-testing bot commented Jul 16, 2021

Uh oh!

magento-automated-testing bot commented Mar 14, 2023

Uh oh!

engcom-Delta commented Jan 5, 2024

Uh oh!

engcom-November commented Jul 1, 2024

Uh oh!

engcom-November commented Jul 3, 2024

Uh oh!

hostep commented Jul 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-November commented Jul 5, 2024

Uh oh!

engcom-November commented Oct 15, 2024

Uh oh!

engcom-November commented Oct 15, 2024

Uh oh!

engcom-November commented Oct 15, 2024

Uh oh!

fredden Oct 15, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-November Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-November commented Oct 16, 2024

Uh oh!

engcom-November commented Oct 16, 2024

Uh oh!

Uh oh!

hostep commented Jul 3, 2024 •

edited

Loading