Rename debug_record() Fix function to print_record(). (#238)

Author: blackwinter

README.md

@@ -242,37 +242,6 @@ Copies (or appends to) a field from an existing field.
 copy_field("<sourceField>", "<targetField>")
 ```
 
-##### `debug_record`
-
-Prints the current record either to standard output or to a file.
-
-Parameters:
-
-- `prefix` (optional): Prefix to print before the record. (Default: Empty string)
-
-Options:
-
-- `compression` (file output only): Compression mode. (Default: `auto`)
-- `destination`: Destination to write the record to; may include [format directives](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html#syntax) for counter and record ID (in that order). (Default: `stdout`)
-- `encoding` (file output only): Encoding used by the underlying writer. (Default: `UTF-8`)
-- `footer`: Footer which is output after the record. (Default: `\n`)
-- `header`: Header which is output before the record. (Default: Empty string)
-- `id`: Field name which contains the record ID; if found, will be included before the prefix. (Default: `_id`)
-- `json`: Whether to encode the record as JSON. (Default: `false`)
-- `pretty`: Whether to use pretty printing. (Default: `false`)
-
-```perl
-debug_record(["<prefix>"][, <options>...])
-```
-
-E.g.:
-
-```perl
-debug_record("Before transformation")
-debug_record(destination: "record-%03d.gz", header: "After transformation: ")
-debug_record(destination: "record-%2$s.json", id: "001", json: "true", pretty: "true")
-```
-
 ##### `format`
 
 Replaces the value with a formatted (`sprintf`-like) version.
@@ -336,6 +305,37 @@ paste("my.string", "~Hi", "a", "~how are you?")
 # "my.string": "Hi eeny how are you?"
 ```
 
+##### `print_record`
+
+Prints the current record either to standard output or to a file.
+
+Parameters:
+
+- `prefix` (optional): Prefix to print before the record. (Default: Empty string)
+
+Options:
+
+- `compression` (file output only): Compression mode. (Default: `auto`)
+- `destination`: Destination to write the record to; may include [format directives](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html#syntax) for counter and record ID (in that order). (Default: `stdout`)
+- `encoding` (file output only): Encoding used by the underlying writer. (Default: `UTF-8`)
+- `footer`: Footer which is output after the record. (Default: `\n`)
+- `header`: Header which is output before the record. (Default: Empty string)
+- `id`: Field name which contains the record ID; if found, will be included before the prefix. (Default: `_id`)
+- `json`: Whether to encode the record as JSON. (Default: `false`)
+- `pretty`: Whether to use pretty printing. (Default: `false`)
+
+```perl
+print_record(["<prefix>"][, <options>...])
+```
+
+E.g.:
+
+```perl
+print_record("Before transformation")
+print_record(destination: "record-%03d.gz", header: "After transformation: ")
+print_record(destination: "record-%2$s.json", id: "001", json: "true", pretty: "true")
+```
+
 ##### `random`
 
 Creates (or replaces) a field with a random number (less than the specified maximum).

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

@@ -131,53 +131,6 @@ public void apply(final Metafix metafix, final Record record, final List<String>
             }));
         }
     },
-    debug_record {
-        private final Map<Metafix, LongAdder> scopedCounter = new HashMap<>();
-
-        @Override
-        public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            final String destination = options.getOrDefault("destination", ObjectWriter.STDOUT);
-            final Value idValue = record.get(options.getOrDefault("id", StandardEventNames.ID));
-
-            final boolean json = getBoolean(options, "json");
-            final boolean pretty = getBoolean(options, "pretty");
-
-            final String id = Value.isNull(idValue) ? "" : idValue.toString();
-            final String prefix = (id.isEmpty() ? "" : "[" + id + "] ") + (params.isEmpty() ? "" : params.get(0) + ": ");
-
-            final LongAdder counter = scopedCounter.computeIfAbsent(metafix, k -> new LongAdder());
-            counter.increment();
-
-            final ObjectWriter<String> writer = new ObjectWriter<>(String.format(destination, counter.sum(), id));
-
-            withOption(options, "compression", writer::setCompression);
-            withOption(options, "encoding", writer::setEncoding);
-            withOption(options, "footer", writer::setFooter);
-            withOption(options, "header", writer::setHeader);
-
-            boolean written = false;
-
-            if (json) {
-                try {
-                    writer.process(prefix + record.toJson(pretty));
-                    written = true;
-                }
-                catch (final IOException e) {
-                }
-            }
-
-            if (!written) {
-                if (pretty) {
-                    record.forEach((f, v) -> writer.process(prefix + f + "=" + v));
-                }
-                else {
-                    writer.process(prefix + record);
-                }
-            }
-
-            writer.closeStream();
-        }
-    },
     format {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
@@ -261,6 +214,53 @@ private boolean literalString(final String s) {
             return s.startsWith("~");
         }
     },
+    print_record {
+        private final Map<Metafix, LongAdder> scopedCounter = new HashMap<>();
+
+        @Override
+        public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
+            final String destination = options.getOrDefault("destination", ObjectWriter.STDOUT);
+            final Value idValue = record.get(options.getOrDefault("id", StandardEventNames.ID));
+
+            final boolean json = getBoolean(options, "json");
+            final boolean pretty = getBoolean(options, "pretty");
+
+            final String id = Value.isNull(idValue) ? "" : idValue.toString();
+            final String prefix = (id.isEmpty() ? "" : "[" + id + "] ") + (params.isEmpty() ? "" : params.get(0) + ": ");
+
+            final LongAdder counter = scopedCounter.computeIfAbsent(metafix, k -> new LongAdder());
+            counter.increment();
+
+            final ObjectWriter<String> writer = new ObjectWriter<>(String.format(destination, counter.sum(), id));
+
+            withOption(options, "compression", writer::setCompression);
+            withOption(options, "encoding", writer::setEncoding);
+            withOption(options, "footer", writer::setFooter);
+            withOption(options, "header", writer::setHeader);
+
+            boolean written = false;
+
+            if (json) {
+                try {
+                    writer.process(prefix + record.toJson(pretty));
+                    written = true;
+                }
+                catch (final IOException e) {
+                }
+            }
+
+            if (!written) {
+                if (pretty) {
+                    record.forEach((f, v) -> writer.process(prefix + f + "=" + v));
+                }
+                else {
+                    writer.process(prefix + record);
+                }
+            }
+
+            writer.closeStream();
+        }
+    },
     random {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {