mml 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1d691b0a249ad8e7c35c7eb2daeaa315202df3bd5ce479cca4ff73ef8bd98e
-  data.tar.gz: 1c200909f2749d9b62136a3d23e9a5462454e46e3591587a463114abd7d201f8
+  metadata.gz: cb306bb25f97a7fb6562b604f7f31a7301a06133efbac3011e7de508556f37a3
+  data.tar.gz: 2a928b1ffaa1d6273bd6a47825e9d7c395d395a38eb06588f906901d4cb50dbe
 SHA512:
-  metadata.gz: 6328fec56b6a4bb170ba7085a0a27ae8264d16922119c63e255c72059d442f80ba80bae26179bf8f098ef53a47d25dfd69cacff8056f64f68de95f7219fcfa3f
-  data.tar.gz: c9c9ac8e92274886ea12c9c09d32e899583cbe1b99d753f890465e1ec06822b7b80ad34dd168b246fd0494bdeba588bb8bf8144bdb9ae18ec6c6f6450911a19b
+  metadata.gz: b7a14d5f681eaafffc8c9863b048c6cb4583385aac027d5612ea21c019de8da79690f888a268f622b244fdfb8324a5bd6ce085783759b28569a5f76f2dac8f32
+  data.tar.gz: 187c9be72bc5cd64788ae64d9208fcb035c772ba1072e7894a8bea4ae16398be5f1446ef6080ae0a269723336dbb4b157760c1bd3e7f346bceb0d334379e3a04

data/.gitmodules

@@ -0,0 +1,9 @@
+[submodule "spec/fixtures/mml2-testsuite"]
+	path = spec/fixtures/mml2-testsuite
+	url = https://github.com/plurimath/mml2-testsuite.git
+[submodule "spec/fixtures/mml3-testsuite"]
+	path = spec/fixtures/mml3-testsuite
+	url = https://github.com/plurimath/mml3-testsuite.git
+[submodule "spec/fixtures/mmlcore-testsuite"]
+	path = spec/fixtures/mmlcore-testsuite
+	url = https://github.com/plurimath/mmlcore-testsuite.git

data/.rubocop.yml

@@ -12,3 +12,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'vendor/**/*'
+    - 'spec/fixtures/mml2-testsuite/**/*'
+    - 'spec/fixtures/mml3-testsuite/**/*'
+    - 'spec/fixtures/mmlcore-testsuite/**/*'
+    - 'spec/tasks/**/*'

data/.rubocop_todo.yml

@@ -1,49 +1,53 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-05 08:05:31 UTC using RuboCop version 1.86.0.
+# on 2026-04-10 10:04:19 UTC using RuboCop version 1.86.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 114
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Lint/UselessAssignment:
   Exclude:
-    - 'mml.gemspec'
-    - 'spec/mml_spec.rb'
-    - 'spec/spec_helper.rb'
+    - 'lib/mml/context_configuration.rb'
 
-# Offense count: 18
+# Offense count: 23
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
 
-# Offense count: 5
+# Offense count: 11
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 172
+  Max: 167
 
-# Offense count: 43
+# Offense count: 55
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 175
-
-# Offense count: 2
-# Configuration parameters: Prefixes, AllowedPatterns.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/mml4_spec.rb'
-    - 'spec/mml_spec.rb'
+  Max: 170
 
 # Offense count: 1
-RSpec/MultipleDescribes:
+Naming/ConstantName:
   Exclude:
-    - 'spec/mml_spec.rb'
+    - 'lib/mml/v2/namespace.rb'
+
+# Offense count: 35
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 11
+
+# Offense count: 18
+RSpec/MultipleExpectations:
+  Max: 3
 
 # Offense count: 1
 # Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
@@ -51,4 +55,9 @@ RSpec/MultipleDescribes:
 RSpec/SpecFilePathFormat:
   Exclude:
     - '**/spec/routing/**/*'
-    - 'spec/mml4_spec.rb'
+    - 'spec/mml/v3/mnone_spec.rb'
+
+# Offense count: 1
+RSpec/UnspecifiedException:
+  Exclude:
+    - 'spec/mml/v3_spec.rb'

data/Gemfile

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 source "https://rubygems.org"
-
 gemspec
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem "canon"
 gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"

data/README.adoc

@@ -53,69 +53,68 @@ Mml::V4.parse(input)
 
 == MathML version architecture
 
-Mml maintains two parallel class hierarchies under `Mml::V3` and `Mml::V4`.
-Both versions share the same namespace URI (`http://www.w3.org/1998/Math/MathML`)
-for backward compatibility.
+Mml maintains three parallel class hierarchies under `Mml::V2`, `Mml::V3`, and `Mml::V4`.
+All versions share the same namespace URI (`http://www.w3.org/1998/Math/MathML`).
 
 [source]
 ----
