kdl 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be3bacf1ec9d5292dfa518987c77b5d40eed8e67305bd4888118a633b8fa45f0
-  data.tar.gz: 7da6c65eff791761f4ff0d36182fa98aa715359d301830c447b0717095061bea
+  metadata.gz: 24483470a3eb179aeb4a3e2e759693a4e818316cb7cb6c3b019b22b2318504af
+  data.tar.gz: 73ce32af9afa6ebcd4be7a73add2ee1077e08aad71425863b75b1581613a2628
 SHA512:
-  metadata.gz: 0af1a1c13a2b88bdd2266f1ff5d057da2a26ea87027c64c5507054962564ac76e005927b4e69480da79a4ba16c55b2e749b9d30debd880e3cead808e66a8824d
-  data.tar.gz: f707eea04e876c2c6c781203a2d00e5675f8ae8c414e48a4f9413f8f614eedaf208c0a5411481b24b756f6954b625fe37f2105a3de6d12ef79bc059d3eb8a60e
+  metadata.gz: b2ea10129c13825376583228ce0d5e91f888c89e6adb0787f02c1f046801d79809b0fa2997799b30237493b70717c1bc5423eefc360d07387333709157f6690b
+  data.tar.gz: fbbf3d6e8d148ab9a67855ed8751d31b1f28adc1a4798309c6dc6344d02042c655997ab9abfe833b32686f58cc1fb9da4024bb56e62794d14c7b0c1b201fedc4

data/lib/kdl/builder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module KDL
+  class Builder < BasicObject
+    class Error < ::KDL::Error; end
+
+    def initialize
+      @nesting = []
+      @document = Document.new
+    end
+
+    def document(&block)
+      yield if block
+      @document
+    end
+
+    def node(name = nil, *args, type: nil, **props, &block)
+      n = Node.new(name&.to_s || "node", type:)
+      @nesting << n
+      args.each do |value|
+        case value
+        when ::Hash
+          value.each { |k, v| prop k, v }
+        else arg value
+        end
+      end
+      props.each do |key, value|
+        prop key, value
+      end
+      yield if block
+      @nesting.pop
+      if parent = current_node
+        parent.children << n
+      else
+        @document << n
+      end
+      n
+    end
+    alias _ node
+
+    def arg(value, type: nil)
+      if n = current_node
+        val = Value.from(value)
+        val = val.as_type(type) if type
+        n.arguments << val
+        val
+      else
+        raise Error, "Can't do argument, not inside Node"
+      end
+    end
+
+    def prop(key, value, type: nil)
+      key = key.to_s
+      if n = current_node
+        val = Value.from(value)
+        val = val.as_type(type) if type
+        n.properties[key] = val
+        val
+      else
+        raise Error, "Can't do property, not inside Node"
+      end
+    end
+
+    def method_missing(name, *args, **props, &block)
+      node name, *args, **props, &block
+    end
+
+    private
+
+    def current_node
+      return nil if @nesting.empty?
+
+      @nesting.last
+    end
+  end
+end

data/lib/kdl/document.rb

@@ -6,7 +6,7 @@ module KDL
 
     attr_accessor :nodes
 
-    def initialize(nodes)
+    def initialize(nodes = [])
       @nodes = nodes
     end
 
@@ -21,6 +21,10 @@ module KDL
       end
     end
 
+    def <<(node)
+      nodes << node
+    end
+
     def arg(key)
       self[key]&.arguments&.first&.value
     end

data/lib/kdl/error.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
 module KDL
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :filename, :line, :column
+
+    def initialize(message, filename = nil, line = nil, column = nil)
+      message += " (#{line}:#{column})" if line
+      message = "#{[filename, line, column].compact.join(':')}: #{message}" if filename
+      super(message)
+      @filename = filename
+      @line = line
+      @column = column
+    end
+  end
 
   class VersionMismatchError < Error
     attr_reader :version, :parser_version
 
-    def initialize(message, version = nil, parser_version = nil)
-      super(message)
+    def initialize(message, version = nil, parser_version = nil, filename = nil)
+      super(message, filename, 1, 1)
       @version = version
       @parser_version = parser_version
     end
