glossarist-new 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fca876eda8d9aaf1f9c931e93b47865f618f37991b317cf9a9b1aecaee4f60cf
+  data.tar.gz: 9af3d0caefb3ecf7c1cc8958b4440641d279126bcc4a2888feb91ee4bb2ccf42
+SHA512:
+  metadata.gz: 35fd58588549adf1b1978b6688b21257f8a9f094246daa69365f6e031a0c9e6de9ddbd57835692f80b4fbbe0a4f8cd40af8f60e2dd237cb397d8fb515824bd21
+  data.tar.gz: 9f0843c03da02ffde2f6defad7f6d42732842ecb32cbbd560283d6e2ac5700073e7573ecf5d74e0764b781fedcb9fe48caae1d9a3de80c5e7d0a89976a603c8e

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+
+[{*.adoc,*.html,*.js,*.json,*.rake,*.rb,*.rf,*.yaml,*.yml,Rakefile,rakefile}]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test
+
+on:
+  - push
+  - pull_request
+  - workflow_dispatch
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+          - "2.4"
+
+    steps:
+      - name: Fetch source code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+
+# RSpec failure tracking
+.rspec_status
+
+# RuboCop caches
+.rubocop-http---*
+.rubocop-https---*
+

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+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

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2021, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,11 @@
+= Glossarist
+
+== Credits
+
+This gem is developed, maintained and funded by
+https://www.ribose.com[Ribose Inc.]
+
+== License
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/BSD-2-Clause[2-Clause BSD License].

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

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/glossarist.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/glossarist/version"
+
+all_files_in_git = Dir.chdir(File.expand_path(__dir__)) do
+  `git ls-files -z`.split("\x0")
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "glossarist-new"
+  spec.version       = Glossarist::VERSION
+  spec.authors       = ["Ribose"]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       =
+    "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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files         = all_files_in_git
+    .reject { |f| f.match(%r{\A(?:test|spec|features|bin|\.)/}) }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry", "~> 0.14.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+end

data/lib/glossarist/citation.rb

@@ -0,0 +1,85 @@
+# 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)
+      @source = ref["source"]
+      @id = ref["id"]
+      @version = ref["version"]
+    end
+
+    private
+
+    def ref_to_h
+      if structured?
+        { "source" => source, "id" => id, "version" => version }.compact
+      else
+        text
+      end
+    end
+  end
+end

data/lib/glossarist/collection.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  # @todo Add support for lazy concept loading.
+  # @todo Consider extracting persistence backend to a separate class.
+  class Collection
+    include Enumerable
+
+    # 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
+      @index = {}
+    end
+
+    def each(&block)
+      @index.each_value(&block)
+    end
+
+    # Returns concept with given ID, if it is present in collection, or +nil+
+    # otherwise.
+    #
+    # @param id [String]
+    #    Concept ID
+    # @return [Concept, nil]
+    def fetch(id)
+      @index[id]
+    end
+
+    alias :[] :fetch
+
+    # If concept with given ID is present in this collection, returns that
+    # concept.  Otherwise, instantiates a new concept, adds it to
+    # the collection, and returns it.
+    #
+    # @param id [String]
+    #    Concept ID
+    # @return [Concept]
+    def fetch_or_initialize(id)
+      fetch(id) or store(Concept.new(id: id))
+    end
+
+    # Adds concept to the collection.  If collection contains a concept with
+    # the same ID already, that concept is replaced.
+    #
+    # @param concept [Concept]
+    #   concept about to be added
+    def store(concept)
+      @index[concept.id] = concept
+    end
+
+    alias :<< :store
+
+    # Reads all concepts from files.
+    def load_concepts
+      Dir.glob(concepts_glob) do |filename|
+        store(load_concept_from_file(filename))
+      end
+    end
+
+    private def load_concept_from_file(filename)
+      Concept.from_h(Psych.safe_load(File.read(filename)))
+    end
+
+    # Writes all concepts to files.
+    def save_concepts
+      @index.each_value &method(:save_concept_to_file)
+    end
+
+    private 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

data/lib/glossarist/concept.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class Concept < Model
+    # Concept ID.
+    # @return [String]
+    attr_accessor :id
+    alias :termid= :id=
+
+    # 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
+
+    def initialize(*)
+      @localizations = {}
+      @sources = []
+      @related = []
+      @notes = []
+      @designations = []
+
+      super
+    end
+
+    # 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
+
+    def notes=(notes)
+      @notes = notes&.map { |n| DetailedDefinition.new(n) }
+    end
+
+    def definition=(definition)
+      @definition = definition&.map { |d| DetailedDefinition.new(d) }
+    end
+
+    def designations=(designations)
+      @designations = designations&.map do |designation|
+        Designation::Base.from_h(designation)
+      end
+    end
+
+    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
+      {
+        "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
+    end
+
+    # @deprecated For legacy reasons only.
+    #   Implicit conversion (i.e. {#to_hash} alias) will be removed soon.
+    alias :to_hash :to_h
+
+    # rubocop:disable Metrics/AbcSize, Style/RescueModifier
+    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 }
+          .compact
+
+        concept.related = hash.dig("related") || []
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Style/RescueModifier
+
+    # All Related Concepts
+    # @return [Array<RelatedConcept>]
+    def related
+      @related.empty? ? nil : @related
+    end
+
+    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
+
+    private
+
+    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
+
+    def concepts_glob
+      File.join(path, "concept-*.{yaml,yml}")
+    end
+  end
+end