-                   ┌───────────────────────────────────────────┐
-                   │                   Mml                     │
-                   │  parse() delegates to V3 or V4            │
-                   └────────────────────┬──────────────────────┘
-                                        │
-                    ┌───────────────────┴────────────────────┐
-                    │                                        │
-               ┌────┴────┐                              ┌────┴────┐
-               │ Mml::V3 │                              │ Mml::V4 │
-               └────┬────┘                              └────┬────┘
-                    │                                        │
-    ┌───────────────┼─────────────────────┐  ┌───────────────┼───────────────┐
-    │  ┌────────────┴───────────────┐     │  │  ┌────────────┴────────────┐  │
-    │  │ Element classes            │     │  │  │ Element classes         │  │
-    │  │ (Mi, Mn, Mo, Mrow, ...)    │     │  │  │ (Mi, Mn, Mo, Mrow, ...) │  │
-    │  │                            │     │  │  │ + intent, arg,          │  │
-    │  │ Inherits from              │     │  │  │   displaystyle,         │  │
-    │  │ Lutaml::Model::Serializable│     │  │  │   scriptlevel           │  │
-    │  └────────────┬───────────────┘     │  │  │  + <a> element          │  │
-    │               │                     │  │  └────────────┬────────────┘  │
-    │  ┌────────────┴────────────┐        │  │  ┌────────────┴────────────┐  │
-    │  │ CommonElements        │        │  │  │ CommonElements        │  │
-    │  │ (child element mixin)   │        │  │  │ (v4 version)            │  │
-    │  └─────────────────────────┘        │  |  └─────────────────────────┘  |
-    └─────────────────────────────────────┘  └───────────────────────────────┘
-                                           │
-                        ┌──────────────────┴──────────────────────┐
-                        │         Lutaml::Model::Serializable     │
-                        │         (XML mapping framework)         │
-                        └─────────────────────────────────────────┘
-----
+                ┌───────────────────────────────────────────┐
+                │                    Mml                    │
+                │   parse() delegates to V2 / V3 / V4       │
+                └────────────────────┬──────────────────────┘
+                                     │
+           ┌─────────────────────────┼─────────────────────────┐
+           │                         │                         │
+      ┌────┴────┐               ┌────┴────┐               ┌────┴────┐
+      │ Mml::V2 │               │ Mml::V3 │               │ Mml::V4 │
+      └────┬────┘               └────┬────┘               └────┬────┘
+           │                         │                         │
+┌──────────┴──────────┐   ┌──────────┴──────────┐   ┌──────────┴──────────┐
+│   V2-only classes   │   │     Shared          │   │   V4-only classes   │
+│ (declare, reln, …)  │   │   Base::modules     │   │ + intent, arg,      │
+└─────────────────────┘   └─────────────────────┘   │   displaystyle,     │
+                                                    │   scriptlevel,      │
+                                                    │   + <a> element     │
+                                                    └─────────────────────┘
+
+                    ┌───────────────────────────────┐
+                    │          lib/mml/base/        │
+                    │     (shared attributes)       │
+                    └───────────────────────────────┘
+----
+
+**V2** (`lib/mml/v2/`): Standalone class hierarchy with full Content MathML support.
+Includes deprecated elements like `declare` and `reln` not present in V3/V4.
+
+**V3** (`lib/mml/v3/`): Uses shared `lib/mml/base/` modules for presentation elements.
+Adds `overflow` attribute and V3-specific features.
+
+**V4** (`lib/mml/v4/`): Uses shared `lib/mml/base/` modules with V4-only attributes
+(`intent`, `arg`, `displaystyle`, `scriptlevel`) and the `<a>` hyperlink element.
 
 === Version selection
 
 [source,ruby]
 ----
 Mml.parse(input)              # Default: MathML 3 (Mml::V3)
+Mml.parse(input, version: 2)  # Explicit MathML 2
 Mml.parse(input, version: 3)  # Explicit MathML 3
-Mml.parse(input, version: 4)  # MathML 4 with intent/arg attributes
+Mml.parse(input, version: 4)  # Explicit MathML 4
+Mml::V2.parse(input)          # Direct v2 parsing
 Mml::V3.parse(input)          # Direct v3 parsing
 Mml::V4.parse(input)          # Direct v4 parsing
 ----
 
-=== Key differences between MathML 3 and MathML 4
+=== Key differences between MathML 2, 3 and 4
 
-[cols="1,2",options="header"]
+[cols="1,2,2",options="header"]
 |===
