elliotchance/gedcom

View on GitHub
family_node.go

Summary

Maintainability
C
1 day
Test Coverage

Method FamilyNode.siblingsBornTooCloseWarnings has a Cognitive Complexity of 25 (exceeds 20 allowed). Consider refactoring.
Open

func (node *FamilyNode) siblingsBornTooCloseWarnings() (warnings Warnings) {
    pairs := IndividualNodePairs{}
    nineMonths := time.Duration(274 * 24 * time.Hour)
    twoDays := time.Duration(2 * 24 * time.Hour)

Severity: Minor
Found in family_node.go - 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

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

func (node *FamilyNode) SetHusband(individual *IndividualNode) *FamilyNode {
    if IsNil(individual) {
        husband := node.Husband().Individual()
        if IsNil(husband) {
            return node
Severity: Major
Found in family_node.go and 1 other location - About 2 hrs to fix
family_node.go on lines 166..190

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

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

func (node *FamilyNode) SetWife(individual *IndividualNode) *FamilyNode {
    if IsNil(individual) {
        wife := node.Wife().Individual()
        if IsNil(wife) {
            return node
Severity: Major
Found in family_node.go and 1 other location - About 2 hrs to fix
family_node.go on lines 140..164

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

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

func (node *FamilyNode) Wife() (wife *WifeNode) {
    if node == nil {
        return nil
    }

Severity: Major
Found in family_node.go and 1 other location - About 1 hr to fix
family_node.go on lines 24..45

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

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

func (node *FamilyNode) Husband() (husband *HusbandNode) {
    if node == nil {
        return nil
    }

Severity: Major
Found in family_node.go and 1 other location - About 1 hr to fix
family_node.go on lines 48..69

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

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 3 places. Go fmt your code!
Open

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

exported method FamilyNode.SetHusband should have comment or be unexported
Open

func (node *FamilyNode) SetHusband(individual *IndividualNode) *FamilyNode {
Severity: Minor
Found in family_node.go by golint

comment on exported method FamilyNode.Husband should be of the form "Husband ..."
Open

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

exported method FamilyNode.AddChild should have comment or be unexported
Open

func (node *FamilyNode) AddChild(individual *IndividualNode) *ChildNode {
Severity: Minor
Found in family_node.go by golint

comment on exported method FamilyNode.HasChild should be of the form "HasChild ..."
Open

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

exported method FamilyNode.SetHusbandPointer should have comment or be unexported
Open

func (node *FamilyNode) SetHusbandPointer(pointer string) *FamilyNode {
Severity: Minor
Found in family_node.go by golint

exported method FamilyNode.SetWife should have comment or be unexported
Open

func (node *FamilyNode) SetWife(individual *IndividualNode) *FamilyNode {
Severity: Minor
Found in family_node.go by golint

exported method FamilyNode.SetWifePointer should have comment or be unexported
Open

func (node *FamilyNode) SetWifePointer(pointer string) *FamilyNode {
Severity: Minor
Found in family_node.go by golint

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

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

comment on exported method FamilyNode.Wife should be of the form "Wife ..."
Open

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

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

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

There are no issues that match your filters.

Category
Status