glossarist 2.3.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe8b9555663cedc2258a960b19a10f9d6fc4575faf70006e1223c69f95678451
-  data.tar.gz: fbdd27366d93b637882ad7dd3b77bfbaca9ae68c489403d7595fbe39af901e68
+  metadata.gz: 0667bd53eab8d4a86ef3376ddb095b7dafe5ce903b5df39683f279ef51c01a7e
+  data.tar.gz: 66a281d1f6132de430a6c24706eeb564c98c10f97cfac4751811c33dae2fdcc6
 SHA512:
-  metadata.gz: 2e7030a8e328ee775641e8c4637b458c6746b872d597235bad00977c78a97d56f21ed48bbb9ef11ab0209ba74a93f7aeac19121bca32bd8c71aecdf67601223b
-  data.tar.gz: 1a5ddbc5c71542eb7f258d17c601cd08b54041053ddfb1089a5f6e7eca28dfb360fe2b1c21da4bfa9d8474c333ce37376aeccbf75fc609dd2cea3e2e28c1acd2
+  metadata.gz: 2eb5758d7c7528f8cf8759924e9b2e6e5872ea58ef4c63b86365265f884f99ac4899caf62003bd01b2cb9ff8f32d914775df95820f21907c8f5cb80c306009a4
+  data.tar.gz: 43b9635c121ca5e910611a46109a3353c2290ef8e901bec2b1a55e37e03d707e28cfb927ed6a20c9e6e85df9bc708801552bab821d20f63dff71bce832055e14

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/exe/glossarist

@@ -21,12 +21,14 @@ class GlossaristCommand < Thor
 
     concept_set = Glossarist::ConceptSet.new(options[:concepts_path], assets)
     latex_str = concept_set.to_latex(latex_concepts_file)
+    output_latex(latex_str)
+  end
 
+  def output_latex(latex_str)
     output_file_path = options[:output_file]
+
     if output_file_path
-      File.open(output_file_path, "w") do |file|
-        file.puts latex_str
-      end
+      File.open(output_file_path, "w") { |file| file.puts latex_str }
     else
       puts latex_str
     end

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.6"
   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