Merge pull request #154 from metafacture/153-makeSubstringCompatible

Change `substring()` Fix function to be compatible with Catmandu.

Author: blackwinter

README.md

@@ -485,10 +485,10 @@ split_field("<sourceField>", "<separator>")
 
 #### `substring`
 
-Replaces a string with its substring as defined by the start and end positions.
+Replaces a string with its substring as defined by the start position (offset) and length.
 
 ```perl
-substring("<sourceField>", "<startPosition>", "<endPosition>")
+substring("<sourceField>", "<startPosition>", "<length>")
 ```
 
 #### `sum`

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

@@ -458,7 +458,14 @@ public void apply(final Metafix metafix, final Record record, final List<String>
     substring {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            new FixPath(params.get(0)).transformIn(record, s -> s.substring(getInteger(params, 1), getInteger(params, 2) - 1));
+            final int offset = getInteger(params, 1);
+            final Integer end = params.size() > 2 ? offset + getInteger(params, 2) : null;
+            // TODO: final String replacement = params.size() > 3 ? params.get(3) : null;
+
+            new FixPath(params.get(0)).transformIn(record, s -> {
+                final int length = s.length();
+                return offset > length ? s : end == null || end > length ? s.substring(offset) : s.substring(offset, end);
+            });
         }
     },
     sum {

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

@@ -179,16 +179,70 @@ public void shouldNotCapitalizeArray() {
     @Test
     public void shouldGetSubstringOfString() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
-                "substring('title', '0', '2')"
+                "substring('rel', '5', '3')"
             ),
             i -> {
                 i.startRecord("1");
-                i.literal("title", "marc");
+                i.literal("rel", "grandson");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("rel", "son");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldGetSubstringOfStringWithoutLength() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "substring('rel', '5')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("rel", "grandson");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("rel", "son");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldGetSubstringOfTruncatedString() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "substring('rel', '5', '6')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("rel", "grandson");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("rel", "son");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldNotGetSubstringOutsideOfString() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "substring('rel', '9', '3')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("rel", "grandson");
                 i.endRecord();
             },
             o -> {
                 o.get().startRecord("1");
-                o.get().literal("title", "m");
+                o.get().literal("rel", "grandson");
                 o.get().endRecord();
             }
         );
@@ -197,17 +251,17 @@ public void shouldGetSubstringOfString() {
     @Test
     public void shouldGetSubstringWithVar() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
-                "substring('title', '0', '$[end]')"
+                "substring('rel', '0', '$[length]')"
             ),
-            ImmutableMap.of("end", "3"),
+            ImmutableMap.of("length", "5"),
             i -> {
                 i.startRecord("1");
-                i.literal("title", "marc");
+                i.literal("rel", "grandson");
                 i.endRecord();
             },
             o -> {
                 o.get().startRecord("1");
-                o.get().literal("title", "ma");
+                o.get().literal("rel", "grand");
                 o.get().endRecord();
             }
         );

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringJustStart/expected.json

@@ -0,0 +1 @@
+{"key":"cat"}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringJustStart/input.json

@@ -0,0 +1 @@
+{"key":"tacocat"}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringJustStart/test.fix

@@ -0,0 +1 @@
+substring("key", "4")

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringJustStart/test.flux

@@ -0,0 +1,8 @@
+FLUX_DIR + "input.json"
+|open-file
+|as-records
+|decode-json
+|fix(FLUX_DIR + "test.fix")
+|encode-json
+|write(FLUX_DIR + "output-metafix.json")
+;

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringStartLength/expected.json

@@ -0,0 +1 @@
+{"key":"taco"}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringStartLength/input.json

@@ -0,0 +1 @@
+{"key":"tacocat"}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/substringStartLength/test.fix

@@ -0,0 +1 @@
+substring("key", "0", "4")