lutaml-jsonschema 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 229f1667cd05ad90ee3f424ebc68ae1720ec3219eeec3584a1f65d76f09cf90c
-  data.tar.gz: 224e628bec6fe5d06986a0dbdee00cb5946b8d39b00e1baa4c3777503db4fbb2
+  metadata.gz: b7c72a0b9f42bf072c40e4f52b986ba536f59ed1eaa96650bd6df86d469a16e1
+  data.tar.gz: 818f5e758c204d40d20f371ccb3cc6e772ab2c9e7b54e59c5f02de9b0050b9db
 SHA512:
-  metadata.gz: 2602ab20233317d4d1ae319739dbc98b86a92598d5decb13a6f5e4e5c3bd0398b69c53698d16c35426599ccd029b565c7a3ceda8546b837d6030d471bcae2c13
-  data.tar.gz: f647240a0ce3da5e729da26cbe79e71e02ae3a17bd16b58c71e80bff88711cb8e34d81787caad00522c6494c2ca90c0c0b59966c252f6d96e56e550be6cf355b
+  metadata.gz: 85878a652c2ffee03bed715b5ee1eb83c0b54b8d16e04ef5dee20977ebed04f7b239a8f2a0c43a2c49e25b14a96a55dc620e9c8033b5f4d20afd3fc0108fef56
+  data.tar.gz: 4ab26811feb7b7be7ff0ebe407582ba1adf2c6a2109c84d4a411e16e544cec7186ad276043425f027178fd2782fbb5aea54c6c921a90c069341d722c38d2f850

data/.rubocop_todo.yml

@@ -187,7 +187,7 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 54
+  Max: 57
 
 # Offense count: 12
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.

data/CLAUDE.md

@@ -16,14 +16,14 @@ bundle exec rspec                          # full suite
 bundle exec rspec spec/lutaml/cli_spec.rb  # one file
 bundle exec rspec spec/lutaml/cli_spec.rb:76  # one example
 bundle exec rubocop                        # lint (-a to autofix; .rubocop_todo.yml holds baselined offenses)
-bundle exec rake                           # spec + rubocop (what CI runs)
+bundle exec rake                           # spec + rubocop + perf gate + axe AA audit (what CI runs)
 
 bundle exec rake frontend:build            # npm install + vite build → frontend/dist
 cd frontend && npm test                    # vitest (frontend unit tests)
 
 bundle exec exe/lutaml-jsonschema spa SCHEMA_FILES... [--diff BASELINE...]
 bundle exec exe/lutaml-jsonschema combine|validate SCHEMA_FILES...
-bundle exec exe/lutaml-jsonschema export SCHEMA_FILES... -f cddl|openapi|xsd|adoc
+bundle exec exe/lutaml-jsonschema export SCHEMA_FILES... -f cddl|openapi|xsd|adoc|lml
 bundle exec exe/lutaml-jsonschema diff OLD NEW [--format json]
 ```
 
@@ -34,13 +34,14 @@ bundle exec exe/lutaml-jsonschema diff OLD NEW [--format json]
 Data flow: schema files → `SchemaSet.load_from_files` → `Spa::SpaBuilder` → `Spa::SpaDocument` → `to_json` → `Spa::VueInlinedStrategy` (embeds `window.SCHEMA_DATA` + inlined JS/CSS into `index.html`).
 
 - **`Base`** — everything inherits from `Lutaml::Model::Serializable`. `Base` also forward-declares `Schema` to break the circular `Schema ↔ PropertyEntry ↔ Link` references.
-- **`Schema`** — the central model of a JSON Schema document. Every `$`-prefixed keyword is a `dollar_`-prefixed attribute (`$schema` → `dollar_schema`) via json mappings. `Schema.from_json` / `to_json` are lutaml-model serialization.
+- **`Schema`** — the central model of a JSON Schema document. Every `$`-prefixed keyword is a `dollar_`-prefixed attribute (`$schema` → `dollar_schema`) via json mappings. `Schema.from_json` / `to_json` are lutaml-model serialization. The model is **lossless**: `map_unmapped to: :extensions` collects every unmodeled keyword (vendor `x-*`, dialect additions) verbatim and re-emits it — new keywords land as attributes, not in a hand-rolled serializer.
 - **`SchemaSet`** — in-memory named collection of schemas plus `$ref` resolution (local `#/...` pointers and relative `./file.json` refs through `ReferenceResolver`) and validation.
 - **`SchemaStore`** — `SchemaSet` subclass that adds on-disk persistence through **lutaml-store** (`PackageStore`, package shape from `LjrPackageDefinition`).
 - **`Combiner`** — compatibility facade; bundling lives in `SchemaSet#bundle` (hoists definitions, adds a top-level `$ref` property per source schema, rewrites `#/definitions/` → `#/$defs/`).
 - **`Spa::*`** — `SpaBuilder` flattens a `SchemaSet` into a `SpaDocument` (metadata, `SpaSchema` list, flat `search_index` for FlexSearch). `Spa::Generator` renders through an `OutputStrategy`; `VueInlinedStrategy` is the only implementation.
 - **`Configuration`** — YAML config for the SPA (title, theme, appearance…), loaded by `Cli#spa -c`.
