samvera-nesting_indexer 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75345930203b00001250fed039cf25d5fb6924a0
-  data.tar.gz: 976fdb5ce55d267d2d579512c58fdcec074da652
+  metadata.gz: 3933e26eda523a5609b140bccf34d4c291669292
+  data.tar.gz: d6d13b4ba28d3863aaaf32f40a8524de8f37ab5b
 SHA512:
-  metadata.gz: 1a39a7a17bf963fa3b0e0f63779bbad6591331b1ad1da88b8f66e471b7bf7e821e57a82b21cf86ee76b50d192fd0fbf4727e41cadfcb1946cdeb81d32bcfb826
-  data.tar.gz: b15f80f10ece6a9cb33bf3ee6349fb00548ee2ba721dafbb75ed37393ac0db700ced920f2acd850aae60683b5eafe19202d647ce8935cc7225db865689287334
+  metadata.gz: fbd5fa597ab1afc270d34a8e501e39a9aa6d066f3442b87aa7f692c9bbbd8d719dcd6c08cd196e0b95a17dc13918588b33fad42b8f86e4cb65d0e25d31297f8b
+  data.tar.gz: 164221f096a42d550d624f6658fbc0e3127560935f05684f573c53de5c7772b4b68665a5058788a32fda61c06fbaf41936da0ea3bb32505f0cc874b7a9b1b3ec

data/lib/samvera/nesting_indexer/adapters/abstract_adapter.rb

@@ -7,27 +7,37 @@ module Samvera
       module AbstractAdapter
         # @api public
         # @param id [String]
-        # @return Samvera::NestingIndexer::Document::PreservationDocument
+        # @return [Samvera::NestingIndexer::Document::PreservationDocument]
         def self.find_preservation_document_by(id:)
           raise NotImplementedError
         end
 
         # @api public
         # @param id [String]
-        # @return Samvera::NestingIndexer::Documents::IndexDocument
+        # @return [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.find_index_document_by(id:)
           raise NotImplementedError
         end
 
         # @api public
-        # @yield Samvera::NestingIndexer::Document::PreservationDocument
-        def self.each_preservation_document(&block)
+        # @since 0.7.0
+        # @yieldparam id [String] The `id` of the preservation document
+        # @yieldparam parent_ids [String] The ids of the parent objects of this presevation document
+        def self.each_perservation_document_id_and_parent_ids(&block)
+          raise NotImplementedError
+        end
+
+        # @api public
+        # @since 0.7.0
+        # @param id [String] The `id` of the preservation document
+        # @return [Array<String>] The parent ids of the given preservation document
+        def self.find_preservation_parent_ids_for(id:)
           raise NotImplementedError
         end
 
         # @api public
         # @param document [Samvera::NestingIndexer::Documents::IndexDocument]
-        # @yield Samvera::NestingIndexer::Documents::IndexDocument
+        # @yield [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.each_child_document_of(document:, &block)
           raise NotImplementedError
         end

data/lib/samvera/nesting_indexer/adapters/in_memory_adapter.rb

@@ -19,20 +19,27 @@ module Samvera
 
         # @api public
         # @param id [String]
-        # @return Samvera::NestingIndexer::Documents::IndexDocument
+        # @return [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.find_index_document_by(id:)
           Index.find(id)
         end
 
         # @api public
-        # @yield Samvera::NestingIndexer::Document::PreservationDocument
-        def self.each_preservation_document(&block)
-          Preservation.find_each { |document| block.call(document) }
+        # @yieldparam id [String] The `id` of the preservation document
+        # @yieldparam parent_ids [String] The ids of the parent objects of this presevation document
+        def self.each_perservation_document_id_and_parent_ids(&block)
+          Preservation.find_each do |document|
+            block.call(document.id, document.parent_ids)
+          end
+        end
+
+        def self.find_preservation_parent_ids_for(id:)
+          Preservation.find(id).parent_ids
         end
 
         # @api public
         # @param document [Samvera::NestingIndexer::Documents::IndexDocument]
-        # @yield Samvera::NestingIndexer::Documents::IndexDocument
+        # @yield [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.each_child_document_of(document:, &block)
           Index.each_child_document_of(document: document, &block)
         end
@@ -41,7 +48,7 @@ module Samvera
         # This is not something that I envision using in the production environment;
         # It is hear to keep the Preservation system isolated and accessible only through interfaces.
         # @param attributes [Hash]
-        # @return Samvera::NestingIndexer::Documents::PreservationDocument
+        # @return [Samvera::NestingIndexer::Documents::PreservationDocument]
         def self.write_document_attributes_to_preservation_layer(attributes)
           Preservation.write_document(attributes)
         end
@@ -52,7 +59,7 @@ module Samvera
         # @param parent_ids [Array<String>]
         # @param ancestors [Array<String>]
         # @param pathnames [Array<String>]
