lutaml-xsd 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9494ca53202f830264c7ab5add8f9f14f7034f74fb26bcb6fcc2cc7e5ad3e03e
-  data.tar.gz: 583dc806f1576cc5c6ed659a319dd2a615f115eb9f3f9d5188fbe8cf2dae236a
+  metadata.gz: e6278aec90450f0666ccb21d61f3afa2f7f77be209dac10da32c991841a31a7d
+  data.tar.gz: 5dc436d5d5e8323fec4bd2fe2928f0890de032e626d0f4bde19baf5570acaccb
 SHA512:
-  metadata.gz: db868e168314d197b0144e4a63bdd3544e47763297cbe8518910790305d3f498c0b4345638eeb2e0a0678175c374f9310749b642bc7d56fc039792093e416cc1
-  data.tar.gz: 5a4c8242b2662ddd1848559a363452db3c36a198b798ed2348ea1fdfa753211549144724744da4d7a320b07c142512540a2b0232f8e6b8bf55b7f981f48b157a
+  metadata.gz: 5491e6d47a6d39bbb0ff66ab75334aaafebfbc171de6117bfd9b5fae07badea0d53239941c1539d3d67c6e49dfda736e6420b489036a56529affca0f89431e17
+  data.tar.gz: 2e020487a42d0c3eaf86ad45040719632178147891edf4b35caa6d7d9d1fad310ed9682f4a5c70627429078d2db472997aa691e7da7f19e1d355b816afea0444

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-22 11:16:09 UTC using RuboCop version 1.86.1.
+# on 2026-04-25 09:44:01 UTC using RuboCop version 1.86.1.
 # 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
@@ -11,6 +11,29 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'lutaml-xsd.gemspec'
 
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_element, with_fixed_indentation
+Layout/ArrayAlignment:
+  Exclude:
+    - 'lib/lutaml/xsd/spa/schema_serializer.rb'
+    - 'lib/lutaml/xsd/spa/utils/extract_enumeration.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: IndentationWidth.
+Layout/AssignmentIndentation:
+  Exclude:
+    - 'lib/lutaml/xsd/commands/package_command.rb'
+    - 'lib/lutaml/xsd/spa/schema_serializer.rb'
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+    - 'lib/lutaml/xsd/spa/schema_serializer.rb'
+
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleAlignWith.
@@ -45,7 +68,7 @@ Layout/IndentationWidth:
   Exclude:
     - 'lib/lutaml/xsd/spa/schema_serializer.rb'
 
-# Offense count: 729
+# Offense count: 730
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -60,11 +83,14 @@ Layout/MultilineMethodCallBraceLayout:
   Exclude:
     - 'lib/lutaml/xsd/spa/schema_serializer.rb'
 
-# Offense count: 1
+# Offense count: 11
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowInHeredoc.
 Layout/TrailingWhitespace:
   Exclude:
+    - 'lib/lutaml/xsd/commands/package_command.rb'
+    - 'lib/lutaml/xsd/spa/schema_serializer.rb'
+    - 'lib/lutaml/xsd/spa/utils/extract_enumeration.rb'
     - 'lib/lutaml/xsd/spa/xml_instance_generator.rb'
 
 # Offense count: 11
@@ -222,6 +248,14 @@ Style/IdenticalConditionalBranches:
   Exclude:
     - 'lib/lutaml/xsd/package_tree_formatter.rb'
 
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/lutaml/xsd/commands/package_command.rb'
+    - 'lib/lutaml/xsd/spa/schema_serializer.rb'
+    - 'lib/lutaml/xsd/spa/utils/extract_enumeration.rb'
+
 # Offense count: 1
 Style/OpenStructUse:
   Exclude:

data/README.adoc

@@ -42,7 +42,7 @@ allowing you to shape and structure your data into useful forms.
 
 * <<spa-documentation,SPA documentation generation>> - Modern, responsive,
   interactive HTML documentation with schema navigation and search
