glossarist-new 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca876eda8d9aaf1f9c931e93b47865f618f37991b317cf9a9b1aecaee4f60cf
-  data.tar.gz: 9af3d0caefb3ecf7c1cc8958b4440641d279126bcc4a2888feb91ee4bb2ccf42
+  metadata.gz: 6c97457297f94e65b52da9de5fd9dc620f3722034e9a97dae80c81736333cf7d
+  data.tar.gz: e8716f64a5cb9d2e84f752540854219a6ffe406fc46140158274fc135a002da0
 SHA512:
-  metadata.gz: 35fd58588549adf1b1978b6688b21257f8a9f094246daa69365f6e031a0c9e6de9ddbd57835692f80b4fbbe0a4f8cd40af8f60e2dd237cb397d8fb515824bd21
-  data.tar.gz: 9f0843c03da02ffde2f6defad7f6d42732842ecb32cbbd560283d6e2ac5700073e7573ecf5d74e0764b781fedcb9fe48caae1d9a3de80c5e7d0a89976a603c8e
+  metadata.gz: 2f9db6e9f0f5e716c9810d44f06fd14d77140aa060b9004dbc900c2766be1bb08733789e0619d8cda633c18158ddf931b943cd9a5c4d6c025240f71453f351e4
+  data.tar.gz: 28c854fab76b67814180a2da7043ecb8072aea4828c9bcba92cf2b45ae57af5680733532837d46427a8bfd0d2834b965a04b51791010e50b214243ab27d7b7bc

data/.github/workflows/test.yml

@@ -17,8 +17,6 @@ jobs:
           - "3.0"
           - "2.7"
           - "2.6"
-          - "2.5"
-          - "2.4"
 
     steps:
       - name: Fetch source code

data/.gitignore

@@ -16,3 +16,5 @@
 .rubocop-http---*
 .rubocop-https---*
 
+# Relaton local cache directory
+localcache

data/glossarist.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
     "Concept models for terminology glossaries conforming ISO 10241-1."
   spec.homepage      = "https://github.com/glossarist/glossarist-ruby"
   spec.license       = "BSD-2-Clause"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "relaton", "~>1.13.0"
+
   spec.add_development_dependency "pry", "~> 0.14.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"

data/lib/glossarist/asset.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class Asset
+    attr_accessor :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def eql?(asset)
+      path == asset.path
+    end
+
+    def hash
+      path.hash
+    end
+  end
+end

data/lib/glossarist/citation.rb

@@ -67,9 +67,13 @@ module Glossarist
     end
 
     def ref=(ref)
-      @source = ref["source"]
-      @id = ref["id"]
-      @version = ref["version"]
+      if ref.is_a?(Hash)
+        @source = ref["source"]
+        @id = ref["id"]
+        @version = ref["version"]
+      else
+        @text = ref
+      end
     end
 
     private

data/lib/glossarist/collections/asset_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    class AssetCollection < Set
+      def initialize(assets)
+        super
+      end
+    end
+  end
+end

data/lib/glossarist/collections/bibliography_collection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "relaton"
+
+module Glossarist
+  module Collections
+    class BibliographyCollection < Relaton::Db
+      def initialize(concepts, global_cache, local_cache)
+        super(global_cache, local_cache)
+      end
+
+      private
+
+      def populate_bibliographies(concepts)
+        concepts.each do |concept|
+          concept.default_lang.sources.each do |source|
+            next if source.origin.text.nil?
+
+            fetch(source.origin.text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/collections.rb

@@ -0,0 +1,2 @@
+require_relative "collections/asset_collection"
+require_relative "collections/bibliography_collection"

data/lib/glossarist/concept_manager.rb

@@ -26,8 +26,6 @@ module Glossarist
       managed_concepts.each_value &method(:save_concept_to_file)
     end
 
-    private
-
     def load_concept_from_file(filename)
       ManagedConcept.new(Psych.safe_load(File.read(filename)))
     end
@@ -37,6 +35,8 @@ module Glossarist
       File.write(filename, Psych.dump(concept.to_h))
     end
 
+    private
+
     def concepts_glob
       File.join(path, "concept-*.{yaml,yml}")
     end

data/lib/glossarist/concept_set.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Glossarist
+  class ConceptSet
+    # a `Glossarist::ManagedConceptCollection` object
+    attr_accessor :concepts
+
+    # a `BibliographyCollection` object
+    attr_accessor :bibliographies
+
+    # an `Collections::Asset` object
+    attr_accessor :assets
+
+    # @parameters
+    #   concepts => a `Glossarist::ManagedConceptCollection` object or
+    #               a string containing the path of the folder with concepts
+    #   assets => a collection of Glossarist::Asset
+    def initialize(concepts, assets, options = {})
+      @concepts = read_concepts(concepts)
+      @assets = Glossarist::Collections::AssetCollection.new(assets)
+      @bibliographies = Glossarist::Collections::BibliographyCollection.new(
+        @concepts,
+        options.dig(:bibliography, :global_cache),
+        options.dig(:bibliography, :local_cache),
+      )
+    end
+
+    def to_latex(filename = nil)
+      return to_latex_from_file(filename) if filename
+
+      @concepts.map do |concept|
+        latex_template(concept)
+      end.join("\n")
+    end
+
+    private
+
+    def to_latex_from_file(entries_file)
+      File.readlines(entries_file).map do |concept_name|
+        concept = concept_map[concept_name.strip.downcase]
+
+        if concept.nil?
+           puts "  [Not Found]: #{concept_name.strip}"
+        else
+          latex_template(concept)
+        end
+      end.compact.join("\n")
+    end
+
+    def read_concepts(concepts)
+      return concepts if concepts.is_a?(Glossarist::ManagedConceptCollection)
+
+      collection = Glossarist::ManagedConceptCollection.new
+      collection.load_from_files(concepts)
+      collection
+    end
+
+    def latex_template(concept)
+      <<~TEMPLATE
+        \\newglossaryentry{#{concept.default_designation.gsub('_', '-')}}
+        {
+        name={#{concept.default_designation.gsub('_', '\_')}}
+        description={#{normalize_definition(concept.default_definition)}}
+        }
+      TEMPLATE
+    end
+
+    def normalize_definition(definition)
+      definition.gsub(/{{([^}]*)}}/) do |match|
+        "\\textbf{\\gls{#{Regexp.last_match[1].gsub('_', '-')}}}"
+      end
+    end
+
+    def concept_map
+      @concept_map ||= concepts.managed_concepts.map do |concept|
+        [concept.default_designation.downcase, concept]
+      end.to_h
+    end
+  end
+end

data/lib/glossarist/managed_concept.rb

@@ -85,6 +85,15 @@ module Glossarist
       localized&.terms&.first&.designation
     end
 
+    def default_definition
+      localized = localization("eng") || localizations.values.first
+      localized&.definition&.first&.content
+    end
+
+    def default_lang
+      localization("eng") || localizations.values.first
+    end
+
     def managed_concept_attributes
       %i[
         id

data/lib/glossarist/version.rb

@@ -4,5 +4,5 @@
 #
 
 module Glossarist
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/lib/glossarist.rb

@@ -9,11 +9,13 @@ require_relative "glossarist/utilities"
 require_relative "glossarist/version"
 require_relative "glossarist/glossary_definition"
 
+require_relative "glossarist/asset"
 require_relative "glossarist/model"
 require_relative "glossarist/concept_date"
 require_relative "glossarist/detailed_definition"
 require_relative "glossarist/related_concept"
 require_relative "glossarist/citation"
+require_relative "glossarist/concept_set"
 require_relative "glossarist/concept_source"
 require_relative "glossarist/collection"
 require_relative "glossarist/designation"
@@ -24,6 +26,8 @@ require_relative "glossarist/concept_manager"
 require_relative "glossarist/managed_concept"
 require_relative "glossarist/non_verb_rep"
 
+require_relative "glossarist/collections"
+
 module Glossarist
   class Error < StandardError; end
   class InvalidTypeError < StandardError; end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: glossarist-new
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: relaton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -72,11 +86,16 @@ files:
 - config.yml
 - glossarist.gemspec
 - lib/glossarist.rb
+- lib/glossarist/asset.rb
 - lib/glossarist/citation.rb
 - lib/glossarist/collection.rb
+- lib/glossarist/collections.rb
+- lib/glossarist/collections/asset_collection.rb
+- lib/glossarist/collections/bibliography_collection.rb
 - lib/glossarist/concept.rb
 - lib/glossarist/concept_date.rb
 - lib/glossarist/concept_manager.rb
+- lib/glossarist/concept_set.rb
 - lib/glossarist/concept_source.rb
 - lib/glossarist/designation.rb
 - lib/glossarist/designation/abbreviation.rb
@@ -117,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: Concept models for terminology glossaries conforming ISO 10241-1.