Merge pull request #245 from metafacture/passIncludeOptionsAsVariables

Pass `include()` options as variables.

Author: blackwinter

README.md

@@ -153,7 +153,19 @@ You can use path wildcards to select fields matching a pattern. They only match
 
 ##### `include`
 
----- TODO: THIS NEEDS MORE CONTENT -----
+Includes a Fix file and executes it as if its statements were written in place of the function call.
+
+Parameters:
+
+- `path` (required): Path to Fix file (if the path starts with a `.`, it is resolved relative to the including file's directory; otherwise, it is resolved relative to the current working directory).
+
+Options:
+
+- All options are made available as "dynamic" local variables in the included Fix file.
+
+```perl
+include("<path>"[, <dynamicLocalVariables>...])
+```
 
 ##### `nothing`
 

metafix/src/main/java/org/metafacture/metafix/FixMethod.java

@@ -57,7 +57,7 @@ public void apply(final Metafix metafix, final Record record, final List<String>
             // TODO: Catmandu load path
             final String includePath = metafix.resolvePath(includeFile);
 
-            metafix.getRecordTransformer(includePath).transform(record);
+            metafix.getRecordTransformer(includePath).transform(record, options);
         }
     },
     nothing {

metafix/src/test/java/org/metafacture/metafix/MetafixScriptTest.java

@@ -233,6 +233,50 @@ public void shouldIncludeFixFile() {
         );
     }
 
+    @Test
+    public void shouldIncludeFixFileWithVariables() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "include('src/test/resources/org/metafacture/metafix/fixes/vars.fix', a: '1', b: '23')",
+                "include('src/test/resources/org/metafacture/metafix/fixes/vars.fix', a: '2', b: '42')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.endRecord();
+
+                i.startRecord("2");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("test1", "1-23");
+                o.get().literal("test2", "1-42");
+                o.get().endRecord();
+
+                o.get().startRecord("2");
+                o.get().literal("test1", "2-23");
+                o.get().literal("test2", "2-42");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldNotLeakVariablesFromIncludingFixFile() {
+        MetafixTestHelpers.assertProcessException(IllegalArgumentException.class, "Variable 'a' was not assigned!\nAssigned variables:\n{}", () ->
+            MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                    "include('src/test/resources/org/metafacture/metafix/fixes/vars.fix', a: '1', b: '23')",
+                    "add_field('vars', '$[a]-$[b]')"
+                ),
+                i -> {
+                    i.startRecord("1");
+                    i.endRecord();
+                },
+                o -> {
+                }
+            )
+        );
+    }
+
     @Test
     public void shouldIncludeFixFileInBind() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(

metafix/src/test/resources/org/metafacture/metafix/fixes/vars.fix

@@ -0,0 +1 @@
+paste("test$[a]", "_id", "~$[b]", join_char: "-")