lutaml-model 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 073512f7cfe8a5d5bb7af56cf3c1804e0eb9942f9fe2e3f7e0dcc3b0b9fd879a
-  data.tar.gz: '00916ad5bc08547bd350f59be3c554700cd73c1b5af09e2ce7175f39d3443e45'
+  metadata.gz: c756e06ffeedb744a2c6dc3168e678770e105d856c0373340bfb91999a3e0d0d
+  data.tar.gz: b73daf9b28bc1e6920975a51cb55cdd15255421249e2b130f648e4989d8c7f92
 SHA512:
-  metadata.gz: '0196826861701d9277a81f5e0c52fd0bfdac8859128eddb82aee55c074a3688bc453f89ff40f54f8a40a639d5ac625d18e6f097c4abb88f7ee11294b7594e1ff'
-  data.tar.gz: 50fb93a7b534ae371ebecc62576633027a9cc945ed333cdbc7aa3c32a993a558b196dde0513aa594796cfb442c2837158c9181a101351933778009e4e5a00a05
+  metadata.gz: 05d5cb08e286dac1099ff9c591e62358609059dc42e4f97b5b7b41f5e638fc1d27b81437729980d8477a946fa4eac43f895da316dfc3ae7916af12e3a70b9074
+  data.tar.gz: 39d87718bc1687710b447618c547e567c6d324f05759000439343a450c3ce4cf7e327250654776066547dee768b9cf9dc0a7992a02969627930046f2bf95b815

data/.github/workflows/dependent-tests.yml

@@ -1,5 +1,9 @@
 name: dependent-gems-test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches: [ main ]

data/.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  repository_dispatch:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+          cache-version: 0
+          working-directory: docs
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        run: bundle exec jekyll build --verbose --trace --baseurl "${{ steps.pages.outputs.base_path }}"
+        working-directory: docs
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

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

@@ -0,0 +1,156 @@
+name: downstream-performance
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [master, main]
+    tags: [v*]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - downstream: xmi
+            repo: lutaml/xmi
+            env_key: XMI_DIR
+          - downstream: sts
+            repo: metanorma/sts-ruby
+            env_key: STS_DIR
+          - downstream: mml
+            repo: plurimath/mml
+            env_key: MML_DIR
+            submodules: true
+          - downstream: niso
+            repo: metanorma/niso-jats
+            env_key: NISO_DIR
+          - downstream: unitsml
+            repo: unitsml/unitsml-ruby
+            env_key: UNITSML_DIR
+          - downstream: uniword
+            repo: lutaml/uniword
+            env_key: UNIWORD_DIR
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Create main worktree for baseline
+        run: |
+          git worktree add /tmp/main-checkout origin/main
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Checkout downstream (${{ matrix.repo }})
+        uses: actions/checkout@v6
+        with:
+          repository: ${{ matrix.repo }}
+          path: downstream
+          submodules: ${{ matrix.submodules || false }}
+
+      - name: Run baseline benchmark (main branch)
+        env:
+          ITERATIONS: "3"
+          ${{ matrix.env_key }}: ${{ github.workspace }}/downstream
+          LUTAML_MODEL_DIR: ${{ github.workspace }}
+          BENCH_JSON: /tmp/bench_base_${{ matrix.downstream }}.json
+        run: |
+          cd downstream
+          ruby -e '
+            path = ARGV[0]
+            lines = File.readlines("Gemfile")
+            out = []; skip = false
+            lines.each do |l|
+              if l =~ /gem\s+["\x27]lutaml-model["\x27]/
+                skip = true; next
+              end
+              if skip && l =~ /^\s+\w+:/; next; end
+              skip = false; out << l
+            end
+            out << "gem \"lutaml-model\", path: \"#{path}\"\n"
+            File.write("Gemfile", out.join)
+          ' /tmp/main-checkout
+          bundle install --jobs=4
+          bundle exec ruby ${{ github.workspace }}/bench/bench_${{ matrix.downstream }}.rb
+
+      - name: Run current benchmark (PR branch)
+        env:
+          ITERATIONS: "3"
+          ${{ matrix.env_key }}: ${{ github.workspace }}/downstream
+          LUTAML_MODEL_DIR: ${{ github.workspace }}
+          BENCH_JSON: /tmp/bench_current_${{ matrix.downstream }}.json
+        run: |
+          cd downstream
+          ruby -e '
+            path = ARGV[0]
+            lines = File.readlines("Gemfile")
+            out = []; skip = false
+            lines.each do |l|
+              if l =~ /gem\s+["\x27]lutaml-model["\x27]/
+                skip = true; next
+              end
+              if skip && l =~ /^\s+\w+:/; next; end
+              skip = false; out << l
+            end
+            out << "gem \"lutaml-model\", path: \"#{path}\"\n"
+            File.write("Gemfile", out.join)
+          ' ${{ github.workspace }}
+          bundle install --jobs=4
+          bundle exec ruby ${{ github.workspace }}/bench/bench_${{ matrix.downstream }}.rb
+
+      - name: Compare baseline vs current
+        run: |
+          ruby bench/bench_compare.rb \
+            /tmp/bench_base_${{ matrix.downstream }}.json \
+            /tmp/bench_current_${{ matrix.downstream }}.json
+
+      - name: Upload benchmark results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: bench-${{ matrix.downstream }}
+          path: |
+            /tmp/bench_base_${{ matrix.downstream }}.json
+            /tmp/bench_current_${{ matrix.downstream }}.json
+
+  update-baselines:
+    needs: benchmark
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v6
+      - name: Download all benchmark results
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/bench_results
+          pattern: bench-*
+          merge-multiple: true
+      - name: Update baseline files
+        run: |
+          for json in /tmp/bench_results/bench_current_*.json; do
+            name=$(basename "$json" | sed 's/bench_current_/main_/')
+            cp "$json" "bench/baselines/$name"
+            echo "Updated baseline: bench/baselines/$name"
+          done
+      - name: Create pull request for updated baselines
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: "chore: update performance baselines"
+          title: "Update performance baselines"
+          branch: update-baselines
+          body: "Automated baseline update from CI performance run."

