core: Add ProjectBear

Makman2 · Makman2 · commit 74808d097bd9 · 2017-05-13T15:49:04.000+02:00
A ProjectBear runs on all files at once, so it has the worst degree of
parallelization. It just spawns a single task.
diff --git a/coalib/core/ProjectBear.py b/coalib/core/ProjectBear.py
@@ -0,0 +1,42 @@
+from coalib.core.Bear import Bear
+from coalib.settings.FunctionMetadata import FunctionMetadata
+
+
+class ProjectBear(Bear):
+    """
+    This bear base class does not parallelize tasks at all, it runs on the
+    whole file base provided.
+    """
+
+    def __init__(self, section, file_dict):
+        """
+        :param section:
+            The section object where bear settings are contained. A section
+            passed here is considered to be immutable.
+        :param file_dict:
+            A dictionary containing filenames to process as keys and their
+            contents (line-split with trailing return characters) as values.
+        """
+        Bear.__init__(self, section, file_dict)
+
+        self._kwargs = self.get_metadata().create_params_from_section(section)
+
+    def execute_task(self, args, kwargs):
+        # To optimize performance a bit and memory usage, we use args and
+        # kwargs from this class instance, instead of passing them via the
+        # task.
+        return Bear.execute_task(self, (self.file_dict,), self._kwargs)
+
+    @classmethod
+    def get_metadata(cls):
+        """
+        :return:
+            Metadata for the ``analyze`` function extracted from its signature.
+            Excludes parameters ``self`` and ``files``.
+        """
+        return FunctionMetadata.from_function(
+            cls.analyze,
+            omit={'self', 'files'})
+
+    def generate_tasks(self):
+        return (tuple(), {}),
diff --git a/tests/core/ProjectBearTest.py b/tests/core/ProjectBearTest.py
@@ -0,0 +1,117 @@
+import unittest
+
+from coalib.core.ProjectBear import ProjectBear
+from coalib.core.Core import run
+from coalib.settings.Section import Section
+
+
+class TestProjectBear(ProjectBear):
+
+    def analyze(self, files):
+        yield '\n'.join(filename + ':' + str(files[filename])
+                        for filename in sorted(files))
+
+
+class TestProjectBearWithParameters(ProjectBear):
+
+    def analyze(self, files, prefix: str='---'):
+        yield '\n'.join(prefix + filename + ':' + str(files[filename])
+                        for filename in sorted(files))
+
+
+class ProjectBearTest(unittest.TestCase):
+
+    def assertResultsEqual(self, bear_type, expected,
+                           section=None, file_dict=None):
+        """
+        Asserts whether the expected results do match the output of the bear.
+
+        Asserts for the results out-of-order.
+
+        :param bear_type:
+            The bear class to check.
+        :param expected:
+            A sequence of expected results.
+        :param section:
+            A section for the bear to use. By default uses a new section with
+            name ``test-section``.
+        :param file_dict:
+            A file-dictionary for the bear to use. By default uses an empty
+            dictionary.
+        """
+        if section is None:
+            section = Section('test-section')
+        if file_dict is None:
+            file_dict = {}
+
+        uut = bear_type(section, file_dict)
+
+        results = []
+
+        def on_result(result):
+            results.append(result)
+
+        run({uut}, on_result)
+
+        self.assertEqual(sorted(expected), sorted(results))
+
+    def test_bear_without_parameters(self):
+        self.assertResultsEqual(
+            TestProjectBear,
+            file_dict={},
+            expected=[''])
+        self.assertResultsEqual(
+            TestProjectBear,
+            file_dict={'fileX': []},
+            expected=['fileX:[]'])
+        self.assertResultsEqual(
+            TestProjectBear,
+            file_dict={'fileX': [], 'fileY': ['hello']},
+            expected=["fileX:[]\nfileY:['hello']"],)
+        self.assertResultsEqual(
+            TestProjectBear,
+            file_dict={'fileX': [], 'fileY': ['hello'], 'fileZ': ['x\ny']},
+            expected=["fileX:[]\nfileY:['hello']\nfileZ:['x\\ny']"])
+
+    def test_bear_with_parameters_but_keep_defaults(self):
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            file_dict={},
+            expected=[''])
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            file_dict={'fileX': []},
+            expected=['---fileX:[]'])
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            file_dict={'fileX': [], 'fileY': ['hello']},
+            expected=["---fileX:[]\n---fileY:['hello']"], )
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            file_dict={'fileX': [], 'fileY': ['hello'], 'fileZ': ['x\ny']},
+            expected=["---fileX:[]\n---fileY:['hello']\n---fileZ:['x\\ny']"])
+
+    def test_bear_with_parameters(self):
+        section = Section('test-section')
+        section['prefix'] = '___'
+
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            section=section,
+            file_dict={},
+            expected=[''])
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            section=section,
+            file_dict={'fileX': []},
+            expected=['___fileX:[]'])
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            section=section,
+            file_dict={'fileX': [], 'fileY': ['hello']},
+            expected=["___fileX:[]\n___fileY:['hello']"], )
+        self.assertResultsEqual(
+            TestProjectBearWithParameters,
+            section=section,
+            file_dict={'fileX': [], 'fileY': ['hello'], 'fileZ': ['x\ny']},
+            expected=["___fileX:[]\n___fileY:['hello']\n___fileZ:['x\\ny']"])
