Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package com.hubspot.jinjava.lib.tag.eager;

import com.google.common.annotations.Beta;
import com.hubspot.jinjava.interpret.DeferredValue;
import com.hubspot.jinjava.interpret.JinjavaInterpreter;
import com.hubspot.jinjava.lib.tag.ContinueTag;
import com.hubspot.jinjava.lib.tag.ForTag;
import com.hubspot.jinjava.tree.parse.TagToken;

/**
* Eager decorator for the continue tag that handles reconstruction when the continue
* is inside a deferred context (e.g., when in deferred execution mode such as
* inside a deferred if condition within a for loop).
*/
@Beta
public class EagerContinueTag extends EagerTagDecorator<ContinueTag> {

public EagerContinueTag() {
super(new ContinueTag());
}

public EagerContinueTag(ContinueTag continueTag) {
super(continueTag);
}

@Override
public String getEagerTagImage(TagToken tagToken, JinjavaInterpreter interpreter) {
if (!(interpreter.getContext().get(ForTag.LOOP) instanceof DeferredValue)) {
interpreter.getContext().replace(ForTag.LOOP, DeferredValue.instance());
}
return super.getEagerTagImage(tagToken, interpreter);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.hubspot.jinjava.lib.tag.BlockTag;
import com.hubspot.jinjava.lib.tag.BreakTag;
import com.hubspot.jinjava.lib.tag.CallTag;
import com.hubspot.jinjava.lib.tag.ContinueTag;
import com.hubspot.jinjava.lib.tag.CycleTag;
Expand Down Expand Up @@ -46,6 +45,7 @@ public class EagerTagFactory {
.put(IfTag.class, EagerIfTag.class)
.put(UnlessTag.class, EagerUnlessTag.class)
.put(CallTag.class, EagerCallTag.class)
.put(ContinueTag.class, EagerContinueTag.class)

Choose a reason for hiding this comment

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

break doesn't need to map to anything? Not even EagerGenericTag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It auto-maps to EagerGenericTag if it's not in TAG_CLASSES_TO_SKIP

Choose a reason for hiding this comment

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

thanks!

.build();
// These classes don't need an eager decorator.
public static final Set<Class<? extends Tag>> TAG_CLASSES_TO_SKIP = ImmutableSet
Expand All @@ -56,8 +56,6 @@ public class EagerTagFactory {
.add(ElseTag.class)
.add(RawTag.class)
.add(ExtendsTag.class) // TODO support reconstructing extends tags
.add(BreakTag.class) // TODO support eager break tag
.add(ContinueTag.class) // TODO support eager continue tag
.build();

@SuppressWarnings("unchecked")
Expand Down
65 changes: 49 additions & 16 deletions src/test/java/com/hubspot/jinjava/EagerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
Expand Down Expand Up @@ -1647,42 +1648,74 @@ public void itWrapsMacroThatWouldChangeCurrentPathInChildScope() {

@Test
public void itHandlesDeferredBreakInForLoop() {
String input = expectedTemplateInterpreter.getFixtureTemplate(
expectedTemplateInterpreter.assertExpectedOutput(
"handles-deferred-break-in-for-loop/test"
);
interpreter.render(input);
// We don't support this yet
assertThat(interpreter.getContext().getDeferredNodes()).isNotEmpty();
}

@Test
public void itHandlesDeferredBreakInForLoopSecondPass() {
localContext.put("deferred", 1);
expectedTemplateInterpreter.assertExpectedOutput(
"handles-deferred-break-in-for-loop/test.expected"
);
expectedTemplateInterpreter.assertExpectedNonEagerOutput(
"handles-deferred-break-in-for-loop/test.expected"
);
}

@Test
public void itHandlesBreakInDeferredForLoop() {
String input = expectedTemplateInterpreter.getFixtureTemplate(
expectedTemplateInterpreter.assertExpectedOutput(
"handles-break-in-deferred-for-loop/test"
);
interpreter.render(input);
// We don't support this yet
assertThat(interpreter.getContext().getDeferredNodes()).isNotEmpty();
}

@Test
public void itHandlesBreakInDeferredForLoopSecondPass() {
localContext.put("deferred", List.of(0, 1, 2, 3, 4, 5));
expectedTemplateInterpreter.assertExpectedOutput(
"handles-break-in-deferred-for-loop/test.expected"
);
expectedTemplateInterpreter.assertExpectedNonEagerOutput(
"handles-break-in-deferred-for-loop/test.expected"
);
}

@Test
public void itHandlesDeferredContinueInForLoop() {
String input = expectedTemplateInterpreter.getFixtureTemplate(
expectedTemplateInterpreter.assertExpectedOutput(
"handles-deferred-continue-in-for-loop/test"
);
interpreter.render(input);
// We don't support this yet
assertThat(interpreter.getContext().getDeferredNodes()).isNotEmpty();
}

@Test
public void itHandlesDeferredContinueInForLoopSecondPass() {
localContext.put("deferred", 2);
expectedTemplateInterpreter.assertExpectedOutput(
"handles-deferred-continue-in-for-loop/test.expected"
);
expectedTemplateInterpreter.assertExpectedNonEagerOutput(
"handles-deferred-continue-in-for-loop/test.expected"
);
}

@Test
public void itHandlesContinueInDeferredForLoop() {
String input = expectedTemplateInterpreter.getFixtureTemplate(
expectedTemplateInterpreter.assertExpectedOutput(
"handles-continue-in-deferred-for-loop/test"
);
interpreter.render(input);
// We don't support this yet
assertThat(interpreter.getContext().getDeferredNodes()).isNotEmpty();
}

@Test
public void itHandlesContinueInDeferredForLoopSecondPass() {
localContext.put("deferred", List.of(0, 1, 2, 3, 4, 5));
expectedTemplateInterpreter.assertExpectedOutput(
"handles-continue-in-deferred-for-loop/test.expected"
);
expectedTemplateInterpreter.assertExpectedNonEagerOutput(
"handles-continue-in-deferred-for-loop/test.expected"
);
}

@Test
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Start loop
i is: 0
i is: 1
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Start loop
{% for i in deferred %}\
{% if i > 1 %}\
{% break '' %}\
{% endif %}\
i is: {{ i }}
{% endfor %}\
End loop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Start loop
{% for i in deferred %}
{% if i %}
{% break %}
{% endif %}
{% for i in deferred -%}
{% if i > 1 -%}
{% break -%}
{% endif -%}
i is: {{ i }}
{% endfor %}
{% endfor -%}
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Start loop
i is: 1
i is: 3
i is: 5
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Start loop
{% for i in deferred %}\
{% if i % 2 == 0 %}\
{% continue '' %}\
{% endif %}\
i is: {{ i }}
{% endfor %}\
End loop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Start loop
{% for i in deferred %}
{% if i %}
{% continue %}
{% endif %}
{% for i in deferred -%}
{% if i % 2 == 0 -%}
{% continue -%}
{% endif -%}
i is: {{ i }}
{% endfor %}
{% endfor -%}
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Start loop
i is: 0
i is: 1
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Start loop
{% for __ignored__ in [0] %}\
{% if 0 > deferred %}\
{% break '' %}\
{% endif %}\
i is: 0
{% if 1 > deferred %}\
{% break '' %}\
{% endif %}\
i is: 1
{% if 2 > deferred %}\
{% break '' %}\
{% endif %}\
i is: 2
{% if 3 > deferred %}\
{% break '' %}\
{% endif %}\
i is: 3
{% if 4 > deferred %}\
{% break '' %}\
{% endif %}\
i is: 4
{% endfor %}\
End loop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Start loop
{% for i in range(5) %}
{% if deferred %}
{% break %}
{% endif %}
{% for i in range(5) -%}
{% if i > deferred -%}
{% break -%}
{% endif -%}
i is: {{ i }}
{% endfor %}
{% endfor -%}
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Start loop
i is: 1
i is: 3
End loop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Start loop
{% for i in [0, 1, 2, 3, 4] %}\
{% if i % deferred == 0 %}\
{% continue '' %}\
{% endif %}\
i is: {{ i }}
{% endfor %}\
End loop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Start loop
{% for i in range(5) %}
{% if deferred %}
{% continue %}
{% endif %}
{% for i in range(5) -%}
{% if i % deferred == 0 -%}
{% continue -%}
{% endif -%}
i is: {{ i }}
{% endfor %}
{% endfor -%}
End loop