diagrammatron 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4b7974989ef344d2eaaae0c54f82567b8ed9edd9c7fb5d2dfc3e405895efa7
-  data.tar.gz: efdd52da27d648f9da7fed309ba668eae6237eeddd51a703c47c46c45c394435
+  metadata.gz: 8c51dc3c8502bd1626d2a78bccd7e772e60fb25a26e6327879f42144849db598
+  data.tar.gz: 78548d0ad0af86031afecb81bf4fedca42da58420d0de3a0d5063f07cb68538e
 SHA512:
-  metadata.gz: e235a20fb0fb4013e4f0006731743830f84500519d2ab4262b04caa9bae0962bd7da5127cd30e44c9e6bf891b735a02f10fe193149047fa6b54ec0bd6185f2e5
-  data.tar.gz: e6c4c3db889c83d23390ee874379215747fb4336fbb3f1f2f543226ab72788fe948a6394e500ea89ed4d4a013126a324b10fa5b49bf73be9233cd94e9781a024
+  metadata.gz: 03d48ecd6c7e586007dcb470655fff6814e21d32f1921dcb828b35602bea208e48f58d9ba2ea5cdf5f16fb8f633a242a9d43a599c21fbf61d5ffaa631282c827
+  data.tar.gz: 5ed263d065a49d69a031fa140ac0159d58301da26f4b51807573e5b8eefbeca6238301f6953cca5c8b44423a83fec18903a7e9d960a5b3fcf1d4702f1b671233

data/bin/diagrammatron-edges

@@ -6,54 +6,32 @@
 
 require_relative '../lib/common'
 require 'optparse'
-require 'yaml'
 require 'set'
-require 'pathname'
 
 
 def work_copy(src, quiet)
   work = { edges: {}, nodes: [] }
-  # Expected nodes, edges. Other pass-through.
   label2idx = {}
   errors = false
   edge_nodes = Set.new
-  edges = src.fetch('edges', [])
-  unedges = []
+  edges = src['edges']
   selfedges = []
   edges.each_index do |k|
     edge = edges[k]
-    labels = edge.fetch('between', [])
-    if labels.nil? || labels.empty?
-      unedges.push(k)
-    elsif labels.size == 2
-      if labels.first == labels.last
-        selfedges.push(k)
-      else
-        edge_nodes.add labels.first
-        edge_nodes.add labels.last
-        work[:edges][k] = { idx: k, between: [ labels[0], labels[1] ] }
-      end
+    labels = edge['between']
+    if labels.first == labels.last
+      selfedges.push(k)
     else
-      aargh "Edge #{k + 1} does not have two labels in 'between'"
-      errors = true
+      edge_nodes.add labels.first
+      edge_nodes.add labels.last
+      work[:edges][k] = { idx: k, between: [ labels[0], labels[1] ] }
     end
   end
   labeled_nodes = Set.new
-  unlabeled = []
-  nodes = src.fetch('nodes', [])
+  nodes = src['nodes']
   subsets = {}
   nodes.each_index do |k|
     node = nodes[k]
-    unless node.key? 'sid'
-      aargh "Node without sid: #{node.fetch('label', k + 1)}"
-      errors = true
-      next
-    end
-    unless node.key?('xo') && node.key?('yo')
-      aargh "Node without xo or yo: #{node.fetch('label', k + 1)}"
-      errors = true
-      next
-    end
     sid = node['sid']
     subsets[sid] = [] unless subsets.key? sid
     subsets[sid].push(k)
@@ -63,10 +41,6 @@ def work_copy(src, quiet)
       xo: node['xo'] * 2, # Make room for edge coordinates.
       yo: node['yo'] * 2
     })
-    unless node.key? 'label'
-      unlabeled.push k
-      next
-    end
     label = node['label']
     if label2idx.key?(label) && edge_nodes.member?(label)
       aargh "Edge-referred label used twice: #{label}"
