hyperlang 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5b04c05d3353ba14e7fabc8609d8681737eebcec58c2f5acc17e88e940b8ab8
+  data.tar.gz: 0051737e8f854dc03c2be88e3e3786cb799ac8e5956db1ec26ec891f57ea4819
+SHA512:
+  metadata.gz: 6d99633b71264fb819562a30cd7c08c3000aa9e70d72134b8c83c2e316b1f3fbfef5cf090728fde815d6a464e298249c65d163cab66d7b923de943a38831120c
+  data.tar.gz: 2d162a1064ba4cf0a08eac1e4567903e7742cb9b08a12c98c35b6e0fac76463c6c49a8f2fe1fac7c08cb9ed8c96f6eb688417aa38cc5da51101920bc397ef872

data/.github/workflows/rake.yml

@@ -0,0 +1,19 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+permissions:
+  contents: write
+  packages: write
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.LUTAML_CI_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,8 @@
+/pkg/
+/tmp/
+/log/
+*.gem
+.bundle/
+Gemfile.lock
+.DS_Store
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# 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
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -0,0 +1,45 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2026-03-28 04:02:35 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: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'hyperlang.gemspec'
+    - 'lib/hyperlang.rb'
+    - 'lib/hyperlang/xhtml/dd.rb'
+    - 'spec/hyperlang/xhtml/inline_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 28
+
+# Offense count: 1
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/hyperlang/round_trip_spec.rb'
+
+# Offense count: 10
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 19
+
+# Offense count: 2
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/hyperlang/xhtml/block_spec.rb'
+    - 'spec/hyperlang/xhtml/inline_spec.rb'
+
+# Offense count: 7
+RSpec/MultipleExpectations:
+  Max: 4

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xml-c14n.gemspec
+gemspec
+
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+gem "nokogiri"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/README.adoc

