Module: CapistranoMulticonfigParallel::CoreHelper

Included in:
ApplicationHelper, Configuration
Defined in:
lib/capistrano_multiconfig_parallel/helpers/core_helper.rb

Overview

class that holds the options that are configurable for this gem

Class Method Summary collapse

Class Method Details

.app_debug_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 16

def app_debug_enabled?
  configuration.multi_debug.to_s.downcase == 'true'
end

.ask_confirm(message, default) ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 35

def ask_confirm(message, default)
  force_confirmation do
    ask_stdout_confirmation(message, default)
  end
rescue
  return nil
end

.ask_stdout_confirmation(message, default) ⇒ Object 



29
30
31
32
33
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 29

def ask_stdout_confirmation(message, default)
  result = Ask.input message, default: default
  $stdout.flush
  result
end

.check_terminal_tty ⇒ Object 



24
25
26
27
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 24

def check_terminal_tty
  $stdin.sync = true if $stdin.isatty
  $stdout.sync = true if $stdout.isatty
end

.debug_websocket? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 116

def debug_websocket?
  websocket_server_config['enable_debug'].to_s == 'true'
end

.development_debug? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 55

def development_debug?
  ENV['MULTICAP_DEBUG'].to_s == 'true'
end

.error_filtered?(error) ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 51

def error_filtered?(error)
  [CapistranoMulticonfigParallel::TaskFailed, SystemExit].find { |class_name| error.is_a?(class_name) }.present?
end

.execute_with_rescue(output = nil) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 129

def execute_with_rescue(output = nil)
  yield if block_given?
rescue Interrupt
  rescue_interrupt
rescue => error
  rescue_error(error, output)
end

.find_worker_log(job_id, prefix = nil) ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 95

def find_worker_log(job_id, prefix = nil)
  return if job_id.blank?
  FileUtils.mkdir_p(log_directory) unless File.directory?(log_directory)
  filename = File.join(log_directory, "multi_cap_worker_#{prefix.present? ? "#{prefix}_" : ''}#{job_id}.log")
  setup_filename_logger(filename)
end

.force_confirmation(&block) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 43

def force_confirmation(&block)
  `stty -raw echo`
  check_terminal_tty
  result = block.call
  `stty -raw echo`
  result
end

.format_error(exception) ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 79

def format_error(exception)
  message = "\n#{exception.class} (#{exception.respond_to?(:message) ? exception.message : exception.inspect}):\n"
  message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
  message << '  ' << exception.backtrace.join("\n  ") if exception.respond_to?(:backtrace)
  message
end

.log_error(error, options = {}) ⇒ Object 



59
60
61
62
63
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 59

def log_error(error, options = {})
  message = format_error(error)
  log_output_error(error, options.fetch(:output, nil), message)
  log_to_file(message, options.merge(log_method: 'fatal'))
end

.log_output_error(error, output, message) ⇒ Object 



73
74
75
76
77
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 73

def log_output_error(error, output, message)
  return if message.blank? || error_filtered?(error)
  puts message if output.present?
  terminal_actor.errors.push(message) if terminal_errors?
end

.log_to_file(message, options = {}) ⇒ Object 



86
87
88
89
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 86

def log_to_file(message, options = {})
  worker_log = options.fetch(:job_id, '').present? ? find_worker_log(options[:job_id], options[:prefix]) : logger
  print_to_log_file(worker_log, options.merge(message: message)) if worker_log.present? && app_debug_enabled?
end

.multi_fetch_argv(args) ⇒ Object 



6
7
8
9
10
11
12
13
14
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 6

def multi_fetch_argv(args)
  options = {}
  args.each do |arg|
    if arg =~ /^(\w+)=(.*)$/m
      options[Regexp.last_match(1)] = Regexp.last_match(2)
    end
  end
  options
end

.print_to_log_file(worker_log, options = {}) ⇒ Object 



91
92
93
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 91

def print_to_log_file(worker_log, options = {})
  worker_log.send(options.fetch(:log_method, 'debug'), "#{options.fetch(:message, '')}\n")
end

.rescue_error(error, output = nil) ⇒ Object 



137
138
139
140
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 137

def rescue_error(error, output = nil)
  log_error(error, output: output)
  exit(1)
end

.rescue_interrupt ⇒ Object 



142
143
144
145
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 142

def rescue_interrupt
  `stty icanon echo`
  puts "\n Command was cancelled due to an Interrupt error."
end

.setup_filename_logger(filename) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 102

def setup_filename_logger(filename)
  worker_log = ::Logger.new(filename)
  worker_log.level = ::Logger::Severity::DEBUG
  setup_logger_formatter(worker_log)
  worker_log
end

.setup_logger_formatter(logger) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 109

def setup_logger_formatter(logger)
  logger.formatter = proc do |severity, datetime, progname, msg|
    date_format = datetime.strftime('%Y-%m-%d %H:%M:%S')
    "[#{date_format}] #{severity}  (#{progname}): #{msg}\n"
  end
end

.show_warning(message) ⇒ Object 



20
21
22
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 20

def show_warning(message)
  warn message if app_debug_enabled?
end

.terminal_actor ⇒ Object 



65
66
67
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 65

def terminal_actor
  Celluloid::Actor[:terminal_server]
end

.terminal_errors? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 69

def terminal_errors?
  development_debug? && terminal_actor.present? && terminal_actor.alive? && terminal_actor.errors.is_a?(Array)
end

.websocket_config ⇒ Object 



124
125
126
127
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 124

def websocket_config
  create_log_file(websocket_server_config.fetch('log_file_path', nil)) if debug_websocket?
  websocket_server_config.merge('enable_debug' =>  debug_websocket?)
end

.websocket_server_config ⇒ Object 



120
121
122
 
# File 'lib/capistrano_multiconfig_parallel/helpers/core_helper.rb', line 120

def websocket_server_config
  configuration.fetch(:websocket_server, {}).stringify_keys
end