Class: PuppetDebugger::InputResponderPlugin

Inherits:

Object

• Object
• PuppetDebugger::InputResponderPlugin

Extended by:

Forwardable

Includes:

Singleton

Defined in:

lib/puppet-debugger/input_responder_plugin.rb

Direct Known Subclasses

PuppetDebugger::InputResponders::Benchmark, PuppetDebugger::InputResponders::Classes, PuppetDebugger::InputResponders::Classification, PuppetDebugger::InputResponders::Commands, PuppetDebugger::InputResponders::Datatypes, PuppetDebugger::InputResponders::Environment, PuppetDebugger::InputResponders::Exit, PuppetDebugger::InputResponders::FacterdbFilter, PuppetDebugger::InputResponders::Facts, PuppetDebugger::InputResponders::Functions, PuppetDebugger::InputResponders::Help, PuppetDebugger::InputResponders::Krt, PuppetDebugger::InputResponders::Play, PuppetDebugger::InputResponders::Reset, PuppetDebugger::InputResponders::Resources, PuppetDebugger::InputResponders::Set, PuppetDebugger::InputResponders::Types, PuppetDebugger::InputResponders::Vars, PuppetDebugger::InputResponders::Whereami

Instance Attribute Summary

• #debugger ⇒ Object

  Returns the value of attribute debugger.

Class Method Summary

• .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.

• .command_group ⇒ String

  The name of the command group the plugin is in.

• .command_words ⇒ Array[String]

  An array of words the user can call the command with.

• .details ⇒ Hash

  A has of all the details of the plugin.

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

  The output of the plugin command.

• .summary ⇒ String

  A summary of the plugin.

Instance Method Summary

• #run(args = []) ⇒ Object

  The output of the plugin command.

Instance Attribute Details

#debugger ⇒ Object

Returns the value of attribute debugger.

# File 'lib/puppet-debugger/input_responder_plugin.rb', line 9

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

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

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

# File 'lib/puppet-debugger/input_responder_plugin.rb', line 26

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

# File 'lib/puppet-debugger/input_responder_plugin.rb', line 16

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

# File 'lib/puppet-debugger/input_responder_plugin.rb', line 31

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

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

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

# File 'lib/puppet-debugger/input_responder_plugin.rb', line 21

def self.summary
  self::SUMMARY
end

Instance Method Details

#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)

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

def run(args = [])
  raise NotImplementedError
end