glossarist-new 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c97457297f94e65b52da9de5fd9dc620f3722034e9a97dae80c81736333cf7d
-  data.tar.gz: e8716f64a5cb9d2e84f752540854219a6ffe406fc46140158274fc135a002da0
+  metadata.gz: 33417ab36e59957a55a83d33feb67f9657d1a790c72200a113a8da5d5da30dbb
+  data.tar.gz: 394244acd5674b48b66316576472f23bab6d9ffb9c8d9cac6febe592827d75a7
 SHA512:
-  metadata.gz: 2f9db6e9f0f5e716c9810d44f06fd14d77140aa060b9004dbc900c2766be1bb08733789e0619d8cda633c18158ddf931b943cd9a5c4d6c025240f71453f351e4
-  data.tar.gz: 28c854fab76b67814180a2da7043ecb8072aea4828c9bcba92cf2b45ae57af5680733532837d46427a8bfd0d2834b965a04b51791010e50b214243ab27d7b7bc
+  metadata.gz: d855e52b2d3d48a1b2a7c46190a229af9e0597f2b971e18a3d73ad3194387fba2f9a8d270abe8840f59bd9940d4802ec6b2dcaf8b9422f425dcb7fd172a66a8a
+  data.tar.gz: 75414f5177abe52d0fa160d5cb5769ea27ba175f89cfa6e7aa2c6fdb8c3d26e03e00181b310d85e3e0e6dba93cfbbeab0c61dca9e3f74260bc77706cdd6b94ac

data/README.adoc

@@ -1,5 +1,28 @@
 = Glossarist
 
+== Commands
+
+generate_latex: Convert Concepts to Latex format
+
+=== Usage:
+  glossarist generate_latex p, --concepts-path=CONCEPTS_PATH
+
+=== Options:
+[cols="1,1"]
+|===
+|p, --concepts-path
+|Path to yaml concepts directory
+
+|l, --latex-concepts
+|File path having list of concepts that should be converted to LATEX format. If not provided all the concepts will be converted to the latex format
+
+|o, --output-file
+|Output file path. By default the output will pe printed to the console
+
+|e, --extra-attributes
+|List of extra attributes that are not in standard Glossarist Concept model. eg -e one two three
+|===
+
 == Credits
 
 This gem is developed, maintained and funded by

data/exe/glossarist

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/glossarist"
+
+class GlossaristCommand < Thor
+  desc "generate_latex", "Convert Concepts to Latex format"
+
+  option :concepts_path, aliases: :p, required: true, desc: "Path to yaml concepts directory"
+  option :latex_concepts, aliases: :l, desc: "File path having list of concepts that should be converted to LATEX format. If not provided all the concepts will be converted to the latex format"
+  option :output_file, aliases: :o, desc: "Output file path. By default the output will pe printed to the console"
+  option :extra_attributes, aliases: :e, type: :array, desc: "List of extra attributes that are not in standard Glossarist Concept model"
+  def generate_latex
+    assets = []
+    latex_concepts_file = options[:latex_concepts]
+
+    if options[:extra_attributes]
+      Glossarist.configure do |config|
+        config.register_extension_attributes(options[:extra_attributes])
+      end
+    end
+
+    concept_set = Glossarist::ConceptSet.new(options[:concepts_path], assets)
+    latex_str = concept_set.to_latex(latex_concepts_file)
+
+    output_file_path = options[:output_file]
+    if output_file_path
+      File.open(output_file_path, "w") do |file|
+        file.puts latex_str
+      end
+    else
+      puts latex_str
+    end
+  end
+
+  def method_missing(*args)
+    warn "No method found named: #{args[0]}"
+    warn "Run with `--help` or `-h` to see available options"
+    exit 1
+  end
+
+  def respond_to_missing?
+    true
+  end
+
+  def self.exit_on_failure?
+    true
+  end
+end
+
+GlossaristCommand.start(ARGV)

data/glossarist.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "relaton", "~>1.13.0"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "pry", "~> 0.14.0"
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/glossarist/concept.rb

@@ -40,12 +40,16 @@ module Glossarist
     # @return [Array<DetailedDefinition>]
     attr_reader :examples
 
+    # Contains list of extended attributes
+    attr_accessor :extension_attributes
+
     def initialize(*)
       @localizations = {}
       @sources = []
       @related = []
       @notes = []
       @designations = []
