* Add multi_sort filter

 * Update the key_value parser as I think the value should be string,
not list (I don't see a use case a list is needed/used for any purpose)
 * Update test cases

Author: chinyeungli

src/attributecode/attrib.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2019 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2020 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -32,13 +32,14 @@
 from attributecode.licenses import COMMON_LICENSES
 from attributecode.model import parse_license_expression
 from attributecode.util import add_unc
+from attributecode.attrib_util import multi_sort
 
 
 DEFAULT_TEMPLATE_FILE = os.path.join(
     os.path.dirname(os.path.realpath(__file__)), '../../templates', 'default_html.template')
 
 
-def generate(abouts, template=None, vartext_dict=None):
+def generate(abouts, template=None, variables=None):
     """
     Generate an attribution text from an `abouts` list of About objects, a
     `template` template text and a `variables` optional dict of extra
@@ -125,7 +126,7 @@ def generate(abouts, template=None, vartext_dict=None):
             license_name_to_license_key=license_name_to_license_key,
             utcnow=utcnow,
             tkversion=__version__,
-            vartext_dict=vartext_dict
+            variables=variables
         )
     except Exception as e:
         lineno = getattr(e, 'lineno', '') or ''
@@ -145,12 +146,13 @@ def check_template(template_string):
     message) if the template is invalid or None if it is valid.
     """
     try:
+        jinja2.filters.FILTERS['multi_sort'] = multi_sort
         jinja2.Template(template_string)
     except (jinja2.TemplateSyntaxError, jinja2.TemplateAssertionError) as e:
         return e.lineno, e.message
 
 
-def generate_from_file(abouts, template_loc=DEFAULT_TEMPLATE_FILE, vartext_dict=None):
+def generate_from_file(abouts, template_loc=DEFAULT_TEMPLATE_FILE, variables=None):
     """
     Generate an attribution text from an `abouts` list of About objects, a
     `template_loc` template file location and a `variables` optional
@@ -163,7 +165,7 @@ def generate_from_file(abouts, template_loc=DEFAULT_TEMPLATE_FILE, vartext_dict=
     template_loc = add_unc(template_loc)
     with io.open(template_loc, encoding='utf-8') as tplf:
         tpls = tplf.read()
-    return generate(abouts, template=tpls, vartext_dict=vartext_dict)
+    return generate(abouts, template=tpls, variables=variables)
 
 
 def generate_and_save(abouts, output_location, template_loc=None, variables=None):
@@ -186,16 +188,10 @@ def generate_and_save(abouts, output_location, template_loc=None, variables=None
                    str(special_char_in_expression))
             errors.append(Error(ERROR, msg))
 
-    vartext_dict = {}
-    if variables:
-        keys = variables.keys()
-        for k in keys:
-            vartext_dict[k] = (variables[k])[0]
-
     rendering_error, rendered = generate_from_file(
         abouts,
         template_loc=template_loc,
-        vartext_dict=vartext_dict
+        variables=variables
     )
 
     if rendering_error:

src/attributecode/cmd.py

@@ -107,7 +107,7 @@ def about():
 
 def validate_key_values(ctx, param, value):
     """
-    Return the a dict of {key: [values,...] if valid or raise a UsageError
+    Return the a dict of {key: value} if valid or raise a UsageError
     otherwise.
     """
     if not value:
@@ -523,7 +523,7 @@ def get_error_messages(errors, quiet=False, verbose=False):
 def parse_key_values(key_values):
     """
     Given a list of "key=value" strings, return:
-    - a dict {key: [value, value, ...]}
+    - a dict {key: value}
     - a sorted list of unique error messages for invalid entries where there is
       a missing a key or value.
     """
@@ -545,9 +545,7 @@ def parse_key_values(key_values):
             errors.add('missing <value> in "{key_value}".'.format(**locals()))
             continue
 
-        values = parsed_key_values[key]
-        if value not in values:
-            parsed_key_values[key].append(value)
+        parsed_key_values[key] = value
 
     return dict(parsed_key_values), sorted(errors)
 

tests/test_cmd.py

@@ -307,8 +307,8 @@ def test_parse_key_values_simple(self):
             'keY=bar',
         ]
         expected = {
-            'key': ['value', 'bar'],
-            'this': ['THat']
+            'key': 'bar',
+            'this': 'THat'
             }
         keyvals, errors = cmd.parse_key_values(test)
         assert expected == keyvals
@@ -323,7 +323,7 @@ def test_parse_key_values_with_errors(self):
             'FOO=bar'
         ]
         expected = {
-            'foo': ['bar'],
+            'foo': 'bar',
         }
         keyvals, errors = cmd.parse_key_values(test)
         assert expected == keyvals