Fixed #139 - Custom key name for the inventory output

 * Added a `--mapping-output` option

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

USAGE.rst

@@ -267,6 +267,8 @@ inventory
     --mapping                   Use file mapping.config to collect the defined not supported fields in ABOUT files.
     --mapping-file              Use a custom mapping file with mapping between input
                                 keys and ABOUT field names.
+    --mapping-output FILE       Use a custom mapping file with mapping between
+                                ABOUT field names and output keys
     --verbose                   Show all the errors and warning.
     -q, --quiet                 Do not print any error/warning.
     -h, --help                  Show this message and exit.
@@ -304,6 +306,18 @@ Options
 
     $ about inventory --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
 
+    --mapping-output
+
+        Same behavior as `--mapping-file` but with custom mapping file
+        In the custom mapping file, the left side is the custom key name where
+        the right side is the ABOUT field name. For instance,
+        Component: name
+        
+        The "Component" is a custom field name for the output
+        The "name" is one of the defaul ABOUT field name that user want to convert
+
+    $ about inventory --mapping-output CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
+
     --verbose
 
         This option tells the tool to show all errors found.

docs/CHANGELOG.rst

@@ -7,7 +7,7 @@
     * `check` command will not counted INFO message as error when `--verbose` is set
     * Update `track_change` to `track_changes`
     * Add support for `author_file`
-    * New `--filter` option for `inventory`
+    * New `--filter` and `--mapping-output` options for `inventory`
 
 2018-6-25
 

src/attributecode/cmd.py

@@ -123,6 +123,10 @@ def cli():
     type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
     help='Use a custom mapping file with mapping between input keys and ABOUT field names.')
 
