revix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84fc11db5dc8582011c975954500bc7cdf138644d2eeb23f8a7be8e84e9e19a5
+  data.tar.gz: c4a80aaf7fc824afdd86a07637db47a016f5d2dc8090aaf1da147259dc2ed963
+SHA512:
+  metadata.gz: 42ae71d3dacde27dbebb7dc4ba5ae7b23e428946286c57d84b4e92f5fa2493b93587c8ca0adc331d2a1c3d84b5d6454ad3489c72b9ba0aef300645bdea0412b7
+  data.tar.gz: ca6fb8744817b6d489d25e33ad9df7b509abbf423d79ac73b4c656319b875dc01d7620d9106c9dac855294a2c5be8a70c13445837a9865e8ad9f01e4fce9e647

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in revix.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.7"

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, Ribose Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,317 @@
+= Revix: revision history models
+
+image:https://img.shields.io/gem/v/revix.svg["Gem Version", link="https://rubygems.org/gems/revix"]
+image:https://github.com/metanorma/revix/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/revix/actions?query=workflow%3Aubuntu"]
+image:https://github.com/metanorma/revix/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/revix/actions?query=workflow%3Amacos"]
+image:https://github.com/metanorma/revix/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/revix/actions?query=workflow%3Awindows"]
+image:https://codeclimate.com/github/metanorma/revix/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/revix"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/revix.svg["Pull Requests", link="https://github.com/metanorma/revix/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/revix/latest.svg["Commits since latest",link="https://github.com/metanorma/revix/releases"]
+
+== Purpose
+
+Revix is a Ruby gem for working with Metanorma document revision history.
+
+It provides a set of models and utilities for parsing, manipulating, and
+serializing revision history data in YAML and XML formats.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'revix'
+----
+
+And then execute:
+
+[source,shell]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+$ gem install revix
+----
+
+== Usage
+
+=== Parsing revision history
+
+==== From YAML
+
+[source,yaml]
+----
+- edition: 1.0.0
+  date:
+    - type: published
+      value: 2012-04
+  contributor:
+    - person:
+        name:
+          abbreviation: JMS
+          completename: J. Michael Straczynski
+  amend:
+    - description: Approved edition of S-102
+      location:
+        - type: clause
+          value: 4.0
+        - type: whole
+----
+
+[source,ruby]
+----
+require 'revix'
+
+# Parse from YAML string
+yaml_content = File.read('revision_history.yaml')
+history = Revix::RevisionHistory.from_yaml(yaml_content)
+
+# Access revision data
+history.revisions.each do |revision|
+  puts "Edition: #{revision.edition}"
+  puts "Date: #{revision.date.first.value} (#{revision.date.first.type})"
+
+  revision.contributor.each do |contributor|
+    if contributor.person
+      puts "Contributor: #{contributor.person.name.completename} (#{contributor.person.name.abbreviation})"
+    elsif contributor.organization
+      puts "Contributor: #{contributor.organization.name}"
+    end
+  end
+
+  revision.amend.each do |amendment|
+    puts "Amendment: #{amendment.description}"
+
+    amendment.location&.each do |location|
+      if location.value
+        puts "  Location: #{location.type}=#{location.value}"
+      else
+        puts "  Location: #{location.type}"
+      end
+    end
+
+    amendment.classification&.each do |classification|
+      puts "  Classification: #{classification.tag} = #{classification.value}"
+    end
+  end
+end
+----
+
+==== From XML
+
+[source,xml]
+----
+<revision-history>
+  <revision>
+    <date type="published">2012-04</date>
+    <edition>1.0.0</edition>
+    <contributor>
+      <person>
+        <name abbreviation="JMS">
+          <completename>J. Michael Straczynski</completename>
+        </name>
+      </person>
+    </contributor>
+    <amend>
+      <amendment>
+        <description>Approved edition of S-102</description>
+        <location type="clause">4.0</location>
+        <location type="whole"/>
+      </amendment>
+    </amend>
+  </revision>
+</revision-history>
+----
+
+[source,ruby]
+----
+require 'revix'
+
+# Parse from XML string
+xml_content = File.read('revision_history.xml')
+history = Revix::RevisionHistory.from_xml(xml_content)
+
+# Access revision data (same as with YAML)
+----
+
+=== Serializing revision history
+
+==== To YAML
+
+[source,ruby]
+----
+require 'revix'
+
+# Create a revision history object
+history = Revix::RevisionHistory.new(revisions: [
+  Revix::Revision.new(
+    date: [Revix::DateInfo.new(type: "published", value: "2012-04")],
+    edition: "1.0.0",
+    contributor: [
+      Revix::Contributor.new(
+        person: Revix::Person.new(
+          name: Revix::Name.new(
+            abbreviation: "JMS",
+            completename: "J. Michael Straczynski"
+          )
+        )
+      )
+    ],
+    amend: [
+      Revix::Amendment.new(
+        description: "Approved edition of S-102",
+        location: [
+          Revix::Location.new(type: "clause", value: "4.0"),
+          Revix::Location.new(type: "whole")
+        ]
+      )
+    ]
+  )
+])
+
+# Serialize to YAML
+yaml_content = history.to_yaml
+File.write('revision_history.yaml', yaml_content)
+----
+
+==== To XML
+
+[source,ruby]
+----
+# Serialize to XML
+xml_content = history.to_xml
+File.write('revision_history.xml', xml_content)
+----
+
+== Data model
+
+The Revix gem provides the following models.
+
+[source]
+----
++-------------------+
+|  RevisionHistory  |
+|                   |
+| +revisions        |
++--------+----------+
+         |
+         | 1..*
++--------v----------+      +------------+
+|     Revision      |      |  DateInfo  |
+|                   |      |            |
+| -edition          |<>--->| -type      |
+| -relation_type    |      | -value     |
+| +date             |      |            |
+| +contributor      |      +------------+
+| +amend            |
++--------+----------+
+         |
+    +----+----+---------------------+
+    |         |                     |
++---v---+ +---v----------+  +-------v--------+
+|Person | | Organization |  | Amendment      |
+|       | |              |  |                |
+| +name | | -name        |  | -description   |
+|       | | -subdivision |  | -change        |
+|       | | -abbreviation|  | +location      |
++---+---+ +--------------+  | +classification|
+    |                       +-------+--------+
+    |                               |
+    |                  +------------+------+
++---v---+              |                   |
+| Name  |       +------+-------+   +-------+-------+
+|       |       +  Location    |   | Classification|
+| -abbr |       |              |   |               |
+| -full |       | -type        |   | -tag          |
++-------+       | -value       |   | -value        |
+                +--------------+   +---------------+
+----
+
+=== RevisionHistory
+
+The main container for all revisions.
+
+`revisions`:: A collection of `Revision` objects
+
+=== Revision
+
+Represents a single revision entry.
+
+`date`:: A collection of `DateInfo` objects
+`edition`:: The version number as a string
+`contributor`:: A collection of `Contributor` objects
+`amend`:: A collection of `Amendment` objects
+`relation_type`:: The relation type (optional)
+
+=== DateInfo
+
+Represents date information.
+
+`type`:: The type of date (e.g., "published", "updated")
+`value`:: The date value as a string
+
+=== Contributor
+
+Represents a contributor, which can be either a person or an organization.
+
+`person`:: A `Person` object (optional)
+`organization`:: An `Organization` object (optional)
+
+=== Person
+
+Represents a person contributor.
+
+`name`:: A `Name` object
+
+=== Organization
+
+Represents an organization contributor.
+
+`name`:: The organization name as a string
+`subdivision`:: The organization subdivision as a string (optional)
+`abbreviation`:: The organization abbreviation as a string (optional)
+
+=== Name
+
+Represents a person's name.
+
+`abbreviation`:: The person's abbreviation or initials
+`completename`:: The person's full name
+
+=== Amendment
+
+Represents an amendment.
+
+`description`:: The amendment description as a string
+`location`:: A collection of `Location` objects (optional)
+`classification`:: A collection of `Classification` objects (optional)
+`change`:: The type of change (default: "modify")
+
+=== Location
+
+Represents a location affected by an amendment.
+
+`type`:: The location type. Accepts the defined Metanorma location types, including: `section`, `clause`, `part`, `paragraph`, `chapter`, `page`, `line`, `table`, `annex`, `figure`, `example`, `note`, `formula`, `list`, `time`, `anchor`, `whole`.
+`value`:: The location value (e.g., `4.0`, `B`), can be `nil` for types like `whole`.
+
+=== Classification
+
+Represents a classification tag/value pair.
+
+`tag`:: The classification tag (e.g., "severity", "type")
+`value`:: The classification value (e.g., "major", "editorial")
+
+== Copyright
+
+This gem is developed, maintained and funded by
+https://www.ribose.com[Ribose Inc.]
+
+== License
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/BSD-2-Clause[2-Clause BSD License].

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/revix/amendment.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Amendment < Lutaml::Model::Serializable
+    attribute :description, :string
+    attribute :location, Location, collection: true
+    attribute :classification, Classification, collection: true
+    attribute :change, :string, default: -> { "modify" }
+
+    xml do
+      root "amend"
+      map_element "description", to: :description
+      map_element "location", to: :location
+      map_element "classification", to: :classification
+      map_element "change", to: :change
+    end
+
+    key_value do
+      map "description", to: :description
+      map "location", to: :location
+      map "classification", to: :classification
+      map "change", to: :change
+    end
+  end
+end

