lutaml-model 0.8.17 → 0.8.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8296b9832eb080f64ba1344b7fa929b179fedc1c4265d9743d6636cd408720f6
-  data.tar.gz: 533255e9702cd82fc93cacc78bf88fb90dba17b8543b5ecf22bb223eaacfa9a1
+  metadata.gz: 852a93ce391ef7eb0f8e7673bda66f7bb417637b252735cebe833d1e305a6c7b
+  data.tar.gz: 65f067c3e0bf4e1d520d5e2d133a6de4606900844b5e91d367ce4edee51da0e1
 SHA512:
-  metadata.gz: 936d9c1ff8eefb9f2b861d3c29c4d032462f9f6f5624bb2d669ebfc77d49ade62ce2859f171052f3b473a00d0a83a88955ee1c4cbd47f5bbddfe2a625e62d1f8
-  data.tar.gz: 79f9f3b4cea4bff89c06df360e6a316507f62af37f2a277cd10dc54b38f72c374cadba6b4b995234e4c67f82dbaa71ecf751d3ec8ed280bf5fe0e64dca42534f
+  metadata.gz: 318f15b16d919319fd4c2cd9c2722a1ee37b8f1a4272b5a966ce45bf2811447c7c1004642fd76c3204ddd70c8fb4ac6de9397e67f7305529e4b2310769fca52b
+  data.tar.gz: 65479ec0a4e9ef58938953f94802da282bfe2d443c4d7cd41a9bf83973e653c3d6ce700fb9eb07e7e5cf1ffa120cfb54fded8d71d8215f4e35c76360dd6393fe

data/.github/workflows/downstream-performance.yml

@@ -42,16 +42,42 @@ jobs:
       - uses: actions/checkout@v6
         with:
           fetch-depth: 0
+          submodules: "recursive"
 
       - name: Create main worktree for baseline
         run: |
           git worktree add /tmp/main-checkout origin/main
+          (cd /tmp/main-checkout && git submodule update --init --recursive)
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.4'
-          bundler-cache: true
+          bundler-cache: false
+
+      - name: Install ragel
+        run: sudo apt-get update && sudo apt-get install -y ragel
+
+      - name: Install ruby-ll (for rake vendor:prepare)
+        run: gem install ruby-ll --no-document
+
+      - name: Generate ragel / ruby-ll outputs in vendored forks (current)
+        run: rake vendor:prepare
+
+      - name: Generate ragel / ruby-ll outputs in vendored forks (main baseline)
+        run: (cd /tmp/main-checkout && rake vendor:prepare)
+
+      - name: Configure bundler
+        run: |
+          mkdir -p .bundle
+          echo "---" > .bundle/config
+          echo 'BUNDLE_BUILD__RUBY___LL: "--with-cflags=-std=gnu17"' >> .bundle/config
+
+      - name: Compile liboga / libll native extensions (current)
+        run: rake vendor:compile
+
+      - name: Compile liboga / libll native extensions (main baseline)
+        run: (cd /tmp/main-checkout && rake vendor:compile)
 
       - name: Checkout downstream (${{ matrix.repo }})
         uses: actions/checkout@v6

data/.github/workflows/js-pr-check.yml

