oasis-etm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad71a9a5219cab7710a57ebe6b3424172a11c50deac97889692b01ac239511a7
+  data.tar.gz: 11521a92f66914b6afef831dcd34f5544f082a00abc9dbd8e08c00d2ba48a6fc
+SHA512:
+  metadata.gz: 6ece8bcbd0b7914cbe9eea7bbc6a9b59c9fc9e88f95f1278a710fa59e13e900239fd5a020c62d9cbfd8412e24664a64b8bf6369e6e73bd047c3a44b4f460ec0a
+  data.tar.gz: bf7e7b5b1921b33599e1e28ea2b494784227cb07c787dcf7de9a8dbcde5adf84f34f05ac2f97ac09224d375b57d031367960f92fd2abe4543532183d10dca7e3

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+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,23 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+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.LUTAML_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/.gitignore

@@ -0,0 +1,13 @@
+.rubocop-https---*
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+require:
+- rubocop-performance
+- rubocop-rake
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-11-01 07:12:25 UTC using RuboCop version 1.68.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: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'spec/oasis/etm/entry_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 10
+
+# Offense count: 12
+RSpec/MultipleExpectations:
+  Max: 10

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oasis-etm.gemspec
+gemspec
+
+gem "nokogiri"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "xml-c14n"

data/README.adoc

@@ -0,0 +1,152 @@
+= OASIS Exchange Table Model (ETM) Parser
+:toc: macro
+:toclevels: 3
+
+image:https://img.shields.io/gem/v/oasis-etm.svg[Gem Version, link=https://rubygems.org/gems/oasis-etm]
+image:https://github.com/yourusername/oasis-etm/actions/workflows/test.yml/badge.svg[Build Status, link=https://github.com/yourusername/oasis-etm/actions/workflows/test.yml]
+image:https://img.shields.io/github/license/yourusername/oasis-etm.svg[License, link=https://github.com/yourusername/oasis-etm/blob/main/LICENSE]
+
+toc::[]
+
+== Purpose
+
+The OASIS ETM format is a simple XML format for representing tables for
+exchange. It is used in the DocBook and NISO JATS standards.
+
+This library provides a Ruby implementation of the
+https://www.oasis-open.org/specs/a503.htm[OASIS Technical Resolution TR 9503:1995].
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'oasis-etm'
+----
+
+And then execute:
+
+[source,shell]
+----
+bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+gem install oasis-etm
+----
+
+
+== Usage
+
+=== Basic example
+
+[source,ruby]
+----
+require 'oasis-etm'
+
+# Parse an ETM XML file
+table = Oasis::Etm::Table.from_xml(File.read('table.xml'))
+
+# Access table attributes
+puts table.frame
+puts table.colsep
+puts table.rowsep
+
+# Access table content
+table.tgroups.each do |tgroup|
+  tgroup.colspecs.each do |colspec|
+    puts "Column #{colspec.colnum}: #{colspec.colwidth}"
+  end
+end
+
+# Create a new table
+table = Oasis::Etm::Table.new(
+  frame: 'all',
+  colsep: 1,
+  rowsep: 1,
+  tgroups: [
+    Oasis::Etm::Tgroup.new(
+      cols: 3,
+      colspecs: [
+        Oasis::Etm::Colspec.new(colnum: 1, colwidth: '1*'),
+        Oasis::Etm::Colspec.new(colnum: 2, colwidth: '2*'),
+        Oasis::Etm::Colspec.new(colnum: 3, colwidth: '1*')
+      ]
+    )
+  ]
+)
+
+# Convert to XML
+xml = table.to_xml
+----
+
+=== XML schema
+
+The OASIS ETM format follows this basic structure:
+
+[source,xml]
+----
+<table frame="all" colsep="1" rowsep="1">
+  <title>Sample Table</title>
+  <tgroup cols="3">
+    <colspec colnum="1" colwidth="1*"/>
+    <colspec colnum="2" colwidth="2*"/>
+    <colspec colnum="3" colwidth="1*"/>
+    <thead>
+      <row>
+        <entry>Header 1</entry>
+        <entry>Header 2</entry>
+        <entry>Header 3</entry>
+      </row>
+    </thead>
+    <tbody>
+      <row>
+        <entry>Cell 1</entry>
+        <entry>Cell 2</entry>
+        <entry>Cell 3</entry>
+      </row>
+    </tbody>
+  </tgroup>
+</table>
+----
+
+== Development
+
+=== Test files
+
+`spec/fixtures/native/docbook_example.xml`::
+https://tdg.docbook.org/tdg/4.5/table
+
+`spec/fixtures/niso-jats/niso-jats-table-wrap.xml`::
+https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/element/oasis-table.html
+This is to test the OASIS exchange table model when it is namespaced from
+another location.
+
+`spec/fixtures/isosts/isosts_tables.cals.{nn}.xml`::
+Tables extracted from https://www.iso.org/schema/isosts/cals/test/isosts_tables.cals.xml.
+This is to test the OASIS exchange table model when it is namespaced from
+another location.
+
+
+== Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+. Fork it
+. Create your feature branch (`git checkout -b my-new-feature`)
+. Commit your changes (`git commit -am 'Add some feature'`)
+. Push to the branch (`git push origin my-new-feature`)
+. Create new Pull Request
+
+
+== License and Copyright
+
+This project is licensed under the BSD 2-clause License.
+See the link:LICENSE.md[] file for details.
+
+Copyright Ribose.

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/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "oasis/etm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oasis/etm/colspec.rb

