Merge pull request CloudBotIRC#110 from linuxdaemon/gonzobot+markdown-util

Move markdown table generator to cloudbot.util

Author: edwardslabs

cloudbot/util/formatting.py

@@ -44,7 +44,7 @@
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
-
+import copy
 import re
 import html.entities
 
@@ -318,3 +318,20 @@ def get_text_list(list_, last_word='or'):
         # Translators: This string is used as a separator between list elements
         ', '.join([i for i in list_][:-1]),
         last_word, list_[-1])
+
+
+def gen_markdown_table(headers, rows):
+    """
+    Generates a Markdown formatted table from the data
+    """
+    rows = copy.copy(rows)
+    rows.insert(0, headers)
+    rotated = zip(*reversed(rows))
+
+    sizes = tuple(map(lambda l: max(max(map(len, l)), 3), rotated))
+    rows.insert(1, tuple(('-' * size) for size in sizes))
+    lines = [
+        "| {} |".format(' | '.join(cell.ljust(sizes[i]) for i, cell in enumerate(row)))
+        for row in rows
+    ]
+    return '\n'.join(lines)

plugins/core/optout.py

@@ -13,6 +13,7 @@
 from cloudbot import hook
 from cloudbot.hook import Priority
 from cloudbot.util import database, web
+from cloudbot.util.formatting import gen_markdown_table
 
 optout_table = Table(
     'optout',
@@ -75,20 +76,6 @@ def get_channel_optouts(conn_name, chan=None):
         return [opt for opt in optout_cache[conn_name] if not chan or opt.match_chan(chan)]
 
 
-def gen_markdown_table(headers, rows):
-    rows = copy.copy(rows)
-    rows.insert(0, headers)
-    rotated = zip(*reversed(rows))
-
-    sizes = tuple(map(lambda l: max(map(len, l)), rotated))
-    rows.insert(1, tuple(('-' * size) for size in sizes))
-    lines = [
-        "| {} |".format(' | '.join(cell.ljust(sizes[i]) for i, cell in enumerate(row)))
-        for row in rows
-    ]
-    return '\n'.join(lines)
-
-
 def format_optout_list(opts):
     headers = ("Channel Pattern", "Hook Pattern", "Allowed")
     table = [(opt.channel, opt.hook, "true" if opt.allow else "false") for opt in opts]

plugins/core/plugin_control.py

@@ -4,20 +4,7 @@
 
 from cloudbot import hook
 from cloudbot.util import web
-
-
-def gen_markdown_table(headers, rows):
-    rows = list(rows)
-    rows.insert(0, headers)
-    rotated = zip(*reversed(rows))
-
-    sizes = tuple(map(lambda l: max(map(len, l)), rotated))
-    rows.insert(1, tuple(('-' * size) for size in sizes))
-    lines = [
-        "| {} |".format(' | '.join(cell.ljust(sizes[i]) for i, cell in enumerate(row)))
-        for row in rows
-    ]
-    return '\n'.join(lines)
+from cloudbot.util.formatting import gen_markdown_table
 
 
 @hook.command(permissions=["botcontrol"], autohelp=False)