Class: Fast::Cli

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

Overview

Command Line Interface for Fast

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Cli

Returns a new instance of Cli.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/fast/cli.rb', line 85

def initialize(args)
  args = replace_args_with_shortcut(args) if args.first&.start_with?('.')

  @pattern, *@files = args.reject { |arg| arg.start_with? '-' }
  @colorize = STDOUT.isatty

  option_parser.parse! args

  @files = [*@files].reject { |arg| arg.start_with?('-') }
  @sql ||= @files.any? && @files.all? { |file| file.end_with?('.sql') }

  require 'fast/sql' if @sql
end

Instance Attribute Details

#from_code ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def from_code
  @from_code
end

#help ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def help
  @help
end

#pattern ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def pattern
  @pattern
end

#pry ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def pry
  @pry
end

#show_sexp ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def show_sexp
  @show_sexp
end

#similar ⇒ Object (readonly)

rubocop:disable Metrics/ClassLength



84
85
86
 
# File 'lib/fast/cli.rb', line 84

def similar
  @similar
end

Class Method Details

.run!(argv) ⇒ Object

Run a new command line interface digesting the arguments



180
181
182
183
 
# File 'lib/fast/cli.rb', line 180

def self.run!(argv)
  argv = argv.dup
  new(argv).run!
end

Instance Method Details

#debug(*info) ⇒ Object

Output information if #debug_mode? is true.



257
258
259
 
# File 'lib/fast/cli.rb', line 257

def debug(*info)
  puts(info) if debug_mode?
end

#debug_mode? ⇒ Boolean

Returns true when “-d” or “–debug” option is passed.

Returns:

  • (Boolean) —

    true when “-d” or “–debug” option is passed



252
253
254
 
# File 'lib/fast/cli.rb', line 252

def debug_mode?
  @debug == true
end

#execute_search {|with| ... } ⇒ Object

Executes search for all files yielding the results

Yield Parameters:

  • with (String, Array) —

    file and respective search results



238
239
240
241
242
243
244
 
# File 'lib/fast/cli.rb', line 238

def execute_search(&on_result)
  Fast.public_send(search_method_name,
                   @pattern,
                   @files,
                   parallel: parallel?,
                   on_result: on_result)
end

#exit_shortcut_not_found(name) ⇒ Object

Exit process with warning message bolding the shortcut that was not found. Prints available shortcuts as extra help and exit with code 1.



293
294
295
296
297
298
299
300
 
# File 'lib/fast/cli.rb', line 293

def exit_shortcut_not_found(name)
  puts "Shortcut \033[1m#{name}\033[0m not found :("
  if Fast.shortcuts.any?
    puts "Available shortcuts are: #{Fast.shortcuts.keys.join(', ')}."
    Fast.load_fast_files!
  end
  exit 1
end

#expression ⇒ Array<Fast::Find>

Create fast expression from node pattern using the command line

Returns:

  • (Array<Fast::Find>) —

    with the expression from string.



217
218
219
 
# File 'lib/fast/cli.rb', line 217

def expression
  Fast.expression(@pattern)
end

#find_shortcut(name) ⇒ Fast::Shortcut

