class Knowledge::Adapters::Base
Description¶ ↑
This adapter is the base adapter. It does nothing specific but is meant to manage all generic stuff.
Usage¶ ↑
Just inherit from it
@example:
class MySuperAdapter < Knowledge::Adapters::Base; end
Attributes¶ ↑
@attr_reader [Class] setter @attr_reader [Hash] variables
Attributes
setter[R]
Setter
object used to set variables once retrieved
variables[R]
Variables descriptor
Public Class Methods
new(variables:, setter:, params: nil)
click to toggle source
Just initializes instance variables with given params
Parameters¶ ↑
@param :variables [Hash] @param :setter [Class] @param :params [Hash]
# File lib/knowledge/adapters/base.rb, line 44 def initialize(variables:, setter:, params: nil) # rubocop:disable Lint/UnusedMethodArgument @variables = variables @setter = setter end
Public Instance Methods
run()
click to toggle source
Should run the actual adapter. This method is meant to be overriden
Errors¶ ↑
@raise [Knowledge::AdapterRunMethodNotImplemented] if not overridden by subclasses
# File lib/knowledge/adapters/base.rb, line 59 def run raise ::Knowledge::AdapterRunMethodNotImplemented, "Please override the #run method for #{self.class}" end