Class: Shell

Inherits:
Object
  • Object
show all
Defined in:
lib/core/shell.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.tmp_stderr ⇒ Object (readonly)

Returns the value of attribute tmp_stderr.



5
6
7
 
# File 'lib/core/shell.rb', line 5

def tmp_stderr
  @tmp_stderr
end

.verbose ⇒ Object (readonly)

Returns the value of attribute verbose.



5
6
7
 
# File 'lib/core/shell.rb', line 5

def verbose
  @verbose
end

Class Method Details

.abort(message) ⇒ Object 



50
51
52
 
# File 'lib/core/shell.rb', line 50

def self.abort(message)
  Kernel.abort(color("ERROR: #{message}", :red))
end

.color(message, color_key) ⇒ Object 



34
35
36
 
# File 'lib/core/shell.rb', line 34

def self.color(message, color_key)
  shell.set_color(message, color_key)
end

.confirm(message) ⇒ Object 



38
39
40
 
# File 'lib/core/shell.rb', line 38

def self.confirm(message)
  shell.yes?("#{message} (y/N)")
end

.debug(prefix, message, sensitive_data_pattern: nil) ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/core/shell.rb', line 58

def self.debug(prefix, message, sensitive_data_pattern: nil)
  return unless verbose

  filtered_message = hide_sensitive_data(message, sensitive_data_pattern)
  stderr.puts("\n[#{color(prefix, :red)}] #{filtered_message}")
end

.hide_sensitive_data(message, pattern = nil) ⇒ String

Hide sensitive data based on the passed pattern

Examples:

hide_sensitive_data("--token abcd", /(?<=--token )(\S+)/)

Parameters:

  • message (String) —

    The message to get processed.

  • pattern (Regexp, nil) (defaults to: nil) —

    The regular expression to be used. If not provided, no filter gets applied.

Returns:

  • (String) —

    Filtered message.



82
83
84
85
86
 
# File 'lib/core/shell.rb', line 82

def self.hide_sensitive_data(message, pattern = nil)
  return message unless pattern.is_a?(Regexp)

  message.gsub(pattern, "XXXXXXX")
end

.read_from_tmp_stderr ⇒ Object 



29
30
31
32
 
# File 'lib/core/shell.rb', line 29

def self.read_from_tmp_stderr
  tmp_stderr.rewind
  tmp_stderr.read.strip
end

.shell ⇒ Object 



8
9
10
 
# File 'lib/core/shell.rb', line 8

def self.shell
  @shell ||= Thor::Shell::Color.new
end

.should_hide_output? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/core/shell.rb', line 65

def self.should_hide_output?
  tmp_stderr && !verbose
end

.stderr ⇒ Object 



12
13
14
 
# File 'lib/core/shell.rb', line 12

def self.stderr
  @stderr ||= $stderr
end

.use_tmp_stderr ⇒ Object 



16
17
18
19
20
21
22
23
 
# File 'lib/core/shell.rb', line 16

def self.use_tmp_stderr
  @tmp_stderr = Tempfile.create

  yield

  @tmp_stderr.close
  @tmp_stderr = nil
end

.verbose_mode(verbose) ⇒ Object 



54
55
56
 
# File 'lib/core/shell.rb', line 54

def self.verbose_mode(verbose)
  @verbose = verbose
end

.warn(message) ⇒ Object 



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

def self.warn(message)
  stderr.puts(color("WARNING: #{message}", :yellow))
end

.warn_deprecated(message) ⇒ Object 



46
47
48
 
# File 'lib/core/shell.rb', line 46

def self.warn_deprecated(message)
  stderr.puts(color("DEPRECATED: #{message}", :yellow))
end

.write_to_tmp_stderr(message) ⇒ Object 



25
26
27
 
# File 'lib/core/shell.rb', line 25

def self.write_to_tmp_stderr(message)
  tmp_stderr.write(message)
end