markdoc 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 903c73cf0ff9c9c6b3b9caaf41c0d9fd6ebda60624259acae36e09fa8fd4f81a
-  data.tar.gz: aad92c597c2acc1f40449d7e5f1feaa608140831bbd88d22640e77e23796e620
+  metadata.gz: a313ccc3aef3a547c0d688e8a84dac9097c6fad2e7e5e27e46475311646e1e67
+  data.tar.gz: 4491396850eac63988494d4e68f110db83813304a9cc1bab00458eb5875e497e
 SHA512:
-  metadata.gz: fee4a4c2de9b2350c3df3991c6b6a3c11640fe7026f741e6eb62bb50475fc5adb6492004fb24e304231cbdfa1c9beba8de527b1d79a76e8e497e27bae0d66498
-  data.tar.gz: a2e44199fb3ed992890ce7a74d028b90e2d708c28eaa5cb9db34746784c11c4283d3134ecbdf72bf67c4077a7c2f3256ff5605f3a5bf5113d8b9db6a5cb15501
+  metadata.gz: 949e3a80919e9b9b54f624b659c5bbb72ca0cf9b7746c9080dd8fd08a27b012147099cc2c50397d68694f05a717eb8265d14bb058146b8174416cb59dbce9db3
+  data.tar.gz: a32fbb8e268d9035ff15c4b2d93726e48a9bb5ab3fb9af6e13c95a7d8979f7b6ee57b1d469c23871c6179b3d2b83c0da9c6658351cf8932a66c6ecf777682f7b

data/bin/markdoc

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'markdoc'
 

data/bin/pseudo2svg

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Pseudo code to Graphviz converter
 #

data/bin/sequence2svg

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Sequence definition to image converter using sequence.pic macros.
 #   http://www.umlgraph.org/doc/seq-intro.html

data/lib/markdoc/pseudocode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'polyglot'
 require 'treetop'
 
@@ -13,14 +15,17 @@ module Markdoc
 
     class ActionLiteral < Treetop::Runtime::SyntaxNode
       def out(file)
