metanorma-plugin-glossarist 0.5.2 → 0.5.3.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0124df506956c04fd99381c614e2d921ead65cf5918a1bb8f49b80cde8c2c9
-  data.tar.gz: e60bf164cd7becbc5a096a774d5d8f6b494478e6cf1558f6b9c6ca2703a5025a
+  metadata.gz: cf34441379e0de9b9ba6a8a680cac2bd971750b0700c72ee80758a9d892ed07c
+  data.tar.gz: 9e006a7bc8f570bf9c3c79fdba330492ea9a57e6e73eb31461d7c39bb3a3478f
 SHA512:
-  metadata.gz: fc7a8c4118818585c2c80b818cb4679be59123a2b8474318d37f9026769b110c0c5b466d78db01ff114d0d45f9e7bf70a5c017af9fe4f0c3a167e8cc199ebfd1
-  data.tar.gz: 8bad06b56f2d363acbf96a85c4dac4ec8a23c31bc12ead57ee3887acb8e4f146ecf7a18b97c2c12bd8bdb13aa52a6db8d4450738ece556e5e8723549329b3908
+  metadata.gz: d672c5391726eee43defd3da5af83c3d28898879d2d6a4d28eb255676594cbbc3d94b3975786ba22157570bb996d188394a4ce521292176476927ddaf7f8ea7e
+  data.tar.gz: 23de9fd069969746cfe8170209ed7ac18a14f6fee776889a3e398173638bc080ee2dd7e58e4f9bee01fc27c30e8bcd19f8946cf21e2d34ea98d0915c78345d45

data/.github/workflows/release.yml

@@ -14,9 +14,10 @@ on:
   repository_dispatch:
     types: [ do-release ]
 
+# Least-privilege ceiling for the called rubygems-release.yml: its release job
+# needs contents:write (git tag push) and id-token:write (OIDC Trusted Publishing).
 permissions:
   contents: write
-  packages: write
   id-token: write
 
 jobs:

data/.rubocop.yml

@@ -2,18 +2,30 @@
 # See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  # .rubocop_todo.yml MUST be the last entry. inherit_from is last-wins:
+  # if listed before oss-guides, the shared config's stricter Metrics/
+  # (MethodLength, BlockLength, etc.) rules override the todo's per-file
+  # grandfathering, and the todo becomes inert on those cops. Empirically
+  # verified on suma 2026-07-06: with todo listed first, 34 Metrics/* offenses
+  # remained; moved last, cleared. Every gem in the metanorma-org fleet
+  # already ships a `.rubocop_todo.yml` on its live tree (audited 2026-07-06,
+  # 54/54 have it), so this reference is safe to emit unconditionally.
   - .rubocop_todo.yml
 
-inherit_mode:
-  merge:
-    - Exclude
-
-# local repo-specific modifications
-# ...
+# Rubocop plugins enabled centrally so every metanorma-org gem picks them up
+# on cimas sync — best practice belongs at the shared-template layer, not
+# per-repo. Per ronaldtse feedback on metanorma/ci#332.
 plugins:
   - rubocop-rspec
   - rubocop-performance
   - rubocop-rake
 
+# local repo-specific modifications
+# ...
+
 AllCops:
-  TargetRubyVersion: 3.0
+  # 3.3 matches the org-wide minimum being pushed via #274 (Raise minimum
+  # Ruby version to 3.3 due to EOL of 3.2 on 2026-03-31). Was 3.4 before
+  # this commit — 3.4 was above the org's stated minimum and would have
+  # applied Rubocop rules that fail-close on gems still targeting 3.3.
+  TargetRubyVersion: 3.3

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-07-05 06:01:54 UTC using RuboCop version 1.86.1.
+# on 2026-10-10 14:51:08 UTC using RuboCop version 1.91.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
@@ -11,7 +11,7 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'metanorma-plugin-glossarist.gemspec'
 
-# Offense count: 37
+# Offense count: 39
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -26,6 +26,12 @@ Lint/ConstantDefinitionInBlock:
     - 'lib/metanorma/plugin/glossarist/field_filter.rb'
     - 'spec/metanorma/plugin/glossarist/field_filter_spec.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Lint/RedundantRequireStatement:
+  Exclude:
+    - 'lib/metanorma/plugin/glossarist/bibliography_renderer.rb'
+
 # Offense count: 1
 Lint/StructNewOverride:
   Exclude:
