Skip to content

Fixed using raw strings as requiredMsg #731

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
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fixed using raw strings as requiredMsg #731

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
38b083a
Added getRequiredText() method to FormEntryPrompt
grzesiek2010 Sep 27, 2023
d06041b
Added tests for required messages that use itext function
grzesiek2010 Sep 27, 2023
196fd3a
Added failing tests for required messages that use raw strings
grzesiek2010 Sep 27, 2023
6a0f2c7
Fixed getting required messages that are raw strings
grzesiek2010 Sep 27, 2023
dcc9701
Reworked tests that verify constraint messages
grzesiek2010 Sep 27, 2023
e04b30d
Naming improvements
grzesiek2010 Dec 13, 2023
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
38 changes: 38 additions & 0 deletions src/main/java/org/javarosa/form/api/FormEntryPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
import org.javarosa.core.util.NoLocalizedTextException;
import org.javarosa.core.util.UnregisteredLocaleException;
import org.javarosa.formmanager.view.IQuestionWidget;
import org.javarosa.xform.parse.XFormParser;
import org.javarosa.xpath.XPathParseTool;
import org.javarosa.xpath.expr.XPathExpression;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -185,6 +188,41 @@ public String getAnswerText() {
}
}

public String getRequiredText() {
// look for the text under the requiredMsg bind attribute
String constraintText = form.getMainInstance().resolveReference(index.getReference()).getBindAttributeValue(XFormParser.NAMESPACE_JAVAROSA,
Copy link
Member

Choose a reason for hiding this comment

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

This should be requiredMsgText or something, right? It has nothing to do with constraints?

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, fixed.

"requiredMsg");
if (constraintText != null) {
XPathExpression xpathRequiredMsg;
try {
xpathRequiredMsg = XPathParseTool.parseXPath("string(" + constraintText + ")");
} catch (Exception e) {
// Expected in probably most cases.
// This is a string literal, so no need to evaluate anything.
return constraintText;
}

if (xpathRequiredMsg != null) {
try {
TreeElement treeElement = form.getMainInstance().resolveReference(
index.getReference());
EvaluationContext ec = new EvaluationContext(form.getEvaluationContext(),
treeElement.getRef());
Object value = xpathRequiredMsg.eval(form.getMainInstance(), ec);
if (!value.equals("")) {
return (String) value;
}
return constraintText;
} catch (Exception e) {
return constraintText;
}
} else {
return constraintText;
}
}
return null;
}

public String getConstraintText() {
return getConstraintText(null);
}
Expand Down
43 changes: 0 additions & 43 deletions src/test/java/org/javarosa/form/api/ConstraintTextTest.java
View file
Open in desktop

This file was deleted.

168 changes: 168 additions & 0 deletions src/test/java/org/javarosa/form/api/FormEntryPromptTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.nullValue;
import static org.javarosa.core.util.BindBuilderXFormsElement.bind;
import static org.javarosa.core.util.XFormsElement.body;
import static org.javarosa.core.util.XFormsElement.head;
import static org.javarosa.core.util.XFormsElement.html;
Expand Down Expand Up @@ -148,4 +150,170 @@ public void getSelectItemText_onSelectionsInRepeatInstances_returnsLabelInnerTex
assertThat(questionPrompt.getAnswerText(), is("A"));
}
//endregion

@Test
public void getRequiredText_shouldReturnNullIfRequiredTextNotSpecified() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Required questions", html(
head(
title("Required questions"),
model(
mainInstance(
t("data id='required-questions'",
t("q1")
)
),
bind("/data/q1").type("int")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getRequiredText(), is(nullValue()));
}

@Test
public void getRequiredText_shouldReturnRequiredTextIfSpecifiedUsingItextFunction() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Required questions", html(
head(
title("Required questions"),
model(
t("itext",
t("translation lang='en'",
t("text id='/data/q1:requiredMsg'",
t("value", "message")
)
)
),
mainInstance(
t("data id='required-questions'",
t("q1")
)
),
bind("/data/q1").type("int").withAttribute("jr", "requiredMsg", "jr:itext('/data/q1:requiredMsg')")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getRequiredText(), is("message"));
}

@Test
public void getRequiredText_shouldReturnRequiredTextIfSpecifiedUsingRawString() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Required questions", html(
head(
title("Required questions"),
model(
t("itext",
t("translation lang='en'",
t("text id='/data/q1:requiredMsg'",
t("value", "Your message")
)
)
),
mainInstance(
t("data id='required-questions'",
t("q1")
)
),
bind("/data/q1").type("int").withAttribute("jr", "requiredMsg", "message")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getRequiredText(), is("message"));
}

@Test
public void getConstraintText_shouldReturnNullIfRConstraintTextNotSpecified() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Constrained questions", html(
head(
title("Constrained questions"),
model(
mainInstance(
t("data id='constrained-questions'",
t("q1")
)
),
bind("/data/q1").type("int").constraint(". > 10")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getConstraintText(), is(nullValue()));
}

@Test
public void getConstraintText_shouldReturnConstraintTextIfSpecifiedUsingItextFunction() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Constrained questions", html(
head(
title("Constrained questions"),
model(
t("itext",
t("translation lang='en'",
t("text id='/data/q1:constraintMsg'",
t("value", "message")
)
)
),
mainInstance(
t("data id='constrained-questions'",
t("q1")
)
),
bind("/data/q1").type("int").constraint(". > 10").withAttribute("jr", "constraintMsg", "jr:itext('/data/q1:constraintMsg')")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getConstraintText(), is("message"));
}

@Test
public void getConstraintText_shouldReturnConstraintTextIfSpecifiedUsingRawString() throws XFormParser.ParseException, IOException {
Scenario scenario = Scenario.init("Constrained questions", html(
head(
title("Constrained questions"),
model(
t("itext",
t("translation lang='en'",
t("text id='/data/q1:constraintMsg'",
t("value", "Your message")
)
)
),
mainInstance(
t("data id='constrained-questions'",
t("q1")
)
),
bind("/data/q1").type("int").constraint(". > 10").withAttribute("jr", "constraintMsg", "message")
)
),
body(
input("/data/q1")
)
));

scenario.next();
assertThat(scenario.getFormEntryPromptAtIndex().getConstraintText(), is("message"));
}
}
75 changes: 0 additions & 75 deletions src/test/resources/org/javarosa/form/api/constraint-message-error.xml
View file
Open in desktop

This file was deleted.