Class: Smriti::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/smriti/configuration.rb

Overview

Configuration for the Smriti engine.

This class provides customization points for how Smriti integrates with background job systems and controls default behavior across the engine.

Supported job adapters:

  • :active_job (default)
  • :sidekiq
  • :resque

Examples:

Configure in an initializer

Smriti.configure do |config|
  config.job_adapter = :sidekiq
  config.job_queue   = :low_priority
  config.admin_ui   = { row_count_strategy: :estimated }
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ void

Initialize with defaults.



50
51
52
53
54
55
56
 
# File 'lib/smriti/configuration.rb', line 50

def initialize
  @job_adapter = :active_job
  @job_queue   = :default
  @admin_ui    = {
    row_count_strategy: :none
  }
end

Instance Attribute Details

#admin_ui ⇒ Hash

admin_ui configuration

Returns:

  • (Hash) 


44
45
46
 
# File 'lib/smriti/configuration.rb', line 44

def admin_ui
  @admin_ui
end

#job_adapter ⇒ Symbol

The job adapter to use for enqueuing jobs.

Returns:

  • (Symbol) —

    :active_job, :sidekiq, or :resque



33
34
35
 
# File 'lib/smriti/configuration.rb', line 33

def job_adapter
  @job_adapter
end

#job_queue ⇒ Symbol, String

The default queue name to use for jobs.

Returns:

  • (Symbol, String) 


39
40
41
 
# File 'lib/smriti/configuration.rb', line 39

def job_queue
  @job_queue
end