@@ -16,9 +27,11 @@ module KDL
   class UnsupportedVersionError < Error
     attr_reader :version
 
-    def initialize(message, version = nil)
-      super(message)
+    def initialize(message, version = nil, filename = nil)
+      super(message, filename, 1, 1)
       @version = version
     end
   end
+
+  class ParseError < Error; end
 end

data/lib/kdl/kdl.yy

@@ -86,8 +86,8 @@ rule
     2
   end
 
-  def parse(str)
-    @tokenizer = ::KDL::Tokenizer.new(str)
+  def parse(str, filename: nil)
+    @tokenizer = ::KDL::Tokenizer.new(str, filename:)
     check_version
     do_parse
   end

data/lib/kdl/node.rb

@@ -48,6 +48,10 @@ module KDL
       end
     end
 
+    def <<(node)
+      children << node
+    end
+
     def child(key)
       case key
       when Integer

data/lib/kdl/parser_common.rb

@@ -21,8 +21,12 @@ module KDL
     def check_version
       return unless doc_version = @tokenizer.version_directive
       if doc_version != parser_version
-        raise VersionMismatchError.new("Version mismatch, document specified v#{doc_version}, but this is a v#{parser_version} parser", doc_version, parser_version)
+        raise VersionMismatchError.new("version mismatch, document specified v#{doc_version}, but this is a v#{parser_version} parser", doc_version, parser_version)
       end
     end
+
+    def on_error(t, val, vstack)
+      raise KDL::ParseError.new("unexpected #{token_to_str(t)} #{val&.value.inspect}", @tokenizer.filename, val&.line, val&.column)
+    end
   end
 end

data/lib/kdl/tokenizer.rb

@@ -4,12 +4,6 @@ require 'bigdecimal'
 
 module KDL
   class Tokenizer
-    class Error < ::KDL::Error
-      def initialize(message, line, column)
-        super("#{message} (#{line}:#{column})")
-      end
-    end
-
     class Token
       attr_reader :type, :value, :line, :column, :meta
 
@@ -30,10 +24,9 @@ module KDL
       def to_s
         "#{value.inspect} (#{line}:#{column})"
       end
-      alias inspect to_s
     end
 
