Move scoring to 'Delta.determine_score()' #60

  * This branch was created from 52-add-score-to-delta-object and thus
    incorporates recent commits for issue #52.
  * Scoring was previously determined in 'DeltaCode.determine_delta()',
    'DeltaCode.update_deltas()' and 'Delta._license_diff()'.
  * Refactored tests, added five new tests.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>

Author: johnmhoran

src/deltacode/__init__.py

@@ -104,7 +104,7 @@ def determine_delta(self):
                 try:
                     delta_old_files = old_index[path]
                 except KeyError:
-                    self.deltas['added'].append(Delta(new_file, None, 'added', 75))
+                    self.deltas['added'].append(Delta(new_file, None, 'added'))
                     continue
 
                 # at this point, we have a delta_old_file.
@@ -113,10 +113,10 @@ def determine_delta(self):
                 for f in delta_old_files:
                     # TODO: make sure sha1 is NOT empty
                     if new_file.sha1 == f.sha1:
-                        self.deltas['unmodified'].append(Delta(new_file, f, 'unmodified', 0))
+                        self.deltas['unmodified'].append(Delta(new_file, f, 'unmodified'))
                         continue
                     else:
-                        delta = Delta(new_file, f, 'modified', 50)
+                        delta = Delta(new_file, f, 'modified')
                         self.deltas['modified'].append(delta)
 
         # now time to find the added.
@@ -131,7 +131,7 @@ def determine_delta(self):
                     # This file already classified as 'modified' or 'unmodified' so do nothing
                     new_index[path]
                 except KeyError:
-                    self.deltas['removed'].append(Delta(None, old_file, 'removed', 25))
+                    self.deltas['removed'].append(Delta(None, old_file, 'removed'))
                     continue
 
         # make sure everything is accounted for
@@ -165,7 +165,7 @@ def update_deltas(self, added, removed):
         Convert the matched 'added' and 'removed' Delta objects to a combined
         'moved' Delta object and delete the 'added' and 'removed' objects.
         """
-        self.deltas.get('moved').append(Delta(added.new_file, removed.old_file, 'moved', 0))
+        self.deltas.get('moved').append(Delta(added.new_file, removed.old_file, 'moved'))
         self.deltas.get('added').remove(added)
         self.deltas.get('removed').remove(removed)
 
@@ -243,6 +243,8 @@ def __init__(self, new_file=None, old_file=None, delta_type=None, score=0):
         if self.category == 'modified':
             self._license_diff()
 
+        self.determine_score()
+
     def _license_diff(self, cutoff_score=50):
         """
         Compare the license details for a pair of 'new' and 'old' File objects
@@ -255,25 +257,40 @@ def _license_diff(self, cutoff_score=50):
 
         if len(self.new_file.licenses) > 0 and self.old_file.licenses == []:
             self.category = 'license info added'
-            self.score = 70
             return
 
         if self.new_file.licenses == [] and len(self.old_file.licenses) > 0:
             self.category = 'license info removed'
-            self.score = 65
             return
 
         new_keys = set(l.key for l in new_licenses if l.score >= cutoff_score)
         old_keys = set(l.key for l in old_licenses if l.score >= cutoff_score)
 
         if new_keys != old_keys:
             self.category = 'license change'
