seafoam 0.12 → 0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5365ea61783b2be678609c214262d4df073fa4e66df60e9370b6fd33dd73825a
-  data.tar.gz: 322fe5170082c57d51120c3fa43910ca2e79a7839737167955ad1f330084af83
+  metadata.gz: 3bd98e20ee30268f65b81cdee7e286133d09d3daa1a5906500e46391fb8a77e8
+  data.tar.gz: 19e94f385a5e0b056b0431f9385b0ca75796b368e5b767a537406c4f87f83329
 SHA512:
-  metadata.gz: 33cdf9e0f73e9a41d11ee2c19f60b015f8fe5168ddd92eaee1a254c13c6296e8696514858e0fc0c77c583657c3d01b2292919077f9131768198801bd9610dbc9
-  data.tar.gz: 2354dd4f1c5d87c83d265577a0e64b5130cd9dc7de46e6222629b985bdac038b6977f3fe10ffc2624e45b2cc56dbd67ea243734a528a17eab780a80c00996621
+  metadata.gz: 91d9279f98008fd449f4be3ecf4d45fdf2ddac3e3eb1f6eae0b0451a2dbb58d3a52b95fa12be3a805aa208ccb56033fe32b093f653331907cbc3d51b3d033f56
+  data.tar.gz: f2bb55b41d82f3176dcfc1bbfc46bdd01711ac8a4e61995338e5e127a196f43b40eff3ef81b2e16448dd86f4535a215d83accf7643f5f92787ff9b1d74c964b9

data/lib/seafoam/commands.rb

@@ -414,6 +414,28 @@ module Seafoam
           out_file = args.shift
           explicit_out_file = true
           raise ArgumentError, 'no file for --out' unless out_file
+
+          out_ext = File.extname(out_file).downcase
+          case out_ext
+          when '.pdf'
+            out_format = :pdf
+          when '.svg'
+            out_format = :svg
+          when '.png'
+            out_format = :png
+          when '.dot'
+            out_format = :dot
+          when '.mmd'
+            out_format = :mmd
+          when '.md'
+            out_format = :md
+          else
+            raise ArgumentError, "unknown render format #{out_ext}"
+          end
+        when '--md'
+          out_file = @out
+          out_format = :md
+          explicit_out_file = true
         when '--spotlight'
           spotlight_arg = args.shift
           raise ArgumentError, 'no list for --spotlight' unless spotlight_arg
@@ -445,20 +467,7 @@ module Seafoam
         end
       end
       out_file ||= 'graph.pdf'
-      out_ext = File.extname(out_file).downcase
-      case out_ext
-      when '.pdf'
-        out_format = :pdf
-      when '.svg'
-        out_format = :svg
-      when '.png'
-        out_format = :png
-      when '.dot'
-        out_format = :dot
-      else
-        raise ArgumentError, "unknown render format #{out_ext}"
-      end
-
+      out_format ||= :pdf
       with_graph(file, graph_index) do |parser|
         parser.skip_graph_header
         graph = parser.read_graph
@@ -473,10 +482,29 @@ module Seafoam
           end
           spotlight.shade
         end
-        if out_format == :dot
-          File.open(out_file, 'w') do |stream|
-            writer = GraphvizWriter.new(stream)
-            writer.write_graph graph, false, draw_blocks
+        case out_format
+        when :dot, :mmd, :md
+          action = lambda do |stream|
+            case out_format
+            when :dot
+              writer = GraphvizWriter.new(stream)
+              writer.write_graph graph, false, draw_blocks
+            when :mmd
+              writer = MermaidWriter.new(stream)
+              writer.write_graph graph
+            when :md
+              writer = MarkdownWriter.new(stream)
+              writer.write_graph graph
+            else
+              raise
+            end
+          end
+          if out_file.is_a?(String)
+            File.open(out_file, 'w') do |stream|
+              action.call stream
+            end
+          else
+            action.call out_file
           end
         else
           begin

data/lib/seafoam/graal/graph_description.rb

@@ -4,13 +4,12 @@ module Seafoam
     class GraphDescription
       ATTRIBUTES = %i[branches calls deopts linear loops]
 
-      ATTRIBUTES.each { |attr| attr_accessor(attr) }
+      ATTRIBUTES.each { |attr| attr_accessor(attr) unless attr == :linear }
 
       def initialize
         @branches = false
         @calls = false
         @deopts = false
-        @linear = false
         @loops = false
       end
 

data/lib/seafoam/markdown_writer.rb

@@ -0,0 +1,16 @@
+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,40 @@
+module Seafoam
+  # A writer from graphs to the Mermaid format.
+  class MermaidWriter
+    def initialize(stream)
+      @stream = stream
+    end
+
+    # Write a graph.
+    def write_graph(graph)
+      @stream.puts 'flowchart TD'
+      write_nodes graph
+      write_edges graph
+    end
+
+    private
+
+    # Write node declarations.
+    def write_nodes(graph)
+      graph.nodes.each_value do |node|
+        write_node node
+      end
+    end
+
+    def write_node(node)
+      @stream.puts "  node#{node.id}[#{node.props[:label].inspect}]"
+    end
+
+    # Write edge declarations.
+
+    def write_edges(graph)
+      graph.edges.each do |edge|
+        write_edge edge
+      end
+    end
+
+    def write_edge(edge)
+      @stream.puts "  node#{edge.from.id} --> node#{edge.to.id}"
+    end
+  end
+end

data/lib/seafoam/version.rb

@@ -1,5 +1,5 @@
 module Seafoam
   MAJOR_VERSION = 0
-  MINOR_VERSION = 12
+  MINOR_VERSION = 13
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}"
 end

data/lib/seafoam.rb

@@ -14,5 +14,7 @@ require 'seafoam/spotlight'
 require 'seafoam/isabelle_writer'
 require 'seafoam/json_writer'
 require 'seafoam/graphviz_writer'
+require 'seafoam/mermaid_writer'
+require 'seafoam/markdown_writer'
 require 'seafoam/commands'
 require 'seafoam/formatters/formatters'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.13'
 platform: ruby
 authors:
 - Chris Seaton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,8 @@ files:
 - lib/seafoam/graphviz_writer.rb
 - lib/seafoam/isabelle_writer.rb
 - lib/seafoam/json_writer.rb
+- lib/seafoam/markdown_writer.rb
+- lib/seafoam/mermaid_writer.rb
 - lib/seafoam/passes.rb
 - lib/seafoam/passes/fallback.rb
 - lib/seafoam/passes/graal.rb