#396 - add option --android to create MODULE_LICENSE and NOTICE

 * Create empty MODULE_LICENSE_XXX based on the license key
 * Create NOTICE with the ccontext from copyright, notice file and
license file
 * Update copyright date
 * Update some doc

The test code has not been updated and expect some tests will fail

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

REFERENCE.rst

@@ -151,6 +151,10 @@ gen
 
 ::
 
+    --android                           Generate MODULE_LICENSE_XXX (XXX will be
+                                        replaced by license key) and NOTICE as the same
+                                        design as from Android.
+
     --fetch-license api_url api_key     Fetch licenses data from DejaCode License
                                         Library and create <license>.LICENSE
                                         side-by-side with the generated .ABOUT file.
@@ -178,6 +182,17 @@ Options
 
 ::
 
+    --android
+
+        Create an empty file named `MODULE_LICENSE_XXX` where `XXX` is the license
+        key and create a NOTICE file which these two files follow the design from
+        Android Open Source Project.
+
+        The input **must** have the license key information as this is needed to
+        create the empty MODULE_LICENSE_XXX
+
+    $ about gen --android LOCATION OUTPUT
+
     --fetch-license
 
         Fetch licenses text from a DejaCode API. and create <license>.LICENSE side-by-side

about.ABOUT

@@ -2,7 +2,7 @@ about_resource: .
 name: AboutCode-toolkit
 version: 4.0.1
 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)

src/attributecode/cmd.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
@@ -46,7 +46,7 @@
 
 
 __copyright__ = """
-    Copyright (c) 2013-2019 nexB Inc and others. All rights reserved.
+    Copyright (c) 2013-2020 nexB Inc and others. 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
@@ -210,6 +210,11 @@ def inventory(location, output, format, quiet, verbose):  # NOQA
     metavar='OUTPUT',
     type=click.Path(exists=True, file_okay=False, writable=True, resolve_path=True))
 
+@click.option('--android',
+    is_flag=True,
+    help='Generate MODULE_LICENSE_XXX (XXX will be replaced by license key) and NOTICE '
+         'as the same design as from Android.')
+
 # FIXME: the CLI UX should be improved with two separate options for API key and URL
 @click.option('--fetch-license',
     nargs=2,
@@ -233,7 +238,7 @@ def inventory(location, output, format, quiet, verbose):  # NOQA
 
 @click.help_option('-h', '--help')
 
-def gen(location, output, fetch_license, reference, quiet, verbose):
+def gen(location, output, android, fetch_license, reference, quiet, verbose):
     """
 Generate .ABOUT files in OUTPUT from an inventory of .ABOUT files at LOCATION.
 
@@ -245,12 +250,14 @@ def gen(location, output, fetch_license, reference, quiet, verbose):
         print_version()
         click.echo('Generating .ABOUT files...')
 
+    #FIXME: This should be checked in the `click`
     if not location.endswith(('.csv', '.json',)):
         raise click.UsageError('ERROR: Invalid input file extension: must be one .csv or .json.')
 
     errors, abouts = generate_about_files(
         location=location,
         base_dir=output,
+        android=android,
         reference_dir=reference,
         fetch_license=fetch_license,
     )

src/attributecode/gen.py

@@ -211,7 +211,7 @@ def load_inventory(location, base_dir, reference_dir=None):
 def update_about_resource(self):
     pass
 
-def generate(location, base_dir, reference_dir=None, fetch_license=False):
+def generate(location, base_dir, android=None, reference_dir=None, fetch_license=False):
     """
     Load ABOUT data from a CSV inventory at `location`. Write ABOUT files to
     base_dir. Return errors and about objects.
@@ -311,7 +311,7 @@ def generate(location, base_dir, reference_dir=None, fetch_license=False):
                         if about.license_name.value:
                             about.license_name.present = True
 
-            about.dump(dump_loc)
+            about.dump(dump_loc, android)
 
             for e in not_exist_errors:
                 errors.append(Error(INFO, e))

src/attributecode/model.py

@@ -677,7 +677,7 @@ def validate_fields(fields, about_file_path, running_inventory, base_dir,
 def validate_field_name(name):
     if not is_valid_name(name):
         msg = ('Field name: %(name)r contains illegal name characters: '
-               '0 to 9, a to z, A to Z and _.')
+               '0 to 9, a to z, A to Z and _. (or empty spaces)')
         return Error(CRITICAL, msg % locals())
 
 
@@ -1066,7 +1066,7 @@ def dumps(self):
 
         return saneyaml.dump(data)
 
-    def dump(self, location):
+    def dump(self, location, android):
         """
         Write formatted ABOUT representation of self to location.
         """
@@ -1087,6 +1087,34 @@ def dump(self, location):
         if on_windows:
             about_file_path = add_unc(about_file_path)
 
+        if android:
+            for lic_key in self.license_key.value:
+                # Make uppercase and with dash and spaces and dots replaced by underscore
+                # just to look similar and consistent.
+                name = 'MODULE_LICENSE_' + lic_key.replace('.', '_').replace('-', '_').replace(' ', '_').upper()
+                module_lic_path = os.path.join(os.path.dirname(about_file_path), name)
+                # Create an empty MODULE_LICESE_XXX file
+                open(module_lic_path, 'a').close()
+
+            # Create NOTICE file with the combination context of copyright,
+            # notice_file and license_file
+            notice_path = os.path.join(os.path.dirname(about_file_path), 'NOTICE')
+            notice_context = ''
+            if self.copyright.value:
+                notice_context += self.copyright.value
+            if self.notice_file.value:
+                notice_file_dict = self.notice_file.value
+                notice_file_key = notice_file_dict.keys()
+                for key in notice_file_key:
+                    notice_context += '\n\n' + notice_file_dict[key]
+            if self.license_file.value:
+                lic_file_dict = self.license_file.value
+                lic_file_key = lic_file_dict.keys()
+                for key in lic_file_key:
+                    notice_context += '\n\n' + lic_file_dict[key]
+            with io.open(notice_path, mode='w', encoding='utf-8') as dumped:
+                dumped.write(notice_context)
+
         with io.open(about_file_path, mode='w', encoding='utf-8') as dumped:
             dumped.write(genereated_tk_version)
             dumped.write(self.dumps())