Factor out strip_rst_directives function

docs/api/squabble.rst

@@ -15,3 +15,4 @@ squabble package
    squabble.reporter
    squabble.rule
    squabble.rules
+   squabble.util

docs/api/squabble.util.rst

@@ -0,0 +1,7 @@
+squabble.util module
+====================
+
+.. automodule:: squabble.util
+    :members:
+    :undoc-members:
+    :show-inheritance:

squabble/message.py

@@ -1,8 +1,8 @@
 import inspect
 import logging
-import re
 
 from squabble import SquabbleException
+from squabble.util import strip_rst_directives
 
 
 logger = logging.getLogger(__name__)
@@ -134,7 +134,7 @@ def explain(cls):
         ...      SELECT * FROM big_table;
         ...    '''
         >>> RstMessage().explain()
-        "Don't do this:\\n\\n  SELECT * FROM big_table;"
+        "Don't do this:\\n  SELECT * FROM big_table;"
         """
         if not cls.__doc__:
             return None
@@ -143,12 +143,7 @@ def explain(cls):
         doc = inspect.cleandoc(cls.__doc__)
 
         # replace ``.. code-block:: lang``
-        return re.sub(
-            r'^\s*\.\. code(-block)?:: (\w+)$',
-            '',
-            doc,
-            flags=re.MULTILINE
-        )
+        return strip_rst_directives(doc)
 
     def asdict(self):
         return {

squabble/rules/__init__.py

@@ -1,6 +1,7 @@
 import inspect
 
 from squabble.rule import Registry
+from squabble.util import strip_rst_directives
 
 
 class BaseRule:
@@ -55,7 +56,7 @@ def meta(cls):
 
         help = None
         if len(split_doc) == 2:
-            help = split_doc[1].strip()
+            help = strip_rst_directives(split_doc[1])
 
         return {
             'name': cls.__name__,

squabble/rules/require_foreign_key.py

@@ -15,7 +15,6 @@ class RequireForeignKey(BaseRule):
     the regex ``.*_id$``, but this is configurable.
 
     .. code-block:: sql
-
       CREATE TABLE comments (
         post_id  INT,  -- warning here, this looks like a foreign key,
                        -- but no constraint was given

squabble/util.py

@@ -0,0 +1,22 @@
+"""
+Odds and ends pieces that don't fit elsewhere, but aren't important
+enough to have their own modules.
+"""
+
+import re
+
+
+_RST_DIRECTIVE = re.compile(r'^\.\. [\w-]+:: \w+$\n', flags=re.MULTILINE)
+
+
+def strip_rst_directives(string):
+    """
+    Strip reStructuredText directives out of a block of text.
+
+    Lines containing a directive will be stripped out entirely
+
+    >>> strip_rst_directives('hello\\n.. code-block:: foo\\nworld')
+    'hello\\nworld'
+    """
+
+    return re.sub(_RST_DIRECTIVE, '', string)