rsyntaxtree 1.0.8 → 1.1.1

data/lib/rsyntaxtree/utils.rb

@@ -1,63 +1,59 @@
-#!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
-
-#==========================
-# utils.rb
-#==========================
-#
-# Image utility functions to inspect text font metrics
-# Copyright (c) 2007-2021 Yoichiro Hasebe <yohasebe@gmail.com>
-
-require 'rmagick'
-include Magick
-
-class String
-  def contains_cjk?
-    !!(self.gsub(WHITESPACE_BLOCK, "") =~ /\p{Han}|\p{Katakana}|\p{Hiragana}|\p{Hangul}|[^\x01-\x7E]/)
-  end
-
-  def contains_emoji?
-    !!(self.gsub(WHITESPACE_BLOCK, "").gsub(/\d/, "") =~ /\p{Emoji}/)
-  end
-
-  def all_emoji?
-    !!(self.gsub(WHITESPACE_BLOCK, "").gsub(/\d/, "") =~ /\A\p{Emoji}[\p{Emoji}\s]*\z/)
-  end
-
-  def split_by_emoji
-    results = []
-    self.split(//).each do |ch|
-      case ch
-      when /\d/, WHITESPACE_BLOCK
-        results << {:type => :normal, :char => ch}
-      when /\p{Emoji}/
-        results << {:type => :emoji, :char => ch}
-      else
-        results << {:type => :normal, :char => ch}
-      end
-    end
-    results.reject{|string| string == ""}
-  end
-end
-
-module FontMetrics
-  def get_metrics(text, font, fontsize, font_style, font_weight)
-    background = Image.new(1, 1)
-    gc = Draw.new
-    gc.annotate(background, 0, 0, 0, 0, text) do |gc|
-      gc.font = font
-      gc.font_style = font_style == :italic ? ItalicStyle : NormalStyle
-      gc.font_weight = font_weight == :bold ? BoldWeight : NormalWeight
-      gc.pointsize = fontsize
-      gc.gravity = CenterGravity
-      gc.stroke = 'none'
-      gc.kerning = 0
-      gc.interline_spacing = 0
-      gc.interword_spacing = 0
-    end
-    metrics = gc.get_multiline_type_metrics(background, text)
-    return metrics
-  end
-  module_function :get_metrics
-end
-
+# frozen_string_literal: true
+
+#==========================
+# utils.rb
+#==========================
+#
+# Image utility functions to inspect text font metrics
+# Copyright (c) 2007-2023 Yoichiro Hasebe <yohasebe@gmail.com>
+
+require 'rmagick'
+
+class String
+  def contains_cjk?
+    !!(gsub(WHITESPACE_BLOCK, "") =~ /\p{Han}|\p{Katakana}|\p{Hiragana}|\p{Hangul}|[^\x01-\x7E]/)
+  end
+
+  def contains_emoji?
+    !!(gsub(WHITESPACE_BLOCK, "").gsub(/\d/, "") =~ /\p{Emoji}/)
+  end
+
+  def all_emoji?
+    !!(gsub(WHITESPACE_BLOCK, "").gsub(/\d/, "") =~ /\A\p{Emoji}[\p{Emoji}\s]*\z/)
+  end
+
+  def split_by_emoji
+    results = []
+    split(//).each do |ch|
+      results << case ch
+                 when /\d/, WHITESPACE_BLOCK
+                   { type: :normal, char: ch }
+                 when /\p{Emoji}/
+                   { type: :emoji, char: ch }
+                 else
+                   { type: :normal, char: ch }
+                 end
+    end
+    results.reject { |string| string == "" }
+  end
+end
+
+module FontMetrics
+  def get_metrics(text, font, fontsize, font_style, font_weight)
+    background = Magick::Image.new(1, 1)
+    gc = Magick::Draw.new
+    gc.annotate(background, 0, 0, 0, 0, text) do |gca|
+      gca.font = font
+      gca.font_style = font_style == :italic ? Magick::ItalicStyle : Magick::NormalStyle
+      gca.font_weight = font_weight == :bold ? Magick::BoldWeight : Magick::NormalWeight
+      gca.pointsize = fontsize
+      gca.gravity = Magick::CenterGravity
+      gca.stroke = 'none'
+      gca.kerning = 0
+      gca.interline_spacing = 0
+      gca.interword_spacing = 0
+    end
+    gc.get_multiline_type_metrics(background, text)
+  end
+  module_function :get_metrics
+end

data/lib/rsyntaxtree/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 module RSyntaxTree
-  VERSION = "1.0.8"
+  VERSION = "1.1.1"
 end
-

data/lib/rsyntaxtree.rb

@@ -1,177 +1,173 @@
-#!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
-
-#==========================
-# rsyntaxtree.rb
-#==========================
-#
-# Facade of rsyntaxtree library.  When loaded by a driver script, it does all
-# the necessary 'require' to use the library.
-# Copyright (c) 2007-2021 Yoichiro Hasebe <yohasebe@gmail.com>
-
-$LOAD_PATH << File.join( File.dirname(__FILE__), 'rsyntaxtree')
-
-FONT_DIR = File.expand_path(File.dirname(__FILE__) + "/../fonts")
-ETYPE_NODE = 1
-ETYPE_LEAF = 2
-SUBSCRIPT_CONST = 0.7
-FONT_SCALING = 2
-WHITESPACE_BLOCK = "￭"
-
-class RSTError < StandardError
-  def initialize(msg="Error: something unexpected occurred")
-    msg.gsub!(WHITESPACE_BLOCK, "<>")
-    super msg
-  end
-end
-
-require 'cgi'
-require 'rsvg2'
-require 'utils'
-require 'element'
-require 'elementlist'
-require 'string_parser'
-require 'svg_graph'
-require 'version'
-require 'rmagick'
-
-module RSyntaxTree
-
-  class RSGenerator
-
-    def initialize(params = {})
-      new_params = {}
-      fontset = {}
-      params.each do |keystr, value|
-        key = keystr.to_sym
-        case key
-        when :data
-          data = value
-          data  = data.gsub('-AMP-', '&')
-            .gsub('-PERCENT-', "%")
-            .gsub('-PRIME-', "'")
-            .gsub('-SCOLON-', ';')
-            .gsub('-OABRACKET-', '<')
-            .gsub('-CABRACKET-', '>')
-            .gsub('¥¥', '\¥')
-            .gsub(/(?<!\\)¥/, "\\")
-          new_params[key] = data
-
-        when :symmetrize, :color, :transparent, :polyline
-          new_params[key] = value && (value != "off" && value != "false") ? true : false
-        when :fontsize
-          new_params[key] = value.to_i * FONT_SCALING
-        when :margin
-          new_params[key] = value.to_i * FONT_SCALING * 5
-        when :vheight
-          new_params[key] = value.to_f
-        when :fontstyle
-          if value == "noto-sans" || value == "sans"
-            fontset[:normal] = FONT_DIR + "/NotoSans-Regular.ttf"
-            fontset[:italic] = FONT_DIR + "/NotoSans-Italic.ttf"
-            fontset[:bold] = FONT_DIR + "/NotoSans-Bold.ttf"
-            fontset[:bolditalic] = FONT_DIR + "/NotoSans-BoldItalic.ttf"
-            fontset[:math] = FONT_DIR + "/NotoSansMath-Regular.ttf"
-            fontset[:cjk] = FONT_DIR + "/NotoSansJP-Regular.otf"
-            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
-            new_params[:fontstyle] = "sans"
-          elsif value == "noto-serif" || value == "serif"
-            fontset[:normal] = FONT_DIR + "/NotoSerif-Regular.ttf"
-            fontset[:italic] = FONT_DIR + "/NotoSerif-Italic.ttf"
-            fontset[:bold] = FONT_DIR + "/NotoSerif-Bold.ttf"
-            fontset[:bolditalic] = FONT_DIR + "/NotoSerif-BoldItalic.ttf"
-            fontset[:math] = FONT_DIR + "/latinmodern-math.otf"
-            fontset[:cjk] = FONT_DIR + "/NotoSerifJP-Regular.otf"
-            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
-            new_params[:fontstyle] = "serif"
-          elsif value == "cjk zenhei" || value == "cjk"
-            fontset[:normal] = FONT_DIR + "/wqy-zenhei.ttf"
-            fontset[:italic] = FONT_DIR + "/NotoSans-Italic.ttf"
-            fontset[:bold] = FONT_DIR + "/NotoSans-Bold.ttf"
-            fontset[:bolditalic] = FONT_DIR + "/NotoSans-BoldItalic.ttf"
-            fontset[:math] = FONT_DIR + "/NotoSansMath-Regular.ttf"
-            fontset[:cjk] = FONT_DIR + "/wqy-zenhei.ttf"
-            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
-            new_params[:fontstyle] = "cjk"
-          end
-        else
-          new_params[key] = value
-        end
-      end
-
-      # defaults to the following
-      @params = {
-        :symmetrize  => true,
-        :color       => true,
-        :transparent => false,
-        :fontsize    => 16,
-        :format      => "png",
-        :leafstyle   => "auto",
-        :filename    => "syntree",
-        :data        => "",
-        :margin      => 0,
-        :vheight     =>  1.0,
-        :polyline    => false,
-      }
-
-      @params.merge! new_params
-      @params[:fontsize]  = @params[:fontsize] * FONT_SCALING
-      @params[:margin]    = @params[:margin] * FONT_SCALING
-      @params[:fontset] = fontset
-
-      $single_X_metrics = FontMetrics.get_metrics("X", fontset[:normal], @params[:fontsize], :normal, :normal)
-      $height_connector_to_text = $single_X_metrics.height / 2.0
-      $single_line_height = $single_X_metrics.height * 2.0
-      $width_half_X = $single_X_metrics.width / 2.0
-      $height_connector = $single_X_metrics.height * 1.0 * @params[:vheight]
-      $h_gap_between_nodes = $single_X_metrics.width * 0.8
-      $box_vertical_margin = $single_X_metrics.height * 0.8
-    end
-
-    def self.check_data(text)
-      if text.to_s == ""
-        raise RSTError, "Error: input text is empty"
-      end
-      StringParser.valid?(text)
-    end
-
-    def draw_png(binary = false)
-      svg = draw_svg
-      rsvg = RSVG::Handle.new_from_data(svg)
-      dim = rsvg.dimensions
-      surface = Cairo::ImageSurface.new(Cairo::FORMAT_ARGB32, dim.width, dim.height)
-      context = Cairo::Context.new(surface)
-      context.render_rsvg_handle(rsvg)
-      b = StringIO.new
-      surface.write_to_png(b)
-      if binary
-        return b
-      else
-        return b.string
-      end
-    end
-
-    def draw_svg
-      sp = StringParser.new(@params[:data].gsub('&', '&amp;'), @params[:fontset], @params[:fontsize])
-      sp.parse
-      graph = SVGGraph.new(sp.get_elementlist, @params)
-      graph.svg_data
-    end
-
-    def draw_tree
-      svg = draw_svg
-      image, data = Magick::Image.from_blob(svg) do |im|
-        im.format = 'svg'
-      end
-      if @params[:format] == "png"
-        image = draw_png(false)
-      else
-        image.to_blob do |im|
-          im.format = @params[:format].upcase
-        end
-      end
-      image
-    end
-  end
-end
-
+# frozen_string_literal: true
+
+#==========================
+# rsyntaxtree.rb
+#==========================
+#
+# Facade of rsyntaxtree library.  When loaded by a driver script, it does all
+# the necessary 'require' to use the library.
+# Copyright (c) 2007-2023 Yoichiro Hasebe <yohasebe@gmail.com>
+
+FONT_DIR = File.expand_path(File.join(__dir__, "/../fonts"))
+ETYPE_NODE = 1
+ETYPE_LEAF = 2
+SUBSCRIPT_CONST = 0.7
+FONT_SCALING = 2
+WHITESPACE_BLOCK = "￭"
+
+class RSTError < StandardError
+  def initialize(msg = "Error: something unexpected occurred")
+    msg.gsub!(WHITESPACE_BLOCK, "<>")
+    super msg
+  end
+end
+
+require_relative 'rsyntaxtree/utils'
+require_relative 'rsyntaxtree/element'
+require_relative 'rsyntaxtree/elementlist'
+require_relative 'rsyntaxtree/svg_graph'
+require_relative 'rsyntaxtree/version'
+require_relative 'rsyntaxtree/string_parser'
+
+require 'cgi'
+require 'rsvg2'
+require 'rmagick'
+
+module RSyntaxTree
+  class RSGenerator
+    def initialize(params = {})
+      new_params = {}
+      fontset = {}
+      params.each do |keystr, value|
+        key = keystr.to_sym
+        case key
+        when :data
+          data = value
+          data = data.gsub('-AMP-', '&')
+                     .gsub('-PERCENT-', "%")
+                     .gsub('-PRIME-', "'")
+                     .gsub('-SCOLON-', ';')
+                     .gsub('-OABRACKET-', '<')
+                     .gsub('-CABRACKET-', '>')
+                     .gsub('¥¥', '\¥')
+                     .gsub(/(?<!\\)¥/, "\\")
+          new_params[key] = data
+
+        when :symmetrize, :color, :transparent, :polyline
+          new_params[key] = value && (value != "off" && value != "false") ? true : false
+        when :fontsize
+          new_params[key] = value.to_i * FONT_SCALING
+        when :margin
+          new_params[key] = value.to_i * FONT_SCALING * 5
+        when :vheight
+          new_params[key] = value.to_f
+        when :fontstyle
+          case value
+          when "noto-sans", "sans"
+            fontset[:normal] = FONT_DIR + "/NotoSans-Regular.ttf"
+            fontset[:italic] = FONT_DIR + "/NotoSans-Italic.ttf"
+            fontset[:bold] = FONT_DIR + "/NotoSans-Bold.ttf"
+            fontset[:bolditalic] = FONT_DIR + "/NotoSans-BoldItalic.ttf"
+            fontset[:math] = FONT_DIR + "/NotoSansMath-Regular.ttf"
+            fontset[:cjk] = FONT_DIR + "/NotoSansJP-Regular.otf"
+            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
+            new_params[:fontstyle] = "sans"
+          when "noto-serif", "serif"
+            fontset[:normal] = FONT_DIR + "/NotoSerif-Regular.ttf"
+            fontset[:italic] = FONT_DIR + "/NotoSerif-Italic.ttf"
+            fontset[:bold] = FONT_DIR + "/NotoSerif-Bold.ttf"
+            fontset[:bolditalic] = FONT_DIR + "/NotoSerif-BoldItalic.ttf"
+            fontset[:math] = FONT_DIR + "/latinmodern-math.otf"
+            fontset[:cjk] = FONT_DIR + "/NotoSerifJP-Regular.otf"
+            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
+            new_params[:fontstyle] = "serif"
+          when "cjk zenhei", "cjk"
+            fontset[:normal] = FONT_DIR + "/wqy-zenhei.ttf"
+            fontset[:italic] = FONT_DIR + "/NotoSans-Italic.ttf"
+            fontset[:bold] = FONT_DIR + "/NotoSans-Bold.ttf"
+            fontset[:bolditalic] = FONT_DIR + "/NotoSans-BoldItalic.ttf"
+            fontset[:math] = FONT_DIR + "/NotoSansMath-Regular.ttf"
+            fontset[:cjk] = FONT_DIR + "/wqy-zenhei.ttf"
+            fontset[:emoji] = FONT_DIR + "/OpenMoji-Black.ttf"
+            new_params[:fontstyle] = "cjk"
+          end
+        else
+          new_params[key] = value
+        end
+      end
+
+      # defaults to the following
+      @params = {
+        symmetrize: true,
+        color: true,
+        transparent: false,
+        fontsize: 16,
+        format: "png",
+        leafstyle: "auto",
+        filename: "syntree",
+        data: "",
+        margin: 0,
+        vheight: 1.0,
+        polyline: false
+      }
+
+      @params.merge! new_params
+      @params[:fontsize]  = @params[:fontsize] * FONT_SCALING
+      @params[:margin]    = @params[:margin] * FONT_SCALING
+      @params[:fontset] = fontset
+      single_x_metrics = FontMetrics.get_metrics("X", fontset[:normal], @params[:fontsize], :normal, :normal)
+      @global = {}
+      @global[:single_x_metrics] = single_x_metrics
+      @global[:height_connector_to_text] = single_x_metrics.height / 2.0
+      @global[:single_line_height] = single_x_metrics.height * 2.0
+      @global[:width_half_x] = single_x_metrics.width / 2.0
+      @global[:height_connector] = single_x_metrics.height * 1.0 * @params[:vheight]
+      @global[:h_gap_between_nodes] = single_x_metrics.width * 0.8
+      @global[:box_vertical_margin] = single_x_metrics.height * 0.8
+    end
+
+    def self.check_data(text)
+      raise RSTError, "Error: input text is empty" if text.to_s == ""
+
+      StringParser.valid?(text)
+    end
+
+    def draw_png(binary = false)
+      svg = draw_svg
+      rsvg = RSVG::Handle.new_from_data(svg)
+      dim = rsvg.dimensions
+      surface = Cairo::ImageSurface.new(Cairo::FORMAT_ARGB32, dim.width, dim.height)
+      context = Cairo::Context.new(surface)
+      context.render_rsvg_handle(rsvg)
+      b = StringIO.new
+      surface.write_to_png(b)
+      if binary
+        b
+      else
+        b.string
+      end
+    end
+
+    def draw_svg
+      sp = StringParser.new(@params[:data].gsub('&', '&amp;'), @params[:fontset], @params[:fontsize], @global)
+      sp.parse
+      graph = SVGGraph.new(sp.get_elementlist, @params, @global)
+      graph.svg_data
+    end
+
+    def draw_tree
+      svg = draw_svg
+      image, _data = Magick::Image.from_blob(svg) do |im|
+        im.format = 'svg'
+      end
+      if @params[:format] == "png"
+        image = draw_png(false)
+      else
+        image.to_blob do |im|
+          im.format = @params[:format].upcase
+        end
+      end
+      image
+    end
+  end
+end

data/rsyntaxtree.gemspec

@@ -1,7 +1,6 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
 
-require "rsyntaxtree/version"
+require_relative "lib/rsyntaxtree/version"
 
 Gem::Specification.new do |s|
   s.name        = "rsyntaxtree"
@@ -9,16 +8,19 @@ Gem::Specification.new do |s|
   s.authors     = ["Yoichiro Hasebe"]
   s.email       = ["yohasebe@gmail.com"]
   s.homepage    = "http://github.com/yohasebe/rsyntaxtree"
-  s.summary     = %q{RSyntaxTree is a graphical syntax tree generator written in Ruby}
-  s.description = %q{Syntax tree generator made with Ruby}
+  s.summary     = "RSyntaxTree is a graphical syntax tree generator written in Ruby"
+  s.description = "Syntax tree generator made with Ruby"
   s.licenses    = ["MIT"]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6")
   s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_runtime_dependency 'rmagick', '~> 4.2', '>= 4.2.3'
-  s.add_runtime_dependency 'optimist', '~> 3.0', '>= 3.0.1'
-  s.add_runtime_dependency 'parslet'
-  s.add_runtime_dependency 'rsvg2'
+  s.add_runtime_dependency "optimist", "~> 3.0", ">= 3.0.1"
+  s.add_runtime_dependency "parslet"
+  s.add_runtime_dependency "rmagick", "~> 4.2", ">= 4.2.3"
+  s.add_runtime_dependency "rsvg2"
+
+  s.add_development_dependency "yaml"
 end

data/test/example_verify_test.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "minitest/pride"
+require "yaml"
+require_relative '../lib/rsyntaxtree'
+require_relative '../lib/rsyntaxtree/utils'
+
+class ExampleParserTest < Minitest::Test
+  examples_dir = File.expand_path(File.join(__dir__, "..", "docs", "_examples"))
+  svg_dir = File.expand_path(File.join(__dir__, "..", "docs", "assets", "svg"))
+
+  Dir.glob("*.md", base: examples_dir).map do |md|
+    md = File.join(examples_dir, md)
+    config = YAML.load_file(md)
+    rst = File.read(md).scan(/```([^`]+)```/m).last.first
+
+    opts = {
+      format: "png",
+      leafstyle: "auto",
+      fontstyle: "sans",
+      fontsize: 16,
+      margin: 1,
+      vheight: 2.0,
+      color: "on",
+      symmetrize: "on",
+      transparent: "off",
+      polyline: "off"
+    }
+    name = nil
+    config.each do |key, value|
+      next if value.to_s == ""
+
+      case key
+      when "name"
+        name = value
+      when "colorization"
+        opts[:color] = value
+      when "polyline"
+        opts[:polyline] = value
+      when "symmetrization"
+        opts[:symmetrize] = value
+      when "connector"
+        opts[:leafstyle] = value
+      when "font"
+        opts[:fontstyle] = case value
+                           when /sans/i
+                             "sans"
+                           when /serif/i
+                             "serif"
+                           when /wqy/i
+                             "cjk"
+                           else
+                             "sans"
+                           end
+      end
+    end
+
+    opts[:data] = rst
+    rsg = RSyntaxTree::RSGenerator.new(opts)
+
+    #################################
+    # To test SVG, run the code below
+    #################################
+    svg = rsg.draw_svg
+    opts[:svg] = svg
+    svg_path = File.join(svg_dir, "#{name}.svg")
+    svg_code = File.read(svg_path)
+    puts "Creating example SVG test case: #{name}"
+
+    define_method "test_#{name}" do
+      assert_equal svg_code, opts[:svg]
+    end
+
+    ##########################################
+    # To create SVG for the tests, comment-out
+    # above block and run the code below
+    ##########################################
+    # File.open(File.join(svg_dir, "#{name}.svg"), "w") do |f|
+    #   puts "Creating svg file: #{name}.svg"
+    #   svg = rsg.draw_svg
+    #   f.write(svg)
+    # end
+
+    ##########################################
+    # To create SVG for the documentation,
+    # comment-out above and run the code below
+    ##########################################
+    # png_dir = File.expand_path(File.join(__dir__, "..", "docs", "assets", "img"))
+    # File.open(File.join(png_dir, "#{name}.png"), "w") do |f|
+    #   puts "Creating png file: #{name}.png"
+    #   png = rsg.draw_png
+    #   f.write(png)
+    # end
+  end
+end

data/test/markup_parser_test.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/autorun"
 require "minitest/pride"
-require "./lib/rsyntaxtree/markup_parser.rb"
+require_relative "../lib/rsyntaxtree/markup_parser"
 
 class MarkupParserTest < Minitest::Test
   def setup
@@ -203,5 +205,4 @@ class MarkupParserTest < Minitest::Test
     Markup.parse text2
     # {:status=>:error, :text=>"!^#----\\n\\nX_Y_Z+1+>2"}
   end
-
 end