-        file.write %Q(#{id} [shape=box label="#{label}"]\n)
+        file.write %(#{id} [shape=box label="#{label}"]\n)
       end
+
       def id
         sentence.id
       end
+
       def label
         sentence.value
       end
+
       def ends
         [id]
       end
@@ -28,33 +33,34 @@ module Markdoc
 
     class IfLiteral < Treetop::Runtime::SyntaxNode
       def out(file)
-        file.write %Q(#{id} [shape=diamond label="#{cond.value}"]\n)
+        file.write %(#{id} [shape=diamond label="#{cond.value}"]\n)
 
         unless yes.nil?
           yes.out(file)
-          file.write %Q(  #{id} -> #{yes.id} [label="Yes"]\n)
+          file.write %(  #{id} -> #{yes.id} [label="Yes"]\n)
         end
         unless no.nil?
           no.out(file)
-          file.write %Q(  #{id} -> #{no.id} [label="No"]\n)
+          file.write %(  #{id} -> #{no.id} [label="No"]\n)
         end
       end
 
       def id
         cond.id
       end
+
       def ends
         ary = []
-        if yes.elements.empty?
-          ary << yes.id
-        else
-          ary << yes.elements.last.ends
-        end
-        if no.elements.empty?
-          ary << no.id
-        else
-          ary << no.elements.last.ends
-        end
+        ary << if yes.elements.empty?
+                 yes.id
+               else
+                 yes.elements.last.ends
+               end
+        ary << if no.elements.empty?
+                 no.id
+               else
+                 no.elements.last.ends
+               end
         ary.flatten
       end
     end
@@ -63,6 +69,7 @@ module Markdoc
       def value
         text_value.strip
       end
+
       def id
         @id ||= Register.id
       end
@@ -73,11 +80,10 @@ module Markdoc
         prev = nil
         elements.each do |node|
           next if node.nil?
+
           node.out(file)
-          unless prev.nil?
-            prev.ends.each do |endid|
-              file.write %Q(#{endid} -> #{node.id}\n)
-            end
+          prev&.ends&.each do |endid|
+            file.write %(#{endid} -> #{node.id}\n)
           end
           prev = node
         end
@@ -90,11 +96,11 @@ module Markdoc
       def ends
         ary = []
         elements.each do |node|
-          if node.elements.empty?
-            ary << node.id
-          else
-            ary << node.ends
-          end
+          ary << if node.elements.empty?
+                   node.id
+                 else
+                   node.ends
+                 end
         end
         ary.flatten
       end
@@ -104,7 +110,7 @@ module Markdoc
       parser = PseudocodeParser.new
       tree = parser.parse(code)
 
-      if(tree.nil?)
+      if tree.nil?
         puts parser.failure_reason
         raise "Can't generate graphviz code"
       else
@@ -118,9 +124,7 @@ module Markdoc
           graphviz = file.path
         end
 
-        if format == :graphviz
-          return IO.read(graphviz)
-        end
+        return IO.read(graphviz) if format == :graphviz
 
         image = Tempfile.new([digest, ".#{format}"])
         image.close

data/lib/markdoc/renderer.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'redcarpet'
 require 'pygments'
 
 module Markdoc
   class Renderer < Redcarpet::Render::HTML
-
     def block_code(code, language)
       case language
       when 'pseudo', 'pseudocode'
@@ -17,27 +18,27 @@ module Markdoc
 
     # removes xml or doctype meta info
     def wrap_svg(source)
-      stripped = source.
-                 sub(/<\?xml[^>]+>/i, '').
-                 sub(/<!DOCTYPE[^>]+>/im, '').
-                 gsub(/<!\-\-[^>]+\-\->/, '')
+      stripped = source
+                 .sub(/<\?xml[^>]+>/i, '')
+                 .sub(/<!DOCTYPE[^>]+>/im, '')
+                 .gsub(/<!--[^>]+-->/, '')
 
-      %Q(<div class="svg-holder">\n#{stripped}\n</div>)
+      %(<div class="svg-holder">\n#{stripped}\n</div>)
     end
 
     def doc_header
-      <<-END
-<html>
-<head>
-  <title>Doc</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <style>
-#{IO.read File.expand_path('../../../css/style.css', __FILE__)}
-#{IO.read File.expand_path('../../../css/pygments.css', __FILE__)}
-  </style>
-</head>
-<body>
-END
+      <<~HEADER
+        <html>
+        <head>
+          <title>Doc</title>
+          <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+          <style>
+        #{IO.read File.expand_path('../../css/style.css', __dir__)}
+        #{IO.read File.expand_path('../../css/pygments.css', __dir__)}
+          </style>
+        </head>
+        <body>
+      HEADER
     end
 
     def doc_footer

data/lib/markdoc/sequence.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: false
+
 module Markdoc
   module Sequence
     DEFAULTS = {
       diagram: {
         offsetx: 10,
         offsety: 10,
-        width:   900,
-        height:  600
+        width: 900,
+        height: 600
       },
       role: {
         font: "'Roboto Condensed', sans-serif",
         border: '#3c4260',
-        fill:   '#dcd7d7',
-        radius:  2,
+        fill: '#dcd7d7',
+        radius: 2,
         spacing: 100,
-        width:   100,
-        height:  55,
-        line:    3,
+        width: 100,
+        height: 55,
+        line: 3
       },
       message: {
         color: '#3c4260',
@@ -23,10 +25,10 @@ module Markdoc
         size: 11,
         spacing: 40,
         offset: 100, # from top
-        line:    3,
+        line: 3,
         dash: '4,2'
       }
-    }
+    }.freeze
 
     def self.draw(code)
       diagram = Diagram.new(code)
@@ -60,8 +62,8 @@ module Markdoc
         self.font = args[:ui][:font]
       end
 
-      def <=> o
-        column <=> o.column
+      def <=>(other)
+        column <=> other.column
       end
 
       def type
@@ -80,11 +82,11 @@ module Markdoc
       end
 
       def center
-        x + width/2
+        x + width / 2
       end
 
       def x
-        offsetx + column*(width + spacing)
+        offsetx + column * (width + spacing)
       end
 
       def y
@@ -95,18 +97,18 @@ module Markdoc
         elements = []
         case type
         when :actor
-          elements << %Q[<g transform="translate(#{x+10},0)"><path d="M74,64 a30,30 0 0,0 -27,-27 a16,18 0 1,0 -16,0 a30,30 0, 0,0 -27,27 z" stroke-width="#{line}" fill="#{fill}" stroke="#{border}"/></g>]
-          elements << %Q[<text x="#{x+46-2*id.size}" y="#{y+height-5}" font-family="#{font}" font-size="12" fill="#{border}">#{id}</text>]
+          elements << %[<g transform="translate(#{x + 10},0)"><path d="M74,64 a30,30 0 0,0 -27,-27 a16,18 0 1,0 -16,0 a30,30 0, 0,0 -27,27 z" stroke-width="#{line}" fill="#{fill}" stroke="#{border}"/></g>]
+          elements << %(<text x="#{x + 46 - 2 * id.size}" y="#{y + height - 5}" font-family="#{font}" font-size="12" fill="#{border}">#{id}</text>)
         else
-          elements << %Q[<rect fill="#{fill}" stroke="#{border}" rx="#{radius}" ry="#{radius}" x="#{x}" y="#{y}" width="#{width}" height="#{height}" stroke-width="#{line}"/>]
-          elements << %Q[<text x="#{x+10}" y="#{y+20}" font-family="#{font}" font-size="12" fill="#{border}">#{label}</text>]
+          elements << %(<rect fill="#{fill}" stroke="#{border}" rx="#{radius}" ry="#{radius}" x="#{x}" y="#{y}" width="#{width}" height="#{height}" stroke-width="#{line}"/>)
+          elements << %(<text x="#{x + 10}" y="#{y + 20}" font-family="#{font}" font-size="12" fill="#{border}">#{label}</text>)
         end
 
         x1 = center
         y1 = offsety + height
         x2 = center
         y2 = messages.last.y + 10
-        elements << %Q[<line x1="#{x1}" y1="#{y1}" x2="#{x2}" y2="#{y2}" stroke="#{border}" stroke-width="#{line}"/>]
+        elements << %(<line x1="#{x1}" y1="#{y1}" x2="#{x2}" y2="#{y2}" stroke="#{border}" stroke-width="#{line}"/>)
 
         elements.join("\n")
       end
@@ -134,17 +136,19 @@ module Markdoc
         self.dash    = args[:ui][:dash]
 
         if op.index('~')
-          options << %Q[stroke-dasharray="#{dash}"]
+          options << %(stroke-dasharray="#{dash}")
         elsif op.index('-').nil?
-          raise "Message direction must be one of ->, ~>, <-, <~"
+          raise 'Message direction must be one of ->, ~>, <-, <~'
         end
 
         if op.index('>')
-          self.source, self.dest = args[:role1], args[:role2]
+          self.source = args[:role1]
+          self.dest = args[:role2]
         elsif op.index('<')
-          self.source, self.dest = args[:role2], args[:role1]
+          self.source = args[:role2]
+          self.dest = args[:role1]
         else
-          raise "Message direction must be one of ->, ~>, <-, <~"
+          raise 'Message direction must be one of ->, ~>, <-, <~'
         end
 
         source.messages << self
@@ -155,36 +159,35 @@ module Markdoc
         role1, role2 = *(source < dest ? [source, dest] : [dest, source])
         elements = []
 
+        x1 = role1.center
         if role1.eql?(role2)
-          x1 = role1.center
           y1 = y
           x2 = x1 + 50
           y2 = y1 + spacing
 
-          elements << %Q(<polyline points="#{x1},#{y1} #{x2},#{y1} #{x2},#{y2} #{x1+5},#{y2}" fill="none" stroke-width="2" stroke-linejoin="round" stroke="#{color}" #{options.join ' '}/>)
-          elements << %Q(<polygon points="#{x1+10},#{y2-5} #{x1},#{y2} #{x1+10},#{y2+5}" fill="#{color}"/>)
-          elements << %Q(<text x="#{x1+10}" y="#{y1-5}" font-family="#{font}" font-size="#{size}" fill="#{color}">#{label}</text>)
+          elements << %(<polyline points="#{x1},#{y1} #{x2},#{y1} #{x2},#{y2} #{x1 + 5},#{y2}" fill="none" stroke-width="2" stroke-linejoin="round" stroke="#{color}" #{options.join ' '}/>)
+          elements << %(<polygon points="#{x1 + 10},#{y2 - 5} #{x1},#{y2} #{x1 + 10},#{y2 + 5}" fill="#{color}"/>)
+          elements << %(<text x="#{x1 + 10}" y="#{y1 - 5}" font-family="#{font}" font-size="#{size}" fill="#{color}">#{label}</text>)
         else
-          x1 = role1.center
           x2 = role2.center
 
           if role1 == source
             x2 -= 10
-            elements << %Q(<polygon points="#{x2},#{y-5} #{x2+10},#{y} #{x2},#{y+5}" fill="#{color}"/>)
+            elements << %(<polygon points="#{x2},#{y - 5} #{x2 + 10},#{y} #{x2},#{y + 5}" fill="#{color}"/>)
           else
             x1 += 10
-            elements << %Q(<polygon points="#{x1},#{y-5} #{x1-10},#{y} #{x1},#{y+5}" fill="#{color}"/>)
+            elements << %(<polygon points="#{x1},#{y - 5} #{x1 - 10},#{y} #{x1},#{y + 5}" fill="#{color}"/>)
           end
 
-          elements << %Q(<line x1="#{x1}" y1="#{y}" x2="#{x2}" y2="#{y}" stroke="#{color}" stroke-width="2" #{options.join ' '}/>)
-          elements << %Q(<text x="#{x1+40}" y="#{y-5}" font-family="#{font}" font-size="#{size}" fill="#{color}">#{label}</text>)
+          elements << %(<line x1="#{x1}" y1="#{y}" x2="#{x2}" y2="#{y}" stroke="#{color}" stroke-width="2" #{options.join ' '}/>)
+          elements << %(<text x="#{x1 + 40}" y="#{y - 5}" font-family="#{font}" font-size="#{size}" fill="#{color}">#{label}</text>)
 
-          if comment.size > 0
+          if comment.size.positive?
             x = role2.prev.center + 15
-            elements << %Q(<path fill="#eeeeee" d="M#{x2-30},#{y+1} L#{x2-30},#{y+10} H#{x} V#{y+2*spacing - 25} H#{x2} V#{y+10} H#{x2-20} z" />)
-            elements << %Q(<text x="#{x+5}" y="#{y+23}" font-family="#{font}" font-size="#{size}" fill="#{color}">)
+            elements << %(<path fill="#eeeeee" d="M#{x2 - 30},#{y + 1} L#{x2 - 30},#{y + 10} H#{x} V#{y + 2 * spacing - 25} H#{x2} V#{y + 10} H#{x2 - 20} z" />)
+            elements << %(<text x="#{x + 5}" y="#{y + 23}" font-family="#{font}" font-size="#{size}" fill="#{color}">)
             split(comment).each_with_index do |line, i|
-              elements << %Q(<tspan x="#{x+5}" y="#{y+23+13*i}">#{line}</tspan>)
+              elements << %(<tspan x="#{x + 5}" y="#{y + 23 + 13 * i}">#{line}</tspan>)
             end
             elements << '</text>'
           end
@@ -194,7 +197,7 @@ module Markdoc
       end
 
       def y
-        offset + row*spacing
+        offset + row * spacing
       end
 
       private
@@ -210,10 +213,9 @@ module Markdoc
             line = word
           end
         end
-        ary << line if line.length > 0
+        ary << line if line.length.positive?
         ary
       end
-
     end
 
     class Diagram
@@ -233,14 +235,14 @@ module Markdoc
       end
 
       def find(id)
-        roles.detect{|role| role.id == id.strip} or raise("Non-declared role: #{id}")
+        roles.detect { |role| role.id == id.strip } or raise("Non-declared role: #{id}")
       end
 
       def parse
         input.split("\n").each do |line|
           next if line.strip.empty?
 
-          if matches = line.match(/^(?<id>[a-zA-Z0-9_ \t]+) *= *(?<label>[a-zA-Z0-9_ \t]+)/)
+          if (matches = line.match(/^(?<id>[a-zA-Z0-9_ \t]+) *= *(?<label>[a-zA-Z0-9_ \t]+)/))
             # User = Actor
             roles << Role.new(
               id: matches[:id],
@@ -249,7 +251,7 @@ module Markdoc
               diagram: attributes[:diagram],
               ui: attributes[:role]
             )
-          elsif matches = line.match(/^(?<role1>[a-zA-Z0-9_ \t]+) *(?<op>[<\-~>]{2}) *(?<role2>[a-zA-Z0-9_ \t]+):(?<label>[^#]+)#?(?<comment>.*)/)
+          elsif (matches = line.match(/^(?<role1>[a-zA-Z0-9_ \t]+) *(?<op>[<\-~>]{2}) *(?<role2>[a-zA-Z0-9_ \t]+):(?<label>[^#]+)#?(?<comment>.*)/))
             # User -> Web : Login
             messages << Message.new(
               role1: find(matches[:role1]),
@@ -263,8 +265,8 @@ module Markdoc
             )
             self.rows += 1
             # comment takes 1 more row
-            self.rows += 1 if matches[:comment].length > 0
-          elsif matches = line.match(/^(?<role>[a-zA-Z0-9_ \t]+) *:(?<label>[^#]+)#?(?<comment>.*)/)
+            self.rows += 1 if matches[:comment].length.positive?
+          elsif (matches = line.match(/^(?<role>[a-zA-Z0-9_ \t]+) *:(?<label>[^#]+)#?(?<comment>.*)/))
             # Web : Save the form
             messages << Message.new(
               role1: find(matches[:role]),
@@ -290,11 +292,7 @@ module Markdoc
       end
 
       def print
-        template % {
-          width: width,
-          height: height,
-          content: (roles + messages).map(&:print).join("\n")
-        }
+        format(template, width: width, height: height, content: (roles + messages).map(&:print).join("\n"))
       end
 
       def height
@@ -311,13 +309,12 @@ module Markdoc
       private
 
       def template
-        '<svg xmlns="http://www.w3.org/2000/svg" '+
-          'xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" '+
-          'width="%{width}" height="%{height}" '+
-          'viewBox="0 0 %{width} %{height}">'+
-          '%{content}</svg>'
+        '<svg xmlns="http://www.w3.org/2000/svg" ' \
+          'xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" ' \
+          'width="%<width>s" height="%<height>s" ' \
+          'viewBox="0 0 %<width>s %<height>s">' \
+          '%<content>s</svg>'
       end
-
     end
   end
 end

data/lib/markdoc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Markdoc
-  VERSION = '1.2.1'
+  VERSION = '2.0.0'
 end

data/lib/markdoc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest'
 require 'tempfile'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdoc
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
-- Lkhagva Ochirkhuyag
+- Ochirkhuyag.L
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyglot
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: treetop
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: treetop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: '13.0'
 description: Markdown with support for pseudocode to flowchart and sequence diagram
   generation
 email: ochkoo@gmail.com
@@ -113,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Markdown to HTML converter with diagrams