glossarist 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9111f4d1d6b0ea9180c0a61faee7fa8a823aef40b3712803757bf0cc4df76509
-  data.tar.gz: 47255c6c4ad7b725198d7b3f3e256e30cc2c1489d0a1a8315c84e3aabae73d32
+  metadata.gz: 04b9e5d5f00de57e8d2c9aff73d25697758be004f33c5d02c0fdbf6254c69521
+  data.tar.gz: bca6a55ce2c23c374ab5d0e8745803f5ea77af3535ab94835726eeb06f331600
 SHA512:
-  metadata.gz: 635ff3fb8d7f56a2e25968700c9b025946d4fb00ae0d8785619c438a2f4aaee5a93f82ff6022298a2c89d71da9c38d4095d215509addc1c3060b66fe9ff09bff
-  data.tar.gz: d04bf458f1e88b0f325e2c38403d426179e8ca33277ac1e6efe12fc85837bdddf7fd80899cc370ca1930f0a0f91da97b67aef7087009217a89b06f0d861cecbe
+  metadata.gz: 1fa6e324a0f5a72a682a30492fa440731570da4f1b976b293318bd331b888743702e8241b9135a8a4aacc56cbdf266ca1319de9519fa8c0c09f56d9e9fa0e308
+  data.tar.gz: '09cc267101990c505ffeb3798887fc79d42b8c0aef6aa25424971095d5c745fa1a9bd9142f99adf7c012c7dce0d670e07ddfb932d85ca65603d6c5c9b9cbbd0f'

data/.rubocop.yml

@@ -2,6 +2,7 @@
 # See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - .rubocop_todo.yml
 
 # local repo-specific modifications
 # ...

data/.rubocop_todo.yml

@@ -0,0 +1,65 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-01-16 08:32:21 UTC using RuboCop version 1.70.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:
+    - 'glossarist.gemspec'
+
+# Offense count: 64
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/unit/utilities/common_functions_spec.rb'
+
+# Offense count: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/glossarist/managed_concept.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/glossarist/concept_manager.rb'
+    - 'lib/glossarist/utilities/uuid.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/glossarist/designation/expression.rb'
+    - 'lib/glossarist/managed_concept.rb'
+
+# Offense count: 6
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/glossarist/designation/expression.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/README.adoc

@@ -210,7 +210,7 @@ There are two ways to initialize and populate a concept date
 [,ruby]
 ----
 concept_date = Glossarist::ConceptDate.new({
-  date: "2010-11-01T00:00:00.000Z",
+  date: "2010-11-01T00:00:00+00:00",
   type: :accepted,
 })
 ----