@@ -0,0 +1,28 @@
+module Oasis
+  module Etm
+    class Colspec < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :colnum, :integer
+      attribute :colname, :string
+      attribute :colwidth, :string
+      attribute :colsep, :integer, values: [0, 1]
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :align, :string, values: %w[left right center justify char]
+      attribute :char, :string
+      attribute :charoff, :string
+
+      xml do
+        root "colspec"
+
+        map_attribute "colnum", to: :colnum
+        map_attribute "colname", to: :colname
+        map_attribute "colwidth", to: :colwidth
+        map_attribute "colsep", to: :colsep
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "align", to: :align
+        map_attribute "char", to: :char
+        map_attribute "charoff", to: :charoff
+      end
+    end
+  end
+end

data/lib/oasis/etm/entry.rb

@@ -0,0 +1,39 @@
+module Oasis
+  module Etm
+    class Entry < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :colname, :string
+      attribute :namest, :string
+      attribute :nameend, :string
+      attribute :morerows, :integer
+      attribute :colsep, :integer, values: [0, 1]
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :align, :string, values: %w[left right center justify char]
+      attribute :char, :string
+      attribute :charoff, :string
+      attribute :valign, :string, values: %w[top middle bottom]
+
+      # Content
+      attribute :content, :string
+
+      xml do
+        root "entry"
+
+        # Attribute mappings
+        map_attribute "colname", to: :colname
+        map_attribute "namest", to: :namest
+        map_attribute "nameend", to: :nameend
+        map_attribute "morerows", to: :morerows
+        map_attribute "colsep", to: :colsep
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "align", to: :align
+        map_attribute "char", to: :char
+        map_attribute "charoff", to: :charoff
+        map_attribute "valign", to: :valign
+
+        # Content mapping
+        map_content to: :content
+      end
+    end
+  end
+end

data/lib/oasis/etm/row.rb

@@ -0,0 +1,22 @@
+require_relative "entry"
+
+module Oasis
+  module Etm
+    class Row < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :valign, :string, values: %w[top middle bottom]
+
+      # Content
+      attribute :entries, Entry, collection: true
+
+      xml do
+        root "row"
+
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "valign", to: :valign
+        map_element "entry", to: :entries
+      end
+    end
+  end
+end

