fisharebest/webtrees

View on GitHub
app/Date/AbstractCalendarDate.php

Summary

Maintainability
F
3 days
Test Coverage

File AbstractCalendarDate.php has 474 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
Severity: Minor
Found in app/Date/AbstractCalendarDate.php - About 7 hrs to fix

    AbstractCalendarDate has 46 functions (exceeds 20 allowed). Consider refactoring.
    Open

    abstract class AbstractCalendarDate
    {
        // GEDCOM calendar escape
        public const ESCAPE = '@#DUNKNOWN@';
    
    
    Severity: Minor
    Found in app/Date/AbstractCalendarDate.php - About 6 hrs to fix

      Function format has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
      Open

          public function format(string $format, string $qualifier = ''): string
          {
              // Dates can include additional punctuation and symbols. e.g.
              // %F %j, %Y
              // %Y. %F %d.
      Severity: Minor
      Found in app/Date/AbstractCalendarDate.php - About 4 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

      Method format has 94 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function format(string $format, string $qualifier = ''): string
          {
              // Dates can include additional punctuation and symbols. e.g.
              // %F %j, %Y
              // %Y. %F %d.
      Severity: Major
      Found in app/Date/AbstractCalendarDate.php - About 3 hrs to fix

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

            public function __construct(array|int|AbstractCalendarDate $date)
            {
                // Construct from an integer (a julian day number)
                if (is_int($date)) {
                    $this->minimum_julian_day = $date;
        Severity: Minor
        Found in app/Date/AbstractCalendarDate.php - About 2 hrs to fix

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

              public function __construct(array|int|AbstractCalendarDate $date)
              {
                  // Construct from an integer (a julian day number)
                  if (is_int($date)) {
                      $this->minimum_julian_day = $date;
          Severity: Minor
          Found in app/Date/AbstractCalendarDate.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

          Avoid too many return statements within this method.
          Open

                          return new JalaliDate($this);
          Severity: Major
          Found in app/Date/AbstractCalendarDate.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return $this;
            Severity: Major
            Found in app/Date/AbstractCalendarDate.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return new HijriDate($this);
              Severity: Major
              Found in app/Date/AbstractCalendarDate.php - About 30 mins to fix

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

                    public function dayNames(int $day_number): string
                    {
                        static $translated_day_names;
                
                        if ($translated_day_names === null) {
                Severity: Major
                Found in app/Date/AbstractCalendarDate.php and 1 other location - About 2 hrs to fix
                app/Date/AbstractCalendarDate.php on lines 266..290

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

                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 dayNamesAbbreviated(int $day_number): string
                    {
                        static $translated_day_names;
                
                        if ($translated_day_names === null) {
                Severity: Major
                Found in app/Date/AbstractCalendarDate.php and 1 other location - About 2 hrs to fix
                app/Date/AbstractCalendarDate.php on lines 240..257

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

                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

                There are no issues that match your filters.

                Category
                Status