glossarist 2.3.11 → 2.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a4cc39193c017e8f66dd84a4c8252f67bfce4d39dcffd149097cd3148def5e7
-  data.tar.gz: 1b876ae71c7d505b4280d9aa2eab9b40ad70c7662fbd795c5a0200ee3f881f88
+  metadata.gz: 8e764b9c8ec92fdd762fdda65ea36270f6798ffd417547e40bd48c8b88e50521
+  data.tar.gz: 2ad3ea02fcdc6d374b7e674796ef124473dc02fbfeff8e4d8053a38fe543e5c6
 SHA512:
-  metadata.gz: fe5475e31ddb035e8b7b2ff1225a678449be2dcc6f72c04f790d85af5f905e7339559d741d6ebb4111e7560b7be759c5185695f392a4851df859afd97bf290ad
-  data.tar.gz: a9d36fcfeebadc62003a2579ff77eee012b5b5a952d8874c25da69c9792f335364a5b7f76e8a7f9a88a9eba20dbc24bb70aff636b5a862e1497139235d95df3b
+  metadata.gz: ee2ea9ab8d52588d84b19aecd860359438e8b929717726bb4f323e2ba37213bb2d39402cd950d0be896f4c4e63a6147a127fd21088cd42f52d99c0c623ccb945
+  data.tar.gz: 10a6f8eb05fac3d6f87d1092b934793f01ae7ce0a000efc7314d865b4790bf3e14189fa90ef55b58020c40ae882bf1210b02c0ea5626171f7ccc0ef9f207135d

data/.github/workflows/release.yml

@@ -2,12 +2,18 @@
 # See https://github.com/metanorma/cimas
 name: release
 
+permissions:
+  contents: write
+  id-token: write
+  pull-requests: write
+
 on:
   workflow_dispatch:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
   repository_dispatch:
@@ -15,10 +21,8 @@ on:
 
 jobs:
   release:
-    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    uses: relaton/support/.github/workflows/release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:
       rubygems-api-key: ${{ secrets.GLOSSARIST_CI_RUBYGEMS_API_KEY }}
-      pat_token: ${{ secrets.GLOSSARIST_CI_PAT_TOKEN }}
-

data/.gitignore

@@ -18,3 +18,6 @@
 
 # Relaton local cache directory
 localcache
+
+.vscode
+

data/.rubocop_todo.yml

@@ -1,25 +1,125 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-16 08:32:21 UTC using RuboCop version 1.70.0.
+# on 2026-03-24 03:31:43 UTC using RuboCop version 1.86.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
+# This cop supports safe autocorrection (--autocorrect).
+Gemspec/RequireMFA:
+  Exclude:
+    - 'glossarist.gemspec'
+
+# Offense count: 1
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'glossarist.gemspec'
 
-# Offense count: 64
+# Offense count: 13
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/glossarist/concept.rb'
+    - 'lib/glossarist/concept_data.rb'
+    - 'lib/glossarist/concept_manager.rb'
+    - 'lib/glossarist/designation/grammar_info.rb'
+    - 'lib/glossarist/managed_concept.rb'
+    - 'spec/features/v2_serialization_spec.rb'
+    - 'spec/unit/locality_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+    - 'spec/features/multi_content_yaml_serialization_spec.rb'
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: consistent, consistent_relative_to_receiver, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstArgumentIndentation:
+  Exclude:
+    - 'spec/features/multi_content_yaml_serialization_spec.rb'
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'exe/glossarist'
+    - 'lib/glossarist/concept_data.rb'
+    - 'lib/glossarist/designation/grammar_info.rb'
+    - 'spec/unit/locality_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'glossarist.gemspec'
+
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 90
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: symmetrical, new_line, same_line
+Layout/MultilineMethodCallBraceLayout:
+  Exclude:
+    - 'spec/features/multi_content_yaml_serialization_spec.rb'
+    - 'spec/features/v2_serialization_spec.rb'
+
+# Offense count: 20
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'exe/glossarist'
+    - 'lib/glossarist/concept.rb'
+    - 'lib/glossarist/concept_data.rb'
+    - 'lib/glossarist/concept_manager.rb'
+    - 'lib/glossarist/designation/grammar_info.rb'
+    - 'lib/glossarist/managed_concept.rb'
+    - 'spec/features/v2_serialization_spec.rb'
+    - 'spec/unit/locality_spec.rb'
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
@@ -33,6 +133,12 @@ Lint/DuplicateMethods:
     - 'lib/glossarist/managed_concept.rb'
 
 # Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Lint/NonAtomicFileOperation:
