glossarist 0.2.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15883cde9ccc6f1d81e6851314ef7cae3835fd679c320b961be4310eea0e3384
-  data.tar.gz: b0821aa718dbc0caa858ff5d1ab0723937e4c527d9a98a6a182f4976637d32d0
+  metadata.gz: 6ef95bd483f8056cb7238fba5a2c701879f1d51250627250a8c10dec04da9df0
+  data.tar.gz: 9fe8e9bdc77e630c36edf6f8500b9b91d62a2c10395664798304719161860545
 SHA512:
-  metadata.gz: 295691e8f62944ea642ed41861146e0d321ec2c793d519227d1ad1cdde174787d8ad9a219bfbe19a3d4b7eb60395a53c37f6375151cc5a89a707694367614be4
-  data.tar.gz: 6a0c63bfd7b33bc7803e0daa685d677dc6bb061e4bf09be415878f10e72c3c836285d36b38da61628438ea7c9afb0d03eed566a1f8a9af5993990ffc6fe819c3
+  metadata.gz: e224dd6e334eecf6bf9e8cdfbca206aabfbfc42967479625db0f677dddabe6b6dc3c7d9eb77f2462e140aac762c0707d35b8252884879f71f3de727b37443e55
+  data.tar.gz: 0a17ff365ff523f83e553c376b4d53b58df84fd2916e00dbcb874a10a017eb5c78e9c3285bf1355de5f572faeb5bb5ae1aabc76611699e205368cfaf7bbf6a73

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-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

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

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
   enabled: true
-  config_file: .rubocop.yml
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,35 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  TargetRubyVersion: 2.4
-
-# This one breaks plenty of RSpec idioms.
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*"
-
-# Defining a constant or class inside RSpec.describe block
-# sometimes makes sense.
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "spec/**/*"
-
-# This requirement is silly to me.
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-# Makes little sense for Glossarist models, as these attr_accessors should all
-# be documented eventually.
-Style/AccessorGrouping:
-  Enabled: false
-
-# This requirement is silly to me.
-Style/ClassCheck:
-  Enabled: false
-
-# This requirement is silly to me.
-Style/SingleArgumentDig:
-  Enabled: false
+  TargetRubyVersion: 2.5

data/README.adoc

@@ -1,5 +1,28 @@
 = Glossarist
 
+== Commands
+
+generate_latex: Convert Concepts to Latex format
+
+=== Usage:
+  glossarist generate_latex p, --concepts-path=CONCEPTS_PATH
+
+=== Options:
+[cols="1,1"]
+|===
+|p, --concepts-path
+|Path to yaml concepts directory
+
+|l, --latex-concepts
+|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
+
+|o, --output-file
+|Output file path. By default the output will pe printed to the console
+
+|e, --extra-attributes
+|List of extra attributes that are not in standard Glossarist Concept model. eg -e one two three
+|===
+
 == Credits
 
 This gem is developed, maintained and funded by

data/config.yml

@@ -0,0 +1,83 @@
+# This file can be used to configure enum attributes in the model.
+# For example to add different allowed values for Abbreviation::Type
+# you can change the values under abbreviation => type
+#
+# NOTE: All the keys in this file are needed for the script to run
+#       and should not be removed. You can change the values but atleast
+#       one option should be present in each list.
+
+concept_source:
+  status:
+    - identical
+    - similar
+    - modified
+    - restyle
+    - context_added
+    - generalisation
+    - specialisation
+    - unspecified
+    - related
+    - not_equal
+  type:
+    - authoritative
+    - lineage
+
+designation:
+  base:
+    normative_status:
+      - preferred
+      - deprecated
+      - admitted
+      - <símbolo> # in iev-data => '<symbol>'
+      - 티에스 # in iev-data => translates to 'TS' I think it is a synonym and not status.
+      - prąd startowy # in iev-data => 'starting current' I think it is a synonym and not status.
+
+related_concept:
+  type:
+    - deprecates
+    - supersedes
+    - superseded_by
+    - narrower
+    - broader
+    - equivalent
+    - compare
+    - contrast
+    - see
+
+abbreviation:
+  type:
+    - truncation
+    - acronym
+    - initialism
+
+grammar_info:
+  boolean_attribute:
+    - preposition
+    - participle
+    - adj
+    - verb
+    - adverb
+    - noun
+  gender:
+    - m
+    - f
+    - n
+    - c
+  number:
+    - singular
+    - dual
+    - plural
+
+concept:
+  status:
+    - draft
+    - not_valid
+    - valid
+    - superseded
+    - retired
+
+concept_date:
+  type:
+    - accepted
+    - amended
+    - retired

