relaton-index 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 116ce97493b2532df6617749a9b8b29c815222450a9a8195850c25f3326fcce1
-  data.tar.gz: 6ee22048d4b694b6055d5e5d866afb4ea8c69343bc9b9804fe42f9de9ad066c2
+  metadata.gz: 39ea35c85bb825679fc73792345d3c11217e80972f2eb32c1a4cc5b31b1a41de
+  data.tar.gz: eedc5afbe9b1fcbd76763d26b628b510e29a9f0a9c74d1a2bb4ab554b0ffb0f0
 SHA512:
-  metadata.gz: b497db789344edc0376b295ae27551c2240062bc882f71164f52e82cac453b724dc17c3ca2f12152d34967ad30f4afea481875f28bed4913f57923e84b327fc3
-  data.tar.gz: 3e8f5f10253631234ed6645785382537318265de9f12eb956cb4eb056bf893bc13147bc1c1c9566e43a4065ad7335d1a6928c206418ad8f2138a50de60181e68
+  metadata.gz: e420ccb8c3d7eaa8834d02c901b0ff495ec6f16552fb614b81905d15758228553eb399234b2575a6bf905931dc96c11491f90082355c28f5be8ba3fa2a0edb44
+  data.tar.gz: 63971b59580a47e70782a0e6a1b98acb270953b415ed451f2b634a5baebafbc46ea7ca08b83a5a76f5110e95d96af27ba64ab8a63fbc6feb850118553b4b6611

data/README.adoc

@@ -33,7 +33,7 @@ Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/rela
 Relaton::Index.find_or_create :IHO
 
 # If the URL or filename is specified and has a new value (different from what it was before), the index object will be recreated.
-Relaton::Index.find_or_create :IHO, url: nil, filename: "index.yaml"
+Relaton::Index.find_or_create :IHO, url: nil, file: "index.yaml"
 
 # Remove the index from the pool.
 Relaton::Index.close :IHO
@@ -53,7 +53,7 @@ In this case, the Relaton library creates an index object and adds documents' fi
 index = Relaton::Index.find_or_create :IHO
 
 # Add a document to the index or update it if it already exists.
-index.add_or_update id: "B-4 2.19.0", file: "data/b-4_2_19_0.xml"
+index.add_or_update "B-4 2.19.0", "data/b-4_2_19_0.xml"
 
 # Save the index to the `index.yaml` file in the current directory.
 index.save

data/lib/relaton/index/file_io.rb

@@ -11,10 +11,12 @@ module Relaton
       #
       # Initialize FileIO
       #
-      # @param [String] dir local directory in ~/.relaton to store index
-      # @param [String, Boolean, nil] url git repository URL to fetch index from
-      #   (if not exists, or older than 24 hours) or nil if index is used to
-      #   index files
+      # @param [String] dir falvor specific local directory in ~/.relaton to store index
+      # @param [String, Boolean, nil] url
+      #   if String then the URL is used to fetch an index from a Git repository
+      #     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)
       #
       def initialize(dir, url, filename)
         @dir = dir
@@ -26,25 +28,24 @@ module Relaton
       # If url is String, check if index file exists and is not older than 24
       #   hours. If not, fetch index from external repository and save it to
       #   storage.
-      # If url is true, remove index from storage.
-      # If url is nil, read index from file.
+      # If url is true, read index from path to local file.
+      # If url is nil, read index from filename.
       #
       # @return [Array<Hash>] index
       #
       def read
         case url
         when String
-          @file ||= path_to_local_file
           check_file || fetch_and_save
-        when true
-          @file ||= path_to_local_file
-          read_file
         else
-          @file ||= @filename
-          read_file
+          read_file || []
         end
       end
 
+      def file
+        @file ||= url ? path_to_local_file : @filename
+      end
+
       #
       # Create path to local file
       #
@@ -60,7 +61,7 @@ module Relaton
       # @return [Array<Hash>, nil] index or nil
       #
       def check_file
-        ctime = Index.config.storage.ctime(@file)
+        ctime = Index.config.storage.ctime(file)
         return unless ctime && ctime > Time.now - 86400
 
         read_file
@@ -72,10 +73,11 @@ module Relaton
       # @return [Array<Hash>] index
       #
       def read_file
-        yaml = Index.config.storage.read(@file)
-        return [] unless yaml
+        yaml = Index.config.storage.read(file)
+        return unless yaml
 
         YAML.safe_load yaml, permitted_classes: [Symbol]
+      rescue Psych::SyntaxError
       end
 
       #
@@ -100,7 +102,7 @@ module Relaton
       # @return [void]
       #
       def save(index)
-        Index.config.storage.write @file, index.to_yaml
+        Index.config.storage.write file, index.to_yaml
       end
 
       #
@@ -109,7 +111,7 @@ module Relaton
       # @return [Array]
       #
       def remove
-        Index.config.storage.remove @filename
+        Index.config.storage.remove file
         []
       end
     end

data/lib/relaton/index/version.rb

@@ -2,6 +2,6 @@
 
 module Relaton
   module Index
-    VERSION = "0.1.9"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-index
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip