glossarist 2.6.5 → 2.6.7

data/lib/glossarist/v1/concept.rb

@@ -42,22 +42,12 @@ module Glossarist
           mc.add_localization(LocalizedConcept.of_yaml({ "data" => data }))
         end
 
+        assign_domains(mc) if groups.is_a?(Array) && groups.any?
         assign_references(mc) if references.is_a?(Array) && references.any?
 
         mc
       end
 
-      private
-
-      def assign_references(concept)
-        l10n = concept.localization("eng") || concept.localizations.values.first
-        return unless l10n
-
-        l10n.data.references = references.map do |r|
-          ConceptReference.new(r.transform_keys(&:to_sym))
-        end
-      end
-
       def lang_blocks_from(model, value)
         blocks = {}
         value.each do |key, v|
@@ -76,6 +66,23 @@ module Glossarist
           doc[lang] = data
         end
       end
+
+      private
+
+      def assign_domains(concept)
+        concept.data.domains = groups.map do |g|
+          ConceptReference.new(concept_id: g.to_s, ref_type: "domain")
+        end
+      end
+
+      def assign_references(concept)
+        l10n = concept.localization("eng") || concept.localizations.values.first
+        return unless l10n
+
+        l10n.data.references = references.map do |r|
+          ConceptReference.new(r.transform_keys(&:to_sym))
+        end
+      end
     end
   end
 end

data/lib/glossarist/v2/citation.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class Citation < Glossarist::Citation
+      attribute :text, :string
+
+      key_value do
+        map :ref, to: :text, with: { from: :ref_from_yaml, to: :ref_to_yaml }
+        map %i[clause locality],
+            to: :locality,
+            with: { from: :locality_from_yaml, to: :locality_to_yaml }
+        map :link, to: :link
+        map :original, to: :original
+        map %i[custom_locality customLocality], to: :custom_locality
+      end
+
+      def label
+        text
+      end
+
+      def ref_from_yaml(model, value)
+        model.text = case value
+                     when Hash
+                       value["source"] || value[:source]
+                     when String
+                       value
+                     end
+      end
+
+      def ref_to_yaml(model, doc)
+        doc["ref"] = model.text if model.text
+      end
+    end
+  end
+end

data/lib/glossarist/v2/concept_data.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ConceptData < Glossarist::ConceptData
+      attribute :sources, V2::ConceptSource,
+                collection: Collections::ConceptSourceCollection,
+                initialize_empty: true
+      attribute :definition, V2::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :examples, V2::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :notes, V2::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :related, V2::RelatedConcept, collection: true
+
+      key_value do
+        map :dates, to: :dates
+        map :definition, to: :definition, value_map: { to: { empty: :empty } }
+        map :examples, to: :examples, value_map: { to: { empty: :empty } }
+        map :id, to: :id
+        map %i[lineage_source_similarity lineageSourceSimilarity],
+            to: :lineage_source_similarity
+        map :notes, to: :notes, value_map: { to: { empty: :empty } }
+        map :release, to: :release
+        map :sources, to: :sources
+        map :terms, to: :terms,
+                    with: { from: :terms_from_yaml, to: :terms_to_yaml }
+        map :related, to: :related
+        map :references, to: :references
+        map :domain, to: :domain
+        map %i[language_code languageCode], to: :language_code
+        map :script, to: :script
+        map :system, to: :system
+        map %i[entry_status entryStatus], to: :entry_status
+        map %i[review_date reviewDate], to: :review_date
+        map %i[review_decision_date reviewDecisionDate], to: :review_decision_date
+        map %i[review_decision_event reviewDecisionEvent],
+            to: :review_decision_event
+      end
+    end
+  end
+end

data/lib/glossarist/v2/concept_document.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ConceptDocument < Glossarist::ConceptDocument
+      attribute :concept, V2::ManagedConcept
+      attribute :localizations, V2::LocalizedConcept, collection: true
+
+      yamls do
+        sequence do
+          map_document 0, to: :concept, type: V2::ManagedConcept
+          map_document 1.., to: :localizations, type: V2::LocalizedConcept,
+                                             collection: true
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/v2/concept_ref.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ConceptRef < Glossarist::ConceptRef
+    end
+  end
+end

data/lib/glossarist/v2/concept_source.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ConceptSource < Glossarist::ConceptSource
+      attribute :origin, V2::Citation
+
+      key_value do
+        map :origin, to: :origin
+        map :status, to: :status
+        map :type, to: :type
+        map :modification, to: :modification
+      end
+    end
+  end
+end

