Sign upLogin

wikimedia/mediawiki-extensions-CirrusSearch

View on GitHub
Star
includes/Maintenance/AnalysisConfigBuilder.php

Summary

Maintainability
F
1 wk
Test Coverage

File AnalysisConfigBuilder.php has 1462 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace CirrusSearch\Maintenance;

use CirrusSearch\CirrusSearch;
Severity: Major
Found in includes/Maintenance/AnalysisConfigBuilder.php - About 3 days to fix

    Method customize has 521 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function customize( $config, $language ) {
        $langName = $this->getDefaultTextAnalyzerType( $language );
        $icuEnabled = $this->shouldActivateIcuFolding( $language );

        // prep an AnalyzerBuilder for this language, with proper ICU folding setup.
    Severity: Major
    Found in includes/Maintenance/AnalysisConfigBuilder.php - About 2 days to fix

      Method defaults has 291 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function defaults( $language ) {
        $defaults = [
            'analyzer' => [
                'text' => [
                    'type' => $this->getDefaultTextAnalyzerType( $language ),
      Severity: Major
      Found in includes/Maintenance/AnalysisConfigBuilder.php - About 1 day to fix

        Function customize has a Cognitive Complexity of 69 (exceeds 5 allowed). Consider refactoring.
        Open

            private function customize( $config, $language ) {
        $langName = $this->getDefaultTextAnalyzerType( $language );
        $icuEnabled = $this->shouldActivateIcuFolding( $language );

        // prep an AnalyzerBuilder for this language, with proper ICU folding setup.
        Severity: Minor
        Found in includes/Maintenance/AnalysisConfigBuilder.php - About 1 day 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

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

        class AnalysisConfigBuilder {
    /**
     * Version number for the core analysis. Increment the major
     * version when the analysis changes in an incompatible way,
     * and change the minor version when it changes but isn't
        Severity: Minor
        Found in includes/Maintenance/AnalysisConfigBuilder.php - About 3 hrs to fix

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

              public function enableICUFolding( array $config, $language ) {
        $unicodeSetFilter = $this->getICUSetFilter( $language );
        $filter = [
            'type' => 'icu_folding',
        ];
          Severity: Minor
          Found in includes/Maintenance/AnalysisConfigBuilder.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

          Function mergeConfig has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
          Open

              private function mergeConfig( array &$config, array $langConfig, $name, $prefix ) {
        $analyzer = $langConfig[ 'analyzer' ][ $name ];
        $config[ 'analyzer' ][ $prefix . '_' . $name ] = $analyzer;
        if ( !empty( $analyzer[ 'filter' ] ) ) {
            // Add private filters for this analyzer
          Severity: Minor
          Found in includes/Maintenance/AnalysisConfigBuilder.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

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

              protected function addRemoveEmpty( array $config ) {
        foreach ( $config[ 'analyzer' ] as $name => $value ) {
            if ( isset( $value[ 'type' ] ) && $value[ 'type' ] != 'custom' ) {
                continue;
            }
          Severity: Minor
          Found in includes/Maintenance/AnalysisConfigBuilder.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 enableICUFolding has 43 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function enableICUFolding( array $config, $language ) {
        $unicodeSetFilter = $this->getICUSetFilter( $language );
        $filter = [
            'type' => 'icu_folding',
        ];
          Severity: Minor
          Found in includes/Maintenance/AnalysisConfigBuilder.php - About 1 hr to fix

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

                public function __construct(
        $langCode,
        array $plugins,
        SearchConfig $config = null,
        CirrusSearchHookRunner $cirrusSearchHookRunner = null
            Severity: Minor
            Found in includes/Maintenance/AnalysisConfigBuilder.php - About 1 hr to fix

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

                  public function __construct(
        $langCode,
        array $plugins,
        SearchConfig $config = null,
        CirrusSearchHookRunner $cirrusSearchHookRunner = null
              Severity: Minor
              Found in includes/Maintenance/AnalysisConfigBuilder.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 buildGlobalCustomFilters has 31 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private static function buildGlobalCustomFilters(): array {
        $gcf = [
            //////////////////////////
            // char filters
            'globo_norm' => new GlobalCustomFilter( 'char_filter' ),
              Severity: Minor
              Found in includes/Maintenance/AnalysisConfigBuilder.php - About 1 hr to fix

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

                    private function getDefaultFilters( array &$config, array $analyzers ) {
        $defaultFilters = [];
        foreach ( $analyzers as $analyzer ) {
            if ( empty( $config[ 'analyzer' ][ $analyzer ][ 'filter' ] ) ) {
                continue;
                Severity: Minor
                Found in includes/Maintenance/AnalysisConfigBuilder.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 defaults has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function defaults( $language ) {
        $defaults = [
            'analyzer' => [
                'text' => [
                    'type' => $this->getDefaultTextAnalyzerType( $language ),
                Severity: Minor
                Found in includes/Maintenance/AnalysisConfigBuilder.php - About 45 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 enableICUTokenizer has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function enableICUTokenizer( array $config ) {
        foreach ( $config[ 'analyzer' ] as $name => &$value ) {
            if ( isset( $value[ 'type' ] ) && $value[ 'type' ] != 'custom' ) {
                continue;
            }
                Severity: Minor
                Found in includes/Maintenance/AnalysisConfigBuilder.php - About 35 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 standardTokenizerOnlyCleanup has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function standardTokenizerOnlyCleanup( array $config ) {
        foreach ( $config[ 'analyzer' ] as $name => &$value ) {
            if ( isset( $value[ 'type' ] ) && $value[ 'type' ] != 'custom' ) {
                continue;
            }
                Severity: Minor
                Found in includes/Maintenance/AnalysisConfigBuilder.php - About 35 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 resolveFilters has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function resolveFilters( array &$config, array $standardFilters, array $defaultFilters,
            string $prefix ) {
        $resultFilters = [];
        foreach ( $config[ 'filter' ] as $name => $filter ) {
            $existingFilter = $standardFilters[$name] ?? $defaultFilters[$name] ?? null;
                Severity: Minor
                Found in includes/Maintenance/AnalysisConfigBuilder.php - About 35 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

                Avoid too many return statements within this method.
                Open

                                return false;
                Severity: Major
                Found in includes/Maintenance/AnalysisConfigBuilder.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return false;
                  Severity: Major
                  Found in includes/Maintenance/AnalysisConfigBuilder.php - About 30 mins to fix

                    Function switchFiltersToICUFoldingPreserve has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                        private function switchFiltersToICUFoldingPreserve( array $filters, $append = false ) {
        if ( in_array( 'icu_folding', $filters ) ) {
            // ICU folding already here
            return $filters;
        }
                    Severity: Minor
                    Found in includes/Maintenance/AnalysisConfigBuilder.php - About 25 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

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

                                    'globo_norm' => [
                    'type' => 'mapping',
                    'mappings' => [
                        // map lots of apostrophe-like characters to apostrophe (T315118);
                        // formerly apostrophe_norm
                    Severity: Major
                    Found in includes/Maintenance/AnalysisConfigBuilder.php and 1 other location - About 1 hr to fix
                    includes/Maintenance/SuggesterAnalysisConfigBuilder.php on lines 64..121

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

                    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