gitlab-markup 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 216b27009d51155a59aa00c6ea107ba15617c493
-  data.tar.gz: e22c1a28edaff57ff060a98c772b4ded2fc6370c
+  metadata.gz: 82795809627f394f8c953c348cd41b408fb3b205
+  data.tar.gz: 8ad6727f7393d9e0206dc7227b32a14931102448
 SHA512:
-  metadata.gz: 5291f6b31d67fbb75e7630defd4d4d2bb265100d88e48cfb73264c62d828bc65619e197c31d4b4dc25e50063410baec5141308d549ccf1065beea23ddb851419
-  data.tar.gz: 348298df2c87487252cf2174ca51675429d0a877d3bd24ca7d92ababbb0672332ef984e532c6149df3d346dcc203fd1f767a263ed7c39bddc8414357599cd96d
+  metadata.gz: 18a7fde6790047ac49d7269835ef78747e8514b68e5c0cfe1ba8564ce2ddab30b23f9fb9c5fa3767412c1bd129d1b5dfce880c305eaee3bd522ac547dc7efa1a
+  data.tar.gz: b8ace4828588e671f59c6f8a184e9443819542a0b26526a2180d66e8edfdff8c4cf0979e130c27149c6a303aaedf813215463d2600aae000557c0cd77b576493

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 1.6.3 (2017-10-30)
+
+* Support PlantUML caption option and `uml::` directive
+
 ## 1.6.2 (2017-09-20)
 
 * Support PlantUML blocks in reStructuredText

data/lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '1.6.2'
+    VERSION = '1.6.3'
     Version = VERSION
   end
 end

data/lib/github/commands/rest2html

@@ -47,7 +47,7 @@ except:
 import codecs
 import io
 
-from docutils import nodes
+from docutils import nodes, statemachine
 from docutils.parsers.rst import directives, roles
 from docutils.parsers.rst.directives.body import CodeBlock
 from docutils.core import publish_parts
@@ -85,9 +85,25 @@ class PlantumlDirective(CodeBlock):
     picked up in GitLab by the generic Banzai::Filter::PlantumlFilter
     """
 
+    option_spec = CodeBlock.option_spec.copy()
+    option_spec.update({
+        'caption': directives.unchanged
+    })
+
     def run(self):
         self.arguments = ['plantuml']
-        return super(PlantumlDirective, self).run()
+        node = super(PlantumlDirective, self).run()
+
+        if 'caption' in self.options:
+            # create an anonymous container to parse the caption content
+            container = nodes.Element()
+            content = statemachine.StringList([self.options['caption']])
+            self.state.nested_parse(content, self.content_offset, container)
+            caption = nodes.caption(self.options['caption'], '', *container)
+
+            node.append(caption)
+
+        return node
 
 
 class GitHubHTMLTranslator(HTMLTranslator, object):
@@ -112,6 +128,7 @@ class GitHubHTMLTranslator(HTMLTranslator, object):
 
     def visit_literal_block(self, node):
         classes = node.attributes['classes']
+
         if len(classes) >= 2 and classes[0] == 'code':
             language = classes[1]
             del classes[:]
@@ -198,7 +215,9 @@ def main():
     directives.register_directive('doctest', DoctestDirective)
 
     # Render source code in Sphinx plantuml blocks
+    # Also support uml:: directive for compatibility with sphinxcontrib-plantuml
     directives.register_directive('plantuml', PlantumlDirective)
+    directives.register_directive('uml', PlantumlDirective)
 
     parts = publish_parts(text, writer=writer, settings_overrides=SETTINGS)
     if 'html_body' in parts:

data/test/markups/README.rst

@@ -73,7 +73,17 @@ someone@somewhere.org
 
 Press :kbd:`Ctrl+C` to quit
 
-
 .. raw:: html
 
     <p><strong>RAW HTML!</strong></p><style> p {color:blue;} </style>
+
+.. plantuml::
+   :caption: Caption with **bold** and *italic*
+
+   Bob -> Alice: hello
+   Alice -> Bob: Go Away
+
+.. uml::
+
+   Bob -> Alice: hello
+   Alice -> Bob: Go Away

data/test/markups/README.rst.html

@@ -90,4 +90,14 @@ but no problem!</td>
 <p><a href="mailto:someone@somewhere.org">someone@somewhere.org</a></p>
 
 <p>Press <kbd>Ctrl+C</kbd> to quit</p>
-
+<pre>
+<code lang="plantuml">
+Bob -&gt; Alice: hello
+Alice -&gt; Bob: Go Away</code>
+</pre>
+<p>Caption with <strong>bold</strong> and <em>italic</em></p>
+<pre>
+<code lang="plantuml">
+Bob -&gt; Alice: hello
+Alice -&gt; Bob: Go Away</code>
+</pre>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-markup
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport