creof/wkb-parser

View on GitHub

Showing 33 of 33 total issues

File Parser.php has 435 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Copyright (C) 2016 Derek J. Lambert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
Severity: Minor
Found in lib/CrEOF/Geo/WKB/Parser.php - About 6 hrs to fix

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

        private function multiCurve()
        {
            $values = array();
            $count  = $this->readCount();
    
    
    Severity: Major
    Found in lib/CrEOF/Geo/WKB/Parser.php and 1 other location - About 5 hrs to fix
    lib/CrEOF/Geo/WKB/Parser.php on lines 572..602

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

    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 curvePolygon()
        {
            $values = array();
            $count  = $this->readCount();
    
    
    Severity: Major
    Found in lib/CrEOF/Geo/WKB/Parser.php and 1 other location - About 5 hrs to fix
    lib/CrEOF/Geo/WKB/Parser.php on lines 610..640

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

    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

    Parser has 30 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Parser
    {
        const WKB_TYPE_GEOMETRY           = 0;
        const WKB_TYPE_POINT              = 1;
        const WKB_TYPE_LINESTRING         = 2;
    Severity: Minor
    Found in lib/CrEOF/Geo/WKB/Parser.php - About 3 hrs to fix

      The class Parser has an overall complexity of 89 which is very high. The configured complexity threshold is 50.
      Open

      class Parser
      {
          const WKB_TYPE_GEOMETRY           = 0;
          const WKB_TYPE_POINT              = 1;
          const WKB_TYPE_LINESTRING         = 2;
      Severity: Minor
      Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

      Method getTypeName has 44 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function getTypeName($type)
          {
              switch ($this->getTypePrimitive($type)) {
                  case (self::WKB_TYPE_POINT):
                      $typeName = self::TYPE_POINT;
      Severity: Minor
      Found in lib/CrEOF/Geo/WKB/Parser.php - About 1 hr to fix

        Function getTypeName has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

            private function getTypeName($type)
            {
                switch ($this->getTypePrimitive($type)) {
                    case (self::WKB_TYPE_POINT):
                        $typeName = self::TYPE_POINT;
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php - About 1 hr 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

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

                for ($i = 0; $i < $count; $i++) {
                    $this->readByteOrder();
        
                    $type = $this->readType();
        
        
        Severity: Major
        Found in lib/CrEOF/Geo/WKB/Parser.php and 1 other location - About 1 hr to fix
        lib/CrEOF/Geo/WKB/Parser.php on lines 516..526

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

        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

                for ($i = 0; $i < $count; $i++) {
                    $this->readByteOrder();
        
                    $type = $this->readType();
        
        
        Severity: Major
        Found in lib/CrEOF/Geo/WKB/Parser.php and 1 other location - About 1 hr to fix
        lib/CrEOF/Geo/WKB/Parser.php on lines 490..500

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

        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 getBadTypeInTypeMessage has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            private function getBadTypeInTypeMessage($childType, $parentType, array $expectedTypes)
            {
                if ($this->type !== $parentType) {
                    $parentType = $this->type;
                }
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.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

        Avoid unused private methods such as 'multiPoint'.
        Open

            private function multiPoint()
            {
                $values = array();
                $count  = $this->readCount();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Avoid unused private methods such as 'polyhedralSurface'.
        Open

            private function polyhedralSurface()
            {
                $values = array();
                $count  = $this->readCount();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        The method getBadTypeInTypeMessage uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        Open

                } else {
                    $message = 'Bad' . $message;
                }
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        ElseExpression

        Since: 1.4.0

        An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

        Example

        class Foo
        {
            public function bar($flag)
            {
                if ($flag) {
                    // one branch
                } else {
                    // another branch
                }
            }
        }

        Source https://phpmd.org/rules/cleancode.html#elseexpression

        Avoid unused private methods such as 'circularString'.
        Open

            private function circularString()
            {
                return $this->readPoints($this->readCount());
            }
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Avoid unused private methods such as 'multiPolygon'.
        Open

            private function multiPolygon()
            {
                $count  = $this->readCount();
                $values = array();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Avoid unused private methods such as 'multiCurve'.
        Open

            private function multiCurve()
            {
                $values = array();
                $count  = $this->readCount();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Avoid unused private methods such as 'geometryCollection'.
        Open

            private function geometryCollection()
            {
                $values = array();
                $count  = $this->readCount();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        The 'getMachineByteOrder()' method which returns a boolean should be named 'is...()' or 'has...()'
        Open

            private function getMachineByteOrder()
            {
                if (null === self::$machineByteOrder) {
                    $result = unpack('S', "\x01\x00");
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Reader.php by phpmd

        BooleanGetMethodName

        Since: 0.2

        Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.

        Example

        class Foo {
            /**
             * @return boolean
             */
            public function getFoo() {} // bad
            /**
             * @return bool
             */
            public function isFoo(); // ok
            /**
             * @return boolean
             */
            public function getFoo($bar); // ok, unless checkParameterizedMethods=true
        }

        Source https://phpmd.org/rules/naming.html#booleangetmethodname

        Avoid unused private methods such as 'multiSurface'.
        Open

            private function multiSurface()
            {
                $values = array();
                $count  = $this->readCount();
        
        
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Avoid unused private methods such as 'lineString'.
        Open

            private function lineString()
            {
                return $this->readPoints($this->readCount());
            }
        Severity: Minor
        Found in lib/CrEOF/Geo/WKB/Parser.php by phpmd

        UnusedPrivateMethod

        Since: 0.2

        Unused Private Method detects when a private method is declared but is unused.

        Example

        class Something
        {
            private function foo() {} // unused
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedprivatemethod

        Severity
        Category
        Status
        Source
        Language