data/lib/glossarist/v2/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "../context_configuration"
+
+module Glossarist
+  module V2
+    module Configuration
+      extend Glossarist::ContextConfiguration
+
+      CONTEXT_ID = :glossarist_v2
+    end
+  end
+end

data/lib/glossarist/v2/detailed_definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class DetailedDefinition < Glossarist::DetailedDefinition
+      attribute :sources, V2::ConceptSource, collection: true
+
+      key_value do
+        map :content, to: :content
+        map :sources, to: :sources
+      end
+    end
+  end
+end

data/lib/glossarist/v2/localized_concept.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class LocalizedConcept < Glossarist::LocalizedConcept
+      attribute :data, V2::ConceptData, default: -> { V2::ConceptData.new }
+    end
+  end
+end

data/lib/glossarist/v2/managed_concept.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ManagedConcept < Glossarist::ManagedConcept
+      attribute :data, V2::ManagedConceptData, default: -> { V2::ManagedConceptData.new }
+      attribute :related, V2::RelatedConcept, collection: true
+      attribute :sources, V2::ConceptSource, collection: true
+
+      key_value do
+        map :data, to: :data
+        map :id, with: { to: :identifier_to_yaml, from: :identifier_from_yaml }
+        map :identifier,
+            with: { to: :identifier_to_yaml, from: :identifier_from_yaml }
+        map :related, to: :related
+        map :dates, to: :dates
+        map %i[date_accepted dateAccepted],
+            with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
+        map :status, to: :status
+        map :uuid, to: :uuid, with: { from: :uuid_from_yaml, to: :uuid_to_yaml }
+        map :sources, to: :sources
+      end
+    end
+  end
+end

data/lib/glossarist/v2/managed_concept_data.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class ManagedConceptData < Glossarist::ManagedConceptData
+      attribute :sources, V2::ConceptSource, collection: true
+      attribute :localizations, V2::LocalizedConcept,
+                collection: Collections::LocalizationCollection,
+                initialize_empty: true
+      attribute :related, V2::RelatedConcept, collection: true
+
+      key_value do
+        map %i[id identifier], to: :id,
+                               with: { to: :id_to_yaml, from: :id_from_yaml }
+        map :uri, to: :uri
+        map %i[localized_concepts localizedConcepts], to: :localized_concepts
+        map %i[domains groups], to: :domains,
+                                with: { from: :domains_from_yaml, to: :domains_to_yaml }
+        map :sources, to: :sources
+        map :localizations, to: :localizations,
+                            with: { from: :localizations_from_yaml, to: :localizations_to_yaml }
+        map :related, to: :related,
+                      with: { from: :related_from_yaml, to: :related_to_yaml }
+      end
+
+      def localizations_from_yaml(model, value)
+        value.each do |localized_concept_hash|
+          localized_concept = V2::LocalizedConcept.of_yaml(localized_concept_hash)
+          model.localizations.store(localized_concept.language_code,
+                                    localized_concept)
+        end
+      end
+
+      def localizations_to_yaml(model, doc); end
+
+      def related_from_yaml(model, value)
+        return unless value.is_a?(Array)
+
+        model.related = value.map { |r| V2::RelatedConcept.of_yaml(r) }
+      end
+
+      def related_to_yaml(model, doc)
+        return unless model.related&.any?
+
+        doc["related"] = model.related.map(&:to_hash)
+      end
+    end
+  end
+end

data/lib/glossarist/v2/related_concept.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V2
+    class RelatedConcept < Glossarist::RelatedConcept
+      attribute :ref, V2::ConceptRef
+
+      key_value do
+        map :content, to: :content
+        map :type, to: :type
+        map :ref, to: :ref
+      end
+    end
+  end
+end