-- **`Cli`** — Thor commands: `spa` (generate docs; `--diff` embeds a classified change set), `combine` (merge schemas), `export` (cddl/openapi/xsd/adoc), `diff` (exits 1 on breaking changes), `validate` (meta-schema checks), `version`.
+- **`Cli`** — Thor commands: `spa` (generate docs; `--diff` embeds a classified change set), `combine` (merge schemas), `export` (cddl/openapi/xsd/adoc/lml; adoc `--embeddable` drops the level-0 title and namespaces anchors for Metanorma `include::`), `diff` (exits 1 on breaking changes), `validate` (offline meta-schema checks against fully vendored meta-schemas, JSON Pointer error paths), `version`.
+- **`Exports::*`** — one renderer per target language (CDDL, OpenAPI 3.1, XSD, AsciiDoc, LML); all read the same `SchemaSet`, and each documents its approximations on the class. LML output parses back through `lutaml-lml`; CDDL through the RFC 8610 reference parser.
 - **`TupleItem`** — schema-or-boolean wrapper used by `items`/`prefixItems` arrays and composition collections; models that accept `true`/`false` store booleans in companion `*_boolean` attributes and expose `*_value` helpers.
 
 ## JSON engine: yeptris
@@ -51,9 +52,16 @@ Two distinct paths, both engine-backed:
 - **Model serialization** (`Schema.from_json`/`to_json`, `Configuration.from_yaml`, lutaml-store I/O) goes through lutaml-model, whose `AdapterResolver` auto-detects yeptris from the bundle and routes both `:json` and `:yaml` to its `YeptrisAdapter`. That adapter re-raises parse failures as `JSON::ParserError`, so error handling must cover **both** exception types — see the rescue in `Cli#validate`.
 - Raw-parse speed depends on the resolved yeptris build shipping a **native materializer for the running Ruby version**; without one it falls back to a pure-Ruby tape engine that is several times slower than `JSON.parse` on large documents (yeptris-ruby#278). Check with `defined?(Yeptris::Native)` (0.6.28.x shipped only Ruby 3.3; 3.4-native starts at 0.6.29.1).
 - The GC-pressure SIGSEGV in the native JSON materializer (yeptris-ruby#279) is fixed in the yeptris **0.6.34 line** (staged pairs made GC-visible); the gemspec floors at `~> 0.6.34`, excluding the crashy 0.6.29.x–0.6.33.x native builds. Env-gated canary: yeptris-ruby#280.
+- The 0.6.34 C **strict-dup pre-scan** was broken (one shared key table, no growth — false duplicates on ordinary schemas, hang on the 17th distinct key); fixed in yeptris v0.6.35 (per-container frame stacks). Lanes without a native materializer (all Windows) ride that marshal route, so engine bugs surface there first.
+
+## Frontend: i18n, RTL, a11y
+
+- All UI strings come from the typed catalog `frontend/src/i18n/messages.ts` (`en` + `ar`); `t()`/`tf()` read a Vue ref, so the header switch re-renders live. A missing key in a locale is a type error — add both languages.
+- The locale mirrors `lang`/`dir` onto `<html>`; layout uses CSS logical properties (`*-inline-*`), so RTL needs no second stylesheet. `?locale=ar` boots straight into a locale.
+- `script/axe_audit` (in the default `rake` gate) scans the generated site with the vendored axe-core; browser-less lanes skip cleanly. The browser specs (boot, PDF, RTL render) run wherever Chrome exists.
 
 ## Repo notes
 
-- `README.md` is unreplaced gem-template boilerplate — don't treat it as documentation.
 - `TODO.redoc/`, `TODO.refactor/`, `TODO.store/` are untracked, numbered working notes (known gaps and planned refactors), not code. `TODO.sota/` holds the SOTA program (purpose, per-area tasks with done-when criteria, and the goal prompt).
 - CI is metanorma/ci's `generic-rake` workflow; releases run through `.github/workflows/release.yml`.
+- Ruby 4.0 binds brace-less hash literals as keyword arguments — always brace hashes passed to positional-only methods (specs included).

data/README.md

@@ -1,39 +1,103 @@
 # Lutaml::Jsonschema
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lutaml/jsonschema`. To experiment with that code, run `bin/console` for an interactive prompt.
+**JSON Schema, fully legible** — a lossless typed model for machines and
+Redoc-class, sovereign single-file documentation for humans, inside the
+LutaML/metanorma standards ecosystem.
+
+Parses JSON Schema documents (draft-04 through 2020-12, plus the
+interagent-era hyper-schema corpus) into lutaml-model objects, resolves and
+bundles `$ref` graphs (local pointers, cross-file, and opt-in remote HTTP(S)
+with an offline SHA-256 cache), validates against fully vendored
+meta-schemas, diffs schema versions with breaking-change classification, and
+generates a self-contained documentation SPA — no runtime fetches, no
+network, one `index.html`.
+
+**The model is lossless**: every keyword the Ruby model does not name —
+vendor `x-*` extensions, dialect additions, hyper-schema keywords — is
+collected verbatim and re-emitted on serialization (`map_unmapped`).
 
 ## 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.
+```bash
+gem install lutaml-jsonschema
+```
 
-Install the gem and add to the application's Gemfile by executing:
+or add to your Gemfile:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add lutaml-jsonschema
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## CLI
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+# generate the single-file documentation SPA
+lutaml-jsonschema spa SCHEMA_FILES... [--diff BASELINE...] [-c CONFIG.yml]
+
+# merge schema documents into one bundle
+lutaml-jsonschema combine SCHEMA_FILES...
+
+# export to other data-definition languages
+lutaml-jsonschema export SCHEMA_FILES... -f cddl|openapi|xsd|adoc|lml
+
+# semantic diff; exits non-zero when a breaking change is found
+lutaml-jsonschema diff OLD_SCHEMA NEW_SCHEMA [--format json]
+
+# validate against the dialect's meta-schema (offline; --format json)
+lutaml-jsonschema validate SCHEMA_FILE
 ```
 
-## Usage
+The SPA supports light/dark themes, FlexSearch search, per-property and
+per-definition detail views, composition tabs, a JSON builder, a change view
+(`--diff`), RTL locales (`?locale=ar`), and prints to PDF.
 
-TODO: Write usage instructions here
+## Library
 
-## Development
+```ruby
+require "lutaml/jsonschema"
 
-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.
+schema = Lutaml::Jsonschema::Schema.from_json(json_string)
+schema.extensions          # => unknown keywords, preserved verbatim
+schema.to_json             # lossless re-emission
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+set = Lutaml::Jsonschema::SchemaSet.load_from_files(*paths)
+set.bundle                 # hoist definitions, rewrite refs
+set.dereference("demo")    # resolve the $ref graph
 
-## Contributing
+Lutaml::Jsonschema::Exports::Cddl.new(set).render    # RFC 8610
+Lutaml::Jsonschema::Exports::Openapi.new(set).render # OAS 3.1 components
+Lutaml::Jsonschema::Exports::Xsd.new(set).render     # W3C XML Schema
+Lutaml::Jsonschema::Exports::Adoc.new(set).render    # AsciiDoc reference
+Lutaml::Jsonschema::Exports::Lml.new(set).render     # LutaML UML models
+
+Lutaml::Jsonschema::Diff.between(old_schema, new_schema) # classified changes
+```
+
+`SchemaStore` (a `SchemaSet` subclass) adds on-disk persistence through
+[lutaml-store](https://github.com/lutaml/lutaml-store).
+
+## JSON engine
+
+Parsing rides [yeptris](https://github.com/leptris/yeptris-ruby), the org's
+native YAML/JSON engine (FFI over libyeptris, strict RFC 8259 semantics with
+`JSON.parse` parity), auto-detected by lutaml-model for both JSON and YAML.
+JSON generation stays on the stdlib `json` gem.
+
+## Development
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lutaml-jsonschema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lutaml-jsonschema/blob/main/CODE_OF_CONDUCT.md).
+```bash
+bundle exec rake            # specs + rubocop + perf gate + axe AA audit
+bundle exec rspec           # full suite
+cd frontend && npm test     # SPA unit tests
+bundle exec rake frontend:build   # build frontend/dist (needed for spa)
+```
 
-## Code of Conduct
+CI runs the full matrix (3 Ruby lines × ubuntu/macos/windows) on every push,
+including the browser gates (headless-Chrome boot, PDF, RTL render) and the
+WCAG AA audit. `spec/fixtures/` carries the real-world corpora (heroku,
+interagent) the specs round-trip.
+
+## Contributing
 
-Everyone interacting in the Lutaml::Jsonschema project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-jsonschema/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/lutaml/lutaml-jsonschema.

data/Rakefile

@@ -9,7 +9,7 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop perf]
+task default: %i[spec rubocop perf frontend:audit]
 
 namespace :perf do
   desc "Pipeline performance harness with regression caps (TODO.sota/08)"