@@ -221,7 +221,7 @@ concept_date = Glossarist::ConceptDate.new({
 ----
 concept_date = Glossarist::ConceptDate.new
 concept_date.type = :accepted
-concept_date.date = "2010-11-01T00:00:00.000Z"
+concept_date.date = "2010-11-01T00:00:00+00:00"
 ----
 
 [[id,detailed-definition]]

data/config.yml

@@ -52,12 +52,12 @@ abbreviation:
 
 grammar_info:
   boolean_attribute:
-    - preposition
     - participle
     - adj
     - verb
     - adverb
     - noun
+    - preposition
   gender:
     - m
     - f

data/glossarist.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "lutaml-model", "~> 0.5.0"
   spec.add_dependency "relaton", "~> 1.19"
   spec.add_dependency "thor"
 end

data/lib/glossarist/asset.rb

@@ -1,14 +1,9 @@
-# frozen_string_literal: true
-
-# (c) Copyright 2021 Ribose Inc.
-#
-
 module Glossarist
-  class Asset
-    attr_accessor :path
+  class Asset < Lutaml::Model::Serializable
+    attribute :path, :string
 
-    def initialize(path)
-      @path = path
+    yaml do
+      map :path, to: :path
     end
 
     def eql?(asset)

data/lib/glossarist/citation.rb

@@ -1,69 +1,101 @@
-# frozen_string_literal: true
-
-# (c) Copyright 2021 Ribose Inc.
-#
-
 module Glossarist
-  class Citation < Model
+  class Citation < Lutaml::Model::Serializable
     # Unstructured (plain text) reference.
     # @return [String]
-    attr_accessor :text
+    attribute :text, :string
 
     # Source in structured reference.
     # @return [String]
-    attr_accessor :source
+    attribute :source, :string
 
     # Document ID in structured reference.
     # @return [String]
-    attr_accessor :id
+    attribute :id, :string
 
     # Document version in structured reference.
     # @return [String]
-    attr_accessor :version
+    attribute :version, :string
 
     # @return [String]
     # Referred clause of the document.
-    attr_accessor :clause
+    attribute :clause, :string
 
     # Link to document.
     # @return [String]
-    attr_accessor :link
+    attribute :link, :string
 
     # Original ref text before parsing.
     # @return [String]
     # @note This attribute is likely to be removed or reworked in future.
     #   It is arguably not relevant to Glossarist itself.
-    attr_accessor :original
+    attribute :original, :string
+
+    attribute :ref, :string
+
+    yaml do
+      map :id, to: :id, with: { from: :id_from_yaml, to: :id_to_yaml }
+      map :text, to: :text, with: { from: :text_from_yaml, to: :text_to_yaml }
+      map :source, to: :source,
+                   with: { from: :source_from_yaml, to: :source_to_yaml }
+      map :version, to: :version,
+                    with: { from: :version_from_yaml, to: :version_to_yaml }
+      map :ref, to: :ref, with: { from: :ref_from_yaml, to: :ref_to_yaml }
+
+      map :clause, to: :clause
+      map :link, to: :link
+      map :original, to: :original
+    end
 
-    # Whether it is a plain text ref.
-    # @return [Boolean]
-    def plain?
-      (source && id && version).nil?
+    def ref_from_yaml(model, value)
+      model.ref = value
     end
 
-    # Whether it is a structured ref.
-    # @return [Boolean]
-    def structured?
-      !plain?
+    def ref_to_yaml(model, doc)
+      doc["ref"] = if model.structured?
+                     ref_hash(model)
+                   else
+                     model.text
+                   end
     end
 
-    def to_h
-      {
-        "ref" => ref_to_h,
-        "clause" => clause,
-        "link" => link,
-        "original" => original,
-      }.compact
+    def id_from_yaml(model, value)
+      model.id = value
     end
 
-    def self.from_h(hash)
-      hash = hash.dup
+    def id_to_yaml(_model, _doc)
+      # skip, will be handled in ref
+    end
 
-      ref_val = hash.delete("ref")
-      hash.merge!(Hash === ref_val ? ref_val : {"text" => ref_val})
-      hash.compact!
+    def text_from_yaml(model, value)
+      model.text = value
+    end
+
+    def text_to_yaml(_model, _doc)
+      # skip, will be handled in ref
+    end
+
+    def source_from_yaml(model, value)
+      model.source = value
+    end
 
-      super(hash)
+    def source_to_yaml(_model, _doc)
+      # skip, will be handled in ref
+    end
+
+    def version_from_yaml(model, value)
+      model.version = value
+    end
+
+    def version_to_yaml(_model, _doc)
+      # skip, will be handled in ref
+    end
+
+    def ref_hash(model = self)
+      {
+        "source" => model.source,
+        "id" => model.id,
+        "version" => model.version,
+      }.compact
     end
 
     def ref=(ref)
@@ -76,14 +108,14 @@ module Glossarist
       end
     end
 
-    private
+    def plain?
+      (source && id && version).nil?
+    end
 
-    def ref_to_h
-      if structured?
-        { "source" => source, "id" => id, "version" => version }.compact
-      else
-        text
-      end
+    # Whether it is a structured ref.
+    # @return [Boolean]
+    def structured?
+      !plain?
     end
   end
 end

data/lib/glossarist/collection.rb

@@ -1,8 +1,3 @@
-# frozen_string_literal: true
-
-# (c) Copyright 2021 Ribose Inc.
-#
-
 module Glossarist
   # @todo Add support for lazy concept loading.
   # @todo Consider extracting persistence backend to a separate class.
@@ -33,7 +28,6 @@ module Glossarist
     def fetch(id)
       @index[id]
     end
-
     alias :[] :fetch
 
     # If concept with given ID is present in this collection, returns that
@@ -44,7 +38,7 @@ module Glossarist
     #    Concept ID
     # @return [Concept]
     def fetch_or_initialize(id)
-      fetch(id) or store(Concept.new(id: id))
+      fetch(id) or store(Concept.of_yaml({ id: id }))
     end
 
     # Adds concept to the collection.  If collection contains a concept with
@@ -55,7 +49,6 @@ module Glossarist
     def store(concept)
       @index[concept.id] = concept
     end
-
     alias :<< :store
 
     # Reads all concepts from files.
@@ -70,10 +63,8 @@ module Glossarist
       @index.each_value &method(:save_concept_to_file)
     end
 
-    private
-
     def load_concept_from_file(filename)
-      Concept.from_h(Psych.safe_load(File.read(filename)))
+      Concept.from_yaml(File.read(filename))
     rescue Psych::SyntaxError => e
       raise Glossarist::ParseError.new(filename: filename, line: e.line)
     end

data/lib/glossarist/collections/asset_collection.rb

@@ -3,9 +3,6 @@
 module Glossarist
   module Collections
     class AssetCollection < Set
-      def initialize(assets)
-        super
-      end
     end
   end
 end

data/lib/glossarist/collections/bibliography_collection.rb

@@ -5,7 +5,7 @@ require "relaton"
 module Glossarist
   module Collections
     class BibliographyCollection < Relaton::Db
-      def initialize(concepts, global_cache, local_cache)
+      def initialize(_concepts, global_cache, local_cache)
         super(global_cache, local_cache)
       end
 

data/lib/glossarist/concept.rb

@@ -1,244 +1,105 @@
-# frozen_string_literal: true
-
-# (c) Copyright 2021 Ribose Inc.
-#
-
 module Glossarist
-  class Concept < Model
-    # Concept ID.
-    # @return [String]
-    attr_reader :id
-
-    attr_writer :uuid
-
-    # Concept designations.
-    # @todo Alias +terms+ exists only for legacy reasons and will be removed.
-    # @return [Array<Designations::Base>]
-    attr_reader :designations
-    alias :terms :designations
-
-    # <<BasicDocument>>LocalizedString
-    # @return [String]
-    attr_accessor :domain
-
-    # <<BasicDocument>>LocalizedString
-    # @return [String]
-    attr_accessor :subject
-
-    # Concept definition.
-    # @return [Array<DetailedDefinition>]
-    attr_reader :definition
-
-    # Non verbal representation of the concept.
-    # @return [NonVerbRep]
-    attr_accessor :non_verb_rep
-
-    # Concept notes
-    # @return [Array<DetailedDefinition>]
-    attr_reader :notes
-
-    # Concept examples
-    # @return [Array<DetailedDefinition>]
-    attr_reader :examples
-
-    # Contains list of extended attributes
-    attr_accessor :extension_attributes
-
-    attr_accessor :lineage_source
-    attr_accessor :lineage_source_similarity
-
-    attr_accessor :release
-
-    def initialize(*args)
-      @localizations = {}
-      @sources = Glossarist::Collections::Collection.new(klass: ConceptSource)
-      @related = Glossarist::Collections::Collection.new(klass: RelatedConcept)
-      @definition = Glossarist::Collections::Collection.new(klass: DetailedDefinition)
-      @notes = Glossarist::Collections::Collection.new(klass: DetailedDefinition)
-      @examples = Glossarist::Collections::Collection.new(klass: DetailedDefinition)
-      @dates = Glossarist::Collections::Collection.new(klass: ConceptDate)
-
-      @designations = Glossarist::Collections::DesignationCollection.new
-      @extension_attributes = {}
-
-      normalize_args(args)
-
-      super
-    end
-
-    def uuid
-      @uuid ||= Glossarist::Utilities::UUID.uuid_v5(
-        Glossarist::Utilities::UUID::OID_NAMESPACE,
-        to_h_no_uuid.to_yaml,
-      )
+  class Concept < Lutaml::Model::Serializable
+    attribute :data, ConceptData, default: -> { ConceptData.new }
+    attribute :id, :string
+    attribute :uuid, :string
+    attribute :subject, :string
+    attribute :non_verb_rep, :string
+    attribute :extension_attributes, :string
+    attribute :lineage_source, :string
+    attribute :localizations, :hash
+    attribute :extension_attributes, :hash
+    attribute :termid, :string
+
+    yaml do
+      map :data, to: :data
+      map :termid, to: :termid
+      map :subject, to: :subject
+      map :non_verb_rep, to: :non_verb_rep
+      map :extension_attributes, to: :extension_attributes
+      map :lineage_source, to: :lineage_source
+      map :localizations, to: :localizations
+      map :extension_attributes, to: :extension_attributes
+
+      map :date_accepted,
+          with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
+      map :uuid, to: :uuid, with: { to: :uuid_to_yaml, from: :uuid_from_yaml }
+      map :id, to: :id, with: { to: :id_to_yaml, from: :id_from_yaml }
+      map :identifier, to: :id, with: { to: :id_to_yaml, from: :id_from_yaml }
+    end
+
+    def designations
+      data.terms
     end
+    alias :terms :designations
 
-    def id=(id)
-      # Some of the glossaries that are not generated using glossarist, contains ids that are integers
-      # so adding a temporary check until every glossary is updated using glossarist.
-      if !id.nil? && (id.is_a?(String) || id.is_a?(Integer))
-        @id = id
-      else
-        raise(Glossarist::Error, "Expect id to be a String or Integer, Got #{id.class} (#{id})")
-      end
+    def definition
+      data.definition
     end
 
-    alias :termid= :id=
-    alias :identifier= :id=
-
-    # List of authorative sources.
-    # @todo Alias +authoritative_source+ exists for legacy reasons and may be
-    #   removed.
-    # @return [Array<ConceptSource>]
-    attr_reader :sources
-
-    # return [Array<ConceptDate>]
-    attr_reader :dates
-
-    def examples=(examples)
-      @examples.clear!
-      examples&.each { |example| @examples << example }
+    def definition=(value)
+      data.definition = value
     end
 
-    def notes=(notes)
-      @notes.clear!
-      notes&.each { |note| @notes << note }
+    def sources
+      data.sources
     end
 
-    def definition=(definition)
-      @definition.clear!
-      definition&.each { |definition| @definition << definition }
+    def examples
+      data.examples
     end
 
-    def designations=(designations)
-      @designations.clear!
-      designations&.each { |designation| @designations << designation }
+    def notes
+      data.notes
     end
 
-    alias :terms= :designations=
-
     def preferred_designations
-      @designations.select(&:preferred?)
+      data.terms.select(&:preferred?)
     end
-
     alias :preferred_terms :preferred_designations
 
-    def dates=(dates)
-      @dates.clear!
-      dates&.each { |date| @dates << date }
-    end
-
-    def sources=(sources)
-      @sources.clear!
-      sources&.each { |source| @sources << source }
+    def date_accepted
+      data.date_accepted
     end
 
     def authoritative_source
-      @sources.select { |source| source.authoritative? }
-    end
-
-    def authoritative_source=(sources)
-      sources&.each do |source|
-        @sources << source.merge({ "type" => "authoritative" })
-      end
+      data.authoritative_source
     end
 
-    def date_accepted=(date)
-      date_hash = {
-        "type" => "accepted",
-        "date" => date,
-      }
-
-      @dates ||= []
-      @dates << ConceptDate.new(date_hash)
+    def uuid_to_yaml(model, doc)
+      doc["id"] = model.uuid if model.uuid
     end
 
-    def date_accepted
-      return nil unless @dates
-      @dates.find { |date| date.accepted? }
+    def uuid_from_yaml(model, value)
+      model.uuid = value
     end
 
-    def to_h_no_uuid
-      {
-        "data" => {
-          "dates" => dates&.map(&:to_h),
-          "definition" => definition&.map(&:to_h),
-          "examples" => examples&.map(&:to_h),
-          "id" => id,
-          "lineage_source_similarity" => lineage_source_similarity,
-          "notes" => notes&.map(&:to_h),
-          "release" => release,
-          "sources" => sources.empty? ? nil : sources&.map(&:to_h),
-          "terms" => (terms&.map(&:to_h) || []),
-          "related" => related&.map(&:to_h),
-          "domain" => domain,
-        }.compact,
-
-        "date_accepted" => date_accepted&.date,
-
-      }.compact
-    end
+    def id_to_yaml(model, doc); end
 
-    def to_h
-      to_h_no_uuid.merge("id" => uuid)
+    def id_from_yaml(model, value)
+      model.id = value
     end
 
-    # @deprecated For legacy reasons only.
-    #   Implicit conversion (i.e. {#to_hash} alias) will be removed soon.
-    alias :to_hash :to_h
-
-    # rubocop:disable Metrics/AbcSize, Style/RescueModifier
-    def self.from_h(hash)
-      new.tap do |concept|
-        concept.id = hash.dig("termid") || hash.dig("id")
-        concept.sources = hash.dig("sources")
-        concept.related = hash.dig("related")
-        concept.definition = hash.dig("definition")
-
-        hash.values
-          .grep(Hash)
-          .map { |subhash| Config.class_for(:localized_concept).from_h(subhash) rescue nil }
-          .compact
-
-        concept.related = hash.dig("related") || []
+    def date_accepted_to_yaml(model, doc)
+      if model.date_accepted
+        doc["date_accepted"] =
+          model.date_accepted.date.iso8601
       end
     end
-    # rubocop:enable Metrics/AbcSize, Style/RescueModifier
 
-    # All Related Concepts
-    # @return [Array<RelatedConcept>]
-    def related
-      @related.empty? ? nil : @related
-    end
+    def date_accepted_from_yaml(model, value)
+      return if model.date_accepted
 
-    def related=(related)
-      @related.clear!
-      related&.each { |r| @related << r }
-    end
-
-    Glossarist::GlossaryDefinition::CONCEPT_DATE_TYPES.each do |type|
-      # Sets the ConceptDate and add it to dates list of the specified type.
-      define_method("date_#{type}=") do |date|
-        date_hash = {
-          "type" => type,
-          "date" => date,
-        }
-        @dates ||= []
-        @dates << ConceptDate.new(date_hash)
-      end
+      model.data.dates ||= []
+      model.data.dates << ConceptDate.of_yaml({ "date" => value,
+                                                "type" => "accepted" })
     end
 
-    def normalize_args(args)
-      args.each do |arg|
-        data = arg.delete("data")
-
-        arg.merge!(data) if data
-
-        if arg["sources"]
-          arg.delete("authoritative_source")
-          arg.delete("authoritativeSource")
-        end
-      end
+    def uuid
+      @uuid ||= Glossarist::Utilities::UUID.uuid_v5(
+        Glossarist::Utilities::UUID::OID_NAMESPACE,
+        data.to_yaml,
+      )
     end
   end
 end