relaton-index 0.2.12 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e8920bb67f033d7164f4543a40ffc8588b6bbe4de64b6635b92379b77cfed2e
-  data.tar.gz: c809a8e39de290734cd2a7eb5948c10f94b942f15b61f9485fea4d6b157bb474
+  metadata.gz: 5ce9d7205daf0975990050a9f2652f35d7fc9cd02a840f49cc268ee3114c0870
+  data.tar.gz: b0a56e175a3ca0ed09dea40d2b0d6cb1d6b7400f5cb61d67a86185f00d9309d6
 SHA512:
-  metadata.gz: 558a2747f8cd219d018bb59472c09caf279d4e5f0e0637329872e7dfdd7e11eee70173f042f8b025df509b9eb23763357b6cfaae21606f4572b0f30a662fc84f
-  data.tar.gz: '059d3c22c7248132aeb1c73e211af04154a0ec846f7c9c2d402b12bdd6f67fe5264b80a94a529993d0d26420dd5eaa5f4dcfbb7f9d637480d74d57ef120a4a68'
+  metadata.gz: 21cd6e533b27e00ee9b0604eb3a11112dba1c8f69db15996beede0b7ce763ae54ac30242e8a75118c6e525b4bde510bd7b68f347ccbdd180479d38b77f2c88c0
+  data.tar.gz: 2788d0c92aa0e4fe6540eb4fb5ae4b30917abb304f91b09add060efbcd81977427503c5e7ddc15c17afd1db9735a1abecdfe0a0b760de3d7b89d9e3a41476c59

data/lib/relaton/index/file_io.rb

@@ -6,7 +6,7 @@ module Relaton
     # In index mode url should be nil.
     #
     class FileIO
-      attr_reader :url
+      attr_reader :url, :pubid_class
 
       #
       # Initialize FileIO
@@ -17,12 +17,14 @@ module Relaton
       #     and save it to the storage (if not exists, or older than 24 hours)
       #   if true then the index is read from the storage (used to remove index file)
       #   if nil then the fiename is used to read and write file (used to create indes in GH actions)
+      # @param [Pubid::Core::Identifier::Base] pubid class for deserialization
       #
-      def initialize(dir, url, filename, id_keys)
+      def initialize(dir, url, filename, id_keys, pubid_class = nil)
         @dir = dir
         @url = url
         @filename = filename
         @id_keys = id_keys || []
+        @pubid_class = pubid_class
       end
 
       #
@@ -105,23 +107,33 @@ module Relaton
         return unless yaml
 
         index = YAML.safe_load yaml, permitted_classes: [Symbol]
-        return index if check_format index
+        return deserialize_pubid(index) if check_format index
 
         warn_local_index_error "Wrong structure of the"
       rescue Psych::SyntaxError
         warn_local_index_error "YAML parsing error when reading"
       end
 
+      def deserialize_pubid(index)
+        return index unless @pubid_class
+
+        index.map { |r| { id: @pubid_class.create(**r[:id]), file: r[:file] } }
+      end
+
       def warn_local_index_error(reason)
-        warn "[relaton-#{@dir}] #{reason} file #{file}"
+        Util.info "#{reason} file `#{file}`", progname
         if url.is_a? String
-          warn "[relaton-#{@dir}] Considering #{file} file corrupt, re-downloading from #{url}"
+          Util.info "Considering `#{file}` file corrupt, re-downloading from `#{url}`", progname
         else
-          warn "[relaton-#{@dir}] Considering #{file} file corrupt, removing it."
+          Util.info "Considering `#{file}` file corrupt, removing it.", progname
           remove
         end
       end
 
+      def progname
+        @progname ||= "relaton-#{@dir}"
+      end
+
       #
       # Fetch index from external repository and save it to storage
       #
@@ -134,7 +146,7 @@ module Relaton
         yaml = entry.get_input_stream.read
         index = YAML.safe_load(yaml, permitted_classes: [Symbol])
         save index
-        warn "[relaton-#{@dir}] Downloaded index from #{url}"
+        Util.info "Downloaded index from `#{url}`", progname
         return index if check_format index
 
         warn_remote_index_error "Wrong structure of"
@@ -143,9 +155,9 @@ module Relaton
       end
 
       def warn_remote_index_error(reason)
-        warn "[relaton-#{@dir}] #{reason} newly downloaded file " \
-             "at #{file} #{url}, the remote index seems to be invalid." \
-             "Please report this issue at https://github.com/relaton/relaton-cli."
+        Util.info "#{reason} newly downloaded file `#{file}` at `#{url}`, " \
+             "the remote index seems to be invalid. Please report this " \
+             "issue at https://github.com/relaton/relaton-cli.", progname
       end
 
       #
@@ -156,7 +168,8 @@ module Relaton
       # @return [void]
       #
       def save(index)
-        Index.config.storage.write file, index.to_yaml
+        Index.config.storage.write file,
+          index.map { |item| item.transform_values { |value| value.is_a?(Pubid::Core::Identifier::Base) ? value.to_h : value } }.to_yaml
       end
 
       #