data/lib/revix/classification.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Classification < Lutaml::Model::Serializable
+    attribute :tag, :string
+    attribute :value, :string
+
+    xml do
+      root "classification"
+      map_element "tag", to: :tag
+      map_element "value", to: :value
+    end
+
+    key_value do
+      map "tag", to: :tag
+      map "value", to: :value
+    end
+  end
+end

data/lib/revix/contributor.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Contributor < Lutaml::Model::Serializable
+    attribute :person, Person
+    attribute :organization, Organization
+
+    xml do
+      root "contributor"
+      map_element "person", to: :person
+      map_element "organization", to: :organization
+    end
+
+    key_value do
+      map "person", to: :person
+      map "organization", to: :organization
+    end
+  end
+end

data/lib/revix/date_info.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class DateInfo < Lutaml::Model::Serializable
+    attribute :type, :string
+    attribute :value, :string
+
+    xml do
+      root "date"
+      map_element "type", to: :type
+      map_element "value", to: :value
+    end
+
+    key_value do
+      map "type", to: :type
+      map "value", to: :value
+    end
+  end
+end

data/lib/revix/location.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Location < Lutaml::Model::Serializable
+    VALID_TYPES = %w[
+      section clause part paragraph chapter page line table annex figure
+      example note formula list time anchor whole
+    ].freeze
+
+    attribute :value, :string
+    attribute :type, :string, values: VALID_TYPES
+
+    xml do
+      root "location"
+      map_content to: :value
+      map_attribute "type", to: :type
+    end
+
+    key_value do
+      map "value", to: :value
+      map "type", to: :type
+    end
+  end
+end

