relaton-index 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a1a3374a5ce4bf3ed866e1f16c1bfc23e60e540f01689e70f6de64ddd77000
-  data.tar.gz: 2ad750089311e884d7fbe3de14f45769e578a4bd4de76a90ca1710a4733396e3
+  metadata.gz: 0eaf31518d3ecfb78041891165d24d8f0e9673d2aebcfa02608694ec9f562843
+  data.tar.gz: 206c0f5fcf0b5336ff186f35da3efc79fda86cf25c93f1c499dd525cccdd6128
 SHA512:
-  metadata.gz: e62a664b3974dcf33b11b04601514aefe89d7891a750d76622097fb66a836fab28808c8f5844e026c5d1578997aa7e8057b2cf34222a5a207f24e2c55ba5f22f
-  data.tar.gz: 4c40187df923f53aa096aa717486f3f82a5cacb0411b1de9886dbbe533f8d7cff6e968aa96c95dc24675a8d192e098839c5ccd67faeaaa2e497570e21b77c464
+  metadata.gz: 3426d0303d776d0c7ecaeb17bf957a20228858ae859f85aec02d52dc833d643ead02cd14c522d6fcecc72b9f920e2efbc3667f31c86e6dcd363ebc4ef9eae516
+  data.tar.gz: 0e8809f80cc34c92100a081917ce561ccaeb287e9002171f558d62e0c6148ac68a5b4b72f96e8720815f4d3be9390cda026fe39b08c3ba0895706c15a74e8865

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"
 
 
@@ -96,7 +96,7 @@ This method removes the index file. The index object is cleared and can be used
 
 [source,ruby]
 ----
-index.remove
+index.remove_file
 ----
 
 === Configuration

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,27 +23,43 @@ 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
           check_file || fetch_and_save
         else
-          @file ||= @filename
           read_file
         end
       end
 
+      def file
+        @file ||= url ? path_to_local_file : @filename
+      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
       #
       # @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
@@ -55,7 +71,7 @@ module Relaton
       # @return [Array<Hash>] index
       #
       def read_file
-        yaml = Index.config.storage.read(@file)
+        yaml = Index.config.storage.read(file)
         return [] unless yaml
 
         YAML.safe_load yaml, permitted_classes: [Symbol]
@@ -83,16 +99,17 @@ module Relaton
       # @return [void]
       #
       def save(index)
-        Index.config.storage.write @file, index.to_yaml
+        Index.config.storage.write file, index.to_yaml
       end
 
       #
       # Remove index file from storage
       #
-      # @return [void]
+      # @return [Array]
       #
       def remove
-        Index.config.storage.remove @file
+        Index.config.storage.remove file
+        []
       end
     end
   end

data/lib/relaton/index/type.rb

@@ -79,7 +79,7 @@ module Relaton
       #
       # @return [void]
       #
-      def remove
+      def remove_file
         @file_io.remove
         @index = nil
       end

data/lib/relaton/index/version.rb

@@ -2,6 +2,6 @@
 
 module Relaton
   module Index
-    VERSION = "0.1.8"
+    VERSION = "0.2.0"
   end
 end

metadata

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