@@ -0,0 +1,102 @@
+name: js-pr-check
+
+# On PRs that touch lib/, Gemfile, Rakefile, or .gitmodules, fire a
+# repository_dispatch at lutaml-model-js so it builds a test artifact
+# and runs the JS smoke tests against the PR head. Does NOT publish.
+# Catches JS regressions before the Ruby PR merges.
+#
+# PAT token: LUTAML_CI_PAT_TOKEN must have `repo` scope on
+# lutaml/lutaml-model-js. Note that PRs from forks of lutaml/lutaml-model
+# will not have access to the PAT (GitHub masks secrets on fork PRs);
+# those builds will be skipped — contributors from forks should run
+# `gh workflow run js-pr-check` manually after pushing to a branch on
+# the origin repo.
+
+on:
+  pull_request:
+    paths:
+      - 'lib/**'
+      - 'Gemfile'
+      - 'gemspec'
+      - 'Rakefile'
+      - '.gitmodules'
+      - '.github/workflows/js-pr-check.yml'
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        description: PR number to test (for manual reruns).
+        required: true
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == 'lutaml/lutaml-model' }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          # Need the PR head, not the merge commit, so the SHA the JS
+          # build pulls matches what reviewers see.
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          fetch-depth: 0
+
+      - name: Resolve PR inputs
+        id: pr
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const prNumber = context.payload.inputs?.pr_number
+              ? parseInt(context.payload.inputs.pr_number, 10)
+              : context.payload.pull_request?.number;
+            if (!prNumber) {
+              core.setFailed("No PR number available");
+              return;
+            }
+            const { data: pr } = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: prNumber,
+            });
+            core.setOutput("number", String(prNumber));
+            core.setOutput("sha", pr.head.sha);
+            core.setOutput("ref", pr.head.ref);
+            core.setOutput("repo", pr.head.repo.full_name);
+
+      - name: Notify lutaml-model-js
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}
+          repository: lutaml/lutaml-model-js
+          event-type: js-pr-check
+          client-payload: |-
+            {
+              "pr_number": ${{ steps.pr.outputs.number }},
+              "sha": "${{ steps.pr.outputs.sha }}",
+              "ref": "${{ steps.pr.outputs.ref }}",
+              "repo": "${{ steps.pr.outputs.repo }}"
+            }
+
+      - name: Annotate PR with build link
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const body = [
+              "### JS build check",
+              "",
+              "Triggered [`js-pr-check`]",
+              `(https://github.com/lutaml/lutaml-model-js/actions/workflows/pr-check.yml)`,
+              "against this PR's head (`" + context.payload.pull_request.head.sha.substring(0, 7) + "`).",
+              "",
+              "The result will appear as a `lutaml-model-js / pr-check` status check",
+              "on this PR once the workflow run completes.",
+            ].join("\n");
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              body,
+            });

data/.github/workflows/js-sync.yml

@@ -0,0 +1,51 @@
+name: js-sync
+
+# On every push to main, fire a repository_dispatch at lutaml-model-js
+# so it rebuilds and publishes under the npm `next` dist-tag. This
+# closes the dev-build gap: JS consumers can track Ruby main without
+# waiting for a stable gem release.
+#
+# PAT token: LUTAML_CI_PAT_TOKEN must have `repo` scope on
+# lutaml/lutaml-model-js. Same token already used by release.yml.
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+    inputs:
+      sha:
+        description: Specific SHA to build from (defaults to HEAD on main).
+        required: false
+
+permissions:
+  contents: read
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Resolve SHA
+        id: sha
+        run: |
+          if [ -n "${{ github.event.inputs.sha }}" ]; then
+            echo "sha=${{ github.event.inputs.sha }}" >> "$GITHUB_OUTPUT"
+          else
+            echo "sha=${{ github.sha }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Notify lutaml-model-js
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}
+          repository: lutaml/lutaml-model-js
+          event-type: js-sync-main
+          client-payload: |-
+            {
+              "sha": "${{ steps.sha.outputs.sha }}",
+              "ref": "${{ github.ref }}",
+              "ruby_ref": "main"
+            }

data/.github/workflows/opal.yml

@@ -3,29 +3,49 @@ name: opal
 on:
   push:
     branches: [main]
+    tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           submodules: "recursive"
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.3"
-          bundler-cache: true
+          ruby-version: "3.4"
+          # bundler-cache disabled: the path-source oga and ruby-ll forks
+          # need ragel + ruby-ll outputs generated (rake vendor:prepare)
+          # before their C extensions can compile.
+          bundler-cache: false
 
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: "18"
 