data/lib/revix/name.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Name < Lutaml::Model::Serializable
+    attribute :abbreviation, :string
+    attribute :completename, :string
+
+    xml do
+      root "name"
+      map_element "abbreviation", to: :abbreviation
+      map_element "completename", to: :completename
+    end
+
+    key_value do
+      map "abbreviation", to: :abbreviation
+      map "completename", to: :completename
+    end
+  end
+end

data/lib/revix/organization.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Organization < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :subdivision, :string
+    attribute :abbreviation, :string
+
+    xml do
+      root "organization"
+      map_element "name", to: :name
+      map_element "subdivision", to: :subdivision
+      map_element "abbreviation", to: :abbreviation
+    end
+
+    key_value do
+      map "name", to: :name
+      map "subdivision", to: :subdivision
+      map "abbreviation", to: :abbreviation
+    end
+  end
+end

data/lib/revix/person.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Person < Lutaml::Model::Serializable
+    attribute :name, Name
+
+    xml do
+      root "person"
+      map_element "name", to: :name
+    end
+
+    key_value do
+      map "name", to: :name
+    end
+  end
+end

data/lib/revix/revision.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class Revision < Lutaml::Model::Serializable
+    attribute :date, DateInfo, collection: true
+    attribute :edition, :string
+    attribute :contributor, Contributor, collection: true
+    attribute :amend, Amendment, collection: true
+    attribute :relation_type, Amendment, collection: true
+
+    xml do
+      root "revision"
+      map_element "date", to: :date
+      map_element "edition", to: :edition
+      map_element "contributor", to: :contributor
+      map_element "amend", to: :amend
+      map_element "relation", to: :relation_type
+    end
+
+    key_value do
+      map "date", to: :date
+      map "edition", to: :edition
+      map "contributor", to: :contributor
+      map "amend", to: :amend
+      map "relation", to: :relation_type
+    end
+  end
+end

