Class: Karafka::Cli::Console

Inherits:
Base
  • Object
show all
Defined in:
lib/karafka/cli/console.rb

Overview

Console Karafka Cli action

Instance Attribute Summary

Attributes inherited from Base

#cli

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

bind_to, desc, #initialize, load, option

Constructor Details

This class inherits a constructor from Karafka::Cli::Base

Class Method Details

.console ⇒ String

Returns Console executing command for non-Rails setup.

Examples:

Karafka::Cli::Console.command #=> 'KARAFKA_CONSOLE=true bundle exec irb...'

Returns:

  • (String) —

    Console executing command for non-Rails setup



15
16
17
 
# File 'lib/karafka/cli/console.rb', line 15

def console
  "IRBRC='#{Karafka.gem_root}/.console_irbrc' bundle exec irb -r #{Karafka.boot_file}"
end

.rails_console ⇒ String

Note:

In case of Rails, it has its own console, hence we can just defer to it

Returns Console executing command for Rails setup.

Returns:

  • (String) —

    Console executing command for Rails setup



21
22
23
 
# File 'lib/karafka/cli/console.rb', line 21

def rails_console
  'bundle exec rails console'
end

Instance Method Details

#call ⇒ Object

Start the Karafka console



27
28
29
30
31
32
33
 
# File 'lib/karafka/cli/console.rb', line 27

def call
  cli.info

  command = ::Karafka.rails? ? self.class.rails_console : self.class.console

  exec "KARAFKA_CONSOLE=true #{command}"
end