curate-indexer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1be92053b6ce30d9e75ac935c7000861725a4c5
-  data.tar.gz: babb5d4f0228d9210d096688d920d5c457f0f266
+  metadata.gz: 18c501d0580dc9320571ba6c849d2cc68ee89757
+  data.tar.gz: b514b51c8c01130e99f7f0ea2893a941f4f59351
 SHA512:
-  metadata.gz: eb5f7aaecda93774887fe655bd9c9884901c65360f32575f74df1f1e15404ef5b0a3933e5992ef5a4a35b794364fddf5c0cbc63f5212214efe1d288a5f7099e3
-  data.tar.gz: 1aaf669fc93f8f435b6d116417da0433428cb72a0ff5871c362e8815d6348cbdb012dc2d8c7bee7b9a4ba9c17cdf315d435cc08c05a45d91223db0741aa66b7d
+  metadata.gz: 854ea3ff16844b348da2e8292af7a0d46f3488f0962d7f7e9acece6437c08243b324b05711f196192393cebb393822232e7cd3f87f94ebb3ccf76dfc162272de
+  data.tar.gz: 47a2e72f2ce17741a8db05a724228a0017246cb7c63b5278a784a28f6e9b9a2b462035d96793074adfd0fc84fc4148a12ed9914190b0fbbdc885743c5027e984

data/lib/curate/indexer/adapters/abstract_adapter.rb

@@ -0,0 +1,42 @@
+module Curate
+  module Indexer
+    module Adapters
+      # @api public
+      # A module that defines the interface of methods required to interact with Curate::Indexer operations
+      module AbstractAdapter
+        # @api public
+        # @param pid [String]
+        # @return Curate::Indexer::Document::PreservationDocument
+        def self.find_preservation_document_by(*)
+          raise NotImplementedError
+        end
+
+        # @api public
+        # @param pid [String]
+        # @return Curate::Indexer::Documents::IndexDocument
+        def self.find_index_document_by(*)
+          raise NotImplementedError
+        end
+
+        # @api public
+        # @yield Curate::Indexer::Document::PreservationDocument
+        def self.each_preservation_document
+          raise NotImplementedError
+        end
+
+        # @api public
+        # @param pid [String]
+        # @yield Curate::Indexer::Documents::IndexDocument
+        def self.each_child_document_of(*, &_block)
+          raise NotImplementedError
+        end
+
+        # @api public
+        # @return Curate::Indexer::Documents::IndexDocument
+        def self.write_document_attributes_to_index_layer(*)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/curate/indexer/adapters/in_memory_adapter.rb

@@ -0,0 +1,60 @@
+require 'curate/indexer/adapters/abstract_adapter'
+module Curate
+  module Indexer
+    module Adapters
+      # @api public
+      #
+      # Defines the interface for interacting with the InMemory layer. It is a reference
+      # implementation that is used throughout tests.
+      module InMemoryAdapter
+        extend AbstractAdapter
+        # @api public
+        # @param pid [String]
+        # @return Curate::Indexer::Document::PreservationDocument
+        def self.find_preservation_document_by(pid)
+          Preservation.find(pid)
+        end
+
+        # @api public
+        # @param pid [String]
+        # @return Curate::Indexer::Documents::IndexDocument
+        def self.find_index_document_by(pid)
+          Index.find(pid)
+        end
+
+        # @api public
+        # @yield Curate::Indexer::Document::PreservationDocument
+        def self.each_preservation_document
+          Preservation.find_each { |document| yield(document) }
+        end
+
+        # @api public
+        # @param pid [String]
+        # @yield Curate::Indexer::Documents::IndexDocument
+        def self.each_child_document_of(pid, &block)
+          Index.each_child_document_of(pid, &block)
+        end
+
+        # @api public
+        # 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.
+        # @return Curate::Indexer::Documents::PreservationDocument
+        def self.write_document_attributes_to_preservation_layer(attributes = {})
+          Preservation.write_document(attributes)
+        end
+
+        # @api public
+        # @return Curate::Indexer::Documents::IndexDocument
+        def self.write_document_attributes_to_index_layer(attributes = {})
+          Index.write_document(attributes)
+        end
+
+        # @api private
+        def self.clear_cache!
+          Preservation.clear_cache!
+          Index.clear_cache!
+        end
+      end
+    end
+  end
+end

