feat: implement parse.map for mapping RIS tags to human-friendly names

Makefile

@@ -12,6 +12,14 @@ parse: grammar.js
 grammar.js: grammar.ne lexer.js
 	yarn -s nearleyc $^ > $@
 
+# Output Markdown table for all possible types
+markdown-type:
+	@jq -M -S -r -f doc/type.jq type-map.json | awk -F"," -f doc/type.awk
+
+# Output Markdown table for the tag map
+markdown-tag:
+	@jq -M -S -r -f doc/tag.jq tag-map.json | awk -F"," -f doc/tag.awk
+
 /tmp/ris.test: grammar.js index.js ris-parser.feature steps.js
 	yarn cucumber-js --require steps.js ris-parser.feature
 	touch $@

doc/tag.awk

@@ -0,0 +1,21 @@
+NR == 1 {
+  printf "|"
+  for (i=1; i<NF; i=i+1) { printf "%s|", $i }
+  printf "\n"
+  printf "|"
+  for (i=1; i<NF; i=i+1) { printf ":--|", $i }
+  printf "\n"
+  next
+}
+
+{
+  printf "|"
+  for (i=1; i<NF; i=i+1) {
+    if ($i == "N/A") {
+      printf "_%s_|", $i
+    } else {
+      printf "%s|", $i
+    }
+  }
+  printf "\n"
+}

doc/tag.jq

@@ -0,0 +1,10 @@
+  (to_entries | map(.key | split(".") | last) | unique) as $all_tags
+| to_entries
+| group_by(.key | split(".") | first)
+| map(reduce .[] as $item ({}; . + { TY: ($item.key | split(".") | first)
+                                   , ($item.key | split(".") | last): $item.value
+                                   }))
+| sort_by(.TY)
+| ([["Type", "TY"] + $all_tags]) + map([.TY, "@type"] + (. as $format | ($all_tags | map($format[.] // "N/A"))))
+| map(join(","))
+| join("\n")

doc/type.awk

@@ -0,0 +1,18 @@
+# INPUT
+#   A,1
+#   B,2
+#
+# OUTPUT
+#   | TY | Description |
+#   |:---|:------------|
+#   | A  | 1           |
+#   | B  | 2           |
+
+
+BEGIN {
+  print "| TY | Description |"
+  print "|:---|:------------|"
+}
+{
+  print "|" $1 "|" $2 "|"
+}

doc/type.jq

@@ -0,0 +1,7 @@
+# INPUT
+#   {"A": "1", "B": "2"}
+# OUTPUT
+#   "A,1"
+#   "B,2"
+
+to_entries | map("\(.key),\(.value)") | join("\n")

index.js

@@ -4,6 +4,8 @@
 
 const nearley = require('nearley');
 const grammar = require('./grammar.js');
+const type_map = require('./type-map.json');
+const tag_map = require('./tag-map.json');
 
 const zip =
   (keys, values) =>
@@ -157,4 +159,15 @@ const parse = text => {
   return process_ast(parser.results[0]);
 };
 
+parse.map = text => {
+  const parsed = parse(text);
+  return parsed.map(
+    p => Object.keys(p).reduce(
+      (mapped, key) => {
+        const new_key = tag_map[`${p.TY}.${key}`] || (key === 'TY' ? '@type' : key);
+        mapped[new_key] = new_key !== '@type' ? p[key] : type_map[p.TY];
+        return mapped;
+      }, {}));
+};
+
 module.exports = parse;

package.json

@@ -12,7 +12,9 @@
   "files": [
     "index.js",
     "grammar.js",
-    "lexer.js"
+    "lexer.js",
+    "tag-map.json",
+    "type-map.json"
   ],
   "dependencies": {
     "moo": "^0.5.1",

ris-parser.feature

@@ -286,3 +286,14 @@ Scenario Outline: Samples
   Examples:
     | ris    | response |
     | 01.ris | 01.json  |
+
+Scenario: Remapping tags
+  Given I have this RIS file
+    """
+    TY  - JOUR
+    AB  - this is my abstract
+    ER  - 
+    """
+  When I parse the file and rename the tags
+  Then I will find a reference where '@type' is set to 'Journal'
+  Then I will find a reference where 'abstract' is set to 'this is my abstract'

steps.js

@@ -16,6 +16,10 @@ defineStep('I parse the file', function () {
   this.list = sut(this.file);
 });
 
+defineStep('I parse the file and rename the tags', function () {
+  this.list = sut.map(this.file);
+});
+
 defineStep('I will get a list of {int} reference(s)', function (count) {
   assert.equal(this.list.length, count);
 });