+      @extension_attributes = {}
 
       super
     end
@@ -122,7 +126,7 @@ module Glossarist
 
         hash.values
           .grep(Hash)
-          .map { |subhash| LocalizedConcept.from_h(subhash) rescue nil }
+          .map { |subhash| Config.class_for(:localized_concept).from_h(subhash) rescue nil }
           .compact
 
         concept.related = hash.dig("related") || []

data/lib/glossarist/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Glossarist
+  class Config
+    include Singleton
+
+    DEFAULT_CLASSES = {
+      localized_concept: Glossarist::LocalizedConcept,
+    }.freeze
+
+    attr_reader :registered_classes
+
+    def initialize
+      @registered_classes = DEFAULT_CLASSES.dup
+      @extension_attributes = []
+    end
+
+    def class_for(name)
+      @registered_classes[name.to_sym]
+    end
+
+    def register_class(class_name, klass)
+      @registered_classes[class_name] = klass
+    end
+
+    def extension_attributes
+      @extension_attributes
+    end
+
+    def register_extension_attributes(attributes)
+      @extension_attributes = attributes
+    end
+
+    class << self
+      def class_for(name)
+        self.instance.class_for(name)
+      end
+
+      def extension_attributes
+        self.instance.extension_attributes
+      end
+
+      def register_class(class_name, klass)
+        self.instance.register_class(class_name, klass)
+      end
+
+      def register_extension_attributes(attributes)
+        self.register_extension_attributes(attributes)
+      end
+    end
+  end
+end

data/lib/glossarist/localized_concept.rb

@@ -44,7 +44,7 @@ module Glossarist
         "review_date" => review_date,
         "review_decision_date" => review_decision_date,
         "review_decision_event" => review_decision_event,
-      }.compact)
+      }.compact).merge(@extension_attributes)
     end
 
     def self.from_h(hash)

data/lib/glossarist/managed_concept.rb

@@ -36,7 +36,7 @@ module Glossarist
     end
 
     def localized_concepts=(localized_concepts_hash)
-      @localized_concepts = localized_concepts_hash.map { |l| LocalizedConcept.new(l) }.compact
+      @localized_concepts = localized_concepts_hash.map { |l| Config.class_for(:localized_concept).new(l) }.compact
 
       @localized_concepts.each do |l|
         add_l10n(l)

data/lib/glossarist/model.rb

@@ -18,8 +18,12 @@ module Glossarist
     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."
+      if Config.extension_attributes.include?(name)
+        extension_attributes[name] = value
+      else
+        raise ArgumentError, "#{self.class.name} does not have " +
+          "attribute #{name} defined or the attribute is read only."
+      end
     end
 
     def self.from_h(hash)

data/lib/glossarist/version.rb

@@ -4,5 +4,5 @@
 #
 
 module Glossarist
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/glossarist.rb

@@ -4,6 +4,7 @@
 #
 
 require "psych"
+require "thor"
 
 require_relative "glossarist/utilities"
 require_relative "glossarist/version"
@@ -28,8 +29,16 @@ require_relative "glossarist/non_verb_rep"
 
 require_relative "glossarist/collections"
 
+require_relative "glossarist/config"
+
 module Glossarist
   class Error < StandardError; end
   class InvalidTypeError < StandardError; end
   # Your code goes here...
+
+  def self.configure
+    config = Glossarist::Config.instance
+
+    yield(config) if block_given?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glossarist-new
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: relaton
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,8 @@ dependencies:
 description:
 email:
 - open.source@ribose.com
-executables: []
+executables:
+- glossarist
 extensions: []
 extra_rdoc_files: []
 files:
@@ -84,6 +99,7 @@ files:
 - README.adoc
 - Rakefile
 - config.yml
+- exe/glossarist
 - glossarist.gemspec
 - lib/glossarist.rb
 - lib/glossarist/asset.rb
@@ -97,6 +113,7 @@ files:
 - lib/glossarist/concept_manager.rb
 - lib/glossarist/concept_set.rb
 - lib/glossarist/concept_source.rb
+- lib/glossarist/config.rb
 - lib/glossarist/designation.rb
 - lib/glossarist/designation/abbreviation.rb
 - lib/glossarist/designation/base.rb