data/lib/curate/indexer/adapters.rb

@@ -1,95 +1,12 @@
+require 'curate/indexer/adapters/abstract_adapter'
+require 'curate/indexer/adapters/in_memory_adapter'
+
 module Curate
   module Indexer
+    # A container for the various adapter implementations.
+    # @see Curate::Indexer::Adapters::AbstractAdapter
+    # @see Curate::Indexer::Adapters::InMemoryAdapter
     module Adapters
-      # @api public
-      # A module that defines the interface of methods required to interact with Curate::Indexer operations
-      module AbstractAdapter
-        # @api public
-        # @param pid [String]
-        # @return Curate::Indexer::Document::PreservationDocument
-        def self.find_preservation_document_by(*)
-          raise NotImplementedError
-        end
-
-        # @api public
-        # @param pid [String]
-        # @return Curate::Indexer::Documents::IndexDocument
-        def self.find_index_document_by(*)
-          raise NotImplementedError
-        end
-
-        # @api public
-        # @yield Curate::Indexer::Document::PreservationDocument
-        def self.each_preservation_document
-          raise NotImplementedError
-        end
-
-        # @api public
-        # @param pid [String]
-        # @yield Curate::Indexer::Documents::IndexDocument
-        def self.each_child_document_of(*, &_block)
-          raise NotImplementedError
-        end
-
-        # @api public
-        # @return Curate::Indexer::Documents::IndexDocument
-        def self.write_document_attributes_to_index_layer(*)
-          raise NotImplementedError
-        end
-      end
-      # @api public
-      #
-      # Defines the interface for interacting with the InMemory layer. It is a reference
-      # implementation that is used throughout tests.
-      module InMemoryAdapter
-        extend AbstractAdapter
-        # @api public
-        # @param pid [String]
-        # @return Curate::Indexer::Document::PreservationDocument
-        def self.find_preservation_document_by(pid)
-          Preservation.find(pid)
-        end
-
-        # @api public
-        # @param pid [String]
-        # @return Curate::Indexer::Documents::IndexDocument
-        def self.find_index_document_by(pid)
-          Index.find(pid)
-        end
-
-        # @api public
-        # @yield Curate::Indexer::Document::PreservationDocument
-        def self.each_preservation_document
-          Preservation.find_each { |document| yield(document) }
-        end
-
-        # @api public
-        # @param pid [String]
-        # @yield Curate::Indexer::Documents::IndexDocument
-        def self.each_child_document_of(pid, &block)
-          Index.each_child_document_of(pid, &block)
-        end
-
-        # @api public
-        # 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.
-        # @return Curate::Indexer::Documents::PreservationDocument
-        def self.write_document_attributes_to_preservation_layer(attributes = {})
-          Preservation.write_document(attributes)
-        end
-
-        # @api public
-        # @return Curate::Indexer::Documents::IndexDocument
-        def self.write_document_attributes_to_index_layer(attributes = {})
-          Index.write_document(attributes)
-        end
-
-        # @api private
-        def self.clear_cache!
-          Preservation.clear_cache!
-          Index.clear_cache!
-        end
-      end
     end
   end
 end

data/lib/curate/indexer/configuration.rb

@@ -12,7 +12,7 @@ module Curate
       private
 
       def default_adapter
-        require 'curate/indexer/adapters'
+        require 'curate/indexer/adapters/in_memory_adapter'
         Adapters::InMemoryAdapter
       end
     end

data/lib/curate/indexer/version.rb

@@ -1,5 +1,5 @@
 module Curate
   module Indexer
-    VERSION = "0.1.0".freeze
+    VERSION = "0.1.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curate-indexer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -256,6 +256,8 @@ files:
 - curate-indexer.gemspec
 - lib/curate/indexer.rb
 - lib/curate/indexer/adapters.rb
+- lib/curate/indexer/adapters/abstract_adapter.rb
+- lib/curate/indexer/adapters/in_memory_adapter.rb
 - lib/curate/indexer/configuration.rb
 - lib/curate/indexer/documents.rb
 - lib/curate/indexer/exceptions.rb