-            self.score = 60
+
+    def determine_score(self):
+        """
+        Assign a score to each 'Delta' object by modifying the object's 'score'
+        attribute based on the object's 'category' attribute.
+        """
+        scores = {
+            'added': 75,
+            'license info added': 70,
+            'license info removed': 65,
+            'license change': 60,
+            'modified': 50,
+            'removed': 25,
+            'moved': 0,
+            'unmodified': 0
+        }
+
+        self.score = scores.get(self.category, 0)
 
     def to_dict(self):
         """
         Check the 'category' attribute of the Delta object and return an
-        OrderedDict comprising the 'category' and 'path' of the object.
+        OrderedDict comprising the 'category', 'score' and 'path' of the object.
         """
         delta = OrderedDict([
             ('category', self.category),

tests/test_deltacode.py

@@ -1483,6 +1483,7 @@ def test_Delta_create_object_removed(self):
         assert type(delta.new_file) == type(models.File())
         assert delta.old_file.path == 'path/removed.txt'
         assert delta.category == 'removed'
+        assert delta.score == 25
 
     def test_Delta_create_object_added(self):
         new = models.File({'path': 'path/added.txt'})
@@ -1493,6 +1494,7 @@ def test_Delta_create_object_added(self):
         assert delta.new_file.path == 'path/added.txt'
         assert type(delta.old_file) == type(models.File())
         assert delta.category == 'added'
+        assert delta.score == 75
 
     def test_Delta_create_object_modified(self):
         new = models.File({'path': 'path/modified.txt', 'sha1': 'a'})
@@ -1505,6 +1507,7 @@ def test_Delta_create_object_modified(self):
         assert delta.old_file.path == 'path/modified.txt'
         assert delta.old_file.sha1 == 'b'
         assert delta.category == 'modified'
+        assert delta.score == 50
 
     def test_Delta_create_object_unmodified(self):
         new = models.File({'path': 'path/unmodified.txt', 'sha1': 'a'})
@@ -1517,6 +1520,7 @@ def test_Delta_create_object_unmodified(self):
         assert delta.old_file.path == 'path/unmodified.txt'
         assert delta.old_file.sha1 == 'a'
         assert delta.category == 'unmodified'
+        assert delta.score == 0
 
     def test_Delta_create_object_moved(self):
         new = models.File({'path': 'path_new/moved.txt', 'sha1': 'a'})
@@ -1529,10 +1533,56 @@ def test_Delta_create_object_moved(self):
         assert delta.old_file.path == 'path_old/moved.txt'
         assert delta.old_file.sha1 == 'a'
         assert delta.category == 'moved'
+        assert delta.score == 0
 
     def test_Delta_create_object_empty(self):
         delta = deltacode.Delta()
 
         assert type(delta.new_file) == type(models.File())
         assert type(delta.old_file) == type(models.File())
         assert delta.category == ''
+
+    def test_Delta_determine_score_new_no_license_info(self):
+        new_file = models.File({'path': 'new/path.txt'})
+        old_file = models.File({'path': 'old/path.txt', 'licenses': [{'key': 'mit', 'score': 50.0}]})
+
+        result = deltacode.Delta(new_file, old_file, 'modified')
+
+        assert result.category == 'license info removed'
+        assert result.score == 65
+
+    def test_Delta_determine_score_new_no_license_info_below_cutoff_score(self):
+        new_file = models.File({'path': 'new/path.txt'})
+        old_file = models.File({'path': 'old/path.txt', 'licenses': [{'key': 'mit', 'score': 49.0}]})
+
+        result = deltacode.Delta(new_file, old_file, 'modified')
+
+        assert result.category == 'license info removed'
+        assert result.score == 65
+
+    def test_Delta_determine_score_old_no_license_info(self):
+        new_file = models.File({'path': 'new/path.txt', 'licenses': [{'key': 'mit', 'score': 50.0}]})
+        old_file = models.File({'path': 'old/path.txt'})
+
+        result = deltacode.Delta(new_file, old_file, 'modified')
+
+        assert result.category == 'license info added'
+        assert result.score == 70
+
+    def test_Delta_determine_score_old_no_license_info_below_cutoff_score(self):
+        new_file = models.File({'path': 'new/path.txt', 'licenses': [{'key': 'mit', 'score': 49.0}]})
+        old_file = models.File({'path': 'old/path.txt'})
+
+        result = deltacode.Delta(new_file, old_file, 'modified')
+
+        assert result.category == 'license info added'
+        assert result.score == 70
+
+    def test_Delta_determine_score_single_diff_multiple_keys(self):
+        new_file = models.File({'path': 'new/path.txt', 'licenses': [{'key': 'gpl-2.0', 'score': 100.0}, {'key': 'mit', 'score':30.0}]})
+        old_file = models.File({'path': 'old/path.txt', 'licenses': [{'key': 'mit', 'score': 50.0}]})
+
+        result = deltacode.Delta(new_file, old_file, 'modified')
+
+        assert result.category == 'license change'
+        assert result.score == 60