robotomize/fujes

View on GitHub

Showing 145 of 145 total issues

Avoid excessively long variable names like $directMatchCoefficient. Keep variable name length under 20.
Open

    public static function setDirectMatchCoefficient($directMatchCoefficient)

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $moreRelevantJsonTreesOnArray. Keep variable name length under 20.
Open

    private $moreRelevantJsonTreesOnArray = [];
Severity: Minor
Found in src/robotomize/Fujes/SearchEngine.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $directMatchCoefficient. Keep variable name length under 20.
Open

    public static function setDirectMatchCoefficient($directMatchCoefficient)

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $testMatchStringAnother. Keep variable name length under 20.
Open

    private static $testMatchStringAnother = ['aeroflot', 'kaskoflot', 's7', 'sseven'];
Severity: Minor
Found in tests/FactoryTest.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $multipleResultDefault. Keep variable name length under 20.
Open

    private static $multipleResultDefault = false;
Severity: Minor
Found in src/robotomize/Fujes/SearchEngine.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $moreJsonTreesOnString. Keep variable name length under 20.
Open

    private $moreJsonTreesOnString = '';
Severity: Minor
Found in src/robotomize/Fujes/SearchEngine.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

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

    private function isJsonTest($string)
    {
        $string = substr($string, 0, 255);
        if (json_last_error() == JSON_ERROR_NONE) {
            if (substr($string, 0, 1) === '[') {
Severity: Major
Found in tests/SearchEngineTest.php and 1 other location - About 1 hr to fix
src/robotomize/Utils/Json.php on lines 43..56

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

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

    public static function isJsonTest($string)
    {
        $string = substr($string, 0, 255);
        if (json_last_error() == JSON_ERROR_NONE) {
            if (substr($string, 0, 1) === '[') {
Severity: Major
Found in src/robotomize/Utils/Json.php and 1 other location - About 1 hr to fix
tests/SearchEngineTest.php on lines 62..75

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

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

    public function preSearch($inputArray = [], $key = '', $level = 0)
    {
        if (0 === count($inputArray)) {
            $inputArray = $this->inputArray;
        }
Severity: Minor
Found in src/robotomize/Fujes/SearchSubstringCompare.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

Function preSearch has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function preSearch($inputArray = [], $key = '', $level = 0)
    {
        if (0 === count($inputArray)) {
            $inputArray = $this->inputArray;
        }
Severity: Minor
Found in src/robotomize/Fujes/SearchLevenshteinCompare.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

The class SearchEngine has 26 fields. Consider redesigning SearchEngine to keep the number of fields under 15.
Open

class SearchEngine
{
    /**
     * @var string
     */
Severity: Minor
Found in src/robotomize/Fujes/SearchEngine.php by phpmd

TooManyFields

Since: 0.1

Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

Example

class Person {
   protected $one;
   private $two;
   private $three;
   [... many more fields ...]
}

Source https://phpmd.org/rules/codesize.html#toomanyfields

Function search has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function search($inputArray = [], $key = '', $level = 0)
    {
        if (0 === count($inputArray)) {
            $inputArray = $this->inputArray;
        }
Severity: Minor
Found in src/robotomize/Fujes/SearchSubstringCompare.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

Function substringIterator has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    private function substringIterator($currentString)
    {
        $currentIterationCount = 0;
        $currentMaxStackValue = 0;

Severity: Minor
Found in src/robotomize/Fujes/SearchSubstringCompare.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

Method run has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function run()
    {
        $this->parseJsonToArray();
        if (0 === count($this->jsonTree)) {
            $this->exceptionObject->create('The data is not in JSON format');
Severity: Minor
Found in src/robotomize/Fujes/SearchEngine.php - About 1 hr to fix

    Method __construct has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function __construct(
            $urlName,
            $matchString,
            $depth = 1,
            $jsonEncode = true,
    Severity: Minor
    Found in src/robotomize/Fujes/SearchEngine.php - About 1 hr to fix

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

          public function compareStart($current, $key)
          {
              $compare = levenshtein(strtolower(trim($current)), $this->matchString);
              if (strtolower($current) === $this->matchString || $compare <= $this->precision) {
                  $this->directMatch[] = [$key, $current, $compare];
      Severity: Major
      Found in src/robotomize/Fujes/SearchSubstringCompare.php and 1 other location - About 1 hr to fix
      src/robotomize/Fujes/SearchLevenshteinCompare.php on lines 195..204

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

      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 compareStart($current, $key)
          {
              $compare = levenshtein(strtolower(trim($current)), $this->matchString);
              if (strtolower($current) === $this->matchString || $compare <= $this->precision) {
                  $this->directMatch[] = [$key, $current, $compare];
      Severity: Major
      Found in src/robotomize/Fujes/SearchLevenshteinCompare.php and 1 other location - About 1 hr to fix
      src/robotomize/Fujes/SearchSubstringCompare.php on lines 153..162

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

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

          public function run()
          {
              $this->parseJsonToArray();
              if (0 === count($this->jsonTree)) {
                  $this->exceptionObject->create('The data is not in JSON format');
      Severity: Minor
      Found in src/robotomize/Fujes/SearchEngine.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

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

              $urlName,
              $matchString,
              $depth = 1,
              $jsonEncode = true,
              $multipleResult = false,
      Severity: Major
      Found in src/robotomize/Fujes/SearchFacade.php - About 50 mins to fix

        Method find has 7 arguments (exceeds 4 allowed). Consider refactoring.
        Open

                $urlName,
                $matchString,
                $depth = 1,
                $jsonEncode = true,
                $multipleResult = false,
        Severity: Major
        Found in src/robotomize/Fujes/SearchFactory.php - About 50 mins to fix
          Severity
          Category
          Status
          Source
          Language