-  - Single-file and API modes
+  - Single-file mode
   - Entrypoint prioritization in sidebar
   - Schema detail views with elements/types/attributes tables
   - Hash-based navigation with browser back/forward support
@@ -63,7 +63,7 @@ allowing you to shape and structure your data into useful forms.
   - `pkg` commands for package inspection
   - `xml` commands for XML validation
   - `build` commands for package creation
-  - `doc` commands for documentation generation
+  - `spa` command for documentation generation
 * <<lxr-packages,LXR (LutaML XSD Repository) packages>> for distributable,
   pre-indexed schema collections
 * <<parsing-xsd,XSD file parsing>> with full schema structure support
@@ -127,10 +127,10 @@ Generate single-file documentation:
 [source,bash]
 ----
 # Generate standalone HTML file with semantic URLs
-lutaml-xsd doc spa your_package.lxr --mode single_file --output docs.html
+lutaml-xsd spa your_package.lxr --output docs.html
 
 # Generate with custom title
-lutaml-xsd doc spa schemas.lxr --mode single_file --output docs.html \
+lutaml-xsd spa schemas.lxr --output docs.html \
   --title "My Schema Documentation"
 ----
 
@@ -141,21 +141,6 @@ lutaml-xsd doc spa schemas.lxr --mode single_file --output docs.html \
 * Clickable cross-references throughout
 * xs3p-quality documentation
 
-Generate API-mode documentation with server:
-
-[source,bash]
-----
-# Generate API-based SPA with Sinatra server
-lutaml-xsd doc spa your_package.lxr --mode api --output-dir docs/
-
-# Start the server
-cd docs/
-bundle install
-bundle exec rackup
-
-# Access at http://localhost:9292
-----
-
 === Navigation and Linking
 
 The generated SPA provides comprehensive navigation:
@@ -213,21 +198,7 @@ Perfect for:
 
 [source,bash]
 ----
-lutaml-xsd generate-spa schemas.lxr --mode single_file --output schema-docs.html
-----
-
-==== Multi-file mode
-
-Generates a documentation site with separate resource files. Perfect for:
-
-* Web hosting (better caching)
-* Larger schema sets (faster loading)
-* Professional deployment
-* CDN optimization
-
-[source,bash]
-----
-lutaml-xsd generate-spa schemas.lxr --mode multi_file --output-dir ./docs
+lutaml-xsd spa schemas.lxr --output schema-docs.html
 ----
 
 === Configuration
@@ -244,8 +215,7 @@ The SPA generator is fully configurable via YAML files in `config/spa/`:
 [source,bash]
 ----
 # Generate with custom configuration
-lutaml-xsd generate-spa schemas.lxr \
-  --mode single_file \
+lutaml-xsd spa schemas.lxr \
   --output custom-docs.html \
   --config config/my-custom-spa-config.yml \
   --title "Custom Schema Docs"
@@ -559,7 +529,7 @@ Where `<CATEGORY>` is one of:
 `pkg`:: Package inspection commands (operate on `.lxr` files)
 `xml`:: XML validation commands (operate on `.xml` files)
 `build`:: Package creation commands (operate on `.yml` configs)
-`doc`:: Documentation generation commands (operate on `.lxr` files)
+`spa`:: Documentation generation (operate on `.lxr` files)
 
 This structure ensures:
 
@@ -923,73 +893,19 @@ Each warning shows:
 * Actionable hint for resolution
 ====
 
-=== DOC commands (documentation generation)
+=== SPA command (documentation generation)
 
 Generate documentation from LXR packages.
 
 [source,bash]
 ----
-# Generate SPA documentation (single-file)
-lutaml-xsd doc spa <package.lxr> --mode single_file --output docs.html
-
-# Generate SPA with API mode (multi-file with server)
-lutaml-xsd doc spa <package.lxr> --mode api --output-dir docs/
-
-# Generate markdown documentation
-lutaml-xsd doc markdown <package.lxr> --output-dir docs/
-----
-
-==== API mode documentation
+# Generate single-file documentation
+lutaml-xsd spa <package.lxr> --output docs.html
 
