Class: Chemicalml::Cli::Command

Inherits:

Object

• Object
• Chemicalml::Cli::Command

Defined in:

lib/chemicalml/cli/command.rb

Overview

Base class for every command. Subclasses implement #run(options).

Each command receives a Chemicalml::Logger in its constructor. When dispatched via Thor (the normal CLI path), the logger is bridged to Thor's shell for coloured output. When invoked directly (MyCommand.new.run(options)), the logger writes plain text to $stderr.

Direct Known Subclasses

ConstraintsCommand, ConventionsCommand, DictionariesCommand, ElementsCommand, EnumsCommand, InfoCommand, InspectCommand, ValidateCommand

Instance Attribute Summary

• #logger ⇒ Object readonly

  Returns the value of attribute logger.

Class Method Summary

• .run(options = {}, logger: Chemicalml::Logger.default) ⇒ Object

Instance Method Summary

• #initialize(logger: Chemicalml::Logger.default) ⇒ Command constructor

  A new instance of Command.

• #run(_options = {}) ⇒ Object

Constructor Details

#initialize(logger: Chemicalml::Logger.default) ⇒ Command

Returns a new instance of Command.

Parameters:

• logger (Chemicalml::Logger) (defaults to: Chemicalml::Logger.default) —

  the logger to use. Defaults to a plain stderr logger. The Thor dispatcher passes one bridged to Thor's shell for colour.

# File 'lib/chemicalml/cli/command.rb', line 18

def initialize(logger: Chemicalml::Logger.default)
  @logger = logger
end

Instance Attribute Details

#logger ⇒ Object (readonly)

Returns the value of attribute logger.

# File 'lib/chemicalml/cli/command.rb', line 13

def logger
  @logger
end

Class Method Details

.run(options = {}, logger: Chemicalml::Logger.default) ⇒ Object

# File 'lib/chemicalml/cli/command.rb', line 23

def run(options = {}, logger: Chemicalml::Logger.default)
  new(logger: logger).run(options)
end

Instance Method Details

#run(_options = {}) ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/chemicalml/cli/command.rb', line 28

def run(_options = {})
  raise NotImplementedError, "#{self.class} must implement #run"
end