@@ -45,7 +51,7 @@ Metrics/AbcSize:
     - 'lib/metanorma/plugin/glossarist/dataset_preprocessor.rb'
     - 'lib/metanorma/plugin/glossarist/template_renderer.rb'
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
@@ -53,6 +59,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/metanorma/plugin/glossarist/concept_filter.rb'
     - 'lib/metanorma/plugin/glossarist/concept_path_resolver.rb'
     - 'lib/metanorma/plugin/glossarist/dataset_preprocessor.rb'
+    - 'lib/metanorma/plugin/glossarist/template_renderer.rb'
 
 # Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
@@ -67,6 +74,14 @@ Metrics/PerceivedComplexity:
     - 'lib/metanorma/plugin/glossarist/concept_filter.rb'
     - 'lib/metanorma/plugin/glossarist/dataset_preprocessor.rb'
 
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, BlockForwardingName.
+# SupportedStyles: anonymous, explicit
+Naming/BlockForwarding:
+  Exclude:
+    - 'lib/metanorma/plugin/glossarist/liquid/drops/localization_collection_drop.rb'
+
 # Offense count: 25
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
@@ -78,9 +93,14 @@ RSpec/ContextWording:
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
     - 'spec/metanorma/plugin/glossarist/bibliography_scope_spec.rb'
 
-# Offense count: 45
+# Offense count: 49
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 35
@@ -90,7 +110,7 @@ RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/metanorma/plugin/glossarist/field_filter_spec.rb'
 
-# Offense count: 66
+# Offense count: 68
 RSpec/MultipleExpectations:
   Max: 4
 
@@ -116,12 +136,23 @@ RSpec/RepeatedExample:
 # SupportedInflectors: default, active_support
 RSpec/SpecFilePathFormat:
   Exclude:
+    - '**/spec/routing/**/*'
     - 'spec/metanorma/plugin/glossarist/liquid/custom_filters_spec.rb'
     - 'spec/metanorma/plugin/glossarist/liquid/drop_bracket_access_spec.rb'
     - 'spec/metanorma/plugin/glossarist/liquid/drops/localization_collection_drop_spec.rb'
     - 'spec/metanorma/plugin/glossarist/liquid/drops/managed_concept_data_drop_spec.rb'
     - 'spec/metanorma/plugin/glossarist/liquid/drops/managed_concept_drop_spec.rb'
 
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowOnlyRestArgument, UseAnonymousForwarding, RedundantRestArgumentNames, RedundantKeywordRestArgumentNames, RedundantBlockArgumentNames.
+# RedundantRestArgumentNames: args, arguments
+# RedundantKeywordRestArgumentNames: kwargs, options, opts
+# RedundantBlockArgumentNames: blk, block, proc
+Style/ArgumentsForwarding:
+  Exclude:
+    - 'lib/metanorma/plugin/glossarist/liquid/drops/localization_collection_drop.rb'
+
 # Offense count: 1
 # Configuration parameters: Max.
 Style/SafeNavigationChainLength:

data/CLAUDE.md

