glossarist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34ea633c0a5f8f609e12c72d8a835fd8675f8cf52996633ed9c84c9d304f73cc
+  data.tar.gz: a855be248a3ae9d9435969643660210a30ae1f7912b0c714ed4a7d1ee09632f3
+SHA512:
+  metadata.gz: b98c00342f4107b361ddc27f7e6323540c1335a339b54594c7944a4d45e1dcf4746070f38cd91934320a39d2616305055f9cf62b88253deb1842686f238cbed1
+  data.tar.gz: 8ec6121d3a5dd24e3c032bf92ab4e31ceefaf451aa81bf8f395c4d78e34e2ec1c594173f997c646af9f2a5b094db490a9f3fdcec1f8d4a57b8c79afa5107aa7b

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,37 @@
+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"
+
+    name: Run tests
+    runs-on: ubuntu-latest
+
+    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/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"
+  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.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+require "psych"
+
+require_relative "glossarist/version"
+
+require_relative "glossarist/model"
+require_relative "glossarist/concept"
+require_relative "glossarist/collection"
+require_relative "glossarist/localized_concept"
+
+module Glossarist
+  class Error < StandardError; end
+  # Your code goes here...
+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,81 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class Concept < Model
+    # Concept ID.
+    # @return [String]
+    attr_accessor :id
+
+    # All localizations for this concept.
+    #
+    # Keys are language codes and values are instances of {LocalizedConcept}.
+    # @return [Hash<String, LocalizedConcept>]
+    attr_reader :localizations
+
+    def initialize(*)
+      @localizations = {}
+      super
+    end
+
+    # Adds concept localization.
+    # @param localized_concept [LocalizedConcept]
+    def add_localization(localized_concept)
+      lang = localized_concept.language_code
+      localizations.store(lang, localized_concept)
+    end
+
+    alias :add_l10n :add_localization
+
+    # Returns concept localization.
+    # @param lang [String] language code
+    # @return [LocalizedConcept]
+    def localization(lang)
+      localizations[lang]
+    end
+
+    alias :l10n :localization
+
+    def to_h
+      {
+        "termid" => id,
+        "term" => default_designation,
+        "related" => related_concepts,
+        **localizations.transform_values(&: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")
+
+        hash.values
+          .grep(Hash)
+          .map { |subhash| LocalizedConcept.from_h(subhash) rescue nil }
+          .compact
+          .each { |lc| concept.add_l10n lc }
+
+        concept.l10n("eng")&.superseded_concepts = hash.dig("related_concepts")
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Style/RescueModifier
+
+    def default_designation
+      localized = localization("eng") || localizations.values.first
+      localized&.terms&.dig(0, "designation")
+    end
+
+    def related_concepts
+      # TODO Someday other relation types too
+      arr = [localization("eng")&.superseded_concepts].flatten.compact
+      arr.empty? ? nil : arr
+    end
+  end
+end

data/lib/glossarist/localized_concept.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class LocalizedConcept < Model
+    # Needs to be identical with {Concept#id}.
+    # @todo Here for legacy reasons.  Will be removed eventually.
+    attr_accessor :id
+
+    # ISO 639-2 code for terminology.
+    # @see https://www.loc.gov/standards/iso639-2/php/code_list.php code list
+    # @return [String]
+    attr_accessor :language_code
+
+    # Concept designations.
+    # @todo Alias +terms+ exists only for legacy reasons and will be removed.
+    # @todo Right now accepts hashes for legacy reasons, but they will be
+    #   replaced with dedicated classes.
+    # @return [Array<Hash>]
+    attr_accessor :designations
+    alias :terms :designations
+    alias :terms= :designations=
+
+    # @return [Array<String>]
+    attr_accessor :notes
+
+    # @return [Array<String>]
+    attr_accessor :examples
+
+    # Concept definition.
+    # @todo Support multiple definitions.
+    # @return [String]
+    attr_accessor :definition
+
+    # @todo Right now accepts hashes for legacy reasons, but they will be
+    #   replaced with dedicated classes.
+    # @return [Hash]
+    attr_accessor :authoritative_source
+
+    # Must be one of the following:
+    # +notValid+, +valid+, +superseded+, +retired+.
+    # @todo Proper type checking.
+    # @note Works with strings, but soon they may be replaced with symbols.
+    # @return [String]
+    attr_accessor :entry_status
+
+    # Must be one of the following:
+    # +preferred+, +admitted+, +deprecated+.
+    # @todo Proper type checking.
+    # @note Works with strings, but soon they may be replaced with symbols.
+    # @return [String]
+    attr_accessor :classification
+
+    attr_accessor :review_date
+    attr_accessor :review_decision_date
+    attr_accessor :review_decision_event
+
+    attr_accessor :date_accepted
+    attr_accessor :date_amended
+
+    # @todo Here for legacy reasons.  Will be moved to Concept.
+    # @todo Right now is an array of hashes for legacy reasons, but these hashes
+    #    will be replaced with some dedicated class.
+    # @todo Should be read-only, but for now it is not for legacy reasons.
+    #    Don't use the setter.
+    # @return [Array<Hash>]
+    attr_accessor :superseded_concepts
+
+    def initialize(*)
+      @examples = []
+      @notes = []
+      @designations = []
+      super
+    end
+
+    def to_h # rubocop:disable Metrics/MethodLength
+      {
+        "id" => id,
+        "terms" => terms,
+        "definition" => definition,
+        "language_code" => language_code,
+        "notes" => notes,
+        "examples" => examples,
+        "entry_status" => entry_status,
+        "classification" => classification,
+        "authoritative_source" => authoritative_source,
+        "date_accepted" => date_accepted,
+        "date_amended" => date_amended,
+        "review_date" => review_date,
+        "review_decision_date" => review_decision_date,
+        "review_decision_event" => review_decision_event,
+      }.compact
+    end
+
+    # @deprecated For legacy reasons only.
+    #   Implicit conversion (i.e. {#to_hash} alias) will be removed soon.
+    alias :to_hash :to_h
+  end
+end

data/lib/glossarist/model.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  class Model
+    def initialize(attributes = {})
+      attributes.each_pair { |k, v| set_attribute(k, v) }
+    end
+
+    def set_attribute(name, value)
+      public_send("#{name}=", value)
+    rescue NoMethodError
+      raise ArgumentError, "#{self.class.name} does not have " +
+        "attribute #{name} defined or the attribute is read only."
+    end
+
+    def self.from_h(hash)
+      new(hash)
+    end
+  end
+end

data/lib/glossarist/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: glossarist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- glossarist.gemspec
+- lib/glossarist.rb
+- lib/glossarist/collection.rb
+- lib/glossarist/concept.rb
+- lib/glossarist/localized_concept.rb
+- lib/glossarist/model.rb
+- lib/glossarist/version.rb
+homepage: https://github.com/glossarist/glossarist-ruby
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/glossarist/glossarist-ruby
+  source_code_uri: https://github.com/glossarist/glossarist-ruby
+  bug_tracker_uri: https://github.com/glossarist/glossarist-ruby/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Concept models for terminology glossaries conforming ISO 10241-1.
+test_files: []