Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up backend Word/Sense models #2867

Merged
merged 2 commits into from
Jan 5, 2024
Merged

Clean up backend Word/Sense models #2867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23bda44
Clean up backend Word/Sense models
imnasnainaec Jan 3, 2024
62c945c
Fix review issues
imnasnainaec Jan 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion Backend.Tests/Models/SenseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using BackendFramework.Models;
using NUnit.Framework;

Expand Down Expand Up @@ -67,12 +68,40 @@ public void TestIsContainedIn()
var domGlossSense = new Sense { Glosses = glossList, SemanticDomains = domList };
var defGlossSense = new Sense { Definitions = defList, Glosses = glossList };
// For empty senses, semantic domains are checked.
Assert.That((new Sense()).IsContainedIn(domSense), Is.True);
Assert.That(new Sense().IsContainedIn(domSense), Is.True);
Assert.That(domSense.IsContainedIn(new Sense()), Is.False);
// For non-empty senses, semantic domains aren't checked.
Assert.That(domGlossSense.IsContainedIn(defGlossSense), Is.True);
Assert.That(defGlossSense.IsContainedIn(domGlossSense), Is.False);
}

[Test]
public void TestCopyDomains()
{
// Add domains from a new sense, one a duplicate and one new.
var oldSense = Util.RandomSense();
var newSense = oldSense.Clone();
var oldSemDom = Util.RandomSemanticDomain();
var oldSemDomDup = oldSemDom.Clone();
oldSemDom.UserId = "id-not-in-dup";
oldSense.SemanticDomains.Add(oldSemDom);
newSense.SemanticDomains.Add(oldSemDomDup);
var newSemDom = Util.RandomSemanticDomain();
newSense.SemanticDomains.Add(newSemDom);

var userId = Util.RandString();
oldSense.CopyDomains(newSense, userId);

// Ensure the duplicate domain isn't added.
var oldDom = oldSense.SemanticDomains.FindAll(dom => dom.Id == oldSemDom.Id);
Assert.That(oldDom.Count, Is.EqualTo(1));
Assert.That(oldDom.First().UserId, Is.Not.EqualTo(userId));

// Ensure the new domain is added.
var newDom = oldSense.SemanticDomains.FindAll(dom => dom.Id == newSemDom.Id);
Assert.That(newDom.Count, Is.EqualTo(1));
Assert.That(newDom.First().UserId, Is.EqualTo(userId));
}
}

public class DefinitionTests
Expand Down
65 changes: 3 additions & 62 deletions Backend.Tests/Models/WordTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ public void TestAppendContainedWordContents()
newWord.EditedBy.Add(Text);
newWord.History.Add(Text);

// create a userId
var userId = Util.RandString();
Assert.That(oldWord.AppendContainedWordContents(newWord, userId), Is.True);
// Append new content.
Assert.That(oldWord.AppendContainedWordContents(newWord, "user-id"), Is.True);

// Confirm content is appended.
var updatedSense = oldWord.Senses.Find(s => s.Guid == newSense.Guid);
Assert.That(updatedSense, Is.Not.Null);
var updatedDom = updatedSense!.SemanticDomains.Find(dom => dom.Id == newSemDom.Id);
Expand All @@ -103,65 +103,6 @@ public void TestAppendContainedWordContents()
Assert.That(oldWord.Audio.Contains(Text), Is.True);
Assert.That(oldWord.EditedBy.Contains(Text), Is.True);
Assert.That(oldWord.History.Contains(Text), Is.True);

// if userId append successfully
Assert.That(updatedDom?.UserId, Is.EqualTo(userId));


// test2
// 1. create newWord2
var newWord2 = Util.RandomWord(oldWord.ProjectId);
newWord2.Vernacular = oldWord.Vernacular;

// 2. Make newWord2 have a cloned sense of oldWord, add one more new semantic domain
var newSense2 = oldWord.Senses.First().Clone();
var newSemDom2 = Util.RandomSemanticDomain();
newSense2.SemanticDomains.Add(newSemDom2);
newWord2.Senses = new List<Sense> { newSense2 };

