class SSHKit::Configuration

Attributes

backend[W]
default_env[W]
default_runner[W]
output[W]
umask[RW]

Public Instance Methods

backend() click to toggle source
# File lib/sshkit/configuration.rb, line 32
def backend
  @backend ||= SSHKit::Backend::Netssh
end
command_map() click to toggle source
# File lib/sshkit/configuration.rb, line 69
def command_map
  @command_map ||= SSHKit::CommandMap.new
end
command_map=(value) click to toggle source
# File lib/sshkit/configuration.rb, line 73
def command_map=(value)
  @command_map = SSHKit::CommandMap.new(value)
end
default_env() click to toggle source
# File lib/sshkit/configuration.rb, line 24
def default_env
  @default_env ||= {}
end
default_runner() click to toggle source
# File lib/sshkit/configuration.rb, line 28
def default_runner
  @default_runner ||= :parallel
end
deprecation_logger() click to toggle source
# File lib/sshkit/configuration.rb, line 12
def deprecation_logger
  unless defined? @deprecation_logger
    self.deprecation_output = $stderr
  end

  @deprecation_logger
end
deprecation_output=(out) click to toggle source
# File lib/sshkit/configuration.rb, line 20
def deprecation_output=(out)
  @deprecation_logger = DeprecationLogger.new(out)
end
format=(format) click to toggle source

TODO: deprecate in favor of `use_format`

# File lib/sshkit/configuration.rb, line 45
def format=(format)
  use_format(format)
end
output() click to toggle source
# File lib/sshkit/configuration.rb, line 8
def output
  @output ||= use_format(:pretty)
end
output_verbosity() click to toggle source
# File lib/sshkit/configuration.rb, line 36
def output_verbosity
  @output_verbosity ||= logger(:info)
end
output_verbosity=(verbosity) click to toggle source
# File lib/sshkit/configuration.rb, line 40
def output_verbosity=(verbosity)
  @output_verbosity = logger(verbosity)
end
use_format(formatter, *args) click to toggle source

Tell SSHKit to use the specified `formatter` for stdout. The formatter can be the name of a built-in SSHKit formatter, like `:pretty`, a formatter class, like `SSHKit::Formatter::Pretty`, or a custom formatter class you've written yourself.

Additional arguments will be passed to the formatter's constructor.

Example:

config.use_format(:pretty)

Is equivalent to:

config.output = SSHKit::Formatter::Pretty.new($stdout)
# File lib/sshkit/configuration.rb, line 64
def use_format(formatter, *args)
  klass = formatter.is_a?(Class) ? formatter : formatter_class(formatter)
  self.output = klass.new($stdout, *args)
end

Private Instance Methods

formatter_class(symbol) click to toggle source
# File lib/sshkit/configuration.rb, line 83
def formatter_class(symbol)
  name = symbol.to_s.downcase
  found = SSHKit::Formatter.constants.find do |const|
    const.to_s.downcase == name
  end
  fail NameError, %Q{Unrecognized SSHKit::Formatter "#{symbol}"} if found.nil?
  SSHKit::Formatter.const_get(found)
end
logger(verbosity) click to toggle source
# File lib/sshkit/configuration.rb, line 79
def logger(verbosity)
  verbosity.is_a?(Integer) ? verbosity : Logger.const_get(verbosity.upcase)
end