Merge branch 'develop' into 417_json_transform

 * Heavily modified `transform` code and tests

Author: chinyeungli

NOTICE

@@ -1,4 +1,4 @@
- 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

README.rst

@@ -10,7 +10,6 @@ third-party software components that you use in your project.
 You start by storing ABOUT files (a small YAML formatted text file with field/value pairs)
 side-by-side with each of the third-party software components you use.
 Each ABOUT file documents origin and license for one software.
-For more information on the ABOUT file format, visit http://www.dejacode.org
 There are many examples of ABOUT files (valid or invalid) in the testdata/
 directory of the whole repository.
 

REFERENCE.rst

@@ -83,8 +83,8 @@ Options
     $ about attrib --vartext "title=Attribution Notice" --vartext "header=Product 101" LOCATION OUTPUT
 
         Users can use the following in the template to get the vartext:
-        {{ vartext_dict['title'] }}
-        {{ vartext_dict['header'] }} 
+        {{ variables['title'] }}
+        {{ variables['header'] }} 
 
     --verbose
 

about.ABOUT

@@ -1,8 +1,8 @@
 about_resource: .
 name: AboutCode-toolkit
-version: 4.0.1
+version: 5.0.0
 author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
-copyright: Copyright (c) 2013-2019 nexB Inc.
+copyright: Copyright (c) 2013-2020 nexB Inc.
 description: |
     AboutCode Toolkit is a tool to process ABOUT files. An ABOUT file
     provides a simple way to document the provenance (origin and license)

docs/CHANGELOG.rst

@@ -1,8 +1,14 @@
-2019-xx-xx
+2020-xx-xx
+    Release 5.0.0
+
+    * Update transform code (See #427 and #428)
+
+2020-05-05
     Release 4.0.2
 
     * Upgrade license-expression library to v1.2
-    * Enhance the `transform` to also work with JSON file
+    * Fix the missing `multi_sort` filter for Jinja2
+    * Update help text for `--vartext`
 
 
 2019-10-17

docs/UsingAboutCodetoDocumentYourSoftwareAssets.md

@@ -253,8 +253,8 @@ For instance with this configuration the columns "Directory/Location" will be
 renamed to "about_resource" and "foo" to "bar":
 
     field_renamings:
-        'Directory/Location' : about_resource
-        foo : bar
+        about_resource : 'Directory/Location'
+        bar : foo
 
 The renaming is always applied first before other transforms and checks. All
 other column names referenced below are these that exist AFTER the renaming
@@ -296,6 +296,7 @@ transformed target CSV/JSON.
 
 For instance with this configuration the target CSV/JSON will not contain the "type"
 and "temp" fields:
+
     exclude_fields:
         - type
         - temp

docs/UsingAboutCodetoDocumentYourSoftwareAssets.pdf

@@ -24,7 +24,7 @@ def read(*names, **kwargs):
 
 setup(
     name='aboutcode-toolkit',
-    version='4.0.1',
+    version='5.0.0',
     license='Apache-2.0',
     description=(
         'AboutCode-toolkit is a tool to document the provenance (origin and license) of '

setup.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
@@ -31,12 +31,12 @@
 
 import saneyaml
 
-__version__ = '4.0.1'
+__version__ = '5.0.0'
 
 __about_spec_version__ = '3.1.4'
 
 __copyright__ = """
-Copyright (c) 2013-2019 nexB Inc. All rights reserved. http://dejacode.org
+Copyright (c) 2013-2020 nexB Inc. All rights reserved. http://dejacode.org
 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

src/attributecode/__init__.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,6 +32,7 @@
 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(
@@ -145,6 +146,7 @@ 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