data/lib/glossarist/v2.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "v2/configuration"
+require_relative "v2/citation"
+require_relative "v2/concept_source"
+require_relative "v2/detailed_definition"
+require_relative "v2/concept_ref"
+require_relative "v2/related_concept"
+require_relative "v2/concept_data"
+require_relative "v2/localized_concept"
+require_relative "v2/managed_concept_data"
+require_relative "v2/managed_concept"
+require_relative "v2/concept_document"
+
+module Glossarist
+  module V2
+    Configuration.register_model(Citation, id: :citation)
+    Configuration.register_model(ConceptSource, id: :concept_source)
+    Configuration.register_model(DetailedDefinition, id: :detailed_definition)
+    Configuration.register_model(ConceptData, id: :concept_data)
+    Configuration.register_model(LocalizedConcept, id: :localized_concept)
+    Configuration.register_model(ConceptRef, id: :concept_ref)
+    Configuration.register_model(RelatedConcept, id: :related_concept)
+    Configuration.register_model(ManagedConceptData, id: :managed_concept_data)
+    Configuration.register_model(ManagedConcept, id: :managed_concept)
+    Configuration.register_model(ConceptDocument, id: :concept_document)
+  end
+end

data/lib/glossarist/v3/bibliography_entry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class BibliographyEntry < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :reference, :string
+      attribute :title, :string
+      attribute :link, :string
+
+      key_value do
+        map :id, to: :id
+        map :reference, to: :reference
+        map :title, to: :title
+        map :link, to: :link
+      end
+    end
+  end
+end

data/lib/glossarist/v3/bibliography_file.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class BibliographyFile < Lutaml::Model::Collection
+      instances :entries, BibliographyEntry
+
+      key_value do
+        map_instances to: :entries
+      end
+
+      def self.from_file(path)
+        return nil unless File.exist?(path)
+
+        from_yaml(File.read(path))
+      end
+
+      def resolve?(anchor)
+        entries.any? { |e| e.id == anchor.to_s }
+      end
+
+      def [](key)
+        entries.find { |e| e.id == key.to_s }
+      end
+    end
+  end
+end

data/lib/glossarist/v3/citation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class Citation < Glossarist::Citation
+      key_value do
+        map :ref, to: :ref, with: { from: :ref_from_yaml, to: :ref_to_yaml }
+      end
+
+      def ref_from_yaml(model, value)
+        case value
+        when Hash
+          model.ref = Ref.new(value.transform_keys(&:to_sym))
+        when String
+          model.ref = Ref.new(source: value)
+        end
+      end
+
+      def ref_to_yaml(model, doc)
+        return unless model.ref
+
+        attrs = {}
+        attrs["source"] = model.ref.source if model.ref.source
+        attrs["id"] = model.ref.id if model.ref.id
+        attrs["version"] = model.ref.version if model.ref.version
+        doc["ref"] = attrs.empty? ? nil : attrs
+      end
+    end
+  end
+end

data/lib/glossarist/v3/concept_data.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ConceptData < Glossarist::ConceptData
+      attribute :sources, V3::ConceptSource,
+                collection: Collections::ConceptSourceCollection,
+                initialize_empty: true
+      attribute :definition, V3::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :examples, V3::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :notes, V3::DetailedDefinition,
+                collection: Collections::DetailedDefinitionCollection,
+                initialize_empty: true
+      attribute :related, V3::RelatedConcept, collection: true
+
+      key_value do
+        map :dates, to: :dates
+        map :definition, to: :definition
+        map :examples, to: :examples
+        map :id, to: :id
+        map %i[lineage_source_similarity lineageSourceSimilarity],
+            to: :lineage_source_similarity
+        map :notes, to: :notes
+        map :release, to: :release
+        map :sources, to: :sources
+        map :terms, to: :terms,
+                    with: { from: :terms_from_yaml, to: :terms_to_yaml }
+        map :related, to: :related
+        map :references, to: :references
+        map :domain, to: :domain
+        map %i[language_code languageCode], to: :language_code
+        map :script, to: :script
+        map :system, to: :system
+        map %i[entry_status entryStatus], to: :entry_status
+        map %i[review_date reviewDate], to: :review_date
+        map %i[review_decision_date reviewDecisionDate], to: :review_decision_date
+        map %i[review_decision_event reviewDecisionEvent],
+            to: :review_decision_event
+      end
+    end
+  end
+end

data/lib/glossarist/v3/concept_document.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ConceptDocument < Glossarist::ConceptDocument
+      attribute :concept, V3::ManagedConcept
+      attribute :localizations, V3::LocalizedConcept, collection: true
+
+      yamls do
+        sequence do
+          map_document 0, to: :concept, type: V3::ManagedConcept
+          map_document 1.., to: :localizations, type: V3::LocalizedConcept,
+                                             collection: true
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/v3/concept_ref.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ConceptRef < Glossarist::ConceptRef
+    end
+  end
+end

