Class: Sym::App::CLI

Inherits:
Object show all
Includes:
CLISlop
Defined in:
lib/sym/app/cli.rb

Overview

This is the main interface class for the CLI application. It is responsible for parsing user’s input, providing help, examples, coordination of various sub-systems (such as PrivateKey detection), etc.

Besides holding the majority of the application state, it contains two primary public methods: #new and #run.

The constructor is responsible for parsing the flags and determining the the application is about to do. It sets up input/output, but doesn’t really execute any encryption or decryption. This happens in the #run method called immediately after #new.

{Shh{Shh::App{Shh::App::CLI} module effectively performs the translation of the opts object (of type Slop::Result) and interpretation of users intentions. It holds on to opts for the duration of the program.

Responsibility Delegated

The responsibility of determining the private key from various options provided is performed by the PrivateKey::Handler instance. See there for more details.

Subsequently, #run method handles the finding of the appropriate Sym::App::Commands::BaseCommand subclass to respond to user’s request. Command registry, sorting, command dependencies, and finding them is done by the Coommands module.

User input is handled by the Input::Handler instance, while the output is provided by the procs in the Output classes.

Finally, the Mac OS-X -specific usage of the KeyChain, is encapsulated in a cross-platform way inside the Keychain module.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CLISlop

#key_spec, #parse

Constructor Details

#initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil) ⇒ CLI

Returns a new instance of CLI.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/sym/app/cli.rb', line 62

def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)

  self.stdin  = stdin
  self.stdout = stdout
  self.stderr = stderr
  self.kernel = kernel

  Sym::App.stdin  = stdin
  Sym::App.stdout = stdout
  Sym::App.stderr = stderr

  begin
    # Re-map any legacy options to the new options
    self.opts = parse(argv)
    if opts[:sym_args]
      append_sym_args(argv)
      self.opts = parse(argv)
    end

    # Disable coloring if requested, or if piping STDOUT
    if opts[:no_color] || !self.stdout.tty?
      Colored2.disable! # reparse options without the colors to create new help msg
      self.opts = parse(argv)
    end

  rescue StandardError => e
    log :error, "#{e.message}" if opts
    error exception: e
    exit 127 if stdin == STDIN
  end

  self.application = ::Sym::Application.new(opts, stdin, stdout, stderr, kernel)
end

Instance Attribute Details

#application ⇒ Object

Returns the value of attribute application.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def application
  @application
end

#kernel ⇒ Object

Returns the value of attribute kernel.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def kernel
  @kernel
end

#opts ⇒ Object

Returns the value of attribute opts.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def opts
  @opts
end

#outputs ⇒ Object

Returns the value of attribute outputs.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def outputs
  @outputs
end

#stderr ⇒ Object

Returns the value of attribute stderr.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def stderr
  @stderr
end

#stdin ⇒ Object

Returns the value of attribute stdin.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def stdin
  @stdin
end

#stdout ⇒ Object

Returns the value of attribute stdout.



59
60
61
 
# File 'lib/sym/app/cli.rb', line 59

def stdout
  @stdout
end

Instance Method Details

#append_sym_args(argv) ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/sym/app/cli.rb', line 96

def append_sym_args(argv)
  if env_args = sym_args
    argv << env_args.split(' ')
    argv.flatten!
    argv.compact!
  end
end

#command ⇒ Object 



122
123
124
 
# File 'lib/sym/app/cli.rb', line 122

def command
  @command ||= self.application.command if self.application
end

#execute ⇒ Object 



112
113
114
115
116
117
118
119
120
 
# File 'lib/sym/app/cli.rb', line 112

def execute
  return Sym::App.exit_code if Sym::App.exit_code != 0
  result = application.execute
  if result.is_a?(Hash)
    self.output_proc ::Sym::App::Args.new({}).output_class
    error(result)
  end
  Sym::App.exit_code
end

#execute! ⇒ Object 



108
109
110
 
# File 'lib/sym/app/cli.rb', line 108

def execute!
  execute
end

#opts_present ⇒ Object 



134
135
136
137
138
 
# File 'lib/sym/app/cli.rb', line 134

def opts_present
  o = opts.to_hash
  o.keys.map { |k| opts[k] ? nil : k }.compact.each { |k| o.delete(k) }
  o
end

#output_proc(proc = nil) ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/sym/app/cli.rb', line 126

def output_proc(proc = nil)
  if self.application
    self.application.output = proc if proc
    return self.application.output
  end
  nil
end

#sym_args ⇒ Object 



104
105
106
 
# File 'lib/sym/app/cli.rb', line 104

def sym_args
  ENV[Sym::Constants::ENV_ARGS_VARIABLE_NAME]
end