data/lib/revix/revision_history.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Revix
+  class RevisionHistory < Lutaml::Model::Serializable
+    attribute :revisions, Revix::Revision, collection: true
+
+    xml do
+      root "revision-history"
+      map_element "revision", to: :revisions
+    end
+
+    key_value do
+      map "revisions", to: :revisions
+    end
+  end
+end

data/lib/revix/version.rb

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

data/lib/revix.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "revix/version"
+require "lutaml/model"
+
+module Revix
+  class Error < StandardError; end
+end
+
+require_relative "revix/name"
+require_relative "revix/person"
+require_relative "revix/organization"
+require_relative "revix/contributor"
+require_relative "revix/date_info"
+require_relative "revix/classification"
+require_relative "revix/location"
+require_relative "revix/amendment"
+require_relative "revix/revision"
+require_relative "revix/revision_history"
+
+require "lutaml/model/xml_adapter/nokogiri_adapter"
+require "lutaml/model/json_adapter/standard_json_adapter"
+require "lutaml/model/yaml_adapter/standard_yaml_adapter"
+
+Lutaml::Model::Config.configure do |config|
+  config.xml_adapter = Lutaml::Model::XmlAdapter::NokogiriAdapter
+  config.yaml_adapter = Lutaml::Model::YamlAdapter::StandardYamlAdapter
+  config.json_adapter = Lutaml::Model::JsonAdapter::StandardJsonAdapter
+end

data/revix.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/revix/version"
+
+all_files_in_git = Dir.chdir(File.expand_path(__dir__)) do
+  `git ls-files -z`.split("\x0")
+end
+
+Gem::Specification.new do |spec|
+  spec.name = "revix"
+  spec.version = Revix::VERSION
+  spec.authors = ["Ribose"]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Library to work with Metanorma document revision history."
+  spec.homepage = "https://github.com/metanorma/revix"
+  spec.license = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = all_files_in_git
+               .reject { |f| f.match(%r{\A(?:test|features|bin|\.)/}) }
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lutaml-model", "~> 0.6"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "xml-c14n"
+end

data/spec/fixtures/iho_sample.yaml

@@ -0,0 +1,75 @@
+revisions:
+  - date:
+    - type: published
+      value:  2012-04
+    edition: 1.0.0
+    contributor:
+    - organization:
+        name: International Hydrographic Organization
+        subdivision: Transfer Standard Maintenance and Application Development
+        abbreviation: TSMAD
+    amend:
+      - description: Approved edition of S-102
+  - date:
+    - type: published
+      value:  2017-03
+    edition: 2.0.0
+    contributor:
+    - organization:
+        name: International Hydrographic Organization
+        subdivision: S-102 Project Team
+        abbreviation: S-102PT
+    amend:
+      - description: >
+          Updated clause 4.0 and 12.0.
+
+          Populated clause 9.0 and Annex B.
+        location:
+          - type: clause
+            value: 4.0
+          - type: clause
+            value: 12.0
+          - type: clause
+            value: 9.0
+          - type: annex
+            value: B
+  - date:
+    - type: updated
+      value:  2017-05
+    edition: 2.0.0
+    contributor:
+    - organization:
+        name: International Hydrographic Organization
+        subdivision: S-102 Project Team
+        abbreviation: S-102PT
+    amend:
+      - description: >
+          Modified clause 9.0 based on feedback at S-100WG2 meeting.
+        location:
+          - type: clause
+            value: 9.0
+  - date:
+    - type: updated
+      value:  2018-02
+    edition: 2.0.0
+    contributor:
+    - person:
+        name:
+          completename: Cliff Kottman
+          abbreviation: CK
+    amend:
+      - description: >
+          Modified clause 9.0. Deleted contents of Annex B in preparation for updated S-100 Part 10C guidance. Added Annex F: S-102 Dataset Size and Production, Annex G: Gridding Example, Annex H: Statement added for Multi-Resolution Gridding, Annex I: Statement for future S-102 Tiling.
+        location:
+          - type: clause
+            value: 9.0
+          - type: annex
+            value: B
+          - type: annex
+            value: F
+          - type: annex
+            value: G
+          - type: annex
+            value: H
+          - type: annex
+            value: I

