mml 2.4.2 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c77b2ef21dc7f5b7c41d642d3501b45c1ea2c6fb9c02ffe4994d854def2387ed
-  data.tar.gz: 4be1c2a88c5643bc242d8d5ea4cacd6902e7fb68bb2cb2baba40cc9ad4c151d7
+  metadata.gz: f2ceed2663265e233553c9545d55aba20fd2c3d6b35e6ee3b7fdd2649d9ea779
+  data.tar.gz: 9c2e6fe91813bf181b968be1f2470f03c93e88dbadd0755da50d782066777b10
 SHA512:
-  metadata.gz: 9f83c302a2ad241e04601c7ff70e2b44719e94d649ad0e808203d6ce3f6241db04ec373212a63b1ce96d82b959736690a3d2fa6e93f904812678dd41060b0ec0
-  data.tar.gz: aa52ac71ca819d8426d89fd061a32ad9822ae05ac875b3c0bb2e42c08d731f739d5e440368128f67e34531dce80d0c5044f3a2241ea02d20b1e4612e6e39ed3d
+  metadata.gz: 887114641a9b57f242302c3d75bd40bb6911d41d427d3afa5d09505dcb73cc06c061c3e56c48df4d3507eb7cf8edca0dae59b5f32d91b3b46af00de14029c60f
+  data.tar.gz: d01b619568ccc20403c313aa44f1c2c97461fdc3d014f21189ce28d138659b7d6f56eb7fd81127a37ea6648503df4dad65213380487290ed1d900d4e890b967c

data/.github/workflows/notify-mml-js.yml

@@ -0,0 +1,127 @@
+# Hand-maintained cross-repo trigger.
+name: notify-mml-js
+
+# After each successful release, dispatch do-release to plurimath/mml-js,
+# which compiles that version with Opal and publishes it to npm as
+# @plurimath/mml.
+#
+# Runs on workflow_run, not on push: the release pushes its version bump
+# with GITHUB_TOKEN, which starts no push-triggered workflows.
+#
+# Dispatches only a commit tagged v<VERSION> for its own
+# lib/mml/version.rb, and only if that commit is:
+# - the child of head_sha on main's first-parent line (normal run), or
+# - head_sha itself, on main, with no later v* tag on main (recovery run:
+#   a release with next_version=skip after a run that tagged and failed).
+# Fails if lib/mml/version.rb cannot be read or does not have exactly one
+# `VERSION = "..."` line.
+#
+# Limits: the release commits and tags its bump on top of the main tip it
+# checks out, which is head_sha only if main has not moved. If it moved,
+# this run's release is not dispatched. If head_sha's child is a release
+# commit tagged by another run, or by the first attempt of a re-run (which
+# keeps head_sha), that version is dispatched instead. A run that made no
+# bump also dispatches such a child. A version can be dispatched more than
+# once; mml-js must treat an already-published version as done. To send a
+# missed release, run release with next_version=skip while main is at that
+# release's commit.
+
+on:
+  workflow_run:
+    workflows: [release]
+    types: [completed]
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  dispatch:
+    if: github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: main
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Find the version this release run tagged
+        id: ver
+        env:
+          HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
+        run: |
+          set -euo pipefail
+          if ! printf '%s' "$HEAD_SHA" | grep -qxE '[0-9a-f]{40}'; then
+            printf '::error::unexpected head_sha: %q\n' "$HEAD_SHA"
+            exit 1
+          fi
+          # Sets V to VERSION in lib/mml/version.rb at commit $1.
+          read_version() {
+            local source
+            if ! source=$(git show "$1:lib/mml/version.rb"); then
+              printf '::error::cannot read lib/mml/version.rb at %s\n' "$1"
+              exit 1
+            fi
+            local lines
+            lines=$(printf '%s\n' "$source" \
+              | { grep -E '^[[:space:]]*VERSION = "[^"]+"' || true; })
+            V=$(printf '%s\n' "$lines" | sed -n '1s/^[^"]*"\([^"]*\)".*$/\1/p')
+            if [ -z "$V" ] || [ "$(printf '%s\n' "$lines" | wc -l)" -ne 1 ]; then
+              printf '::error::no VERSION = "..." line in lib/mml/version.rb at %s\n' "$1"
+              exit 1
+            fi
+          }
+          tag_commit() { git rev-parse -q --verify "refs/tags/v$1^{commit}" || true; }
+          RELEASE=""
+          NEW=""
+          # Normal run: the bump commit is head_sha's child on main's
+          # first-parent line.
+          BUMP=$(git rev-list --first-parent --parents origin/main \
+            | awk -v h="$HEAD_SHA" '!found && $2 == h { print $1; found = 1 }')
+          if [ -n "$BUMP" ]; then
+            read_version "$BUMP"
+            if [ "$(tag_commit "$V")" = "$BUMP" ]; then
+              RELEASE=$BUMP
+              NEW=$V
+            fi
+          fi
+          # Recovery run: head_sha is on main, is the tagged release commit,
+          # and no later v* tag is on main.
+          if [ -z "$RELEASE" ] && git merge-base --is-ancestor "$HEAD_SHA" origin/main 2>/dev/null \
+            && [ -z "$(git tag -l 'v*' --merged origin/main --no-merged "$HEAD_SHA")" ]; then
+            read_version "$HEAD_SHA"
+            if [ "$(tag_commit "$V")" = "$HEAD_SHA" ]; then
+              RELEASE=$HEAD_SHA
+              NEW=$V
+            fi
+          fi
+          if [ -z "$RELEASE" ]; then
+            echo "no release commit for this run; not dispatching"
+            echo "dispatch=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+          # Accept only npm semver (2.5.0.rc1 is not).
+          # Reject newlines before grep's per-line check.
+          if [[ "$NEW" == *$'\n'* ]] || ! printf '%s' "$NEW" \
+            | grep -qE '^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$'; then
+            printf '::error::VERSION %q is not a semver version mml-js can publish\n' "$NEW"
+            exit 1
+          fi
+          echo "release commit $RELEASE is tagged v$NEW; dispatching"
+          echo "dispatch=true" >> "$GITHUB_OUTPUT"
+          echo "version=$NEW" >> "$GITHUB_OUTPUT"
+
+      - name: Dispatch do-release to plurimath/mml-js
+        if: steps.ver.outputs.dispatch == 'true'
+        # v4.0.1
+        uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697
+        with:
+          token: ${{ secrets.PLURIMATH_CI_PAT_TOKEN }}
+          repository: plurimath/mml-js
+          event-type: do-release
+          client-payload: |
+            {
+              "version": "${{ steps.ver.outputs.version }}",
+              "ruby_ref": "v${{ steps.ver.outputs.version }}"
+            }

