add wc parser

jc/parsers/wc.py

@@ -0,0 +1,130 @@
+"""jc - JSON CLI output utility `wc` command output parser
+
+Usage (cli):
+
+    $ wc file.txt | jc --wc
+
+    or
+
+    $ jc wc file.txt
+
+Usage (module):
+
+    import jc.parsers.wc
+    result = jc.parsers.wc.parse(wc_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ wc * | jc --wc -p
+    [
+      {
+        "filename": "airport-I.json",
+        "lines": 1,
+        "words": 30,
+        "characters": 307
+      },
+      {
+        "filename": "airport-I.out",
+        "lines": 15,
+        "words": 33,
+        "characters": 348
+      },
+      {
+        "filename": "airport-s.json",
+        "lines": 1,
+        "words": 202,
+        "characters": 2152
+      },
+      ...
+    ]
+"""
+import jc.utils
+
+
+class info():
+    version = '1.0'
+    description = 'wc command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    details = 'Parses wc and sum program output'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']
+    magic_commands = ['wc', 'sum']
+
+
+__version__ = info.version
+
+
+def process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (dictionary) raw structured data to process
+
+    Returns:
+
+        List of dictionaries. Structured data with the following schema:
+
+        [
+          {
+            "filename":     string,
+            "lines":        integer,
+            "words":        integer,
+            "characters":   integer
+          }
+        ]
+    """
+
+    for entry in proc_data:
+        int_list = ['lines', 'words', 'characters']
+        for key in int_list:
+            if key in entry:
+                try:
+                    entry[key] = int(entry[key])
+                except (ValueError):
+                    entry[key] = None
+    return proc_data
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of dictionaries. Raw or processed structured data.
+    """
+    if not quiet:
+        jc.utils.compatibility(__name__, info.compatible)
+
+    raw_output = []
+
+    if jc.utils.has_data(data):
+
+        for line in filter(None, data.splitlines()):
+            split_line = line.split(maxsplit=3)
+            item = {
+                'filename': split_line[3] if len(split_line) == 4 else None,
+                'lines': split_line[0],
+                'words': split_line[1],
+                'characters': split_line[2]
+            }
+            raw_output.append(item)
+
+    if raw:
+        return raw_output
+    else:
+        return process(raw_output)