alanwillms/php-hound

View on GitHub

Showing 17 of 17 total issues

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

    protected function addIssuesFromXml(Reader $xml)
    {
        $xmlArray = $xml->parse();

        foreach ((array) $xmlArray['value'] as $fileTag) {
Severity: Major
Found in src/integration/PHPCodeSniffer.php and 1 other location - About 3 hrs to fix
src/integration/PHPMessDetector.php on lines 47..67

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

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

    protected function addIssuesFromXml(Reader $xml)
    {
        $xmlArray = $xml->parse();

        foreach ((array) $xmlArray['value'] as $fileTag) {
Severity: Major
Found in src/integration/PHPMessDetector.php and 1 other location - About 3 hrs to fix
src/integration/PHPCodeSniffer.php on lines 46..66

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

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

    protected function getTouchedFilesAndLines()
    {
        $resultFilter = [];
        foreach ($this->getDiffsWithAddedCode() as $fileDiff) {
            $file = $this->root . DIRECTORY_SEPARATOR . substr($fileDiff->getTo(), 2);
Severity: Minor
Found in src/output/filter/DiffOutputFilter.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 append has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function append(AnalysisResult $result)
    {
        $data = $this->getData();

        $data['executions'][] = date('M d H:i');
Severity: Minor
Found in src/output/html/History.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 filter has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function filter($data)
    {
        $filteredData = [];

        foreach ($this->getTouchedFilesAndLines() as $fileName => $lines) {
Severity: Minor
Found in src/output/filter/DiffOutputFilter.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 getArguments has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function getArguments()
    {
        return [
            'help' => [
                'prefix' => 'h',
Severity: Minor
Found in src/Command.php - About 1 hr to fix

    Function getDiffsWithAddedCode has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function getDiffsWithAddedCode()
        {
            $diffs = [];
            foreach ($this->diffs as $fileDiff) {
                foreach ($fileDiff->getChunks() as $chunkDiff) {
    Severity: Minor
    Found in src/output/filter/DiffOutputFilter.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 addIssuesFromXml has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function addIssuesFromXml(Reader $xml)
        {
            $xmlArray = $xml->parse();
    
            foreach ((array) $xmlArray['value'] as $duplicationTag) {
    Severity: Minor
    Found in src/integration/PHPCopyPasteDetector.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 getSabreXmlArrayFor has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function getSabreXmlArrayFor(AnalysisResult $result)
        {
            $sabreXmlArray = [
                'phphound' => [],
            ];
    Severity: Minor
    Found in src/output/XmlOutput.php - About 1 hr to fix

      Function result has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function result(AnalysisResult $result)
          {
              foreach ($result->toArray() as $fileName => $lines) {
                  $this->cli->br();
      
      
      Severity: Minor
      Found in src/output/TextOutput.php - About 45 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 trigger has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function trigger($eventType, $message = null)
          {
              switch ($eventType) {
                  case Analyser::EVENT_STARTING_ANALYSIS:
                      $this->cli->green('Starting analysis');
      Severity: Minor
      Found in src/output/TextTriggerTrait.php - About 45 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

      Method addIssue has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          public function addIssue($fileName, $line, $toolName, $issueType, $message)
      Severity: Minor
      Found in src/AnalysisResult.php - About 35 mins to fix

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

            public function mergeWith(AnalysisResult $other)
            {
                foreach ($other->toArray() as $fileName => $lines) {
                    foreach ($lines as $line => $issues) {
                        foreach ($issues as $issue) {
        Severity: Minor
        Found in src/AnalysisResult.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

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

            protected function addIssuesFromXml(Reader $xml)
            {
                $xmlArray = $xml->parse();
        
                foreach ((array) $xmlArray['value'] as $fileTag) {
        Severity: Minor
        Found in src/integration/PHPCodeSniffer.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

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

            protected function getSabreXmlArrayFor(AnalysisResult $result)
            {
                $sabreXmlArray = [
                    'phphound' => [],
                ];
        Severity: Minor
        Found in src/output/XmlOutput.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

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

            protected function addIssuesFromXml(Reader $xml)
            {
                $xmlArray = $xml->parse();
        
                foreach ((array) $xmlArray['value'] as $fileTag) {
        Severity: Minor
        Found in src/integration/PHPMessDetector.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

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

            public function result(AnalysisResult $result)
            {
                $writer = Writer::createFromString('');
                $writer->insertOne(['File', 'Line', 'Tool', 'Type', 'Message']);
        
        
        Severity: Minor
        Found in src/output/CsvOutput.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

        Severity
        Category
        Status
        Source
        Language