Sign upLogin

elliotchance/gedcom

View on GitHub
Star
individual_node.go

Summary

Maintainability
D
1 day
Test Coverage

IndividualNode has 44 methods (exceeds 20 allowed). Consider refactoring.
Open

type IndividualNode struct {
    *simpleDocumentNode
    cachedFamilies, cachedSpouses bool
    families                      FamilyNodes
    spouses                       []*IndividualNode
Severity: Minor
Found in individual_node.go - About 6 hrs to fix

    File individual_node.go has 573 lines of code (exceeds 500 allowed). Consider refactoring.
    Open

    package gedcom

import (
    "fmt"
    "strings"
    Severity: Minor
    Found in individual_node.go - About 3 hrs to fix

      Method IndividualNode.incorrectEventOrderWarnings has a Cognitive Complexity of 32 (exceeds 20 allowed). Consider refactoring.
      Open

      func (node *IndividualNode) incorrectEventOrderWarnings() (warnings Warnings) {
    // Event order describes the boundaries of groups of events. That is to say
    // that any baptism or LDS baptism events must be after a birth event but
    // also much be before the any death event.
    eventOrder := []*struct {
      Severity: Minor
      Found in individual_node.go - 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

      Method IndividualNode.incorrectEventOrderWarnings has 54 lines of code (exceeds 50 allowed). Consider refactoring.
      Open

      func (node *IndividualNode) incorrectEventOrderWarnings() (warnings Warnings) {
    // Event order describes the boundaries of groups of events. That is to say
    // that any baptism or LDS baptism events must be after a birth event but
    // also much be before the any death event.
    eventOrder := []*struct {
      Severity: Minor
      Found in individual_node.go - About 1 hr to fix

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

            if death, _ := node.Death(); death != nil && death.DateRange().IsValid() {
        dateParts = append(dateParts, fmt.Sprintf("d. %s", death.String()))
    } else if burial, _ := node.Burial(); burial != nil && burial.DateRange().IsValid() {
        dateParts = append(dateParts, fmt.Sprintf("bur. %s", burial.String()))
    }
        Severity: Minor
        Found in individual_node.go and 1 other location - About 1 hr to fix
        individual_node.go on lines 804..808

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

        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 birth, _ := node.Birth(); birth != nil && birth.DateRange().IsValid() {
        dateParts = append(dateParts, fmt.Sprintf("b. %s", birth.String()))
    } else if baptism, _ := node.Baptism(); baptism != nil && baptism.DateRange().IsValid() {
        dateParts = append(dateParts, fmt.Sprintf("bap. %s", baptism.String()))
    }
        Severity: Minor
        Found in individual_node.go and 1 other location - About 1 hr to fix
        individual_node.go on lines 810..814

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

        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

        Your code does not pass gofmt in 2 places. Go fmt your code!
        Open

        package gedcom
        Severity: Minor
        Found in individual_node.go by gofmt

        comment on exported method IndividualNode.Sex should be of the form "Sex ..."
        Open

        // If the node is nil the result will be SexUnknown.
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.UniqueIDs should have comment or be unexported
        Open

        func (node *IndividualNode) UniqueIDs() (nodes []*UniqueIDNode) {
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.AddName should have comment or be unexported
        Open

        func (node *IndividualNode) AddName(name string) *IndividualNode {
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.FamilySearchIDs should have comment or be unexported
        Open

        func (node *IndividualNode) FamilySearchIDs() (nodes []*FamilySearchIDNode) {
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.Warnings should have comment or be unexported
        Open

        func (node *IndividualNode) Warnings() (warnings Warnings) {
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Families should be of the form "Families ..."
        Open

        // TODO: needs tests
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.AddBirthDate should have comment or be unexported
        Open

        func (node *IndividualNode) AddBirthDate(birthDate string) *IndividualNode {
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Spouses should be of the form "Spouses ..."
        Open

        // TODO: needs tests
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.AddBurialDate should have comment or be unexported
        Open

        func (node *IndividualNode) AddBurialDate(burialDate string) *IndividualNode {
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.FamilyWithUnknownSpouse should be of the form "FamilyWithUnknownSpouse ..."
        Open

        // TODO: needs tests
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Name should be of the form "Name ..."
        Open

        // TODO: Needs tests
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.AddDeathDate should have comment or be unexported
        Open

        func (node *IndividualNode) AddDeathDate(deathDate string) *IndividualNode {
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Names should be of the form "Names ..."
        Open

        // If the node is nil the result will also be nil.
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Children should be of the form "Children ..."
        Open

        // TODO: Needs tests
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.FamilyWithSpouse should be of the form "FamilyWithSpouse ..."
        Open

        // TODO: needs tests
        Severity: Minor
        Found in individual_node.go by golint

        exported method IndividualNode.AddBaptismDate should have comment or be unexported
        Open

        func (node *IndividualNode) AddBaptismDate(baptismDate string) *IndividualNode {
        Severity: Minor
        Found in individual_node.go by golint

        comment on exported method IndividualNode.Is should be of the form "Is ..."
        Open

        // TODO: needs tests
        Severity: Minor
        Found in individual_node.go by golint

        There are no issues that match your filters.

        Category
        Status