+  Exclude:
+    - 'lib/glossarist/concept_manager.rb'
+
+# Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -46,10 +152,10 @@ Metrics/CyclomaticComplexity:
     - 'lib/glossarist/designation/expression.rb'
     - 'lib/glossarist/managed_concept.rb'
 
-# Offense count: 6
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 20
+  Max: 19
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -57,9 +163,53 @@ Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/glossarist/designation/expression.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Performance/StringIdentifierArgument:
+  Exclude:
+    - 'spec/unit/collection_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/features/v2_serialization_spec.rb'
+
 # Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.
 # SupportedStyles: annotated, template, unannotated
 Style/FormatStringToken:
   EnforcedStyle: unannotated
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/MapIntoArray:
+  Exclude:
+    - 'spec/unit/collection_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Style/SafeNavigationChainLength:
+  Exclude:
+    - 'lib/glossarist/managed_concept.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'glossarist.gemspec'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperArguments:
+  Exclude:
+    - 'lib/glossarist/designation/base.rb'
+    - 'lib/glossarist/designation/expression.rb'

data/Gemfile

@@ -2,8 +2,12 @@
 
 source "https://rubygems.org"
 
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
 gem "pry"
 gem "rake"
 gem "rspec"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
 
 gemspec

data/exe/glossarist

@@ -5,10 +5,14 @@ require_relative "../lib/glossarist"
 class GlossaristCommand < Thor
   desc "generate_latex", "Convert Concepts to Latex format"
 
-  option :concepts_path, aliases: :p, required: true, desc: "Path to yaml concepts directory"
-  option :latex_concepts, aliases: :l, desc: "File path having list of concepts that should be converted to LATEX format. If not provided all the concepts will be converted to the latex format"
-  option :output_file, aliases: :o, desc: "Output file path. By default the output will pe printed to the console"
-  option :extra_attributes, aliases: :e, type: :array, desc: "List of extra attributes that are not in standard Glossarist Concept model"
+  option :concepts_path, aliases: :p, required: true,
+                         desc: "Path to yaml concepts directory"
+  option :latex_concepts, aliases: :l,
+                          desc: "File path having list of concepts that should be converted to LATEX format. If not provided all the concepts will be converted to the latex format"
+  option :output_file, aliases: :o,
+                       desc: "Output file path. By default the output will pe printed to the console"
+  option :extra_attributes, aliases: :e, type: :array,
+                            desc: "List of extra attributes that are not in standard Glossarist Concept model"
   def generate_latex
     assets = []
     latex_concepts_file = options[:latex_concepts]

data/glossarist.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   spec.files         = all_files_in_git

data/lib/glossarist/collections/bibliography_collection.rb

@@ -6,11 +6,36 @@ module Glossarist
   module Collections
     class BibliographyCollection < Relaton::Db
       def initialize(_concepts, global_cache, local_cache)
+        @version_mismatch = check_cache_version(local_cache) ||
+                            check_cache_version(global_cache)
         super(global_cache, local_cache)
       end
 
+      def fetch_all(...)
+        raise @version_mismatch if @version_mismatch
+
+        super
+      end
+
       private
 