@@ -80,12 +54,14 @@ def work_copy(src, quiet)
     aargh "Edges refer to missing node labels: #{missing.to_a.join(' ')}"
     errors = true
   end
+  unless selfedges.empty?
+    info = selfedges.map { |k| "#{edges[k]['between'].first} (#{k})" }
+    aargh "Edges from node to itself: #{info.join(' ')}"
+    errors = true
+  end
   return nil if errors
   unused = labeled_nodes - edge_nodes
-  [ [ unused.to_a, 'unconnected labeled nodes' ],
-    [ unlabeled, 'unlabeled nodes' ],
-    [ selfedges, 'edges from node to itself' ],
-    [ unedges, 'edges without end-points' ]
+  [ [ unused.to_a, 'unconnected labeled nodes' ]
   ].each do |x|
     next if quiet || x.first.empty?
     aargh("Note, #{x.last}: #{x.first.join(' ')}")
@@ -125,7 +101,7 @@ Segment = Struct.new(:vertical, :cc, :range, :edge_index, :at_node, :segment_ind
     node_subset.each do |n|
       node = work[:nodes][n]
       next unless cc == node[ck]
-      (0..1).each do |k|
+      2.times do |k|
         return true if range[i0] < node[rk] && node[rk] < range[i1]
         next if at_node[k]
         return true if range[k] == node[rk]
@@ -631,7 +607,7 @@ def place_edges(work)
         all.push nil
         all.concat(layered_order(gright, glur).reverse)
         # Give each rational offset using layer index + 1 and layer count + 2.
-        denominator = 2 + all.count { |x| x.nil? }
+        denominator = 2 + all.count(&:nil?)
         layer = 1
         all.each do |sg|
           if sg.nil?
@@ -737,6 +713,8 @@ end
 def main
   input = nil
   output = nil
+  input_schema = 'edges'
+  output_schema = 'place'
   quiet = false
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -757,13 +735,21 @@ def main
       $stdout.puts %(#{opts}
 
 Input YAML file is expected to be the output of diagrammatron-nodes.
+
+Input YAML file schema is returned by:
+diagrammatron-schema #{input_schema}
+
+Output YAML file schema is returned by:
+diagrammatron-schema #{output_schema}
+
+There can be other fields present but they are ignored and retained.
 )
       exit 0
     end
   end
   parser.parse! ARGV
 
-  doc = load_source(input)
+  doc = load_verified(input, input_schema)
   return 2 if doc.nil?
 
   begin
@@ -775,7 +761,7 @@ Input YAML file is expected to be the output of diagrammatron-nodes.
 
   place_edges(work)
   prepare_output(doc, work)
-  dump_result(output, YAML.dump(doc, line_width: 1_000_000), 4)
+  save_verified(output, doc, 4, output_schema)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/diagrammatron-get

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021, 2022 Ismo Kärkkäinen
+# Copyright © 2021-2023 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/common'
 require 'optparse'
-require 'pathname'
 
 
 def template(name = nil)
@@ -28,8 +27,8 @@ def main
     end
     opts.on('-h', '--help', 'Print this help and exit.') do
       $stdout.puts %(#{opts}
-This is used to easily access template files included in the gem without need
-to clone the original repository.
+This is used to easily access template files included in the gem without
+the need to clone the original repository.
 
 Without arguments, lists all templates, template root, and content files
 included in the gem.
@@ -41,7 +40,7 @@ Given a name of a included file, saves it to --output.
   end
   parser.parse! ARGV
 
-  if ARGV.size.zero?
+  if ARGV.empty?
     # List all files in templates directory.
     Dir.entries(template).sort.each do |name|
       next if name.start_with? '.'

data/bin/diagrammatron-nodes

@@ -6,9 +6,7 @@
 
 require_relative '../lib/common'
 require 'optparse'
-require 'yaml'
 require 'set'
-require 'pathname'
 
 
 def vertical(work)
@@ -139,7 +137,7 @@ def shifts(count)
   side = (count / 2.0).ceil
   side = ((side / 4) + ((side % 4).positive? ? 1 : 0)) * 4
   xs = Array.new(side) { |index| Integer((index - side / 2).round) }
-  (0..3).each { |k| xs.push(-xs[k]) }
+  4.times { |k| xs.push(-xs[k]) }
   ys = Array.new(xs)
   xs.rotate!(side / 2 - 1)
   ys.rotate!(side - 1) # First half-way to offset with xs, then like xs.
@@ -281,36 +279,23 @@ def work_copy(src, quiet)
   errors = false
   edge_nodes = Set.new
   edges = src.fetch('edges', [])
-  unedges = []
   selfedges = []
   edges.each_index do |k|
     edge = edges[k]
-    labels = edge.fetch('between', [])
-    if labels.nil? || labels.empty?
-      unedges.push(k)
-    elsif labels.size == 2
-      if labels.first == labels.last
-        selfedges.push(k)
-      else
-        edge_nodes.add labels.first
-        edge_nodes.add labels.last
-        work[:edges].push({ idx: k, between: [ labels[0], labels[1] ] })
-      end
+    labels = edge['between']
+    if labels.first == labels.last
+      selfedges.push(k)
     else
-      aargh "Edge #{k + 1} does not have two labels in 'between'"
-      errors = true
+      edge_nodes.add labels.first
+      edge_nodes.add labels.last
+      work[:edges].push({ idx: k, between: [ labels[0], labels[1] ] })
     end
   end
   labeled_nodes = Set.new
-  unlabeled = []
   nodes = src.fetch('nodes', [])
   nodes.each_index do |k|
     work[:nodes].push({ idx: k })
     node = nodes[k]
-    unless node.key? 'label'
-      unlabeled.push k
-      next
-    end
     label = node['label']
     if label2idx.key?(label) && edge_nodes.member?(label)
       aargh "Edge-referred label used twice: #{label}"
@@ -327,9 +312,7 @@ def work_copy(src, quiet)
   return nil if errors
   unused = labeled_nodes - edge_nodes
   [ [ unused.to_a, 'unconnected labeled nodes' ],
-    [ unlabeled, 'unlabeled nodes' ],
-    [ selfedges, 'edges from node to itself' ],
-    [ unedges, 'edges without end-points' ]
+    [ selfedges, 'edges from node to itself' ]
   ].each do |x|
     next if quiet || x.first.empty?
     aargh("Note, #{x.last}: #{x.first.join(' ')}")
@@ -351,6 +334,8 @@ def prepare_output(doc, work)
 end
 
 def main
+  input_schema = 'nodes'
+  output_schema = 'edges'
   input = nil
   output = nil
   algo = 'pathlength'
@@ -378,22 +363,15 @@ def main
       $stdout.puts %(
 Algorithm names are: #{$algorithms.keys.sort.join(' ')}
 
-Input YAML file is expected to be like:
----
-nodes:
-  - label: something
-  - label: another
-  - ignored: "Since no label. Still placed."
-  - label: "Unused and ok. Still placed."
-edges:
-  - between: [ something, another ]
-  - between: [ something, something ] # Ignored.
-  - between: [ ] # Ignored.
-  - ignored: "Since no between."
-...
+Input YAML file schema is returned by:
+diagrammatron-schema #{input_schema}
+
 There can be other fields present but they are ignored. The nodes will
 receive values xo and yo that indicate horizontal and vertical coordinates.
 
+Output YAML file schema is returned by:
+diagrammatron-schema #{output_schema}
+
 Output is the input file with 'xo', 'yo' and 'sid' added to each node.
 The 'xo' and 'yo' indicate which unique x- and y-coordinate the value is.
 The 'sid' indicates the sub-diagram consisting of connected nodes.
@@ -408,7 +386,7 @@ The 'sid' indicates the sub-diagram consisting of connected nodes.
   end
   algo = $algorithms[algo]
 
-  doc = load_source(input)
+  doc = load_verified(input, input_schema)
   return 2 if doc.nil?
 
   begin
@@ -420,7 +398,7 @@ The 'sid' indicates the sub-diagram consisting of connected nodes.
 
   algo.call(work)
   prepare_output(doc, work)
-  dump_result(output, YAML.dump(doc, line_width: 1_000_000), 4)
+  save_verified(output, doc, 4, output_schema)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/diagrammatron-place

@@ -1,18 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021, 2022 Ismo Kärkkäinen
+# Copyright © 2021-2023 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/common'
 require 'optparse'
-require 'yaml'
 require 'set'
-require 'pathname'
 
-def info(msg, return_value = nil)
+
+def info(msg)
   $stderr.puts(msg) unless $QUIET
-  return_value
 end
 
 BoundingBox = Struct.new(:xmin, :ymin, :xmax, :ymax) do
@@ -91,22 +89,19 @@ end
 
 def work_copy(src)
   work = { edges: {}, nodes: {} }
-  # Expected nodes, edges. Other pass-through.
-  nodes = src.fetch('nodes', [])
+  nodes = src['nodes']
   nodes.each_index do |k|
     node = nodes[k]
-    sid = node.fetch('sid', nil)
-    xo = node.fetch('xo', nil)
-    yo = node.fetch('yo', nil)
-    next if sid.nil? || xo.nil? || yo.nil?
+    sid = node['sid']
+    xo = node['xo']
+    yo = node['yo']
     work[:nodes][sid] = work[:nodes].fetch(sid, []).push(Node.new(k, sid, xo, yo))
   end
-  edges = src.fetch('edges', [])
+  edges = src['edges']
   edges.each_index do |k|
     edge = edges[k]
-    path = edge.fetch('path', nil)
-    sid = edge.fetch('sid', nil)
-    next if path.nil? || sid.nil?
+    path = edge['path']
+    sid = edge['sid']
     work[:edges][sid] = work[:edges].fetch(sid, []).push(Edge.new(k, sid, path))
   end
   work[:subsets] = work[:nodes].keys.to_set.merge(work[:edges].keys.to_set).to_a
@@ -140,7 +135,7 @@ def area_order(bbs)
   end
   order.sort! do |a, b|
     d = area_compare(a[1], b[1])
-    (d != 0) ? d : (a[0] <=> b[0])
+    d.zero? ? (a[0] <=> b[0]) : d
   end
   order
 end
@@ -362,6 +357,7 @@ $QUIET = false
 def main
   input = nil
   output = nil
+  input_output_schema = 'edges'
   algo = 'tallwide'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -389,10 +385,13 @@ def main
       $stdout.puts %(
 Algorithm names are: #{$algorithms.keys.sort.join(' ')}
 
-Input YAML file is expected to be the output of diagrammatron-edges.
+Input and output YAML file schema is returned by:
+diagrammatron-schema #{input_output_schema}
+
+There can be other fields present but they are ignored and retained.
 
-Output is the input file with 'xo' and 'yo' modified so that the sub-diagrams
-do not overlap.
+Output is the input file with 'xo', 'yo', and 'path' modified to remove
+overlap between sub-diagrams and edges.
 )
       exit 0
     end
@@ -415,7 +414,7 @@ do not overlap.
   end
   algo = $algorithms[algo]
 
-  doc = load_source(input)
+  doc = load_verified(input, input_output_schema)
   return 2 if doc.nil?
 
   begin
@@ -427,7 +426,7 @@ do not overlap.
 
   algo.call(work)
   prepare_output(doc, work)
-  dump_result(output, YAML.dump(doc, line_width: 1_000_000), 4)
+  save_verified(output, doc, 4, input_output_schema)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/diagrammatron-prune

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021 Ismo Kärkkäinen
+# Copyright © 2021-2023 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/common'
 require 'optparse'
-require 'yaml'
 require 'set'
-require 'pathname'
 
 
 def prune_array(original, matching, keep)
@@ -26,7 +24,12 @@ def prune(doc, patterns, keep)
   nodes = doc.fetch('nodes', [])
   matching = Array.new(nodes.size, false)
   nodes.each_index do |k|
-    label = nodes[k].fetch('label', '')
+    label = nodes[k].fetch('label', nil)
+    if label.nil?
+      # Schemas require 'label' to be present.
+      matching[k] = !keep
+      next
+    end
     patterns.each do |p|
       next unless p.match(label)
       matching[k] = true
@@ -40,10 +43,12 @@ def prune(doc, patterns, keep)
   edges.each_index do |k|
     between = edges[k].fetch('between', [])
     if between.size != 2
-      matching[k] = keep # Removing these suppresses later warnings.
+      matching[k] = !keep # Schemas require between size to be 2.
     elsif keep
+      # Both ends matched reversed remove rule, keep the edge.
       matching[k] = (labels.member?(between[0]) && labels.member?(between[1]))
     else
+      # If either end matched remove rule, remove the edge.
       matching[k] = (labels.member?(between[0]) || labels.member?(between[1]))
     end
   end
@@ -53,6 +58,7 @@ end
 def main
   input = nil
   output = nil
+  input_output_schema = 'nodes'
   keep = false
   ENV['POSIXLY_CORRECT'] = '1' # Leaves patterns as they are.
   parser = OptionParser.new do |opts|
@@ -75,6 +81,8 @@ def main
 Patterns are strings used to create Ruby Regexps.
 
 Input YAML file is expected to be dot_json2diagrammatron output.
+Input and output YAML file schema is returned by:
+diagrammatron-schema #{input_output_schema}
 
 Output is the input file with nodes that have labels that match patterns
 removed or kept depending on options. Edges to removed nodes are removed.
@@ -89,7 +97,7 @@ removed or kept depending on options. Edges to removed nodes are removed.
   rescue StandardError => e
     return aargh("Error creating Regexp: #{e}", 1)
   end
-  doc = load_source(input)
+  doc = load_verified(input, input_output_schema)
   return 2 if doc.nil?
 
   begin
@@ -98,7 +106,7 @@ removed or kept depending on options. Edges to removed nodes are removed.
     return aargh('Error processing input.', 3)
   end
 
-  dump_result(output, YAML.dump(doc, line_width: 1_000_000), 4)
+  save_verified(output, doc, 4, input_output_schema)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/diagrammatron-render

@@ -61,8 +61,7 @@ def separate_coordinates(doc)
     push_coords(xcoords, ycoords, ckd2count, node.clone, 1, 1, true)
   end
   doc['edges'].each do |edge|
-    path = edge.fetch('path', nil)
-    next if path.nil?
+    path = edge['path']
     xdirection, ydirection = end_directions(path[0], path[1])
     push_coords(xcoords, ycoords, ckd2count, path[0], xdirection, ydirection)
     (1...(path.size - 1)).each do |k|
@@ -99,7 +98,7 @@ class Styles
     @d = base_styles(base_styles({}, template_styles, 'diagram'), diagram_styles, 'diagram')
   end
 
-  def fill(mapping, type_name, item)
+  def fill(mapping, _type_name, item)
     styles = item.fetch('style', [ 'default' ])
     styles = [ styles ] unless styles.is_a?(Array)
     s = {}
@@ -112,7 +111,7 @@ class Styles
     end
     s.merge!(mapping['default']) unless found # Merge default at least.
     # Keep values specified explicitly.
-    item.merge!(s) { |key, existing, from_template| existing || from_template }
+    item.merge!(s) { |_key, existing, from_template| existing || from_template }
   end
 
   def apply_node_styles(node)
@@ -169,7 +168,7 @@ def estimate_sizes(doc, ckd2count)
   $render = SizeEstimation.new(ckd2count, doc)
   doc['nodes'].each do |node|
     $render.node = node
-    label = node.fetch('label', 'unnamed')
+    label = node['label']
     style = node.fetch('style', 'default')
     code = node.fetch('size_estimator',
       %(raise NotImplementedError, "No size estimator for style: #{style}"))
@@ -187,7 +186,7 @@ end
 def maxima(doc)
   xmax = Hash.new(0)
   ymax = Hash.new(0)
-  doc.fetch('nodes', []).each do |node|
+  doc['nodes'].each do |node|
     xmax[node['xo']] = [ node['w'], xmax[node['xo']] ].max
     ymax[node['yo']] = [ node['h'], ymax[node['yo']] ].max
   end
@@ -195,7 +194,7 @@ def maxima(doc)
 end
 
 def apply_maxima(doc, xmax, ymax)
-  doc.fetch('nodes', []).each do |node|
+  doc['nodes'].each do |node|
     node['w'] = xmax[node['xo']]
     node['h'] = ymax[node['yo']]
   end
@@ -258,13 +257,12 @@ class Render
   def dimensions
     w = 0
     h = 0
-    @doc.fetch('nodes', []).each do |node|
+    @doc['nodes'].each do |node|
       w = [ w, node['xo'] + node['w'] ].max
       h = [ h, node['yo'] + node['h'] ].max
     end
-    @doc.fetch('edges', []).each do |edge|
-      path = edge.fetch('path', nil)
-      next if path.nil?
+    @doc['edges'].each do |edge|
+      path = edge['path']
       path.each do |p|
         w = [ w, p['xo'] ].max
         h = [ h, p['yo'] ].max
@@ -305,6 +303,7 @@ end
 def main
   template = nil
   input = nil
+  input_schema = 'render'
   output = nil
   styles = nil
   parser = OptionParser.new do |opts|
@@ -324,7 +323,10 @@ def main
     end
     opts.on('-h', '--help', 'Print this help and exit.') do
       $stdout.puts %(#{opts}
-Input YAML file is expected to be the output of diagrammatron-place.
+Input YAML file schema is returned by:
+diagrammatron-schema #{input_schema}
+
+There can be other fields present as needed by the template.
 
 Output is the file produced by the erb-template.
 )
@@ -347,15 +349,15 @@ Output is the file produced by the erb-template.
     end
   end
 
-  doc = load_source(input)
+  doc = load_verified(input, input_schema)
   return 2 if doc.nil?
 
   styles = Styles.new(template.fetch('styles', {}), doc.fetch('styles', {}))
-  doc.fetch('nodes', []).each do |node|
+  doc['nodes'].each do |node|
     styles.apply_node_styles(node)
-    node['text'] = node.fetch('text', node.fetch('label', '')).split("\n")
+    node['text'] = node.fetch('text', node['label']).split("\n")
   end
-  doc.fetch('edges', []).each { |edge| styles.apply_edge_styles(edge) }
+  doc['edges'].each { |edge| styles.apply_edge_styles(edge) }
   doc['diagram'] = {} unless doc.key? 'diagram'
   styles.apply_diagram_styles(doc['diagram'])
 
@@ -376,16 +378,16 @@ Output is the file produced by the erb-template.
   remap_coordinates(xcoords, xmax, x2min, doc.dig('diagram', 'edge_gap'))
   remap_coordinates(ycoords, ymax, y2min, doc.dig('diagram', 'edge_gap'))
 
-  doc['nodes'] = reverse_depth_sort(doc.fetch('nodes', []))
-  doc['edges'] = reverse_depth_sort(doc.fetch('edges', []))
-  all = doc.fetch('nodes', []).map do |a|
+  doc['nodes'] = reverse_depth_sort(doc['nodes'])
+  doc['edges'] = reverse_depth_sort(doc['edges'])
+  all = doc['nodes'].map do |a|
     {
       'kind' => 'node',
       'depth' => a.fetch('depth', 0),
       'item' => a
     }
   end
-  all.concat(doc.fetch('edges', []).map do |a|
+  all.concat(doc['edges'].map do |a|
     {
       'kind' => 'edge',
       'depth' => a.fetch('depth', 0),