-The API mode generates a complete Sinatra-based server with separate frontend
-and JSON API.
-
-.Generating API-mode SPA
-[example]
-====
-[source,bash]
-----
-# Generate with API mode
-$ lutaml-xsd doc spa pkg/urban_function_repository.lxr \
-    --mode api \
-    --output-dir tmp/api_docs
-
-SPA Documentation Generated Successfully
-════════════════════════════════════════════════════════════════
-
-Output files (6 total):
-  tmp/api_docs/public/index.html
-  tmp/api_docs/data/schemas.json
-  tmp/api_docs/lib/app.rb
-  tmp/api_docs/config.ru
-  tmp/api_docs/Gemfile
-  tmp/api_docs/README.md
-
-✓ Generation complete
-
-# Install dependencies and start server
-$ cd tmp/api_docs
-$ bundle install
-$ bundle exec rackup
-
-# Access at http://localhost:9292
+# Generate with custom title
+lutaml-xsd spa <package.lxr> --output docs.html --title "My Docs"
 ----
 
-The API mode provides:
-
-* **Separate frontend and backend**: HTML/JS frontend fetches data via API
-* **RESTful endpoints**: `/api/schemas`, `/api/schemas/:id`, `/api/health`
-* **CORS enabled**: Can be used by external applications
-* **Production ready**: Sinatra server with proper error handling
-
-API endpoints:
-
-* `GET /` - Serves the frontend HTML
-* `GET /api/schemas` - Returns all schema data as JSON
-* `GET /api/schemas/:id` - Returns specific schema by ID
-* `GET /api/health` - Health check endpoint
-====
-
 === Table formatting
 
 All CLI table output uses the `table-tennis` gem for beautiful, auto-themed

data/docs/CLI.adoc

@@ -487,20 +487,11 @@ lutaml-xsd xml validate instance.xml \
 ====
 [source,bash]
 ----
-# Single file output
-lutaml-xsd doc spa my_composition.yml \
-  --mode single_file \
-  --output docs.html
-
-# Multi-file output
-lutaml-xsd doc spa my_composition.yml \
-  --mode multi_file \
-  --output docs/
-
-# API mode output
-lutaml-xsd doc spa my_composition.yml \
-  --mode api \
-  --output api/
+# Single file output (default)
+lutaml-xsd spa my_composition.yml --output docs.html
+
+# With separate asset files
+lutaml-xsd spa my_composition.yml --output docs.html --mode cdn
 ----
 ====
 

data/docs/FAQ.adoc

@@ -457,7 +457,7 @@ Note: `marshal` format packages may not be compatible across different Ruby majo
 
 Yes! Lutaml::XSD is complementary to other XML tools:
 
-* **Nokogiri**: Use for XML parsing/validation
+* **Moxml**: Unified XML adapter layer
 * **REXML**: Use for lightweight XML processing
 * **Ox**: Use for fast XML parsing
 

data/docs/SPA_CONFIGURATION.adoc

@@ -785,7 +785,7 @@ templates:
 
 [source,bash]
 ----
-lutaml-xsd generate-spa schemas.lxr \
+lutaml-xsd spa schemas.lxr \
   --config my-spa-config.yml \
   --output custom-docs.html
 ----

data/docs/SPA_GUIDE.adoc

@@ -16,9 +16,9 @@ The SPA (Single Page Application) Documentation Generator creates modern, intera
 * **Advanced search** - Real-time fuzzy matching across all schema components
 * **Type filtering** - Filter by element, complex type, simple type, attribute group, group
 * **Zero dependencies** - Self-contained HTML, CSS, and JavaScript
-* **Offline-capable** - Works without internet connection (single-file and multi-file modes)
+* **Offline-capable** - Works without internet connection (inlined mode)
 * **Accessibility** - WCAG 2.1 AA compliant
-* **Three output modes** - Single-file, multi-file, or API-based deployment
+* **Two output modes** - Single-file (inlined) or separate assets (cdn)
 
 === When to use SPA documentation
 