data/exe/glossarist

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+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"
+  def generate_latex
+    assets = []
+    latex_concepts_file = options[:latex_concepts]
+
+    if options[:extra_attributes]
+      Glossarist.configure do |config|
+        config.register_extension_attributes(options[:extra_attributes])
+      end
+    end
+
+    concept_set = Glossarist::ConceptSet.new(options[:concepts_path], assets)
+    latex_str = concept_set.to_latex(latex_concepts_file)
+
+    output_file_path = options[:output_file]
+    if output_file_path
+      File.open(output_file_path, "w") do |file|
+        file.puts latex_str
+      end
+    else
+      puts latex_str
+    end
+  end
+
+  def method_missing(*args)
+    warn "No method found named: #{args[0]}"
+    warn "Run with `--help` or `-h` to see available options"
+    exit 1
+  end
+
+  def respond_to_missing?
+    true
+  end
+
+  def self.exit_on_failure?
+    true
+  end
+end
+
+GlossaristCommand.start(ARGV)

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,9 @@ 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_dependency "thor"
+
   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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class Citation < Model
+    # Unstructured (plain text) reference.
+    # @return [String]
+    attr_accessor :text
+
+    # Source in structured reference.
+    # @return [String]
+    attr_accessor :source
+
+    # Document ID in structured reference.
+    # @return [String]
+    attr_accessor :id
+
+    # Document version in structured reference.
+    # @return [String]
+    attr_accessor :version
+
+    # @return [String]
+    # Referred clause of the document.
+    attr_accessor :clause
+
+    # Link to document.
+    # @return [String]
+    attr_accessor :link
+
+    # Original ref text before parsing.
+    # @return [String]
+    # @note This attribute is likely to be removed or reworked in future.
+    #   It is arguably not relevant to Glossarist itself.
+    attr_accessor :original
+
+    # Whether it is a plain text ref.
+    # @return [Boolean]
+    def plain?
+      (source && id && version).nil?
+    end
+
+    # Whether it is a structured ref.
+    # @return [Boolean]
+    def structured?
+      !plain?
+    end
+
+    def to_h
+      {
+        "ref" => ref_to_h,
+        "clause" => clause,
+        "link" => link,
+        "original" => original,
+      }.compact
+    end
+
+    def self.from_h(hash)
+      hash = hash.dup
+
+      ref_val = hash.delete("ref")
+      hash.merge!(Hash === ref_val ? ref_val : {"text" => ref_val})
+      hash.compact!
+
+      super(hash)
+    end
+
+    def ref=(ref)
+      if ref.is_a?(Hash)
+        @source = ref["source"]
+        @id = ref["id"]
+        @version = ref["version"]
+      else
+        @text = ref
+      end
+    end
+
+    private
+
+    def ref_to_h
+      if structured?
+        { "source" => source, "id" => id, "version" => version }.compact
+      else
+        text
+      end
+    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

@@ -8,44 +8,108 @@ module Glossarist
     # Concept ID.
     # @return [String]
     attr_accessor :id
+    alias :termid= :id=
 
-    # All localizations for this concept.
-    #
-    # Keys are language codes and values are instances of {LocalizedConcept}.
-    # @return [Hash<String, LocalizedConcept>]
-    attr_reader :localizations
+    # Concept designations.
+    # @todo Alias +terms+ exists only for legacy reasons and will be removed.
+    # @return [Array<Designations::Base>]
+    attr_reader :designations
+    alias :terms :designations
+
+    # <<BasicDocument>>LocalizedString
+    # @return [String]
+    attr_accessor :domain
+
+    # <<BasicDocument>>LocalizedString
+    # @return [String]
+    attr_accessor :subject
+
+    # Concept definition.
+    # @return [Array<DetailedDefinition>]
+    attr_reader :definition
+
+    # Non verbal representation of the concept.
+    # @return [NonVerbRep]
+    attr_accessor :non_verb_rep
+
+    # Concept notes
+    # @return [Array<DetailedDefinition>]
+    attr_reader :notes
+
+    # Concept examples
+    # @return [Array<DetailedDefinition>]
+    attr_reader :examples
+
+    # Contains list of extended attributes
+    attr_accessor :extension_attributes
 
     def initialize(*)
       @localizations = {}
+      @sources = []
+      @related = []
+      @notes = []
+      @designations = []
+      @extension_attributes = {}
+
       super
     end
 
