From eab2f4b0566b4c76db661cbfa99a56a6bf8d6541 Mon Sep 17 00:00:00 2001
From: philippeitis <33013301+philippeitis@users.noreply.github.com>
Date: Sun, 8 Mar 2020 13:20:38 -0700
Subject: [PATCH] Move core magic() logic into seperate function for
 testability, minor tweaks.

We only care about the command when testing magic() - by moving that out, we can easily test the command. I modified the code to return a boolean signalling that the command is valid, and the command itself to maintain the original functionality.

I also made some small tweaks (removed a list() call, fixed a possible bug with no arguments., moved magic_dict instantiation past the fast path checks to avoid making a dict if not needed.)
---
 jc/cli.py | 52 +++++++++++++++++++++++++++++++++-------------------
 1 file changed, 33 insertions(+), 19 deletions(-)

diff --git a/jc/cli.py b/jc/cli.py
index a5b1af01..aebf829b 100644
--- a/jc/cli.py
+++ b/jc/cli.py
@@ -183,18 +183,15 @@ def json_out(data, pretty=False):
         print(json.dumps(data))
 
 
-def magic():
-    """Parse with magic syntax: jc -p ls -al"""
+def generate_magic_command():
+    """
+    Returns a tuple with a boolean and a command, where the boolean signifies that
+    the command is valid, and the command is either a command string or None.
+    """
+    
+    # Parse with magic syntax: jc -p ls -al
     if len(sys.argv) <= 1 or sys.argv[1].startswith('--'):
-        return
-
-    magic_dict = {}
-    parser_info = about_jc()['parsers']
-
-    # Create a dictionary of magic_commands to their respective parsers.
-    for entry in parser_info:
-        # Update the dict with all of the magic commands for this parser, if they exist.
-        magic_dict.update({mc: entry['argument'] for mc in entry.get('magic_commands', [])})
+        return False, None
 
     # correctly parse escape characters and spaces with shlex
     args_given = " ".join(map(shlex.quote, sys.argv[1:])).split()
@@ -202,10 +199,10 @@ def magic():
 
     # find the options
     popped = 0
-    for i, arg in list(enumerate(args_given)):
+    for i, arg in enumerate(args_given):
         # parser found - use standard syntax
         if arg.startswith('--'):
-            return
+            return False, None
 
         # option found - populate option list
         elif arg.startswith('-'):
@@ -218,7 +215,15 @@ def magic():
 
     # all options popped and no command found - for case like 'jc -a'
     if len(args_given) == 0:
-        return
+        return False, None
+
+    magic_dict = {}
+    parser_info = about_jc()['parsers']
+
+    # Create a dictionary of magic_commands to their respective parsers.
+    for entry in parser_info:
+        # Update the dict with all of the magic commands for this parser, if they exist.
+        magic_dict.update({mc: entry['argument'] for mc in entry.get('magic_commands', [])})
 
     # find the command and parser
     one_word_command = args_given[0]
@@ -230,11 +235,19 @@ def magic():
     # construct a new command line using the standard syntax: COMMAND | jc --PARSER -OPTIONS
     run_command = ' '.join(args_given)
     if found_parser:
-        cmd_options = '-' + ''.join(options) if options else ''
-        whole_command = ' '.join([run_command, '|', 'jc', found_parser, cmd_options])
-        os.system(whole_command)
-        exit()
+        cmd_options = ('-' + ''.join(options)) if options else ''
+        return True, ' '.join([run_command, '|', 'jc', found_parser, cmd_options])
+    else:
+        return False, run_command
 
+
+def magic():
+    valid_command, run_command = generate_magic_command()
+    if valid_command:
+        os.system(run_command)
+        exit()
+    elif run_command is None:
+        return
     else:
         helptext(f'parser not found for "{run_command}"')
         sys.exit(1)
@@ -293,7 +306,8 @@ def main():
                     found = True
                     break
                 except Exception:
-                    jc.utils.error_message(f'{parser_name} parser could not parse the input data. Did you use the correct parser?\n         For details use the -d option.')
+                    jc.utils.error_message(
+                        f'{parser_name} parser could not parse the input data. Did you use the correct parser?\n         For details use the -d option.')
                     sys.exit(1)
 
     if not found: