railroad_diagrams 0.2.0 → 0.3.0

data/lib/railroad_diagrams/text_diagram.rb

@@ -117,24 +117,43 @@ module RailroadDiagrams
         end
       end
 
-      def rect(item, dashed = false)
+      def rect(item, dashed: false)
         rectish('rect', item, dashed)
       end
 
-      def round_rect(item, dashed = false)
+      def round_rect(item, dashed: false)
         rectish('roundrect', item, dashed)
       end
 
+      def max_width(*args)
+        max_width = 0
+        args.each do |arg|
+          width =
+            case arg
+            when TextDiagram
+              arg.width
+            when Array
+              arg.map(&:length).max
+            when Numeric
+              arg.to_s.length
+            else
+              arg.length
+            end
+          max_width = width if width > max_width
+        end
+        max_width
+      end
+
       def pad_l(string, width, pad)
         gap = width - string.length
-        raise "Gap #{gap} must be a multiple of pad string '#{pad}'" unless gap % pad.length == 0
+        raise "Gap #{gap} must be a multiple of pad string '#{pad}'" unless (gap % pad.length).zero?
 
         (pad * (gap / pad.length)) + string
       end
 
       def pad_r(string, width, pad)
         gap = width - string.length
-        raise "Gap #{gap} must be a multiple of pad string '#{pad}'" unless gap % pad.length == 0
+        raise "Gap #{gap} must be a multiple of pad string '#{pad}'" unless (gap % pad.length).zero?
 
         string + (pad * (gap / pad.length))
       end
@@ -169,54 +188,57 @@ module RailroadDiagrams
 
       def rectish(rect_type, data, dashed)
         line_type = dashed ? '_dashed' : ''
-        parts = get_parts([
-                            "#{rect_type}_top_left",
-                            "#{rect_type}_left#{line_type}",
-                            "#{rect_type}_bot_left",
-                            "#{rect_type}_top_right",
-                            "#{rect_type}_right#{line_type}",
-                            "#{rect_type}_bot_right",
-                            "#{rect_type}_top#{line_type}",
-                            "#{rect_type}_bot#{line_type}",
-                            'line',
-                            'cross'
-                          ])
-
-        item_td = data.is_a?(TextDiagram) ? data : new(0, 0, [data.to_s])
-
-        lines = [parts[6] * (item_td.width + 2)]
-        lines += item_td.expand(1, 1, 0, 0).lines.map { |line| " #{line} " }
-        lines << (parts[7] * (item_td.width + 2))
+        top_left, ctr_left, bot_left, top_right, ctr_right, bot_right, top_horiz, bot_horiz, line, cross =
+          get_parts([
+                      "#{rect_type}_top_left",
+                      "#{rect_type}_left#{line_type}",
+                      "#{rect_type}_bot_left",
+                      "#{rect_type}_top_right",
+                      "#{rect_type}_right#{line_type}",
+                      "#{rect_type}_bot_right",
+                      "#{rect_type}_top#{line_type}",
+                      "#{rect_type}_bot#{line_type}",
+                      'line',
+                      'cross'
+                    ])
+
+        item_td = data.is_a?(TextDiagram) ? data : new(0, 0, [data])
+
+        lines = [top_horiz * (item_td.width + 2)]
+        if data.is_a?(TextDiagram)
+          lines += item_td.expand(1, 1, 0, 0).lines
+        else
+          (0...item_td.lines.length).each do |i|
+            lines += [" #{item_td.lines[i]} "]
+          end
+        end
+        lines += [(bot_horiz * (item_td.width + 2))]
 
         entry = item_td.entry + 1
         exit = item_td.exit + 1
 
-        left_max = [parts[0], parts[1], parts[2]].map(&:size).max
-        lefts = Array.new(lines.size, parts[1].ljust(left_max))
-        lefts[0] = parts[0].ljust(left_max, parts[6])
-        lefts[-1] = parts[2].ljust(left_max, parts[7])
-        lefts[entry] = parts[9].ljust(left_max) if data.is_a?(TextDiagram)
+        left_max_width = max_width(top_left, ctr_left, bot_left)
+        lefts = [pad_r(ctr_left, left_max_width, ' ')] * lines.length
+        lefts[0] = pad_r(top_left, left_max_width, top_horiz)
+        lefts[-1] = pad_r(bot_left, left_max_width, bot_horiz)
+        lefts[entry] = cross if data.is_a?(TextDiagram)
 
-        right_max = [parts[3], parts[4], parts[5]].map(&:size).max
-        rights = Array.new(lines.size, parts[4].rjust(right_max))
-        rights[0] = parts[3].rjust(right_max, parts[6])
-        rights[-1] = parts[5].rjust(right_max, parts[7])
-        rights[exit] = parts[9].rjust(right_max) if data.is_a?(TextDiagram)
+        right_max_width = max_width(top_right, ctr_right, bot_right)
+        rights = [pad_l(ctr_right, right_max_width, ' ')] * lines.length
+        rights[0] = pad_l(top_right, right_max_width, top_horiz)
+        rights[-1] = pad_l(bot_right, right_max_width, bot_horiz)
+        rights[exit] = cross if data.is_a?(TextDiagram)
 
-        new_lines = lines.each_with_index.map do |line, i|
-          lefts[i] + line + rights[i]
-        end
+        lines = enclose_lines(lines, lefts, rights)
 
-        lefts = Array.new(lines.size, ' ')
-        lefts[entry] = parts[8]
-        rights = Array.new(lines.size, ' ')
-        rights[exit] = parts[8]
+        lefts = [' '] * lines.length
+        lefts[entry] = line
+        rights = [' '] * lines.length
+        rights[exit] = line
 
-        new_lines = new_lines.each_with_index.map do |line, i|
-          lefts[i] + line + rights[i]
-        end
+        lines = enclose_lines(lines, lefts, rights)
 
-        new(entry, exit, new_lines)
+        new(entry, exit, lines)
       end
     end
 
@@ -227,12 +249,17 @@ module RailroadDiagrams
       @exit = exit
       @lines = lines.dup
       @height = lines.size
-      @width = lines.empty? ? 0 : lines.first.size
+      @width = lines.any? ? lines[0].length : 0
+
+      raise "Entry is not within diagram vertically:\n#{dump(false)}" unless entry <= lines.length
+      raise "Exit is not within diagram vertically:\n#{dump(false)}" unless exit <= lines.length
 
-      validate
+      lines.each do |line|
+        raise "Diagram data is not rectangular:\n#{dump(false)}" unless lines[0].length == line.length
+      end
     end
 
-    def alter(new_entry = nil, new_exit = nil, new_lines = nil)
+    def alter(new_entry: nil, new_exit: nil, new_lines: nil)
       self.class.new(
         new_entry || @entry,
         new_exit || @exit,
@@ -310,23 +337,33 @@ module RailroadDiagrams
       )
     end
 
-    private
-
-    def validate
-      return if @lines.empty?
-
-      line_length = @lines.first.size
-      @lines.each do |line|
-        raise ArgumentError, "Diagram is not rectangular:\n#{inspect}" unless line.size == line_length
+    def dump(show = true)
+      result = "height=#{@height}; len(lines)=#{@lines.length}"
+
+      result += "; entry outside diagram: entry=#{@ntry}" if @entry > @lines.length
+      result += "; exit outside diagram: exit=#{@exit}" if @exit > @lines.length
+
+      (0...[@lines.length, @entry + 1, @exit + 1].max).each do |y|
+        result += "\n[#{format('%03d', y)}]"
+        result += " '#{@lines[y]}' len=#{@lines[y].length}" if y < @lines.length
+        if y == @entry && y == @exit
+          result += ' <- entry, exit'
+        elsif y == @entry
+          result += ' <- entry'
+        elsif y == @exit
+          result += ' <- exit'
+        end
       end
 
-      raise ArgumentError, "Entry point out of bounds:\n#{inspect}" if @entry >= @height
-
-      return unless @exit >= @height
-
-      raise ArgumentError, "Exit point out of bounds:\n#{inspect}"
+      if show
+        puts result
+      else
+        result
+      end
     end
 
+    private
+
     def inspect
       output = ["TextDiagram(entry=#{@entry}, exit=#{@exit}, height=#{@height})"]
       @lines.each_with_index do |line, i|

data/lib/railroad_diagrams/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailroadDiagrams
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/railroad_diagrams.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/railroad_diagrams/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'railroad_diagrams'
+  spec.version = RailroadDiagrams::VERSION
+  spec.authors = ['Yudai Takada']
+  spec.email = ['t.yudai92@gmail.com']
+
+  spec.summary = '🛤️ A tiny Ruby+SVG library for drawing railroad syntax diagrams like JSON.org.'
+  spec.description = 'Generate SVG railroad syntax diagrams, like on JSON.org.'
+  spec.homepage = 'https://github.com/ydah/railroad_diagrams'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = spec.homepage
+  spec.metadata['changelog_uri']         = "#{spec.homepage}/releases"
+  spec.metadata['bug_tracker_uri']       = "#{spec.homepage}/issues"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|sample)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 add('test choice up',
     Diagram.new(
       Choice.new(

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: railroad_diagrams
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yudai Takada
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies: []
 description: Generate SVG railroad syntax diagrams, like on JSON.org.
 email:
@@ -18,7 +17,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".gitignore"
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - MIT
 - README.md
@@ -50,7 +52,7 @@ files:
 - lib/railroad_diagrams/text_diagram.rb
 - lib/railroad_diagrams/version.rb
 - lib/railroad_diagrams/zero_or_more.rb
-- sample/sample.html
+- railroad_diagrams.gemspec
 - test.rb
 homepage: https://github.com/ydah/railroad_diagrams
 licenses:
@@ -61,7 +63,6 @@ metadata:
   changelog_uri: https://github.com/ydah/railroad_diagrams/releases
   bug_tracker_uri: https://github.com/ydah/railroad_diagrams/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: "\U0001F6E4️ A tiny Ruby+SVG library for drawing railroad syntax diagrams
   like JSON.org."