data/.github/workflows/opal.yml

@@ -0,0 +1,25 @@
+name: opal
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  boot-file-spec:
+    name: Opal boot file verification
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Run opal boot file spec
+      run: bundle exec rspec spec/mml/opal_boot_spec.rb

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 gem "canon"
 gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
 gem "nokogiri"
+gem "opal", "~> 1.8"
 gem "ox"
 gem "pry"
 gem "rake", "~> 12.0"

data/README.adoc

@@ -630,6 +630,33 @@ bundle exec rubocop     # Lint
 bin/console             # Interactive IRB
 ----
 
+=== Opal build
+
+`lib/mml/opal.rb` is the Opal entry point. It requires every file under
+`lib/mml` in load order and registers the V2, V3 and V4 models at its end.
+`spec/mml/opal_boot_spec.rb` checks it on MRI and compiles it with
+`Opal::Builder`; the `opal` workflow runs that spec.
+
+`spec/opal/` holds a runtime smoke test that runs only locally. It compiles
+the boot file with Opal, loads it in Node after `@lutaml/opal-runtime` and
+`@lutaml/lutaml-model`, and round-trips one document through
+`Mml::V2::Math.from_xml`, `Mml::V3::Math.from_xml` and
+`Mml::V4::Math.from_xml`:
+
+[source,bash]
+----
+bundle exec ruby spec/opal/build_smoke.rb /tmp/mml-opal.js
+cd <directory whose node_modules has both packages>
+node /path/to/mml/spec/opal/smoke.js /tmp/mml-opal.js
+----
+
+There is no CI job for it, because no published `@lutaml/lutaml-model`
+works with this gem: `0.1.0` (`latest`) contains no `dist/` files, and the
+`next` dev build is older than the lutaml-model version this gem requires.
+Locally it needs an `@lutaml/lutaml-model` compiled with Opal from a
+lutaml-model version this gem accepts, for example a local build of
+https://github.com/lutaml/lutaml-model-js[lutaml-model-js].
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/lib/mml/common_elements.rb

