toon-fu 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f87e2144c7adb60f949127ea36ed9e26b84fb1ba5e4cd6893d9fc46f3e859e
-  data.tar.gz: 84c74750d67f681645a7cd0e84b46675919f3e0549cc4e168306510b1f8b45bf
+  metadata.gz: fe7b6913ab8e4bd4224ed1b08175c8ae7b2e2a5b841c990daa77f48819f4f495
+  data.tar.gz: 536f77da3c7fe3ce3a34c0d7421d5777559a8a912ab6194582be07bff441e0e1
 SHA512:
-  metadata.gz: a78c3f872ff747c74af86f91a5e945b8dcf1b2eb5d10ea9694ad2a0e3efccc938fe7652a5cfda36713163f0f39d965dbe75f1e77698bdea3aea124e81bb1b194
-  data.tar.gz: 1b6fa5a87123368f9a7e92ee1fb1f91fce1950d583967acf007542b6ea10168c8b67c282cb87e96009841a039b657a23c77c11d4e47535d192bde41f9e82aaad
+  metadata.gz: be1b854a3300c9e7b70cd2fa73d2d9d6ace099c88c32d1f98a3d30152a2f2c03ab42de0f23b48bbacb6eccfa042946add466eb99dec2c7e3636cb0089857e0f8
+  data.tar.gz: 40cad3826f9fd815fd636fb4ac2c6b3b4e7563fefa73a9cbbfe1444161590222f914557ecaaf9d142a680b6a741cea300579e82cf5a711a943044f7adb614a83

data/README.md

@@ -138,7 +138,7 @@ ToonFu.decode("tags[3]: a,b")
 
 ### Options
 
