Added acronym ratings

Author: tholzheim

migration/openresearch/event.py

@@ -12,6 +12,9 @@
 import os
 import time
 
+from ormigrate.issue41 import AcronymLengthFixer
+from ormigrate.painscale import PainScale
+
 
 class OREntityList(JSONAbleList):
     '''
@@ -103,7 +106,7 @@ def getCachePath():
 
     @classmethod
     def getResourcePath(cls):
-        path = os.path.dirname(__file__) + "/../ormigrate/resources/"
+        path = os.path.dirname(__file__) + "/../ormigrate/resources"
         return path
 
     def getJsonFile(self):
@@ -395,12 +398,10 @@ def fixRecord(self,record):
             record.pop(key)
 
     @classmethod       
-    def rateMigration(cls,event,eventRecord): 
-        acronymLength = len(eventRecord.get('acronym')) if 'acronym' in eventRecord else None
-        acronymMarker = "❌-" if acronymLength is None else f"❌ - {acronymLength}" if acronymLength > 20 or acronymLength<6 else f"✅ {acronymLength}"
-        eventRecord['acronym length'] = acronymMarker
+    def rateMigration(cls,event,eventRecord):
+        rating = AcronymLengthFixer.getRating(eventRecord)
+        eventRecord['acronym length'] = PainScale.lookupPainImage(rating)
         pass
-            
 
     def __str__(self):
         text=self.pageTitle

migration/ormigrate/issue41.py

@@ -0,0 +1,47 @@
+from ormigrate.fixer import PageFixer
+import re
+
+class AcronymLengthFixer(PageFixer):
+    '''
+    fixer for acronym length
+    https://github.com/SmartDataAnalytics/OpenResearch/issues/41
+    '''
+
+    def __init__(self, wikiId="or", baseUrl="https://www.openresearch.org/wiki/", debug=False, restoreOut=False, suspicitionLength=20):
+        '''
+        Constructor
+        '''
+        # call super constructor
+        super(AcronymLengthFixer, self).__init__(wikiId, baseUrl)
+        self.debug = debug
+        self.restoreOut = restoreOut
+        self.suspicitionLength = suspicitionLength
+
+    @staticmethod
+    def getRating(eventRecord):
+        '''
+        Returns the pain scale of this event
+        https://cr.bitplan.com/index.php/Acronyms
+
+        Args:
+            eventRecord:
+
+        Returns:
+            int: pain rating of the acronym
+        '''
+        if 'acronym' not in eventRecord:
+            return 6
+        acronym = eventRecord['acronym']
+        if acronym is None:
+            return 6
+        elif re.match(r'[A-Z]+\s*[0-9]+', acronym):
+            # Regex based on the results of https://cr.bitplan.com/index.php/Acronyms
+            if len(acronym) < 5:
+                return 5
+            elif len(acronym) > 45:
+                return 5
+            else:
+                return 1
+        else:
+            return 6
+

migration/ormigrate/painscale.py

@@ -0,0 +1,18 @@
+
+
+class PainScale(object):
+
+    @staticmethod
+    def lookupPainImage(rating: int):
+        '''Returns html image tag to the corresponding pain rating'''
+        painImages = {1: "http://rq.bitplan.com/images/rq/a/a3/Pain0.png",
+                      2: "https://rq.bitplan.com/images/rq/0/01/Pain1.png",
+                      3: "https://rq.bitplan.com/images/rq/0/0a/Pain4.png",
+                      4: "https://rq.bitplan.com/images/rq/b/b0/Pain6.png",
+                      5: "https://rq.bitplan.com/images/rq/6/6c/Pain7.png",
+                      6: "https://rq.bitplan.com/images/rq/2/29/Pain10.png"
+                      }
+        if rating > 0 and rating < 7:
+            return f'<img alt="{rating}" src="{painImages[rating]}" width="32" height="32"/>'
+        else:
+            return ""

migration/ormigrate/toolbox.py

@@ -25,7 +25,7 @@ def inPublicCI():
 
     @classmethod
     def getResourcePath(cls):
-        path = os.path.dirname(__file__) + "/resources/"
+        path = os.path.dirname(__file__) + "/resources"
         return path
 
     @classmethod

migration/requirements.txt

@@ -3,4 +3,4 @@ pylodstorage>=0.0.29
 # https://pypi.org/project/python-dateutil/
 python-dateutil
 # https://pypi.org/project/py-3rdparty-mediawiki/
-py-3rdparty-mediawiki>=0.4.3
+py-3rdparty-mediawiki>=0.4.5

migration/setup.py

@@ -33,7 +33,8 @@
             'Programming Language :: Python :: 3.8',
             'Programming Language :: Python :: 3.9'
       ],
-      packages=['ormigrate','openresearch','ormigrate.resources'],
+      packages=['ormigrate','openresearch',''],
+      package_data={'ormigrate': ['resources/*.json']},
       install_requires=[
           'pylodstorage',
           'python-dateutil',

migration/tests/testIssue41.py

@@ -0,0 +1,21 @@
+import unittest
+from ormigrate.issue41 import AcronymLengthFixer
+
+
+class TestIssue168(unittest.TestCase):
+    '''
+    test issue 41 fixer
+    '''
+
+
+    def testgetPainRating(self):
+        painList = [
+            (1,"IEEE 2020"),
+            (1,"IEEE 2020a"),
+            (6,"IEEE"),
+            (6,"Title of the event used as acronym"),
+            (6,None)
+        ]
+        eventRecord = lambda acronym: {"acronym": acronym }
+        for (painRating, sample) in painList:
+            self.assertTrue(AcronymLengthFixer.getRating(eventRecord(sample)) == painRating)