relaton-index 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f22ce8f232dc77b5b791d5eaa6fb5b80bf62697f8a1a7cd9d18e7515ff7d65
-  data.tar.gz: 86884150296d335342dba8ebf3c2808f662fd08709378ce9674e91965494c600
+  metadata.gz: 94b98c8a3a2f93284d50aefe422e0fea795bf697c7f4cd4bce8fcf517ccd2f62
+  data.tar.gz: 63dbd9440f0cf7dbb58a043bce06940d1ac50e4a43513ab148ce292177a37f22
 SHA512:
-  metadata.gz: 3c59bccab496f4be0a8a7d228dcb676c148daf9e6d84308623d1877bd0fe85a6738a5f151219f787385ac53faae430f43bfa928b40e2e399d62082abcfb86600
-  data.tar.gz: 33ef8426b9e9e72cfb2488d78ef16d65e5083d3a50376b9e530d95b213744c69763d9fa2fa4c39395cd3428fdf7e8954ea3a47047c2ce029b2cdbb580ff406a0
+  metadata.gz: ae44baa7e0019a6de91cdecbc23c5c832425f84fd53f2f9262fd7d295a4df8bf3e95d96628326561023a90c1fd9a90cb2cee6cd0e542033d011ce5975a2f2354
+  data.tar.gz: cef211d3dbf82b2105bfc3035a1f7d140ca41e9cd4a7a35559fd2709189dc36528a744d927ccf969cbc8827bb6405b3dda3659a273fda9794635ff4a11313e28

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.5"
+    VERSION = "0.1.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-index
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-11 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Relaton Index is a library for indexing Relaton files.