Module: ConsoleBuddy

Defined in:
lib/console_buddy/job.rb,
lib/console_buddy.rb,
lib/console_buddy/csv.rb,
lib/console_buddy/irb.rb,
lib/console_buddy/base.rb,
lib/console_buddy/report.rb,
lib/console_buddy/augment.rb,
lib/console_buddy/helpers.rb,
lib/console_buddy/railtie.rb,
lib/console_buddy/version.rb,
lib/console_buddy/jobs/resque.rb,
lib/console_buddy/one_off_job.rb,
lib/console_buddy/http_request.rb,
lib/console_buddy/jobs/sidekiq.rb,
lib/console_buddy/method_store.rb,
lib/console_buddy/jobs/active_job.rb,
lib/console_buddy/byebug/buddy_command.rb,
lib/console_buddy/byebug/hello_command.rb

Overview

Example Usage: ConsoleBuddy::Jobs::ActiveJob.perform_later(“foo”, “bar”)

This class is used to integrate the ConsoleBuddy::OneOffJob with ActiveJob.

Defined Under Namespace

Modules: Byebug, CSV, HttpRequest, IRB, Jobs, Report Classes: Augment, Base, Helpers, InvalidJobServiceType, Job, MethodStore, OneOffJob, Railtie

Constant Summary collapse

VERSION = 
"0.1.3"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.allowed_envs ⇒ Object

Returns the value of attribute allowed_envs.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def allowed_envs
  @allowed_envs
end

.ignore_startup_errors ⇒ Object

Returns the value of attribute ignore_startup_errors.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def ignore_startup_errors
  @ignore_startup_errors
end

.one_off_job_service_type ⇒ Object

Returns the value of attribute one_off_job_service_type.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def one_off_job_service_type
  @one_off_job_service_type
end

.use_in_debuggers ⇒ Object

Returns the value of attribute use_in_debuggers.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def use_in_debuggers
  @use_in_debuggers
end

.use_in_tests ⇒ Object

Returns the value of attribute use_in_tests.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def use_in_tests
  @use_in_tests
end

.verbose_console ⇒ Object

Returns the value of attribute verbose_console.



42
43
44
 
# File 'lib/console_buddy.rb', line 42

def verbose_console
  @verbose_console
end

Class Method Details

.load_byebug! ⇒ Object 



73
74
75
 
# File 'lib/console_buddy.rb', line 73

def load_byebug!
  start_buddy_in_byebug
end

.start! ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/console_buddy.rb', line 48

def start!
  # Initialize the default values
  set_config_defaults
  # Check if there is a .console_buddy/config file
  load_console_buddy_config

  # Only start the buddy in the allowed environments. e.g. development, test
  return if !allowed_env?

  # Do not start the buddy in test environment if use_in_tests is false
  return if test? && !use_in_tests

  begin
    load_console_buddy_files
    augment_classes
    augment_console
    start_buddy_in_irb
    start_buddy_in_rails
    start_buddy_in_byebug
    puts "ConsoleBuddy session started! Debugger: #{use_in_debuggers} | Test: #{current_env}" if verbose_console
  rescue ::StandardError => error
    puts "ConsoleBuddy encountered an during startup. [Error]: #{error.message}" if ignore_startup_errors
  end
end

.store ⇒ Object 



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

def store
  @store ||= ::ConsoleBuddy::MethodStore.new
end