elliotchance/gedcom

View on GitHub
html/individual_compare.go

Summary

Maintainability
C
1 day
Test Coverage

Method IndividualCompare.writeHTMLTo has a Cognitive Complexity of 45 (exceeds 20 allowed). Consider refactoring.
Open

func (c *IndividualCompare) writeHTMLTo(w io.Writer) (int64, error) {
    left := c.comparison.Left
    right := c.comparison.Right

    c.addProgress()
Severity: Minor
Found in html/individual_compare.go - 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 IndividualCompare.writeHTMLTo has 110 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (c *IndividualCompare) writeHTMLTo(w io.Writer) (int64, error) {
    left := c.comparison.Left
    right := c.comparison.Right

    c.addProgress()
Severity: Major
Found in html/individual_compare.go - About 3 hrs to fix

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

    func NewIndividualCompare(comparison *gedcom.IndividualComparison, filterFlags *gedcom.FilterFlags, progress chan gedcom.Progress, compareOptions *gedcom.IndividualNodesCompareOptions, visibility LivingVisibility) *IndividualCompare {
    Severity: Minor
    Found in html/individual_compare.go - About 35 mins to fix

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

          if !gedcom.IsNil(right) {
              for _, parents := range right.Parents() {
                  if parent := parents.Husband(); parent != nil {
                      rightParents = append(rightParents, parent.Individual())
                  }
      Severity: Minor
      Found in html/individual_compare.go and 1 other location - About 40 mins to fix
      html/individual_compare.go on lines 125..134

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

          if !gedcom.IsNil(left) {
              for _, parents := range left.Parents() {
                  if parent := parents.Husband(); parent != nil {
                      leftParents = append(leftParents, parent.Individual())
                  }
      Severity: Minor
      Found in html/individual_compare.go and 1 other location - About 40 mins to fix
      html/individual_compare.go on lines 137..146

      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

      exported method IndividualCompare.WriteHTMLTo should have comment or be unexported
      Open

      func (c *IndividualCompare) WriteHTMLTo(w io.Writer) (int64, error) {
      Severity: Minor
      Found in html/individual_compare.go by golint

      exported function NewIndividualCompare should have comment or be unexported
      Open

      func NewIndividualCompare(comparison *gedcom.IndividualComparison, filterFlags *gedcom.FilterFlags, progress chan gedcom.Progress, compareOptions *gedcom.IndividualNodesCompareOptions, visibility LivingVisibility) *IndividualCompare {
      Severity: Minor
      Found in html/individual_compare.go by golint

      exported type IndividualCompare should have comment or be unexported
      Open

      type IndividualCompare struct {
      Severity: Minor
      Found in html/individual_compare.go by golint

      There are no issues that match your filters.

      Category
      Status