-- `strict:` — `true` (default) checks what the spec requires: declared lengths, row widths, duplicate keys, indentation. Pass `false` to read a document that bends those rules — a declared length is ignored, a duplicate key takes its last value, a stray over-indented line is skipped unless it is a bare token, which raises in either mode.
+- `strict:` — `true` (default) checks everything the spec requires. Pass `false` for the spec's five recoveries and nothing more: a declared length is ignored, a duplicate key takes its last value, a tab indents one level, a blank line between an array's items or rows is skipped, and a scope's first line sets its depth. Everything else — a malformed header, a row of the wrong width, a stray over-indented line — raises in either mode.
 - `indent_size:` — spaces per nesting level, default `2`.
 
 ```ruby
@@ -166,17 +166,17 @@ b08ea2d feat: ship a toon executable
 
 ## Compared with other Ruby TOON gems
 
-The only one that passes every spec fixture: toon-fu passes all 160 encode and all 385 decode fixtures. The table compares encoding — the 138 encode fixtures that use default options, which every gem can run; none of the others reads TOON back.
+The only one that passes every spec fixture: toon-fu passes all 160 encode and all 404 decode fixtures. The table compares encoding — the 138 encode fixtures that use default options; the other 22 set a delimiter or an indent size, which the other gems do not take, and none of them reads TOON back.
 
 | Gem | Spec fixtures passed | Speed vs toon-fu |
 |---|---:|---:|
 | **toon-fu** | **138 / 138** | **1.00×** |
-| sorbet-toon 0.1.0 | 104 / 138 | 0.63× |
-| toon-ruby 0.1.1 | 100 / 138 | 0.62× |
-| toon_my_json 0.1.0 | 48 / 138 | 1.62× |
-| toon-format 0.1.2 | 40 / 138 | 1.31× |
+| sorbet-toon 0.1.0 | 104 / 138 | 0.55× |
+| toon-ruby 0.1.1 | 100 / 138 | 0.55× |
+| toon_my_json 0.1.0 | 46 / 138 | 1.49× |
+| toon-format 0.1.2 | 40 / 138 | 1.11× |
 
-The Ruby TOON encoders with more than 10,000 downloads, measured by [`benchmark/run.rb`](benchmark/run.rb) on Ruby 3.4.11 (2026-10-07). **Spec fixtures** are the spec's own encode fixtures that use default options. **Speed** is the geometric mean of encodes per second over five workloads — tables of 100 and 1000 rows, nested objects, a list of mixed objects, strings needing quotes — relative to toon-fu.
+The Ruby TOON encoders with more than 10,000 downloads, measured by [`benchmark/run.rb`](benchmark/run.rb) on Ruby 3.4.11 (2026-10-10). **Spec fixtures** are the spec's own encode fixtures that use default options. **Speed** is the geometric mean of encodes per second over five workloads — tables of 100 and 1000 rows, nested objects, a list of mixed objects, strings needing quotes — relative to toon-fu.
 
 What falls through the gaps:
 
@@ -203,7 +203,7 @@ The gem version tracks the TOON specification it implements:
 - `MAJOR.MINOR` is the spec version: `X.Y.Z` speaks TOON `X.Y`.
 - `PATCH` is the gem's own: fixes and improvements within the same dialect.
 
-This release speaks `toon-spec: 4.3`.
+This release speaks `toon-spec: 4.4`.
 
 Pin the spec line with `gem "toon-fu", "~> X.Y.0"`: it takes our fixes and keeps you on the dialect you speak. The gem badge above shows the current release; the spec-drift badge turns red when a newer spec is released and toon-fu has not caught up yet.
 

data/lib/toon_fu/decoder.rb

@@ -3,13 +3,14 @@
 module ToonFu
   # Decodes TOON with one set of options, for callers that decode many.
   class Decoder
-    # @param strict [Boolean] whether to enforce the spec's strict-mode
-    #   checks; with +false+ duplicate keys resolve last-write-wins, leading
-    #   spaces that are not a multiple of indent_size are accepted, a tab in
-    #   indentation is accepted and counts as one level, a line of spaces and
-    #   tabs is blank, a scope's first line sets the scope's depth, an
-    #   over-indented line is skipped unless it is a bare token, and a
-    #   malformed or misplaced header is read as a key-value line
+    # @param strict [Boolean] whether to enforce every check of the spec;
+    #   with +false+ exactly the spec's five recoveries apply: a declared
+    #   length is ignored; a duplicate key or a field name repeated in one
+    #   field list resolves last-write-wins, keeping its first position; a
+    #   tab in indentation counts as one level, leading spaces need not be a
+    #   multiple of indent_size and a line of spaces and tabs is blank; a
+    #   blank line inside a header span is ignored; and a scope's first line
+    #   sets the scope's depth
     # @param indent_size [Integer] spaces per nesting level
     # @raise [ArgumentError] when strict is not a boolean or indent_size is
     #   not a positive Integer
@@ -43,13 +44,14 @@ module ToonFu
     # @raise [Error] for text that is not a String or not valid UTF-8; for a
     #   number outside the Float range; for an invalid escape, an
     #   unterminated quoted string, or content after a closing quote; for a
-    #   key without a colon; for a bare token line inside a scope; for
-    #   content after a completed root form; for nesting beyond the depth
-    #   limit; and, when strict, for a declared length or row width that
-    #   does not match, a malformed or misplaced header, a duplicate key, a
-    #   blank line inside a header's scope, a tab in indentation, indentation
-    #   that is not a multiple of indent_size, a depth jump, and an
-    #   over-indented line, an indented first line included
+    #   key without a colon; for a malformed or misplaced header; for a row
+    #   width that does not match; for a line that belongs to no scope, an
+    #   over-indented or indented first line included; for content after a
+    #   completed root form; for nesting beyond the depth limit; and, when
+    #   strict, for a declared length that does not match, a duplicate key, a
+    #   field name repeated in one field list, a blank line inside a header
+    #   span, a tab in indentation, indentation that is not a multiple of
+    #   indent_size, and a depth jump
     def decode(text)
       Reader.new(@strict, @indent_size).read(utf8(text))
     end

data/lib/toon_fu/header.rb

@@ -21,8 +21,8 @@ module ToonFu
     end
 
     # A line whose first unquoted "[" precedes its first unquoted colon is an
-    # array-header line; one that fails the §6 grammar is malformed, a
-    # strict-mode error (§5.2).
+    # array-header line; one that fails the §6 grammar is malformed, an
+    # error in either mode (§5.2, §14.2).
     def malformed?
       @malformed
     end
@@ -38,7 +38,7 @@ module ToonFu
       # §6: a keyed header's field list is required, and a fields-bearing
       # header carries no inline content.
       return broken if @keyed && !fields?
-      return broken if fields? && !@inline.strip.empty?
+      return broken if fields? && !Tokens.trim(@inline).empty?
 
       self
     end

data/lib/toon_fu/lines.rb

@@ -2,7 +2,7 @@
 
 module ToonFu
   class Line
-    ITEM = /\A-(?: |\z)/
+    ITEM = /\A-(?: +|\z)/
 
     attr_reader :content, :depth, :number, :text
 
@@ -57,10 +57,6 @@ module ToonFu
       line
     end
 
-    def number
-      peek ? peek.number : @lines.length
-    end
-
     private
 
     def significant(text)
@@ -88,8 +84,6 @@ module ToonFu
       Line.new(line.sub(INDENTATION, ""), depth(line, number), number, line, blank)
     end
 
-    # Non-strict mode accepts a tab as indentation (§12), where each tab
-    # counts as one level; strict mode rejects it.
     def depth(line, number)
       indent = line[INDENTATION]
       raise Error, "cannot decode a line indented with a tab on line #{number}: #{line}" if @strict && indent.include?("\t")

data/lib/toon_fu/reader.rb

@@ -25,7 +25,7 @@ module ToonFu
       return object(-1, 0) unless line.depth.zero?
       return empty_array_root if line.content == "[]"
 
-      header = usable(Header.parse(line.content), line)
+      header = parse_header(line)
       return keyless_root(header) if header && header.key.nil?
       return scalar_root(line) if @lines.one? && scalar?(line)
 
@@ -70,10 +70,7 @@ module ToonFu
     end
 
     def orphan(line)
-      raise Error, "cannot decode a line that belongs to no scope on line #{line.number}: #{line.text}" if @strict
-      raise Error, "cannot decode a bare token line inside a scope on line #{line.number}: #{line.text}" if scalar?(line)
-
-      @lines.next
+      raise Error, "cannot decode a line that belongs to no scope on line #{line.number}: #{line.text}"
     end
 
     def scalar?(line)
@@ -87,12 +84,12 @@ module ToonFu
     end
 
     def field(line, depth)
-      header = usable(Header.parse(line.content), line)
+      header = parse_header(line)
       return [Tokens.key(header.key), header_value(header, depth)] if header&.key
       misplaced(line, "a keyless array header in object field position") if header
 
       colon = Tokens.colon_index(line.content)
-      raise Error, "cannot decode a line without a colon after its key on line #{line.number}: #{line.text}" if colon.nil?
+      raise Error, "cannot decode a line without a colon on line #{line.number}: #{line.text}" if colon.nil?
 
       key = Tokens.key(line.content[0...colon])
       [key, field_value(Tokens.trim(line.content[(colon + 1)..]), depth)]
@@ -135,9 +132,9 @@ module ToonFu
       return {} if rest.empty?
       return [] if rest == "[]"
 
-      header = usable(Header.parse(rest), line)
+      header = parse_header(line, rest)
       return item_header(header, line) if header
-      return item_object(rest, line.depth) if Tokens.colon_index(rest)
+      return item_object(rest, line) if Tokens.colon_index(rest)
 
       Token.decode(Tokens.trim(rest))
     end
@@ -146,19 +143,20 @@ module ToonFu
       return array(header, line.depth) unless header.key || header.fields?
 
       misplaced(line, "a keyless fields-bearing header as a list item") unless header.key
-      item_object(line.item_content, line.depth)
+      item_object(line.item_content, line)
     end
 
     def misplaced(line, what)
-      raise Error, "cannot decode #{what} on line #{line.number}: #{line.text}" if @strict
+      raise Error, "cannot decode #{what} on line #{line.number}: #{line.text}"
     end
 
-    def item_object(rest, depth)
-      synthetic = Line.new(rest, depth + 1, @lines.number)
-      key, value = descend { field(synthetic, depth + 1) }
+    def item_object(rest, line)
+      depth = line.depth + 1
+      synthetic = Line.new(rest, depth, line.number)
+      key, value = descend { field(synthetic, depth) }
       result = {}
       store(result, key, value, synthetic)
-      descend { object(depth, depth + 1, result) }
+      descend { object(line.depth, depth, result) }
     end
 
     def table(header, parent)
@@ -190,15 +188,11 @@ module ToonFu
       collected = descend do
         gather(parent) do |line|
           colon = Tokens.colon_index(line.content)
-          if colon.nil?
-            raise Error, "cannot decode an entry row without a colon on line #{line.number}: #{line.text}" if @strict
+          raise Error, "cannot decode an entry row without a colon on line #{line.number}: #{line.text}" if colon.nil?
 
-            next nil
-          end
           [Tokens.key(line.content[0...colon]), row(header, line, line.content[(colon + 1)..]), line]
         end
       end
-      collected.compact!
       count(collected.length, header, "entry row")
       collected.each { |key, value, line| store(result, key, value, line) }
       result
@@ -209,10 +203,7 @@ module ToonFu
       collected = []
       depth = content_depth(parent)
       while depth && (line = @lines.peek) && line.depth > parent
-        if line.depth != depth
-          orphan(line)
-          next
-        end
+        orphan(line) if line.depth != depth
         break if stop&.call(line)
 
         take
@@ -233,21 +224,12 @@ module ToonFu
       cells = Tokens.split(text, header.delimiter)
       cells = [] if cells.length == 1 && Tokens.trim(cells.first).empty?
       width(cells.length, header, line)
-      shape(header.fields, cells.each)
+      shape(header.fields, cells)
     end
 
     def shape(fields, cells)
       fields.each_with_object({}) do |(name, nested), result|
-        if nested
-          result[name] = shape(nested, cells)
-        else
-          cell = begin
-            cells.next
-          rescue StopIteration
-            next
-          end
-          result[name] = Token.decode(Tokens.trim(cell))
-        end
+        result[name] = nested ? shape(nested, cells) : Token.decode(Tokens.trim(cells.shift))
       end
     end
 
@@ -258,16 +240,16 @@ module ToonFu
     end
 
     def width(actual, header, line)
-      return unless @strict && actual != header.leaves.length
+      return if actual == header.leaves.length
 
       raise Error, "cannot decode #{actual} cells on line #{line.number} where the header declares #{header.leaves.length} field#{"s" unless header.leaves.length == 1}"
     end
 
-    def usable(header, line)
-      return header unless header&.malformed?
-      raise Error, "cannot decode a malformed array header on line #{line.number}: #{line.text}" if @strict
+    def parse_header(line, content = line.content)
+      header = Header.parse(content)
+      raise Error, "cannot decode a malformed array header on line #{line.number}: #{line.text}" if header&.malformed?
 
-      nil
+      header
     end
 
     def content_depth(parent)

data/lib/toon_fu/tokens.rb

@@ -3,7 +3,7 @@
 module ToonFu
   module Tokens
     QUOTE_SPAN = /"(?:[^"\\]|\\.?)*"?/
-    TRAILING_WHITESPACE = /[[:space:]]\z/
+    TRAILING_WHITESPACE = /[ \t]\z/
     UNTIL_COLON = /[^":]+/
     UNTIL_BRACKET = /[^":\[]+/
     UNTIL_BRACE = /[^"{]+/

data/lib/toon_fu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ToonFu
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toon-fu
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Yevhenii Hurin