tbx 0.1.0

data/lib/tbx/term_sec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Tbx
+  class TermSec < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :term, ::Tbx::Term
+    attribute :term_note, ::Tbx::TermNote, collection: true
+    attribute :term_note_grp, ::Tbx::TermNoteGrp, collection: true
+    attribute :admin, ::Tbx::Admin, collection: true
+    attribute :admin_grp, ::Tbx::AdminGrp, collection: true
+    attribute :descrip, ::Tbx::Descrip, collection: true
+    attribute :descrip_grp, ::Tbx::DescripGrp, collection: true
+    attribute :note, ::Tbx::Note, collection: true
+    attribute :ref, ::Tbx::Ref, collection: true
+    attribute :transac_grp, ::Tbx::TransacGrp, collection: true
+    attribute :xref, ::Tbx::Xref, collection: true
+
+    xml do
+      root "termSec"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      map_element "term", to: :term
+      map_element "termNote", to: :term_note
+      map_element "termNoteGrp", to: :term_note_grp
+      map_element "admin", to: :admin
+      map_element "adminGrp", to: :admin_grp
+      map_element "descrip", to: :descrip
+      map_element "descripGrp", to: :descrip_grp
+      map_element "note", to: :note
+      map_element "ref", to: :ref
+      map_element "transacGrp", to: :transac_grp
+      map_element "xref", to: :xref
+    end
+  end
+end

data/lib/tbx/text_element.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tbx
+  class TextElement < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :body, ::Tbx::Body
+    attribute :back, ::Tbx::Back
+
+    xml do
+      root "text"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      map_element "body", to: :body
+      map_element "back", to: :back
+    end
+  end
+end

data/lib/tbx/title.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tbx
+  class Title < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :lang, Lutaml::Xml::W3c::XmlLangType
+    attribute :content, :string, collection: true
+
+    xml do
+      root "title"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      w3c_attributes :lang
+      map_content to: :content
+    end
+  end
+end

data/lib/tbx/title_stmt.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tbx
+  class TitleStmt < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :lang, Lutaml::Xml::W3c::XmlLangType
+    attribute :title, ::Tbx::Title
+    attribute :note, ::Tbx::Note, collection: true
+
+    xml do
+      root "titleStmt"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      w3c_attributes :lang
+      map_element "title", to: :title
+      map_element "note", to: :note
+    end
+  end
+end

data/lib/tbx/transac.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Tbx
+  class Transac < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :lang, Lutaml::Xml::W3c::XmlLangType
+    attribute :target, :string
+    attribute :datatype, :string
+    attribute :type, :string
+    attribute :content, :string, collection: true
+
+    xml do
+      root "transac"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      w3c_attributes :lang
+      map_attribute "target", to: :target
+      map_attribute "datatype", to: :datatype
+      map_attribute "type", to: :type
+      map_content to: :content
+    end
+  end
+end

data/lib/tbx/transac_grp.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tbx
+  class TransacGrp < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :transac, ::Tbx::Transac
+    attribute :date, ::Tbx::DateElement, collection: true
+    attribute :note, ::Tbx::Note, collection: true
+    attribute :ref, ::Tbx::Ref, collection: true
+    attribute :transac_note, ::Tbx::TransacNote, collection: true
+    attribute :xref, ::Tbx::Xref, collection: true
+
+    xml do
+      root "transacGrp"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      map_element "transac", to: :transac
+      map_element "date", to: :date
+      map_element "note", to: :note
+      map_element "ref", to: :ref
+      map_element "transacNote", to: :transac_note
+      map_element "xref", to: :xref
+    end
+  end
+end

data/lib/tbx/transac_note.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Tbx
+  class TransacNote < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :lang, Lutaml::Xml::W3c::XmlLangType
+    attribute :target, :string
+    attribute :datatype, :string
+    attribute :type, :string
+    attribute :content, :string, collection: true
+
+    xml do
+      root "transacNote"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      w3c_attributes :lang
+      map_attribute "target", to: :target
+      map_attribute "datatype", to: :datatype
+      map_attribute "type", to: :type
+      map_content to: :content
+    end
+  end
+end

data/lib/tbx/version.rb

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

data/lib/tbx/xref.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tbx
+  class Xref < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :target, :string
+    attribute :type, :string
+    attribute :content, :string, collection: true
+
+    xml do
+      root "xref"
+      mixed_content
+      namespace ::Tbx::Namespaces::TbxNamespace
+
+      map_attribute "id", to: :id
+      map_attribute "target", to: :target
+      map_attribute "type", to: :type
+      map_content to: :content
+    end
+  end
+end

