xseed 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6c2e0db62a6b48dacc78418921a44b73c64ef54254add4aabe1740213d325af
+  data.tar.gz: 6bc326ef4f09b18ab10327405f545da0f37c048905e1f82ffb1db3877cfe21de
+SHA512:
+  metadata.gz: c54a36cb15f6fee52de817eb2048867a5825c1e6368c47e8c1ed50b90306ba2f135e89fad28179fb34edca56fce32164a6fd46501230eee82fac5e02ba45254c
+  data.tar.gz: 2741d0adbe469e3dc56620df5ee95a1adf334e5b8fbd0a5f9d2774d603c0d0a5392e561c04288574b2e715230c84611579bf956ae3e9830bd2177a4b0515102e

data/.github/workflows/rake.yml

@@ -0,0 +1,16 @@
+name: rake
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: release
+
+permissions:
+  contents: write
+  packages: write
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: "skip"
+  repository_dispatch:
+    types: [do-release]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -0,0 +1,72 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+.rubocop-https*
+
+# Operating system files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,11 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,432 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-11-20 10:08:13 UTC using RuboCop version 1.81.7.
+# 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: 1
+# Configuration parameters: Severity.
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'xseed.gemspec'
+
+# Offense count: 46
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_element, with_fixed_indentation
+Layout/ArrayAlignment:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 11
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'spec/integration/documentation/content_generation_integration_spec.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'spec/integration/documentation/content_generation_integration_spec.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentOneStep, IndentationWidth.
+# SupportedStyles: case, end
+Layout/CaseIndentation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, DefLikeMacros, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'spec/integration/documentation/content_generation_integration_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: consistent, consistent_relative_to_receiver, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstArgumentIndentation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 26
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 21
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, AllowedPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'spec/integration/documentation/content_generation_integration_spec.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/LineEndStringConcatenationIndentation:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 148
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/MultilineBlockLayout:
+  Exclude:
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: symmetrical, new_line, same_line
+Layout/MultilineMethodCallBraceLayout:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/hierarchy_table_generator.rb'
+    - 'lib/xseed/documentation/utils/strings.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/xseed/cli.rb'
+    - 'lib/xseed/documentation/generators/instance_sample_generator.rb'
+    - 'lib/xseed/documentation/schema_loader.rb'
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: require_no_space, require_space
+Layout/SpaceInLambdaLiteral:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 50
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 11
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 55
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'examples/advanced_usage.rb'
+    - 'examples/simple_generation.rb'
+    - 'lib/xseed/cli.rb'
+    - 'lib/xseed/documentation/generators/hierarchy_table_generator.rb'
+    - 'lib/xseed/documentation/generators/instance_sample_generator.rb'
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'lib/xseed/documentation/presentation/navigation_builder.rb'
+    - 'lib/xseed/documentation/utils/namespaces.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 21
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 428
+
+# Offense count: 3
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 36
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'examples/advanced_usage.rb'
+    - 'lib/xseed/cli.rb'
+    - 'lib/xseed/documentation/generators/hierarchy_table_generator.rb'
+    - 'lib/xseed/documentation/generators/instance_sample_generator.rb'
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'lib/xseed/documentation/presentation/navigation_builder.rb'
+    - 'lib/xseed/documentation/schema_loader.rb'
+    - 'lib/xseed/documentation/utils/helpers.rb'
+    - 'lib/xseed/documentation/utils/namespaces.rb'
+    - 'lib/xseed/documentation/utils/references.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 85
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 97
+
+# Offense count: 27
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'examples/advanced_usage.rb'
+    - 'lib/xseed/cli.rb'
+    - 'lib/xseed/documentation/generators/hierarchy_table_generator.rb'
+    - 'lib/xseed/documentation/generators/instance_sample_generator.rb'
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'lib/xseed/documentation/utils/helpers.rb'
+    - 'lib/xseed/documentation/utils/namespaces.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/xseed/models/element_declaration.rb'
+
+# Offense count: 3
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Performance/RegexpMatch:
+  Exclude:
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'spec/integration/documentation/content_generation_integration_spec.rb'
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CombinableLoops:
+  Exclude:
+    - 'spec/support/parity_helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBranchesCount.
+Style/HashLikeCase:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/MapIntoArray:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMethodComparison, ComparisonsThreshold.
+Style/MultipleComparison:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Methods.
+Style/RedundantArgument:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantRegexpArgument:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/xseed/documentation/generators/instance_sample_generator.rb'
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'old-docs/instance_sample_generator_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
+Style/TernaryParentheses:
+  Exclude:
+    - 'lib/xseed/documentation/generators/properties_table_generator.rb'
+
+# Offense count: 54
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
+Style/TrailingCommaInArguments:
+  Exclude:
+    - 'examples/parser_usage.rb'
+    - 'lib/xseed/documentation/generators/hierarchy_table_generator.rb'
+    - 'lib/xseed/documentation/html_generator.rb'
+    - 'lib/xseed/documentation/schema_loader.rb'
+    - 'lib/xseed/models/element_declaration.rb'
+    - 'lib/xseed/parser/xsd_parser.rb'
+    - 'old-docs/instance_sample_generator_spec.rb'
+    - 'spec/integration/parser/xsd_parser_integration_spec.rb'
+    - 'spec/unit/documentation/generators/hierarchy_table_generator_spec.rb'
+    - 'spec/unit/documentation/generators/properties_table_generator_spec.rb'
+    - 'spec/unit/documentation/schema_loader_spec.rb'
+    - 'spec/unit/documentation/utils/namespaces_spec.rb'
+    - 'spec/unit/documentation/utils/references_spec.rb'
+    - 'spec/unit/models/element_declaration_spec.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
+Style/TrailingCommaInArrayLiteral:
+  Exclude:
+    - 'examples/advanced_usage.rb'
+    - 'examples/html_generation.rb'
+    - 'spec/integration/parser/xsd_parser_integration_spec.rb'
+    - 'spec/unit/documentation/schema_loader_spec.rb'
+
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/xseed/documentation/config.rb'
+    - 'lib/xseed/documentation/utils/helpers.rb'
+    - 'lib/xseed/documentation/utils/references.rb'
+    - 'spec/unit/documentation/utils/namespaces_spec.rb'
+    - 'spec/unit/documentation/utils/references_spec.rb'