rsyntaxtree 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3b753fd33f6df5903c6df87d02bf7c7ac45de57e1ba18da51f03fe391ab45f
-  data.tar.gz: 3f53988bbb1ccd64b75792b822ccb04eca2d7f209500d881610cf2295ced3ce7
+  metadata.gz: 27e1c2eb4e8e276a63ab92e99b32bd3ef607451df95088f379ff093f6a206001
+  data.tar.gz: 5147922ca1269a629761d7b93f364f9ae9d22fc41d63ce28fdd4c75223cccc52
 SHA512:
-  metadata.gz: 66e9a66413e457d4de55902743cc9ad61861c4b7fcdb4d9951d79966893e0665f5fea1e369ec69bbf058104627fc156250c841e2213f22b55b1c5b306991f311
-  data.tar.gz: 94ff87d7fab49605087c81bc98639c86fe768c1842048438c87381d22ebbf4d651cc0b5b6cadc16acf169cdee9021b694a8239777bc6088a4d3eb3d5f985d248
+  metadata.gz: 36edfb6922b94b9e8c0821e72f9154b58ad58fc43bd7f55ae913807534f39acd9dbe8becd00e9f14c30c999bb90cc15b6d7ba9cf38e75a6e1feaeca9c090edb9
+  data.tar.gz: 58f60c25f6c8ab2566ff1755c74c353769ea80a970e020f3e2c656bb2b6ee7d8e75fe82831b5d10c3788f8539d601a6817a257c5f57006d492ca11526c30e77b

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.2", "3.4"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libpango1.0-dev librsvg2-dev libmagickwand-dev \
+            libgirepository1.0-dev gobject-introspection \
+            fonts-noto-core fonts-noto-cjk
+          sudo fc-cache -f
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,74 @@
 # Changelog
 