-        # @return Hash - the attributes written to the indexing layer
+        # @return [Hash] - the attributes written to the indexing layer
         def self.write_document_attributes_to_index_layer(id:, parent_ids:, ancestors:, pathnames:)
           Index.write_document(id: id, parent_ids: parent_ids, ancestors: ancestors, pathnames: pathnames)
         end

data/lib/samvera/nesting_indexer/adapters/interface_behavior_spec.rb

@@ -19,6 +19,21 @@ if defined?(RSpec)
         expect(block_parameter_extracter.call(subject)).to be_empty
       end
     end
+    describe '.find_preservation_parent_ids_for' do
+      subject { described_class.method(:find_preservation_parent_ids_for) }
+
+      it 'requires the :id  keyword (and does not require any others)' do
+        expect(required_keyword_parameters.call(subject)).to eq([:id])
+      end
+
+      it 'does not require any other parameters (besides :id)' do
+        expect(required_parameters.call(subject)).to eq(required_keyword_parameters.call(subject))
+      end
+
+      it 'does not expect a block' do
+        expect(block_parameter_extracter.call(subject)).to be_empty
+      end
+    end
     describe '.find_index_document_by' do
       subject { described_class.method(:find_index_document_by) }
 
@@ -34,8 +49,8 @@ if defined?(RSpec)
         expect(block_parameter_extracter.call(subject)).to be_empty
       end
     end
-    describe '.each_preservation_document' do
-      subject { described_class.method(:each_preservation_document) }
+    describe '.each_perservation_document_id_and_parent_ids' do
+      subject { described_class.method(:each_perservation_document_id_and_parent_ids) }
 
       it 'requires no keywords' do
         expect(required_keyword_parameters.call(subject)).to eq([])

data/lib/samvera/nesting_indexer/repository_reindexer.rb

@@ -21,7 +21,7 @@ module Samvera
       # @param maximum_nesting_depth [Integer] detect cycles in the graph
       # @param adapter [Samvera::NestingIndexer::Adapters::AbstractAdapter] Conforms to the Samvera::NestingIndexer::Adapters::AbstractAdapter interface
       def initialize(maximum_nesting_depth:, id_reindexer:, adapter:)
-        @max_maximum_nesting_depth = maximum_nesting_depth.to_i
+        @maximum_nesting_depth = maximum_nesting_depth.to_i
         @id_reindexer = id_reindexer
         @adapter = adapter
         @processed_ids = []
@@ -29,12 +29,14 @@ module Samvera
 
       # @todo Would it make sense to leverage an each_preservation_id instead?
       def call
-        @adapter.each_preservation_document { |document| recursive_reindex(document, max_maximum_nesting_depth) }
+        @adapter.each_perservation_document_id_and_parent_ids do |id, parent_ids|
+          recursive_reindex(id: id, parent_ids: parent_ids, time_to_live: maximum_nesting_depth)
+        end
       end
 
       private
 
-      attr_reader :max_maximum_nesting_depth, :processed_ids, :id_reindexer
+      attr_reader :maximum_nesting_depth, :processed_ids, :id_reindexer
 
       # When we find a document, reindex it if it doesn't have a parent. If it has a parent, reindex the parent first.
       #
@@ -43,17 +45,17 @@ module Samvera
       #
       # The reindexing process assumes that an object's parents have been indexed; Thus we need to
       # walk up the parent graph to reindex the parents before we start on the child.
-      def recursive_reindex(document, maximum_nesting_depth = max_maximum_nesting_depth)
-        return true if processed_ids.include?(document.id)
-        raise Exceptions::CycleDetectionError, document.id if maximum_nesting_depth <= 0
-        document.parent_ids.each do |parent_id|
-          parent_document = @adapter.find_preservation_document_by(id: parent_id)
-          recursive_reindex(parent_document, maximum_nesting_depth - 1)
+      def recursive_reindex(id:, parent_ids:, time_to_live:)
+        return true if processed_ids.include?(id)
+        raise Exceptions::CycleDetectionError, id if time_to_live <= 0
+        parent_ids.each do |parent_id|
+          grand_parent_ids = @adapter.find_preservation_parent_ids_for(id: parent_id)
+          recursive_reindex(id: parent_id, parent_ids: grand_parent_ids, time_to_live: maximum_nesting_depth - 1)
         end
-        reindex_a_id(document.id)
+        reindex_an_id(id)
       end
 
-      def reindex_a_id(id)
+      def reindex_an_id(id)
         id_reindexer.call(id: id)
         processed_ids << id
       rescue StandardError => e

data/lib/samvera/nesting_indexer/version.rb

@@ -1,5 +1,5 @@
 module Samvera
   module NestingIndexer
-    VERSION = "0.6.0".freeze
+    VERSION = "0.7.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samvera-nesting_indexer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jeremy Friesen