rsyntaxtree 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4cd7a8b28ffa968f99ff228e3a182a64d420e0405cd27e120b5f4ff02fe48e
-  data.tar.gz: 23a64934f448707de2b55cad4c206d65fab18aa7d6c1cd3aab0b1871efd9be1e
+  metadata.gz: 8c57f743f27cc6830495cfe9da3ce4483fec13491af8e80d4437357cc9c37968
+  data.tar.gz: d051b212a5abe64711fd42622bce06cea77c1e8bfc78a8315dfc1246f0dc22d0
 SHA512:
-  metadata.gz: 2dfd53e10a62187649fb3d7285fa38189ef25cf56d6af7ceea27fba3cc7358b1f7d528db6466607061120fab61a2ff7bd9b84fa0b989e4313faaac306af42235
-  data.tar.gz: 7399787ea179bdd17910fa9695cc292a18cb5b8e9b3948e943bf32fd52fd05f89e6ec0e2792138197d56c839b9960bab678489a976590667eca9b4dd80679029
+  metadata.gz: e214718246e31cf0d42a03f91ee4b7e714cf1576f3f60fb70b6d0fb9d2d22a24e2b04e832d9e8be2df0b664b5506bf8a0994f659384a85469a4023535409c615
+  data.tar.gz: 5f7638450414b9cb53ac9fe2cdc08e7776af24ea50a0de75166dfbb3d47b9d4a27ab1d45a026012ef6bd9fdcc76400b1cf88f7df5095dac20cd78c629c3ccc33

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [2.3.0] - 2026-09-01
+
+### Added
+- `RSTError::CODES` lists every error code the library can report. A program
+  keyed by code — one that translates the diagnosis, or tallies what kinds of
+  mistake a writer makes — needs the whole set rather than the codes it has
+  happened to see, and until now that set could only be recovered by reading
+  five files and the repair table. The list only grows: a published code is
+  not renamed or removed.
+
+### Fixed
+- Whitespace alone is an empty input rather than a defect in the library. It
+  reached the drawing, which walked off the end of an empty tree and reported
+  `internal_error`, telling the caller that their own fixable input was the
+  library's fault.
+- A bracketless input of a single character draws. The tokenizer counted its
+  cursor as exhausted one character early, so `A`, and `<>` once it is one
+  whitespace block, produced no tokens at all — though the manual has always
+  said a label on its own draws as one leaf.
+
 ## [2.2.0] - 2026-09-01
 
 ### Changed
@@ -97,9 +117,8 @@ looking at what was left. Every figure in the gallery draws exactly as it did.
 
 ### Added
 - `shear`: the drawn figure tilts by the given angle (degrees, positive
-  leaning the top to the right) and lies on a plane drawn behind it, so the
-  lean reads as a surface seen at an angle rather than as a mistake. The
-  whole picture shears as one affine piece — layout untouched, region
+  leaning the top to the right) and lies on a plane drawn behind it, which
+  shows the tilt as a surface. The whole picture shears as one affine piece — layout untouched, region
   shades coming out parallelograms on their own, and nothing able to newly
   touch or cross. The plane is fill without an edge — a region shade is
   bounded because it marks one part of a figure off from the rest, and a
@@ -245,9 +264,8 @@ looking at what was left. Every figure in the gallery draws exactly as it did.
 - Derivations. A derivation puts the words first and the result last, and
   joins what each step combines with one rule drawn across all of it rather
   than with a line to each daughter. `derivation` draws the rules and
-  `direction: btt` turns the tree over; together they give the format
-  categorial grammar is written in, and `derivation` on its own marks the
-  spans of an ordinary tree. The name of each step rides in the label after a
+  `direction: btt` turns the tree over; together they draw a CCG derivation,
+  and `derivation` on its own marks the spans of an ordinary tree. The name of each step rides in the label after a
   column break and is set beside the end of its rule. A derivation runs down
   the page and is drawn with its rules, so `direction: ltr` and hiding the
   default connectors are refused rather than approximated.
@@ -379,15 +397,15 @@ RMagick dependency.
   rule that work never uses.
 - A matrix nested in a label, written between `#(` and `#)`. The value of an
   attribute can be another attribute-value matrix, to any depth, which is what
-  a feature path such as SYNSEM | LOCAL | CATEGORY | HEAD needs and what HPSG,
-  SBCG and LFG are written in. The nested matrix draws its own brackets and
+  a feature path such as SYNSEM | LOCAL | CATEGORY | HEAD needs, and what
+  HPSG and LFG are written in. The nested matrix draws its own brackets and
   lays out its own columns, and the rows after it clear its full height.
 - `\t` in a label cuts the line into cells. Every line is cut at the same
   points and each column is drawn at the width of its widest cell, so the
   parts line up down the label. Together with the bracket enclosure and the
   horizontal rule this gives attribute-value matrices — the feature structures
