Class: Byebug::MethodCommand

Inherits:
Command
  • Object
show all
Includes:
Columnize
Defined in:
lib/byebug/commands/method.rb

Overview

Show methods of specific classes/modules/objects.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Command

commands, find, format_subcmd, format_subcmds, help, inherited, #initialize, #match

Methods included from StringFunctions

#camelize, #prettify

Methods included from FileFunctions

#get_line, #get_lines, #n_lines, #normalize

Methods included from ParseFunctions

#get_int, #parse_steps, #syntax_valid?

Constructor Details

This class inherits a constructor from Byebug::Command

Class Method Details

.descriptionObject


34
35
36
37
38
39
40
41
42
43
44
# File 'lib/byebug/commands/method.rb', line 34

def description
  prettify <<-EOD
    m[ethod] (i[nstance][ <obj>]|<class|module>)

    When invoked with "instance", shows instance methods of the object
    specified as argument or of self no object was specified.

    When invoked only with a class or module, shows class methods of the
    class or module specified as argument.
  EOD
end

.namesObject


30
31
32
# File 'lib/byebug/commands/method.rb', line 30

def names
  %w(method)
end

Instance Method Details

#executeObject


14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/byebug/commands/method.rb', line 14

def execute
  obj = bb_eval(@match.post_match)
  result =
    if @match[1]
      prc('method.methods', obj.methods.sort) { |item, _| { name: item } }
    elsif !obj.is_a?(Module)
      pr('variable.errors.not_module', object: @match.post_match)
    else
      prc('method.methods', obj.instance_methods(false).sort) do |item, _|
        { name: item }
      end
    end
  puts result
end

#regexpObject


10
11
12
# File 'lib/byebug/commands/method.rb', line 10

def regexp
  /^\s* m(?:ethod)? \s+ (i(:?nstance)?\s+)?/x
end