Merge pull request #557 from samvera-labs/issue/515-initialize-docs

Doc in code that persister, query service #initialize are not public API

lib/valkyrie/persistence/fedora/persister.rb

@@ -6,6 +6,8 @@ class Persister
     require 'valkyrie/persistence/fedora/persister/alternate_identifier'
     attr_reader :adapter
     delegate :connection, :base_path, :resource_factory, to: :adapter
+
+    # (see Valkyrie::Persistence::Memory::Persister#initialize)
     def initialize(adapter:)
       @adapter = adapter
     end

lib/valkyrie/persistence/fedora/query_service.rb

@@ -4,6 +4,8 @@ module Valkyrie::Persistence::Fedora
   class QueryService
     attr_reader :adapter
     delegate :connection, :resource_factory, to: :adapter
+
+    # (see Valkyrie::Persistence::Memory::QueryService#initialize)
     def initialize(adapter:)
       @adapter = adapter
     end

lib/valkyrie/persistence/memory/persister.rb

@@ -6,8 +6,10 @@ module Valkyrie::Persistence::Memory
   class Persister
     attr_reader :adapter
     delegate :cache, to: :adapter
+
     # @param adapter [Valkyrie::Persistence::Memory::MetadataAdapter] The memory adapter which
     #   holds the cache for this persister.
+    # @note Many persister methods are part of Valkyrie's public API, but instantiation itself is not
     def initialize(adapter)
       @adapter = adapter
     end

lib/valkyrie/persistence/memory/query_service.rb

@@ -6,8 +6,10 @@ class QueryService
     # @note Documentation for Query Services in general is maintained here.
     attr_reader :adapter, :query_handlers
     delegate :cache, to: :adapter
+
     # @param adapter [Valkyrie::Persistence::Memory::MetadataAdapter] The adapter which
     #   has the cache to query.
+    # @note Many query service methods are part of Valkyrie's public API, but instantiation itself is not
     def initialize(adapter:)
       @adapter = adapter
       @query_handlers = []

lib/valkyrie/persistence/postgres/persister.rb

@@ -6,6 +6,8 @@ module Valkyrie::Persistence::Postgres
   class Persister
     attr_reader :adapter
     delegate :resource_factory, to: :adapter
+
+    # (see Valkyrie::Persistence::Memory::Persister#initialize)
     def initialize(adapter:)
       @adapter = adapter
     end

lib/valkyrie/persistence/postgres/query_service.rb

@@ -9,6 +9,8 @@ module Valkyrie::Persistence::Postgres
   class QueryService
     attr_reader :resource_factory
     delegate :orm_class, to: :resource_factory
+
+    # (see Valkyrie::Persistence::Memory::QueryService#initialize)
     def initialize(resource_factory:)
       @resource_factory = resource_factory
     end

lib/valkyrie/persistence/solr/persister.rb

@@ -7,8 +7,10 @@ module Valkyrie::Persistence::Solr
   class Persister
     attr_reader :adapter
     delegate :connection, :resource_factory, to: :adapter
+
     # @param adapter [Valkyrie::Persistence::Solr::MetadataAdapter] The adapter with the
     #   configured solr connection.
+    # (see Valkyrie::Persistence::Memory::Persister#initialize)
     def initialize(adapter:)
       @adapter = adapter
     end

lib/valkyrie/persistence/solr/query_service.rb

@@ -4,8 +4,10 @@ module Valkyrie::Persistence::Solr
   # Query Service for Solr MetadataAdapter.
   class QueryService
     attr_reader :connection, :resource_factory
+
     # @param connection [RSolr::Client]
     # @param resource_factory [Valkyrie::Persistence::Solr::ResourceFactory]
+    # (see Valkyrie::Persistence::Memory::QueryService#initialize)
     def initialize(connection:, resource_factory:)
       @connection = connection
       @resource_factory = resource_factory