@@ -0,0 +1,176 @@
+= hyperlang
+
+Complete XHTML 1.1 element model library for Lutaml.
+
+== Overview
+
+hyperlang provides Ruby object models for every XHTML 1.1 element (Strict, Transitional, and Frameset variants), built on top of `lutaml-model`. Each element class inherits from `Lutaml::Model::Serializable` and supports XML round-trip serialization via the `xml` DSL.
+
+== Installation
+
+Add to your Gemfile:
+
+[source,ruby]
+gem "hyperlang", "~> 0.1.0"
+
+== Usage
+
+=== Parsing XHTML
+
+[source,ruby]
+require "hyperlang"
+
+html = Hyperlang::Xhtml::Html.from_xml(xhtml_string)
+puts html.head.title.content
+puts html.body.div.first.p.first.content
+
+=== Generating XHTML
+
+[source,ruby]
+html = Hyperlang::Xhtml::Html.new(
+  head: Hyperlang::Xhtml::Head.new(
+    title: Hyperlang::Xhtml::Title.new(content: "My Page")
+  ),
+  body: Hyperlang::Xhtml::Body.new(
+    div: [
+      Hyperlang::Xhtml::Div.new(
+        p: [Hyperlang::Xhtml::P.new(content: "Hello world")]
+      )
+    ]
+  )
+)
+
+puts html.to_xml
+
+== Elements
+
+All 99 XHTML element classes live under `Hyperlang::Xhtml::`:
+
+=== Structure
+
+|===
+| Element | Class
+| `<html>` | `Html`
+| `<head>` | `Head`
+| `<title>` | `Title`
+| `<body>` | `Body`
+|===
+
+=== Text Block
+
+`Div`, `P`, `Pre`, `Address`, `H1`-`H6`, `Blockquote`, `Hr`
+
+=== Text Inline
+
+Phrasal:: `Abbr`, `Acronym`, `Cite`, `Code`, `Dfn`, `Em`, `Kbd`, `Q`, `Samp`, `Strong`, `Var`
+
+Structural:: `Span`, `Br`
+
+=== Hypertext
+
+`A`
+
+=== Lists
+
+`Dl`, `Dt`, `Dd`, `Ol`, `Ul`, `Li`
+
+=== Tables
+
+`Table`, `Caption`, `Colgroup`, `Col`, `Thead`, `Tfoot`, `Tbody`, `Tr`, `Th`, `Td`
+
+=== Forms
+
+`Form`, `Fieldset`, `Legend`, `Label`, `Input`, `Select`, `Optgroup`, `Option`, `Textarea`, `Button`
+
+=== Presentation
+
+`B`, `Big`, `I`, `Small`, `Sub`, `Sup`, `Tt`
+
+=== Other
+
+`Object`, `Param`, `Img`, `Map`, `Area`, `Meta`, `Script`, `Noscript`, `Style`, `Link`, `Base`
+
+=== Edit
+
+`Del`, `Ins`
+
+=== BIDI
+
+`Bdo`
+
+=== Ruby Annotation
+
+`Ruby`, `Rbc`, `Rtc`, `Rb`, `Rt`, `Rp`
+
+=== Transitional-only
+
+`Applet`, `Basefont`, `Center`, `Dir`, `Font`, `Iframe`, `Isindex`, `Menu`, `S`, `Strike`, `U`
+
+=== Frameset-only
+
+`Frame`, `Frameset`, `Noframes`
+
+== Namespace
+
+All elements use the XHTML namespace `http://www.w3.org/1999/xhtml` with prefix `xhtml`.
+
+== Architecture
+
+=== Element class pattern
+
+Every element follows a consistent pattern:
+
+[source,ruby]
+class Hyperlang::Xhtml::P < Lutaml::Model::Serializable
+  attribute :content, :string
+  attribute :span, Hyperlang::Xhtml::Span, collection: true
+  attribute :klass, :string
+
+  xml do
+    element "p"
+    namespace Hyperlang::Xhtml::Namespace
+    mixed_content
+    map_content to: :content
+    map_element "span", to: :span
+    map_attribute "class", to: :klass
+  end
+end
+
+Key conventions:
+
+* `mixed_content` + `map_content to: :content` for elements allowing text and child elements
+* `collection: true` for child elements that can appear multiple times
+* XML `class` attribute mapped to Ruby `:klass` to avoid collision with Ruby's `Class`
+
+=== Document tree
+
+[source]
+Html
+  +-- Head
+  |     +-- Title
+  |     +-- Meta (collection)
+  |     +-- Link (collection)
+  |     +-- Style (collection)
+  |     +-- Script (collection)
+  |     +-- Base
+  +-- Body (mixed_content)
+        +-- Div, P, Span, A, Ul, Ol, Table, H1-H6, Pre, ...
+
+=== Loading
+
+Classes are loaded in topologically sorted order (computed from dependency analysis) to ensure parent classes load before children that reference them. Leaf-node elements (`Br`, `Img`, `Span`) load first; container elements (`Html`, `Body`, `Div`) load last.
+
+== Relationship to reqif
+
+The `reqif` gem uses hyperlang for XHTML content within ReqIF documents. The `<XHTML-CONTENT>` element in ReqIF can contain any XHTML element, and reqif references hyperlang's element classes for parsing and serializing rich text content.
+
+== Development
+
+After checking out the repo:
+
+  $ bundle install
+  $ bundle exec rake
+
+== License
+
+See `hyperlang.gemspec` for license information.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/hyperlang.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/hyperlang/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hyperlang"
+  spec.version = Hyperlang::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Complete XHTML model library for Lutaml"
+  spec.description = "XHTML 1.1 Strict, Transitional, and Frameset element models for Lutaml"
+  spec.homepage = "https://github.com/lutaml/hyperlang"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/lutaml/hyperlang/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
+end

data/lib/hyperlang/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  VERSION = "0.1.0"
+end

