gabrielbull/php-ups-api

View on GitHub
src/AddressValidation.php

Summary

Maintainability
C
1 day
Test Coverage

Function createRequest has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    private function createRequest()
    {
        $xml = new DOMDocument();
        $xml->formatOutput = true;

Severity: Minor
Found in src/AddressValidation.php - About 2 hrs 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

Method createRequest has 48 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function createRequest()
    {
        $xml = new DOMDocument();
        $xml->formatOutput = true;

Severity: Minor
Found in src/AddressValidation.php - About 1 hr to fix

    Method validate has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function validate(Address $address, $requestOption = self::REQUEST_OPTION_ADDRESS_VALIDATION, $maxSuggestion = 15)
        {
            if ($maxSuggestion > 50) {
                throw new \Exception('Maximum of 50 suggestions allowed');
            }
    Severity: Minor
    Found in src/AddressValidation.php - About 1 hr to fix

      Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

              $accessKey = null,
              $userId = null,
              $password = null,
              $useIntegration = false,
              RequestInterface $request = null,
      Severity: Minor
      Found in src/AddressValidation.php - About 45 mins to fix

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

            public function validate(Address $address, $requestOption = self::REQUEST_OPTION_ADDRESS_VALIDATION, $maxSuggestion = 15)
            {
                if ($maxSuggestion > 50) {
                    throw new \Exception('Maximum of 50 suggestions allowed');
                }
        Severity: Minor
        Found in src/AddressValidation.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

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

            public function __construct(
                $accessKey = null,
                $userId = null,
                $password = null,
                $useIntegration = false,
        Severity: Major
        Found in src/AddressValidation.php and 7 other locations - About 1 hr to fix
        src/Locator.php on lines 40..46
        src/QuantumView.php on lines 62..68
        src/Shipping.php on lines 54..60
        src/SimpleAddressValidation.php on lines 45..57
        src/TimeInTransit.php on lines 31..37
        src/Tracking.php on lines 80..86
        src/Tradeability.php on lines 49..61

        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 107.

        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

        There are no issues that match your filters.

        Category
        Status