data/lib/oasis/etm/table.rb

@@ -0,0 +1,31 @@
+require_relative "tgroup"
+
+module Oasis
+  module Etm
+    class Table < Lutaml::Model::Serializable
+      # Table attributes
+      attribute :frame, :string, values: %w[top bottom topbot all sides none]
+      attribute :colsep, :integer, values: [0, 1]
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :pgwide, :integer, values: [0, 1]
+
+      # Table content
+      attribute :title, :string
+      attribute :tgroups, Tgroup, collection: true
+
+      xml do
+        root "table"
+
+        # Frame mappings
+        map_attribute "frame", to: :frame
+        map_attribute "colsep", to: :colsep
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "pgwide", to: :pgwide
+
+        # Content mappings
+        map_element "title", to: :title
+        map_element "tgroup", to: :tgroups
+      end
+    end
+  end
+end

data/lib/oasis/etm/tbody.rb

@@ -0,0 +1,20 @@
+require_relative "row"
+
+module Oasis
+  module Etm
+    class Tbody < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :valign, :string, values: %w[top middle bottom]
+
+      # Content
+      attribute :rows, Row, collection: true
+
+      xml do
+        root "tbody"
+
+        map_attribute "valign", to: :valign
+        map_element "row", to: :rows
+      end
+    end
+  end
+end

data/lib/oasis/etm/tcol.rb

@@ -0,0 +1,28 @@
+module Oasis
+  module Etm
+    class Colspec < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :colnum, :integer
+      attribute :colname, :string
+      attribute :colwidth, :string
+      attribute :colsep, :integer, values: [0, 1]
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :align, :string, values: %w[left right center justify char]
+      attribute :char, :string
+      attribute :charoff, :string
+
+      xml do
+        root "colspec"
+
+        map_attribute "colnum", to: :colnum
+        map_attribute "colname", to: :colname
+        map_attribute "colwidth", to: :colwidth
+        map_attribute "colsep", to: :colsep
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "align", to: :align
+        map_attribute "char", to: :char
+        map_attribute "charoff", to: :charoff
+      end
+    end
+  end
+end

data/lib/oasis/etm/tgroup.rb

@@ -0,0 +1,37 @@
+require_relative "colspec"
+require_relative "thead"
+require_relative "tbody"
+
+module Oasis
+  module Etm
+    class Tgroup < Lutaml::Model::Serializable
+      # Required attributes
+      attribute :cols, :integer
+
+      # Optional attributes
+      attribute :colsep, :integer, values: [0, 1]
+      attribute :rowsep, :integer, values: [0, 1]
+      attribute :align, :string, values: %w[left right center justify char]
+
+      # Content
+      attribute :colspecs, Colspec, collection: true
+      attribute :thead, Thead
+      attribute :tbody, Tbody
+
+      xml do
+        root "tgroup"
+
+        # Attribute mappings
+        map_attribute "cols", to: :cols
+        map_attribute "colsep", to: :colsep
+        map_attribute "rowsep", to: :rowsep
+        map_attribute "align", to: :align
+
+        # Content mappings
+        map_element "colspec", to: :colspecs
+        map_element "thead", to: :thead
+        map_element "tbody", to: :tbody
+      end
+    end
+  end
+end

data/lib/oasis/etm/thead.rb

@@ -0,0 +1,20 @@
+require_relative "row"
+
+module Oasis
+  module Etm
+    class Thead < Lutaml::Model::Serializable
+      # Optional attributes
+      attribute :valign, :string, values: %w[top middle bottom]
+
+      # Content
+      attribute :rows, Row, collection: true
+
+      xml do
+        root "thead"
+
+        map_attribute "valign", to: :valign
+        map_element "row", to: :rows
+      end
+    end
+  end
+end

data/lib/oasis/etm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Oasis
+  module Etm
+    VERSION = "0.1.0"
+  end
+end