-  of HPSG, SBCG and LFG — without spacing each row by hand, which is how the
-  gallery's HPSG example used to do it.
+  of HPSG, LFG and the like — without spacing each row by hand, which is how
+  the gallery's HPSG example used to do it.
 - `color: gray`, a scheme that keeps node and leaf labels black and draws the
   connectors, triangles and movement paths in grey. It is for diagrams whose
   links outnumber their labels — an ontology, a network of constructions —

data/lib/rsyntaxtree/string_parser.rb

@@ -64,7 +64,12 @@ module RSyntaxTree
     end
 
     def self.valid?(data)
-      raise RSTError.new(+"Error: input text is empty", code: :empty_input, retryable: false) if data.empty?
+      # Whitespace alone is an empty input, not a tree with one blank label:
+      # nothing survives the parse, and what used to happen is that the
+      # drawing walked off the end of an empty element list and reported a
+      # defect in the library for what the caller could see and fix. A space
+      # meant as a label is written <>, which is not whitespace here.
+      raise RSTError.new(+"Error: input text is empty", code: :empty_input, retryable: false) if data.strip.empty?
 
       if /\[\s*\]/m =~ data
         raise RSTError.new(+"Error: inside the brackets is empty", code: :empty_brackets,
@@ -204,7 +209,11 @@ module RSyntaxTree
       token = ""
       i = 0
 
-      return "" if (@pos + 1) >= data.length
+      # The cursor is exhausted when it reaches the end, not one before it:
+      # counting from @pos + 1 skipped the last character, so an input of a
+      # single character — "A", or "<>" once it is one whitespace block —
+      # produced no tokens at all and drew from an empty element list.
+      return "" if @pos >= data.length
 
       escape = false
       while ((@pos + i) < data.length) && !gottoken

data/lib/rsyntaxtree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSyntaxTree
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/lib/rsyntaxtree.rb

@@ -133,6 +133,50 @@ class RSTError < StandardError
     super(msg.gsub(WHITESPACE_BLOCK, "<>"))
   end
 
+  # Every code an error from this library can carry. Consumers dispatch on
+  # these — a translation keyed by code, a harness counting what kinds of
+  # mistake occur — and both need to know the whole set, not only the codes
+  # they have happened to see: a kind of mistake nobody made is not the same
+  # as a kind that cannot happen. Until this list existed the set was only
+  # discoverable by reading five files and a repair table.
+  #
+  # Written out rather than computed, because it is a contract and a contract
+  # should be readable at a glance and visible in a diff. A test keeps it
+  # honest by finding the codes the library actually raises and comparing.
+  #
+  # The list grows and does not churn: a code once published is not renamed
+  # or removed, so a consumer keyed by code — a translation table, a tally of
+  # what kinds of mistake a writer makes — only ever has entries to add.
+  #
+  # Eight are named by the repair table, which diagnoses a label by rewriting
+  # it and asking the parser whether the rewrite reads: angle_brackets,
+  # bare_hyphen, incomplete_path, invalid_color, rule_name_without_derivation,
+  # stray_triangle, unclosed_markup, unclosed_matrix. invalid_markup is where
+  # a label lands whose mistake no single rewrite fits, which in practice
+  # means more than one. unknown_color and label_split are mistakes inside a
+  # label too, found before the repair table is reached.
+  CODES = %i[
+    angle_brackets
+    bare_hyphen
+    empty_brackets
+    empty_input
+    incomplete_path
+    internal_error
+    invalid_color
+    invalid_markup
+    invalid_option
+    label_split
+    path_multiple_ends
+    path_single_end
+    result_too_big
+    rule_name_without_derivation
+    stray_triangle
+    unbalanced_brackets
+    unclosed_markup
+    unclosed_matrix
+    unknown_color
+  ].freeze
+
   # Where the notation is written down. A hint repairs the mistake in front of
   # it and says nothing about the rest, which is enough for a reader who knows
   # the notation and not enough for one who was guessing at it. Given once, at
@@ -435,8 +479,21 @@ module RSyntaxTree
       !OFF.include?(value.to_s.strip.downcase)
     end
 
+    # Whether the input is nothing to draw. Whitespace alone counts: it
+    # leaves no label behind, and reporting it as a defect in the library
+    # told the caller their own fixable input was our fault. Asked without
+    # strip when the bytes are not valid UTF-8, because strip raises there
+    # and that input is not blank — it is malformed, which the caller
+    # learns further down.
+    def self.blank?(text)
+      s = text.to_s
+      return true if s.empty?
+
+      s.valid_encoding? && s.strip.empty?
+    end
+
     def self.check_data(text, params = {})
-      raise RSTError.new(+"Error: input text is empty", code: :empty_input, retryable: false) if text.to_s == ""
+      raise RSTError.new(+"Error: input text is empty", code: :empty_input, retryable: false) if blank?(text)
 
       begin
         StringParser.valid?(text)
@@ -510,7 +567,7 @@ module RSyntaxTree
     def self.diagnose(text, params = {})
       errors = []
       note = nil
-      if text.to_s == ""
+      if blank?(text)
         errors << RSTError.new(+"Error: input text is empty", code: :empty_input, retryable: false)
       else
         begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsyntaxtree
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Yoichiro Hasebe