Module: Kiba::Extend::Sources::Lookupable

Included in:
CSV
Defined in:
lib/kiba/extend/sources/lookupable.rb

Overview

Mix-in module for extending sources so that they can be used (or not) as lookups in jobs

Since:

  • 4.0.0

Instance Method Summary collapse

Instance Method Details

#is_lookupable?Boolean

Returns True.

Returns:

  • (Boolean)

    True

Since:

  • 4.0.0



12
13
14
# File 'lib/kiba/extend/sources/lookupable.rb', line 12

def is_lookupable?
  true
end

#lookup_options_keyObject

This method is abstract.

Returns:

  • Symbol used as key for specifying file options for lookup, if file options may be passed

  • Nil if no file options may be passed

Raises:

  • (NotImplementedError)

Since:

  • 4.0.0



20
21
22
23
# File 'lib/kiba/extend/sources/lookupable.rb', line 20

def lookup_options_key
  raise NotImplementedError,
    ":lookup_options_key must be defined in including class"
end