rng 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b70e1b28d17dd9d6a287a404f218151f5a25ab38eba65aba55330d1e5692a08
-  data.tar.gz: d8524a2367eb0c73b64f9040555a2269ad2e6f8121a5ed5d05021c20ad00042b
+  metadata.gz: 6098b94d05fc5d4051353c56c3506280514394551876755c300e3926ba514501
+  data.tar.gz: 588a13fd65f9aae5c317ff64c69a9d567fdbbe586ca4cf94b8c234888c3a0b11
 SHA512:
-  metadata.gz: 06bc5ef5f3d56f356730e71b42ee2080ab449ed1c769446a315a8077a015327bea94635e172ab9dcbd1d2559eacbb21ad519f3c5dc48fc45c5c7c7ee577326e2
-  data.tar.gz: 2eca01084c177a824f02c5f30c03fc2463de4fee55fab370c9fc951bc51cbf56fadebee4f326c1472754f394361a4e932979d269bf130b1a23312af20feb6483
+  metadata.gz: 59de0a086d49d26a332e3ffda73eb81b4873ea9ff45ecaf97e78b2fcda7e477650abf726e8be5d1623bcf8176aec74d6c5e4b336d75549f8ea973dba4328d3e8
+  data.tar.gz: 1bea4dfb461300942a4f677a352ddc5801833bb915ea16656b2cf86ad07e62414c9a0bb426ae765731ce8361e1c0a30348314434c1dcf2dfb7a2d7b031fef479

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 3.0
 

data/.rubocop_todo.yml

@@ -0,0 +1,64 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-06-13 04:55:12 UTC using RuboCop version 1.76.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: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'spec/rng/spectest_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/rng.rb'
+
+# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 95
+
+# Offense count: 23
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 109
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 167
+
+# Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 29
+
+# Offense count: 8
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 86
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 27
+
+# Offense count: 31
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 261

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -5,12 +5,14 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rng.gemspec
 gemspec
 
+gem "diffy" # For generating human-readable diffs
 gem "equivalent-xml"
+gem "lutaml-model"
 gem "nokogiri"
-gem "xml-c14n"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
+gem "xml-c14n"

data/README.adoc