data/spec/fixtures/ogc_sample.yaml

@@ -0,0 +1,31 @@
+revisions:
+  - date:
+    - type: published
+      value: 2020-06-04
+    edition: 0.9.0
+    contributor:
+    - person:
+        name:
+          completename: C. Heazel
+          abbreviation: CH
+    amend:
+      - description: Draft for review
+        location:
+          - type: whole
+  - date:
+    - type: published
+      value: 2020-06-07
+    edition: 0.9.1
+    contributor:
+    - person:
+        name:
+          completename: T. H. Kolbe
+          abbreviation: THK
+    amend:
+      - description: Bibliography was added
+        location:
+          - type: clause
+            value: 10
+        classification:
+          - tag: type
+            value: editorial

data/spec/fixtures/sample.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<revision-history>
+  <revision>
+    <date>
+      <type>published</type>
+      <value>2012-04</value>
+    </date>
+    <edition>1.0.0</edition>
+    <contributor>
+      <person>
+        <name>
+          <abbreviation>JMS</abbreviation>
+          <completename>J. Michael Straczynski</completename>
+        </name>
+      </person>
+    </contributor>
+    <amend>
+      <description>Approved edition of S-102</description>
+    </amend>
+  </revision>
+  <revision>
+    <date>
+      <type>updated</type>
+      <value>2017-03</value>
+    </date>
+    <edition>2.0.0</edition>
+    <contributor>
+      <organization>
+        <name>S-102PT</name>
+      </organization>
+    </contributor>
+    <amend>
+      <description>Updated clause 4.0 and 12.0.
+
+Populated clause 9.0.</description>
+      <location type="clause">4.0</location>
+      <location type="clause">12.0</location>
+      <location type="clause">9.0</location>
+      <location type="whole"></location>
+      <classification>
+        <tag>severity</tag>
+        <value>major</value>
+      </classification>
+      <classification>
+        <tag>type</tag>
+        <value>editorial</value>
+      </classification>
+    </amend>
+    <amend>
+      <description>Deleted contents of Annex B in preparation for updated S-100 Part 10C guidance.</description>
+      <location type="annex">B</location>
+    </amend>
+  </revision>
+</revision-history>

data/spec/fixtures/sample.yaml

@@ -0,0 +1,41 @@
+revisions:
+  - date:
+    - type: published
+      value:  2012-04
+    edition: 1.0.0
+    contributor:
+    - person:
+        name:
+          abbreviation: JMS
+          completename: J. Michael Straczynski
+    amend:
+      - description: Approved edition of S-102
+  - date:
+    - type: updated
+      value:  2017-03
+    edition: 2.0.0
+    contributor:
+    - organization:
+        name: S-102PT
+    amend:
+      - description: |
+          Updated clause 4.0 and 12.0.
+
+          Populated clause 9.0.
+        location:
+          - type: clause
+            value: 4.0
+          - type: clause
+            value: 12.0
+          - type: clause
+            value: 9.0
+          - type: whole
+        classification:
+          - tag: severity
+            value: major
+          - tag: type
+            value: editorial
+      - description: Deleted contents of Annex B in preparation for updated S-100 Part 10C guidance.
+        location:
+          - type: annex
+            value: B

