glossarist-new 1.0.0

data/lib/glossarist/related_concept.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Glossarist
+  class RelatedConcept < Model
+    include Glossarist::Utilities::Enum
+
+    register_enum :type, Glossarist::GlossaryDefinition::RELATED_CONCEPT_TYPES
+
+    # @return [String]
+    attr_accessor :content
+
+    # Reference to the related concept.
+    # @return [Citation]
+    attr_reader :ref
+
+    def ref=(ref)
+      @ref = Citation.new(ref)
+    end
+
+    def to_h
+      reference = ref&.to_h
+      reference&.merge!(reference&.delete("ref"))
+
+      {
+        "type" => type.to_s,
+        "content" => content,
+        "ref" => reference,
+      }.compact
+    end
+  end
+end

data/lib/glossarist/utilities/boolean_attributes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Utilities
+    module BooleanAttributes
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def self.extended(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def register_boolean_attributes(attributes)
+          attributes.each do |attribute|
+            register_boolean_attribute(attribute)
+          end
+        end
+
+        def register_boolean_attribute(attribute)
+          attr_reader attribute
+
+          define_method("#{attribute}=") do |value|
+            instance_variable_set("@#{attribute}", !!value)
+          end
+
+          define_method("#{attribute}?") do
+            !!instance_variable_get("@#{attribute}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/utilities/common_functions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Utilities
+    module CommonFunctions
+      # Hash#transform_keys is not available in Ruby 2.4
+      # so we have to do this ourselves :(
+      # symbolize hash keys
+      def symbolize_keys(hash)
+        result = {}
+        hash.each_pair do |key, value|
+          result[key.to_sym] = value
+        end
+        result
+      end
+
+      # Hash#slice is not available in Ruby 2.4
+      # so we have to do this ourselves :(
+      # slice hash keys
+      def slice_keys(hash, keys)
+        result = {}
+        keys.each do |key|
+          result[key] = hash[key] if hash.key?(key)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/glossarist/utilities/enum/class_methods.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Glossarist
+  module Utilities
+    module Enum
+      module ClassMethods
+        def add_inheritable_attribute(attribute)
+          @inheritable_attributes ||= Set[:inheritable_attributes]
+          @inheritable_attributes << attribute
+        end
+
+        def inherited(subclass)
+          @inheritable_attributes.each do |inheritable_attribute|
+            instance_var = "@#{inheritable_attribute}"
+            subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
+          end
+        end
+
+        def enums
+          @enums ||= EnumCollection.new
+        end
+
+        def register_enum(name, values, options = {})
+          values = standardize_values(values)
+
+          enums.add(name, values, options)
+
+          add_inheritable_attribute(:enums)
+          register_type_accessor(name)
+
+          values.each do |value|
+            register_check_method(name, value)
+            register_set_method(name, value)
+          end
+        end
+
+        def registered_enums
+          enums.registered_enums
+        end
+
+        def valid_types(name)
+          enums.valid_types(name)
+        end
+
+        def type_options(name)
+          enums.type_options(name)
+        end
+
+        def register_type_reader(name)
+          define_method(name) do
+            if self.class.type_options(name)[:multiple]
+              selected_type[name].map(&:to_s)
+            else
+              selected_type[name].first&.to_s
+            end
+          end
+        end
+
+        def register_type_writer(name)
+          define_method("#{name}=") do |type|
+            select_type(name, type)
+          end
+        end
+
+        # Adds a reader and writer for the type name given.
+        def register_type_accessor(name)
+          register_type_reader(name)
+          register_type_writer(name)
+        end
+
+        def register_check_method(name, value)
+          define_method("#{value}?") do
+            !!selected_type[name]&.include?(value.to_sym)
+          end
+        end
+
+        def register_set_method(name, value)
+          define_method("#{value}=") do |input|
+            if input
+              select_type(name, value)
+            else
+              deselect_type(name, value)
+            end
+          end
+        end
+
+        def standardize_values(values)
+          if values.is_a?(Array)
+            values.map(&:to_sym)
+          else
+            [values.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/utilities/enum/enum_collection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Utilities
+    module Enum
+      class EnumCollection
+        include Enumerable
+
+        def initialize
+          @collection = {}
+        end
+
+        def add(name, values, options = {})
+          @collection[name] = { registered_values: values, options: options }
+        end
+
+        def each(&block)
+          if block_given?
+            @collection.each do |object|
+              block.call(object)
+            end
+          else
+            enum_for(:each)
+          end
+        end
+
+        def registered_enums
+          @collection&.keys || []
+        end
+
+        def valid_types(name)
+          @collection[name][:registered_values]
+        end
+
+        def type_options(name)
+          @collection[name][:options]
+        end
+
+        def [](name)
+          @collection[name]
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/utilities/enum/instance_methods.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Utilities
+    module Enum
+      module InstanceMethods
+        def selected_type
+          initialize_selected_type if @selected_type.nil?
+
+          @selected_type
+        end
+
+        def select_type(type_name, values)
+          values = if values.is_a?(Array)
+                     values
+                   else
+                     [values]
+                   end
+
+          values.each do |value|
+            select_type_value(type_name, value)
+          end
+        end
+
+        def deselect_type(type_name, value)
+          selected_type[type_name].delete(value)
+        end
+
+        private
+
+        def select_type_value(type_name, value)
+          if !value
+            selected_type[type_name].clear
+          elsif self.class.valid_types(type_name).include?(value.to_sym)
+            selected_type[type_name].clear unless self.class.type_options(type_name)[:multiple]
+            selected_type[type_name] << value.to_sym
+          else
+            raise(
+              Glossarist::InvalidTypeError,
+              "`#{value}` is not a valid #{type_name}. Supported #{type_name} are #{self.class.enums[type_name][:registered_values].to_a.join(", ")}"
+            )
+          end
+        end
+
+        def initialize_selected_type
+          @selected_type = {}
+
+          self.class.registered_enums.each do |type|
+            @selected_type[type] = []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/utilities/enum.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "enum/enum_collection"
+require_relative "enum/class_methods"
+require_relative "enum/instance_methods"
+
+module Glossarist
+  module Utilities
+    module Enum
+      def self.included(base)
+        base.include(InstanceMethods)
+        base.extend(ClassMethods)
+      end
+
+      def self.extended(base)
+        base.include(InstanceMethods)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/glossarist/utilities.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "utilities/enum"
+require_relative "utilities/boolean_attributes"
+require_relative "utilities/common_functions"

data/lib/glossarist/version.rb

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

data/lib/glossarist.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# (c) Copyright 2021 Ribose Inc.
+#
+
+require "psych"
+
+require_relative "glossarist/utilities"
+require_relative "glossarist/version"
+require_relative "glossarist/glossary_definition"
+
+require_relative "glossarist/model"
+require_relative "glossarist/concept_date"
+require_relative "glossarist/detailed_definition"
+require_relative "glossarist/related_concept"
+require_relative "glossarist/citation"
+require_relative "glossarist/concept_source"
+require_relative "glossarist/collection"
+require_relative "glossarist/designation"
+require_relative "glossarist/concept"
+require_relative "glossarist/localized_concept"
+require_relative "glossarist/managed_concept_collection"
+require_relative "glossarist/concept_manager"
+require_relative "glossarist/managed_concept"
+require_relative "glossarist/non_verb_rep"
+
+module Glossarist
+  class Error < StandardError; end
+  class InvalidTypeError < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: glossarist-new
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ribose
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-27 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
+- config.yml
+- glossarist.gemspec
+- lib/glossarist.rb
+- lib/glossarist/citation.rb
+- lib/glossarist/collection.rb
+- lib/glossarist/concept.rb
+- lib/glossarist/concept_date.rb
+- lib/glossarist/concept_manager.rb
+- lib/glossarist/concept_source.rb
+- lib/glossarist/designation.rb
+- lib/glossarist/designation/abbreviation.rb
+- lib/glossarist/designation/base.rb
+- lib/glossarist/designation/expression.rb
+- lib/glossarist/designation/grammar_info.rb
+- lib/glossarist/designation/graphical_symbol.rb
+- lib/glossarist/designation/letter_symbol.rb
+- lib/glossarist/designation/symbol.rb
+- lib/glossarist/detailed_definition.rb
+- lib/glossarist/glossary_definition.rb
+- lib/glossarist/localized_concept.rb
+- lib/glossarist/managed_concept.rb
+- lib/glossarist/managed_concept_collection.rb
+- lib/glossarist/model.rb
+- lib/glossarist/non_verb_rep.rb
+- lib/glossarist/related_concept.rb
+- lib/glossarist/utilities.rb
+- lib/glossarist/utilities/boolean_attributes.rb
+- lib/glossarist/utilities/common_functions.rb
+- lib/glossarist/utilities/enum.rb
+- lib/glossarist/utilities/enum/class_methods.rb
+- lib/glossarist/utilities/enum/enum_collection.rb
+- lib/glossarist/utilities/enum/instance_methods.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.2
+signing_key:
+specification_version: 4
+summary: Concept models for terminology glossaries conforming ISO 10241-1.
+test_files: []