@@ -40,42 +40,25 @@ Use the SPA generator when you need to:
 
 === Quick start
 
-Generate single-file documentation:
-
 [source,bash]
 ----
-# From an LXR package
-lutaml-xsd generate-spa schemas.lxr --mode single_file --output docs.html
+# From an LXR package (generates single self-contained HTML)
+lutaml-xsd spa schemas.lxr --output docs.html
 
 # With custom title
-lutaml-xsd generate-spa schemas.lxr \
-  --mode single_file \
-  --output schema-docs.html \
-  --title "My Schema Documentation"
-----
+lutaml-xsd spa schemas.lxr --output schema-docs.html --title "My Schema Documentation"
 
-Generate multi-file documentation:
-
-[source,bash]
-----
-# Creates a directory with separate files
-lutaml-xsd generate-spa schemas.lxr \
-  --mode multi_file \
-  --output-dir ./docs
-
-# Generate API-based documentation with Sinatra server
-lutaml-xsd generate-spa schemas.lxr \
-  --mode api \
-  --output-dir ./docs-api
+# With separate asset files (requires HTTP server)
+lutaml-xsd spa schemas.lxr --output docs.html --mode cdn
 ----
 
 Open the generated HTML file in your browser to view the documentation.
 
 == Output modes
 
-=== Single-file mode
+=== Inlined mode (default)
 
-Single-file mode generates a standalone HTML file with all assets embedded.
+Inlined mode generates a standalone HTML file with all assets embedded.
 
 ==== Advantages
 
@@ -92,7 +75,7 @@ Single-file mode generates a standalone HTML file with all assets embedded.
 
 ==== When to use
 
-Use single-file mode for:
+Use inlined mode for:
 
 * Email attachments or file sharing
 * Offline documentation needs
@@ -105,8 +88,7 @@ Use single-file mode for:
 [source,bash]
 ----
 # Generate standalone documentation
-lutaml-xsd generate-spa person_schemas.lxr \
-  --mode single_file \
+lutaml-xsd spa person_schemas.lxr \
   --output person-documentation.html \
   --title "Person Schema Documentation"
 ----
@@ -116,154 +98,33 @@ Output:
 person-documentation.html  (125 KB)
 ----
 
-=== Multi-file mode
-
-Multi-file mode generates a documentation site with separate resource files.
+=== CDN mode
 