data/spec/models/amendment_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Revix::Amendment do
+  let(:simple_amendment_data) do
+    Revix::Amendment.new(description: "Approved edition of S-102")
+  end
+
+  let(:complex_amendment_data) do
+    locations = [
+      Revix::Location.new(type: "clause", value: "4.0"),
+      Revix::Location.new(type: "clause", value: "12.0"),
+      Revix::Location.new(type: "clause", value: "9.0"),
+      Revix::Location.new(type: "whole", value: nil)
+    ]
+
+    classifications = [
+      Revix::Classification.new(tag: "severity", value: "major"),
+      Revix::Classification.new(tag: "type", value: "editorial")
+    ]
+
+    Revix::Amendment.new(
+      description: "Updated clause 4.0 and 12.0.\n\nPopulated clause 9.0.",
+      location: locations,
+      classification: classifications,
+      change: "modify"
+    )
+  end
+
+  describe ".new" do
+    it "creates a simple Amendment object" do
+      amendment = simple_amendment_data
+      expect(amendment).to be_a(Revix::Amendment)
+      expect(amendment.description).to eq("Approved edition of S-102")
+      expect(amendment.location).to be_empty
+      expect(amendment.classification).to be_empty
+      expect(amendment.change).to eq("modify") # Default value
+    end
+
+    it "creates a complex Amendment object" do
+      amendment = complex_amendment_data
+      expect(amendment).to be_a(Revix::Amendment)
+      expect(amendment.description).to eq("Updated clause 4.0 and 12.0.\n\nPopulated clause 9.0.")
+      expect(amendment.location.size).to eq(4)
+      expect(amendment.location.first.type).to eq("clause")
+      expect(amendment.location.first.value).to eq("4.0")
+      expect(amendment.location.last.type).to eq("whole")
+      expect(amendment.location.last.value).to be_nil
+      expect(amendment.classification.size).to eq(2)
+      expect(amendment.classification.first.tag).to eq("severity")
+      expect(amendment.classification.first.value).to eq("major")
+      expect(amendment.change).to eq("modify")
+    end
+  end
+
+  describe "#to_xml" do
+    it "converts a complex Amendment object to XML" do
+      amendment = complex_amendment_data
+      xml = amendment.to_xml
+      expect(xml).to be_a(String)
+      expect(xml).to include("<amend>")
+      expect(xml).to include("<description>Updated clause 4.0 and 12.0.\n\nPopulated clause 9.0.</description>")
+      expect(xml).to include('<location type="clause">4.0</location>')
+      expect(xml).to include('<location type="clause">12.0</location>')
+      expect(xml).to include('<location type="clause">9.0</location>')
+      expect(xml).to include('<location type="whole"></location>')
+      expect(xml).to include("<tag>severity</tag>")
+      expect(xml).to include("<value>major</value>")
+      expect(xml).to include("<tag>type</tag>")
+      expect(xml).to include("<value>editorial</value>")
+      expect(xml).to include("<change>modify</change>")
+    end
+
+    it "performs round-trip conversion from XML to object and back" do
+      original = complex_amendment_data
+      xml1 = original.to_xml
+
+      # Parse back to object and generate XML again
+      parsed = Revix::Amendment.from_xml(xml1)
+      xml2 = parsed.to_xml
+
+      # Canonicalize both XMLs and compare using xml-c14n
+      c14n1 = Xml::C14n.format(xml1)
+      c14n2 = Xml::C14n.format(xml2)
+
+      expect(c14n2).to eq(c14n1)
+      expect(c14n2).to be_analogous_with(c14n1)
+    end
+  end
+end

data/spec/models/revision_history_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Revix::RevisionHistory do
+  fixture_path = File.join(__dir__, "..", "fixtures")
+  let(:yaml_content) { File.read(File.join(fixture_path, "sample.yaml")) }
+  let(:xml_content) { File.read(File.join(fixture_path, "sample.xml")) }
+  let(:iho_yaml_content) { File.read(File.join(fixture_path, "iho_sample.yaml")) }
+  let(:ogc_yaml_content) { File.read(File.join(fixture_path, "ogc_sample.yaml")) }
+
+  describe ".from_yaml" do
+    it "parses YAML content into a RevisionHistory object" do
+      history = Revix::RevisionHistory.from_yaml(yaml_content)
+      expect(history).to be_a(Revix::RevisionHistory)
+      expect(history.revisions.size).to eq(2)
+    end
+
+    it "parses IHO YAML content into a RevisionHistory object" do
+      history = Revix::RevisionHistory.from_yaml(iho_yaml_content)
+      expect(history).to be_a(Revix::RevisionHistory)
+      expect(history.revisions.size).to eq(4)
+    end
+
+    it "parses OGC YAML content into a RevisionHistory object" do
+      history = Revix::RevisionHistory.from_yaml(ogc_yaml_content)
+      expect(history).to be_a(Revix::RevisionHistory)
+      expect(history.revisions.size).to eq(2)
+    end
+  end
+
+  describe ".from_xml" do
+    it "parses XML content into a RevisionHistory object" do
+      history = Revix::RevisionHistory.from_xml(xml_content)
+      expect(history).to be_a(Revix::RevisionHistory)
+      expect(history.revisions.size).to eq(2)
+    end
+  end
+
+  describe "#to_yaml" do
+    it "converts a RevisionHistory object to YAML" do
+      history = Revix::RevisionHistory.from_yaml(yaml_content)
+      yaml = history.to_yaml
+      expect(yaml).to be_a(String)
+    end
+  end
+
+  describe "#to_xml" do
+    it "converts a RevisionHistory object to XML" do
+      history = Revix::RevisionHistory.from_yaml(yaml_content)
+      xml = history.to_xml
+      expect(xml).to be_a(String)
+      expect(xml).to include("<revision-history>")
+      expect(xml).to include("<revision>")
+    end
+
+    it "performs round-trip conversion from XML to object and back" do
+      # Start with the static XML sample
+      original_xml = xml_content
+
+      # Parse to object
+      history = Revix::RevisionHistory.from_xml(original_xml)
+
+      # Convert back to XML
+      generated_xml = history.to_xml
+
+      # Canonicalize both XMLs and compare using xml-c14n
+      c14n_original = Xml::C14n.format(original_xml)
+      c14n_generated = Xml::C14n.format(generated_xml)
+
+      expect(c14n_generated).to eq(c14n_original)
+      expect(c14n_generated).to be_analogous_with(c14n_original)
+    end
+  end
+end

