edoxen 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5b96952dff52eca74ca77c35534cf68e380e57694eec5f308fe855b306bd3b2
+  data.tar.gz: c19d66b0f115b74562a01d04a19e1416f2ee7414010d7cca991f84ee37c39245
+SHA512:
+  metadata.gz: d44772650c4943aa5d487969edb49db47a8078ff7544fe68d7d581e238eb4d1d8b1c4268919cbd823b5f7787c2edf81040b7342ae05392ccfe21e1159f5e9e34
+  data.tar.gz: 0e079b28ade73d23191d517fbf676fd22f2a1584670575b1d3ad42bbc18673c02836feba67191d72733aee37be1aa27abb6f5b087aac824fa71132889249cd72

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,96 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-07-18 13:23:46 UTC using RuboCop version 1.78.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
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'edoxen.gemspec'
+
+# Offense count: 13
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'lib/edoxen/action.rb'
+    - 'lib/edoxen/approval.rb'
+    - 'lib/edoxen/consideration.rb'
+    - 'lib/edoxen/meeting_identfier.rb'
+    - 'lib/edoxen/resolution.rb'
+    - 'lib/edoxen/resolution_collection.rb'
+    - 'lib/edoxen/resolution_date.rb'
+    - 'lib/edoxen/resolution_relationship.rb'
+    - 'lib/edoxen/structured_identifier.rb'
+    - 'lib/edoxen/subject_body.rb'
+    - 'spec/edoxen/action_spec.rb'
+    - 'spec/edoxen/resolution_collection_spec.rb'
+    - 'spec/edoxen/resolution_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 123
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/EmptyFile:
+  Exclude:
+    - 'lib/edoxen/meeting.rb'
+
+# Offense count: 14
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 234
+
+# Offense count: 10
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/edoxen.rb'
+    - 'lib/edoxen/action.rb'
+    - 'lib/edoxen/approval.rb'
+    - 'lib/edoxen/consideration.rb'
+    - 'lib/edoxen/meeting_identfier.rb'
+    - 'lib/edoxen/resolution.rb'
+    - 'lib/edoxen/resolution_collection.rb'
+    - 'lib/edoxen/resolution_relationship.rb'
+    - 'lib/edoxen/structured_identifier.rb'
+    - 'lib/edoxen/subject_body.rb'
+
+# Offense count: 13
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/*.arb'
+    - 'lib/edoxen/action.rb'
+    - 'lib/edoxen/approval.rb'
+    - 'lib/edoxen/consideration.rb'
+    - 'lib/edoxen/meeting_identfier.rb'
+    - 'lib/edoxen/resolution.rb'
+    - 'lib/edoxen/resolution_collection.rb'
+    - 'lib/edoxen/resolution_date.rb'
+    - 'lib/edoxen/resolution_relationship.rb'
+    - 'lib/edoxen/structured_identifier.rb'
+    - 'lib/edoxen/subject_body.rb'
+    - 'spec/edoxen/action_spec.rb'
+    - 'spec/edoxen/resolution_collection_spec.rb'
+    - 'spec/edoxen/resolution_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 123

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 ronald.tse@ribose.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in edoxen.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/README.adoc

@@ -0,0 +1,258 @@
+= Edoxen
+
+https://github.com/metanorma/edoxen[image:https://img.shields.io/github/stars/metanorma/edoxen.svg?style=social[GitHub Stars]]
+https://github.com/metanorma/edoxen[image:https://img.shields.io/github/forks/metanorma/edoxen.svg?style=social[GitHub Forks]]
+image:https://img.shields.io/github/license/metanorma/edoxen.svg[License]
+image:https://img.shields.io/github/actions/workflow/status/metanorma/edoxen/test.yml?branch=main[Build Status]
+image:https://img.shields.io/gem/v/edoxen.svg[RubyGems Version]
+
+== Purpose
+
+Edoxen is a set of information models used for representing resolution and
+decision information. They are designed to provide a structured way to model
+formal resolutions, including their metadata, actions, considerations, and
+approvals.
+
+The `edoxen` gem provides a Ruby library for working with these models,
+allowing users to create, manipulate, and serialize resolution data in a
+structured format. It is built on top of the `lutaml-model` serialization
+framework, which provides a flexible and extensible way to define data models
+and serialize them to YAML or JSON formats.
+
+This library is particularly useful for standards organizations, committees,
+and governance bodies that need to maintain structured records of their
+decision-making processes.
+
+
+== Origin
+
+"Edoxen" is how all resolutions of Ancient Athens started.
+
+____
+"It was the opinion of... (the people and city that...)"
+____
+
+The word "edoxen" originates from the Ancient Greek word edokeō (ἔδοξεν),
+meaning "it was the opinion of" or "it seemed good to". This term was used in
+the context of formal resolutions and decisions made by the Athenian assembly,
+reflecting the collective will and judgment of the citizens.
+
+
+== Features
+
+* Classes for modeling resolutions, actions, considerations, and approvals
+* Support for resolution collections with metadata
+* YAML and JSON serialization with round-trip compatibility
+* Structured identifiers and meeting information
+* Resolution relationships and dependencies
+* Integration with the `lutaml-model` serialization framework
+* Comprehensive YAML schema for validation
+* Real-world data compatibility with ISO/TC 154 resolution formats
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'edoxen'
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install edoxen
+----
+
+== Quick start
+
+Here's a minimal example to get you started:
+
+[source,ruby]
+----
+require 'edoxen'
+
+# Create a simple resolution
+resolution = Edoxen::Resolution.new(
+  title: "Adoption of new standard",
+  type: "resolution",
+  category: "Technical resolutions",
+  identifier: "2024-01"
+)
+
+# Add an action to the resolution
+action = Edoxen::Action.new(
+  type: "resolves",
+  message: "to adopt ISO 12345 as a new standard",
+  date_effective: Date.new(2024, 1, 15)
+)
+resolution.actions = [action]
+
+# Add a consideration
+consideration = Edoxen::Consideration.new(
+  type: "having",
+  message: "reviewed the technical specifications"
+)
+resolution.considerations = [consideration]
+
+# Serialize to YAML
+puts resolution.to_yaml
+
+# Create a resolution collection
+collection = Edoxen::ResolutionCollection.new(
+  metadata: {
+    title: "Resolutions of the 42nd plenary meeting",
+    date: "2024-01-15",
+    source: "ISO/TC 154 Secretariat"
+  },
+  resolutions: [resolution]
+)
+
+# Serialize collection to YAML
+puts collection.to_yaml
+----
+
+== Documentation
+
+=== Data models
+
+The library provides these main model classes:
+
+`Edoxen::Resolution`::
+Core model representing a formal resolution with title, type, category, and
+associated elements.
+
+`Edoxen::ResolutionCollection`::
+Container for multiple resolutions with metadata about the meeting or
+collection context.
+
+`Edoxen::Action`::
+Represents actions taken within a resolution (e.g., "resolves", "requests",
+"thanks").
+
+`Edoxen::Consideration`::
+Models considerations that lead to a resolution (e.g., "having", "noting",
+"recognizing").
+
+`Edoxen::Approval`::
+Captures approval information including type and degree of consensus.
+
+`Edoxen::MeetingIdentifier`::
+Contains meeting identification information such as venue, date, and identifier.
+
+`Edoxen::ResolutionRelationship`::
+Defines relationships between resolutions (e.g., "supersedes", "amends").
+
+=== Architecture overview
+
+The library is built on `lutaml-model` and follows these design principles:
+
+**Model-based approach**::
+Each entity is represented as a Ruby class with defined attributes and
+serialization mappings.
+
+**Flexible serialization**::
+Support for both YAML and JSON formats with automatic type conversion and
+round-trip compatibility.
+
+**Extensible structure**::
+Models allow additional properties beyond the core schema, enabling
+customization for specific organizational needs.
+
+**Real-world compatibility**::
+Designed to work with existing resolution data formats used by standards
+organizations.
+
+== Usage workflow
+
+The `edoxen` workflow follows a straightforward approach:
+
+=== 1. Data modeling
+
+. **Create resolutions**: Instantiate `Resolution` objects with required
+  attributes
+. **Add components**: Attach actions, considerations, approvals as needed
+. **Build collections**: Group resolutions into collections with metadata
+
+=== 2. Serialization and persistence
+
+. **Export to YAML/JSON**: Use built-in serialization methods
+. **Validate structure**: Leverage the provided YAML schema for validation
+. **Round-trip processing**: Load and save data while preserving structure
+
+== YAML format specification
+
+Edoxen uses a structured YAML format for resolution data. Here's an example:
+
+[source,yaml]
+----
+metadata:
+  title: "Resolutions of the 42nd plenary meeting of ISO/TC 154"
+  date: "2024-01-15"
+  source: "ISO/TC 154 Secretariat"
+  venue: "Virtual meeting"
+
+resolutions:
+  - identifier: "2024-01"
+    title: "Adoption of new standard"
+    type: "resolution"
+    category: "Technical resolutions"
+
+    considerations:
+      - type: "having"
+        message: "reviewed the technical specifications"
+
+    actions:
+      - type: "resolves"
+        message: "to adopt ISO 12345 as a new standard"
+        date_effective: "2024-01-15"
+
+    approvals:
+      - type: "affirmative"
+        degree: "unanimous"
+----
+
+=== Schema validation
+
+A comprehensive YAML schema is provided at `schema/edoxen.yaml` for validating
+resolution data files. The schema follows JSON Schema Draft 7 conventions and
+includes:
+
+* Complete structure definitions for all model types
+* Enumerated values for type validation
+* Date format validation
+* Flexible extensibility with `additionalProperties`
+
+The schema can be used with standard JSON Schema validators to ensure data
+integrity and compliance.
+
+== Real-world examples
+
+The library has been tested with real resolution data from ISO/TC 154 and
+other standards organizations. It successfully handles:
+
+* Complex resolution structures with multiple actions and considerations
+* Various resolution types (resolutions, recommendations, decisions)
+* Meeting metadata and organizational information
+* Cross-references and relationships between resolutions
+* Historical data migration and format conversion
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/metanorma/edoxen.
+
+== License and Copyright
+
+This project is licensed under the BSD 2-clause License.
+See the link:LICENSE[] 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/edoxen.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/edoxen/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "edoxen"
+  spec.version = Edoxen::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Edoxen is a set of information models used for representing resolution and decision information."
+  spec.description = <<~HEREDOC
+    Edoxen provides a Ruby library for working with resolution models, allowing users to create, manipulate, and serialize resolution data in a structured format. It is built on top of the lutaml-model serialization framework, which provides a flexible and extensible way to define data models and serialize them to YAML or JSON formats.
+  HEREDOC
+
+  spec.homepage = "https://github.com/metanorma/edoxen"
+  spec.license = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/edoxen"
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/edoxen"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lutaml-model", "~> 0.7"
+end

data/lib/edoxen/action.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Edoxen
+  class Action < Lutaml::Model::Serializable
+    ACTION_TYPE_ENUM = %w[
+      adopts thanks approves decides declares asks invites resolves confirms
+      welcomes recommends requests congratulates instructs urges appoints
+      resolves further instructs calls-upon encourages affirms elects
+      authorizes charges states remarks judges sanctions abrogates empowers
+    ].freeze
+
+    attribute :type, :string, values: ACTION_TYPE_ENUM
+    attribute :date_effective, :date
+    attribute :message, :string
+    attribute :subject, :string
+
+    key_value do
+      map "type", to: :type
+      map "date_effective", to: :date_effective
+      map "message", to: :message
+      map "subject", to: :subject
+    end
+  end
+end
+
+# Action {
+#   type: ActionType
+#   dateEffective: Date
+#   message: Text
+# }
+
+# enum ActionType {
+#   adopts
+#   thanks / expresses-appreciation (subjects)
+#   approves
+#   decides
+#   declares
+#   asks (subjects)
+#   invites / further invites (subjects)
+#   resolves
+#   confirms
+#   welcomes (subjects)
+#   recommends
+#   requests (subjects)
+#   congratulates (subjects)
+#   instructs (subjects)
+#   urges (subjects)
+#   appoints (subjects)
+#   resolves further
+#   instructs (subjects)
+#   calls upon (subjects)
+#   encourages (subjects)
+#   affirms / reaffirming (subjects)
+#   elects
+#   authorizes
+#   charges
+#   states
+#   remarks
+#   judges
+#   sanctions
+#   abrogates
+#   empowers
+# }

data/lib/edoxen/approval.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Approval {
+#   type: ApprovalType
+#   degree: ApprovalDegree
+#   date: Date
+#   message: Text
+# }
+
+# enum ApprovalType {
+#   affirmative
+#   negative
+# }
+
+# enum ApprovalDegree {
+#   unanimous
+#   majority
+#   minority
+# }
+require "lutaml/model"
+
+module Edoxen
+  class Approval < Lutaml::Model::Serializable
+    APPROVAL_TYPE_ENUM = %w[affirmative negative].freeze
+    APPROVAL_DEGREE_ENUM = %w[unanimous majority minority].freeze
+
+    attribute :type, :string, values: APPROVAL_TYPE_ENUM
+    attribute :degree, :string, values: APPROVAL_DEGREE_ENUM
+    attribute :date, :date
+    attribute :message, :string
+
+    key_value do
+      map "type", to: :type
+      map "degree", to: :degree
+      map "date", to: :date
+      map "message", to: :message
+    end
+  end
+end

data/lib/edoxen/consideration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Consideration {
+#   type: ConsiderationType
+#   dateEffective: Date
+#   message: Text
+# }
+
+# enum ConsiderationType {
+#   having / having regard
+#   noting
+#   recognizing
+#   acknowledging
+#   recalling / further recalling
+#   reaffirming
+#   considering
+#   taking into account
+#   pursuant to
+#   bearing in mind
+#   emphasizing
+#   concerned
+#   accepts
+#   observing
+#   referring
+#   acting
+#   empowers
+#   reaffirming
+# }
+
+require "lutaml/model"
+
+module Edoxen
+  class Consideration < Lutaml::Model::Serializable
+    CONSIDERATION_TYPE_ENUM = %w[having noting recognizing acknowledging recalling reaffirming considering
+                                 taking-into-account pursuant-to bearing-in-mind emphasizing concerned accepts observing
+                                 referring acting empowers reaffirming].freeze
+
+    attribute :type, :string, values: CONSIDERATION_TYPE_ENUM
+    attribute :date, :date
+    attribute :message, :string
+
+    key_value do
+      map "type", to: :type
+      map "date", to: :date
+      map "message", to: :message
+    end
+  end
+end

data/lib/edoxen/meeting_identfier.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# MeetingIdentifier {
+#   venue: String
+#   date: DateTime
+# }
+require "lutaml/model"
+
+module Edoxen
+  class MeetingIdentifier < Lutaml::Model::Serializable
+    attribute :venue, :string
+    attribute :date, :date
+
+    key_value do
+      map "venue", to: :venue
+      map "date", to: :date
+    end
+  end
+end

data/lib/edoxen/resolution.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Edoxen
+  class Resolution < Lutaml::Model::Serializable
+    RESOLUTION_TYPE_ENUM = %w[resolution recommendation decision declaration].freeze
+
+    attribute :category, :string
+    attribute :dates, :date, collection: true
+    attribute :subject, :string
+    attribute :title, :string
+    attribute :type, :string, values: RESOLUTION_TYPE_ENUM
+    attribute :identifier, :string
+    attribute :considerations, Consideration, collection: true
+    attribute :approvals, Approval, collection: true
+    attribute :actions, Action, collection: true
+
+    key_value do
+      map "category", to: :category
+      map "dates", to: :dates
+      map "subject", to: :subject
+      map "title", to: :title
+      map "type", to: :type
+      map "identifier", to: :identifier
+      map "considerations", to: :considerations
+      map "approvals", to: :approvals
+      map "actions", to: :actions
+    end
+
+    # Example of a Resolution
+    # category: Resolutions related to JWG 1
+    # dates:
+    #   - 2019-10-17
+    # subject: ISO/TC 154
+    # title: "Adoption of NWIP ballot for ISO/PWI 9735-11 "Electronic data..."
+    # identifier: 2019-01
+    # considerations:
+    #   - type: considering
+    #     date_effective: 2019-10-17
+    #     message: considering the voting result ...
+
+    #   - type: considering
+    #     date_effective: 2019-10-17
+    #     message: considering the importance of ...
+
+    #   - type: considering
+    #     date_effective: 2019-10-17
+    #     message: considering the request from JWG1...
+
+    # approvals:
+    #   - type: affirmative
+    #     degree: unanimous
+    #     message: The resolution was taken by unanimity.
+
+    # actions:
+    #   - type: resolves
+    #     date_effective: 2019-10-17
+    #     message: resolves to submit ISO 9735-11...
+  end
+end

data/lib/edoxen/resolution_collection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Edoxen
+  class ResolutionCollection < Lutaml::Model::Serializable
+    attribute :metadata, :hash
+    attribute :resolutions, Resolution, collection: true
+
+    key_value do
+      map "metadata", to: :metadata
+      map "resolutions", to: :resolutions
+    end
+
+    # Example of a ResolutionCollection
+    # metadata:
+    #   title: Resolutions of the 38th plenary meeting of ISO/TC 154
+    #   date: 2019-10-17
+    #   source: ISO/TC 154 Secretariat
+    # resolutions:
+    #   - category: Resolutions related to JWG 1
+    #     dates: 2019/10/17
+    #     ...
+  end
+end

data/lib/edoxen/resolution_date.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# class ResolutionRelation {
+#   source: StructuredIdentifier (Resolution)
+#   destination: StructuredIdentifier (Resolution)
+#   type: ResolutionRelationType
+# }
+
+# enum ResolutionRelationType {
+#   annexOf {
+#     This resolution is an annex to the target resolution.
+#   }
+
+#   hasAnnex {
+#     The target resolution is an annex of the source resolution.
+#   }
+
+#   updates {
+#     This resolution updates the target resolution.
+#   }
+
+#   refines {
+#     This resolution refines the target resolution.
+#   }
+
+#   replaces/obsoletes {
+#     This resolution replaces/obsoletes the target resolution.
+#   }
+
+#   considers {
+#     This resolution is made in consideration of the target resolution.
+#   }
+# }

data/lib/edoxen/resolution_relationship.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# class ResolutionRelation {
+#   source: StructuredIdentifier (Resolution)
+#   destination: StructuredIdentifier (Resolution)
+#   type: ResolutionRelationType
+# }
+
+# enum ResolutionRelationType {
+#   annexOf {
+#     This resolution is an annex to the target resolution.
+#   }
+
+#   hasAnnex {
+#     The target resolution is an annex of the source resolution.
+#   }
+
+#   updates {
+#     This resolution updates the target resolution.
+#   }
+
+#   refines {
+#     This resolution refines the target resolution.
+#   }
+
+#   replaces/obsoletes {
+#     This resolution replaces/obsoletes the target resolution.
+#   }
+
+#   considers {
+#     This resolution is made in consideration of the target resolution.
+#   }
+# }
+
+require "lutaml/model"
+
+module Edoxen
+  class ResolutionRelationship < Lutaml::Model::Serializable
+    RESOLUTION_RELATIONSHIP_ENUM = %w[annexOf hasAnnex updates refines replaces obsoletes considers].freeze
+
+    attribute :source, :string
+    attribute :destination, :string
+    attribute :type, :string, values: RESOLUTION_RELATIONSHIP_ENUM
+
+    key_value do
+      map "source", to: :source
+      map "destination", to: :destination
+      map "type", to: :type
+    end
+  end
+end

data/lib/edoxen/structured_identifier.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# StructuredIdentifier {
+#   number:
+#   prefix:
+# }
+
+require "lutaml/model"
+
+module Edoxen
+  class StructuredIdentifier < Lutaml::Model::Serializable
+    attribute :number, :string
+    attribute :prefix, :string
+
+    key_value do
+      map "number", to: :number
+      map "prefix", to: :prefix
+    end
+  end
+end

data/lib/edoxen/subject_body.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# SubjectBody {
+#   name
+#   address
+#   etc.
+# }
+require "lutaml/model"
+
+module Edoxen
+  class SubjectBody < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :address, :string
+
+    key_value do
+      map "name", to: :name
+      map "address", to: :address
+    end
+  end
+end

data/lib/edoxen/version.rb

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

data/lib/edoxen.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+require_relative "edoxen/version"
+
+# Configure lutaml-model for YAML serialization
+Lutaml::Model::Config.configure do |config|
+  config.yaml_adapter_type = :standard_yaml
+  config.json_adapter_type = :standard_json
+end
+
+module Edoxen
+  class Error < StandardError; end
+
+  # Load all model classes
+  require_relative "edoxen/action"
+  require_relative "edoxen/approval"
+  require_relative "edoxen/consideration"
+  require_relative "edoxen/meeting"
+  require_relative "edoxen/resolution"
+  require_relative "edoxen/resolution_collection"
+  require_relative "edoxen/resolution_date"
+  require_relative "edoxen/resolution_relationship"
+  require_relative "edoxen/structured_identifier"
+  require_relative "edoxen/subject_body"
+  require_relative "edoxen/meeting_identfier"
+end

data/schema/edoxen.yaml

@@ -0,0 +1,286 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
+---
+$schema: "http://json-schema.org/draft-07/schema#"
+$id: "https://github.com/metanorma/edoxen/schema/edoxen.yaml"
+title: "Edoxen Resolution Collection Schema"
+description: "Schema for validating Edoxen resolution collection YAML files"
+type: object
+
+properties:
+  metadata:
+    type: object
+    description: "Metadata about the resolution collection"
+    properties:
+      title:
+        type: string
+        description: "Title of the resolution collection"
+      date:
+        type: string
+        format: date
+        description: "Date of the meeting or collection (YYYY-MM-DD)"
+      source:
+        type: string
+        description: "Source organization or secretariat"
+      venue:
+        type: string
+        description: "Meeting venue"
+      chair:
+        type: string
+        description: "Meeting chair"
+    additionalProperties: false
+
+  resolutions:
+    type: array
+    description: "Array of resolutions"
+    items:
+      $ref: "#/$defs/Resolution"
+
+required:
+  - resolutions
+
+$defs:
+  Resolution:
+    type: object
+    description: "A single resolution"
+    properties:
+      identifier:
+        oneOf:
+          - type: string
+          - type: integer
+        description: "Resolution identifier (e.g., '2019-01' or 1)"
+
+      title:
+        type: string
+        description: "Resolution title"
+
+      type:
+        type: string
+        enum:
+          - "resolution"
+          - "recommendation"
+          - "decision"
+          - "declaration"
+        description: "Type of resolution"
+
+      category:
+        type: string
+        description: "Resolution category"
+
+      subject:
+        type: string
+        description: "Subject or scope of the resolution"
+
+      dates:
+        type: array
+        items:
+          type: string
+          format: date
+        description: "Array of relevant dates"
+
+      considerations:
+        type: array
+        items:
+          $ref: "#/$defs/Consideration"
+        description: "Considerations leading to the resolution"
+
+      approvals:
+        type: array
+        items:
+          $ref: "#/$defs/Approval"
+        description: "Approval information"
+
+      actions:
+        type: array
+        items:
+          $ref: "#/$defs/Action"
+        description: "Actions taken in the resolution"
+
+      meeting:
+        $ref: "#/$defs/MeetingIdentifier"
+        description: "Meeting information"
+
+      relationships:
+        type: array
+        items:
+          $ref: "#/$defs/ResolutionRelationship"
+        description: "Relationships to other resolutions"
+
+    required:
+      - title
+    additionalProperties: false
+
+  Consideration:
+    type: object
+    description: "A consideration leading to a resolution"
+    properties:
+      type:
+        type: string
+        enum:
+          - "having"
+          - "noting"
+          - "recognizing"
+          - "acknowledging"
+          - "considering"
+          - "recalling"
+          - "welcoming"
+          - "appreciating"
+        description: "Type of consideration"
+
+      date_effective:
+        type: string
+        format: date
+        description: "Effective date of the consideration"
+
+      message:
+        type: string
+        description: "Consideration text"
+
+      subject:
+        type: string
+        description: "Subject of the consideration"
+
+    additionalProperties: false
+
+  Approval:
+    type: object
+    description: "Approval information for a resolution"
+    properties:
+      type:
+        type: string
+        enum:
+          - "affirmative"
+          - "negative"
+        description: "Type of approval"
+
+      degree:
+        type: string
+        enum:
+          - "unanimous"
+          - "majority"
+          - "minority"
+        description: "Degree of approval"
+
+      message:
+        type: string
+        description: "Approval details"
+
+    additionalProperties: false
+
+  Action:
+    type: object
+    description: "An action taken in a resolution"
+    properties:
+      type:
+        type: string
+        enum:
+          - "adopts"
+          - "thanks"
+          - "approves"
+          - "decides"
+          - "declares"
+          - "resolves"
+          - "requests"
+          - "recommends"
+          - "encourages"
+          - "welcomes"
+          - "notes"
+          - "confirms"
+          - "reaffirms"
+          - "withdraws"
+          - "abrogates"
+          - "establishes"
+          - "appoints"
+          - "nominates"
+          - "extends"
+          - "initiates"
+        description: "Type of action"
+
+      date_effective:
+        type: string
+        format: date
+        description: "Effective date of the action"
+
+      message:
+        type: string
+        description: "Action text"
+
+      subject:
+        type: string
+        description: "Subject of the action"
+
+    additionalProperties: false
+
+  MeetingIdentifier:
+    type: object
+    description: "Meeting identification information"
+    properties:
+      venue:
+        type: string
+        description: "Meeting venue"
+
+      date:
+        type: string
+        format: date
+        description: "Meeting date"
+
+      identifier:
+        type: string
+        description: "Meeting identifier"
+
+    additionalProperties: false
+
+  ResolutionRelationship:
+    type: object
+    description: "Relationship between resolutions"
+    properties:
+      type:
+        type: string
+        enum:
+          - "supersedes"
+          - "amends"
+          - "references"
+          - "replaces"
+          - "updates"
+        description: "Type of relationship"
+
+      target:
+        type: string
+        description: "Target resolution identifier"
+
+      description:
+        type: string
+        description: "Description of the relationship"
+
+    additionalProperties: false
+
+  StructuredIdentifier:
+    type: object
+    description: "Structured identifier with prefix and number"
+    properties:
+      prefix:
+        type: string
+        description: "Identifier prefix"
+
+      number:
+        oneOf:
+          - type: string
+          - type: integer
+        description: "Identifier number"
+
+    additionalProperties: false
+
+  SubjectBody:
+    type: object
+    description: "Subject body information"
+    properties:
+      name:
+        type: string
+        description: "Name of the subject body"
+
+      address:
+        type: string
+        description: "Address of the subject body"
+
+    additionalProperties: false
+
+additionalProperties: false

data/sig/edoxen.rbs

@@ -0,0 +1,4 @@
+module Edoxen
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: edoxen
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-07-18 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.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 'Edoxen provides a Ruby library for working with resolution models, allowing
+  users to create, manipulate, and serialize resolution data in a structured format.
+  It is built on top of the lutaml-model serialization framework, which provides a
+  flexible and extensible way to define data models and serialize them to YAML or
+  JSON formats.
+
+  '
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- edoxen.gemspec
+- lib/edoxen.rb
+- lib/edoxen/action.rb
+- lib/edoxen/approval.rb
+- lib/edoxen/consideration.rb
+- lib/edoxen/meeting.rb
+- lib/edoxen/meeting_identfier.rb
+- lib/edoxen/resolution.rb
+- lib/edoxen/resolution_collection.rb
+- lib/edoxen/resolution_date.rb
+- lib/edoxen/resolution_relationship.rb
+- lib/edoxen/structured_identifier.rb
+- lib/edoxen/subject_body.rb
+- lib/edoxen/version.rb
+- schema/edoxen.yaml
+- sig/edoxen.rbs
+homepage: https://github.com/metanorma/edoxen
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/edoxen
+  source_code_uri: https://github.com/metanorma/edoxen
+  changelog_uri: https://github.com/metanorma/edoxen
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.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: Edoxen is a set of information models used for representing resolution and
+  decision information.
+test_files: []