+      - name: Install ragel
+        run: sudo apt-get update && sudo apt-get install -y ragel
+
+      - name: Install ruby-ll (for rake vendor:prepare)
+        run: gem install ruby-ll --no-document
+
+      - name: Generate ragel / ruby-ll outputs in vendored forks
+        # Run before bundle install: the path-source oga/ruby-ll forks
+        # gitignore their generated .rb/.c files. bundle install compiles
+        # the C extensions via each fork's extconf.rb, which needs
+        # ext/c/lexer.c to exist.
+        run: rake vendor:prepare
+
+      - name: Install dependencies
+        run: bundle install
+
       - name: Run Opal tests
-        # TODO: Remove continue-on-error once REXML adapter is verified
-        # under actual Opal runtime (REXML compiles to JS via Opal's stdlib)
         run: bundle exec rake spec:opal
-        continue-on-error: true

data/.github/workflows/performance.yml

@@ -19,15 +19,40 @@ jobs:
     timeout-minutes: 20
     steps:
       - uses: actions/checkout@v6
-      - name: Configure bundle for LLM extension
-        run: |
-          mkdir -p .bundle
-          echo "---" > .bundle/config
-          echo 'BUNDLE_BUILD__RUBY___LL: "--with-cflags=-std=gnu17"' >> .bundle/config
+        with:
+          submodules: "recursive"
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.4'
-          bundler-cache: true
+          # bundler-cache disabled: must run rake vendor:prepare before
+          # bundle install can compile the path-source forks' C extensions.
+          bundler-cache: false
+
+      - name: Install ragel
+        run: sudo apt-get update && sudo apt-get install -y ragel
+
+      - name: Install ruby-ll (for rake vendor:prepare)
+        run: gem install ruby-ll --no-document
+
+      - name: Generate ragel / ruby-ll outputs in vendored forks
+        # Path-source oga and ruby-ll forks gitignore their generated
+        # parser/lexer outputs. bundle install compiles the C extensions
+        # via each fork's extconf.rb, which needs ext/c/lexer.c to exist.
+        run: rake vendor:prepare
+
+      - name: Configure bundler
+        run: |
+          mkdir -p .bundle
+          echo "---" > .bundle/config
+          echo 'BUNDLE_BUILD__RUBY___LL: "--with-cflags=-std=gnu17"' >> .bundle/config
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Compile liboga / libll native extensions
+        run: rake vendor:compile
+
       - name: Run performance benchmarks
-        run: bundle exec rake performance:compare
+        run: bundle exec rake performance:compare

data/.github/workflows/rake.yml

@@ -1,40 +1,86 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: rake
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  contents: write
-
 on:
   push:
-    branches: [ master, main ]
+    branches: [ main ]
     tags: [ v* ]
-    paths-ignore:
-      - '**.adoc'
-      - 'docs/**'
-      - '*.md'
-      - 'LICENSE'
   pull_request:
