seafoam 0.11 → 0.14

data/lib/seafoam/json_writer.rb

@@ -1,4 +1,6 @@
-require 'json'
+# frozen_string_literal: true
+
+require "json"
 
 module Seafoam
   # Write files in a JSON format.
@@ -30,26 +32,28 @@ module Seafoam
         name: name,
         props: graph.props,
         nodes: nodes,
-        edges: edges
+        edges: edges,
       }
 
       @out.puts JSON.pretty_generate(prepare_json(object))
     end
 
-    def self.prepare_json(object)
-      case object
-      when Float
-        if object.nan?
-          '[NaN]'
+    class << self
+      def prepare_json(object)
+        case object
+        when Float
+          if object.nan?
+            "[NaN]"
+          else
+            object
+          end
+        when Array
+          object.map { |o| prepare_json(o) }
+        when Hash
+          object.transform_values { |v| prepare_json(v) }
         else
           object
         end
-      when Array
-        object.map { |o| prepare_json(o) }
-      when Hash
-        object.transform_values { |v| prepare_json(v) }
-      else
-        object
       end
     end
   end

data/lib/seafoam/markdown_writer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Seafoam
+  # A writer from graphs to Markdown format, with an embedded Mermaid graph.
+  class MarkdownWriter
+    def initialize(stream)
+      @stream = stream
+    end
+
+    # Write a graph.
+    def write_graph(graph)
+      @stream.puts "```mermaid"
+      mermaid = MermaidWriter.new(@stream)
+      mermaid.write_graph(graph)
+      @stream.puts "```"
+    end
+  end
+end

data/lib/seafoam/mermaid_writer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Seafoam
+  # A writer from graphs to the Mermaid format. Re-uses the Graphviz writer,
+  # just adapting for the syntax. Attributes are cherry-picked, and more
+  # things are left to defaults.
+  class MermaidWriter < GraphvizWriter
+    def initialize(*args)
+      super(*args)
+      @link_style_counter = 0
+    end
+
+    protected
+
+    def start_graph(_attrs)
+      # Ignore bgcolor, as I can't figure out how to do it in Mermaid
+      @stream.puts "flowchart TD"
+    end
+
+    def end_graph
+      # Nothing to do
+    end
+
+    def start_subgraph(id)
+      @stream.puts "  subgraph B#{id}"
+    end
+
+    def end_subgraph
+      @stream.puts "  end"
+    end
+
+    def output_node(indent, id, attrs)
+      case attrs[:shape]
+      when "rectangle"
+        shape = ["(", ")"]
+      when "oval"
+        shape = ["([", "])"]
+      when "diamond"
+        shape = ["{{", "}}"]
+      end
+      @stream.puts "#{indent}#{id}#{shape[0]}#{attrs[:label].inspect}#{shape[1]}"
+      @stream.puts "#{indent}style #{id} fill:#{attrs[:fillcolor]},stroke:#{attrs[:color]},color:#{attrs[:fontcolor]};"
+    end
+
+    def output_edge(from, to, attrs)
+      @stream.puts "  #{from} --> #{to}"
+      link_counter = (@link_style_counter += 1) - 1
+      penwidth = attrs[:penwidth]
+      @stream.puts "  linkStyle #{link_counter} stroke:#{attrs[:color]},stroke-width:#{penwidth}px;"
+    end
+  end
+end

data/lib/seafoam/passes/fallback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Seafoam
   module Passes
     # The fallback pass always applies, and adds some basic properties.
@@ -5,21 +7,23 @@ module Seafoam
     # can emit a graph with 'label' properties and we can do something useful
     # with it.
     class FallbackPass < Pass
-      def self.applies?(_graph)
-        true
+      class << self
+        def applies?(_graph)
+          true
+        end
       end
 
       def apply(graph)
         graph.nodes.each_value do |node|
-          if node.props[:label].nil? && node.props['label']
-            node.props[:label] = node.props['label']
+          if node.props[:label].nil? && node.props["label"]
+            node.props[:label] = node.props["label"]
           end
 
-          node.props[:kind] ||= 'other'
+          node.props[:kind] ||= "other"
         end
 
         graph.edges.each do |edge|
-          edge.props[:kind] ||= 'other'
+          edge.props[:kind] ||= "other"
         end
       end
     end