data/lib/tbx.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+require_relative "tbx/version"
+
+module Tbx
+  autoload :Namespaces, "#{__dir__}/tbx/namespaces"
+
+  # Inline elements
+  autoload :Ec, "#{__dir__}/tbx/ec"
+  autoload :Foreign, "#{__dir__}/tbx/foreign"
+  autoload :Hi, "#{__dir__}/tbx/hi"
+  autoload :Ph, "#{__dir__}/tbx/ph"
+  autoload :Sc, "#{__dir__}/tbx/sc"
+
+  # Text elements
+  autoload :Note, "#{__dir__}/tbx/note"
+  autoload :P, "#{__dir__}/tbx/p"
+  autoload :Title, "#{__dir__}/tbx/title"
+
+  # Data elements
+  autoload :Admin, "#{__dir__}/tbx/admin"
+  autoload :AdminGrp, "#{__dir__}/tbx/admin_grp"
+  autoload :AdminNote, "#{__dir__}/tbx/admin_note"
+  autoload :Descrip, "#{__dir__}/tbx/descrip"
+  autoload :DescripGrp, "#{__dir__}/tbx/descrip_grp"
+  autoload :DescripNote, "#{__dir__}/tbx/descrip_note"
+  autoload :Ref, "#{__dir__}/tbx/ref"
+  autoload :TermNote, "#{__dir__}/tbx/term_note"
+  autoload :TermNoteGrp, "#{__dir__}/tbx/term_note_grp"
+  autoload :Transac, "#{__dir__}/tbx/transac"
+  autoload :TransacGrp, "#{__dir__}/tbx/transac_grp"
+  autoload :TransacNote, "#{__dir__}/tbx/transac_note"
+  autoload :Xref, "#{__dir__}/tbx/xref"
+
+  # Date
+  autoload :DateElement, "#{__dir__}/tbx/date"
+
+  # Reference elements
+  autoload :Item, "#{__dir__}/tbx/item"
+  autoload :ItemGrp, "#{__dir__}/tbx/item_grp"
+  autoload :ItemSet, "#{__dir__}/tbx/item_set"
+  autoload :RefObject, "#{__dir__}/tbx/ref_object"
+  autoload :RefObjectSec, "#{__dir__}/tbx/ref_object_sec"
+
+  # Structural elements
+  autoload :Term, "#{__dir__}/tbx/term"
+  autoload :TermSec, "#{__dir__}/tbx/term_sec"
+  autoload :LangSec, "#{__dir__}/tbx/lang_sec"
+  autoload :ConceptEntry, "#{__dir__}/tbx/concept_entry"
+  autoload :Body, "#{__dir__}/tbx/body"
+  autoload :TextElement, "#{__dir__}/tbx/text_element"
+  autoload :Back, "#{__dir__}/tbx/back"
+
+  # Header elements
+  autoload :Change, "#{__dir__}/tbx/change"
+  autoload :EncodingDesc, "#{__dir__}/tbx/encoding_desc"
+  autoload :FileDesc, "#{__dir__}/tbx/file_desc"
+  autoload :PublicationStmt, "#{__dir__}/tbx/publication_stmt"
+  autoload :RevisionDesc, "#{__dir__}/tbx/revision_desc"
+  autoload :SourceDesc, "#{__dir__}/tbx/source_desc"
+  autoload :TitleStmt, "#{__dir__}/tbx/title_stmt"
+  autoload :TbxHeader, "#{__dir__}/tbx/tbx_header"
+
+  # Root
+  autoload :Document, "#{__dir__}/tbx/document"
+end

data/reference-docs/schemas/TBX-Basic_DCA.sch

@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="utf-8"?>
+<schema queryBinding="xslt2" xmlns:sqf="http://www.schematron-quickfix.com/validator/process" xmlns="http://purl.oclc.org/dsdl/schematron">
+  <ns uri="urn:iso:std:iso:30042:ed-2" prefix="tbx" />
+  <pattern id="coreEnforcement">
+    <rule context="tbx:termNote">
+      <assert test="parent::tbx:termSec or parent::tbx:termNoteGrp/parent::tbx:termSec">Any termNote is only allowed at the termSec level.</assert>
+    </rule>
+    <rule context="tbx:*[@type]">
+      <assert test="@type != ''">Data category must be declared.  If no permitted data categories are listed in the grammar schema, blank values are also not allowed.</assert>
+    </rule>
+    <rule context="*[@target]">
+      <assert test="matches(@target,'https?://.+') or @target = //*/@id">ID must be IDREF for internal references or URI following HTTP protocol for external references.</assert>
+    </rule>
+  </pattern>
+  <pattern id="XLIFF.inlineConstraints">
+    <rule context="tbx:sc[following-sibling::tbx:ec]">
+      <assert test="@isolated='no' or not(@isolated)">@isolated must be 'no' if &lt;sc/&gt; or &lt;ec/&gt; has its corresponding &lt;sc/&gt;/&lt;ec/&gt; in the same note text and @startRef must be used for &lt;ec&gt;</assert>
+    </rule>
+    <rule context="tbx:ec[preceding-sibling::tbx:sc]">
+      <assert test="@isolated='no' or not(@isolated)">@isolated must be 'no' if &lt;sc/&gt; or &lt;ec/&gt; has its corresponding &lt;sc/&gt;/&lt;ec/&gt; in the same note text and @startRef must be used for &lt;ec&gt;</assert>
+      <assert test="@startRef">@starRef is required for &lt;ec&gt; if it is in the same note text as its corresponding &lt;sc&gt;</assert>
+      <!--<assert test="not(@dir)">@dir only permitted when @isolated is 'yes'.</assert>-->
+      <!--@dir IS NOT CURRENTLY USED IN TBX-->
+    </rule>
+    <rule context="tbx:sc[not(following-sibling::tbx:ec)]">
+      <assert test="@isolated='yes' or not(@isolated)">@isolated must be 'yes' if &lt;sc/&gt; or &lt;ec/&gt; does not have its corresponding &lt;sc/&gt;/&lt;sc/&gt; in the same note text.</assert>
+    </rule>
+    <rule context="tbx:ec[not(preceding-sibling::tbx:sc)]">
+      <assert test="@isolated='yes' or not(@isolated)">@isolated must be 'yes' if &lt;sc/&gt; or &lt;ec/&gt; does not have its corresponding &lt;sc/&gt;/&lt;sc/&gt; in the same note text.</assert>
+      <assert test="@id">@id is REQUIRED when @isolated is or should be 'yes'.</assert>
+    </rule>
+    <rule context="tbx:ec[@isolated='yes']">
+      <assert test="@id != ''">ID is required if @isolated is 'yes'.</assert>
+    </rule>
+  </pattern>
+  <pattern id="dialectEnforcement">
+    <rule context="tbx:tbx">
+      <assert test="attribute::type='TBX-Basic'">The name of this dialect should be TBX-Basic.</assert>
+      <assert test="attribute::style='dca'">The style of this dialect should be declared as 'dca'.</assert>
+    </rule>
+    <rule context="*[not(namespace-uri() = 'urn:iso:std:iso:30042:ed-2')]">
+      <assert test="false()">DCT style elements are not permitted in DCA style TBX.</assert>
+    </rule>
+    <!-- Data Category Types -->
+    <rule context="tbx:admin/@type">
+      <assert test=".='customerSubset' or .='projectSubset' or .='source'">Permitted type value(s): customerSubset, projectSubset, source</assert>
+    </rule>
+    <rule context="tbx:descrip/@type">
+      <assert test=".='subjectField' or .='context' or .='definition'">Permitted type value(s): subjectField, context, definition</assert>
+    </rule>
+    <rule context="tbx:ref/@type">
+      <assert test=".='crossReference'">Permitted type value(s): crossReference</assert>
+    </rule>
+    <rule context="tbx:termNote/@type">
+      <assert test=".='administrativeStatus' or .='partOfSpeech' or .='geographicalUsage' or .='grammaticalGender' or .='termLocation' or .='termType'">Permitted type value(s): administrativeStatus, partOfSpeech, geographicalUsage, grammaticalGender, termLocation, termType</assert>
+    </rule>
+    <rule context="tbx:transac/@type">
+      <assert test=".='transactionType'">Permitted type value(s): transactionType</assert>
+    </rule>
+    <rule context="tbx:transacNote/@type">
+      <assert test=".='responsibility'">Permitted type value(s): responsibility</assert>
+    </rule>
+    <rule context="tbx:xref/@type">
+      <assert test=".='externalCrossReference' or .='xGraphic'">Permitted type value(s): externalCrossReference, xGraphic</assert>
+    </rule>
+  </pattern>
+  <!-- min module rules -->
+  <pattern id="module.min.admin">
+    <rule context="tbx:admin[@type='customerSubset']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:conceptEntry or parent::tbx:termSec or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:termSec">/customerSubset/ may only appear at level(s): conceptEntry, termSec</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.min.descrip">
+    <rule context="tbx:descrip[@type='subjectField']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:descripGrp/parent::tbx:conceptEntry">/subjectField/ may only appear at level(s): conceptEntry</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.min.termNote">
+    <rule context="tbx:termNote[@type='administrativeStatus']">
+      <assert test=".='admittedTerm-admn-sts' or .='deprecatedTerm-admn-sts' or .='supersededTerm-admn-sts' or .='preferredTerm-admn-sts'">/administrativeStatus/ type may be: 'admittedTerm-admn-sts' or 'deprecatedTerm-admn-sts' or 'supersededTerm-admn-sts' or 'preferredTerm-admn-sts'</assert>
+    </rule>
+    <rule context="tbx:termNote[@type='partOfSpeech']">
+      <assert test=".='adjective' or .='noun' or .='other' or .='verb' or .='adverb'">/partOfSpeech/ type may be: 'adjective' or 'noun' or 'other' or 'verb' or 'adverb'</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.min.xref">
+    <rule context="tbx:xref[@type='externalCrossReference']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:langSec or parent::tbx:termSec">/externalCrossReference/ may only appear at level(s): conceptEntry, langSec, termSec</assert>
+    </rule>
+  </pattern>
+  <!-- basic module rules -->
+  <pattern id="module.basic.admin">
+    <rule context="tbx:admin[@type='projectSubset']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:conceptEntry or parent::tbx:termSec or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:termSec">/projectSubset/ may only appear at level(s): conceptEntry, termSec</assert>
+    </rule>
+    <rule context="tbx:admin[@type='source']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:conceptEntry or parent::tbx:langSec or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:langSec or parent::tbx:termSec or parent::tbx:*[contains(./local-name(),'Grp')][not(./local-name() = 'transacGrp')]/parent::tbx:termSec">/source/ may only appear at level(s): conceptEntry, langSec, termSec</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.descrip">
+    <rule context="tbx:descrip[@type='context']">
+      <assert test="parent::tbx:termSec or parent::tbx:descripGrp/parent::tbx:termSec">/context/ may only appear at level(s): termSec</assert>
+    </rule>
+    <rule context="tbx:descrip[@type='definition']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:descripGrp/parent::tbx:conceptEntry or parent::tbx:langSec or parent::tbx:descripGrp/parent::tbx:langSec">/definition/ may only appear at level(s): conceptEntry, langSec</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.ref">
+    <rule context="tbx:ref[@type='crossReference']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:*[contains(./local-name(),'Grp')]/parent::tbx:conceptEntry or parent::tbx:termSec or parent::tbx:*[contains(./local-name(),'Grp')]/parent::tbx:termSec">/crossReference/ may only appear at level(s): conceptEntry, termSec</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.termNote">
+    <rule context="tbx:termNote[@type='grammaticalGender']">
+      <assert test=".='masculine' or .='feminine' or .='neuter' or .='other'">/grammaticalGender/ type may be: 'masculine' or 'feminine' or 'neuter' or 'other'</assert>
+    </rule>
+    <rule context="tbx:termNote[@type='termLocation']">
+      <assert test=".='checkBox' or .='comboBox' or .='comboBoxElement' or .='dialogBox' or .='groupBox' or .='informativeMessage' or .='interactiveMessage' or .='menuItem' or .='progressBar' or .='pushButton' or .='radioButton' or .='slider' or .='spinBox' or .='tab' or .='tableText' or .='textBox' or .='toolTip' or .='user-definedType'">/termLocation/ type may be: 'checkBox' or 'comboBox' or 'comboBoxElement' or 'dialogBox' or 'groupBox' or 'informativeMessage' or 'interactiveMessage' or 'menuItem' or 'progressBar' or 'pushButton' or 'radioButton' or 'slider' or 'spinBox' or 'tab' or 'tableText' or 'textBox' or 'toolTip' or 'user-definedType'</assert>
+    </rule>
+    <rule context="tbx:termNote[@type='termType']">
+      <assert test=".='fullForm' or .='acronym' or .='abbreviation' or .='shortForm' or .='variant' or .='phrase'">/termType/ type may be: 'fullForm' or 'acronym' or 'abbreviation' or 'shortForm' or 'variant' or 'phrase'</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.transac">
+    <rule context="tbx:transac[@type='transactionType']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:transacGrp/parent::tbx:conceptEntry or parent::tbx:langSec or parent::tbx:transacGrp/parent::tbx:langSec or parent::tbx:termSec or parent::tbx:transacGrp/parent::tbx:termSec">/transactionType/ may only appear at level(s): conceptEntry, langSec, termSec</assert>
+    </rule>
+    <rule context="tbx:transac[@type='transactionType']">
+      <assert test=".='origination' or .='modification'">/transactionType/ type may be: 'origination' or 'modification'</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.transacNote">
+    <rule context="tbx:transacNote[@type='responsibility']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:transacGrp/parent::tbx:conceptEntry or parent::tbx:langSec or parent::tbx:transacGrp/parent::tbx:langSec or parent::tbx:termSec or parent::tbx:transacGrp/parent::tbx:termSec">/responsibility/ may only appear at level(s): conceptEntry, langSec, termSec</assert>
+    </rule>
+  </pattern>
+  <pattern id="module.basic.xref">
+    <rule context="tbx:xref[@type='xGraphic']">
+      <assert test="parent::tbx:conceptEntry or parent::tbx:langSec">/xGraphic/ may only appear at level(s): conceptEntry, langSec</assert>
+    </rule>
+  </pattern>
+</schema>