Sha256: eaa8a29012bba82d736197626e0ede2a49833ef4ae34f839fe663beb20c172a8

Contents?: true

Size: 1.22 KB

Versions: 9

Compression:

Stored size: 1.22 KB

Contents

# frozen_string_literal: true
module Blacklight
  class AbstractRepository
    attr_accessor :blacklight_config
    attr_writer :connection

    # ActiveSupport::Benchmarkable requires a logger method
    attr_accessor :logger

    include ActiveSupport::Benchmarkable

    def initialize blacklight_config
      @blacklight_config = blacklight_config
    end

    def connection
      @connection ||= build_connection
    end

    ##
    # Find a single document result by a known id
    # @param [String] id document's unique key value
    # @param [Hash] params additional query parameters
    def find(id, params = {})
      raise NotImplementedError
    end

    ##
    # Execute a search query against a search index
    # @param [Hash] params query parameters
    def search(params = {})
      raise NotImplementedError
    end

    # Query the fields that exist from the index
    # @return [Hash]
    def reflect_fields
      raise NotImplementedError
    end

    ##
    # Is the repository in a working state?
    def ping
      raise NotImplementedError
    end

    private

      def connection_config
        blacklight_config.connection_config
      end

      def logger
        @logger ||= Blacklight.logger
      end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
blacklight-6.25.0 lib/blacklight/abstract_repository.rb
blacklight-6.24.0 lib/blacklight/abstract_repository.rb
blacklight-6.23.0 lib/blacklight/abstract_repository.rb
blacklight-6.22.0 lib/blacklight/abstract_repository.rb
blacklight-6.21.0 lib/blacklight/abstract_repository.rb
blacklight-6.20.0 lib/blacklight/abstract_repository.rb
blacklight-6.19.2 lib/blacklight/abstract_repository.rb
blacklight-6.19.1 lib/blacklight/abstract_repository.rb
blacklight-6.19.0 lib/blacklight/abstract_repository.rb