+## [1.8.0] - 2026-08
+
+### Added
+- `tidy` layout scale, one option covering every layout mode from the most
+  spacious to the most dense: `symmetric` (radical symmetrization) | `off` |
+  `low` (contour packing, strict leaf positions) | `medium` (packing with
+  cross-row tucking that never lets two leaves swap their left-right order) |
+  `high` (free tucking; leaf order kept per row only). Connector heights
+  adjust automatically: a small height budget (5% of the tree's height) is
+  spent on the levels whose branches spread widest, evening out branch
+  angles. Tidy never produces overlapping labels (collisions roll back).
+- `mirror` option: flips the finished layout horizontally for the
+  right-to-left tree convention of Arabic/Hebrew syntax (composes with
+  `direction`).
+- `hspacing` option: scales every horizontal gap in every layout mode — the
+  horizontal counterpart of `vheight`/connector height.
+- Pass-through empty nodes: a node labeled only `<>` renders as an invisible
+  joint with the connector running continuously through it, so a `<>` chain
+  aligns a shallow leaf with deeper leaves without a broken line.
+- Full CJK coverage in every font style: the family chains fall back to
+  Noto Sans/Serif/Mono CJK, so Hangul and simplified/traditional Han render
+  in all styles (the standalone Noto JP faces carry no Hangul).
+- Example gallery: Multilingual category (the same UD-PUD sentence in nine
+  languages, constituency derived mechanically from the dependency
+  annotation; the Arabic example demonstrates `mirror`), a Morphology
+  category, and per-figure tidy settings across the whole gallery.
+- CI on GitHub Actions (Ruby 3.2/3.4).
+
+### Changed
+- LSIF output records the layout settings a reader cannot recover from the
+  coordinates: `geometry.mirror`, and `tidy`, `mirror`, `direction` and
+  `horizontal_spacing` under `meta.source.params`.
+- The standalone `symmetrize` option and `-y` flag are deprecated aliases of
+  `tidy: symmetric`; `tidy_spacing` is a deprecated alias of `hspacing`.
+- `--direction` now owns the `-d` short flag (it had been auto-assigned to
+  `--hide-default-connectors`, so the documented `-d ltr` silently did
+  nothing). Every published short flag is now declared explicitly rather
+  than derived from the option set. One undocumented auto-assignment moved
+  as a result: `-e` was `--direction` in 1.7.0 and is `--version` here.
+- The gem no longer bundles font files (38MB that were never opened at
+  runtime since the Pango migration): fonts resolve by family name through
+  fontconfig. See README for the system font packages. The dead `--font`
+  CLI option (its value was never read) is gone.
+
+### Fixed
+- Boolean options left at their defaults are no longer misread as enabled
+  when the caller passes only a partial parameter set (e.g. `tidy: off`
+  rendered as `symmetric` in the web UI).
+
+## [1.7.0] - 2026-08
+
+### Changed
+- Text measurement now uses Pango, the same engine (and the same fontconfig
+  font-fallback resolution) librsvg uses to render the output, instead of
+  RMagick with the bundled font files. Labels in any script are measured with
+  the font that actually draws them, which fixes off-center labels for scripts
+  the bundled fonts do not cover (e.g. Khmer, #14) without bundling per-script
+  fonts. Horizontal dimensions of the output may change slightly.
+- Vertical rhythm is now derived deterministically from the font size
+  (1.4 x size, matching the previous Latin line height) and is identical
+  across scripts; the old engine spaced Japanese text 1.5x and WenQuanYi
+  1.25x, so mixed-language documents had inconsistent spacing.
+- The font-family lists used in the SVG output and in measurement are now
+  defined in a single place (`FONT_FAMILIES` / `FontFamily`).
+
+### Added
+- Runtime dependency on the `pango` gem (ruby-gnome). No new system
+  requirements: librsvg already depends on Pango.
+
 ## [1.6.3] - 2026-07
 
 ### Fixed

data/CITATION.cff

@@ -0,0 +1,21 @@
+cff-version: 1.2.0
+message: "If you use RSyntaxTree in your research, please cite it as below."
+type: software
+title: "RSyntaxTree: A graphical syntax tree image generator"
+authors:
+  - family-names: "Hasebe"
+    given-names: "Yoichiro"
+    email: "yohasebe@gmail.com"
+url: "https://yohasebe.com/rsyntaxtree"
+repository-code: "https://github.com/yohasebe/rsyntaxtree"
+# Concept DOI: always resolves to the latest archived version on Zenodo
+doi: "10.5281/zenodo.21916150"
+license: MIT
+version: 1.8.0
+date-released: 2026-08-15
+keywords:
+  - linguistics
+  - syntax tree
+  - syntactic analysis
+  - visualization
+  - Ruby

data/Dockerfile

@@ -5,18 +5,17 @@ WORKDIR $WORKSPACE
 RUN apk update && \
     apk upgrade && \
     apk add --no-cache linux-headers libxml2-dev make gcc libc-dev bash && \
-    apk add --no-cache librsvg librsvg-dev imagemagick imagemagick-dev xz-dev libbz2 && \
+    apk add --no-cache librsvg librsvg-dev pango-dev imagemagick imagemagick-dev xz-dev libbz2 && \
     apk add --no-cache gobject-introspection gobject-introspection-dev && \
-    apk add --no-cache -t .build-packages --no-cache build-base curl-dev wget gcompat
+    apk add --no-cache -t .build-packages --no-cache build-base curl-dev wget gcompat && \
+    apk add --no-cache font-noto font-noto-cjk font-noto-cjk-extra font-noto-emoji \
+        font-noto-arabic font-noto-devanagari font-noto-thai
 
 
 ADD Gemfile $WORKSPACE
 ADD rsyntaxtree.gemspec $WORKSPACE
 RUN bundle install -j4
 
-ADD fonts $WORKSPACE
-RUN mkdir -p /usr/share/fonts/yh
-COPY ./fonts/* /usr/share/fonts/yh/
 RUN fc-cache -fv
 
 ADD . $WORKSPACE

data/Gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "optimist"
+gem "pango"
 gem "parslet"
 gem "rmagick"
 gem "rsvg2"

data/README.md

@@ -110,6 +110,16 @@ See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/example
 
 <img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' />
 
+## System Fonts
+
+RSyntaxTree resolves fonts by family name through fontconfig (measurement via Pango, rendering via librsvg), so the fonts must be installed on the system that generates the images. Recommended:
+
+- Debian/Ubuntu: `apt install fonts-noto-core fonts-noto-cjk fonts-noto-color-emoji`
+- Alpine: `apk add font-noto font-noto-cjk font-noto-cjk-extra font-noto-emoji` (the `-extra` package carries Noto Serif CJK)
+- macOS: install [Noto Sans/Serif](https://fonts.google.com/noto) (and Noto Sans/Serif JP for CJK); otherwise the system falls back to available fonts
+
+Any script supported by an installed font renders correctly — the family chains fall back from Noto Sans/Serif to the JP and CJK variants, so Japanese, Chinese (simplified and traditional) and Korean are covered by the Noto CJK package. As of v1.8.0 the gem no longer bundles font files (they were not used at runtime).
+
 ## Installation
 
 ```bash
@@ -156,9 +166,11 @@ Usage:
 | `-n, --fontstyle` | Font style: sans, serif, cjk, mono | `sans` |
 | `-s, --fontsize` | Font size: 8-26 | `16` |
 | `-c, --color` | Color mode: modern, traditional, off | `modern` |
-| `-y, --symmetrize` | Symmetrical tree: on, off | `off` |
 | `-p, --polyline` | Polyline connectors: on, off | `off` |
 | `-d, --direction` | Tree layout direction: ttb, ltr | `ttb` |
+| `--tidy` | Layout scale: off, symmetric, low, medium, high | `off` |
+| `--hspacing` | Horizontal spacing factor, all layout modes (0.5-3.0) | `1.0` |
+| `-m, --mirror` | Flip the tree horizontally (RTL convention): on, off | `off` |
 
 Run `rsyntaxtree -h` for the full list of options.
 
@@ -189,16 +201,20 @@ For detailed documentation on syntax and markup:
 - [日本語ドキュメント](https://yohasebe.github.io/rsyntaxtree/documentation_ja)
 - [Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples)
 
-## References
+## How to Cite
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21916150.svg?v=1)](https://doi.org/10.5281/zenodo.21916150)
 
-Please use the following BibTeX entry when citing RSyntaxTree:
+If you use RSyntaxTree in your research, please cite it. You can use the "Cite this repository" button on GitHub (powered by [CITATION.cff](CITATION.cff)), or the following BibTeX entry (adjust `version` to the one you used):
 
 ```bibtex
-@misc{rsyntaxtree,
-  author = {Yoichiro Hasebe},
-  title = {RSyntaxTree: A graphical syntax tree image generator},
-  url = {https://yohasebe.com/rsyntaxtree},
-  year = {2026}
+@software{hasebe_rsyntaxtree,
+  author  = {Hasebe, Yoichiro},
+  title   = {RSyntaxTree: A graphical syntax tree image generator},
+  url     = {https://yohasebe.com/rsyntaxtree},
+  doi     = {10.5281/zenodo.21916150},
+  version = {1.8.0},
+  year    = {2026}
 }
 ```
 

data/bin/rsyntaxtree

@@ -15,7 +15,6 @@ CONFIG_VALIDATORS = {
   format: ->(v) { /\A(png|jpg|gif|pdf|svg|lsif)\z/ =~ v.to_s ? nil : "must be png, jpg, gif, pdf, svg, or lsif" },
   leafstyle: ->(v) { /\A(auto|triangle|bar|nothing)\z/ =~ v.to_s ? nil : "must be auto, triangle, bar, or nothing" },
   fontstyle: ->(v) { /\A(sans|serif|cjk|mono)\z/ =~ v.to_s ? nil : "must be sans, serif, cjk, or mono" },
-  font: ->(v) { v.nil? || File.exist?(v) ? nil : "must be path to an existing ttf font" },
   fontsize: ->(v) { v.is_a?(Integer) && v >= 8 && v <= 26 ? nil : "must be in the range of 8-26" },
   linewidth: ->(v) { v.is_a?(Integer) && v >= 1 && v <= 5 ? nil : "must be in the range of 1-5" },
   vheight: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 5.0 ? nil : "must be in the range of 0.5-5.0" },
@@ -24,6 +23,10 @@ CONFIG_VALIDATORS = {
   transparent: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   polyline: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   hide_default_connectors: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
+  mirror: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
+  tidy: ->(v) { /\A(off|symmetric|low|medium|high|on|compact|true|false)\z/ =~ v.to_s ? nil : "must be off, symmetric, low, medium, or high" },
+  hspacing: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 3.0 ? nil : "must be in the range of 0.5-3.0" },
+  tidy_spacing: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 3.0 ? nil : "must be in the range of 0.5-3.0" },
   direction: ->(v) { /\A(ttb|ltr)\z/ =~ v.to_s ? nil : "must be ttb or ltr" }
 }.freeze
 
@@ -84,7 +87,7 @@ unless loaded[:errors].empty?
 end
 
 opts = Optimist.options do
-  version "RSyntaxTree #{RSyntaxTree::VERSION} (c) 2024 Yoichiro Hasebe"
+  version "RSyntaxTree #{RSyntaxTree::VERSION} (c) 2026 Yoichiro Hasebe"
   banner <<~BANNER
     RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
 
@@ -96,21 +99,24 @@ opts = Optimist.options do
     where [options] are:
   BANNER
 
-  opt :outdir, "Output directory", default: "./"
-  opt :outfilename, "Output file base name", default: "syntree"
-  opt :format, "Output format: png, jpg, gif, pdf, svg, or lsif", default: "png"
-  opt :leafstyle, "visual style of tree leaves: auto, triangle, bar, or nothing", default: "auto"
-  opt :fontstyle, "Font style (available when ttf font is specified): sans, serif, cjk, mono", default: "sans"
-  opt :font, "Path to a ttf font used to generate tree (optional)", type: String
-  opt :fontsize, "Size: 8-26", default: 16
-  opt :linewidth, "Size: 1-5", default: 1
-  opt :vheight, "Connector Height: 0.5-5.0", default: 2.0
-  opt :color, "Color text and bars: modern, traditional, or off", default: "modern"
-  opt :symmetrize, "Generate radically symmetrical, balanced tree: on or off", default: "off"
-  opt :transparent, "Make background transparent: on or off", default: "off"
-  opt :polyline, "draw polyline connectors: on or off", default: "off"
-  opt :hide_default_connectors, "make default connectors transparent: on or off", default: "off"
-  opt :direction, "Tree layout direction: ttb (top-to-bottom) or ltr (left-to-right)", default: "ttb"
+  opt :outdir, "Output directory", default: "./", short: :o
+  opt :outfilename, "Output file base name", default: "syntree", short: :u
+  opt :format, "Output format: png, jpg, gif, pdf, svg, or lsif", default: "png", short: :f
+  opt :leafstyle, "visual style of tree leaves: auto, triangle, bar, or nothing", default: "auto", short: :l
+  opt :fontstyle, "Font style: sans, serif, cjk, mono", default: "sans", short: :n
+  opt :fontsize, "Size: 8-26", default: 16, short: :s
+  opt :linewidth, "Size: 1-5", default: 1, short: :i
+  opt :vheight, "Connector Height: 0.5-5.0", default: 2.0, short: :v
+  opt :color, "Color text and bars: modern, traditional, or off", default: "modern", short: :c
+  opt :symmetrize, "DEPRECATED alias of --tidy symmetric: on or off", default: "off", short: :y
+  opt :transparent, "Make background transparent: on or off", default: "off", short: :r
+  opt :polyline, "draw polyline connectors: on or off", default: "off", short: :p
+  opt :hide_default_connectors, "make default connectors transparent: on or off", default: "off", short: :none
+  opt :mirror, "flip the tree horizontally (RTL linguistics convention: first word at the right edge): on or off", default: "off"
+  opt :tidy, "tidy tree layout: off, symmetric (radical symmetrization), low (packed, strict leaf positions), medium (packed; leaves may overlap but never swap order), or high (packed; leaf order kept per row only)", default: "off", short: :none
+  opt :hspacing, "Horizontal spacing factor (counterpart of vheight): 0.5-3.0", default: 1.0, short: :none
+  opt :tidy_spacing, "DEPRECATED alias of --hspacing: 0.5-3.0", default: 1.0, short: :none
+  opt :direction, "Tree layout direction: ttb (top-to-bottom) or ltr (left-to-right)", default: "ttb", short: :d
   opt :help, "This is a custom help message", short: :h
 end
 
@@ -119,7 +125,6 @@ Optimist.die :direction, "must be ttb or ltr" unless /\A(ttb|ltr)\z/ =~ opts[:di
 Optimist.die :format, "must be png, pdf, svg, or lsif" unless /\A(png|jpg|gif|pdf|svg|lsif)\z/ =~ opts[:format]
 Optimist.die :leafstyle, "must be auto, triangle, bar, or nothing" unless /\A(auto|triangle|bar|nothing)\z/ =~ opts[:leafstyle]
 Optimist.die :fontstyle, "must be sans, serif, cjk, or mono" unless /\A(sans|serif|cjk|mono)\z/ =~ opts[:fontstyle]
-Optimist.die :font, "must be path to an existing ttf font" if opts[:font] && !File.exist?(opts[:font])
 Optimist.die :fontsize, "must be in the range of 8-26" unless opts[:fontsize] >= 8 && opts[:fontsize] <= 26
 Optimist.die :linewidth, "must be in the range of 1-5" unless opts[:linewidth] >= 1 && opts[:linewidth] <= 5
 Optimist.die :color, "must be either modern, traditional, or off" unless /\A(modern|traditional|on|off|true|false)\z/ =~ opts[:color]
@@ -128,6 +133,10 @@ Optimist.die :vheight, "must be in the range of 0.5-5.0" if opts[:vheight] < 0.5
 Optimist.die :transparent, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:transparent]
 Optimist.die :polyline, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:polyline]
 Optimist.die :hide_default_connectors, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:hide_default_connectors]
+Optimist.die :mirror, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:mirror]
+Optimist.die :tidy, "must be off, symmetric, low, medium, or high" unless /\A(off|symmetric|low|medium|high|on|compact|true|false)\z/ =~ opts[:tidy]
+Optimist.die :hspacing, "must be in the range of 0.5-3.0" if opts[:hspacing] < 0.5 || opts[:hspacing] > 3.0
+Optimist.die :tidy_spacing, "must be in the range of 0.5-3.0" if opts[:tidy_spacing] < 0.5 || opts[:tidy_spacing] > 3.0
 
 # Merge config file options with CLI options (CLI takes precedence)
 string_opts = {}
@@ -140,8 +149,8 @@ end
 # Then, apply CLI options (overrides config file)
 opts.each do |key, value|
   key_sym = key.to_sym
-  # Skip internal optimist keys and nil font
-  next if key.to_s.start_with?('_') || (key == :font && !value)
+  # Skip internal optimist keys
+  next if key.to_s.start_with?('_')
   # Only override if explicitly given on CLI or not in config
   if opts[:"#{key}_given"] || !file_config.key?(key_sym)
     string_opts[key_sym] = value