Modify command name #41

  * Change '-a/--all' to '-a/--all-delta-types'.
  * Add default of False to this parameter in 'write_csv()',
    'write_json()' and 'utils.deltas()'.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>

Author: johnmhoran

src/deltacode/cli.py

@@ -39,7 +39,7 @@
 
 
 # FIXME: update the function argument delta to deltacode
-def write_csv(delta, result_file, all):
+def write_csv(delta, result_file, all_delta_types=False):
     """
     Using the DeltaCode object, create a .csv file
     containing the primary information from the Delta objects.  Omit all Delta
@@ -57,13 +57,13 @@ def write_csv(delta, result_file, all):
             f.old_file.size if f.category == 'removed' else f.new_file.size,
             f.old_file.path if f.category == 'moved' else '')
                 for d in delta.deltas for f in delta.deltas.get(d)]:
-                    if all is True:
+                    if all_delta_types is True:
                         csv_out.writerow(row)
                     elif row[0] != 'unmodified':
                         csv_out.writerow(row)
 
 
-def write_json(deltacode, outfile, all):
+def write_json(deltacode, outfile, all_delta_types=False):
     """
     Using the DeltaCode object, create a .json file
     containing the primary information from the Delta objects.  Omit all Delta
@@ -73,7 +73,7 @@ def write_json(deltacode, outfile, all):
     results = OrderedDict([
         ('deltacode_version', __version__),
         ('deltacode_stats', deltacode.get_stats()),
-        ('deltas', deltas(deltacode, all)),
+        ('deltas', deltas(deltacode, all_delta_types)),
     ])
 
     # TODO: add toggle for pretty printing
@@ -87,8 +87,8 @@ def write_json(deltacode, outfile, all):
 @click.option('-o', '--old', required=True, prompt=False, type=click.Path(exists=True, readable=True), help='Identify the path to the "old" scan file')
 @click.option('-c', '--csv-file', prompt=False, type=click.Path(exists=False), help='Identify the path to the .csv output file')
 @click.option('-j', '--json-file', prompt=False, default='-', type=click.File(mode='wb', lazy=False), help='Identify the path to the .json output file')
-@click.option('-a', '--all', is_flag=True, help="Include unmodified files as well as all changed files in the .json or .csv output.  If not selected, only changed files are included.")
-def cli(new, old, csv_file, json_file, all):
+@click.option('-a', '--all-delta-types', is_flag=True, help="Include unmodified files as well as all changed files in the .json or .csv output.  If not selected, only changed files are included.")
+def cli(new, old, csv_file, json_file, all_delta_types):
     """
     Identify the changes that need to be made to the 'old'
     scan file (-o or -old) in order to generate the 'new' scan file (-n or
@@ -101,7 +101,7 @@ def cli(new, old, csv_file, json_file, all):
 
     # output to csv
     if csv_file:
-        write_csv(deltacode, csv_file, all)
+        write_csv(deltacode, csv_file, all_delta_types)
     # generate JSON output
     else:
-        write_json(deltacode, json_file, all)
+        write_json(deltacode, json_file, all_delta_types)

src/deltacode/utils.py

@@ -31,15 +31,15 @@
 from commoncode import paths
 
 
-def deltas(deltacode, all):
+def deltas(deltacode, all_delta_types=False):
     """
     Return a generator of Delta dictionaries for JSON serialized ouput.  Omit
     all Delta objects whose 'category' is 'unmodified' unless the user selects
     the '-a'/'--all' option.
     """
     for category, deltas in deltacode.deltas.iteritems():
         for delta in deltas:
-            if all is True:
+            if all_delta_types is True:
                 yield delta.to_dict()
             elif delta.category != 'unmodified':
                 yield delta.to_dict()