sozo-design/Magento2_CurrencyConversionExtended

View on GitHub

Showing 10 of 10 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private function getServiceResponse($url, $retry = 0)
    {
        /** @var \Magento\Framework\HTTP\ZendClient $httpClient */
        $httpClient = $this->httpClientFactory->create();
        $response = [];
Severity: Major
Found in Model/Currency/Import/FreeCurrencyConverterApi.php and 1 other location - About 2 hrs to fix
Model/Currency/Import/OpenRates.php on lines 132..157

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 140.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private function getServiceResponse($url, $retry = 0)
    {
        /** @var \Magento\Framework\HTTP\ZendClient $httpClient */
        $httpClient = $this->httpClientFactory->create();
        $response = [];
Severity: Major
Found in Model/Currency/Import/OpenRates.php and 1 other location - About 2 hrs to fix
Model/Currency/Import/FreeCurrencyConverterApi.php on lines 150..175

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 140.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Method testFetchRatesFail has 41 lines of code (exceeds 30 allowed). Consider refactoring.
Open

    public function testFetchRatesFail(): void
    {
        $currencyFromList = ['GBP'];
        $currencyToList = ['BTC'];
        $responseBody = '{"error":"Symbols \'BTC\' are invalid for date 2019-07-31."}';
Severity: Minor
Found in Test/Unit/Model/Currency/Import/OpenRatesTest.php - About 1 hr to fix

    Method testFetchRatesSuccess has 38 lines of code (exceeds 30 allowed). Consider refactoring.
    Open

        public function testFetchRatesSuccess(): void
        {
            $currencyFromList = ['USD'];
            $currencyToList = ['EUR', 'GBP'];
            $responseBody = '{"rates":{"EUR":0.8965393581,"GBP":0.8217052179},"base":"USD","date":"2019-07-30"}';
    Severity: Minor
    Found in Test/Unit/Model/Currency/Import/OpenRatesTest.php - About 1 hr to fix

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          public function fetchRates()
          {
              $data = [];
              $currencies = $this->_getCurrencyCodes();
              $defaultCurrencies = $this->_getDefaultCurrencyCodes();
      Severity: Minor
      Found in Model/Currency/Import/FreeCurrencyConverterApi.php and 1 other location - About 55 mins to fix
      Model/Currency/Import/OpenRates.php on lines 71..84

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 99.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          public function fetchRates()
          {
              $data = [];
              $currencies = $this->_getCurrencyCodes();
              $defaultCurrencies = $this->_getDefaultCurrencyCodes();
      Severity: Minor
      Found in Model/Currency/Import/OpenRates.php and 1 other location - About 55 mins to fix
      Model/Currency/Import/FreeCurrencyConverterApi.php on lines 83..96

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 99.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Function processResponse has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          protected function processResponse(&$data, $currencyFrom, $currencyTo, $url, $response)
          {
              if ($currencyFrom == $currencyTo) {
                  $data[$currencyFrom][$currencyTo] = $this->_numberFormat(1);
              } else {
      Severity: Minor
      Found in Model/Currency/Import/FreeCurrencyConverterApi.php - About 35 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function processResponse has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          private function processResponse(&$data, $currencyFrom, $currencyTo, $url, $response)
          {
              if ($currencyFrom == $currencyTo) {
                  $data[$currencyFrom][$currencyTo] = $this->_numberFormat(1);
              } else {
      Severity: Minor
      Found in Model/Currency/Import/OpenRates.php - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Define a constant instead of duplicating this literal "getBody" 4 times.
      Open

                  ->setMethods(['getBody'])

      Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

      On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

      Noncompliant Code Example

      With the default threshold of 3:

      function run() {
        prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
        execute('action1');
        release('action1');
      }
      

      Compliant Solution

      ACTION_1 = 'action1';
      
      function run() {
        prepare(ACTION_1);
        execute(ACTION_1);
        release(ACTION_1);
      }
      

      Exceptions

      To prevent generating some false-positives, literals having less than 5 characters are excluded.

      Define a constant instead of duplicating this literal "create" 6 times.
      Open

                  ->setMethods(['create'])

      Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

      On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

      Noncompliant Code Example

      With the default threshold of 3:

      function run() {
        prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
        execute('action1');
        release('action1');
      }
      

      Compliant Solution

      ACTION_1 = 'action1';
      
      function run() {
        prepare(ACTION_1);
        execute(ACTION_1);
        release(ACTION_1);
      }
      

      Exceptions

      To prevent generating some false-positives, literals having less than 5 characters are excluded.

      Severity
      Category
      Status
      Source
      Language