Merge pull request #1208 from HubSpot/construct-eager-macro-functions

Construct EagerMacroFunction when aliasing macro function from {% from %} tag

Author: jasmith-hs

src/main/java/com/hubspot/jinjava/lib/fn/MacroFunction.java

@@ -207,6 +207,10 @@ public int hashCode() {
     );
   }
 
+  public MacroFunction cloneWithNewName(String name) {
+    return new MacroFunction(this, name);
+  }
+
   private boolean alreadyDeferredInEarlierCall(
     String key,
     JinjavaInterpreter interpreter

src/main/java/com/hubspot/jinjava/lib/fn/eager/EagerMacroFunction.java

@@ -58,6 +58,10 @@ public EagerMacroFunction(
     );
   }
 
+  EagerMacroFunction(MacroFunction source, String name) {
+    super(source, name);
+  }
+
   public Object doEvaluate(
     Map<String, Object> argMap,
     Map<String, Object> kwargMap,
@@ -340,4 +344,9 @@ public boolean equals(Object o) {
   public int hashCode() {
     return super.hashCode();
   }
+
+  @Override
+  public EagerMacroFunction cloneWithNewName(String name) {
+    return new EagerMacroFunction(this, name);
+  }
 }

src/main/java/com/hubspot/jinjava/lib/tag/FromTag.java

@@ -170,7 +170,7 @@ public static boolean integrateChild(
       if (val != null) {
         MacroFunction toImport = (MacroFunction) val;
         if (!importMapping.getKey().equals(importMapping.getValue())) {
-          toImport = new MacroFunction(toImport, importMapping.getValue());
+          toImport = toImport.cloneWithNewName(importMapping.getValue());
         }
         interpreter.getContext().addGlobalMacro(toImport);
       } else {

src/main/java/com/hubspot/jinjava/lib/tag/eager/EagerCallTag.java

@@ -7,6 +7,7 @@
 import com.hubspot.jinjava.interpret.JinjavaInterpreter.InterpreterScopeClosable;
 import com.hubspot.jinjava.lib.expression.EagerExpressionStrategy;
 import com.hubspot.jinjava.lib.fn.MacroFunction;
+import com.hubspot.jinjava.lib.fn.eager.EagerMacroFunction;
 import com.hubspot.jinjava.lib.tag.CallTag;
 import com.hubspot.jinjava.lib.tag.FlexibleTag;
 import com.hubspot.jinjava.tree.TagNode;
@@ -45,7 +46,7 @@ public String eagerInterpret(
     LengthLimitingStringJoiner joiner;
     try (InterpreterScopeClosable c = interpreter.enterNonStackingScope()) {
       caller =
-        new MacroFunction(
+        new EagerMacroFunction(
           tagNode.getChildren(),
           "caller",
           new LinkedHashMap<>(),

src/main/java/com/hubspot/jinjava/lib/tag/eager/EagerFromTag.java

@@ -6,6 +6,7 @@
 import com.hubspot.jinjava.interpret.InterpretException;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import com.hubspot.jinjava.lib.fn.MacroFunction;
+import com.hubspot.jinjava.lib.fn.eager.EagerMacroFunction;
 import com.hubspot.jinjava.lib.tag.DoTag;
 import com.hubspot.jinjava.lib.tag.FromTag;
 import com.hubspot.jinjava.loader.RelativePathResolver;
@@ -41,7 +42,7 @@ public String getEagerTagImage(TagToken tagToken, JinjavaInterpreter interpreter
       imports
         .values()
         .forEach(value -> {
-          MacroFunction deferredMacro = new MacroFunction(
+          MacroFunction deferredMacro = new EagerMacroFunction(
             null,
             value,
             null,

src/test/java/com/hubspot/jinjava/EagerTest.java

@@ -1664,4 +1664,9 @@ public void itHandlesDeferredContinueInForLoop() {
     // We don't support this yet
     assertThat(interpreter.getContext().getDeferredNodes()).isNotEmpty();
   }
+
+  @Test
+  public void itReconstructsFromedMacro() {
+    expectedTemplateInterpreter.assertExpectedOutput("reconstructs-fromed-macro/test");
+  }
 }

src/test/resources/eager/defers-caller/test.expected.jinja

@@ -1,4 +1,6 @@
 {% for __ignored__ in [0] %}\
 Jack says:
+{% for __ignored__ in [0] %}\
 How do I get a {{ deferred }}\
-?{% endfor %}
+?{% endfor %}\
+{% endfor %}

src/test/resources/eager/handles-deferred-from-import-as/test.expected.jinja

@@ -6,5 +6,7 @@ Hello {{ myname }}\
 {% endfor %}
 {% set from_bar = bar %}\
 {% enddo %}\
-from_foo: Hello {{ myname }}
+from_foo: {% for __ignored__ in [0] %}\
+Hello {{ myname }}\
+{% endfor %}
 from_bar: {{ from_bar }}

src/test/resources/eager/handles-deferred-modification-in-caller/test.expected.jinja

@@ -1,7 +1,10 @@
 {% set my_list = ['a', 'b'] %}\
 {% set __macro_callerino_729568755_temp_variable_0__ %}\
+{% set __macro_caller_172086791_temp_variable_0__ %}\
 {% do my_list.append(deferred) %}\
 {{ my_list }}\
+{% endset %}\
+{{ __macro_caller_172086791_temp_variable_0__ }}\
 {% do my_list.append('d') %}\
 {% endset %}\
 {% call __macro_callerino_729568755_temp_variable_0__ %}\

src/test/resources/eager/reconstructs-fromed-macro/has-macro.jinja

@@ -0,0 +1,3 @@
+{% macro upper(param) %}
+ {{ param|upper }}
+{% endmacro %}