data/lib/glossarist/v3/concept_source.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ConceptSource < Glossarist::ConceptSource
+      attribute :origin, V3::Citation
+
+      key_value do
+        map :origin, to: :origin
+        map :status, to: :status
+        map :type, to: :type
+        map :modification, to: :modification
+      end
+    end
+  end
+end

data/lib/glossarist/v3/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "../context_configuration"
+
+module Glossarist
+  module V3
+    module Configuration
+      extend Glossarist::ContextConfiguration
+
+      CONTEXT_ID = :glossarist_v3
+    end
+  end
+end

data/lib/glossarist/v3/detailed_definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class DetailedDefinition < Glossarist::DetailedDefinition
+      attribute :sources, V3::ConceptSource, collection: true
+
+      key_value do
+        map :content, to: :content
+        map :sources, to: :sources
+      end
+    end
+  end
+end

data/lib/glossarist/v3/image_entry.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ImageEntry < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :path, :string
+      attribute :type, :string, default: -> { "image" }
+      attribute :title, :string
+      attribute :alt, :string
+
+      key_value do
+        map :id, to: :id
+        map :path, to: :path
+        map :type, to: :type
+        map :title, to: :title
+        map :alt, to: :alt
+      end
+    end
+  end
+end

data/lib/glossarist/v3/image_file.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ImageFile < Lutaml::Model::Collection
+      instances :entries, ImageEntry
+
+      key_value do
+        map_instances to: :entries
+      end
+
+      def self.from_file(path)
+        return nil unless File.exist?(path)
+
+        from_yaml(File.read(path))
+      end
+
+      def path_for_anchor(anchor)
+        entries.find { |e| e.id == anchor.to_s }&.path
+      end
+
+      def anchor_for_path(path)
+        entries.find { |e| e.path == path }&.id
+      end
+
+      def path?(path)
+        entries.any? { |e| e.path == path }
+      end
+    end
+  end
+end

data/lib/glossarist/v3/localized_concept.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class LocalizedConcept < Glossarist::LocalizedConcept
+      attribute :data, V3::ConceptData, default: -> { V3::ConceptData.new }
+    end
+  end
+end

data/lib/glossarist/v3/managed_concept.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ManagedConcept < Glossarist::ManagedConcept
+      attribute :data, V3::ManagedConceptData, default: -> { V3::ManagedConceptData.new }
+      attribute :related, V3::RelatedConcept, collection: true
+      attribute :sources, V3::ConceptSource, collection: true
+
+      key_value do
+        map :data, to: :data
+        map :id, with: { to: :identifier_to_yaml, from: :identifier_from_yaml }
+        map :identifier,
+            with: { to: :identifier_to_yaml, from: :identifier_from_yaml }
+        map :related, to: :related
+        map :dates, to: :dates
+        map %i[date_accepted dateAccepted],
+            with: { from: :date_accepted_from_yaml, to: :date_accepted_to_yaml }
+        map :status, to: :status
+        map :uuid, to: :uuid, with: { from: :uuid_from_yaml, to: :uuid_to_yaml }
+        map :schema_version, to: :schema_version
+        map :sources, to: :sources
+      end
+    end
+  end
+end

data/lib/glossarist/v3/managed_concept_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module V3
+    class ManagedConceptData < Glossarist::ManagedConceptData
+      attribute :sources, V3::ConceptSource, collection: true
+      attribute :localizations, V3::LocalizedConcept,
+                collection: Collections::LocalizationCollection,
+                initialize_empty: true
+
+      key_value do
+        map %i[id identifier], to: :id,
+                               with: { to: :id_to_yaml, from: :id_from_yaml }
+        map :uri, to: :uri
+        map %i[localized_concepts localizedConcepts], to: :localized_concepts
+        map %i[domains groups], to: :domains,
+                                with: { from: :domains_from_yaml, to: :domains_to_yaml }
+        map :sources, to: :sources
+        map :localizations, to: :localizations,
+                            with: { from: :localizations_from_yaml, to: :localizations_to_yaml }
+      end
+
+      def localizations_from_yaml(model, value)
+        value.each do |localized_concept_hash|
+          localized_concept = V3::LocalizedConcept.of_yaml(localized_concept_hash)
+          model.localizations.store(localized_concept.language_code,
+                                    localized_concept)
+        end
+      end
+
+      def localizations_to_yaml(model, doc); end
+    end
+  end
+end