Sign upLogin

kylekatarnls/business-time

View on GitHub
Star

Showing 227 of 228 total issues

Function parseMethodDoc has a Cognitive Complexity of 46 (exceeds 5 allowed). Consider refactoring.
Open

    private function parseMethodDoc(
        string $name,
        int $length,
        string $className,
        string $defaultClass,
Severity: Minor
Found in types.php - About 7 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

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

<?php

namespace BusinessTime\Traits;

trait ClosedOr
Severity: Major
Found in src/BusinessTime/Traits/ClosedOr.php and 1 other location - About 2 hrs to fix
src/BusinessTime/Traits/OpenOr.php on lines 1..124

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

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

<?php

namespace BusinessTime\Traits;

trait OpenOr
Severity: Major
Found in src/BusinessTime/Traits/OpenOr.php and 1 other location - About 2 hrs to fix
src/BusinessTime/Traits/ClosedOr.php on lines 1..124

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

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

Method getScheduleDoc has 66 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getScheduleDoc($defaultClass, $source, $boot)
    {
        $methods = [];
        $source = str_replace('\\', '/', realpath($source));
        $sourceLength = strlen($source);
Severity: Major
Found in types.php - About 2 hrs to fix

    Function getScheduleDoc has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getScheduleDoc($defaultClass, $source, $boot)
    {
        $methods = [];
        $source = str_replace('\\', '/', realpath($source));
        $sourceLength = strlen($source);
    Severity: Minor
    Found in types.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

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

            $businessDaySourceLength = strlen($businessDaySource);
    Severity: Minor
    Found in types.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 $bindMacroContextMethod. Keep variable name length under 20.
    Open

            $bindMacroContextMethod = $this->calculateBindMacroContext($class);
    Severity: Minor
    Found in src/BusinessTime/Schedule.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 $bindMacroContextMethod. Keep variable name length under 20.
    Open

            $bindMacroContextMethod = new ReflectionMethod($class, 'bindMacroContext');
    Severity: Minor
    Found in src/BusinessTime/Schedule.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

    Method parseMethodDoc has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function parseMethodDoc(
        string $name,
        int $length,
        string $className,
        string $defaultClass,
    Severity: Minor
    Found in types.php - About 1 hr to fix

      Method enable has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function enable($carbonClass = null, $defaultOpeningHours = null)
    {
        if ($carbonClass === null) {
            return static function () {
                return true;
      Severity: Minor
      Found in src/BusinessTime/MixinBase.php - About 1 hr to fix

        Avoid using undefined variables such as '$files' which will lead to PHP notices.
        Open

                    $lines = $files[$file];
        Severity: Minor
        Found in types.php by phpmd

        UndefinedVariable

        Since: 2.8.0

        Detects when a variable is used that has not been defined before.

        Example

        class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

        Avoid using undefined variables such as '$files' which will lead to PHP notices.
        Open

                    $methodDocBlock = $this->parseMethodDoc($name, $length, $className, $defaultClass, $code, $files)
        Severity: Minor
        Found in types.php by phpmd

        UndefinedVariable

        Since: 2.8.0

        Detects when a variable is used that has not been defined before.

        Example

        class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

        Avoid using undefined variables such as '$files' which will lead to PHP notices.
        Open

                        $files[$file] = file($file);
        Severity: Minor
        Found in types.php by phpmd

        UndefinedVariable

        Since: 2.8.0

        Detects when a variable is used that has not been defined before.

        Example

        class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

        Avoid using undefined variables such as '$files' which will lead to PHP notices.
        Open

                    if (!isset($files[$file])) {
        Severity: Minor
        Found in types.php by phpmd

        UndefinedVariable

        Since: 2.8.0

        Detects when a variable is used that has not been defined before.

        Example

        class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

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

            public static function create(array $openingHours): self
    {
        $businessTime = new self();
        $parser = new DefinitionParser($businessTime, $openingHours, function ($date) use ($businessTime) {
            if ($date instanceof CarbonInterface) {
        Severity: Minor
        Found in src/BusinessTime/BusinessTimeWrapper.php - About 1 hr to fix

          Consider simplifying this complex logical expression.
          Open

                              if ((
                        (!$mode || $mode === $mixin::LOCAL_MODE) &&
                        ($date = end(static::$macroContextStack)) &&
                        ($hours = $mixin->getOpeningHours($mixin::LOCAL_MODE, $date))
                    ) ||
          Severity: Major
          Found in src/BusinessTime/MixinBase.php - About 1 hr to fix

            Each class must be in a namespace of at least one level (a top-level vendor name)
            Open

            final class TypeGenerator extends \Types\Generator
            Severity: Minor
            Found in types.php by phpcodesniffer

            Function enable has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                public static function enable($carbonClass = null, $defaultOpeningHours = null)
    {
        if ($carbonClass === null) {
            return static function () {
                return true;
            Severity: Minor
            Found in src/BusinessTime/MixinBase.php - About 55 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 create has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                public static function create(array $openingHours): self
    {
        $businessTime = new self();
        $parser = new DefinitionParser($businessTime, $openingHours, function ($date) use ($businessTime) {
            if ($date instanceof CarbonInterface) {
            Severity: Minor
            Found in src/BusinessTime/BusinessTimeWrapper.php - About 55 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

            A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 9 and the first side effect is on line 6.
            Open

            <?php
            Severity: Minor
            Found in types.php by phpcodesniffer
            Severity
            Category
            Status
            Source
            Language