+      def check_cache_version(path)
+        return unless path && File.directory?(path)
+
+        Dir["#{File.expand_path(path)}/*/"].each do |dir|
+          version_file = "#{dir}version"
+          next unless File.exist?(version_file)
+
+          actual = File.read(version_file, encoding: "utf-8").strip
+          expected = Relaton::Registry.instance.by_type(dir.split("/").last)&.grammar_hash
+          next if expected.nil? || actual == expected
+
+          return CacheVersionMismatchError.new(dir, expected, actual)
+        end
+
+        nil
+      end
+
       def populate_bibliographies(concepts)
         concepts.each do |concept|
           concept.default_lang.sources.each do |source|

data/lib/glossarist/concept.rb

@@ -16,12 +16,15 @@ module Glossarist
       map :termid, to: :termid
       map :subject, to: :subject
       map %i[non_verb_rep nonVerbRep], to: :non_verb_rep
-      map %i[extension_attributes extensionAttributes], to: :extension_attributes
+      map %i[extension_attributes extensionAttributes],
+          to: :extension_attributes
       map %i[lineage_source lineageSource], to: :lineage_source
       map :localizations, to: :localizations
-      map %i[extension_attributes extensionAttributes], to: :extension_attributes
+      map %i[extension_attributes extensionAttributes],
+          to: :extension_attributes
 
-      map %i[date_accepted dateAccepted], with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
+      map %i[date_accepted dateAccepted],
+          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 }

data/lib/glossarist/concept_data.rb

@@ -3,11 +3,14 @@ module Glossarist
     include Glossarist::Utilities::CommonFunctions
 
     attribute :dates, ConceptDate, collection: true
-    attribute :definition, DetailedDefinition, collection: true, initialize_empty: true
-    attribute :examples, DetailedDefinition, collection: true, initialize_empty: true
+    attribute :definition, DetailedDefinition, collection: true,
+                                               initialize_empty: true
+    attribute :examples, DetailedDefinition, collection: true,
+                                             initialize_empty: true
     attribute :id, :string
     attribute :lineage_source_similarity, :integer
-    attribute :notes, DetailedDefinition, collection: true, initialize_empty: true
+    attribute :notes, DetailedDefinition, collection: true,
+                                          initialize_empty: true
     attribute :release, :string
     attribute :sources, ConceptSource, collection: true
     attribute :terms, Designation::Base, collection: true
@@ -28,7 +31,8 @@ module Glossarist
       map :definition, to: :definition, value_map: { to: { empty: :empty } }
       map :examples, to: :examples, value_map: { to: { empty: :empty } }
       map :id, to: :id
-      map %i[lineage_source_similarity lineageSourceSimilarity], to: :lineage_source_similarity
+      map %i[lineage_source_similarity lineageSourceSimilarity],
+          to: :lineage_source_similarity
       map :notes, to: :notes, value_map: { to: { empty: :empty } }
       map :release, to: :release
       map :sources, to: :sources
@@ -40,7 +44,8 @@ module Glossarist
       map %i[entry_status entryStatus], to: :entry_status
       map %i[review_date reviewDate], to: :review_date
       map %i[review_decision_date reviewDecisionDate], to: :review_decision_date
-      map %i[review_decision_event reviewDecisionEvent], to: :review_decision_event
+      map %i[review_decision_event reviewDecisionEvent],
+          to: :review_decision_event
     end
 
     def terms_from_yaml(model, value)

data/lib/glossarist/concept_manager.rb

@@ -5,7 +5,8 @@ module Glossarist
 
     yaml do
       map :path, to: :path
-      map %i[localized_concepts_path localizedConceptsPath], to: :localized_concepts_path
+      map %i[localized_concepts_path localizedConceptsPath],
+          to: :localized_concepts_path
     end
 
     def load_from_files(collection: nil)
@@ -98,8 +99,8 @@ module Glossarist
 
       localized_concept_dir = File.join(path, @localized_concepts_path)
 