-    attr_reader :index
+    attr_reader :index, :filename
 
     SYMBOLS = {
       '{' => :LBRACE,
@@ -72,13 +65,14 @@ module KDL
 
     VERSION_PATTERN = /\A\/-[#{WHITESPACE.join}]*kdl-version[#{WHITESPACE.join}]+(\d+)[#{WHITESPACE.join}]*[#{NEWLINES.join}]/
 
-    def initialize(str, start = 0)
+    def initialize(str, start = 0, filename: nil)
       @str = debom(str)
-      @context = nil
-      @rawstring_hashes = nil
       @start = start
       @index = start
       @buffer = +""
+      @filename = filename
+      @context = nil
+      @rawstring_hashes = nil
       @done = false
       @previous_context = nil
       @line = 1
@@ -201,7 +195,7 @@ module KDL
               traverse(1)
             end
           when '\\'
-            t = Tokenizer.new(@str, @index + 1)
+            t = Tokenizer.new(@str, @index + 1, filename:)
             la = t.next_token
             if la[0] == :NEWLINE || la[0] == :EOF || (la[0] == :WS && (lan = t.next_token[0]) == :NEWLINE || lan == :EOF)
               traverse_to(t.index)
@@ -433,7 +427,7 @@ module KDL
             @comment_nesting = 1
             traverse(2)
           elsif c == "\\"
-            t = Tokenizer.new(@str, @index + 1)
+            t = Tokenizer.new(@str, @index + 1, filename:)
             la = t.next_token
             if la[0] == :NEWLINE || la[0] == :EOF || (la[0] == :WS && (lan = t.next_token[0]) == :NEWLINE || lan == :EOF)
               traverse_to(t.index)
@@ -446,7 +440,7 @@ module KDL
             return token(:WS, -@buffer)
           end
         when :equals
-          t = Tokenizer.new(@str, @index)
+          t = Tokenizer.new(@str, @index, filename:)
           la = t.next_token
           if la[0] == :WS
             @buffer << la[1].value
@@ -488,9 +482,9 @@ module KDL
 
     def raise_error(error)
       case error
-      when String then raise Error.new(error, @line, @column)
+      when String then raise ParseError.new(error, @filename, @line, @column)
       when Error then raise error
-      else raise Error.new(error.message, @line, @column)
+      else raise ParseError.new(error.message, @filename, @line, @column)
       end
     end
 

data/lib/kdl/v1/kdl.yy

@@ -81,9 +81,9 @@ rule
     1
   end
 
-  def parse(str, **options)
+  def parse(str, filename: nil, **options)
     init(**options)
-    @tokenizer = ::KDL::V1::Tokenizer.new(str)
+    @tokenizer = ::KDL::V1::Tokenizer.new(str, filename:)
     check_version
     do_parse
   end

data/lib/kdl/v1/value.rb

@@ -83,7 +83,7 @@ module KDL
         when ::Float then Float.new(value)
         when TrueClass, FalseClass then Boolean.new(value)
         when NilClass then Null
-        else raise Error("Unsupported value type: #{value.class}")
+        else raise Error("unsupported value type: #{value.class}")
         end
       end
     end

data/lib/kdl/value.rb

@@ -167,7 +167,7 @@ module KDL
       when ::Float then Float.new(value)
       when TrueClass, FalseClass then Boolean.new(value)
       when NilClass then Null
-      else raise Error("Unsupported value type: #{value.class}")
+      else raise Error, "unsupported value type: #{value.class}"
       end
     end
   end

data/lib/kdl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDL
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/lib/kdl.rb

@@ -10,6 +10,7 @@ require "kdl/string_dumper"
 require "kdl/types"
 require "kdl/parser_common"
 require "kdl/kdl.tab"
+require "kdl/builder"
 require "kdl/v1"
 
 module KDL
@@ -23,28 +24,30 @@ module KDL
     parse(input, **options)
   end
 
-  def self.parse(input, version: default_version, output_version: default_output_version, **options)
+  def self.parse(input, version: default_version, output_version: default_output_version, filename: nil, **options)
     case version
     when 2
-      Parser.new(output_module: output_module(output_version || 2), **options).parse(input)
+      Parser.new(output_module: output_module(output_version || 2), **options).parse(input, filename:)
     when 1
-      V1::Parser.new.parse(input, output_module: output_module(output_version || 1), **options)
+      V1::Parser.new.parse(input, output_module: output_module(output_version || 1), filename:, **options)
     when nil
       auto_parse(input, output_version:, **options)
     else
-      raise UnsupportedVersionError.new("Unsupported version '#{version}'", version)
+      raise UnsupportedVersionError.new("unsupported version '#{version}'", version)
     end
   end
 
   def self.load_file(filespec, **options)
-    parse(File.read(filespec, encoding: Encoding::UTF_8), **options)
+    File.open(filespec, 'r:BOM|UTF-8') do |file|
+      parse(file.read, **options, filename: file.to_path)
+    end
   end
 
   def self.auto_parse(input, output_version: default_output_version, **options)
     parse(input, version: 2, output_version: output_version || 2, **options)
   rescue VersionMismatchError => e
     parse(input, version: e.version, output_version: output_version || e.version, **options)
-  rescue Tokenizer::Error, Racc::ParseError => e
+  rescue ParseError => e
     parse(input, version: 1, output_version: output_version || 1, **options) rescue raise e
   end
 
@@ -53,8 +56,20 @@ module KDL
     when 1 then KDL::V1
     when 2 then KDL
     else
-      warn "Unknown output_version `#{version}', defaulting to v2"
+      warn "[WARNING] Unknown output_version '#{version}', defaulting to v2"
       KDL
     end
   end
+
+  def self.build(&block)
+    builder = Builder.new
+    if block.arity >= 1
+      builder.document do
+        yield builder
+      end
+    else
+      builder.instance_exec(&block)
+      builder.document
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: kdl
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Danielle Smith
 bindir: exe
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -87,6 +87,7 @@ files:
 - bin/setup
 - kdl.gemspec
 - lib/kdl.rb
+- lib/kdl/builder.rb
 - lib/kdl/document.rb
 - lib/kdl/error.rb
 - lib/kdl/kdl.tab.rb