data/.github/workflows/performance.yml

@@ -0,0 +1,33 @@
+name: performance
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [master, main]
+    tags: [v*]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  performance:
+    runs-on: ubuntu-latest
+    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
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Run performance benchmarks
+        run: bundle exec rake performance:compare

data/.github/workflows/rake.yml

@@ -2,15 +2,28 @@
 # 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 ]
     tags: [ v* ]
     paths-ignore:
       - '**.adoc'
+      - 'docs/**'
+      - '*.md'
+      - 'LICENSE'
   pull_request:
     paths-ignore:
       - '**.adoc'
+      - 'docs/**'
+      - '*.md'
+      - 'LICENSE'
 
 jobs:
   rake:

data/.github/workflows/release.yml

@@ -13,6 +13,11 @@ on:
   repository_dispatch:
     types: [ do-release ]
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 jobs:
   release:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 .rubocop-https---*
 
 /.yardoc
@@ -15,4 +16,29 @@
 .direnv/
 
 # Bundler
-.bundle/
+.bundle/
+
+Gemfile.lock
+*_BACKUP_*
+*_BASE_*
+*_LOCAL_*
+*_REMOTE_*
+.vscode
+.rubocop-https*
+
+# Artifacts from static site generators
+/_site
+/docs/_site
+/docs/.jekyll-cache
+
+*.md
+old-docs/
+.kilocode/
+old/
+
+.orig
+.rubocop-*
+.DS_Store
+.ruby-lsp
+TODO*
+

data/.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
   - .rubocop_todo.yml
 
 plugins:
@@ -8,7 +8,19 @@ plugins:
 - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - 'vendor/**/*'
+    - 'tmp/**/*'
+    - '**/*.adoc'
+    - '**/*.md'
+    - 'niso-jats/**/*'
+    - 'sts-ruby/**/*'
+
+Style/OneClassPerFile:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - 'spec/**/*'