glossarist 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81224c902256db7a2b325cc0969d35d044c52ee7a30e67c9c5c77c25c661ca45
-  data.tar.gz: db259d46d23ba8f78bedb40c998cae8ab5e5e46ef5debf3f63360c5ab420dd81
+  metadata.gz: 15883cde9ccc6f1d81e6851314ef7cae3835fd679c320b961be4310eea0e3384
+  data.tar.gz: b0821aa718dbc0caa858ff5d1ab0723937e4c527d9a98a6a182f4976637d32d0
 SHA512:
-  metadata.gz: b141c56e7cce306ebdaca6c67f813de0fbfae1dbc343b576842d5515f54dba7f2a9861aaca60505ccf7ae49b6cc5a53279409dd3892d19b9b4d94a4007438298
-  data.tar.gz: 16bc4e45b695adbe4ac4a8c6e1a6b6dbd47bf981f70342f29f223c0f8a77a05c7f1bbb0ee2a862398ed80c8599e3ffc1873e37e2b3c6fea5fbcc86a480662434
+  metadata.gz: 295691e8f62944ea642ed41861146e0d321ec2c793d519227d1ad1cdde174787d8ad9a219bfbe19a3d4b7eb60395a53c37f6375151cc5a89a707694367614be4
+  data.tar.gz: 6a0c63bfd7b33bc7803e0daa685d677dc6bb061e4bf09be415878f10e72c3c836285d36b38da61628438ea7c9afb0d03eed566a1f8a9af5993990ffc6fe819c3

data/lib/glossarist.rb

@@ -10,6 +10,7 @@ require_relative "glossarist/version"
 require_relative "glossarist/model"
 require_relative "glossarist/concept"
 require_relative "glossarist/collection"
+require_relative "glossarist/designations"
 require_relative "glossarist/localized_concept"
 
 module Glossarist

data/lib/glossarist/concept.rb

@@ -70,7 +70,7 @@ module Glossarist
 
     def default_designation
       localized = localization("eng") || localizations.values.first
-      localized&.terms&.dig(0, "designation")
+      localized&.terms&.first&.designation
     end
 
     def related_concepts

data/lib/glossarist/designations.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+module Glossarist
+  module Designations
+    class Base < Model
+      # @note This is not entirely aligned with agreed schema and may be
+      #   changed.
+      attr_accessor :designation
+
+      attr_accessor :normative_status
+      attr_accessor :geographical_area
+
+      def self.from_h(hash)
+        type = hash["type"]
+
+        if type.nil? || /\w/ !~ type
+          raise ArgumentError, "designation type is missing"
+        end
+
+        designation_subclass = SERIALIZED_TYPES[type]
+
+        if self == Base
+          # called on Base class, delegate it to proper subclass
+          SERIALIZED_TYPES[type].from_h(hash)
+        else
+          # called on subclass, instantiate object
+          unless SERIALIZED_TYPES[self] == type
+            raise ArgumentError, "unexpected designation type: #{type}"
+          end
+          super(hash.reject { |k, _| k == "type" })
+        end
+      end
+    end
+
+    class Expression < Base
+      attr_accessor :gender
+      attr_accessor :part_of_speech
+      attr_accessor :plurality
+      attr_accessor :prefix
+      attr_accessor :usage_info
+
+      def to_h
+        {
+          "type" => "expression",
+          "prefix" => prefix,
+          "normative_status" => normative_status,
+          "usage_info" => usage_info,
+          "designation" => designation,
+          "part_of_speech" => part_of_speech,
+          "geographical_area" => geographical_area,
+          "gender" => gender,
+          "plurality" => plurality,
+        }.compact
+      end
+    end
+
+    class Symbol < Base
+      attr_accessor :international
+
+      def to_h
+        {
+          "type" => "symbol",
+          "normative_status" => normative_status,
+          "geographical_area" => geographical_area,
+          "designation" => designation,
+          "international" => international,
+        }.compact
+      end
+    end
+
+    # Bi-directional class-to-string mapping for STI-like serialization.
+    SERIALIZED_TYPES = {
+      Expression => "expression",
+      Symbol => "symbol",
+    }
+    .tap { |h| h.merge!(h.invert) }
+    .freeze
+  end
+end

data/lib/glossarist/localized_concept.rb

@@ -16,9 +16,7 @@ module Glossarist
 
     # 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>]
+    # @return [Array<Designations::Base>]
     attr_accessor :designations
     alias :terms :designations
     alias :terms= :designations=
@@ -84,7 +82,7 @@ module Glossarist
     def to_h # rubocop:disable Metrics/MethodLength
       {
         "id" => id,
-        "terms" => terms,
+        "terms" => (terms&.map(&:to_h) || []),
         "definition" => definition,
         "language_code" => language_code,
         "notes" => notes,
@@ -100,6 +98,11 @@ module Glossarist
       }.compact
     end
 
+    def self.from_h(hash)
+      terms = hash["terms"]&.map { |h| Designations::Base.from_h(h) } || []
+      super(hash.merge({"terms" => terms}))
+    end
+
     # @deprecated For legacy reasons only.
     #   Implicit conversion (i.e. {#to_hash} alias) will be removed soon.
     alias :to_hash :to_h

data/lib/glossarist/version.rb

@@ -4,5 +4,5 @@
 #
 
 module Glossarist
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glossarist
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose
@@ -73,6 +73,7 @@ files:
 - lib/glossarist.rb
 - lib/glossarist/collection.rb
 - lib/glossarist/concept.rb
+- lib/glossarist/designations.rb
 - lib/glossarist/localized_concept.rb
 - lib/glossarist/model.rb
 - lib/glossarist/version.rb