data/lib/hyperlang/xhtml/a.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class A < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :href, :string
+      attribute :name, :string
+      attribute :hreflang, :string
+      attribute :type, :string
+      attribute :rel, :string
+      attribute :rev, :string
+      attribute :charset, :string
+      attribute :accesskey, :string
+      attribute :tabindex, :integer
+      attribute :shape, :string
+      attribute :coords, :string
+      attribute :id, :string
+      attribute :klass, :string
+      attribute :style, :string
+
+      xml do
+        element "a"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "href", to: :href
+        map_attribute "name", to: :name
+        map_attribute "hreflang", to: :hreflang
+        map_attribute "type", to: :type
+        map_attribute "rel", to: :rel
+        map_attribute "rev", to: :rev
+        map_attribute "charset", to: :charset
+        map_attribute "accesskey", to: :accesskey
+        map_attribute "tabindex", to: :tabindex
+        map_attribute "shape", to: :shape
+        map_attribute "coords", to: :coords
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+        map_attribute "style", to: :style
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/abbr.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Abbr < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :title, :string
+      attribute :id, :string
+      attribute :klass, :string
+
+      xml do
+        element "abbr"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "title", to: :title
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/acronym.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Acronym < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :title, :string
+      attribute :id, :string
+      attribute :klass, :string
+
+      xml do
+        element "acronym"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "title", to: :title
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/address.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Address < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :p, Hyperlang::Xhtml::P, collection: true
+      attribute :span, Hyperlang::Xhtml::Span, collection: true
+      attribute :a, Hyperlang::Xhtml::A, collection: true
+      attribute :em, Hyperlang::Xhtml::Em, collection: true
+      attribute :strong, Hyperlang::Xhtml::Strong, collection: true
+
+      xml do
+        element "address"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_element "p", to: :p
+        map_element "span", to: :span
+        map_element "a", to: :a
+        map_element "em", to: :em
+        map_element "strong", to: :strong
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/applet.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Applet < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :codebase, :string
+      attribute :archive, :string
+      attribute :code, :string
+      attribute :object, :string
+      attribute :alt, :string
+      attribute :name, :string
+      attribute :width, :string
+      attribute :height, :string
+      attribute :align, :string
+      attribute :hspace, :string
+      attribute :vspace, :string
+      attribute :id, :string
+      attribute :klass, :string
+
+      xml do
+        element "applet"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "codebase", to: :codebase
+        map_attribute "archive", to: :archive
+        map_attribute "code", to: :code
+        map_attribute "object", to: :object
+        map_attribute "alt", to: :alt
+        map_attribute "name", to: :name
+        map_attribute "width", to: :width
+        map_attribute "height", to: :height
+        map_attribute "align", to: :align
+        map_attribute "hspace", to: :hspace
+        map_attribute "vspace", to: :vspace
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/area.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Area < Lutaml::Model::Serializable
+      attribute :shape, :string
+      attribute :coords, :string
+      attribute :href, :string
+      attribute :nohref, :string
+      attribute :alt, :string
+      attribute :tabindex, :integer
+      attribute :accesskey, :string
+      attribute :id, :string
+
+      xml do
+        element "area"
+        namespace Hyperlang::Xhtml::Namespace
+        map_attribute "shape", to: :shape
+        map_attribute "coords", to: :coords
+        map_attribute "href", to: :href
+        map_attribute "nohref", to: :nohref
+        map_attribute "alt", to: :alt
+        map_attribute "tabindex", to: :tabindex
+        map_attribute "accesskey", to: :accesskey
+        map_attribute "id", to: :id
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/b.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class B < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :id, :string
+      attribute :klass, :string
+      attribute :style, :string
+
+      xml do
+        element "b"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+        map_attribute "style", to: :style
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Base < Lutaml::Model::Serializable
+      attribute :href, :string
+      attribute :id, :string
+
+      xml do
+        element "base"
+        namespace Hyperlang::Xhtml::Namespace
+        map_attribute "href", to: :href
+        map_attribute "id", to: :id
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/basefont.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Basefont < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :size, :string
+      attribute :color, :string
+      attribute :face, :string
+
+      xml do
+        element "basefont"
+        namespace Hyperlang::Xhtml::Namespace
+        map_attribute "id", to: :id
+        map_attribute "size", to: :size
+        map_attribute "color", to: :color
+        map_attribute "face", to: :face
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/bdo.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Bdo < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :dir, :string
+      attribute :id, :string
+      attribute :klass, :string
+
+      xml do
+        element "bdo"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "dir", to: :dir
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+      end
+    end
+  end
+end

data/lib/hyperlang/xhtml/big.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hyperlang
+  module Xhtml
+    class Big < Lutaml::Model::Serializable
+      attribute :content, :string
+      attribute :id, :string
+      attribute :klass, :string
+      attribute :style, :string
+
+      xml do
+        element "big"
+        namespace Hyperlang::Xhtml::Namespace
+        mixed_content
+        map_content to: :content
+        map_attribute "id", to: :id
+        map_attribute "class", to: :klass
+        map_attribute "style", to: :style
+      end
+    end
+  end
+end