-    # Adds concept localization.
-    # @param localized_concept [LocalizedConcept]
-    def add_localization(localized_concept)
-      lang = localized_concept.language_code
-      localizations.store(lang, localized_concept)
+    # List of authorative sources.
+    # @todo Alias +authoritative_source+ exists for legacy reasons and may be
+    #   removed.
+    # @return [Array<ConceptSource>]
+    attr_reader :sources
+    alias :authoritative_source :sources
+
+    # return [Array<ConceptDate>]
+    attr_reader :dates
+
+    def examples=(examples)
+      @examples = examples&.map { |e| DetailedDefinition.new(e) }
     end
 
-    alias :add_l10n :add_localization
+    def notes=(notes)
+      @notes = notes&.map { |n| DetailedDefinition.new(n) }
+    end
+
+    def definition=(definition)
+      @definition = definition&.map { |d| DetailedDefinition.new(d) }
+    end
 
-    # Returns concept localization.
-    # @param lang [String] language code
-    # @return [LocalizedConcept]
-    def localization(lang)
-      localizations[lang]
+    def designations=(designations)
+      @designations = designations&.map do |designation|
+        Designation::Base.from_h(designation)
+      end
     end
 
-    alias :l10n :localization
+    alias :terms= :designations=
+
+    def dates=(dates)
+      @dates = dates&.map { |d| ConceptDate.new(d) }
+    end
+
+    def sources=(sources)
+      @sources = sources&.map do |source|
+        ConceptSource.new(source)
+      end || []
+    end
+
+    def authoritative_source=(sources)
+      self.sources = sources&.map do |source|
+        source.merge({ "type" => "authoritative" })
+      end
+    end
 
     def to_h
       {
-        "termid" => id,
-        "term" => default_designation,
-        "related" => related_concepts,
+        "id" => id,
+        "related" => related&.map(&:to_h),
+        "terms" => (terms&.map(&:to_h) || []),
+        "definition" => definition&.map(&:to_h),
+        "notes" => notes&.map(&:to_h),
+        "examples" => examples&.map(&:to_h),
       }
       .compact
-      .merge(localizations.transform_values(&:to_h))
     end
 
     # @deprecated For legacy reasons only.
@@ -56,27 +120,28 @@ module Glossarist
     def self.from_h(hash)
       new.tap do |concept|
         concept.id = hash.dig("termid")
+        concept.sources = hash.dig("sources")
+        concept.related = hash.dig("related")
+        concept.definition = hash.dig("definition")
 
         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
-          .each { |lc| concept.add_l10n lc }
 
-        concept.l10n("eng")&.superseded_concepts = hash.dig("related") || []
+        concept.related = hash.dig("related") || []
       end
     end
     # rubocop:enable Metrics/AbcSize, Style/RescueModifier
 
-    def default_designation
-      localized = localization("eng") || localizations.values.first
-      localized&.terms&.first&.designation
+    # All Related Concepts
+    # @return [Array<RelatedConcept>]
+    def related
+      @related.empty? ? nil : @related
     end
 
-    def related_concepts
-      # TODO Someday other relation types too
-      arr = [localization("eng")&.superseded_concepts].flatten.compact
-      arr.empty? ? nil : arr
+    def related=(related)
+      @related = related&.map { |r| RelatedConcept.new(r) } || []
     end
   end
 end

data/lib/glossarist/concept_date.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Glossarist
+  class ConceptDate < Model
+    include Glossarist::Utilities::Enum
+
+    # Iso8601 date
+    # @return [String]
+    attr_accessor :date
+
+    register_enum :type, Glossarist::GlossaryDefinition::CONCEPT_DATE_TYPES
+
+    def to_h
+      {
+        "type" => type,
+        "date" => date,
+      }.compact
+    end
+  end
+end

data/lib/glossarist/concept_manager.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Glossarist
+  class ConceptManager
+    # Path to concepts directory.
+    # @return [String]
+    attr_accessor :path
+
+    # @param path [String]
+    #   concepts directory path, either absolute or relative to CWD
+    def initialize(path: nil)
+      @path = path
+    end
+
+    # Reads all concepts from files.
+    def load_from_files(collection: nil)
+      collection ||= ManagedConceptCollection.new
+
+      Dir.glob(concepts_glob) do |filename|
+        collection.store(load_concept_from_file(filename))
+      end
+    end
+
+    # Writes all concepts to files.
+    def save_to_files(managed_concepts)
+      managed_concepts.each_value &method(:save_concept_to_file)
+    end
+
+    def load_concept_from_file(filename)
+      ManagedConcept.new(Psych.safe_load(File.read(filename)))
+    end
+
+    def save_concept_to_file(concept)
+      filename = File.join(path, "concept-#{concept.id}.yaml")
+      File.write(filename, Psych.dump(concept.to_h))
+    end
+
+    private
+
+    def concepts_glob
+      File.join(path, "concept-*.{yaml,yml}")
+    end
+  end
+end