Skip to content

Fix a dropped morpheme ID when a zero-width rule wraps one ending at the same node #500

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

Open
johnml1135 wants to merge 2 commits into
base: fix-506-directional-boundaries
Choose a base branch
from
Open

Fix a dropped morpheme ID when a zero-width rule wraps one ending at the same node #500

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
b86120f
Fix a dropped morpheme ID when a zero-width rule wraps one ending at …
johnml1135 Sep 25, 2026
f531fb1
Require every load to give the identity rule's ID order
johnml1135 Oct 30, 2026
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
14 changes: 7 additions & 7 deletions ...achine.Morphology.HermitCrab/MorphologicalRules/SynthesisAffixProcessAllomorphRuleSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,6 @@ public Word ApplyRhs(PatternRule<Word, ShapeNode> rule, Match<Word, ShapeNode> m
_allomorph,
output.MorphologicalRuleApplicationCount.ToString()
);
if (outputNewMorph == null)
{
// There are no new output morphs in a truncation rule,
// so we add its allomorph to the last output shape.
string morphID = output.MorphologicalRuleApplicationCount.ToString();
output.MarkMorph(new List<ShapeNode>() { output.Shape.Last }, _allomorph, morphID);
}
var markedAllomorphs = new HashSet<Allomorph>();
foreach (Annotation<ShapeNode> inputMorph in match.Input.Morphs)
{
Expand Down Expand Up @@ -205,6 +198,13 @@ public Word ApplyRhs(PatternRule<Word, ShapeNode> rule, Match<Word, ShapeNode> m
}
markedAllomorphs.Add(allomorph);
}
if (outputNewMorph == null)
{
// Truncation and zero-width rules have no new morph. Mark the last node after the
// loop, so a wrapped allomorph ending there keeps it and this rule's ID sorts after.
string morphID = output.MorphologicalRuleApplicationCount.ToString();
output.MarkMorph(new List<ShapeNode>() { output.Shape.Last }, _allomorph, morphID);
Comment thread
claude[bot] marked this conversation as resolved.
Resolved
}

output.MprFeatures.AddOutput(_allomorph.OutMprFeatures);

Expand Down
182 changes: 182 additions & 0 deletions tests/SIL.Machine.Morphology.HermitCrab.Tests/IdentityRuleSignatureMorphDropTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
using NUnit.Framework;

namespace SIL.Machine.Morphology.HermitCrab;

