metanorma-plugin-glossarist 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a817c5969de17ce761956773dce8a9aeb2dee7e2c1bde5f3970783438dd008a1
-  data.tar.gz: 2cbc4ca6b683be306731443ab4ca1d8930b97a2bad8a1c0588d8c12d54b27d80
+  metadata.gz: 891bcd6d1ffd87c66fd4d6901e26dde46ee52b93a8feee0e04b4f6f5e0a8d588
+  data.tar.gz: 7cf700c07b974e0b4e17bb02117cfaf38cc6d1b0d7b6fc578025da3faa497412
 SHA512:
-  metadata.gz: 5f37a8fd2db74f26be2868893eeac5ad65f5014e15f7748ff21975747c864f5d52d14a66bd1263d3be1a608a6032564b2db2a13045222a642a1308a7ad7d5637
-  data.tar.gz: c9b4b823a8e9ba4167d37b7f4d8a4d3c51c27af9cb5d411b35d3690dce50206ef1b682ccbe7bd0cb03fed06a1d977252cb3bc24222ccd570a909196f64c015a5
+  metadata.gz: a78d34c2063ca08e785f99e2ddcddd93321ea78f9243d1fa537d80dbbbf4aee56639b5739c5ef04e495717a7752d53a43ae4ca530938ef037d8aeec2b9eb4876
+  data.tar.gz: f7f93f41b8883f7648b079f157b2085c5a0300e36b6962a4f08a2fb3a00f4acf8c82c7cadcefe50e7605fa05a10560ad4e4e33986f7ccf35a356231afa65c203

data/Gemfile

@@ -4,6 +4,11 @@ Encoding.default_internal = Encoding::UTF_8
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
 
+gem "metanorma-standoc"
+gem "pry"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
 gemspec
 
 eval_gemfile("Gemfile.devel") rescue nil

data/README.md

@@ -138,6 +138,194 @@ The term bar is used as metasyntactic variables and placeholder names in compute
 The term foo is used as metasyntactic variables and placeholder names in computer programming
 ```
 
+The full concept model (a concept can have multiple localized concepts) is available through the block as follows:
+
+```ruby
+{
+  # UUIDs for localized concept mappings
+  "localized_concepts" => {
+    "eng" => "<uuid>",  # English concept UUID
+    "fre" => "<uuid>"   # French concept UUID
+  },
+
+  # Main concept term
+  "term" => "<string>",
+  
+  # Language-specific content (structure repeated for each language code)
+  "<language_code>" => {
+    "dates" => [],      # Array of relevant dates
+    "definition" => [   # Array of definition objects
+      {
+        "content" => "<string>"  # Definition text
+      }
+    ],
+    "examples" => [],   # Array of example objects
+    "id" => "<string>", # Concept ID
+    
+    "notes" => [        # Array of note objects
+      {
+        "content" => "<string>"  # Note text
+      }
+    ],
+    
+    "sources" => [      # Array of source objects
+      {
+        "origin" => {
+          "ref" => "<string>"    # Reference citation
+        },
+        "type" => "<string>",    # Source type (e.g. "lineage")
+        "status" => "<string>"   # Status (e.g. "identical")
+      }
+    ],
+    
+    "terms" => [        # Array of term objects
+      {
+        "type" => "<string>",              # Term type (e.g. "expression")
+        "normative_status" => "<string>",  # Status (e.g. "preferred")
+        "designation" => "<string>",       # Term text
+        "grammar_info" => [                # Array of grammar objects
+          {
+            "preposition" => boolean,
+            "participle" => boolean,
+            "adj" => boolean,
+            "verb" => boolean,
+            "adverb" => boolean,
+            "noun" => boolean,
+            "gender" => ["<string>"],      # Array of grammatical genders
+            "number" => ["<string>"]       # Array of grammatical numbers
+          }
+        ]
+      }
+    ],
+    
+    "language_code" => "<string>"  # ISO language code
+  }
+}
+```
+
+The language codes used are ISO 639-* 3-character codes, as described in the
+[Glossarist Concept model](https://github.com/glossarist/concept-model).
+
+An example of the full model (from ISO/IEC 2382:2015):
+
+```ruby
+{
+  "localized_concepts" => {
+    "eng" => "01134f51-b88c-5214-8909-5d271ea619cf",
+    "fre" => "f290a3af-f1b3-527a-9045-a2dfcc0caf5a"
+  },
+  "term" => "concept description",
+  "eng" => {
+    "dates" => [],
+    "definition" => [
+      {
+        "content" => "data structure describing the class of all known instances of a concept"
+      }
+    ],
+    "examples" => [],
+    "id" => "2122978",
+    "notes" => [
+      {
+        "content" => "concept description: term and definition standardized by ISO/IEC [ISO/IEC 2382-31:1997]."
+      },
+      {
+        "content" => "31.02.02 (2382)"
+      }
+    ],
+    "sources" => [
+      {
+        "origin" => {
+          "ref" => "ISO/IEC 2382-31:1997"
+        },
+        "type" => "lineage",
+        "status" => "identical"
+      },
+      {
+        "origin" => {
+          "ref" => "Ranger, Natalie * 2006 * Bureau de la traduction / Translation Bureau * Services linguistiques / Linguistic Services * Bur. dir. Centre de traduction et de terminologie / Dir's Office Translation and Terminology Centre * Div. Citoyenneté et Protection civile / Citizen. & Emergency preparedness Div. * Normalisation terminologique / Terminology Standardization"
+        },
+        "type" => "lineage",
+        "status" => "identical"
+      }
+    ],
+    "terms" => [
+      {
+        "type" => "expression",
+        "normative_status" => "preferred",
+        "designation" => "concept description",
+        "grammar_info" => [
+          {
+            "preposition" => false,
+            "participle" => false,
+            "adj" => false,
+            "verb" => false,
+            "adverb" => false,
+            "noun" => false,
+            "gender" => [],
+            "number" => ["singular"]
+          }
+        ]
+      }
+    ],
+    "language_code" => "eng"
+  },
+  "fre" => {
+    "dates" => [],
+    "definition" => [
+      {
+        "content" => "structure de données qui décrit la classe des instances connues d'un concept"
+      }
+    ],
+    "examples" => [],
+    "id" => "2122978",
+    "notes" => [
+      {
+        "content" => "description de concept : terme et définition normalisés par l'ISO/CEI [ISO/IEC 2382-31:1997]."
+      },
+      {
+        "content" => "31.02.02 (2382)"
+      }
+    ],
+    "sources" => [
+      {
+        "origin" => {
+          "ref" => "ISO/IEC 2382-31:1997"
+        },
+        "type" => "lineage",
+        "status" => "identical"
+      },
+      {
+        "origin" => {
+          "ref" => "Ranger, Natalie * 2006 * Bureau de la traduction / Translation Bureau * Services linguistiques / Linguistic Services * Bur. dir. Centre de traduction et de terminologie / Dir's Office Translation and Terminology Centre * Div. Citoyenneté et Protection civile / Citizen. & Emergency preparedness Div. * Normalisation terminologique / Terminology Standardization"
+        },
+        "type" => "lineage",
+        "status" => "identical"
+      }
+    ],
+    "terms" => [
+      {
+        "type" => "expression",
+        "normative_status" => "preferred",
+        "designation" => "description de concept",
+        "grammar_info" => [
+          {
+            "preposition" => false,
+            "participle" => false,
+            "adj" => false,
+            "verb" => false,
+            "adverb" => false,
+            "noun" => false,
+            "gender" => ["f"],
+            "number" => ["singular"]
+          }
+        ]
+      }
+    ],
+    "language_code" => "fre"
+  }
+}
+```
+
 ### Rendering a single term from loaded dataset
 
 This can be used to render a single concept from the loaded dataset. See [Loading Dataset](#loading-dataset) to load a dataset.

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "asciidoctor"
-require "pry"
 
 require "liquid"
 require "asciidoctor/reader"
@@ -61,7 +60,9 @@ module Metanorma
           super
           @config = config
           @datasets = {}
+          @title_depth = { value: 2 }
           @rendered_bibliographies = {}
+          @seen_glossarist = []
         end
 
         def process(document, reader)
@@ -74,10 +75,19 @@ module Metanorma
           @config[:file_system] = file_system
 
           processed_doc = prepare_document(document, input_lines)
+          log(document, processed_doc.to_s) unless @seen_glossarist.empty?
           Asciidoctor::PreprocessorReader.new(document,
                                               processed_doc.to_s.split("\n"))
         end
 
+        protected
+
+        def log(doc, text)
+          File.open("#{doc.attr('docfile')}.glossarist.log.txt", "w:UTF-8") do |f|
+            f.write(text)
+          end
+        end
+
         private
 
         def prepare_document(document, input_lines, end_mark = nil)
@@ -110,11 +120,13 @@ module Metanorma
           elsif match = current_line.match(GLOSSARIST_BLOCK_REGEX)
             process_glossarist_block(document, liquid_doc, input_lines, match)
           else
+            @title_depth[:value] = current_line.sub(/ .*$/, "").size if /^==+ \S/.match?(current_line)
             liquid_doc.add_content(current_line)
           end
         end
 
         def process_dataset_tag(document, input_lines, liquid_doc, match)
+          @seen_glossarist << "x"
           context_names = prepare_dataset_contexts(document, match[1])
 
           dataset_section = <<~TEMPLATE
@@ -130,6 +142,7 @@ module Metanorma
         end
 
         def process_glossarist_block(document, liquid_doc, input_lines, match)
+          @seen_glossarist << "x"
           end_mark = input_lines.next
           path = relative_file_path(document, match[1])
 
@@ -161,6 +174,7 @@ module Metanorma
         end
 
         def process_render_tag(liquid_doc, match)
+          @seen_glossarist << "x"
           context_name, concept_name = match[1].split(",")
 
           liquid_doc.add_content(
@@ -169,6 +183,7 @@ module Metanorma
         end
 
         def process_import_tag(liquid_doc, match)
+          @seen_glossarist << "x"
           context_name = match[1].strip
           dataset = @datasets[context_name.strip]
 
@@ -180,6 +195,7 @@ module Metanorma
         end
 
         def process_bibliography(liquid_doc, match)
+          @seen_glossarist << "x"
           dataset_name = match[1].strip
           dataset = @datasets[dataset_name]
 
@@ -191,6 +207,7 @@ module Metanorma
         end
 
         def process_bibliography_entry(liquid_doc, match)
+          @seen_glossarist << "x"
           dataset_name, concept_name = match[1].split(",").map(&:strip)
           concept = @datasets[dataset_name][concept_name]
 
@@ -203,7 +220,7 @@ module Metanorma
           bibliography = concept["eng"]["sources"].map do |source|
             ref = source["origin"]["ref"]
 
-            next if @rendered_bibliographies[ref]
+            next if @rendered_bibliographies[ref] || ref.nil? || ref.empty?
 
             @rendered_bibliographies[ref] = ref.gsub(/[ \/:]/, "_")
             "* [[[#{@rendered_bibliographies[ref]},#{ref}]]]"
@@ -238,7 +255,7 @@ module Metanorma
 
         def concept_template(dataset_name, concept_name)
           <<~CONCEPT_TEMPLATE
-            ==== {{ #{dataset_name}['#{concept_name}'].term }}
+            #{"=" * (@title_depth[:value] + 1)} {{ #{dataset_name}['#{concept_name}'].term }}
             #{alt_terms(dataset_name, concept_name)}
 
             {{ #{dataset_name}['#{concept_name}']['eng'].definition[0].content }}
@@ -290,6 +307,7 @@ module Metanorma
         def sources(dataset_name, concept_name)
           <<~SOURCES
             {% for source in #{dataset_name}['#{concept_name}']['eng'].sources %}
+            {%- if source.origin.ref == nil or source.origin.ref == '' %}{% continue %}{% endif %}
             [.source]
             <<{{ source.origin.ref | replace: ' ', '_' | replace: '/', '_' | replace: ':', '_' }},{{ source.origin.clause }}>>
 

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Glossarist
-      VERSION = "0.2.0".freeze
+      VERSION = "0.2.2".freeze
     end
   end
 end

data/metanorma-plugin-glossarist.gemspec

@@ -24,10 +24,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
-  spec.add_dependency "glossarist", "~> 2.0.1"
+  spec.add_dependency "glossarist", "~> 2.0"
   spec.add_dependency "liquid", "~> 5"
-
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-glossarist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -52,48 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: Metanorma plugin for glossarist
 email:
 - open.source@ribose.com
@@ -141,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Metanorma plugin for glossarist