+@click.option('--mapping-output', metavar='FILE', nargs=1,
+    type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
+    help='Use a custom mapping file with mapping between ABOUT field names and output keys')
+
 @click.option('--verbose', is_flag=True, default=False,
     help='Show all errors and warnings. '
         'By default, the tool only prints these '
@@ -136,7 +140,7 @@ def cli():
 
 @click.help_option('-h', '--help')
 
-def inventory(location, output, mapping, mapping_file, filter, quiet, format, verbose):
+def inventory(location, output, mapping, mapping_file, mapping_output, filter, quiet, format, verbose):
     """
 Collect a JSON or CSV inventory of components from .ABOUT files.
 
@@ -186,7 +190,7 @@ def inventory(location, output, mapping, mapping_file, filter, quiet, format, ve
             break
 
     if not halt_output:
-        write_errors = model.write_output(updated_abouts, output, format)
+        write_errors = model.write_output(updated_abouts, output, format, mapping_output)
         for err in write_errors:
             errors.append(err)
     else:

src/attributecode/model.py

@@ -1300,27 +1300,35 @@ def about_object_to_list_of_dictionary(abouts, with_absent=False, with_empty=Tru
     return abouts_dictionary_list
 
 
-def write_output(abouts, location, format, with_absent=False, with_empty=True):
+def write_output(abouts, location, format, mapping_output=None, with_absent=False, with_empty=True):
     """
     Write a CSV/JSON file at location given a list of About objects
     """
     errors = []
     about_dictionary_list = about_object_to_list_of_dictionary(abouts, with_absent, with_empty)
+    if mapping_output:
+        updated_dictionary_list = util.update_about_dictionary_keys(about_dictionary_list, mapping_output)
+    else:
+        updated_dictionary_list = about_dictionary_list
     location = add_unc(location)
     with codecs.open(location, mode='wb', encoding='utf-8') as output_file:
         if format == 'csv':
             fieldnames = field_names(abouts)
-            writer = csv.DictWriter(output_file, fieldnames)
+            if mapping_output:
+                updated_fieldnames = util.update_fieldnames(fieldnames, mapping_output)
+            else:
+                updated_fieldnames = fieldnames
+            writer = csv.DictWriter(output_file, updated_fieldnames)
             writer.writeheader()
-            for row in about_dictionary_list:
+            for row in updated_dictionary_list:
                 # See https://github.com/dejacode/about-code-tool/issues/167
                 try:
                     writer.writerow(row)
                 except Exception as e:
                     msg = u'Generation skipped for ' + row['about_file_path'] + u' : ' + str(e)
                     errors.append(Error(CRITICAL, msg))
         else:
-            output_file.write(json.dumps(about_dictionary_list, indent=2))
+            output_file.write(json.dumps(updated_dictionary_list, indent=2))
     return errors
 
 

src/attributecode/util.py

@@ -321,6 +321,35 @@ def get_mapping(location=None):
     return mapping
 
 
+def get_output_mapping(location):
+    """
+    Return a mapping of About key names to user key names by reading the
+    user's input file from location. The format of the user key names will
+    NOT be formatted (i.e. keys will NOT be forced to convert to lower case)
+    """
+    if not os.path.exists(location):
+        return {}
+
+    mapping = {}
+    try:
+        with open(location) as mapping_file:
+            for line in mapping_file:
+                if not line or not line.strip() or line.strip().startswith('#'):
+                    continue
+
+                if ':' in line:
+                    key, sep, value = line.partition(':')
+                    user_key = key.strip()
+                    about_key = value.strip()
+                    mapping[about_key] = user_key
+
+    except Exception as e:
+        print(repr(e))
+        print('Cannot open or process file at %(location)r.' % locals())
+        # FIXME: this is rather brutal
+        sys.exit(errno.EACCES)
+    return mapping
+
 def apply_mapping(abouts, alternate_mapping=None):
     """
     Given a list of About data dictionaries and a dictionary of
@@ -578,3 +607,32 @@ def inventory_filter(abouts, filter_dict):
                 # The current about object does not have the defined attribute
                 continue
     return updated_abouts
+
+
+def update_fieldnames(fieldnames, mapping_output):
+    map = get_output_mapping(mapping_output)
+    updated_header = []
+    for name in fieldnames:
+        try:
+            updated_header.append(map[name])
+        except:
+            updated_header.append(name)
+    return updated_header
+
+
+def update_about_dictionary_keys(about_dictionary_list, mapping_output):
+    output_map = get_output_mapping(mapping_output)
+    updated_dict_list = []
+    for element in about_dictionary_list:
+        updated_ordered_dict = OrderedDict()
+        for about_key, value in element.items():
+            update_key = False
+            for custom_key in output_map:
+                if about_key == custom_key:
+                    update_key = True
+                    updated_ordered_dict[output_map[custom_key]] = value
+                    break
+            if not update_key:
+                updated_ordered_dict[about_key] = value
+        updated_dict_list.append(updated_ordered_dict)
+    return updated_dict_list

tests/test_util.py

@@ -481,4 +481,24 @@ def test_inventory_filter(self):
         # the filtering
         updated_abouts = util.inventory_filter(abouts, filter_dict)
         for about in updated_abouts:
-            assert about.name.value == 'simple'
+            assert about.name.value == 'simple'
+
+    def test_update_fieldnames(self):
+        mapping_output = get_test_loc('util/mapping_output')
+        fieldnames = ['about_file_path', 'name', 'version']
+        expexted_fieldnames = ['about_file_path', 'Component', 'version']
+        result = util.update_fieldnames(fieldnames, mapping_output)
+        assert expexted_fieldnames == result
+
+    def test_update_about_dictionary_keys(self):
+        mapping_output = get_test_loc('util/mapping_output')
+        about_ordered_dict = OrderedDict()
+        about_ordered_dict['about_resource_path'] = '.'
+        about_ordered_dict['name'] = 'test.c'
+        about_dict_list = [about_ordered_dict]
+        expected_output_dict = OrderedDict()
+        expected_output_dict['about_resource_path'] = '.'
+        expected_output_dict['Component'] = 'test.c'
+        expected_dict_list = [expected_output_dict]
+        result = util.update_about_dictionary_keys(about_dict_list, mapping_output)
+        assert expected_dict_list == result

tests/testdata/util/mapping_output

@@ -0,0 +1 @@
+Component: name