relaton-index 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba264ee91f3458c72c08556365a2cf318a42ba7d28f54b33f94ebcaa5819a5cb
-  data.tar.gz: 1036ca48d53463eb1b13349f4865a8022a06651fc233851d316c70fb496040ac
+  metadata.gz: c0a18404c0b3197dd888ee8b286ec575e391327d0ad7c50645fb57adfa922b78
+  data.tar.gz: 69bd5fc4c3dc70d2daf646debe653d899ebfd7bef691809c8ac31b4e49ebf1cf
 SHA512:
-  metadata.gz: d13c60883ccbf875b28cf17968ccdb766f957f4a27f578b8af80369b97847f9c4cdd4cb87314f9b3795c2107e02317b808f9808d80e31b6ddb2da77cb2b01085
-  data.tar.gz: 9363b56f7968471b7853a8ca25169c0425ad911f4c99e657b2ff5776314baac3ba8b9ad507d98cacbb07c21c11cad0a29c29f096ca5b7cc6dcd8b0408f1c01f8
+  metadata.gz: 66c4fc49df2fcebbbb41913e55223d94b5058bde802b714381c1a91178d37d13904055a99aa5b5d5f87283d1248cdde6d86c309060f238a7988f538277de72db
+  data.tar.gz: fa6fed8320e73cc1bea2ef9fbf3aec9640f9de5f62f79c03cb5a34ad2473c5bbd452008b1dd4ba275c47e844d75ca0d68351efc4c6fd67d0dc0cd284211e0465

data/README.adoc

@@ -22,18 +22,33 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 == Usage
 
+[source,ruby]
+----
+require 'relaton/index'
+
+# Create a new index object. The first argument is the type of dataset (ISO, IEC, IHO, etc.) URL and filename are optional.
+Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/index.zip", filename: "index-iho.yaml"
+
+# 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.
+Relaton::Index.find_or_create :IHO, url: nil, filename: "index.yaml"
+
+# Remove the index from the pool.
+Relaton::Index.close :IHO
+----
+
 The aim of this gem is to be used by Relaton libraries in two ways:
 - indexing documents' files in GitHub repositories
 - searching a document by a reference when the Relaton library fetches a document
 
 === 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]
 ---- 
-require 'relaton/index' 
-
 # Create a new index object or fetch an existing one. The first argument is the type of dataset (ISO, IEC, IHO, etc.) URL should not be specified.
 index = Relaton::Index.find_or_create :IHO
 
@@ -50,9 +65,7 @@ In this case, the Relaton library should create an index object and search for a
 
 [source,ruby]
 ----
-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 is saved as `index.yaml` file to the `/[HOME]/.relaton/iho/` folder.
 index = Relaton::Index.find_or_create :IHO, url: "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/index.zip"
 
 
@@ -66,9 +79,29 @@ index.search do |row|
   row[:id] == "B-4"
 end
 # => [{ id: "B-4 2.19.0", file: "data/b-4_2_19_0.xml" }] 
+----
 
-# Remove the index from the pool.
-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
+----
+
+It's also possible to redefine file name for a specific type of index:
+[source,ruby]
+----
+index = Relaton::Index.find_or_create :IHO, filename: "index-iho.yaml"
 ----
 
 == Development

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

@@ -6,16 +6,20 @@ module Relaton
     # In index mode url should be nil.
     #
     class FileIO
+      attr_reader :url
+
       #
       # 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)
+      def initialize(dir, url, filename)
         @dir = dir
         @url = url
+        @filename = filename
       end
 
       #
@@ -24,11 +28,11 @@ module Relaton
       # @return [Array<Hash>] index
       #
       def read
-        if @url
-          @file ||= File.join(Index.config.storage_dir, ".relaton", @dir, "index.yaml")
+        if url
+          @file ||= File.join(Index.config.storage_dir, ".relaton", @dir, @filename)
           check_file || fetch_and_save
         else
-          @file ||= "index.yaml"
+          @file ||= @filename
           read_file
         end
       end
@@ -63,7 +67,7 @@ module Relaton
       # @return [Array<Hash>] index
       #
       def fetch_and_save
-        resp = URI(@url).open
+        resp = URI(url).open
         zip = Zip::InputStream.new resp
         entry = zip.get_next_entry
         index = YAML.safe_load(entry.get_input_stream.read, permitted_classes: [Symbol])

data/lib/relaton/index/pool.rb

@@ -13,11 +13,16 @@ module Relaton
       #
       # @param [String] type <description>
       # @param [String, nil] url external URL to index, used to fetch index for searching files
+      # @param [String, nil] file output file name
       #
       # @return [Relaton::Index::Type] typed index
       #
-      def type(type, url)
-        @pool[type.upcase.to_sym] ||= Type.new(type, url)
+      def type(type, **args)
+        if @pool[type.upcase.to_sym]&.actual?(**args)
+          @pool[type.upcase.to_sym]
+        else
+          @pool[type.upcase.to_sym] = Type.new(type, args[:url], args[:file])
+        end
       end
 
       #

data/lib/relaton/index/type.rb

@@ -9,12 +9,19 @@ module Relaton
       #
       # @param [String, Symbol] type type of index (ISO, IEC, etc.)
       # @param [String, nil] url external URL to index, used to fetch index for searching files
+      # @param [String, nil] file output file name
       #
-      def initialize(type, url = nil)
-        @file_io = FileIO.new type.to_s.downcase, url
+      def initialize(type, url = nil, file = nil)
+        @file = file
+        filename = file || Index.config.filename
+        @file_io = FileIO.new type.to_s.downcase, url, filename
         @index = @file_io.read
       end
 
+      def actual?(**args)
+        (!args.key?(:url) || args[:url] == @file_io.url) && (!args.key?(:file) || args[:file] == @file)
+      end
+
       #
       # Add or update index item
       #

data/lib/relaton/index/version.rb

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

data/lib/relaton/index.rb

@@ -20,11 +20,12 @@ module Relaton
       #
       # @param [String] type index type (ISO, IEC, etc.)
       # @param [String, nil] url external URL to index, used to fetch index for searching files
+      # @param [String, nil] file output file name, default is config.filename
       #
       # @return [Relaton::Index::Type] typed index
       #
-      def find_or_create(type, url: nil)
-        pool.type(type, url)
+      def find_or_create(type, url: nil, file: nil)
+        pool.type(type, url, 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.2
+  version: 0.1.4
 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