@@ -0,0 +1,402 @@
+= RNG: RELAX NG Schema Processing for Ruby
+:toc: macro
+:toclevels: 3
+:toc-title: Contents
+:source-highlighter: highlight.js
+
+image:https://github.com/lutaml/rng/workflows/rake/badge.svg["Build Status", link="https://github.com/lutaml/rng/actions?workflow=rake"]
+
+toc::[]
+
+== Introduction and purpose
+
+RNG provides Ruby tools for working with RELAX NG schemas, supporting both the XML syntax (RNG) and the compact syntax (RNC). It allows parsing, manipulation, and generation of RELAX NG schemas through an intuitive Ruby API.
+
+Key features:
+
+* Parse RELAX NG XML (.rng) and Compact (.rnc) syntax
+* Programmatically build RELAX NG schemas
+* Convert between XML and compact notations
+* Object model representing RELAX NG concepts
+* Integration with the LutaML ecosystem
+
+== Getting started
+
+Install the gem:
+
+[source,ruby]
+----
+# In your Gemfile
+gem 'rng'
+----
+
+=== Parsing RNG schemas
+
+[source,ruby]
+----
+require 'rng'
+
+# Parse from XML syntax
+schema = Rng.parse(File.read('example.rng'))
+
+# Access schema components
+if schema.element
+  # Simple element pattern
+  puts "Root element: #{schema.element.name}"
+else
+  # Grammar with named patterns
+  start_element = schema.start.element
+  puts "Root element: #{start_element.name}"
+end
+----
+
+=== Parsing RNC schemas
+
+[source,ruby]
+----
+require 'rng'
+
+# Parse from compact syntax
+schema = Rng.parse_rnc(File.read('example.rnc'))
+
+# Access schema components
+if schema.element
+  # Simple element pattern
+  puts "Root element: #{schema.element.name}"
+else
+  # Grammar with named patterns
+  start_element = schema.start.element
+  puts "Root element: #{start_element.name}"
+end
+----
+
+=== Converting between formats
+
+[source,ruby]
+----
+require 'rng'
+
+# Parse RNG and convert to RNC
+schema = Rng.parse(File.read('example.rng'))
+rnc = Rng.to_rnc(schema)
+File.write('example.rnc', rnc)
+
+# Parse RNC and get RNG XML
+schema = Rng.parse_rnc(File.read('example.rnc'))
+rng_xml = Rng::RncParser.parse(File.read('example.rnc'))
+File.write('example.rng', rng_xml)
+----
+
+=== Building schemas programmatically
+
+[source,ruby]
+----
+require 'rng'
+
+# Create a schema with an address element
+schema = Rng::Grammar.new
+schema.element = Rng::Element.new(
+  name: "address"
+)
+
+# Add attributes
+schema.element.attribute = Rng::Attribute.new(
+  name: "id"
+)
+schema.element.attribute.data = Rng::Data.new(
+  type: "ID"
+)
+
+# Add child elements
+name_element = Rng::Element.new(name: "name")
+name_element.text = Rng::Text.new
+
+street_element = Rng::Element.new(name: "street")
+street_element.text = Rng::Text.new
+
+city_element = Rng::Element.new(name: "city")
+city_element.text = Rng::Text.new
+
+# Add child elements to parent
+schema.element.element = [name_element, street_element, city_element]
+
+# Convert to RNC format
+rnc = Rng.to_rnc(schema)
+File.write('address.rnc', rnc)
+----
+
+== Schema object model
+
+=== Grammar
+
+The Grammar class represents a complete RELAX NG schema:
+
+[source,ruby]
+----
+# Simple element pattern
+schema = Rng::Grammar.new(
+  element: Rng::Element.new(...)
+)
+
+# Grammar with named patterns
+schema = Rng::Grammar.new(
+  start: Rng::Start.new(...),
+  define: [Rng::Define.new(...), ...],
+  datatypeLibrary: "http://www.w3.org/2001/XMLSchema-datatypes"
+)
+----
+
+=== Start
+
+The Start class defines the entry point of a schema:
+
+[source,ruby]
+----
+start = Rng::Start.new(
+  ref: Rng::Ref.new(name: "addressDef"),  # Reference to a named pattern
+  element: Rng::Element.new(...),         # Inline element definition
+  choice: Rng::Choice.new(...),           # Choice pattern
+  group: Rng::Group.new(...)              # Group pattern
+)
+----
+
+=== Define
+
+Define represents named pattern definitions:
+
+[source,ruby]
+----
+define = Rng::Define.new(
+  name: "addressDef",
+  element: Rng::Element.new(...),
+  choice: Rng::Choice.new(...),
+  group: Rng::Group.new(...)
+)
+----
+
+=== Element
+
+Element represents XML elements in the schema:
+
+[source,ruby]
+----
+element = Rng::Element.new(
+  name: "address",
+  attribute: Rng::Attribute.new(...),   # Attribute definition
+  element: Rng::Element.new(...),       # Child element definition
+  text: Rng::Text.new,                  # Text content
+  zeroOrMore: Rng::ZeroOrMore.new(...), # Elements that can appear zero or more times
+  oneOrMore: Rng::OneOrMore.new(...),   # Elements that must appear at least once
+  optional: Rng::Optional.new(...)      # Optional elements
+)
+----
+
+=== Attribute
+
+Attribute defines attributes for elements:
+
+[source,ruby]
+----
+attribute = Rng::Attribute.new(
+  name: "id",
+  data: Rng::Data.new(type: "ID")  # XML Schema datatype
+)
+----
+
+=== Pattern Classes
+
+The library includes classes for all RELAX NG patterns:
+
+* `Rng::Choice` - Represents a choice between patterns
+* `Rng::Group` - Represents a sequence of patterns
+* `Rng::Interleave` - Represents patterns that can be interleaved
+* `Rng::Mixed` - Represents mixed content (text and elements)
+* `Rng::Optional` - Represents an optional pattern
+* `Rng::ZeroOrMore` - Represents a pattern that can occur zero or more times
+* `Rng::OneOrMore` - Represents a pattern that must occur at least once
+* `Rng::Text` - Represents text content
+* `Rng::Empty` - Represents empty content
+* `Rng::Value` - Represents a specific value
+* `Rng::Data` - Represents a datatype
+* `Rng::List` - Represents a list of values
+* `Rng::Ref` - Represents a reference to a named pattern
+* `Rng::ParentRef` - Represents a reference to a pattern in a parent grammar
+* `Rng::ExternalRef` - Represents a reference to a pattern in an external grammar
+* `Rng::NotAllowed` - Represents a pattern that is not allowed
+
+== Schema formats
+
+=== RELAX NG XML syntax (RNG)
+
+XML syntax is the canonical form of RELAX NG schemas:
+
+[source,xml]
+----
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+  <start>
+    <element name="address">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <element name="name">
+        <text/>
+      </element>
+      <element name="street">
+        <text/>
+      </element>
+      <element name="city">
+        <text/>
+      </element>
+    </element>
+  </start>
+</grammar>
+----
+
+=== RELAX NG Compact syntax (RNC)
+
+Compact syntax provides a more readable alternative:
+
+[source,rnc]
+----
+element address {
+  attribute id { text },
+  element name { text },
+  element street { text },
+  element city { text }
+}
+----
+
+== Advanced usage
+
+=== Working with complex patterns
+
+[source,ruby]
+----
+require 'rng'
+
+# Create a schema with choice patterns
+schema = Rng::Grammar.new
+schema.start = Rng::Start.new
+
+# Create a choice between two elements
+choice = Rng::Choice.new
+choice.element = []
+
+# First option: name element
+name_element = Rng::Element.new(name: "name")
+name_element.text = Rng::Text.new
+choice.element << name_element
+
+# Second option: first name and last name elements
+first_name = Rng::Element.new(name: "firstName")
+first_name.text = Rng::Text.new
+
+last_name = Rng::Element.new(name: "lastName")
+last_name.text = Rng::Text.new
+
+# Group the first name and last name elements
+group = Rng::Group.new
+group.element = [first_name, last_name]
+
+# Add the group as the second choice
+choice.group = [group]
+
+# Add the choice to the start element
+schema.start.choice = choice
+
+# Convert to RNC format
+rnc = Rng.to_rnc(schema)
+puts rnc
+----
+
+=== Working with named patterns
+
+[source,ruby]
+----
+require 'rng'
+
+# Create a schema with named patterns
+schema = Rng::Grammar.new
+schema.start = Rng::Start.new
+
+# Create a reference to a named pattern
+ref = Rng::Ref.new(name: "addressDef")
+schema.start.ref = ref
+
+# Define the named pattern
+define = Rng::Define.new(name: "addressDef")
+schema.define = [define]
+
+# Add an element to the named pattern
+element = Rng::Element.new(name: "address")
+element.attribute = Rng::Attribute.new(name: "id")
+element.attribute.data = Rng::Data.new(type: "ID")
+
+# Add child elements
+name_element = Rng::Element.new(name: "name")
+name_element.text = Rng::Text.new
+element.element = [name_element]
+
+# Add the element to the named pattern
+define.element = element
+
+# Convert to RNC format
+rnc = Rng.to_rnc(schema)
+puts rnc
+----
+
+=== Working with cardinality constraints
+
+[source,ruby]
+----
+require 'rng'
+
+# Create a schema with cardinality constraints
+schema = Rng::Grammar.new
+schema.element = Rng::Element.new(name: "addressBook")
+
+# Create a card element that can appear zero or more times
+zero_or_more = Rng::ZeroOrMore.new
+card_element = Rng::Element.new(name: "card")
+
+# Add child elements to the card element
+name_element = Rng::Element.new(name: "name")
+name_element.text = Rng::Text.new
+
+email_element = Rng::Element.new(name: "email")
+email_element.text = Rng::Text.new
+
+# Create an optional note element
+optional = Rng::Optional.new
+note_element = Rng::Element.new(name: "note")
+note_element.text = Rng::Text.new
+optional.element = [note_element]
+
+# Add the child elements to the card element
+card_element.element = [name_element, email_element]
+card_element.optional = optional
+
+# Add the card element to the zero_or_more pattern
+zero_or_more.element = [card_element]
+
+# Add the zero_or_more pattern to the address book element
+schema.element.zeroOrMore = zero_or_more
+
+# Convert to RNC format
+rnc = Rng.to_rnc(schema)
+puts rnc
+----
+
+== Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+== License
+
+Copyright (c) 2025 Ribose Inc.
+
+This project is licensed under the BSD-2-Clause License.

data/lib/rng/any_name.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Rng
+  class AnyName < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :id, :string
+    attribute :ns, :string
+    attribute :datatypeLibrary, :string
+    attribute :except, Except
+
+    xml do
+      root "anyName", ordered: true
+      map_attribute "name", to: :name
+      map_attribute "id", to: :id
+      map_attribute "ns", to: :ns, value_map: {
+        from: { empty: :empty, omitted: :omitted, nil: :nil },
+        to: { empty: :empty, omitted: :omitted, nil: :nil }
+      }
+      map_attribute "datatypeLibrary", to: :datatypeLibrary
+
+      map_element "except", to: :except
+    end
+  end
+end