Code optimization for the offline shipping methods.

atwixfirster commented 5 years ago

Summary (*)

Flat Rate, Free Shipping, and Store Pickup shipping methods use protected $_code variable to provide information about carrier's code.

For example, Flat Rate shipping method:

class Flatrate extends AbstractCarrier implements CarrierInterface
{
    /**
     * @var string
     */
    protected $_code = 'flatrate';

...

In the getAllowedMethods() function for this shipping method we have:

 * @return array
     */
    public function getAllowedMethods()
    {
        return ['flatrate' => $this->getConfigData('name')];
    }

So, carrier's code is duplicated.

Examples (*)

Proposed solution

Use $this->_code in the getAllowedMethods() function of Flat Rate, Free Shipping, and Store Pickup.

For example, a code optimization for Flat Rate will look like:

/**
     * @return array
     */
    public function getAllowedMethods()
    {
        return [$this->_code => $this->getConfigData('name')];
    }

m2-assistant[bot] commented 5 years ago

Hi @atwixfirster. Thank you for your report. To help us process this issue please make sure that you provided the following information:

[ ] Summary of the issue
[ ] Information on your environment
[ ] Steps to reproduce
[ ] Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

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

@atwixfirster do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

[ ] yes
[ ] no

Join Magento Community Engineering Slack and ask your questions in #github channel.

m2-assistant[bot] commented 5 years ago

Hi @atwixfirster. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
[ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.3-develop branch
Details
- Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Verify that the issue is reproducible on 2.2-develop branch.
Details
- Add the comment @magento give me 2.2-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

Join Magento Community Engineering Slack and ask your questions in #github channel.

orlangur commented 5 years ago

@atwixfirster such improvements may be proposed directly as pull requests without even reporting an issue ;) Issues are mostly useful when we deal with a bug and need to verify it against all release lines.

atwixfirster commented 5 years ago

@atwixfirster such improvements may be proposed directly as pull requests without even reporting an issue ;) Issues are mostly useful when we deal with a bug and need to verify it against all release lines.

Thanks for the flow explanation, @orlangur ! I will use it in my future PRs.

👍

magento-engcom-team commented 5 years ago

Hi @atwixfirster. Thank you for your report. The issue has been fixed in magento/magento2#23144 by @atwixfirster in 2.3-develop branch Related commit(s):

The fix will be available with the upcoming 2.3.4 release.

magento / magento2