#354 Remove the 'about_resource_path' field

 * The key 'about_resource_path' is removed
 * Updated the required fields to be 'about_resource' and 'name'
 * Removed some non-use code

Signed-off-by: Chin Yeung Li <tli@nexb.com>

Author: chinyeungli

docs/CHANGELOG.rst

@@ -8,6 +8,8 @@
     * The owner is now a StringField instead of ListField
     * Format the ordering of the genreated ABOUT file (See https://github.com/nexB/aboutcode-toolkit/issues/349#issuecomment-438871444)
     * '+' and '(' and ')' is now supported in license_expression
+    * The key 'about_resource_path' is removed
+    * The 2 required fields are 'about_resource' and 'name'
 
 2018-10-23
 

src/attributecode/cmd.py

@@ -35,7 +35,6 @@
 from attributecode import model
 from attributecode import severities
 from attributecode.util import extract_zip
-from attributecode.util import update_severity_level_about_resource_path_not_exist_error
 from attributecode.util import to_posix
 from attributecode.util import inventory_filter
 
@@ -199,14 +198,13 @@ def inventory(location, output, mapping, mapping_file, mapping_output, filter, q
         print(msg)
 
     error_count = 0
-    finalized_errors = update_severity_level_about_resource_path_not_exist_error(errors)
 
-    for e in finalized_errors:
+    for e in errors:
         # Only count as warning/error if CRITICAL, ERROR and WARNING
         if e.severity > 20:
             error_count = error_count + 1
 
-    log_errors(finalized_errors, error_count, quiet, verbose, os.path.dirname(output))
+    log_errors(errors, error_count, quiet, verbose, os.path.dirname(output))
     click.echo(' %(error_count)d errors or warnings detected.' % locals())
     sys.exit(0)
 
@@ -283,13 +281,12 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
 
     about_count = len(abouts)
     error_count = 0
-    finalized_errors = update_severity_level_about_resource_path_not_exist_error(errors)
 
-    for e in finalized_errors:
+    for e in errors:
         # Only count as warning/error if CRITICAL, ERROR and WARNING
         if e.severity > 20:
             error_count = error_count + 1
-    log_errors(finalized_errors, error_count, quiet, verbose, output)
+    log_errors(errors, error_count, quiet, verbose, output)
     click.echo('Generated %(about_count)d .ABOUT files with %(error_count)d errors or warnings' % locals())
     sys.exit(0)
 
@@ -372,14 +369,13 @@ def attrib(location, output, template, mapping, mapping_file, inventory, vartext
         inv_errors.append(no_match_error)
 
     error_count = 0
-    finalized_errors = update_severity_level_about_resource_path_not_exist_error(inv_errors)
 
-    for e in finalized_errors:
+    for e in inv_errors:
         # Only count as warning/error if CRITICAL, ERROR and WARNING
         if e.severity > 20:
             error_count = error_count + 1
 
-    log_errors(finalized_errors, error_count, quiet, verbose, os.path.dirname(output))
+    log_errors(inv_errors, error_count, quiet, verbose, os.path.dirname(output))
     click.echo(' %(error_count)d errors or warnings detected.' % locals())
     click.echo('Finished.')
     sys.exit(0)

src/attributecode/gen.py

@@ -33,6 +33,7 @@
 
 from attributecode import ERROR
 from attributecode import CRITICAL
+from attributecode import INFO
 from attributecode import Error
 from attributecode import model
 from attributecode import util
@@ -244,40 +245,29 @@ def generate(location, base_dir, license_notice_text_location=None,
 
         try:
             # Generate value for 'about_resource' if it does not exist
-            # Note: The `about_resource` is in ListField class
-            # and `about_resource_path` is in AboutResourceField class
             if not about.about_resource.value:
-                #about.about_resource.value = OrderedDict()
+                about.about_resource.value = OrderedDict()
+                about_resource_value = ''
                 if about.about_file_path.endswith('/'):
-                    about.about_resource.value.append(u'.')
-                    about.about_resource.original_value = u'.'
+                    about_resource_value = u'.'
                 else:
-                    about.about_resource.value.append(basename(about.about_file_path))
-                    about.about_resource.original_value = basename(about.about_file_path)
+                    about_resource_value = basename(about.about_file_path)
+                about.about_resource.value[about_resource_value] = None
                 about.about_resource.present = True
-
-            # Generate value for 'about_resource_path' if it does not exist
-            # Basically, this should be the same as the 'about_resource'
-            if not about.about_resource_path.value:
-                about.about_resource_path.value = OrderedDict()
-                for about_resource_value in about.about_resource.value:
-                    about.about_resource_path.value[about_resource_value] = None
-                about.about_resource_path.present = True
-                # Check for the existence of the about_resource
-                # If the input already have the about_resource_path field, it will
+                # Check for the existence of the 'about_resource'
+                # If the input already have the 'about_resource' field, it will
                 # be validated when creating the about object
                 loc = util.to_posix(dump_loc)
                 about_file_loc = loc
-                for about_resource_value in about.about_resource_path.value:
-                    path = join(dirname(util.to_posix(about_file_loc)),
-                                          about_resource_value)
-                    if not exists(path):
-                        path = util.to_posix(path.strip(UNC_PREFIX_POSIX))
-                        path = normpath(path)
-                        msg = (u'Field about_resource_path: '
-                               u'%(path)s '
-                               u'does not exist' % locals())
-                        not_exist_errors.append(msg)
+                path = join(dirname(util.to_posix(about_file_loc)), about_resource_value)
+                if not exists(path):
+                    path = util.to_posix(path.strip(UNC_PREFIX_POSIX))
+                    path = normpath(path)
+                    msg = (u'Field about_resource: '
+                           u'%(path)s '
+                           u'does not exist' % locals())
+                    not_exist_errors.append(msg)
+
             if gen_license:
                 # Write generated LICENSE file
                 license_key_name_context_url_list = about.dump_lic(dump_loc, license_dict)
@@ -304,7 +294,7 @@ def generate(location, base_dir, license_notice_text_location=None,
             # Write the ABOUT files
             about.dump(dump_loc, use_mapping=use_mapping, mapping_file=mapping_file, with_empty=with_empty, with_absent=with_absent)
             for e in not_exist_errors:
-                errors.append(Error(ERROR, e))
+                errors.append(Error(INFO, e))
         except Exception as e:
             # only keep the first 100 char of the exception
             emsg = repr(e)[:100]

src/attributecode/model.py

@@ -455,15 +455,15 @@ def _validate(self, *args, **kwargs):
             if self.license_notice_text_location:
                 location = posixpath.join(self.license_notice_text_location, path)
             else:
-                # The 'about_resource_path' should be a joined path with
+                # The 'about_resource' should be a joined path with
                 # the 'about_file_path' and the 'base_dir
                 if not self.running_inventory and self.about_file_path:
                     # Get the parent directory of the 'about_file_path'
                     afp_parent = posixpath.dirname(self.about_file_path)
 
-                    # Create a relative 'about_resource_path' by joining the
+                    # Create a relative 'about_resource' path by joining the
                     # parent of the 'about_file_path' with the value of the
-                    # 'about_resource_path'
+                    # 'about_resource'
                     arp = posixpath.join(afp_parent, path)
                     normalized_arp = posixpath.normpath(arp).strip(posixpath.sep)
                     location = posixpath.join(self.base_dir, normalized_arp)
@@ -480,7 +480,11 @@ def _validate(self, *args, **kwargs):
                 location = util.to_posix(location.strip(UNC_PREFIX))
                 msg = (u'Field %(name)s: Path %(location)s not found'
                        % locals())
-                errors.append(Error(CRITICAL, msg))
+                # We want to show INFO error for 'about_resource'
+                if name == u'about_resource':
+                    errors.append(Error(INFO, msg))
+                else:
+                    errors.append(Error(CRITICAL, msg))
                 location = None
 
             paths[path] = location
@@ -702,10 +706,10 @@ def create_fields(self):
         is simpler.
         """
         self.fields = OrderedDict([
-            ('about_resource', ListField(required=True)),
+            #('about_resource', ListField(required=True)),
             # ('about_resource', AboutResourceField(required=True)),
-            ('name', SingleLineField()),
-            ('about_resource_path', AboutResourceField()),
+            ('about_resource', AboutResourceField(required=True)),
+            ('name', SingleLineField(required=True)),
 
             ('version', SingleLineField()),
             ('download_url', UrlField()),
@@ -870,6 +874,7 @@ def as_dict(self, with_paths=False, with_absent=True, with_empty=True):
             afpa = self.about_file_path_attr
             as_dict[afpa] = self.about_file_path
             arpa = self.about_resource_path_attr
+            """
             if self.about_resource_path.present:
                 as_dict[arpa] = self.resolved_resources_paths()
             else:
@@ -890,6 +895,7 @@ def as_dict(self, with_paths=False, with_absent=True, with_empty=True):
                     key = u''
                     arp[key] = None
                     as_dict[arpa] = arp
+            """
 
         for field in self.all_fields(with_absent=with_absent,
                                      with_empty=with_empty):
@@ -1035,12 +1041,12 @@ def load(self, location, use_mapping=False, mapping_file=None):
             yaml.load(input_text, Loader=util.NoDuplicateLoader)
             """
             The running_inventory defines if the current process is 'inventory' or not.
-            This is used for the validation of the about_resource_path.
+            This is used for the validation of the path of the 'about_resource'.
             In the 'inventory' command, the code will use the parent of the about_file_path
-            location and join with the 'about_resource_path' for the validation.
+            location and join with the 'about_resource' for the validation.
             On the other hand, in the 'gen' command, the code will use the
             generated location (aka base_dir) along with the parent of the about_file_path
-            and then join with the 'about_resource_path'
+            and then join with the 'about_resource'
             """
             running_inventory = True
             # wrap the value of the boolean field in quote to avoid 
@@ -1103,7 +1109,7 @@ def dumps(self, use_mapping=False, mapping_file=False, with_absent=False, with_e
         license_name = []
         license_file = []
         license_url = []
-        file_fields = ['about_resource_path', 'notice_file', 'changelog_file', 'author_file']
+        file_fields = ['about_resource', 'notice_file', 'changelog_file', 'author_file']
         bool_fields = ['redistribute', 'attribute', 'track_changes', 'modified']
         for field in self.all_fields(with_absent, with_empty):
             if field.name == 'license_key' and field.value:
@@ -1114,11 +1120,9 @@ def dumps(self, use_mapping=False, mapping_file=False, with_absent=False, with_e
                 license_file = field.value.keys()
             elif field.name == 'license_url' and field.value:
                 license_url = field.value
-            # No multiple 'about_resource' and 'about_resource_path' reference supported.
+            # No multiple 'about_resource' reference supported.
             # Take the first element (should only be one) in the list for the
-            # value of 'about_resource' and 'about_resource_path'
-            elif field.name == 'about_resource' and field.value:
-                about_data[field.name] = field.value[0]
+            # value of 'about_resource'
             elif field.name in file_fields and field.value:
                 about_data[field.name] = list(field.value.keys())[0]
             else:
@@ -1373,8 +1377,6 @@ def about_object_to_list_of_dictionary(abouts, with_absent=False, with_empty=Tru
             afp = ad['about_file_path']
             afp = '/' + afp if not afp.startswith('/') else afp
             ad['about_file_path'] = afp
-        if not 'about_resource_path' in ad.keys():
-            arp = ad['about_resource_path']
         abouts_dictionary_list.append(ad)
     return abouts_dictionary_list
 

src/attributecode/util.py

@@ -656,19 +656,6 @@ def copy_license_notice_files(fields, base_dir, license_notice_text_location, af
                 print(repr(e))
                 print('Cannot copy file at %(from_lic_path)r.' % locals())
 
-
-def update_severity_level_about_resource_path_not_exist_error(errors):
-    ignore_resource_path_check_message = u'Field about_resource_path:'
-    updated_errors = []
-    for err in errors:
-        if ignore_resource_path_check_message in err.message:
-            updated_errors.append(Error(INFO, err.message))
-            #continue
-        else:
-            updated_errors.append(err)
-    return updated_errors
-
-
 def inventory_filter(abouts, filter_dict):
     updated_abouts = []
     for key in filter_dict:
@@ -743,7 +730,7 @@ def format_about_dict_for_csv_output(about_dictionary_list):
             if element[key]:
                 if isinstance(element[key], list):
                     row_list[key] = u'\n'.join((element[key]))
-                elif key == u'about_resource_path' or key in file_fields:
+                elif key == u'about_resource' or key in file_fields:
                     row_list[key] = u'\n'.join((element[key].keys()))
                 else:
                     row_list[key] = element[key]
@@ -763,10 +750,12 @@ def format_about_dict_for_json_output(about_dictionary_list):
         license_url = []
         for key in element:
             if element[key]:
+                """
                 if key == u'about_resource':
                     row_list[key] = element[key][0]
-                # The 'about_resource_path' is an ordered dict
-                elif key == u'about_resource_path':
+                """
+                # The 'about_resource' is an ordered dict
+                if key == u'about_resource':
                     row_list[key] = list(element[key].keys())[0]
                 elif key in licenses:
                     if key == 'license_key':