-    paths-ignore:
-      - '**.adoc'
-      - 'docs/**'
-      - '*.md'
-      - 'LICENSE'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
-    with:
-      before-setup-ruby: |
-        mkdir -p .bundle
-        touch .bundle/config
-        cat .bundle/config
-        echo "---" >> .bundle/config
-        echo 'BUNDLE_BUILD__RUBY___LL: "--with-cflags=-std=gnu17"' >> .bundle/config
-        cat .bundle/config
-    secrets:
-      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}
+  test:
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: ["3.3", "3.4", "4.0"]
+        experimental: [false]
+        include:
+          - os: windows-latest
+            experimental: true
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: "recursive"
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          # bundler-cache disabled: the path-source oga and ruby-ll forks
+          # need ragel + ruby-ll outputs generated (rake vendor:prepare)
+          # before their C extensions can compile.
+          bundler-cache: false
+
+      - name: Install ragel (Linux)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y ragel
+
+      - name: Install ragel (macOS)
+        if: runner.os == 'macOS'
+        run: brew install ragel
+
+      - name: Install ragel (Windows)
+        if: runner.os == 'Windows'
+        run: choco install -y ragel
+        continue-on-error: true
+
+      - name: Install ruby-ll (for rake vendor:prepare)
+        run: gem install ruby-ll --no-document
+
+      - name: Generate ragel / ruby-ll outputs in vendored forks
+        # Run before bundle install: the path-source oga/ruby-ll forks
+        # gitignore their generated .rb/.c files. bundle install compiles
+        # the C extensions via each fork's extconf.rb, which needs
+        # ext/c/lexer.c to exist.
+        run: rake vendor:prepare
+
+      - name: Configure bundler
+        # ruby-ll's C extension needs an older C standard on some compilers.
+        run: |
+          mkdir -p .bundle
+          echo '---' > .bundle/config
+          echo 'BUNDLE_BUILD__RUBY___LL: "--with-cflags=-std=gnu17"' >> .bundle/config
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Compile liboga / libll native extensions
+        # Bundler does not reliably build path-source gems' native
+        # extensions; compile them explicitly so `require "oga"` (which
+        # requires libll) resolves under CRuby.
+        run: rake vendor:compile
+
+      - name: Run tests
+        run: bundle exec rake spec
+
+      - name: Run rubocop
+        run: bundle exec rake rubocop

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "vendor/opal-oga"]
+	path = vendor/opal-oga
+	url = https://github.com/lutaml/opal-oga.git
+[submodule "vendor/opal-ruby-ll"]
+	path = vendor/opal-ruby-ll
+	url = https://github.com/lutaml/opal-ruby-ll.git

data/.rubocop_todo.yml

@@ -548,3 +548,11 @@ Style/StringConcatenation:
     - 'lib/lutaml/model/schema/xml_compiler/complex_type.rb'
     - 'lib/lutaml/model/schema/xml_compiler/simple_type.rb'
     - 'lib/lutaml/model/schema/xml_compiler/xml_namespace_class.rb'
+
+# Offense count: 1
+# child_names_set may be a Set; Array#intersect? requires an Array, so
+# the autocorrect from rubocop 1.88.2's Style/ArrayIntersect would
+# break runtime. Use the block form.
+Style/ArrayIntersect:
+  Exclude:
+    - 'lib/lutaml/xml/model_transform.rb'

data/Gemfile

@@ -5,6 +5,14 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in lutaml-model.gemspec
 gemspec
 
+# Opal-compatible forks of oga and ruby-ll. The forks add pure-Ruby lexer
+# and driver fallbacks (under ext/pureruby/) plus an Opal-aware conditional
+# in lib/oga.rb / lib/ll/setup.rb that selects the pure-Ruby implementation
+# when RUBY_PLATFORM == 'opal'. Under CRuby/JRuby the forks behave
+# identically to upstream (the conditional falls through to liboga/libll).
+gem "oga", path: "vendor/opal-oga"
+gem "ruby-ll", path: "vendor/opal-ruby-ll"
+
 # needed for liquid with ruby 3.4
 gem "base64"
 gem "benchmark-ips"
@@ -14,13 +22,14 @@ gem "json-ld"
 gem "liquid", "~> 5"
 gem "multi_json"
 gem "nokogiri"
-gem "oga"
 gem "oj"
 gem "openssl", "~> 3.0"
 gem "ox"
 gem "rake"
 gem "rdf-turtle"
 gem "rexml"
+# TODO: revert rng branch to main when lutaml/rng#32 is merged
+gem "rng", git: "https://github.com/lutaml/rng", branch: "main"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-performance", require: false
@@ -32,3 +41,9 @@ gem "toml-rb"
 # ruby-prof works on all platforms including Windows (unlike stackprof)
 # Provides both CPU and memory profiling
 gem "ruby-prof", group: :development
+
+group :opal do
+  gem "opal", "~> 1.8"
+  gem "opal-rspec", "~> 1.0"
+  gem "opal-sprockets"
+end