Talesoft/tale-stream

View on GitHub

Showing 5 of 5 total issues

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

    public function write($string): int
    {
        if (!is_string($string)) {
            throw new InvalidArgumentException(sprintf(
                'Argument 1 passed to %s->write needs to be string, %s given',
Severity: Major
Found in src/Stream.php and 1 other location - About 3 hrs to fix
src/Stream.php on lines 313..338

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

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 function read($length): string
    {
        if (!is_int($length)) {
            throw new InvalidArgumentException(sprintf(
                'Argument 1 passed to %s->read needs to be int, %s given',
Severity: Major
Found in src/Stream.php and 1 other location - About 3 hrs to fix
src/Stream.php on lines 269..294

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

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

Stream has 26 functions (exceeds 20 allowed). Consider refactoring.
Open

final class Stream implements StreamInterface
{
    /**
     * Tells ->seek() to move from the start of the stream.
     */
Severity: Minor
Found in src/Stream.php - About 3 hrs to fix

    File Stream.php has 291 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php declare(strict_types=1);
    
    namespace Tale;
    
    use InvalidArgumentException;
    Severity: Minor
    Found in src/Stream.php - About 3 hrs to fix

      Function getIterator has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getIterator(): Generator
          {
              $line = '';
              foreach ($this->readIterator as $content) {
                  $parts = explode($this->delimiter, $content);
      Severity: Minor
      Found in src/Stream/Iterator/SplitIterator.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

      Severity
      Category
      Status
      Source
      Language