relaton-index 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0a18404c0b3197dd888ee8b286ec575e391327d0ad7c50645fb57adfa922b78
-  data.tar.gz: 69bd5fc4c3dc70d2daf646debe653d899ebfd7bef691809c8ac31b4e49ebf1cf
+  metadata.gz: d43fbc7d91123a99bde7050b74ee42d38408a610d6aab858a3e9a032b41e2a26
+  data.tar.gz: d3655957e051b6b1d3f0d2d7a223fab43e63a0186fa946092446611804c1fc23
 SHA512:
-  metadata.gz: 66c4fc49df2fcebbbb41913e55223d94b5058bde802b714381c1a91178d37d13904055a99aa5b5d5f87283d1248cdde6d86c309060f238a7988f538277de72db
-  data.tar.gz: fa6fed8320e73cc1bea2ef9fbf3aec9640f9de5f62f79c03cb5a34ad2473c5bbd452008b1dd4ba275c47e844d75ca0d68351efc4c6fd67d0dc0cd284211e0465
+  metadata.gz: 4d70ce12c06d309f611949aa6c138e03093be574830cf0b13389f8d41849cfae16a7b150726d1a1d8ac1f3eb263e657b32143a2d5f2102412a2f106af6d80649
+  data.tar.gz: 20f183f6b0c279825bceddc016fb87449ce475983d08029c6152c7552528df4fe385c7d6ca0818add7c2cc64219651636be995009d7a5de3cbb62dbfa243f252

data/README.adoc

@@ -32,7 +32,7 @@ Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/rela
 # Find an existing index object (created before).
 Relaton::Index.find_or_create :IHO
 
-# If a new value of URL or filename is specified and has a new value (different from what it was before), the index object will be recreated.
+# 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"
 
 # Remove the index from the pool.
@@ -81,6 +81,13 @@ end
 # => [{ id: "B-4 2.19.0", file: "data/b-4_2_19_0.xml" }] 
 ----
 
+=== Remove all index records
+
+[source,ruby]
+----
+index.remove_all
+----
+
 === Configuration
 
 The gem can be configured by using the `Relaton::Index.config` method. The following settings are available:

data/lib/relaton/index/type.rb

@@ -18,6 +18,16 @@ module Relaton
         @index = @file_io.read
       end
 
+      #
+      # Check if index is actual. If url or file is given, check if it is equal to
+      # index url or file.
+      #
+      # @param [Hash] **args arguments
+      # @option args [String, nil] :url external URL to index, used to fetch index for searching files
+      # @option args [String, nil] :file output file name
+      #
+      # @return [Boolean] true if index is actual, false otherwise
+      #
       def actual?(**args)
         (!args.key?(:url) || args[:url] == @file_io.url) && (!args.key?(:file) || args[:file] == @file)
       end
@@ -60,6 +70,15 @@ module Relaton
       def save
         @file_io.save @index
       end
+
+      #
+      # Remove all index items
+      #
+      # @return [void]
+      #
+      def remove_all
+        @index = []
+      end
     end
   end
 end

data/lib/relaton/index/version.rb

@@ -2,6 +2,6 @@
 
 module Relaton
   module Index
-    VERSION = "0.1.4"
+    VERSION = "0.1.6"
   end
 end

data/lib/relaton/index.rb

@@ -25,7 +25,7 @@ module Relaton
       # @return [Relaton::Index::Type] typed index
       #
       def find_or_create(type, url: nil, file: nil)
-        pool.type(type, url, file)
+        pool.type(type, url: url, file: file)
       end
 
       def close(type)

metadata

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