data/lib/relaton/index/pool.rb

@@ -22,7 +22,7 @@ module Relaton
         if @pool[type.upcase.to_sym]&.actual?(**args)
           @pool[type.upcase.to_sym]
         else
-          @pool[type.upcase.to_sym] = Type.new(type, args[:url], args[:file], args[:id_keys])
+          @pool[type.upcase.to_sym] = Type.new(type, args[:url], args[:file], args[:id_keys], args[:pubid_class])
         end
       end
 

data/lib/relaton/index/type.rb

@@ -10,11 +10,12 @@ module Relaton
       # @param [String, Symbol] type type of index (ISO, IEC, etc.)
       # @param [String, nil] url external URL to index, used to fetch index for searching files
       # @param [String, nil] file output file name
+      # @param [Pubid::Core::Identifier::Base] pubid class for deserialization
       #
-      def initialize(type, url = nil, file = nil, id_keys = nil)
+      def initialize(type, url = nil, file = nil, id_keys = nil, pubid_class = nil)
         @file = file
         filename = file || Index.config.filename
-        @file_io = FileIO.new type.to_s.downcase, url, filename, id_keys
+        @file_io = FileIO.new type.to_s.downcase, url, filename, id_keys, pubid_class
       end
 
       def index
@@ -38,7 +39,7 @@ module Relaton
       #
       # Add or update index item
       #
-      # @param [String] id document ID
+      # @param [Pubid::Core::Identifier::Base] id document ID
       # @param [String] file file name of the document
       #
       # @return [void]
@@ -55,13 +56,21 @@ module Relaton
       #
       # Search index for a given ID
       #
-      # @param [Comparable] id ID to search for
+      # @param [String, Pubid::Core::Identifier::Base] id ID to search for
       #
       # @return [Array<Hash>] search results
       #
       def search(id = nil)
         index.select do |i|
-          block_given? ? yield(i) : i[:id].include?(id)
+          if block_given?
+            yield(i)
+          else
+            if i[:id].is_a?(String)
+              id.is_a?(String) ? i[:id].include?(id) : i[:id].include?(id.to_s)
+            else
+              id.is_a?(String) ? i[:id].to_s.include?(id) : i[:id] == id
+            end
+          end
         end
       end
 
@@ -71,7 +80,7 @@ module Relaton
       # @return [void]
       #
       def save
-        @file_io.save @index
+        @file_io.save(@index || [])
       end
 
       #

data/lib/relaton/index/util.rb

@@ -0,0 +1,18 @@
+module Relaton
+  module Index
+    module Util
+      extend self
+
+      PROGNAME = "relaton-index".freeze
+
+      def method_missing(method_name, msg = nil, prog = nil, **opts, &block)
+        prog ||= self::PROGNAME
+        Relaton.logger_pool.send method_name, msg, prog, **opts, &block
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        Relaton.logger_pool.respond_to?(method_name) || super
+      end
+    end
+  end
+end

data/lib/relaton/index/version.rb

@@ -2,6 +2,6 @@
 
 module Relaton
   module Index
-    VERSION = "0.2.12"
+    VERSION = "0.2.15"
   end
 end

data/lib/relaton/index.rb

@@ -2,10 +2,13 @@
 
 require "yaml"
 require "zip"
+require "relaton/logger"
+require "pubid-core"
 
 require_relative "index/version"
 require_relative "index/file_storage"
 require_relative "index/config"
+require_relative "index/util"
 require_relative "index/pool"
 require_relative "index/type"
 require_relative "index/file_io"
@@ -16,17 +19,10 @@ module Relaton
 
     class << self
       #
-      # Find or create index
+      # Proxy for Pool#type
       #
-      # @param [String] type index type (ISO, IEC, etc.)
-      # @param [String, nil] url external URL to index, used to fetch index for searching files
-      # @param [String, nil] file output file name, default is config.filename
-      # @param [Array<Symbol>, nil] id_keys keys to check if index is correct
-      #
-      # @return [Relaton::Index::Type] typed index
-      #
-      def find_or_create(type, url: nil, file: nil, id_keys: nil)
-        pool.type(type, url: url, file: file, id_keys: id_keys)
+      def find_or_create(type, **args)
+        pool.type(type, **args)
       end
 
       def close(type)

data/relaton-index.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "pubid-core", "~> 1.12.9"
+  spec.add_dependency "relaton-logger", "~> 0.2.0"
   spec.add_dependency "rubyzip", "~> 2.3.0"
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-index
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.15
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pubid-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.9
+- !ruby/object:Gem::Dependency
+  name: relaton-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +71,7 @@ files:
 - lib/relaton/index/file_storage.rb
 - lib/relaton/index/pool.rb
 - lib/relaton/index/type.rb
+- lib/relaton/index/util.rb
 - lib/relaton/index/version.rb
 - relaton-index.gemspec
 - sig/relaton/index.rbs
@@ -67,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Relaton Index is a library for indexing Relaton files.