/// <summary>
/// Regression coverage for a dropped morpheme ID when a zero-width rule wraps one ending at the
/// same shape node.
/// </summary>
[TestFixture]
public class IdentityRuleSignatureMorphDropTests
{
private const string GrammarXml = """

@claude claude Bot Oct 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: F5. GrammarXml and WriteTempGrammar (line 99) use "grammar" for the HermitCrab configuration. AGENTS.md reserves that word and asks for Language or Stratum instead, e.g. LanguageXml and WriteTempLanguage.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE HermitCrabInput SYSTEM "HermitCrabInput.dtd">
<HermitCrabInput>
<Language>
<Name>IdentityRuleSignatureMorphDropTest</Name>
<PartsOfSpeech>
<PartOfSpeech id="posX"><Name>x</Name></PartOfSpeech>
</PartsOfSpeech>
<HeadFeatures>
<SymbolicFeature id="featGrp">
<Name>grp</Name>
<Symbols>
<Symbol id="symP">p</Symbol>
<Symbol id="symQ">q</Symbol>
</Symbols>
</SymbolicFeature>
</HeadFeatures>
<CharacterDefinitionTable id="tbl">
<Name>Main</Name>
<SegmentDefinitions>
<SegmentDefinition id="cF"><Representations><Representation>f</Representation></Representations></SegmentDefinition>
<SegmentDefinition id="cE"><Representations><Representation>e</Representation></Representations></SegmentDefinition>
<SegmentDefinition id="cN"><Representations><Representation>n</Representation></Representations></SegmentDefinition>
<SegmentDefinition id="cO"><Representations><Representation>o</Representation></Representations></SegmentDefinition>
<SegmentDefinition id="cS"><Representations><Representation>s</Representation></Representations></SegmentDefinition>
</SegmentDefinitions>
</CharacterDefinitionTable>
<NaturalClasses>
<FeatureNaturalClass id="ncAny"><Name>Any</Name></FeatureNaturalClass>
</NaturalClasses>
<Strata>
<Stratum characterDefinitionTable="tbl" morphologicalRules="mrPtoQ mrQtoP mrIdentity">
<Name>Main</Name>
<MorphologicalRuleDefinitions>
<MorphologicalRule id="mrPtoQ">
<Name>ptoq</Name>
<MorphologicalSubrules>
<MorphologicalSubrule id="subPtoQ">
<MorphologicalInput><PhoneticSequence id="stemPtoQ"><OptionalSegmentSequence min="1" max="-1"><SimpleContext naturalClass="ncAny" /></OptionalSegmentSequence></PhoneticSequence></MorphologicalInput>
<MorphologicalOutput><CopyFromInput index="stemPtoQ" /><InsertSegments><PhoneticShape>o</PhoneticShape></InsertSegments></MorphologicalOutput>
</MorphologicalSubrule>
</MorphologicalSubrules>
<OutputHeadFeatures><FeatureValue feature="featGrp" symbolValues="symQ" /></OutputHeadFeatures>
<RequiredHeadFeatures><FeatureValue feature="featGrp" symbolValues="symP" /></RequiredHeadFeatures>
<MorphemeId>PTOQ</MorphemeId>
<Gloss>PTOQ</Gloss>
</MorphologicalRule>
<MorphologicalRule id="mrQtoP">
<Name>qtop</Name>
<MorphologicalSubrules>
<MorphologicalSubrule id="subQtoP">
<MorphologicalInput><PhoneticSequence id="stemQtoP"><OptionalSegmentSequence min="1" max="-1"><SimpleContext naturalClass="ncAny" /></OptionalSegmentSequence></PhoneticSequence></MorphologicalInput>
<MorphologicalOutput><CopyFromInput index="stemQtoP" /><InsertSegments><PhoneticShape>s</PhoneticShape></InsertSegments></MorphologicalOutput>
</MorphologicalSubrule>
</MorphologicalSubrules>
<OutputHeadFeatures><FeatureValue feature="featGrp" symbolValues="symP" /></OutputHeadFeatures>
<RequiredHeadFeatures><FeatureValue feature="featGrp" symbolValues="symQ" /></RequiredHeadFeatures>
<MorphemeId>QTOP</MorphemeId>
<Gloss>QTOP</Gloss>
</MorphologicalRule>
<MorphologicalRule id="mrIdentity">
<Name>identity</Name>
<MorphologicalSubrules>
<MorphologicalSubrule id="subIdentity">
<MorphologicalInput><PhoneticSequence id="stemIdentity"><OptionalSegmentSequence min="1" max="-1"><SimpleContext naturalClass="ncAny" /></OptionalSegmentSequence></PhoneticSequence></MorphologicalInput>
<MorphologicalOutput><CopyFromInput index="stemIdentity" /></MorphologicalOutput>
</MorphologicalSubrule>
</MorphologicalSubrules>
<OutputHeadFeatures><FeatureValue feature="featGrp" symbolValues="symQ" /></OutputHeadFeatures>
<RequiredHeadFeatures><FeatureValue feature="featGrp" symbolValues="symP" /></RequiredHeadFeatures>
<MorphemeId>IDENT</MorphemeId>
<Gloss>IDENT</Gloss>
</MorphologicalRule>
</MorphologicalRuleDefinitions>
<LexicalEntries>
<LexicalEntry id="eFen" partOfSpeech="posX">
<Allomorphs><Allomorph id="aFen"><PhoneticShape>fen</PhoneticShape></Allomorph></Allomorphs>
<MorphemeId>FEN</MorphemeId>
<Gloss>fen</Gloss>
</LexicalEntry>
</LexicalEntries>
</Stratum>
</Strata>
</Language>
</HermitCrabInput>
""";

private static string WriteTempGrammar()
{
string path = Path.Combine(
Path.GetTempPath(),
"hc-identity-signature-drop-" + Guid.NewGuid().ToString("N") + ".xml"
);
File.WriteAllText(path, GrammarXml);
return path;
}

private static string Signature(IEnumerable<Word> results)
{
List<string> signatures = results
.Select(w =>
string.Join("+", w.AllomorphsInMorphOrder.Select(a => a.Morpheme.Id))
+ "|"
+ w.Shape.ToRegexString(w.Stratum.CharacterDefinitionTable, true)
)
.OrderBy(s => s, StringComparer.Ordinal)
.ToList();
return signatures.Count == 0 ? "-" : string.Join(";", signatures);
}

private static string ParseWithFreshMorpher(Language language, string word)
{
var morpher = new Morpher(new TraceManager(), language, maxDegreeOfParallelism: 1);
return Signature(morpher.ParseWord(word, out _, false).ToList());
}

[Test]
public void Fen_BareRootControl_IdentityWrapsRootDirectly_StableAndCorrect()
{
// Control: mrIdentity wraps the root directly, so no two rules share an affix boundary.
string path = WriteTempGrammar();
try
{
Language language = XmlLanguageLoader.Load(path);
for (int trial = 0; trial < 10; trial++)
Assert.That(ParseWithFreshMorpher(language, "fen"), Is.EqualTo("FEN+IDENT|fen;FEN|fen"));
}
finally
{
File.Delete(path);
}
}

[Test]
public void Feno_NoIdentityRuleApplies_StableAndCorrect()
{
// Control: after mrPtoQ alone the value is q, so mrIdentity (requires p) never applies.
string path = WriteTempGrammar();
try
{
Language language = XmlLanguageLoader.Load(path);
for (int trial = 0; trial < 10; trial++)
Assert.That(ParseWithFreshMorpher(language, "feno"), Is.EqualTo("FEN+PTOQ|feno"));
}
finally
{
File.Delete(path);
}
}

[Test]
public void Fenos_IdentityWrapsOutermost_EveryFreshLoadHasCorrectSignature()
{
string path = WriteTempGrammar();
try
{
const string CorrectSig = "FEN+PTOQ+QTOP+IDENT|fenos;FEN+PTOQ+QTOP|fenos";
for (int load = 1; load <= 20; load++)
{
Language language = XmlLanguageLoader.Load(path);
string signature = ParseWithFreshMorpher(language, "fenos");
Assert.That(signature, Is.EqualTo(CorrectSig), $"Fresh load {load} produced {signature}");
}
}
finally
{
File.Delete(path);
}
}
}
Loading