// 3. AppendContainedWordContents with a empty userId
Assert.That(oldWord.AppendContainedWordContents(newWord2, ""), Is.True);
var updatedSense2 = oldWord.Senses.Find(s => s.Guid == newSense2.Guid);
Assert.That(updatedSense2, Is.Not.Null);
var updatedDom2 = updatedSense2!.SemanticDomains.Find(dom => dom.Id == newSemDom2.Id);
Assert.That(updatedDom2, Is.Not.Null);

// 4.test userId still be empty after append
Assert.That(updatedDom2?.UserId, Is.Empty);


// test3
// test Adding multiple items at same time
// Make newWord3 have a cloned sense of oldWord,
var newWord3 = Util.RandomWord(oldWord.ProjectId);
newWord3.Vernacular = oldWord.Vernacular;

// add three more new semantic domains
var newSense3 = oldWord.Senses.First().Clone();
var newSemDom3 = Util.RandomSemanticDomain();
var newSemDom4 = Util.RandomSemanticDomain();
var newSemDom5 = Util.RandomSemanticDomain();
newSense3.SemanticDomains.Add(newSemDom3);
newSense3.SemanticDomains.Add(newSemDom4);
newSense3.SemanticDomains.Add(newSemDom5);
newWord3.Senses = new List<Sense> { newSense3 };

// create a userId2
var userId2 = Util.RandString();
Assert.That(oldWord.AppendContainedWordContents(newWord3, userId2), Is.True);
var updatedSense3 = oldWord.Senses.Find(s => s.Guid == newSense3.Guid);
Assert.That(updatedSense3, Is.Not.Null);

// test all updateDoms have the same userId
var updatedDom3 = updatedSense3!.SemanticDomains.Find(dom => dom.Id == newSemDom3.Id);
Assert.That(updatedDom3, Is.Not.Null);
Assert.That(updatedDom3?.UserId, Is.EqualTo(userId2));
var updatedDom4 = updatedSense3!.SemanticDomains.Find(dom => dom.Id == newSemDom4.Id);
Assert.That(updatedDom4, Is.Not.Null);
Assert.That(updatedDom4?.UserId, Is.EqualTo(userId2));
var updatedDom5 = updatedSense3!.SemanticDomains.Find(dom => dom.Id == newSemDom5.Id);
Assert.That(updatedDom5, Is.Not.Null);
Assert.That(updatedDom5?.UserId, Is.EqualTo(userId2));
}
}

Expand Down
14 changes: 14 additions & 0 deletions Backend/Models/Sense.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,20 @@ public bool IsContainedIn(Sense other)
Glosses.All(other.Glosses.Contains) &&
Definitions.All(other.Definitions.Contains);
}

/// <summary> Adds all semantic domains from other Sense. </summary>
public void CopyDomains(Sense other, string userId)
{
var newDoms = other.SemanticDomains.Where(dom => SemanticDomains.All(d => d.Id != dom.Id)).ToList();
newDoms.ForEach(dom =>
{
if (string.IsNullOrEmpty(dom.UserId))
{
dom.UserId = userId;
}
});
SemanticDomains.AddRange(newDoms);
}
}

public class Definition
Expand Down
14 changes: 2 additions & 12 deletions Backend/Models/Word.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ public bool Contains(Word other)
/// Plural, Created, Modified, Accessibility, OtherField.
/// </summary>
/// <returns> A bool: true if operation succeeded and word updated. </returns>
public bool AppendContainedWordContents(Word other, String userId)
public bool AppendContainedWordContents(Word other, string userId)
{
// Confirm that the other word is contained
if (!Contains(other))
Expand All @@ -228,17 +228,7 @@ public bool AppendContainedWordContents(Word other, String userId)
{
return false;
}

// Get List of items that difference of two sequences update it if userId is NullOrEmpty
otherSense.SemanticDomains.Except(containingSense.SemanticDomains).ToList().ForEach((t) =>
{
if (string.IsNullOrEmpty(t.UserId))
{
t.UserId = userId;
}
});
containingSense.SemanticDomains.AddRange(otherSense.SemanticDomains);
containingSense.SemanticDomains = containingSense.SemanticDomains.Distinct().ToList();
containingSense.CopyDomains(otherSense, userId);
}

// Preserve other word's SemanticDomains, Note, Flag, Audio, EditedBy, History
Expand Down