Merge branch 'license_expression_support' into develop

Author: chinyeungli

src/attributecode/attrib.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2017 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
@@ -18,6 +18,7 @@
 from __future__ import print_function
 
 import codecs
+import collections
 import jinja2
 import os
 from posixpath import basename
@@ -29,6 +30,7 @@
 from attributecode import ERROR
 from attributecode import Error
 from attributecode.licenses import COMMON_LICENSES
+from attributecode.model import parse_license_expression
 from attributecode.util import add_unc
 
 
@@ -46,7 +48,10 @@ def generate(abouts, template_string=None):
     try:
         captured_license = []
         license_key_and_context = {}
+        sorted_license_key_and_context = {}
         license_text_name_and_key = {}
+        license_key_to_license_name = {}
+        # FIXME: This need to be simplified
         for about in abouts:
             # about.license_file.value is a OrderDict with license_text_name as
             # the key and the license text as the value
@@ -61,10 +66,40 @@ def generate(abouts, template_string=None):
                         else:
                             license_key = license_text_name
                         license_key_and_context[license_key] = about.license_file.value[license_text_name]
+                        sorted_license_key_and_context = collections.OrderedDict(sorted(license_key_and_context.items()))
                         license_text_name_and_key[license_text_name] = license_key
 
-        rendered = template.render(abouts=abouts, common_licenses=COMMON_LICENSES, license_key_and_context=license_key_and_context,
-                                   license_text_name_and_key=license_text_name_and_key)
+            # Convert/map the key in license expression to license name
+            if about.license_expression.value and about.license_name.value:
+                # Split the license expression into list with license key and condition keyword
+                lic_expression_list = about.license_expression.value.split()
+                
+
+                lic_name_list = about.license_name.value
+                lic_name_expression_list = []
+
+                # The order of the license_name and key should be the same
+                # The length for both list should be the same excluding the condition keyword
+                # such as 'and' and 'or'
+                assert len(lic_name_list) <= len(lic_expression_list)
+
+                # Map the licence key to license name
+                index_for_license_name_list = 0
+                for key in lic_expression_list:
+                    if key.lower() == 'and' or key.lower() == 'or':
+                        lic_name_expression_list.append(key)
+                    else:
+                        lic_name_expression_list.append(lic_name_list[index_for_license_name_list])
+                        license_key_to_license_name[key] = lic_name_list[index_for_license_name_list]
+                        index_for_license_name_list = index_for_license_name_list + 1
+                # Join the license name expression into a single string
+                lic_name_expression = ' '.join(lic_name_expression_list)
+
+                # Add the license name expression string into the about object
+                about.license_name_expression = lic_name_expression 
+
+        rendered = template.render(abouts=abouts, common_licenses=COMMON_LICENSES, license_key_and_context=sorted_license_key_and_context,
+                                   license_text_name_and_key=license_text_name_and_key, license_key_to_license_name=license_key_to_license_name)
     except Exception, e:
         line = getattr(e, 'lineno', None)
         ln_msg = ' at line: %r' % line if line else ''
@@ -167,6 +202,17 @@ def generate_and_save(abouts, output_location, mapping, template_loc=None,
                 if about.about_file_path == fp:
                     updated_abouts.append(about)
 
+    # Parse license_expression and save to the license list
+    for about in updated_abouts:
+        if about.license_expression.value:
+            special_char_in_expression, lic_list = parse_license_expression(about.license_expression.value)
+            if special_char_in_expression:
+                msg = (u"The following character(s) cannot be in the licesne_expression: " +
+                       str(special_char_in_expression))
+                errors.append(Error(ERROR, msg))
+            else:
+                about.license.value = lic_list
+
     rendered = generate_from_file(updated_abouts, template_loc=template_loc)
 
     if rendered:

src/attributecode/cmd.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2017 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
@@ -136,12 +136,12 @@ def inventory(location, output, quiet, format):
                 '\nExample syntax:\n\n'
                 "about gen --fetch-license 'api_url' 'api_key'")
               )
-@click.option('--license-text-location', nargs=1,
+@click.option('--license-notice-text-location', nargs=1,
               type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
               help="Copy the 'license_file' from the directory to the generated location")
 @click.option('--mapping', is_flag=True, help='Use for mapping between the input keys and the ABOUT field names - mapping.config')
 @click.option('-q', '--quiet', is_flag=True, help='Do not print any error/warning.')
-def gen(location, output, mapping, license_text_location, fetch_license, quiet):
+def gen(location, output, mapping, license_notice_text_location, fetch_license, quiet):
     """
 Given an inventory of ABOUT files at location, generate ABOUT files in base
 directory.
@@ -156,7 +156,7 @@ def gen(location, output, mapping, license_text_location, fetch_license, quiet):
         return
     click.echo('Generating ABOUT files...')
 
-    errors, abouts = attributecode.gen.generate(location, output, mapping, license_text_location, fetch_license)
+    errors, abouts = attributecode.gen.generate(location, output, mapping, license_notice_text_location, fetch_license)
 
     number_of_about_file = len(abouts)
     number_of_error = 0

src/attributecode/gen.py

@@ -97,7 +97,7 @@ def check_duplicated_about_file_path(inventory_dict):
     return errors
 
 
-def load_inventory(mapping, location, base_dir, license_text_location=None):
+def load_inventory(mapping, location, base_dir, license_notice_text_location=None):
     """
     Load the inventory file at location. Return a list of errors and a list of About
     objects validated against the base_dir.
@@ -150,7 +150,7 @@ def load_inventory(mapping, location, base_dir, license_text_location=None):
             loc = posixpath.join(base_dir, afp)
         about = model.About(about_file_path=afp)
         about.location = loc
-        ld_errors = about.load_dict(fields, base_dir, license_text_location, with_empty=False)
+        ld_errors = about.load_dict(fields, base_dir, license_notice_text_location, with_empty=False)
         # 'about_resource' field will be generated during the process.
         # No error need to be raise for the missing 'about_resource'.
         for e in ld_errors:
@@ -163,7 +163,7 @@ def load_inventory(mapping, location, base_dir, license_text_location=None):
     return errors, abouts
 
 
-def generate(location, base_dir, mapping, license_text_location, fetch_license, policy=None, conf_location=None,
+def generate(location, base_dir, mapping, license_notice_text_location, fetch_license, policy=None, conf_location=None,
              with_empty=False, with_absent=False):
     """
     Load ABOUT data from an inventory at csv_location. Write ABOUT files to
@@ -182,7 +182,7 @@ def generate(location, base_dir, mapping, license_text_location, fetch_license,
         gen_license = True
 
     bdir = to_posix(base_dir)
-    errors, abouts = load_inventory(mapping, location, bdir, license_text_location)
+    errors, abouts = load_inventory(mapping, location, bdir, license_notice_text_location)
 
     if gen_license:
         license_dict, err = model.pre_process_and_fetch_license_dict(abouts, api_url, api_key)
@@ -239,10 +239,14 @@ def generate(location, base_dir, mapping, license_text_location, fetch_license,
                             gen_license_name = lic_key + u'.LICENSE'
                             about.license_file.value[gen_license_name] = lic_context
                             about.license_file.present = True
+                            if not about.license_name.present:
+                                about.license_name.value.append(lic_name)
                             if not about.license_url.present:
                                 about.license_url.value.append(lic_url)
                         if about.license_url.value:
                             about.license_url.present = True
+                        if about.license_name.value:
+                            about.license_name.present = True
 
             # Write the ABOUT file and check does the referenced file exist
             # This function is not purposed to throw error. However, since I've commented