relaton-index 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b98c8a3a2f93284d50aefe422e0fea795bf697c7f4cd4bce8fcf517ccd2f62
-  data.tar.gz: 63dbd9440f0cf7dbb58a043bce06940d1ac50e4a43513ab148ce292177a37f22
+  metadata.gz: 60a1a3374a5ce4bf3ed866e1f16c1bfc23e60e540f01689e70f6de64ddd77000
+  data.tar.gz: 2ad750089311e884d7fbe3de14f45769e578a4bd4de76a90ca1710a4733396e3
 SHA512:
-  metadata.gz: ae44baa7e0019a6de91cdecbc23c5c832425f84fd53f2f9262fd7d295a4df8bf3e95d96628326561023a90c1fd9a90cb2cee6cd0e542033d011ce5975a2f2354
-  data.tar.gz: cef211d3dbf82b2105bfc3035a1f7d140ca41e9cd4a7a35559fd2709189dc36528a744d927ccf969cbc8827bb6405b3dda3659a273fda9794635ff4a11313e28
+  metadata.gz: e62a664b3974dcf33b11b04601514aefe89d7891a750d76622097fb66a836fab28808c8f5844e026c5d1578997aa7e8057b2cf34222a5a207f24e2c55ba5f22f
+  data.tar.gz: 4c40187df923f53aa096aa717486f3f82a5cacb0411b1de9886dbbe533f8d7cff6e968aa96c95dc24675a8d192e098839c5ccd67faeaaa2e497570e21b77c464

data/README.adoc

@@ -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
+----
+
 === 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

@@ -78,13 +78,22 @@ 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 [void]
+      #
+      def remove
+        Index.config.storage.remove @file
+      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_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.8"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relaton-index
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ribose Inc.