data/spec/models/revision_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Revix::Revision do
+  let(:revision_data) do
+    date = [
+      Revix::DateInfo.new(type: "published", value: "2012-04")
+    ]
+    name = Revix::Name.new(abbreviation: "JMS", completename: "J. Michael Straczynski")
+    person = Revix::Person.new(name: name)
+    contributor = Revix::Contributor.new(person: person)
+    amendment = Revix::Amendment.new(description: "Approved edition of S-102")
+
+    Revix::Revision.new(
+      date: date,
+      edition: "1.0.0",
+      contributor: [contributor],
+      amend: [amendment]
+    )
+  end
+
+  describe ".new" do
+    it "creates a new Revision object" do
+      revision = revision_data
+      expect(revision).to be_a(Revix::Revision)
+      expect(revision.edition).to eq("1.0.0")
+      expect(revision.date.size).to eq(1)
+      expect(revision.date.first.type).to eq("published")
+      expect(revision.date.first.value).to eq("2012-04")
+      expect(revision.contributor.size).to eq(1)
+      expect(revision.contributor.first.person).not_to be_nil
+      expect(revision.contributor.first.person.name.abbreviation).to eq("JMS")
+      expect(revision.contributor.first.person.name.completename).to eq("J. Michael Straczynski")
+      expect(revision.amend.size).to eq(1)
+      expect(revision.amend.first.description).to eq("Approved edition of S-102")
+    end
+  end
+
+  describe "#to_xml" do
+    it "converts a Revision object to XML and back" do
+      original = revision_data
+      xml1 = original.to_xml
+
+      # Parse back to object and generate XML again
+      parsed = Revix::Revision.from_xml(xml1)
+      xml2 = parsed.to_xml
+
+      # Canonicalize both XMLs and compare using xml-c14n
+      c14n1 = Xml::C14n.format(xml1)
+      c14n2 = Xml::C14n.format(xml2)
+
+      expect(c14n2).to eq(c14n1)
+      expect(c14n2).to be_analogous_with(c14n1)
+    end
+  end
+end

data/spec/revix_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Revix do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "revix"
+require "xml/c14n"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: revix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-c14n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.adoc
+- Rakefile
+- lib/revix.rb
+- lib/revix/amendment.rb
+- lib/revix/classification.rb
+- lib/revix/contributor.rb
+- lib/revix/date_info.rb
+- lib/revix/location.rb
+- lib/revix/name.rb
+- lib/revix/organization.rb
+- lib/revix/person.rb
+- lib/revix/revision.rb
+- lib/revix/revision_history.rb
+- lib/revix/version.rb
+- revix.gemspec
+- spec/fixtures/iho_sample.yaml
+- spec/fixtures/ogc_sample.yaml
+- spec/fixtures/sample.xml
+- spec/fixtures/sample.yaml
+- spec/models/amendment_spec.rb
+- spec/models/revision_history_spec.rb
+- spec/models/revision_spec.rb
+- spec/revix_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/metanorma/revix
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/revix
+  source_code_uri: https://github.com/metanorma/revix
+  bug_tracker_uri: https://github.com/metanorma/revix/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Library to work with Metanorma document revision history.
+test_files: []