Fixed #543 - Add numeric value support for 'attribute' field

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

Author: chinyeungli

docs/source/specification.rst

@@ -352,14 +352,18 @@ Optional Boolean flag fields
 
 -   redistribute: Set this flag to yes if the component license requires source code
     redistribution. Defaults to no when absent.
--   attribute: Set this flag to yes if the component license requires publishing an attribution
-    or credit notice. Defaults to no when absent.
 -   track_changes: Set this flag to yes if the component license requires tracking changes made to
     a the component. Defaults to no when absent.
 -   modified: Set this flag to yes if the component has been modified. Defaults to no when absent.
 -   internal_use_only: Set this flag to yes if the component is used internal only.
     Defaults to no when absent.
 
+Optional Boolean and Numberic fields
+------------------------------------
+
+-   attribute: This field can be either in boolean value: ('yes', 'y', 'true',
+    'x', 'no', 'n', 'false') or numeric value field. Defaults to no when absent.
+
 Optional Extension fields
 -------------------------
 

src/attributecode/model.py

@@ -720,6 +720,108 @@ def __eq__(self, other):
                 and self.value == other.value)
 
 
+class BooleanAndNumbericField(SingleLineField):
+    """
+    Field with either a boolean value or a numeric value. Validated value is
+    False, True, None or numeric value.
+    """
+
+    def default_value(self):
+        return None
+
+    true_flags = ('yes', 'y', 'true', 'x')
+    false_flags = ('no', 'n', 'false')
+    flag_values = true_flags + false_flags
+
+    def _validate(self, *args, **kwargs):
+        """
+        Check that flag are valid with either boolean value or numeric value. Default flag to
+        False. Return a list of errors.
+        """
+        errors = super(BooleanAndNumbericField,
+                       self)._validate(*args, ** kwargs)
+        self.about_file_path = kwargs.get('about_file_path')
+        flag = self.get_value(self.original_value)
+        if flag is False:
+            name = self.name
+            val = self.original_value
+            about_file_path = self.about_file_path
+            flag_values = self.flag_values
+            msg = (u'Path: %(about_file_path)s - Field %(name)s: Invalid value: %(val)r is not '
+                   u'one of: %(flag_values)s and it is not a numeric value.' % locals())
+            errors.append(Error(ERROR, msg))
+            self.value = None
+        elif flag is None:
+            name = self.name
+            msg = (u'Field %(name)s: field is present but empty. ' % locals())
+            errors.append(Error(INFO, msg))
+            self.value = None
+        else:
+            if flag == u'yes' or flag is True:
+                self.value = True
+            elif flag == u'no':
+                self.value = False
+            else:
+                self.value = flag
+        return errors
+
+    def get_value(self, value):
+        """
+        Return a normalized existing value if found in the list of
+        possible values or None if empty or False if not found or original value
+        if it is not a boolean value
+        """
+        if value is None or value == '':
+            return None
+
+        if isinstance(value, bool):
+            return value
+        else:
+            if isinstance(value, str):
+                value = value.strip()
+                if not value:
+                    return None
+
+                value = value.lower()
+                if value in self.flag_values:
+                    if value in self.true_flags:
+                        return u'yes'
+                    else:
+                        return u'no'
+                else:
+                    if value.isdigit():
+                        return value
+                    else:
+                        return False
+            elif isinstance(value, int):
+                return value
+            else:
+                return False
+
+    @property
+    def has_content(self):
+        """
+        Return true if it has content regardless of what value, False otherwise
+        """
+        if self.original_value:
+            return True
+        return False
+
+    def _serialized_value(self):
+        # default normalized values for serialization
+        if self.value:
+            if isinstance(self.value, bool):
+                return u'yes'
+            else:
+                return self.value
+        elif self.value is False:
+            return u'no'
+        else:
+            # self.value is None
+            # TODO: should we serialize to No for None???
+            return u''
+
+
 def validate_fields(fields, about_file_path, running_inventory, base_dir,
                     reference_dir=None):
     """
@@ -810,7 +912,7 @@ def set_standard_fields(self):
             ('notice_url', UrlField()),
 
             ('redistribute', BooleanField()),
-            ('attribute', BooleanField()),
+            ('attribute', BooleanAndNumbericField()),
             ('track_changes', BooleanField()),
             ('modified', BooleanField()),
             ('internal_use_only', BooleanField()),

tests/test_model.py

@@ -648,6 +648,27 @@ def test_About_boolean_value(self):
         assert a.redistribute.value is True
         assert a.track_changes.value is None
 
+    def test_About_boolean_numeric_value(self):
+        test_file = get_test_loc('test_model/parse/boolean_numeric_data.about')
+        a = model.About(test_file)
+        expected_msg = "Field track_changes is present but empty."
+        assert expected_msg in a.errors[0].message
+        # Context of the test file
+        """
+        about_resource: .
+        name: boolean_data
+        attribute: 3
+        modified: true
+        internal_use_only: no
+        redistribute: yes
+        track_changes:
+        """
+        assert a.attribute.value == '3'
+        assert a.modified.value is True
+        assert a.internal_use_only.value is False
+        assert a.redistribute.value is True
+        assert a.track_changes.value is None
+
     def test_About_contains_about_file_path(self):
         test_file = get_test_loc('test_model/serialize/about.ABOUT')
         # TODO: I am not sure this override of the about_file_path makes sense

tests/testdata/test_model/parse/boolean_numeric_data.about

@@ -0,0 +1,7 @@
+about_resource: .
+name: boolean_data
+attribute: 3
+modified: true
+internal_use_only: no
+redistribute: yes
+track_changes: