sts 0.1.0

data/lib/sts/niso_sts.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sts
+  module NisoSts
+  end
+end
+
+require_relative "niso_sts/back"
+require_relative "niso_sts/body"
+require_relative "niso_sts/front"
+require_relative "niso_sts/list"
+require_relative "niso_sts/metadata_iso"
+require_relative "niso_sts/non_normative_note"
+require_relative "niso_sts/paragraph"
+require_relative "niso_sts/reference"
+require_relative "niso_sts/reference_list"
+require_relative "niso_sts/reference_standard"
+require_relative "niso_sts/section"
+require_relative "niso_sts/standard"
+require_relative "niso_sts/term_display"
+require_relative "niso_sts/term_section"

data/lib/sts/tbx_iso_tml/definition.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class Definition < Shale::Mapper
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "definition"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/example.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class Example < Shale::Mapper
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "example"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/external_graphic.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class ExternalGraphic < Shale::Mapper
+      attribute :target, Shale::Type::String
+
+      xml do
+        root "xGraphic"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "xtarget", to: :target
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/external_source.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class ExternalSource < Shale::Mapper
+      attribute :target, Shale::Type::String
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "xSource"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "xtarget", to: :target
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/geographical_usage.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class GeographicalUsage < Shale::Mapper
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "geographicalUsage"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/grammatical_gender.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class GrammaticalGender < Shale::Mapper
+      # TODO: can be masculine, feminine, singular
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "grammaticalGender"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "value", to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/grammatical_number.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class GrammaticalNumber < Shale::Mapper
+      # TODO: can be singular | plural
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "grammaticalNumber"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "value", to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/lang_set.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "shale"
+
+require_relative "note"
+require_relative "example"
+require_relative "definition"
+require_relative "see"
+require_relative "source"
+require_relative "external_source"
+require_relative "term_information_group"
+
+module Sts
+  module TbxIsoTml
+    class LangSet < Shale::Mapper
+      attribute :lang, Shale::Type::String
+      attribute :note, Note, collection: true
+      attribute :example, Example, collection: true
+      attribute :definition, Definition
+      attribute :tig, TermInformationGroup, collection: true
+      attribute :see, See, collection: true
+      attribute :source, Source, collection: true
+      attribute :x_source, ExternalSource, collection: true
+      attribute :cross_reference, Shale::Type::String, collection: true
+      attribute :subject_field, Shale::Type::String
+      # attribute :x_graphic, ExternalGraphic, collection: true
+
+      xml do
+        root "langSet"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "lang", to: :lang,
+                              namespace: "http://www.w3.org/XML/1998/namespace",
+                              prefix: "xml"
+        map_element "note", to: :note
+        map_element "example", to: :example
+        map_element "definition", to: :definition
+        map_element "tig", to: :tig
+        map_element "see", to: :see
+        map_element "source", to: :source
+        map_element "xSource", to: :x_source
+        map_element "crossReference", to: :cross_reference
+        map_element "subjectField", to: :subject_field
+        # map_element 'xGraphic', to: :x_graphic
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/normative_authorization.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class NormativeAuthorization < Shale::Mapper
+      # TODO: can be: admittedTerm, preferredTerm, deprecatedTerm
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "normativeAuthorization"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "value", to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/note.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class Note < Shale::Mapper
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "note"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/part_of_speech.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class PartOfSpeech < Shale::Mapper
+      # TODO: can be `noun`, `verb`, `adj`, `adv`
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "partOfSpeech"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "value", to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/see.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class See < Shale::Mapper
+      attribute :script, Shale::Type::String
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "see"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "script", to: :script
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/source.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class Source < Shale::Mapper
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "source"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/term.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class Term < Shale::Mapper
+      attribute :id, Shale::Type::String
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "term"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "id", to: :id
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/term_entry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "shale"
+
+require_relative "lang_set"
+require_relative "external_graphic"
+
+module Sts
+  module TbxIsoTml
+    class TermEntry < Shale::Mapper
+      attribute :id, Shale::Type::String
+      attribute :lang_set, LangSet, collection: true
+      attribute :x_graphic, ExternalGraphic, collection: true
+
+      xml do
+        root "termEntry"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "id", to: :id
+        map_element "langSet", to: :lang_set
+        map_element "xGraphic", to: :x_graphic
+      end
+
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/term_information_group.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "shale"
+
+require_relative "term"
+require_relative "part_of_speech"
+require_relative "normative_authorization"
+require_relative "geographical_usage"
+require_relative "grammatical_gender"
+require_relative "grammatical_number"
+require_relative "term_type"
+
+module Sts
+  module TbxIsoTml
+    class TermInformationGroup < Shale::Mapper
+      attribute :term, Term
+      attribute :pos, PartOfSpeech
+      attribute :usage_note, Shale::Type::String
+      attribute :normative_authorization, NormativeAuthorization
+      attribute :geographical_usage, GeographicalUsage
+      attribute :grammatical_gender, GrammaticalGender
+      attribute :grammatical_number, GrammaticalNumber
+      attribute :pronunciation, Shale::Type::String
+      attribute :term_type, TermType
+
+      xml do
+        root "tig"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_element "term", to: :term
+        map_element "partOfSpeech", to: :pos
+        map_element "usageNote", to: :usage_note
+        map_element "normativeAuthorization", to: :normative_authorization
+        map_element "geographicalUsage", to: :geographical_usage
+        map_element "pronunciation", to: :pronunciation
+        map_element "termType", to: :term_type
+        map_element "grammaticalGender", to: :grammatical_gender
+        map_element "grammaticalNumber", to: :grammatical_number
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml/term_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Sts
+  module TbxIsoTml
+    class TermType < Shale::Mapper
+      # TODO: can be:
+      # - acronym
+      # - abbreviation
+      # - equation
+      # - formula
+      # - fullForm
+      # - symbol
+      # - variant
+
+      attribute :value, Shale::Type::String
+
+      xml do
+        root "termType"
+        namespace "urn:iso:std:iso:30042:ed-1", "tbx"
+
+        map_attribute "value", to: :value
+      end
+    end
+  end
+end

data/lib/sts/tbx_iso_tml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Sts
+  module TbxIsoTml
+  end
+end
+
+require_relative "tbx_iso_tml/definition"
+require_relative "tbx_iso_tml/example"
+require_relative "tbx_iso_tml/external_graphic"
+require_relative "tbx_iso_tml/external_source"
+require_relative "tbx_iso_tml/geographical_usage"
+require_relative "tbx_iso_tml/grammatical_gender"
+require_relative "tbx_iso_tml/lang_set"
+require_relative "tbx_iso_tml/normative_authorization"
+require_relative "tbx_iso_tml/note"
+require_relative "tbx_iso_tml/part_of_speech"
+require_relative "tbx_iso_tml/see"
+require_relative "tbx_iso_tml/source"
+require_relative "tbx_iso_tml/term"
+require_relative "tbx_iso_tml/term_entry"
+require_relative "tbx_iso_tml/term_information_group"
+require_relative "tbx_iso_tml/term_type"

data/lib/sts/version.rb

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

data/lib/sts.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "sts/version"
+require "shale"
+require "shale/adapter/nokogiri"
+
+module Sts
+  Shale.xml_adapter = Shale::Adapter::Nokogiri
+
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+require_relative "sts/tbx_iso_tml"
+require_relative "sts/niso_sts"

data/sig/sts.rbs

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

data/sts.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/sts/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 = "sts"
+  spec.version = Sts::VERSION
+  spec.authors = ["Ribose"]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Library to work with NISO STS and ISOSTS."
+  spec.homepage      = "https://github.com/metanorma/sts-ruby"
+  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|spec|features|bin|\.)/}) }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "shale"
+  # spec.add_dependency "thor"
+
+  spec.add_development_dependency "pry", "~> 0.14.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  # spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+end