Changed plugins to be stateless (at least for the relevant user code); Configuration and conenctors given to plugins now exist with plugin initialization (and will probably not change, although they could); reworked parameter set for domains and activities to be of a consuming nature, which allows us to spot wrong user config params and report them (we do raise an exception); Removed unnecessary code; Cleanup preps for PR into main repo devel branch; protontypes#164

Author: kikass13

libreselery/commandline.py

@@ -29,6 +29,12 @@ def _runCommand(args):
     # various APIs and servers to
     # allow data gathering
     selery.connect()
+
+    # initialize the CDE (Contribution Distribution Engine)
+    # this also involves finding and 
+    # instantiating activity plugins
+    selery.startEngine()
+
     # let libreselery gather data
     # of all involved projects,
     # dependencies and contributors

libreselery/contribution_activity_plugins/git_file_contributors.py

@@ -47,21 +47,12 @@ def initialize_(self, activity):
         bool: True if successfully initialized
         """
         self.fileFilters = activity.applies_to
-        return True
-
-    def onGlobalsUpdate_(self):
-        """
-        Overload of abstract event method which signalizes the change of the global configuration
 
-        Parameters:
-        None
-
-        Returns:
-        None
-        """
+        ### get global configurations
         self.directory = self.getGlobals().directory
+        return True
 
-    def gather_(self, cachedContributors=[]):
+    def gather_(self):
         """
         Overload of abstract method which is responsible for gathering
         contributor information and scoring contributors based on the action defined
@@ -294,14 +285,14 @@ def test():
     }
     ### create an activity object
     activity = ContributionActivity(d)
+
+    ### emulate some global information
+    ### which is used by the plugin to work properly
+    globalCfg = LibreSeleryConfig({"directory": os.getcwd()})
     ### initialize the action
     ### which will in turn use this specific plugin
     ### if configured correctly
-    init = activity.initialize_()
-    ### emulate some global information
-    ### which is used by the plugin to work properly
-    config = LibreSeleryConfig({"directory": os.getcwd()})
-    activity.updateGlobals(config=config, connectors=None)
+    init = activity.initialize_(globals=globalCfg)
     if init:
         ### let us do our work
         contributors, scores = activity.gather_()

libreselery/contribution_activity_plugins/github_remote_contributors.py

@@ -50,46 +50,25 @@ def initialize_(self, activity):
         Returns:
         bool: True if successfully initialized
         """
+        ### get some information about our activity
         init = True
         self.uniform_score = activity.readParam("uniform_score")
         self.min_contributions = activity.readParam("min_contributions", default=0)
         self.include_deps = activity.readParam("include_dependencies", default=False)
         init = False if not self.uniform_score or not self.min_contributions else True
-        return init
-
-    def onGlobalsUpdate_(self):
-        """
-        Overload of abstract event method which signalizes the change of the global configuration
-
-        Parameters:
-        Non
-
-        Returns:
-        None
-        """
         ### get current project
         self.directory = self.getGlobals().directory
-        ### get special params
-        ###
-        ### TODO:
-        ### these config values should probably not come from globals()
-        ### but from activity (self.initialize_) instead
-        ### because they are not global anymore and instead
-        ### define this specific activity
+
+        ### get global configurations
         self.include_main_repository = self.getGlobals().include_main_repository
 
-        ### get current github connector
-        ###
-        ### TODO:
-        ### connectors are a dict atm, containing all possible
-        ### (preinitialized) connector objects. These can be
-        ### considered "work in progress" and will change slightly
-        ### as time goes on
+        ### get global github connector
         self.githubConnector = self.getConnectors().get(
             self.GITHUB_CONNECTOR_NAME, None
         )
+        return init
 
-    def gather_(self, cachedContributors=[]):
+    def gather_(self):
         """
         Overload of abstract method which is responsible for gathering
         contributor information and scoring contributors based on the activity defined
@@ -223,24 +202,23 @@ def test():
     }
     ### create an activity object
     activity = ContributionActivity(d)
-    ### initialize the activity
-    ### which will in turn use this specific plugin
-    ### if configured correctly
-    init = activity.initialize_()
     ### emulate some global information
     ### which is used by the plugin to work properly
     test_grabEnvironmentVarsFromFile(
         os.path.join(os.environ["HOME"], ".libreselery/tokens.env")
     )
     myGithubToken = os.environ["GITHUB_TOKEN"]
     connectors = {"github": GithubConnector(myGithubToken)}
-    config = LibreSeleryConfig(
+    globalCfg = LibreSeleryConfig(
         {
             "directory": os.path.abspath(os.path.join(os.getcwd(), "..", "..")),
             "include_main_repository": True,
         }
     )
-    activity.updateGlobals(config=config, connectors=connectors)
+    ### initialize the activity
+    ### which will in turn use this specific plugin
+    ### if configured correctly
+    init = activity.initialize_(globals=globalCfg, connectors=connectors)
     if init:
         ### let us do our work
         contributors, scores = activity.gather_()

libreselery/contribution_activity_plugins/hello_world_activity_plugin.py

@@ -47,23 +47,12 @@ def initialize_(self, activity):
         """
         self.log("INIT")
 
-        return True
-
-    def onGlobalsUpdate_(self):
-        """
-        Overload of abstract event method which signalizes the change of the global configuration
-
-        Parameters:
-        None
-
-        Returns:
-        None
-        """
         ### example
         self.someGlobalInformation = self.getGlobals().simulation
-        pass
 
-    def gather_(self, cachedContributors=[]):
+        return True
+
+    def gather_(self):
         """
         Overload of abstract method which is responsible for gathering
         contributor information and scoring contributors based on the activity defined
@@ -111,14 +100,13 @@ def test():
     }
     ### create an activity object
     activity = ContributionActivity(d)
+    ### emulate some global information
+    ### which is used by the plugin to work properly
+    globalCfg = LibreSeleryConfig({"simulation": True})
     ### initialize the action
     ### which will in turn use this specific plugin
     ### if configured correctly
-    init = activity.initialize_()
-    ### emulate some global information
-    ### which is used by the plugin to work properly
-    config = LibreSeleryConfig({"simulation": True})
-    activity.updateGlobals(config=config, connectors=None)
+    init = activity.initialize_(globals=globalCfg)
     ### preparations done, lets do something
     if init:
         ### let us do our work

libreselery/contribution_distribution_engine.py

@@ -6,26 +6,20 @@
 
 
 class ContributionDistributionEngine(object):
-    def __init__(self, config):
+    def __init__(self, config, connectors):
         super(ContributionDistributionEngine, self).__init__()
         ###grab relevant entries from selery cfg
-        self.domains = self._extractContributionDomains(config)
-        ### set our global config to the one given
-        ### these globals can be used by plugins and others
-        self.updateGlobals(config=config)
+        self.domains = self._extractContributionDomains(config, connectors)
 
-    def _extractContributionDomains(self, config):
+    def _extractContributionDomains(self, config, connectors):
         ### read the config and parse usable objects for each domain configured
         domains = []
         for domainDict in config.contribution_domains:
             domain = cdetypes.ContributionDomain(domainDict)
+            domain.initialize_(config, connectors)
             domains.append(domain)
         return domains
 
-    def updateGlobals(self, config=None, connectors=None):
-        for domain in self.domains:
-            domain.updateGlobals(config=config, connectors=connectors)
-
     def splitDictKeyVals(self, d):
         return cdetypes.splitDictKeyVals(d)