zon-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32686cf609ab53ad187e1ea5eab78453f396642b7a092c60d1104b843f7dd47c
+  data.tar.gz: e022ce6c1cb840580a105acc23ace93bf42ebca5001af78d31d2bda183e18319
+SHA512:
+  metadata.gz: 13629fb58006c1ca81cecce5d3bf893f96835e3d927458de00745b0f0c3ccfea40a640d75bfb783c76433be2bcc5b83488c1576325237134f561d286f224e5c5
+  data.tar.gz: c0968e432df9bb625d9d6d49ad6104b6a0a9d9730180d7ef62a1efcb800e6405996184e39918a63ca45e6abae11b0834854ec365be8f90efc9949349bc7062d0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-27
+
+- Initial release
+
+This release contains a basic parser and serializer for the Zig Object Notation (ZON) please refer to the README for more details on how to use this Gem.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David P. Sugar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# Zig Object Notation (ZON) for Ruby
+
+The [Zig](https://ziglang.org/) Object Notation (ZON) is a file format primarily used within the Zig ecosystem. For example, ZON is used for the Zig package [manifest](https://github.com/ziglang/zig/blob/b7ab62540963d80f68d0e9ee7ce18520fb173487/doc/build.zig.zon.md).
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+To parse ZON data into a Ruby object, one can use the `Zon::parse` method. The method expects either a `String` or `IO` (`File`) object as its argument.
+
+```irb
+irb(main):001> Zon::parse(".{ \"foo\", \"bar\"}")
+=> ["foo", "bar"]
+irb(main):002> Zon.parse(File.open("../PassKeeZ/build.zig.zon"))
+=>
+{name: :passkeez,
+ version: "0.5.3",
+ minimum_zig_version: "0.15.1",
+ fingerprint: 15931082159778014966,
+ dependencies:
+  {keylib:
+    {url: "https://github.com/Zig-Sec/keylib/archive/refs/tags/0.7.0.tar.gz",
+     hash: "keylib-0.7.0-mbYjk6qaCQACutrMpyhgstSmYxSKmcuRmLI-CJSumBeA"},
+   uuid:
+    {url: "https://github.com/r4gus/uuid-zig/archive/refs/tags/0.4.0.tar.gz",
+     hash: "uuid-0.4.0-oOieIR2AAAChAUVBY4ABjYI1XN0EbVALmiN0JIlggC3i"},
+   kdbx: {path: "../kdbx"}},
+ paths: ["build.zig", "build.zig.zon", "linux", "README.md", "script", "src", "static"]}
+```
+
+To serialize a Ruby object into ZON, use the `Zon::serialize` method. 
+
+```irb
+irb(main):002> o
+=>
+{name: :passkeez,
+ version: "0.5.3",
+ minimum_zig_version: "0.15.1",
+ fingerprint: 15931082159778014966,
+ dependencies:
+  {keylib: {url: "https://github.com/Zig-Sec/keylib/archive/refs/tags/0.7.0.tar.gz", hash: "keylib-0.7.0-mbYjk6qaCQACutrMpyhgstSmYxSKmcuRmLI-CJSumBeA"},
+   uuid: {url: "https://github.com/r4gus/uuid-zig/archive/refs/tags/0.4.0.tar.gz", hash: "uuid-0.4.0-oOieIR2AAAChAUVBY4ABjYI1XN0EbVALmiN0JIlggC3i"},
+   kdbx: {path: "../kdbx"}},
+ paths: ["build.zig", "build.zig.zon", "linux", "README.md", "script", "src", "static"]}
+irb(main):013> puts(Zon::serialize(o, {:indent_level => 4}))
+.{
+    .name = .passkeez,
+    .version = "0.5.3",
+    .minimum_zig_version = "0.15.1",
+    .fingerprint = 0xdd1692d15d21a6f6,
+    .dependencies = .{
+        .keylib = .{
+            .url = "https://github.com/Zig-Sec/keylib/archive/refs/tags/0.7.0.tar.gz",
+            .hash = "keylib-0.7.0-mbYjk6qaCQACutrMpyhgstSmYxSKmcuRmLI-CJSumBeA",
+        },
+        .uuid = .{
+            .url = "https://github.com/r4gus/uuid-zig/archive/refs/tags/0.4.0.tar.gz",
+            .hash = "uuid-0.4.0-oOieIR2AAAChAUVBY4ABjYI1XN0EbVALmiN0JIlggC3i",
+        },
+        .kdbx = .{
+            .path = "../kdbx",
+        },
+    },
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "linux",
+        "README.md",
+        "script",
+        "src",
+        "static",
+    },
+}
+```
+
+To customize the generated ZON data one can use the `:indent_level` and `:ibase` options. The `:indent_level` specifies how much each block is indented. The `:ibase` option can be used to define in which format (hex: 16, octal: 8, binary: 2, decimal: 10) an `Integer` should be serialized. The default for `:ibase` is `16` (hexadecimal).
+
+```irb
+irb(main):010> Zon::serialize(255, {:ibase => 2})
+=> "0b11111111"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r4gus/zon-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/zon/lexer.rb

@@ -0,0 +1,129 @@
+module Zon
+  module Lexer
+    class TokenType
+      LITERAL = 0
+      STRING = 1
+      NUMBER = 2
+      BOOLEAN = 3
+      LBRACE = 4
+      RBRACE = 5
+      EQUALS = 6
+      COMMA = 7
+    end
+
+    class Token
+      attr_accessor :type
+      attr_accessor :value
+
+      def initialize(type, value)
+        @type = type
+        @value = value
+      end
+
+      def ==(other)
+        self.type == other.type and self.value == other.value
+      end
+    end
+
+    def self.read(input)
+      curr = ""
+      in_comment = false
+      in_string = false
+
+      Enumerator.new do |y|
+        input.each_char.with_index do |char, idx|
+          # Handle comments
+          if not in_string and not in_comment and char == "/" and input[idx + 1] == "/"
+            if curr.length > 0
+              y << curr
+              curr = ""
+            end 
+            in_comment = true
+            next
+          elsif in_comment and char.match?(/(\r\n|\n|\r)/)
+            # there are only line comments, i.e. every
+            # line needs to be commented separately.
+            in_comment = false
+            next
+          elsif in_comment
+            next
+          end
+          
+          if not in_string and char.match?(/\s/) # is whitespace
+            if curr.length > 0
+              y << curr
+              curr = ""
+            end 
+            next
+          end
+
+          if not in_string and char == "{"
+            if curr[-1] == "."
+              y << ".{"
+              curr = ""
+            else
+              raise "Invalid character #{curr[-1]} preceding '{' at index #{idx}" 
+            end
+          elsif not in_string and ["}", "=", ","].include?(char)
+            y << curr if curr.length > 0
+            y << char
+            curr = ""
+          else
+            in_string = not in_string if char == "\"" and curr[-1] != "\\"
+            curr += char
+          end
+        end
+      end
+    end
+
+    def self.parse(input)
+      Enumerator.new do |y|
+        self.read(input).with_index do |token_str, idx|
+          if token_str == ".{"
+            y << Token.new(TokenType::LBRACE, token_str)
+          elsif token_str == "}"
+            y << Token.new(TokenType::RBRACE, token_str)
+          elsif token_str == "="
+            y << Token.new(TokenType::EQUALS, token_str)
+          elsif token_str == ","
+            y << Token.new(TokenType::COMMA, token_str)
+          elsif token_str[0] == '"'
+            if token_str.length <= 1 or not token_str[-1] == '"'
+              raise "Token string at index #{idx} not terminated"
+            end
+            y << Token.new(TokenType::STRING, token_str)
+          elsif ["true", "false"].include?(token_str)
+            y << Token.new(TokenType::BOOLEAN, token_str)
+          elsif self.is_number? token_str
+            y << Token.new(TokenType::NUMBER, token_str)
+          elsif self.is_literal? token_str
+            y << Token.new(TokenType::LITERAL, token_str)
+          else
+            raise "Unknown token '#{token_str}' at index #{idx}"
+          end
+        end
+      end
+    end
+
+    def self.is_literal?(token_str)
+      literal_regex = /\.[a-zA-Z][a-zA-Z_]*/
+      !!(token_str =~ literal_regex)
+    end
+
+    def self.is_number?(token_str)
+      number_regex = /\A
+        [+-]?                  # optional sign
+        (
+          0[xX][0-9a-fA-F]+    # hex
+          |
+          0[bB][01]+           # binary
+          |
+          0[oO]?[0-7]+         # octal (0o77 or classic 077)
+          |
+          \d+                  # decimal
+        )
+      \z/x
+      !!(token_str =~ number_regex)
+    end
+  end
+end

data/lib/zon/parser.rb

@@ -0,0 +1,144 @@
+require_relative "lexer"
+
+Lexer = Zon::Lexer
+
+module Zon
+
+  class Parser
+    STRUCT = 0 
+    ARRAY = 1
+
+    def initialize(tokens)
+      @tokens = tokens
+      @curr = nil
+    end
+
+    def next
+      begin
+        @curr = @tokens.next
+      rescue
+        @curr = nil
+      end
+    end
+
+    def parse
+      if self.next_token? Lexer::TokenType::LBRACE
+        self.next
+
+        if self.next_token? Lexer::TokenType::RBRACE # '.{ }'
+          self.next
+          return {} # this could either be a array or a struct... we don't know
+        end
+
+        v = self.parse
+
+        if v.is_a? Symbol and self.next_token? Lexer::TokenType::EQUALS
+          # This is a Zon struct, i.e. translate it to a Ruby hash
+          k = v
+          self.next_equals # skip equals
+          v = self.parse
+
+          h = {k => v}
+
+          loop do # fetch remaining key value pairs
+            self.next if self.next_token? Lexer::TokenType::COMMA
+            if self.next_token? Lexer::TokenType::RBRACE
+              self.next
+              break
+            end
+
+            k = self.next_key
+            self.next_equals
+            v = self.parse
+            h[k] = v
+          end
+
+          return h
+        else
+          # Must be an array
+          
+          a = [v]
+
+          loop do # fetch remaining values
+            self.next if self.next_token? Lexer::TokenType::COMMA
+            if self.next_token? Lexer::TokenType::RBRACE
+              self.next
+              break
+            end
+            
+            a.append self.parse
+          end
+
+          return a
+        end
+      else
+        return self.next_value
+      end
+    end
+
+    def next_token?(type)
+      self.peek_token.type == type 
+    end
+
+    def peek_token
+      begin
+        @tokens.peek
+      rescue
+        nil
+      end
+    end
+
+    def next_key
+      self.next
+
+      if @curr and @curr.type == Lexer::TokenType::LITERAL
+        @curr.value[1..].to_sym # create sym from string without the '.'
+      elsif
+        raise "Expected literal token but got '#{@curr.value}'"
+      end
+    end
+
+    def next_value
+      self.next
+
+      raise "No token for value" if not @curr
+
+      value = nil
+
+      if @curr.type == Lexer::TokenType::LITERAL
+        value = @curr.value[1..].to_sym
+      elsif @curr.type == Lexer::TokenType::STRING
+        value = @curr.value[1..-2]
+      elsif @curr.type == Lexer::TokenType::NUMBER
+        begin
+          if @curr.value.include? "."
+            value = Float(@curr.value)
+          else
+            value = Integer(@curr.value)
+          end
+        rescue
+          raise "Unable to parse number from value '#{@curr.value}'"
+        end
+      elsif @curr.type == Lexer::TokenType::BOOLEAN
+        if @curr.value == "true"
+          value = true
+        else
+          value = false
+        end
+      end
+
+      raise "Unable to parse value from '#{@curr.value}'" if not value
+
+      value
+    end
+
+    def next_equals
+      self.next
+
+      if not @curr or not @curr.type == Lexer::TokenType::EQUALS
+        raise "Expected '=' token but got '#{@curr.value}'"
+      end
+    end
+  end
+
+end

data/lib/zon/serializer.rb

@@ -0,0 +1,104 @@
+module Zon
+  module Serializer
+    def self.serialize_object(obj, options = {}, level = 0)
+
+      defaults = { :indent_level => 0, :ibase => 16 }
+      options = defaults.merge(options)
+
+      if obj.is_a? Integer
+        s = ""
+        case options[:ibase]
+        when 16
+          s += "0x"
+        when 8
+          s += "0o"
+        when 2
+          s += "0b"
+        end
+
+        s += obj.to_s(options[:ibase])
+        s
+      elsif obj.is_a? Float
+        String(obj)
+      elsif obj.is_a? String
+        "\"" + obj + "\""
+      elsif obj.is_a? Array
+        out = ""
+        l = obj.length
+
+        out += ".{"
+        if options[:indent_level] > 0
+          out += "\n"
+        end
+        
+        obj.each.with_index do |elem, idx|
+          if options[:indent_level] > 0
+            out += " " * (options[:indent_level] * (level + 1))
+          else
+            out += " "
+          end
+
+          out += self.serialize_object(elem, options, level + 1) 
+
+          if options[:indent_level] > 0
+            out += ",\n" 
+          else
+            out += "," if idx < l - 1 # l is at least 1 otherwise this loop is not entered
+            out += " " if idx == l - 1 # last elem
+          end
+        end
+        
+        if options[:indent_level] > 0
+            out += " " * (options[:indent_level] * level)
+        end
+        out += "}"
+        out
+      elsif obj.is_a? Hash
+        out = ""
+        l = obj.length
+
+        out += ".{"
+        if options[:indent_level] > 0
+          out += "\n"
+        end
+
+        obj.each.with_index do |kv, idx|
+          key = kv[0]
+          value = kv[1]
+
+          raise "Key #{key} must be a Symbol" if not key.is_a? Symbol
+
+          if options[:indent_level] > 0
+            out += " " * (options[:indent_level] * (level + 1))
+          else
+            out += " "
+          end
+
+          out += "." + String(key)
+          out += " = "
+          out += self.serialize_object(value, options, level + 1) 
+          if options[:indent_level] > 0
+            out += ",\n" 
+          else
+            out += "," if idx < l - 1 # l is at least 1 otherwise this loop is not entered
+            out += " " if idx == l - 1 # last elem
+          end
+        end
+
+        if options[:indent_level] > 0
+            out += " " * (options[:indent_level] * level)
+        end
+        out += "}"
+        out
+      elsif obj.is_a? TrueClass
+        "true"
+      elsif obj.is_a? FalseClass
+        "false"
+      elsif obj.is_a? Symbol
+        "." + String(obj)
+      else
+        raise ArgumentError, "Unable to serialize '#{obj}' of Class '#{obj.class}' to ZON"
+      end 
+    end
+  end
+end

data/lib/zon/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Zon
+  VERSION = "0.1.0"
+end

data/lib/zon/zon_grammar.treetop

@@ -0,0 +1,48 @@
+grammar ZonGrammar
+    rule zon
+        struct / array
+    end
+
+    rule array
+        '.{' space a_value? (space ',' space a_value)* space '}'
+    end
+
+    rule struct
+        '.{' space pair? (space ',' space pair)* space '}' 
+    end 
+
+    rule a_value
+        struct / array / string / number / literal / true / false / null
+    end
+
+    rule space
+        [\s\n\t\r]*
+    end
+       
+    rule pair
+        literal space '=' space value
+        {
+            def value(parent)
+                parent[elements[0].value.to_sym] = elements[4].value
+            end
+        }
+    end
+
+    rule literal
+        '.' [a-zA-Z_]+
+        {
+          def value
+            elements[1].text_value
+          end
+        }
+    end
+
+    rule string
+        '"' ([^"\\] / "\\" . )* '"'
+        {
+          def value(_env=nil)
+            elements[1].text_value
+          end
+        }
+    end
+end

data/lib/zon.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "zon/version"
+require_relative "zon/lexer"
+require_relative "zon/parser"
+require_relative "zon/serializer"
+
+##
+# Zig Object Notation (ZON) de-/serializer.
+module Zon
+  class Error < StandardError; end
+  
+  ##
+  # Parse ZON data, represented as String or IO/File, into
+  # a Ruby object.
+  #
+  # An ArgumentError is raised if input is neither a String nor
+  # a IO object.
+  def self.parse(input)
+    data = nil
+
+    if input.is_a? String
+      data = input
+    elsif input.is_a? IO
+      data = input.read
+    else
+      raise ArgumentError, "Input must be a String or a File/IO object"
+    end
+
+    tokens = Zon::Lexer.parse data
+    parser = Zon::Parser.new tokens
+    parser.parse
+  end
+  
+  ##
+  # Serialize a Ruby object into a ZON string.
+  #
+  # Available options:
+  # - { :indent_level => <Integer> } - Define the indentation level for each block
+  # - { :ibase => <Integer> } - Specify the base (binary: 2, octal: 8, decimal: 10, hex: 16)
+  def self.serialize(obj, options = {})
+    Zon::Serializer::serialize_object(obj, options)
+  end
+end
+

data/sig/zon.rbs

@@ -0,0 +1,4 @@
+module Zon
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: zon-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David P. Sugar
+bindir: exe
+cert_chain: []
+date: 2025-09-27 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows you to translate ZON data into Ruby objects and vice
+  versa.
+email:
+- david@thesugar.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zon.rb
+- lib/zon/lexer.rb
+- lib/zon/parser.rb
+- lib/zon/serializer.rb
+- lib/zon/version.rb
+- lib/zon/zon_grammar.treetop
+- sig/zon.rbs
+homepage: https://github.com/r4gus/zon-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r4gus/zon-rb
+  source_code_uri: https://github.com/r4gus/zon-rb
+  changelog_uri: https://github.com/r4gus/zon-rb/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Zig Object Notation (ZON) support for Ruby
+test_files: []