fisharebest/webtrees

View on GitHub
app/Module/IndividualListModule.php

Summary

Maintainability
F
6 days
Test Coverage

Function createResponse has a Cognitive Complexity of 114 (exceeds 5 allowed). Consider refactoring.
Open

    protected function createResponse(Tree $tree, UserInterface $user, array $params, bool $families): ResponseInterface
    {
        // We show three different lists: initials, surnames and individuals

        // All surnames beginning with this letter, where "@" is unknown and "," is none
Severity: Minor
Found in app/Module/IndividualListModule.php - About 2 days 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 createResponse has 258 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function createResponse(Tree $tree, UserInterface $user, array $params, bool $families): ResponseInterface
    {
        // We show three different lists: initials, surnames and individuals

        // All surnames beginning with this letter, where "@" is unknown and "," is none
Severity: Major
Found in app/Module/IndividualListModule.php - About 1 day to fix

    File IndividualListModule.php has 531 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    /**
     * webtrees: online genealogy
     * Copyright (C) 2023 webtrees development team
    Severity: Major
    Found in app/Module/IndividualListModule.php - About 1 day to fix

      Function individuals has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          protected function individuals(Tree $tree, string $surname, array $surnames, string $galpha, bool $marnm, bool $fams): Collection
          {
              $query = DB::table('individuals')
                  ->join('name', static function (JoinClause $join): void {
                      $join
      Severity: Minor
      Found in app/Module/IndividualListModule.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 individuals has 35 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function individuals(Tree $tree, string $surname, array $surnames, string $galpha, bool $marnm, bool $fams): Collection
          {
              $query = DB::table('individuals')
                  ->join('name', static function (JoinClause $join): void {
                      $join
      Severity: Minor
      Found in app/Module/IndividualListModule.php - About 1 hr to fix

        Method individuals has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            protected function individuals(Tree $tree, string $surname, array $surnames, string $galpha, bool $marnm, bool $fams): Collection
        Severity: Minor
        Found in app/Module/IndividualListModule.php - About 45 mins to fix

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

              protected function families(Tree $tree, string $surname, array $surnames, string $galpha, bool $marnm): Collection
          Severity: Minor
          Found in app/Module/IndividualListModule.php - About 35 mins to fix

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

                public function handle(ServerRequestInterface $request): ResponseInterface
                {
                    $tree = Validator::attributes($request)->tree();
                    $user = Validator::attributes($request)->user();
            
            
            Severity: Major
            Found in app/Module/IndividualListModule.php and 1 other location - About 1 day to fix
            app/Module/FamilyListModule.php on lines 74..99

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

            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 3 locations. Consider refactoring.
            Open

                    foreach ($query->get() as $row) {
                        $row->n_surn = $row->n_surn === '' ? $row->n_surname : $row->n_surn;
                        $row->n_surn = I18N::strtoupper(I18N::language()->normalize($row->n_surn));
            
                        $list[$row->n_surn][$row->n_surname] ??= 0;
            Severity: Major
            Found in app/Module/IndividualListModule.php and 2 other locations - About 1 hr to fix
            app/Module/FamilyTreeStatisticsModule.php on lines 139..145
            app/Module/TopSurnamesModule.php on lines 123..129

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

            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 3 locations. Consider refactoring.
            Open

                private function binaryColumn(string $column, string $alias = null): Expression
                {
                    if (DB::connection()->getDriverName() === 'mysql') {
                        $sql = 'CAST(' . $column . ' AS binary)';
                    } else {
            Severity: Major
            Found in app/Module/IndividualListModule.php and 2 other locations - About 40 mins to fix
            app/Module/FamilyTreeStatisticsModule.php on lines 351..364
            app/Module/TopSurnamesModule.php on lines 298..311

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

            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