wikimedia/mediawiki-extensions-TwnMainPage

View on GitHub
includes/specials/SpecialTwnMainPage.php

Summary

Maintainability
F
5 days
Test Coverage

File SpecialTwnMainPage.php has 737 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

use MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroups;
use MediaWiki\Extension\Translate\Services;
use MediaWiki\Extension\Translate\Statistics\MessageGroupStats;
Severity: Major
Found in includes/specials/SpecialTwnMainPage.php - About 1 day to fix

    Method getTranslationStatsRows has 106 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function getTranslationStatsRows( string $languageForStats ): string {
            $stale = 60 * 5;
            $expired = 60 * 60 * 12;
            $statsCache = new CachedStat( "userstats-$languageForStats", $stale, $expired,
                [
    Severity: Major
    Found in includes/specials/SpecialTwnMainPage.php - About 4 hrs to fix

      Method loginForm has 102 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function loginForm(): string {
              $this->getOutput()->addModules( 'ext.translate.mainpage.signup' );
      
              $languageCode = $this->getLanguage()->getCode();
              $languageName = Utilities::getLanguageName( $languageCode, $languageCode );
      Severity: Major
      Found in includes/specials/SpecialTwnMainPage.php - About 4 hrs to fix

        SpecialTwnMainPage has 25 functions (exceeds 20 allowed). Consider refactoring.
        Open

        class SpecialTwnMainPage extends SpecialPage {
            protected int $maxProjectTiles = 8;
            private TranslationStashReader $translationStashReader;
            private ?ProjectHandler $projectHandler;
        
        
        Severity: Minor
        Found in includes/specials/SpecialTwnMainPage.php - About 2 hrs to fix

          Method twnStats has 51 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function twnStats(): string {
                  $stale = 60 * 60 * 6;
                  $expired = 60 * 60 * 24;
                  $handler = $this->getProjectHandler();
          
          
          Severity: Major
          Found in includes/specials/SpecialTwnMainPage.php - About 2 hrs to fix

            Method header has 48 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function header(): string {
                    global $wgSitename;
            
                    $siteNameEsc = htmlspecialchars( $wgSitename );
                    $siteMottoEsc = $this->msg( 'twnmp-brand-motto' )->escaped();
            Severity: Minor
            Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

              Method makeGroupTile has 47 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function makeGroupTile( MessageGroup $group, array $stats ): string {
                      $id = $group->getId();
                      $uiLanguage = $this->getLanguage()->getCode();
                      $groupLanguage = $group->getSourceLanguage();
                      $statsHtml = '';
              Severity: Minor
              Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

                Method loggedInWidget has 38 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    private function loggedInWidget(): string {
                        $languageCode = $this->getLanguage()->getCode();
                        $languageName = Utilities::getLanguageName( $languageCode, $languageCode );
                
                        $groupsSourceLanguage = MessageGroups::haveSingleSourceLanguage(
                Severity: Minor
                Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

                  Function twnStats has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function twnStats(): string {
                          $stale = 60 * 60 * 6;
                          $expired = 60 * 60 * 24;
                          $handler = $this->getProjectHandler();
                  
                  
                  Severity: Minor
                  Found in includes/specials/SpecialTwnMainPage.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 footer has 34 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      private function footer(): string {
                          $out = Html::openElement( 'footer' );
                          $out .= Html::openElement( 'div', [ 'class' => 'row twn-mainpage-footer' ] );
                          $out .= Html::element( 'a', [
                              'class' => 'three column',
                  Severity: Minor
                  Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

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

                        private function getTranslationStatsRows( string $languageForStats ): string {
                            $stale = 60 * 5;
                            $expired = 60 * 60 * 12;
                            $statsCache = new CachedStat( "userstats-$languageForStats", $stale, $expired,
                                [
                    Severity: Minor
                    Found in includes/specials/SpecialTwnMainPage.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 searchBar has 29 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                        private function searchBar(): string {
                            $out = Html::openElement( 'form',
                                [
                                    'class' => 'row twn-mainpage-search',
                                    'action' => SpecialPage::getTitleFor( 'SearchTranslations' )->getLocalURL(),
                    Severity: Minor
                    Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

                      Method getStatsTiles has 28 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                          private function getStatsTiles( $stats ): array {
                              return [
                                  // Rows X cols
                                  [
                                      [
                      Severity: Minor
                      Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

                        Method getSandboxRows has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                            private function getSandboxRows(): string {
                                global $wgTranslateSandboxLimit;
                        
                                $count = count( $this->translationStashReader->getTranslations( $this->getUser() ) );
                        
                        
                        Severity: Minor
                        Found in includes/specials/SpecialTwnMainPage.php - About 1 hr to fix

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

                                  foreach ( $stats as $user => $count ) {
                                      if ( $user === $currentUser ) {
                                          $out .= Html::element(
                                              'div',
                                              [ 'class' => 'count' ],
                          Severity: Major
                          Found in includes/specials/SpecialTwnMainPage.php and 1 other location - About 3 hrs to fix
                          includes/specials/SpecialTwnMainPage.php on lines 819..844

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

                          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

                                  foreach ( $stats as $user => $count ) {
                                      if ( $user === $currentUser ) {
                                          $out .= Html::element(
                                              'div',
                                              [ 'class' => 'count' ],
                          Severity: Major
                          Found in includes/specials/SpecialTwnMainPage.php and 1 other location - About 3 hrs to fix
                          includes/specials/SpecialTwnMainPage.php on lines 772..797

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

                          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