Class: PuppetDebugger::InputResponderPlugin

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Singleton
Defined in:
lib/puppet-debugger/input_responder_plugin.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#debugger ⇒ Object

Returns the value of attribute debugger.



11
12
13
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 11

def debugger
  @debugger
end

Class Method Details

.command_completion(_buffer_words) ⇒ Object

By default this returns an empty array, your plugin can chose to override this method in order to provide the user with a list of key words based on the user’s input

Parameters:

  • buffer_words (Array[String]) —

    a array of words the user has typed in



45
46
47
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 45

def self.command_completion(_buffer_words)
  []
end

.command_group ⇒ String

Returns the name of the command group the plugin is in.

Returns:

  • (String) —

    the name of the command group the plugin is in



32
33
34
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 32

def self.command_group
  self::COMMAND_GROUP
end

.command_words ⇒ Array[String]

Returns an array of words the user can call the command with.

Returns:

  • (Array[String]) —

    an array of words the user can call the command with



18
19
20
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 18

def self.command_words
  self::COMMAND_WORDS
end

.details ⇒ Hash

Returns a has of all the details of the plugin.

Returns:

  • (Hash) —

    a has of all the details of the plugin



37
38
39
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 37

def self.details
  { words: command_words, summary: summary, group: command_group }
end

.execute(args = [], debugger) ⇒ Object

Returns the output of the plugin command.

Parameters:

  • args (Array[String]) (defaults to: []) —

    • an array of arguments to pass to the plugin command

  • debugger —

    PuppetDebugger::Cli - an instance of the PuppetDebugger::Cli object

Returns:

  • the output of the plugin command



52
53
54
55
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 52

def self.execute(args = [], debugger)
  instance.debugger = debugger
  instance.run(args)
end

.summary ⇒ String

Returns a summary of the plugin.

Returns:

  • (String) —

    a summary of the plugin



27
28
29
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 27

def self.summary
  self::SUMMARY
end

Instance Method Details

#modules_paths ⇒ Object 



22
23
24
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 22

def modules_paths
  debugger.puppet_environment.full_modulepath
end

#puppet_debugger_lib_dir ⇒ Object

this is the lib directory of this gem in order to load any puppet functions from this gem we need to add the lib path of this gem



66
67
68
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 66

def puppet_debugger_lib_dir
  File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
end

#run(args = []) ⇒ Object

Returns the output of the plugin command.

Parameters:

  • args (Array[String]) (defaults to: []) —

    • an array of arguments to pass to the plugin command

Returns:

  • the output of the plugin command

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/puppet-debugger/input_responder_plugin.rb', line 59

def run(args = [])
  raise NotImplementedError
end