elliotchance/gedcom

View on GitHub
cmd/gedcom/tune.go

Summary

Maintainability
C
1 day
Test Coverage

Function runTuneCommand has 91 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func runTuneCommand() {
    tuneFlags := &TuneFlags{}

    // Input files. Must be provided.
    flag.StringVar(&tuneFlags.optionGedcomFile1, "gedcom1", "", "First GEDCOM file.")
Severity: Major
Found in cmd/gedcom/tune.go - About 2 hrs to fix

    Function runMaxYears has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    func runMaxYears(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
    Severity: Minor
    Found in cmd/gedcom/tune.go - About 35 mins to fix

      Function runJaroBoost has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      func runJaroBoost(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
      Severity: Minor
      Found in cmd/gedcom/tune.go - About 35 mins to fix

        Function runJaroPrefixSize has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        func runJaroPrefixSize(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
        Severity: Minor
        Found in cmd/gedcom/tune.go - About 35 mins to fix

          Function runMinimumSimilarity has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          func runMinimumSimilarity(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
          Severity: Minor
          Found in cmd/gedcom/tune.go - About 35 mins to fix

            Function runNameToDateRatio has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            func runNameToDateRatio(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
            Severity: Minor
            Found in cmd/gedcom/tune.go - About 35 mins to fix

              Function runIndividualWeight has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

              func runIndividualWeight(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
              Severity: Minor
              Found in cmd/gedcom/tune.go - About 35 mins to fix

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

                func runNameToDateRatio(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
                    for x := tuneFlags.optionsNameToDateRatioMin; x <= tuneFlags.optionsNameToDateRatioMax; x += tuneFlags.optionsNameToDateRatioStep {
                        options.NameToDateRatio = x
                
                        runJaroBoost(gedcom1, gedcom2, idealScore, options, tuneFlags)
                Severity: Minor
                Found in cmd/gedcom/tune.go and 2 other locations - About 40 mins to fix
                cmd/gedcom/tune.go on lines 212..218
                cmd/gedcom/tune.go on lines 239..245

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

                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

                func runJaroBoost(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
                    for x := tuneFlags.optionsJaroBoostMin; x <= tuneFlags.optionsJaroBoostMax; x += tuneFlags.optionsJaroBoostStep {
                        options.JaroBoostThreshold = x
                
                        runJaroPrefixSize(gedcom1, gedcom2, idealScore, options, tuneFlags)
                Severity: Minor
                Found in cmd/gedcom/tune.go and 2 other locations - About 40 mins to fix
                cmd/gedcom/tune.go on lines 212..218
                cmd/gedcom/tune.go on lines 231..237

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

                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

                func runMaxYears(gedcom1 *gedcom.Document, gedcom2 *gedcom.Document, idealScore int, options gedcom.SimilarityOptions, tuneFlags *TuneFlags) {
                    for maxYears := tuneFlags.optionYearsMin; maxYears <= tuneFlags.optionYearsMax; maxYears += tuneFlags.optionYearsStep {
                        options.MaxYears = maxYears
                
                        runIndividualWeight(gedcom1, gedcom2, idealScore, options, tuneFlags)
                Severity: Minor
                Found in cmd/gedcom/tune.go and 2 other locations - About 40 mins to fix
                cmd/gedcom/tune.go on lines 231..237
                cmd/gedcom/tune.go on lines 239..245

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

                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

                should replace score -= 1 with score--
                Open

                                score -= 1
                Severity: Minor
                Found in cmd/gedcom/tune.go by golint

                exported type TuneFlags should have comment or be unexported
                Open

                type TuneFlags struct {
                Severity: Minor
                Found in cmd/gedcom/tune.go by golint

                should replace idealScore += 1 with idealScore++
                Open

                                idealScore += 1
                Severity: Minor
                Found in cmd/gedcom/tune.go by golint

                should replace score += 1 with score++
                Open

                                score += 1
                Severity: Minor
                Found in cmd/gedcom/tune.go by golint

                There are no issues that match your filters.

                Category
                Status