Find shortcut by name. Preloads all ‘Fastfiles` before start.

Parameters:

  • name (String)

Returns:



281
282
283
284
285
286
287
288
289
 
# File 'lib/fast/cli.rb', line 281

def find_shortcut(name)
  unless defined? Fast::Shortcut
    require 'fast/shortcut'
    Fast.load_fast_files!
  end

  shortcut = Fast.shortcuts[name] || Fast.shortcuts[name.to_sym]
  shortcut || exit_shortcut_not_found(name)
end

#option_parser ⇒ Object

rubocop:disable Metrics/MethodLength, Metrics/AbcSize



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/fast/cli.rb', line 99

def option_parser # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
  @option_parser ||= OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
    opts.banner = 'Usage: fast expression <files> [options]'
    opts.on('-d', '--debug', 'Debug fast engine') do
      @debug = true
    end

    opts.on('--ast', 'Print AST instead of code') do
      @show_sexp = true
    end

    opts.on('--link', 'Print link to repository URL') do
      require 'fast/git'
      @show_link = true
    end

    opts.on('--permalink', 'Print permalink to repository URL') do
      require 'fast/git'
      @show_permalink = true
    end

    opts.on('-p', '--parallel', 'Paralelize search') do
      @parallel = true
    end

    opts.on("--sql", "Use SQL instead of Ruby") do
      @sql = true
    end

    opts.on('--captures', 'Print only captures of the patterns and skip node results') do
      @captures = true
    end

    opts.on('--headless', 'Print results without the file name in the header') do
      @headless = true
    end

    opts.on('--bodyless', 'Print results without the code details') do
      @bodyless = true
    end

    opts.on('--pry', 'Jump into a pry session with results') do
      @pry = true
      require 'pry'
    end

    opts.on('-s', '--similar', 'Search for similar code.') do
      @similar = true
    end

    opts.on('--no-color', 'Disable color output') do
      @colorize = false
    end

    opts.on('--from-code', 'From code') do
      @from_code = true
    end

    opts.on_tail('--version', 'Show version') do
      puts Fast::VERSION
      exit
    end

    opts.on_tail('-h', '--help', 'Show help. More at https://jonatas.github.io/fast') do
      @help = true
    end
  end
end

#parallel? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/fast/cli.rb', line 261

def parallel?
  @parallel == true
end

#replace_args_with_shortcut(args) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/fast/cli.rb', line 168

def replace_args_with_shortcut(args)
  shortcut = find_shortcut args.first[1..]

  if shortcut.single_run_with_block?
    shortcut.run
    exit
  else
    args.one? ? shortcut.args : shortcut.merge_args(args[1..])
  end
end

#report(file, result) ⇒ Object

Report results using the actual options binded from command line.

See Also:



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/fast/cli.rb', line 267

def report(file, result)
  Fast.report(result,
              file: file,
              show_link: @show_link,
              show_permalink: @show_permalink,
              show_sexp: @show_sexp,
              headless: @headless,
              bodyless: @bodyless,
              colorize: @colorize)
end

#run! ⇒ Object

Show help or search for node patterns



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/fast/cli.rb', line 186

def run!
  raise 'pry and parallel options are incompatible :(' if @parallel && @pry

  if @help || @files.empty? && @pattern.nil?
    puts option_parser.help
    return
  end

  if @similar
    ast = Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
    @pattern = Fast.expression_from(ast)
    debug "Search similar to #{@pattern}"
  elsif @from_code
    ast = Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
    @pattern = ast.to_sexp
    if @sql
      @pattern.gsub!(/\b-\b/,'_')
    end
    debug "Search from code to #{@pattern}"
  end

  if @files.empty?
    ast ||= Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
    puts Fast.highlight(ast, show_sexp: @show_sexp, colorize: @colorize, sql: @sql)
  else
    search
  end
end

#search ⇒ Object

Search for each file independent. If -d (debug option) is enabled, it will output details of each search. If capture option is enabled it will only print the captures, otherwise it prints all the results.



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/fast/cli.rb', line 225

def search
  return Fast.debug(&method(:execute_search)) if debug_mode?

  execute_search do |file, results|
    results.each do |result|
      binding.pry if @pry # rubocop:disable Lint/Debugger
      report(file, result)
    end
  end
end

#search_method_name ⇒ Symbol

Returns with ‘:capture_all` or `:search_all` depending the command line options.

Returns:

  • (Symbol) —

    with ‘:capture_all` or `:search_all` depending the command line options



247
248
249
 
# File 'lib/fast/cli.rb', line 247

def search_method_name
  @captures ? :capture_all : :search_all
end