zon-rb 0.1.0 → 0.2.0

checksums.yaml

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

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2025-09-27
+
+- Added basic Zig package manifest support.
 
 ## [0.1.0] - 2025-09-27
 

data/README.md

@@ -1,25 +1,31 @@
 # Zig Object Notation (ZON) for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/zon-rb.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/zon-rb)
+
 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
+bundle add zon-rb
 ```
 
 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
+gem install zon-rb
 ```
 
 ## Usage
 
+To use this Gem you have to require it:
+
+```ruby
+require "zon"
+```
+
 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
@@ -94,6 +100,20 @@ irb(main):010> Zon::serialize(255, {:ibase => 2})
 => "0b11111111"
 ```
 
+### Zig Manifest
+
+`Zon::Zig::Manifest` provides you with an abstraction for your `build.zig.zon`. It will also validate your Zig package [manifest](https://github.com/ziglang/zig/blob/b7ab62540963d80f68d0e9ee7ce18520fb173487/doc/build.zig.zon.md) and raise an exception if one of the required fields is missing.
+
+```ruby
+o = Zon::parse(File.open("../PassKeeZ/build.zig.zon"))
+manifest = Zon::Zig::Manifest.new o
+
+# Use:
+# manifest.name
+# manifest.version
+# ...
+```
+
 ## 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.

data/lib/zon/version.rb

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

data/lib/zon/zig.rb

@@ -0,0 +1,79 @@
+module Zon
+
+  ##
+  # Everything related specifically to the Zig programming language.
+  module Zig
+    
+    ##
+    # An abstraction of the Zig package manifest.
+    #
+    # Every Zig package should have a +build.zig.zon+ in
+    # its package root, the manifest. Like a manifest in
+    # Ruby, it is used to describe the package and specify
+    # required dependencies.
+    class Manifest
+      def initialize(zon)
+        raise "Missing '.name'" if not zon[:name]
+        raise "Missing '.version'" if not zon[:version]
+        raise "Missing '.fingerprint'" if not zon[:fingerprint]
+
+        if zon[:dependencies]
+          zon[:dependencies].each do |key, value|
+            if value[:url]
+              raise "Missing '.hash' for dependency '#{key}'" if not value[:hash]
+            elsif not value[:path]
+              raise "Expected either '.url' or '.path' for dependency '#{key}'" if not value[:hash]
+            end 
+          end
+        end
+
+        @zon = zon
+      end
+      
+      ##
+      # Get the '.name' field of the manifest.
+      def name
+        @zon[:name]
+      end
+
+      ##
+      # Get the '.version' field of the manifest.
+      def version
+        @zon[:version]
+      end
+
+      ##
+      # Get the '.fingerprint' field of the manifest.
+      def fingerprint
+        @zon[:fingerprint]
+      end
+
+      ##
+      # Get the '.dependencies' field of the manifest.
+      #
+      # This will return nil if the '.dependencies' field does not exist.
+      def dependencies
+        @zon[:dependencies]
+      end
+
+      ##
+      # Get the '.paths' field of the manifest.
+      #
+      # This will return nil if the '.paths' field does not exist.
+      def paths
+        @zon[:paths]
+      end
+
+      ##
+      # Get the '.minimum_zig_version' field of the manifest.
+      #
+      # This will return nil if the '.minimum_zig_version' field does not exist.
+      def minimum_zig_version
+        @zon[:minimum_zig_version]
+      end
+
+    end
+
+  end
+
+end

data/lib/zon.rb

@@ -4,6 +4,7 @@ require_relative "zon/version"
 require_relative "zon/lexer"
 require_relative "zon/parser"
 require_relative "zon/serializer"
+require_relative "zon/zig"
 
 ##
 # Zig Object Notation (ZON) de-/serializer.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zon-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David P. Sugar
@@ -9,8 +9,8 @@ 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.
+description: This gem allows you to translate Zig Object Notation (ZON) data into
+  Ruby objects and vice versa.
 email:
 - david@thesugar.de
 executables: []
@@ -28,6 +28,7 @@ files:
 - lib/zon/parser.rb
 - lib/zon/serializer.rb
 - lib/zon/version.rb
+- lib/zon/zig.rb
 - lib/zon/zon_grammar.treetop
 - sig/zon.rbs
 homepage: https://github.com/r4gus/zon-rb