relaton-index 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c687782518f5a65ec1d2817f0465ad259512fd036c245405c51d33791c9283a8
-  data.tar.gz: 0ad89006b9935eabfa69493c230337be7b0b4f698c9e2cc8fb2caef3e11b5862
+  metadata.gz: ae7a2387f5e09bff4b3d07563d7e6b3daec43720e7af59d5387f62c41d3892e4
+  data.tar.gz: 8cd557981092f4f37c7d5a318eb6655472895f1a383044af469615e4e99430c0
 SHA512:
-  metadata.gz: 18479264d80c4139e0a819a3a49c8c06b7d0f864e8b01098eaa9535a593c2cb3f7117c025ac6fd978b54350aa390685d16b380e05ac5778ce4d4d2e0effe63a4
-  data.tar.gz: 84cdc050c23d872de768672274189ad453708ecd961f8cdbac15e51e59aec64d4a6c9f9f7760b507ea602b7dc2dba04874a01a83d2be911d69361a33e300013b
+  metadata.gz: aebc8bc1def475961474cb000a79d02d8341f1f9687d93d93559f0126cbf7d091a88fcdfdb0308f181bda3bfc9539cfd876f159936f488cd6117fc21baaf1cac
+  data.tar.gz: 35ad2ae0c5c84328860147a1c5422548bf99437496085d1d0f29f3b2515344e8dca01bad75f40a6f21a84838576763c811d9f873b06afde1ff90e73623f4b4bc

data/README.adoc

@@ -28,7 +28,7 @@ The aim of this gem is to be used by Relaton libraries in two ways:
 
 === Indexing
 
-In this case, the Relaton library should create an index object and add documents' files to it. The index object should be saved to the `index.yaml` file in the root of the repository.
+In this case, the Relaton library creates an index object and adds documents' files to it. By default, the index object is saved to the `index.yaml` file in the root of the repository. The filename can be changed using the `filename` setting
 
 [source,ruby]
 ---- 
@@ -52,7 +52,7 @@ In this case, the Relaton library should create an index object and search for a
 ----
 require 'relaton/index' 
 
-# 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 file is saved to the `/[HOME]/.relaton/[TYPE]/index.yaml` file.
+# 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 file is saved to the `/[HOME]/.relaton/iho/index.yaml` file.
 index = Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/index.zip"
 
 
@@ -71,6 +71,23 @@ end
 Relaton::Index.close :IHO
 ----
 
+=== Configuration
+
+The gem can be configured by using the `Relaton::Index.config` method. The following settings are available:
+
+- `filename` - the name of the index file. By default, it is `index.yaml`.
+- `storage` - the storage class or module. By default, it is `FileStorage` module. It can be any class or module that implements the `ctime`, `read`, and `write` class methods.
+- `storage_dir` - the directory where the `.relaton/[TYPE]` folder is created. By default, it's a user's home dir. This setting works only when the gem is used for searching. When indexing, the index is always saved in a current folder.
+
+[source,ruby]
+----
+Relaton::Index.config do |config|
+  config.filename = "index-new.yaml"
+  config.storage = S3Storage
+  config.storage_dir = "/"
+end
+----
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/relaton/index/config.rb

@@ -4,7 +4,7 @@ module Relaton
     # Configuration class for Relaton::Index
     #
     class Config
-      attr_reader :storage, :storage_dir
+      attr_reader :storage, :storage_dir, :filename
 
       #
       # Set default values
@@ -12,6 +12,7 @@ module Relaton
       def initialize
         @storage = FileStorage
         @storage_dir = Dir.home
+        @filename = "index.yaml"
       end
 
       #
@@ -35,6 +36,17 @@ module Relaton
       def storage_dir=(dir)
         @storage_dir = dir
       end
+
+      #
+      # Set filename
+      #
+      # @param [String] filename filename
+      #
+      # @return [void]
+      #
+      def filename=(filename)
+        @filename = filename
+      end
     end
   end
 end

data/lib/relaton/index/file_io.rb

@@ -10,8 +10,9 @@ 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 (if not exists, or older than 24 hours)
-      #   or nil if index is used to index files
+      # @param [String, 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
       #
       def initialize(dir, url)
         @dir = dir
@@ -25,10 +26,10 @@ module Relaton
       #
       def read
         if @url
-          @file ||= File.join(Index.config.storage_dir, ".relaton", @dir, "index.yaml")
+          @file ||= File.join(Index.config.storage_dir, ".relaton", @dir, Index.config.filename)
           check_file || fetch_and_save
         else
-          @file ||= "index.yaml"
+          @file ||= Index.config.filename
           read_file
         end
       end
@@ -66,7 +67,7 @@ module Relaton
         resp = URI(@url).open
         zip = Zip::InputStream.new resp
         entry = zip.get_next_entry
-        index = YAML.safe_load(entry.get_input_stream.read, [Symbol])
+        index = YAML.safe_load(entry.get_input_stream.read, permitted_classes: [Symbol])
         save index
         index
       end

data/lib/relaton/index/version.rb

@@ -2,6 +2,6 @@
 
 module Relaton
   module Index
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end

metadata

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