family_node_test.go

package gedcom_test

import (
	"testing"

	"github.com/elliotchance/gedcom/v39"
	"github.com/elliotchance/tf"
	"github.com/stretchr/testify/assert"
)

var familyTests = []struct {
	doc     func(*gedcom.Document)
	husband *gedcom.IndividualNode
	wife    *gedcom.IndividualNode
}{
	{
		doc: func(doc *gedcom.Document) {
			doc.AddFamily("F1")
		},
		husband: nil,
		wife:    nil,
	},
	{
		doc: func(doc *gedcom.Document) {
			elliot := individual(doc, "P1", "Elliot /Chance/", "4 Jan 1843", "17 Mar 1907")
			f1 := doc.AddFamily("F1")
			f1.SetHusband(elliot)
		},
		husband: elliot,
		wife:    nil,
	},
	{
		doc: func(doc *gedcom.Document) {
			jane := individual(doc, "P2", "Jane /Doe/", "3 Mar 1803", "14 June 1877")
			f2 := doc.AddFamily("F2")
			f2.SetWife(jane)
		},
		husband: nil,
		wife:    jane,
	},
	{
		doc: func(doc *gedcom.Document) {
			jane := individual(doc, "P2", "Jane /Doe/", "3 Mar 1803", "14 June 1877")
			elliot := individual(doc, "P1", "Elliot /Chance/", "4 Jan 1843", "17 Mar 1907")
			f3 := doc.AddFamily("F3")
			f3.SetWife(jane)
			f3.SetHusband(elliot)
			f3.SetWife(nil)
		},
		husband: elliot,
		wife: nil,
	},
	{
		doc: func(doc *gedcom.Document) {
			jane := individual(doc, "P2", "Jane /Doe/", "3 Mar 1803", "14 June 1877")
			elliot := individual(doc, "P1", "Elliot /Chance/", "4 Jan 1843", "17 Mar 1907")
			f3 := doc.AddFamily("F3")
			f3.SetHusband(elliot)
			f3.SetWife(jane)
			f3.SetHusband(nil)

		},
		husband: nil,
		wife: jane,
	},
	{
		doc: func(doc *gedcom.Document) {
				jane := individual(doc, "P2", "Jane /Doe/", "3 Mar 1803", "14 June 1877")
				elliot := individual(doc, "P1", "Elliot /Chance/", "4 Jan 1843", "17 Mar 1907")
				doc.AddFamilyWithHusbandAndWife("F3", elliot, jane)
		},
		husband: elliot,
		wife: jane,
	},
	{
		doc: func(doc *gedcom.Document) {
				elliot := individual(doc, "P1", "Elliot /Chance/", "4 Jan 1843", "17 Mar 1907")
				doc.AddFamilyWithHusbandAndWife("F3", elliot, nil)
		},
		husband: elliot,
		wife: nil,
	},
	{
		doc: func(doc *gedcom.Document) {
				jane := individual(doc, "P2", "Jane /Doe/", "3 Mar 1803", "14 June 1877")	
				doc.AddFamilyWithHusbandAndWife("F3", nil, jane)
		},
		husband: nil,
		wife: jane,
	},
}

func TestFamilyNode_Husband(t *testing.T) {
	for _, test := range familyTests {
		t.Run("", func(t *testing.T) {
			doc := gedcom.NewDocument()
			test.doc(doc)
			node := doc.Families()[0]

			actualHusband := node.Husband()
			if test.husband == nil {
				assert.Nil(t, actualHusband)
			} else {
				if assert.NotNil(t, actualHusband) {
					assertEqual(t, actualHusband.Individual(), test.husband)
				}
			}
		})
	}

	Husband := tf.Function(t, (*gedcom.FamilyNode).Husband)

	Husband((*gedcom.FamilyNode)(nil)).Returns((*gedcom.HusbandNode)(nil))
}

func TestFamilyNode_Wife(t *testing.T) {
	for _, test := range familyTests {
		t.Run("", func(t *testing.T) {
			doc := gedcom.NewDocument()
			test.doc(doc)
			node := doc.Families()[0]

			actualWife := node.Wife()
			if test.wife == nil {
				assert.Nil(t, actualWife)
			} else {
				if assert.NotNil(t, actualWife) {
					assertEqual(t, actualWife.Individual(), test.wife)
				}
			}
		})
	}

	Wife := tf.Function(t, (*gedcom.FamilyNode).Wife)

	Wife((*gedcom.FamilyNode)(nil)).Returns((*gedcom.WifeNode)(nil))
}

func TestFamilyNode_Similarity(t *testing.T) {
	// ghost:ignore
	var tests = map[string]struct {
		doc      func(*gedcom.Document)
		expected float64
	}{
		// Empty cases.
		"Empty1": {
			doc: func(doc *gedcom.Document) {
				doc.AddFamily("F1")
				doc.AddFamily("F2")
			},
			expected: 0.5,
		},
		"Empty2": {
			doc: func(doc *gedcom.Document) {
				doc.AddFamily("F1")
				doc.AddFamily("F2")
			},
			expected: 0.5,
		},

		// Perfect cases.
		"Perfect": {
			// All details match exactly.
			doc: func(doc *gedcom.Document) {
				p1 := doc.AddIndividual("P1",
					gedcom.NewNameNode("Elliot Rupert de Peyster /Chance/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("4 Jan 1843")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("17 Mar 1907")),
				)
				p2 := doc.AddIndividual("P2",
					gedcom.NewNameNode("Dina Victoria /Wyche/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Abt. Feb 1837")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("8 Apr 1923")),
				)
				p3 := doc.AddIndividual("P3",
					gedcom.NewNameNode("Elliot Rupert de Peyster /Chance/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("4 Jan 1843")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("17 Mar 1907")),
				)
				p4 := doc.AddIndividual("P4",
					gedcom.NewNameNode("Dina Victoria /Wyche/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Abt. Feb 1837")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("8 Apr 1923")),
				)

				doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
				doc.AddFamilyWithHusbandAndWife("F2", p3, p4)
			},
			expected: 1.0,
		},

		// Almost perfect matches.
		"AlmostPerfect": {
			// Name is more/less complete.
			doc: func(doc *gedcom.Document) {
				p1 := doc.AddIndividual("P1",
					gedcom.NewNameNode("Elliot Rupert de Peyster /Chance/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("4 Jan 1843")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("17 Mar 1907")),
				)
				p2 := doc.AddIndividual("P2",
					gedcom.NewNameNode("Dina Victoria /Wyche/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Abt. Feb 1837")),
				)
				p3 := doc.AddIndividual("P3",
					gedcom.NewNameNode("Elliot R. d. P. /Chance/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("4 Jan 1843")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("17 Mar 1907")),
				)
				p4 := doc.AddIndividual("P4",
					gedcom.NewNameNode("Dina /Wyche/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Bef. Mar 1837")),
				)

				doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
				doc.AddFamilyWithHusbandAndWife("F2", p3, p4)
			},
			expected: 0.8904318416381887,
		},

		// These ones are way off.
		"WayOff": {
			doc: func(doc *gedcom.Document) {
				p1 := doc.AddIndividual("P1",
					gedcom.NewNameNode("Elliot Rupert de Peyster /Chance/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("4 Jan 1843")),
					gedcom.NewDeathNode("", gedcom.NewDateNode("17 Mar 1907")),
				)
				p2 := doc.AddIndividual("P2",
					gedcom.NewNameNode("Dina Victoria /Wyche/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Abt. Feb 1837")),
				)
				p3 := doc.AddIndividual("P3",
					gedcom.NewNameNode("Bob /Jones/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("1627")),
				)
				p4 := doc.AddIndividual("P4",
					gedcom.NewNameNode("Jane /Doe/"),
					gedcom.NewBirthNode("", gedcom.NewDateNode("Sep 1845")),
				)

				doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
				doc.AddFamilyWithHusbandAndWife("F2", p3, p4)
			},
			expected: 0.37700025152486955,
		},
	}

	options := gedcom.NewSimilarityOptions()
	for testName, test := range tests {
		t.Run(testName, func(t *testing.T) {
			doc := gedcom.NewDocument()
			test.doc(doc)
			family1 := doc.Families().ByPointer("F1")
			family2 := doc.Families().ByPointer("F2")

			got := family1.Similarity(family2, 0, options)

			assert.Equal(t, test.expected, got)
		})
	}
}

func TestFamilyNode_Children(t *testing.T) {
	Children := tf.Function(t, (*gedcom.FamilyNode).Children)

	Children((*gedcom.FamilyNode)(nil)).Returns((gedcom.ChildNodes)(nil))
}

func TestFamilyNode_HasChild(t *testing.T) {
	HasChild := tf.Function(t, (*gedcom.FamilyNode).HasChild)

	HasChild((*gedcom.FamilyNode)(nil), (*gedcom.IndividualNode)(nil)).Returns(false)
}

var familyWarningTests = map[string]struct {
	doc      func(doc *gedcom.Document)
	expected []string
}{
	"ChildBornAfterParent": {
		func(doc *gedcom.Document) {
			nick := individual(doc, "P1", "John /Chance/", "3 Apr 1961", "")
			elliot := individual(doc, "P2", "Elliot /Chance/", "16 May 1989", "")

			family := doc.AddFamilyWithHusbandAndWife("F1", nick, nil)
			family.AddChild(elliot)
		},
		nil,
	},
	"ChildBornBeforeFather": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Elliot /Chance/").
				AddBirthDate("3 Apr 1961")

			doc.AddFamilyWithHusbandAndWife("F1", p1, nil).
				AddChild(p2)
		},
		[]string{
			"The child Elliot Chance (b. 3 Apr 1961) was born before their father John Chance (b. 16 May 1989).",
		},
	},
	"ChildBornBeforeMother": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("Jenny /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Elliot /Chance/").
				AddBirthDate("3 Apr 1961")

			doc.AddFamilyWithHusbandAndWife("F1", nil, p1).
				AddChild(p2)
		},
		[]string{
			"The child Elliot Chance (b. 3 Apr 1961) was born before their mother Jenny Chance (b. 16 May 1989).",
		},
	},
	"MaleChildBornBeforeFather": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Elliot /Chance/").
				AddBirthDate("3 Apr 1961").
				SetSex(gedcom.SexMale)

			doc.AddFamilyWithHusbandAndWife("F1", p1, nil).
				AddChild(p2)
		},
		[]string{
			"The child Elliot Chance (b. 3 Apr 1961) was born before his father John Chance (b. 16 May 1989).",
		},
	},
	"FemaleChildBornBeforeFather": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1961").
				SetSex(gedcom.SexFemale)

			doc.AddFamilyWithHusbandAndWife("F1", p1, nil).
				AddChild(p2)
		},
		[]string{
			"The child Sarah Chance (b. 3 Apr 1961) was born before her father John Chance (b. 16 May 1989).",
		},
	},
	"SiblingsBornFarAwayFromEachOther": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1991").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		nil,
	},
	"SiblingsBornTooCloseToEachOther": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		[]string{
			"The siblings John Chance (b. 16 May 1989) and Sarah Chance (b. 3 Apr 1989) were born within one month and 13 days of each other.",
		},
	},
	"HusbandMarriedTooOld": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1889")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1960").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1995")))
		},
		[]string{
			"The husband John Chance (b. 16 May 1889) married too old at 107 years old.",
		},
	},
	"WifeMarriedTooOld": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1960")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1889").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1995")))
		},
		[]string{
			"The wife Sarah Chance (b. 3 Apr 1889) married too old at 107 years old.",
		},
	},
	"HusbandAndWifeMarriedTooOld": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1891")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1889").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1995")))
		},
		[]string{
			"The husband John Chance (b. 16 May 1891) married too old at 105 years old.",
			"The wife Sarah Chance (b. 3 Apr 1889) married too old at 107 years old.",
		},
	},
	"HusbandMarriedTooYoung": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1960").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1999")))
		},
		[]string{
			"The husband John Chance (b. 16 May 1989) married too young at 11 years old.",
		},
	},
	"WifeMarriedTooYoung": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1960")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1995")))
		},
		[]string{
			"The wife Sarah Chance (b. 3 Apr 1989) married too young at 7 years old.",
		},
	},
	"HusbandAndWifeMarriedAtWrongAge": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1891")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", "",
				gedcom.NewDateNode("1995")))
		},
		[]string{
			"The husband John Chance (b. 16 May 1891) married too old at 105 years old.",
			"The wife Sarah Chance (b. 3 Apr 1989) married too young at 7 years old.",
		},
	},
	"NoMarriageDate": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("16 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("3 Apr 1960").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p1, p2)
			f1.AddNode(gedcom.NewNode(gedcom.TagMarriage, "", ""))
		},
		nil,
	},
	"HusbandAndWifeSwapped": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				SetSex(gedcom.SexMale)

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				SetSex(gedcom.SexFemale)

			doc.AddFamilyWithHusbandAndWife("F1", p2, p1)
		},
		[]string{
			"Sarah Chance (Female) is the husband and John Chance (Male) is the wife.",
		},
	},
	"ParentsSwapped": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				SetSex(gedcom.SexMale)

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				SetSex(gedcom.SexFemale)

			c1 := doc.AddIndividual("P3").
				AddName("Jane /Chance/")

			f1 := doc.AddFamilyWithHusbandAndWife("F1", p2, p1)
			f1.AddChild(c1)
		},
		[]string{
			"Sarah Chance (Female) is the father and John Chance (Male) is the mother.",
		},
	},
	"SiblingsBornInTheSameYear": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		nil,
	},
	"SiblingsBornInTheSameYearFirstExact": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("1 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		nil,
	},
	"SiblingsBornInTheSameYearSecondExact": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("1 May 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		nil,
	},
	"Twins": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("1 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("1 May 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
		},
		nil,
	},
	"Triplets": {
		func(doc *gedcom.Document) {
			p1 := doc.AddIndividual("P1").
				AddName("John /Chance/").
				AddBirthDate("1 May 1989")

			p2 := doc.AddIndividual("P2").
				AddName("Sarah /Chance/").
				AddBirthDate("1 May 1989").
				SetSex(gedcom.SexFemale)

			p3 := doc.AddIndividual("P2").
				AddName("Jane /Chance/").
				AddBirthDate("1 May 1989").
				SetSex(gedcom.SexFemale)

			f1 := doc.AddFamily("F1")
			f1.AddChild(p1)
			f1.AddChild(p2)
			f1.AddChild(p3)
		},
		nil,
	},
}

func TestFamilyNode_Warnings(t *testing.T) {
	for testName, test := range familyWarningTests {
		t.Run(testName, func(t *testing.T) {
			doc := gedcom.NewDocument()
			test.doc(doc)

			f1 := doc.Families().ByPointer("F1")
			assertEqual(t, f1.Warnings().Strings(), test.expected)
		})
	}
}