Module: Byebug::Helpers::VarHelper

Includes:
EvalHelper
Included in:
VarCommand::AllCommand, VarCommand::ArgsCommand, VarCommand::GlobalCommand, VarCommand::InstanceCommand, VarCommand::LocalCommand
Defined in:
lib/byebug/helpers/var.rb

Overview

Utilities for variable subcommands

Instance Method Summary collapse

Methods included from EvalHelper

#error_eval, #multiple_thread_eval, #separate_thread_eval, #silent_eval, #warning_eval

Instance Method Details

#var_args ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/byebug/helpers/var.rb', line 58

def var_args
  args = context.frame.args
  return if args == [[:rest]]

  all_locals = context.frame.locals
  arg_values = args.map { |arg| arg[1] }

  locals = all_locals.select { |k, _| arg_values.include?(k) }
  puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, "instance")
end

#var_global ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/byebug/helpers/var.rb', line 37

def var_global
  globals = global_variables.reject do |v|
    %i[$IGNORECASE $= $KCODE $-K $binding].include?(v)
  end

  var_list(globals)
end

#var_instance(str) ⇒ Object 



45
46
47
48
49
 
# File 'lib/byebug/helpers/var.rb', line 45

def var_instance(str)
  obj = warning_eval(str || "self")

  var_list(obj.instance_variables, obj.instance_eval { binding })
end

#var_list(ary, binding = context.frame._binding) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/byebug/helpers/var.rb', line 13

def var_list(ary, binding = context.frame._binding)
  vars = ary.sort.map do |name|
    code = name.to_s

    if code == "$SAFE" && Gem.ruby_version >= Gem::Version.new("2.7.0.preview3")
      code = <<~RUBY
        original_stderr = $stderr

        begin
          $stderr = StringIO.new

          #{code}
        ensure
          $stderr = original_stderr
        end
      RUBY
    end

    [name, safe_inspect(silent_eval(code, binding))]
  end

  puts prv(vars, "instance")
end

#var_local ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/byebug/helpers/var.rb', line 51

def var_local
  locals = context.frame.locals
  cur_self = context.frame._self
  locals[:self] = cur_self unless cur_self.to_s == "main"
  puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, "instance")
end