@@ -0,0 +1,49 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+Metanorma Asciidoctor plugin for Glossarist terminology datasets. It loads concept datasets (V2 and V3 Glossarist schemas), renders concepts, bibliographies, and non-verbal entities (figures/tables/formulas) into Metanorma AsciiDoc, using Liquid templates.
+
+## Commands
+
+- Run all specs: `bundle exec rspec` (or `bundle exec rake`)
+- Run one spec file: `bundle exec rspec spec/metanorma/plugin/glossarist/mention_extractor_spec.rb`
+- Run one example: append `:LINE` to the spec file path
+- Lint: `bundle exec rubocop`
+- Console: `bin/console`
+
+`metanorma-standoc` is in the Gemfile `:test` group only — specs render through the `:standoc` backend, but the released gem does not depend on it. Keep any new test-only dependencies in that group; the release workflow bundles with `--without test`.
+
+## Architecture
+
+`lib/metanorma-plugin-glossarist.rb` is the entry point: it defines all autoloads (no `require_relative` for internal code — new classes get an autoload entry there) and `TEMPLATES_DIR`, and registers the Liquid extensions at load time (indexed-access polyfill, `WithGlossaristContext` block, custom filters).
+
+Processing pipeline (AsciiDoc in → AsciiDoc out):
+
+1. **`DatasetPreprocessor`** — Asciidoctor preprocessor that dispatches all directives:
+   - `[glossarist,path,filter=...,template=...,context]` block with a Liquid body
+   - `glossarist::import[ds]`, `glossarist::import_sections[ds]`, `glossarist::render[ds,term]`
+   - `glossarist::render_bibliography[ds]`, `glossarist::render_bibliography_entry[ds,term]`
+   - `glossarist::render_figures|tables|formulas[ds]`
+   - `:glossarist-dataset:` document attribute pre-loads datasets globally (`name:path;name:path`)
+2. **`DatasetRegistry`** — loads and caches datasets per document, `find_concept` lookup, registers sections from `register.yaml`, exposes per-context collections (concepts, sections, bibliography, non-verbal kinds).
+3. **Filters** — `ConceptFilter` (collection filters: `sort_by`, `lang`, `tag`, `domain`/`group`), `FieldFilter` (`path=value`, `path.start_with(v)`), `SectionFilter`; all resolve paths via `ConceptPathResolver`, which navigates dot/bracket notation (`data.localizations['eng'].data.terms[0].designation`) through the Glossarist object graph.
+4. **Renderers** — `TemplateRenderer` / `SectionRenderer` (Liquid; builds parent-child trees from broader/narrower refs, auto-detects section depth), `NonVerbalRenderer` + `NonVerbalFormatters::{Figure,Table,Formula}`, `BibliographyRenderer`, `MentionExtractor` (collects xref/cite anchors used to scope bibliographies).
+5. **Liquid layer** (`Liquid` submodule) — drops (`ManagedConceptDrop`, `ManagedConceptDataDrop`, `LocalizationCollectionDrop`), custom filters (`sanitize_references`, `format_ref`), `WithGlossaristContext` block, `MultiplyLocalFileSystem` for template lookup. `Sanitize` converts URN-style refs into Metanorma-safe anchor ids.
+
+### Glossarist gem interop
+
+- This plugin's namespace is `Metanorma::Plugin::Glossarist`. Inside it, Ruby resolves `Glossarist::` to this namespace first — always reference gem classes with the `::Glossarist::` prefix.
+- Dataset layouts: V2 (UUID-named concept/localized_concept files), V3 (identifier-based files, `register.yaml` with sections, `figures/tables/formulas/` subdirectories). Fixtures: `spec/fixtures/dataset-glossarist-v2`, `-v3`, and `invalid_dataset` for error paths. The non-verbal YAML filename stem is irrelevant; the `id:` field inside is the cross-reference target.
+
+### Spec conventions
+
+- Load real `Glossarist` collections from the fixtures; never use `double()`. For Asciidoctor document objects, simple `Struct`-based stand-ins are the accepted pattern.
+- Preprocessor specs drive `Asciidoctor::Reader` with inline template strings; rendering specs compare against the `:standoc` backend using `canon` XML matching (configured in `spec/spec_helper.rb`).
+
+## CI and release
+
+- `rake.yml` calls `metanorma/ci/.github/workflows/generic-rake.yml@v1` (tests Ruby 3.3/3.4/4.0 on linux/macOS/windows).
+- `release.yml` calls `metanorma/ci/.github/workflows/rubygems-release.yml@main`, gated: a `workflow_dispatch` bumps the version and pushes a tag, but publishing only happens after CI on the tag passes and dispatches `do-release` back. Publishing steps showing "skipped" in the first run is expected. Version numbers are the owner's decision — never pick or dispatch one unprompted.

data/lib/metanorma/plugin/glossarist/version.rb

@@ -3,7 +3,7 @@
 module Metanorma
   module Plugin
     module Glossarist
-      VERSION = "0.5.2"
+      VERSION = "0.5.3.pre.alpha.1"
     end
   end
 end

data/metanorma-plugin-glossarist.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.add_dependency "asciidoctor"
   spec.add_dependency "glossarist", "~> 2.8", ">= 2.11.1"
-  spec.add_dependency "liquid"
+  spec.add_dependency "liquid", "~> 5"
   spec.add_dependency "metanorma-utils"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-glossarist
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3.pre.alpha.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-29 00:00:00.000000000 Z
+date: 2026-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -48,16 +48,16 @@ dependencies:
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: metanorma-utils
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +85,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -138,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="