Class Consular::Core
In: lib/consular/core.rb
Parent: Object

Defines the abstract definition of a core. This needs to be subclassed and have the appropriate methods defined so that the CLI runner knows how to execute the Termfile on each core. You will need to add the core to Consular like so:

  Consular.add_core self

Methods

capture!   new   process!   setup!   valid_system?  

Attributes

termfile  [RW] 

Public Class methods

Captures the current terminal settings for the system. It will return a hash format like that of Consular::DSL so that Consular can write it back out into a Termfile.

@return [Hash] Consular style hash.

@api public

Instantiated the hash from the Termfile into the core.

@param [String] path

  Path to Termfile

@api public

Checks to see if the current system/terminal is the right one to use for this core. This is called by the CLI to check if a particular core should be used.

@return [Boolean] Whether the current system is valid.

@api public

Public Instance methods

Method called by the runner to execute the Termfile on the core.

@api public

Method called by runner to execute the Termfile setup on the core.

@api public

[Validate]