relaton-index 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b98c8a3a2f93284d50aefe422e0fea795bf697c7f4cd4bce8fcf517ccd2f62
-  data.tar.gz: 63dbd9440f0cf7dbb58a043bce06940d1ac50e4a43513ab148ce292177a37f22
+  metadata.gz: 116ce97493b2532df6617749a9b8b29c815222450a9a8195850c25f3326fcce1
+  data.tar.gz: 6ee22048d4b694b6055d5e5d866afb4ea8c69343bc9b9804fe42f9de9ad066c2
 SHA512:
-  metadata.gz: ae44baa7e0019a6de91cdecbc23c5c832425f84fd53f2f9262fd7d295a4df8bf3e95d96628326561023a90c1fd9a90cb2cee6cd0e542033d011ce5975a2f2354
-  data.tar.gz: cef211d3dbf82b2105bfc3035a1f7d140ca41e9cd4a7a35559fd2709189dc36528a744d927ccf969cbc8827bb6405b3dda3659a273fda9794635ff4a11313e28
+  metadata.gz: b497db789344edc0376b295ae27551c2240062bc882f71164f52e82cac453b724dc17c3ca2f12152d34967ad30f4afea481875f28bed4913f57923e84b327fc3
+  data.tar.gz: 3e8f5f10253631234ed6645785382537318265de9f12eb956cb4eb056bf893bc13147bc1c1c9566e43a4065ad7335d1a6928c206418ad8f2138a50de60181e68

data/README.adoc

@@ -61,11 +61,11 @@ index.save
 
 === Searching
 
-In this case, the Relaton library should create an index object and search for a document by reference. The gem looks for the `.relaton/[TYPE]/index.yaml` file in the user's home directory. The `[TYPE]` is one of downcased ISO, IEC, IHO, etc. If the file is not found or is older than 24 hours then it will be downloaded from the URL specified in the `find_or_create` method.
+In this case, the Relaton library should create an index object and search for a document by reference. The gem looks for the `.relaton/[TYPE]/index.yaml` file in the user's home directory. The `[TYPE]` is one of downcased ISO, IEC, IHO, etc. If the file is not found or is older than 24 hours then it will be downloaded from the URL specified in the `find_or_create` method. The URL can be specified as `true` if the index should not be fetched from the URL.
 
 [source,ruby]
 ----
-# Create a new index object or fetch an existing one. URL should be specified. If the index file is not found or is older than 24 hours, it will be downloaded from the URL. By default, the index is saved as `index.yaml` file to the `/[HOME]/.relaton/iho/` folder.
+# Create a new index object or fetch an existing one. URL should be specified. If the index file is not found or is older than 24 hours, it will be downloaded from the URL. By default, the index is saved as `index.yaml` file to the `/[HOME]/.relaton/iho/` folder. If the URL is specified as `true`, the index won't be fetched from the URL.
 index = Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/index.zip"
 
 
@@ -83,11 +83,22 @@ end
 
 === Remove all index records
 
+This method removes all records from the index object. The index file is not removed.
+
 [source,ruby]
 ----
 index.remove_all
 ----
 
+=== Remove index file
+
+This method removes the index file. The index object is cleared and can be used for indexing or loading a file from the specified URL.
+
+[source,ruby]
+----
+index.remove_file
+----
+
 === Configuration
 
 The gem can be configured by using the `Relaton::Index.config` method. The following settings are available:

data/lib/relaton/index/file_io.rb

@@ -12,7 +12,7 @@ module Relaton
       # Initialize FileIO
       #
       # @param [String] dir local directory in ~/.relaton to store index
-      # @param [String, nil] url git repository URL to fetch index from
+      # @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
       #
@@ -23,20 +23,37 @@ module Relaton
       end
 
       #
-      # Read index from storage or fetch from external repository
+      # 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.
       #
       # @return [Array<Hash>] index
       #
       def read
-        if url
-          @file ||= File.join(Index.config.storage_dir, ".relaton", @dir, @filename)
+        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
         end
       end
 
+      #
+      # Create path to local file
+      #
+      # @return [<Type>] <description>
+      #
+      def path_to_local_file
+        File.join(Index.config.storage_dir, ".relaton", @dir, @filename)
+      end
+
       #
       # Check if index file exists and is not older than 24 hours
       #
@@ -78,13 +95,23 @@ module Relaton
       #
       # Save index to storage
       #
-      # @param [Array<Hash>] index <description>
+      # @param [Array<Hash>] index index to save
       #
       # @return [void]
       #
       def save(index)
         Index.config.storage.write @file, index.to_yaml
       end
+
+      #
+      # Remove index file from storage
+      #
+      # @return [Array]
+      #
+      def remove
+        Index.config.storage.remove @filename
+        []
+      end
     end
   end
 end

data/lib/relaton/index/file_storage.rb

@@ -42,6 +42,19 @@ module Relaton
         File.write file, data, encoding: "UTF-8"
       end
 
+      #
+      # Remove file
+      #
+      # @param [String] file file path
+      #
+      # @return [void]
+      #
+      def remove(file)
+        return unless File.exist? file
+
+        File.delete file
+      end
+
       extend self
     end
   end

data/lib/relaton/index/type.rb

@@ -15,7 +15,10 @@ module Relaton
         @file = file
         filename = file || Index.config.filename
         @file_io = FileIO.new type.to_s.downcase, url, filename
-        @index = @file_io.read
+      end
+
+      def index
+        @index ||= @file_io.read
       end
 
       #
@@ -41,11 +44,11 @@ module Relaton
       # @return [void]
       #
       def add_or_update(id, file)
-        item = @index.find { |i| i[:id] == id }
+        item = index.find { |i| i[:id] == id }
         if item
           item[:file] = file
         else
-          @index << { id: id, file: file }
+          index << { id: id, file: file }
         end
       end
 
@@ -57,7 +60,7 @@ module Relaton
       # @return [Array<Hash>] search results
       #
       def search(id = nil)
-        @index.select do |i|
+        index.select do |i|
           block_given? ? yield(i) : i[:id].include?(id)
         end
       end
@@ -71,6 +74,16 @@ module Relaton
         @file_io.save @index
       end
 
+      #
+      # Remove index file from storage and clear index
+      #
+      # @return [void]
+      #
+      def remove_file
+        @file_io.remove
+        @index = nil
+      end
+
       #
       # Remove all index items
       #

data/lib/relaton/index/version.rb

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

metadata

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