Class: SyntaxSuggest::Cli

Inherits:
Object
  • Object
show all
Defined in:
lib/syntax_suggest/cli.rb

Overview

All the logic of the exe/syntax_suggest CLI in one handy spot

Cli.new(argv: ["--help"]).call
Cli.new(argv: ["<path/to/file>.rb"]).call
Cli.new(argv: ["<path/to/file>.rb", "--record=tmp"]).call
Cli.new(argv: ["<path/to/file>.rb", "--terminal"]).call

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv:, exit_obj: Kernel, io: $stdout, env: ENV) ⇒ Cli

ARGV is Everything passed to the executable, does not include executable name

All other intputs are dependency injection for testing



20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/syntax_suggest/cli.rb', line 20

def initialize(argv:, exit_obj: Kernel, io: $stdout, env: ENV)
  @options = {}
  @parser = nil
  options[:record_dir] = env["SYNTAX_SUGGEST_RECORD_DIR"]
  options[:record_dir] = "tmp" if env["DEBUG"]
  options[:terminal] = SyntaxSuggest::DEFAULT_VALUE

  @io = io
  @argv = argv
  @exit_obj = exit_obj
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



15
16
17
 
# File 'lib/syntax_suggest/cli.rb', line 15

def options
  @options
end

Instance Method Details

#call ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/syntax_suggest/cli.rb', line 32

def call
  if @argv.empty?
    # Display help if raw command
    parser.parse! %w[--help]
    return
  else
    # Mutates @argv
    parse
    return if options[:exit]
  end

  file_name = @argv.first
  if file_name.nil?
    @io.puts "No file given"
    @exit_obj.exit(1)
    return
  end

  file = Pathname(file_name)
  if !file.exist?
    @io.puts "file not found: #{file.expand_path} "
    @exit_obj.exit(1)
    return
  end

  @io.puts "Record dir: #{options[:record_dir]}" if options[:record_dir]

  display = SyntaxSuggest.call(
    io: @io,
    source: file.read,
    filename: file.expand_path,
    terminal: options.fetch(:terminal, SyntaxSuggest::DEFAULT_VALUE),
    record_dir: options[:record_dir]
  )

  if display.document_ok?
    @io.puts "Syntax OK"
    @exit_obj.exit(0)
  else
    @exit_obj.exit(1)
  end
end

#parse ⇒ Object 



75
76
77
78
79
 
# File 'lib/syntax_suggest/cli.rb', line 75

def parse
  parser.parse!(@argv)

  self
end

#parser ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/syntax_suggest/cli.rb', line 81

def parser
  @parser ||= OptionParser.new do |opts|
    opts.banner = <<~EOM
      Usage: syntax_suggest <file> [options]

      Parses a ruby source file and searches for syntax error(s) such as
      unexpected `end', expecting end-of-input.

      Example:

        $ syntax_suggest dog.rb

        # ...

          > 10  defdog
          > 15  end

      ENV options:

        SYNTAX_SUGGEST_RECORD_DIR=<dir>

        Records the steps used to search for a syntax error
        to the given directory

      Options:
    EOM

    opts.version = SyntaxSuggest::VERSION

    opts.on("--help", "Help - displays this message") do |v|
      @io.puts opts
      options[:exit] = true
      @exit_obj.exit
    end

    opts.on("--record <dir>", "Records the steps used to search for a syntax error to the given directory") do |v|
      options[:record_dir] = v
    end

    opts.on("--terminal", "Enable terminal highlighting") do |v|
      options[:terminal] = true
    end

    opts.on("--no-terminal", "Disable terminal highlighting") do |v|
      options[:terminal] = false
    end
  end
end