-|Feature |MathML 4 additions
-|Universal attributes |`intent`, `arg`, `displaystyle`, `scriptlevel` available on all presentation elements
-|New element |`<a>` hyperlink element with `href`, `hreflang`
-|Deprecated in MathML 4 (still recognized for backward compatibility) a|
-* `fontfamily`, `fontweight`, `fontstyle`, `fontsize`, `color`, `background` on token elements, `mstyle`, `mglyph`, `mspace`
-* `mode`, `macros` on `math`
-* `index` on `mglyph`
-
-See https://github.com/w3c/mathml/issues/5[w3c/mathml#5] and
-https://github.com/w3c/mathml/issues/303[w3c/mathml#303] for details.
+|Feature |MathML 3 additions |MathML 4 additions
+|V3-only attributes |`overflow`, `linebreakmultchar` |-
+|V4-universal attributes |- |`intent`, `arg`, `displaystyle`, `scriptlevel`
+|V4 hyperlink element |- |`<a>` with `href`, `hreflang`
+|V2 deprecated elements |`declare`, `reln`, `fn` |`declare`, `reln`, `fn`
+|Deprecated font attrs |`fontfamily`, `fontweight`, etc. |removed from strict V4
 |===
 
 === Migration from previous versions
@@ -332,6 +331,31 @@ Mml::V4::A.new(
 # => <a href="https://example.com" hreflang="en"><mi>click</mi></a>
 ----
 
+== MathML V2 Support
+
+V2 is a standalone implementation with its own class hierarchy in `lib/mml/v2/`.
+It includes full Content MathML support with elements not present in V3/V4:
+
+[source,ruby]
+----
+# Parse MathML 2
+Mml::V2.parse('<math xmlns="http://www.w3.org/1998/Math/MathML"><mi>x</mi></math>')
+
+# Content elements available in V2 (deprecated in V3/V4)
+Mml::V2::Declare.new(...)
+Mml::V2::Reln.new(...)
+Mml::V2::Fn.new(...)
+----
+
+V2 uses `Mml::V2::Configuration` for context management:
+
+[source,ruby]
+----
+Mml::V2::Configuration.context_id  # => :mml_v2
+Mml::V2::Configuration.context
+Mml::V2::Configuration.populate_context!
+----
+
 == MathML V4 Compliance
 
 This implementation has been audited against the
@@ -491,6 +515,111 @@ and is normalized to a context id internally.
 If you reset global contexts and need the built-in MML contexts restored
 explicitly, call `populate_context!` for the version(s) you want to restore.
 
+== Unsupported Features
+
+The following MathML test suite files are intentionally skipped (not failures) because
+they use features that are not part of the MathML namespace:
+
+[cols="1,3,1",options="header"]
+|===
+|Feature |Reason |Approx. Tests Skipped
+|HTML attributes (`style`, `class`, `id`, `dir`, `mode`, `tabindex`, `data-*`, event handlers) |These are HTML/XML attributes, not MathML attributes |Varies by test suite
+|HTML `<span>` elements |HTML elements are not part of MathML namespace |Varies by test suite
+|XML comments |XML comments inside MathML elements are not supported |Varies by test suite
+|Foreign content in `annotation-xml` |SVG, XHTML content inside annotation-xml is not supported |Varies by test suite
+|Entity references |Named entity references other than standard XML entities |Varies by test suite
+|===
+
+These tests are filtered out via `UNSUPPORTED_PATTERNS` in the test configuration
+and do not represent bugs. They are marked as "pending" in test output because
+RSpec's `skip` directive still records them as pending tests.
+
+== Version-Specific Attributes
+
+Some MathML attributes are version-specific and only available on the appropriate version:
+
+[cols="1,1,2",options="header"]
+|===
+|Attribute |Element |Notes
+|`overflow` |`math` |MathML 3 only (line overflow behavior)
+|`linebreakmultchar` |`math` |MathML 3 only (line break character)
+|`scriptsizemultiplier` |`mscarries` |Float type for fractional scaling
+|===
+
+== Content Elements
+
+The following Content MathML elements are supported for cross-content markup:
+
+* `cn` - numeric content
+* `ci` - identifier content
+* `csymbol` - symbolic content (with presentation element support: `msub`, `msup`, `mrow`, etc.)
+* `cs` - string content
+* `cbytes` - bytes content with encoding attribute
+* `apply`, `bind`, `bvar` - function application and binding
+* `semantics`, `annotation`, `annotation-xml` - semantic annotations
+
+== Test Suite and Fixtures
+
+The gem uses multiple MathML test suites to validate parsing and serialization:
+
+[cols="1,1,3",options="header"]
+|===
+|Test Suite |Version |Description
+|`spec/fixtures/mml2-testsuite/` |V2 |W3C MathML 2 test suite with Content and Presentation elements
+|`spec/fixtures/mml3-testsuite/` |V3 |W3C MathML 3 test suite
+|`spec/fixtures/mmlcore-testsuite/` |V4 |WPT MathML Core tests (modern browser implementation)
+|`spec/fixtures/v2/`, `spec/fixtures/v4/` |V2/V4 |Hand-crafted fixtures for version-specific features
+|===
+
+=== Running Tests
+
+[source,bash]
+----
+bundle exec rake        # Run all specs + rubocop
+bundle exec rspec       # Run all tests
+bundle exec rspec spec/mml/v3_spec.rb  # Run specific test file
+bundle exec rspec --only-failures       # Run only previously failing tests
+----
+
+=== Test Fixture Processing
+
+Some test suites require preprocessing to extract clean MathML from HTML wrappers:
+
+[source,bash]
+----
+# Preprocess test fixtures (strips HTML wrappers, extracts MathML)
+rake spec:preprocess_fixtures
+
+# Validate preprocessed fixtures against XSD schemas
+rake spec:validate_cleaned_fixtures
+
+# Both in sequence
+rake spec:prepare
+----
+
+The preprocessed fixtures are stored in `tmp/cleaned_fixtures/` and are excluded from git.
+
+=== Unsupported Test Patterns
+
+Tests are filtered via `UNSUPPORTED_PATTERNS` when they contain:
+
+* HTML elements/attributes (`<span>`, `style=`, `class=`, etc.)
+* XML comments inside elements
+* Foreign content (SVG in `annotation-xml`)
+* Entity references not handled by the parser
+* Content elements not supported in presentation context (V3/V4)
+
+These are marked as pending, not failures, because they represent features outside the MathML namespace.
+
+=== Known Pending Issues
+
+[cols="1,3",options="header"]
+|===
+|Issue |Affected Tests
+|lutaml-model Unicode NCR comparison |V2 tests with `&#x02009;` spacing characters
+|Parser schema validation |V3 ErrorHandling tests (parser accepts invalid MathML)
+|===
+
 == Development
 
 [source,bash]

data/Rakefile

@@ -6,7 +6,22 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
-
 RuboCop::RakeTask.new
 
+# Spec preparation tasks
+namespace :spec do
+  desc "Preprocess MathML fixture files to clean them"
+  task :preprocess_fixtures do
+    load "spec/tasks/preprocess_fixtures.rb"
+  end
+
+  desc "Validate cleaned fixtures against XSD schemas"
+  task :validate_cleaned_fixtures do
+    load "spec/tasks/validate_cleaned_fixtures.rb"
+  end
+
+  desc "Prepare spec fixtures (preprocess + validate)"
+  task prepare: %i[preprocess_fixtures validate_cleaned_fixtures]
+end
+
 task default: %i[spec rubocop]

data/lib/mml/base/content/annotation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mml
+  module Base
+    module Content
+      # annotation is a non-XML annotation for semantic markup.
+      # Used within semantics element.
+      module Annotation
+        def self.included(klass)
+          klass.class_eval do
+            attribute :definition_url, :string
+            attribute :encoding_value, :string
+            attribute :href, :string
+            attribute :value, :string
+
+            xml do
+              namespace Mml::Namespace
+              element "annotation"
+
+              map_content to: :value
+              map_attribute "href", to: :href
+              map_attribute "definitionURL", to: :definition_url
+              map_attribute "encoding", to: :encoding_value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mml/base/content/annotation_xml.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mml
+  module Base
+    module Content
+      # annotation-xml is an XML-encoded annotation for semantic markup.
+      # Used within semantics element to embed presentation or other markup.
+      module AnnotationXml
+        def self.included(klass)
+          klass.class_eval do
+            attribute :definitionURL, :string
+            attribute :annotation_xml_encoding, :string
+            attribute :cd, :string
+            attribute :name, :string
+
+            xml do
+              namespace Mml::Namespace
+              element "annotation-xml"
+              mixed_content
+
+              map_attribute "definitionURL", to: :definitionURL
+              map_attribute "encoding", to: :annotation_xml_encoding
+              map_attribute "cd", to: :cd
+              map_attribute "name", to: :name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mml/base/content/apply.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Mml
+  module Base
+    module Content
+      # The apply element applies a function to its arguments.
+      # First child is the operator, remaining children are operands.
+      module Apply
+        def self.included(klass)
+          klass.class_eval do
+            attribute :definition_url, :string
+            attribute :encoding_value, :string
+
+            xml do
+              namespace Mml::Namespace
+              element "apply"
+              mixed_content
+
+              map_attribute "definitionURL", to: :definition_url
+              map_attribute "encoding", to: :encoding_value
+            end
+          end
+        end
+      end
+    end
+  end
+end