Skip to content

Allow the default filter value to be omitted #1346

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

Allow the default filter value to be omitted #1346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 12 deletions src/main/java/com/hubspot/jinjava/lib/filter/DefaultFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import com.hubspot.jinjava.doc.annotations.JinjavaParam;
import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
import com.hubspot.jinjava.interpret.JinjavaInterpreter;
import com.hubspot.jinjava.interpret.TemplateSyntaxException;
import com.hubspot.jinjava.objects.PyWrapper;
import com.hubspot.jinjava.util.ObjectTruthValue;
import java.util.Map;
Expand All @@ -36,8 +35,7 @@
@JinjavaParam(
value = DefaultFilter.DEFAULT_VALUE_PARAM,
type = "object",
desc = "Value to print when variable is not defined",
required = true
desc = "Value to print when variable is not defined; defaults to an empty string"
),
@JinjavaParam(
value = DefaultFilter.TRUTHY_PARAM,
Expand Down Expand Up @@ -68,16 +66,8 @@ public Object filter(
JinjavaInterpreter interpreter,
Map<String, Object> parsedArgs
) {
if (parsedArgs.size() < 1) {
throw new TemplateSyntaxException(
interpreter,
getName(),
"requires either 1 (default value to use) or 2 (default value to use, default with variables that evaluate to false) arguments"
);
}

boolean truthy = Boolean.TRUE.equals(parsedArgs.get(TRUTHY_PARAM));
Object defaultValue = parsedArgs.get(DEFAULT_VALUE_PARAM);
Object defaultValue = parsedArgs.getOrDefault(DEFAULT_VALUE_PARAM, "");

if (truthy) {
if (ObjectTruthValue.evaluate(object)) {
Expand Down
34 changes: 34 additions & 0 deletions src/test/java/com/hubspot/jinjava/lib/filter/DefaultFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,40 @@ public void setup() {
jinjava.getGlobalContext().registerClasses(DefaultFilter.class);
}

@Test
public void itKeepsDefinedValuesWithoutADefaultArgument() {
assertThat(jinjava.render("{{ 'a' | default }}", new HashMap<>())).isEqualTo("a");
assertThat(jinjava.render("{{ 0 | default() }}", new HashMap<>())).isEqualTo("0");
}

@Test
public void itDefaultsUndefinedValuesToAnEmptyString() {
assertThat(
jinjava.render(
"{% set value = missing | default %}{{ type(value) }}:{{ value | length }}",
new HashMap<>()
)
)
.isEqualTo("str:0");
}

@Test
public void itDefaultsFalsyValuesWithoutAnExplicitDefault() {
assertThat(
jinjava.render(
"{% set value = false | default(truthy=True) %}{{ type(value) }}:{{ value | length }}",
new HashMap<>()
)
)
.isEqualTo("str:0");
}

@Test
public void itAllowsOmittedArgumentsForTheAlias() {
assertThat(jinjava.render("{{ 'a' | d }}:{{ missing | d }}", new HashMap<>()))
.isEqualTo("a:");
}

@Test
public void itSetsDefaultStringValues() {
assertThat(
Expand Down