metanorma-document 0.2.0

data/lib/metanorma/standard_document/terms/term_source.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The bibliographic source where a term is defined in the
+      # sense applicable in this _StandardDocument_.
+      class TermSource < Lutaml::Model::Serializable
+        attribute :status, Metanorma::StandardDocument::Terms::TermSourceStatus
+        attribute :status, :string
+        attribute :origin, Metanorma::Document::Components::ReferenceElements::Citation
+        attribute :modification, Metanorma::Document::Components::Paragraphs::ParagraphBlock
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "termsource"
+          map_attribute "status", to: :status
+          map_element "origin", to: :origin
+          map_element "modification", to: :modification
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/term_source_status.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The status of a term as it is used in this document, relative to its definition in the original
+      # document.
+      class TermSourceStatus < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[identical modified restyled context-added generalisation
+             specialisation unspecified]
+        end
+
+        xml do
+          element "term-source-status"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/term_source_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The type of the managed term in the present context.
+      class TermSourceType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        def self.values
+          %w[authoritative lineage]
+        end
+
+        xml do
+          element "term-source-type"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/verbal_expression.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Verbal expression of the term.
+      class VerbalExpression < Lutaml::Model::Serializable
+        attribute :paragraph,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
+        attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :dl, Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+
+        # Presentation-specific attributes
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "verbal-definition"
+          map_element "p", to: :paragraph
+          map_element "ol", to: :ol
+          map_element "ul", to: :ul
+          map_element "dl", to: :dl
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      autoload :AbbreviationType, "#{__dir__}/terms/abbreviation_type"
+      autoload :Concept, "#{__dir__}/terms/concept"
+      autoload :DefinitionCollection, "#{__dir__}/terms/definition_collection"
+      autoload :Designation, "#{__dir__}/terms/designation"
+      autoload :ExpressionDesignation, "#{__dir__}/terms/expression_designation"
+      autoload :ExpressionType, "#{__dir__}/terms/expression_type"
+      autoload :GrammarGender, "#{__dir__}/terms/grammar_gender"
+      autoload :GrammarInfo, "#{__dir__}/terms/grammar_info"
+      autoload :GraphicalSymbolDesignation,
+               "#{__dir__}/terms/graphical_symbol_designation"
+      autoload :LetterSymbolDesignation,
+               "#{__dir__}/terms/letter_symbol_designation"
+      autoload :NonVerbalRepresentation,
+               "#{__dir__}/terms/non_verbal_representation"
+      autoload :RelatedTerm, "#{__dir__}/terms/related_term"
+      autoload :RelatedTermType, "#{__dir__}/terms/related_term_type"
+      autoload :Term, "#{__dir__}/terms/term"
+      autoload :TermCollection, "#{__dir__}/terms/term_collection"
+      autoload :TermDefinition, "#{__dir__}/terms/term_definition"
+      autoload :TermSource, "#{__dir__}/terms/term_source"
+      autoload :TermSourceStatus, "#{__dir__}/terms/term_source_status"
+      autoload :TermSourceType, "#{__dir__}/terms/term_source_type"
+      autoload :VerbalExpression, "#{__dir__}/terms/verbal_expression"
+    end
+  end
+end

data/lib/metanorma/standard_document.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "metanorma/document"
+
+module Metanorma
+  module StandardDocument
+    autoload :Blocks, "metanorma/standard_document/blocks"
+    autoload :Elements, "metanorma/standard_document/elements"
+    autoload :Lists, "metanorma/standard_document/lists"
+    autoload :Metadata, "metanorma/standard_document/metadata"
+    autoload :Namespace, "metanorma/standard_document/namespace"
+    autoload :Refs, "metanorma/standard_document/refs"
+    autoload :Root, "metanorma/standard_document/root"
+    autoload :Sections, "metanorma/standard_document/sections"
+    autoload :StandardDocumentType,
+             "metanorma/standard_document/standard_document_type"
+    autoload :Terms, "metanorma/standard_document/terms"
+  end
+end

data/metanorma-document.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/metanorma/document/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-document"
+  spec.version       = Metanorma::Document::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Library for Metanorma document XML"
+  spec.description   = "A Ruby library for representing and processing Metanorma document XML, providing a comprehensive model for standards documents with support for various metadata, content blocks, and structured markup."
+  spec.homepage      = "https://github.com/metanorma/metanorma-document"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/metanorma-document"
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/metanorma-document/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
+end