-      Dir.mkdir(concept_dir) unless Dir.exist?(concept_dir)
-      Dir.mkdir(localized_concept_dir) unless Dir.exist?(localized_concept_dir)
+      FileUtils.mkdir_p(concept_dir)
+      FileUtils.mkdir_p(localized_concept_dir)
 
       filename = File.join(concept_dir, "#{concept.uuid}.yaml")
       File.write(filename, concept.to_yaml)
@@ -114,7 +115,7 @@ module Glossarist
       @localized_concepts_path ||= "localized_concept"
       concept_dir = File.join(path)
 
-      Dir.mkdir(concept_dir) unless Dir.exist?(concept_dir)
+      FileUtils.mkdir_p(concept_dir)
 
       content = []
 

data/lib/glossarist/designation/base.rb

@@ -30,7 +30,7 @@ module Glossarist
             raise ArgumentError, "unexpected designation type: #{type}"
           end
 
-          super(hash, options)
+          super
         end
       end
     end

data/lib/glossarist/designation/expression.rb

@@ -35,7 +35,7 @@ module Glossarist
 
         hash["type"] = "expression" unless hash["type"]
 
-        super(hash, options)
+        super
       end
     end
   end

data/lib/glossarist/designation/grammar_info.rb

@@ -12,7 +12,9 @@ module Glossarist
         map :gender, to: :gender
         map :number, to: :number
 
-        map %i[part_of_speech partOfSpeech], with: { to: :part_of_speech_to_yaml, from: :part_of_speech_from_yaml }
+        map %i[part_of_speech partOfSpeech],
+            with: { to: :part_of_speech_to_yaml,
+                    from: :part_of_speech_from_yaml }
         Glossarist::GlossaryDefinition::GRAMMAR_INFO_BOOLEAN_ATTRIBUTES.each do |bool_attr|
           map bool_attr,
               with: { to: :"part_of_speech_#{bool_attr}_to_yaml",

data/lib/glossarist/error/cache_version_mismatch_error.rb

@@ -0,0 +1,8 @@
+module Glossarist
+  class CacheVersionMismatchError < Error
+    def initialize(cache_dir, expected, actual)
+      super("Relaton cache version mismatch in '#{cache_dir}': " \
+            "expected '#{expected}', got '#{actual}'")
+    end
+  end
+end

data/lib/glossarist/error.rb

@@ -6,3 +6,4 @@ end
 require_relative "error/invalid_type_error"
 require_relative "error/invalid_language_code_error"
 require_relative "error/parse_error"
+require_relative "error/cache_version_mismatch_error"

data/lib/glossarist/managed_concept.rb

@@ -28,7 +28,8 @@ module Glossarist
           with: { to: :identifier_to_yaml, from: :identifier_from_yaml }
       map :related, to: :related
       map :dates, to: :dates
-      map %i[date_accepted dateAccepted], with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
+      map %i[date_accepted dateAccepted],
+          with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
       map :status, to: :status
 
       map :uuid, to: :uuid, with: { from: :uuid_from_yaml, to: :uuid_to_yaml }

data/lib/glossarist/version.rb

@@ -4,5 +4,5 @@
 #
 
 module Glossarist
-  VERSION = "2.3.11"
+  VERSION = "2.3.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glossarist
 version: !ruby/object:Gem::Version
-  version: 2.3.11
+  version: 2.3.12
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-25 00:00:00.000000000 Z
+date: 2026-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -102,6 +102,7 @@ files:
 - lib/glossarist/designation/symbol.rb
 - lib/glossarist/detailed_definition.rb
 - lib/glossarist/error.rb
+- lib/glossarist/error/cache_version_mismatch_error.rb
 - lib/glossarist/error/invalid_language_code_error.rb
 - lib/glossarist/error/invalid_type_error.rb
 - lib/glossarist/error/parse_error.rb
@@ -124,6 +125,7 @@ metadata:
   homepage_uri: https://github.com/glossarist/glossarist-ruby
   source_code_uri: https://github.com/glossarist/glossarist-ruby
   bug_tracker_uri: https://github.com/glossarist/glossarist-ruby/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: