glossarist-new 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442880e43fea97be6b9226dfe85895005fff7201cc5e5fda9560a83bf930e868
-  data.tar.gz: f2e3741feadb58449f9a968c656fc6b8b5efd62356f7f79b400c71081776c989
+  metadata.gz: f0b88c582178e67916b7058bba75f92a14b5862926188092fa6e539c0eb05ad5
+  data.tar.gz: c7d3c4e294f2f77279e712d865239a824ea84ee8fb2a884e23f935c9ca5b871e
 SHA512:
-  metadata.gz: 5b8fa26c16edb86abc96b9eea2c06903dc37caf330fd99f3adc22d5bb661c6c661b71f50bf8600eb0884f9a16216e22161d39c14a296d79b66626a8829460505
-  data.tar.gz: e78d3c5eddb092014afaecd9097e3857da8765a8bf28b8ad4858ef5f54841d744ece34e465960baa5e9350a1c4aa8bb61a898cc96eb6b95d945d333463d6722c
+  metadata.gz: 2ed31f71ae7f554ed6e4f32f27f2203d78c66ce95e6f1e33502cc610142d9cef534ba21fe6a01aee37bf75f6d889b61f99780448e12aa591e4454cf73986d891
+  data.tar.gz: aa4f3b7c9882afde4d1bbf541ccf509150e434a63fa0f68314d6f72e48d344a22d73524eed91524b5b81c83105cc9917c5c469a24560c181619fe0c10c827f01

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/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.rb

@@ -122,7 +122,7 @@ module Glossarist
 
         hash.values
           .grep(Hash)
-          .map { |subhash| LocalizedConcept.from_h(subhash) rescue nil }
+          .map { |subhash| Config.class_for(:localized_concept).from_h(subhash) rescue nil }
           .compact
 
         concept.related = hash.dig("related") || []

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/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Glossarist
+  class Config
+    include Singleton
+
+    DEFAULT_CLASSES = {
+      localized_concept: Glossarist::LocalizedConcept,
+    }.freeze
+
+    attr_reader :registered_classes
+
+    def initialize
+      @registered_classes = DEFAULT_CLASSES.dup
+    end
+
+    def class_for(name)
+      @registered_classes[name.to_sym]
+    end
+
+    def register_class(class_name, klass)
+      @registered_classes[class_name] = klass
+    end
+
+    class << self
+      def class_for(name)
+        self.instance.class_for(name)
+      end
+
+      def register_class(class_name, klass)
+        self.instance.register_class(class_name, klass)
+      end
+    end
+  end
+end

data/lib/glossarist/managed_concept.rb

@@ -36,7 +36,7 @@ module Glossarist
     end
 
     def localized_concepts=(localized_concepts_hash)
-      @localized_concepts = localized_concepts_hash.map { |l| LocalizedConcept.new(l) }.compact
+      @localized_concepts = localized_concepts_hash.map { |l| Config.class_for(:localized_concept).new(l) }.compact
 
       @localized_concepts.each do |l|
         add_l10n(l)
@@ -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.1"
+  VERSION = "1.0.3"
 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,8 +26,18 @@ require_relative "glossarist/concept_manager"
 require_relative "glossarist/managed_concept"
 require_relative "glossarist/non_verb_rep"
 
+require_relative "glossarist/collections"
+
+require_relative "glossarist/config"
+
 module Glossarist
   class Error < StandardError; end
   class InvalidTypeError < StandardError; end
   # Your code goes here...
+
+  def self.configure
+    config = Glossarist::Config.instance
+
+    yield(config) if block_given?
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: glossarist-new
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-23 00:00:00.000000000 Z
+date: 2023-03-10 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,12 +86,18 @@ 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/config.rb
 - lib/glossarist/designation.rb
 - lib/glossarist/designation/abbreviation.rb
 - lib/glossarist/designation/base.rb
@@ -117,14 +137,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.