@@ -210,7 +210,7 @@ module Mml
     attribute :moment_value, :moment, collection: true
     attribute :momentabout_value, :momentabout, collection: true
 
-    # rubocop:disable Metrics/BlockLength
+    # rubocop:disable-next Metrics/BlockLength
     xml do
       # Presentation elements
       map_element "mmultiscripts", to: :mmultiscripts_value
@@ -416,6 +416,5 @@ module Mml
       map_element "moment", to: :moment_value
       map_element "momentabout", to: :momentabout_value
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/mml/opal.rb

@@ -0,0 +1,371 @@
+# frozen_string_literal: true
+
+# Opal entry point for mml.
+#
+# Requires every file under lib/mml in dependency order, then registers
+# each version's models once. Mml.opal_boot! keeps the version files from
+# registering at load time, before their element files are loaded.
+#
+# Ordering:
+#   - Each version's Configuration, Namespace and CommonElements load
+#     before its element files.
+#   - The first `module Mml::VN` autoloads mml/vN.rb. The later
+#     `require "mml/vN"` is a no-op.
+#   - Mml::VN.register_models! runs after the last element file. It skips
+#     a version whose models are already registered.
+
+require "lutaml/model"
+
+require "mml"
+Mml.opal_boot!
+require "mml/version"
+require "mml/namespace"
+require "mml/context_options"
+require "mml/context_configuration"
+require "mml/versioned_parser"
+
+require "mml/base"
+require "mml/common_elements"
+
+# Base attribute modules
+require "mml/base/common_attributes"
+require "mml/base/universal_presentation_attributes"
+require "mml/base/v3_common"
+require "mml/base/v3_presentation_attributes"
+require "mml/base/v4_attributes"
+require "mml/base/deprecated_font_attributes"
+require "mml/base/v3_only"
+
+# Base v3_only nested files
+require "mml/base/v3_only/operator_attrs"
+require "mml/base/v3_only/style_attrs"
+require "mml/base/v3_only/table_attrs"
+
+# Base content loader + content modules
+require "mml/base/content_loader"
+require "mml/base/content/annotation"
+require "mml/base/content/annotation_xml"
+require "mml/base/content/apply"
+require "mml/base/content/arith"
+require "mml/base/content/bind"
+require "mml/base/content/bvar"
+require "mml/base/content/calculus"
+require "mml/base/content/cbytes"
+require "mml/base/content/cerror"
+require "mml/base/content/ci"
+require "mml/base/content/cn"
+require "mml/base/content/condition"
+require "mml/base/content/constants"
+require "mml/base/content/cs"
+require "mml/base/content/csymbol"
+require "mml/base/content/declare"
+require "mml/base/content/degree"
+require "mml/base/content/elementary_functions"
+require "mml/base/content/fn"
+require "mml/base/content/functions"
+require "mml/base/content/interval"
+require "mml/base/content/inverse"
+require "mml/base/content/lambda"
+require "mml/base/content/linear_algebra"
+require "mml/base/content/logic"
+require "mml/base/content/otherwise"
+require "mml/base/content/piece"
+require "mml/base/content/piecewise"
+require "mml/base/content/relations"
+require "mml/base/content/reln"
+require "mml/base/content/semantics"
+require "mml/base/content/sep"
+require "mml/base/content/sets"
+require "mml/base/content/share"
+require "mml/base/content/statistics"
+require "mml/base/content/vector_calculus"
+
+# Base presentation modules
+require "mml/base/maction"
+require "mml/base/maligngroup"
+require "mml/base/malignmark"
+require "mml/base/math"
+require "mml/base/menclose"
+require "mml/base/merror"
+require "mml/base/mfenced"
+require "mml/base/mfrac"
+require "mml/base/mfraction"
+require "mml/base/mglyph"
+require "mml/base/mi"
+require "mml/base/mlabeledtr"
+require "mml/base/mlongdiv"
+require "mml/base/mmultiscripts"
+require "mml/base/mn"
+require "mml/base/mo"
+require "mml/base/mover"
+require "mml/base/mpadded"
+require "mml/base/mphantom"
+require "mml/base/mprescripts"
+require "mml/base/mroot"
+require "mml/base/mrow"
+require "mml/base/ms"
+require "mml/base/mscarries"
+require "mml/base/mscarry"
+require "mml/base/msgroup"
+require "mml/base/msline"
+require "mml/base/mspace"
+require "mml/base/msqrt"
+require "mml/base/msrow"
+require "mml/base/mstack"
+require "mml/base/mstyle"
+require "mml/base/msub"
+require "mml/base/msubsup"
+require "mml/base/msup"
+require "mml/base/mtable"
+require "mml/base/mtd"
+require "mml/base/mtext"
+require "mml/base/mtr"
+require "mml/base/munder"
+require "mml/base/munderover"
+require "mml/base/none"
+require "mml/base/semantics"
+
+# v2 shared infrastructure
+require "mml/v2/configuration"
+require "mml/v2/namespace"
+require "mml/v2/common_elements"
+
+# v2 element files
+require "mml/v2/annotation"
+require "mml/v2/annotation_xml"
+require "mml/v2/apply"
+require "mml/v2/arith"
+require "mml/v2/bind"
+require "mml/v2/bvar"
+require "mml/v2/calculus"
+require "mml/v2/ci"
+require "mml/v2/cn"
+require "mml/v2/condition"
+require "mml/v2/constants"
+require "mml/v2/csymbol"
+require "mml/v2/degree"
+require "mml/v2/elementary_functions"
+require "mml/v2/fn"
+require "mml/v2/functions"
+require "mml/v2/interval"
+require "mml/v2/inverse"
+require "mml/v2/lambda"
+require "mml/v2/linear_algebra"
+require "mml/v2/logic"
+require "mml/v2/maction"
+require "mml/v2/maligngroup"
+require "mml/v2/malignmark"
+require "mml/v2/math"
+require "mml/v2/menclose"
+require "mml/v2/merror"
+require "mml/v2/mfenced"
+require "mml/v2/mfrac"
+require "mml/v2/mfraction"
+require "mml/v2/mglyph"
+require "mml/v2/mi"
+require "mml/v2/mlabeledtr"
+require "mml/v2/mlongdiv"
+require "mml/v2/mmultiscripts"
+require "mml/v2/mn"
+require "mml/v2/mo"
+require "mml/v2/mover"
+require "mml/v2/mpadded"
+require "mml/v2/mphantom"
+require "mml/v2/mprescripts"
+require "mml/v2/mroot"
+require "mml/v2/mrow"
+require "mml/v2/ms"
+require "mml/v2/mscarries"
+require "mml/v2/mscarry"
+require "mml/v2/msgroup"
+require "mml/v2/msline"
+require "mml/v2/mspace"
+require "mml/v2/msqrt"
+require "mml/v2/msrow"
+require "mml/v2/mstack"
+require "mml/v2/mstyle"
+require "mml/v2/msub"
+require "mml/v2/msubsup"
+require "mml/v2/msup"
+require "mml/v2/mtable"
+require "mml/v2/mtd"
+require "mml/v2/mtext"
+require "mml/v2/mtr"
+require "mml/v2/munder"
+require "mml/v2/munderover"
+require "mml/v2/none"
+require "mml/v2/otherwise"
+require "mml/v2/piece"
+require "mml/v2/piecewise"
+require "mml/v2/relations"
+require "mml/v2/reln"
+require "mml/v2/semantics"
+require "mml/v2/sep"
+require "mml/v2/sets"
+require "mml/v2/statistics"
+require "mml/v2/vector_calculus"
+
+# v2 module (already autoloaded above)
+require "mml/v2"
+
+# v3 shared infrastructure
+require "mml/v3/configuration"
+require "mml/v3/namespace"
+require "mml/v3/common_elements"
+
+# v3 element files
+require "mml/v3/annotation"
+require "mml/v3/annotation_xml"
+require "mml/v3/apply"
+require "mml/v3/arith"
+require "mml/v3/bind"
+require "mml/v3/calculus"
+require "mml/v3/cbytes"
+require "mml/v3/cerror"
+require "mml/v3/ci"
+require "mml/v3/cn"
+require "mml/v3/constants"
+require "mml/v3/constructs"
+require "mml/v3/cs"
+require "mml/v3/csymbol"
+require "mml/v3/deprecated_content"
+require "mml/v3/elementary_functions"
+require "mml/v3/functions"
+require "mml/v3/linear_algebra"
+require "mml/v3/logic"
+require "mml/v3/maction"
+require "mml/v3/maligngroup"
+require "mml/v3/malignmark"
+require "mml/v3/math"
+require "mml/v3/menclose"
+require "mml/v3/merror"
+require "mml/v3/mfenced"
+require "mml/v3/mfrac"
+require "mml/v3/mfraction"
+require "mml/v3/mglyph"
+require "mml/v3/mi"
+require "mml/v3/mlabeledtr"
+require "mml/v3/mlongdiv"
+require "mml/v3/mmultiscripts"
+require "mml/v3/mn"
+require "mml/v3/mo"
+require "mml/v3/mover"
+require "mml/v3/mpadded"
+require "mml/v3/mphantom"
+require "mml/v3/mprescripts"
+require "mml/v3/mroot"
+require "mml/v3/mrow"
+require "mml/v3/ms"
+require "mml/v3/mscarries"
+require "mml/v3/mscarry"
+require "mml/v3/msgroup"
+require "mml/v3/msline"
+require "mml/v3/mspace"
+require "mml/v3/msqrt"
+require "mml/v3/msrow"
+require "mml/v3/mstack"
+require "mml/v3/mstyle"
+require "mml/v3/msub"
+require "mml/v3/msubsup"
+require "mml/v3/msup"
+require "mml/v3/mtable"
+require "mml/v3/mtd"
+require "mml/v3/mtext"
+require "mml/v3/mtr"
+require "mml/v3/munder"
+require "mml/v3/munderover"
+require "mml/v3/none"
+require "mml/v3/relations"
+require "mml/v3/semantics"
+require "mml/v3/sets"
+require "mml/v3/statistics"
+require "mml/v3/vector_calculus"
+require "mml/v3/version"
+
+# v3 module (already autoloaded above)
+require "mml/v3"
+
+# v4 shared infrastructure
+require "mml/v4/configuration"
+require "mml/v4/namespace"
+require "mml/v4/common_elements"
+
+# v4 element files
+require "mml/v4/a"
+require "mml/v4/annotation"
+require "mml/v4/annotation_xml"
+require "mml/v4/apply"
+require "mml/v4/arith"
+require "mml/v4/calculus"
+require "mml/v4/cbytes"
+require "mml/v4/cerror"
+require "mml/v4/ci"
+require "mml/v4/cn"
+require "mml/v4/constants"
+require "mml/v4/constructs"
+require "mml/v4/cs"
+require "mml/v4/csymbol"
+require "mml/v4/deprecated_content"
+require "mml/v4/elementary_functions"
+require "mml/v4/factorof"
+require "mml/v4/functions"
+require "mml/v4/limit"
+require "mml/v4/linear_algebra"
+require "mml/v4/logic"
+require "mml/v4/maction"
+require "mml/v4/maligngroup"
+require "mml/v4/malignmark"
+require "mml/v4/math"
+require "mml/v4/menclose"
+require "mml/v4/merror"
+require "mml/v4/mfenced"
+require "mml/v4/mfrac"
+require "mml/v4/mfraction"
+require "mml/v4/mglyph"
+require "mml/v4/mi"
+require "mml/v4/mlabeledtr"
+require "mml/v4/mlongdiv"
+require "mml/v4/mmultiscripts"
+require "mml/v4/mn"
+require "mml/v4/mo"
+require "mml/v4/mover"
+require "mml/v4/mpadded"
+require "mml/v4/mphantom"
+require "mml/v4/mprescripts"
+require "mml/v4/mroot"
+require "mml/v4/mrow"
+require "mml/v4/ms"
+require "mml/v4/mscarries"
+require "mml/v4/mscarry"
+require "mml/v4/msgroup"
+require "mml/v4/msline"
+require "mml/v4/mspace"
+require "mml/v4/msqrt"
+require "mml/v4/msrow"
+require "mml/v4/mstack"
+require "mml/v4/mstyle"
+require "mml/v4/msub"
+require "mml/v4/msubsup"
+require "mml/v4/msup"
+require "mml/v4/mtable"
+require "mml/v4/mtd"
+require "mml/v4/mtext"
+require "mml/v4/mtr"
+require "mml/v4/munder"
+require "mml/v4/munderover"
+require "mml/v4/none"
+require "mml/v4/relations"
+require "mml/v4/semantics"
+require "mml/v4/sets"
+require "mml/v4/statistics"
+require "mml/v4/tendsto"
+require "mml/v4/vector_calculus"
+require "mml/v4/version"
+
+# v4 module (already autoloaded above)
+require "mml/v4"
+
+# Register every version now that all element files are loaded.
+Mml::V2.register_models!
+Mml::V3.register_models!
+Mml::V4.register_models!