-==== Advantages
-
-* **Better caching** - Browser caches CSS/JS separately
-* **Faster loading** - Smaller HTML file loads faster
-* **Professional** - Standard web application structure
-* **CDN-friendly** - Can serve static assets from CDN
-
-==== Disadvantages
-
-* **Multiple files** - Must deploy entire directory
-* **Relative paths** - Files must maintain relative structure
-* **More complex** - Requires web server or proper file serving
+Generates an HTML file with separate JavaScript and CSS files alongside it. The HTML loads Vue.js from a CDN. Requires serving via HTTP (not file://).
 
 ==== When to use
 
-Use multi-file mode for:
+Use CDN mode for:
 
-* Web hosting (GitHub Pages, Netlify, etc.)
+* Web hosting with better caching
 * Larger schema sets
-* Professional deployment
-* Sites with regular updates
-* CDN optimization
+* Professional deployment behind a web server
 
 ==== Example
 
 [source,bash]
 ----
-# Generate multi-file documentation site
-lutaml-xsd generate-spa person_schemas.lxr \
-  --mode multi_file \
-  --output-dir ./docs \
-  --title "Person Schema Documentation"
+# Generate documentation with separate assets
+lutaml-xsd spa person_schemas.lxr --output docs.html --mode cdn
 ----
 
 Output:
 ----
 docs/
-├── index.html        (15 KB)
-├── css/
-│   └── styles.css    (25 KB)
-├── js/
-│   └── app.js        (18 KB)
-└── data/
-    └── schemas.json  (12 KB)
-----
-
-=== API mode (Sinatra server)
-
-API mode generates a complete Sinatra-based web application with a true REST API backend.
-
-==== Advantages
-
-* **True API backend** - Separate frontend and backend architecture
-* **Scalable** - Can handle multiple concurrent requests
-* **Development-friendly** - Hot-reload during development
-* **RESTful architecture** - Standard REST API endpoints
-* **CORS enabled** -Works with SPA frontends from different origins
-
-==== Disadvantages
-
-* **Requires Ruby** - Server must run Ruby application
-* **More complex** - Requires server setup and maintenance
-* **Not static** - Cannot deploy to static hosts
-* **Resource intensive** -Requires running Ruby process
-
-==== When to use
-
-Use API mode for:
-
-* Development and testing environments
-* When you need a true API backend
-* Integrating schema documentation into larger applications
-* Building custom frontends that consume schema data
-* Internal tools with API requirements
-
-==== Example
-
-[source,bash]
-----
-# Generate API-based documentation
-lutaml-xsd generate-spa person_schemas.lxr \
-  --mode api \
-  --output-dir ./docs-api \
-  --title "Person Schema API"
-----
-
-Output:
-----
-docs-api/
-├── public/
-│   └── index.html      (15 KB, SPA frontend)
-├── lib/
-│   └── app.rb          (Sinatra server)
-├── data/
-│   └── schemas.json    (12 KB)
-├── config.ru           (Rack configuration)
-├── Gemfile             (Dependencies)
-└── README.md           (Usage instructions)
-----
-
-==== Running the API server
-
-After generation, start the Sinatra server:
-
-[source,bash]
-----
-cd docs-api
-
-# Install dependencies
-bundle install
-
-# Start server (default port 9292)
-bundle exec rackup
-
-# Or specify custom port
-PORT=3000 bundle exec rackup
-----
-
-Then open http://localhost:9292 in your browser.
-
-==== API endpoints
-
-The generated server provides these REST API endpoints:
-
-* `GET /` - Serve frontend HTML
-* `GET /api/schemas` - Get all schemas (JSON)
-* `GET /api/schemas/:id` - Get specific schema by ID
-* `GET /api/health` - Health check endpoint
-
-.Testing API endpoints
-[example]
-====
-[source,bash]
+├── docs.html       (HTML that loads assets externally)
+├── app.iife.js     (Application JavaScript)
+└── style.css       (Stylesheet)
 ----
-# Get all schemas
-curl http://localhost:9292/api/schemas
-
-# Get specific schema
-curl http://localhost:9292/api/schemas/schema-0
-
-# Health check
-curl http://localhost:9292/api/health
-----
-====
 
 == Using the documentation
 
@@ -340,8 +201,7 @@ Specify a custom configuration file:
 
 [source,bash]
 ----
-lutaml-xsd generate-spa schemas.lxr \
-  --mode single_file \
+lutaml-xsd spa schemas.lxr \
   --output docs.html \
   --config my-spa-config.yml
 ----
@@ -438,7 +298,7 @@ Use your theme:
 
 [source,bash]
 ----
-lutaml-xsd generate-spa schemas.lxr \
+lutaml-xsd spa schemas.lxr \
   --config my-theme.yml \
   --output custom-docs.html
 ----
@@ -449,7 +309,7 @@ Set a custom documentation title:
 
 [source,bash]
 ----
-lutaml-xsd generate-spa schemas.lxr \
+lutaml-xsd spa schemas.lxr \
   --title "My Company Schema Reference" \
   --output docs.html
 ----
@@ -476,7 +336,7 @@ features:
 
 === Local file system
 
-For single-file mode, just open the HTML file:
+For inlined mode, just open the HTML file:
 
 [source,bash]
 ----
@@ -492,16 +352,14 @@ start docs.html
 
 === Static web hosting
 
-Deploy multi-file documentation to static hosts:
+Deploy CDN-mode documentation to static hosts:
 
 ==== GitHub Pages
 
 [source,bash]
 ----
 # Generate documentation
-lutaml-xsd generate-spa schemas.lxr \
-  --mode multi_file \
-  --output-dir ./docs
+lutaml-xsd spa schemas.lxr --output docs.html --mode cdn
 
 # Commit and push
 git add docs/
@@ -517,17 +375,15 @@ git push
 [source,bash]
 ----
 # Generate documentation
-lutaml-xsd generate-spa schemas.lxr \
-  --mode multi_file \
-  --output-dir ./public
+lutaml-xsd spa schemas.lxr --output docs.html --mode cdn
 
 # Deploy with Netlify CLI
-netlify deploy --prod --dir=public
+netlify deploy --prod --dir=docs
 ----
 
 ==== Other static hosts
 
-The multi-file output works with any static file host:
+The CDN output works with any static file host:
 
 * **Vercel** - Deploy `docs/` directory
 * **AWS S3** - Upload to bucket, enable static hosting
@@ -552,7 +408,7 @@ See link:SPA_DEPLOYMENT.adoc[Deployment Guide] for detailed instructions.
 ls -l schemas.lxr
 
 # Use absolute path if needed
-lutaml-xsd generate-spa /absolute/path/to/schemas.lxr --output docs.html
+lutaml-xsd spa /absolute/path/to/schemas.lxr --output docs.html
 ----
 
 ==== "Template not found"
@@ -580,9 +436,8 @@ gem update lutaml-xsd
 [source,bash]
 ----
 # Use correct mode values
-lutaml-xsd generate-spa schemas.lxr --mode single_file  # Not "single"
-lutaml-xsd generate-spa schemas.lxr --mode multi_file   # Not "multi"
-lutaml-xsd generate-spa schemas.lxr --mode api          # API mode
+lutaml-xsd spa schemas.lxr --mode inlined  # Default, single self-contained HTML
+lutaml-xsd spa schemas.lxr --mode cdn      # Separate asset files
 ----
 
 ==== Dark mode not working
@@ -631,7 +486,7 @@ If you encounter issues:
 
 === Performance
 
-* **Use multi-file for large schemas** - Better caching and loading
+* **Use CDN mode for large schemas** - Better caching and loading
 * **Enable CDN** - Serve static assets from CDN
 * **Compress assets** - Enable gzip on web server
 * **Lazy loading** - Load schema details on demand
@@ -659,7 +514,7 @@ echo "files:\n  - schema.xsd" > config.yaml
 lutaml-xsd pkg build config.yaml -o schemas.lxr
 
 # Generate documentation
-lutaml-xsd generate-spa schemas.lxr --output docs.html
+lutaml-xsd spa schemas.lxr --output docs.html
 ----
 
 === How do I update the documentation?
@@ -669,7 +524,7 @@ Regenerate it using the same command:
 [source,bash]
 ----
 # Regenerates with latest schema changes
-lutaml-xsd generate-spa updated-schemas.lxr --output docs.html
+lutaml-xsd spa updated-schemas.lxr --output docs.html
 ----
 
 === Can I customize the HTML structure?
@@ -682,11 +537,9 @@ The HTML structure is controlled by Liquid templates. To customize:
 
 === Does it work offline?
 
-Single-file and multi-file modes work offline:
+Inlined mode works offline:
 
-* **Single-file** - Completely self-contained
-* **Multi-file** - All files are local, no external requests
-* **API mode** - Requires running server, no external requests once running
+* **Inlined** - Completely self-contained, no external requests
 
 === What browsers are supported?
 
@@ -706,11 +559,11 @@ The generator handles schemas of any size, but browser performance varies:
 * **Small** (< 50 types) - Excellent performance
 * **Medium** (50-500 types) - Good performance
 * **Large** (500-2000 types) - Acceptable performance
-* **Very large** (> 2000 types) - May be slow, use multi-file mode
+* **Very large** (> 2000 types) - May be slow, use CDN mode
 
 For very large schemas, consider:
 
-* Using multi-file mode
+* Using CDN mode
 * Splitting into multiple packages
 * Enabling lazy loading features