Split registry metadata from class definitions

erik · Dec 28, 2018 · 21894e9 · 21894e9
1 parent 243ee67
commit 21894e9
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 18 deletions.
diff --git a/squabble/__main__.py b/squabble/__main__.py
@@ -108,15 +108,14 @@ def show_rule(name):
     }
 
     try:
-        rule = rule.Registry.get_meta(name)
+        meta = rule.Registry.get_meta(name)
     except squabble.UnknownRuleException:
         print('{bold}Unknown rule:{reset} {name}'.format(**{
             'name': name,
             **color
         }))
         sys.exit(1)
 
-    meta = rule['meta']
     print('{bold}{name}{reset} - {description}\n{help}'.format(**{
         **meta,
         **color
@@ -129,11 +128,9 @@ def list_rules():
         'reset': Style.RESET_ALL,
     }
 
-    all_rules = sorted(rule.Registry.all(), key=lambda r: r['meta']['name'])
-
-    for rule in all_rules:
-        meta = rule['meta']
+    all_rules = sorted(rule.Registry.all(), key=lambda r: r['name'])
 
+    for meta in all_rules:
         print('{bold}{name: <32}{reset} {description}'.format(**{
             **color,
             **meta

diff --git a/squabble/lint.py b/squabble/lint.py
@@ -34,9 +34,7 @@ def configure_rules(rule_config):
     rules = []
 
     for name, options in rule_config.items():
-        meta = Registry.get_meta(name)
-        cls = meta['class']
-
+        cls = Registry.get_class(name)
         rules.append(cls(options))
 
     return rules

diff --git a/squabble/rule.py b/squabble/rule.py
@@ -38,7 +38,6 @@ def _load_builtin_rules():
     modules = glob.glob(os.path.dirname(__file__) + '/rules/*.py')
 
     for mod in modules:
-        print(mod)
         mod_name = os.path.basename(mod)[:-3]
 
         if not os.path.isfile(mod) or mod_name.startswith('__'):
@@ -114,28 +113,42 @@ def get_meta(name):
         """
         Return metadata about a given rule in the registry.
 
+        If no rule exists in the registry named ``name``,
+        :class:`UnknownRuleException` will be thrown.
+
         The returned dictionary will look something like this:
 
         .. code-block:: python
 
             {
-                'class': RuleClass,
-                'meta': {
-                    'name': 'RuleClass',
-                    'help': 'Some rule...',
-                    # ...
-                }
+                'name': 'RuleClass',
+                'help': 'Some rule...',
+                # ...
             }
         """
         if name not in Registry._REGISTRY:
             raise UnknownRuleException(name)
 
-        return Registry._REGISTRY[name]
+        return Registry._REGISTRY[name]['meta']
+
+    @staticmethod
+    def get_class(name):
+        """
+        Return class for given rule name in the registry.
+
+        If no rule exists in the registry named ``name``,
+        :class:`UnknownRuleException` will be thrown.
+        """
+        if name not in Registry._REGISTRY:
+            raise UnknownRuleException(name)
+
+        return Registry._REGISTRY[name]['class']
 
     @staticmethod
     def all():
         """
         Return an iterator over all known rule metadata. Equivalent to calling
         :func:`~Registry.get_meta()` for all registered rules.
         """
-        return Registry._REGISTRY.values()
+        for r in Registry._REGISTRY.values():
+            yield r['meta']