Class: Rubocop::CLI

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

Overview

The CLI is a class responsible of handling all the command line interface logic.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.rip_source(source) ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/rubocop/cli.rb', line 87

def self.rip_source(source)
  tokens = Ripper.lex(source.join("\n")).map { |t| Cop::Token.new(*t) }
  sexp = Ripper.sexp(source.join("\n"))
  Cop::Position.make_position_objects(sexp)
  correlations = Cop::Grammar.new(tokens).correlate(sexp)
  [tokens, sexp, correlations]
end

Instance Method Details

#config_from_dotfile(target_file_dir) ⇒ Object

Returns the configuration hash from .rubocop.yml searching upwards in the directory structure starting at the given directory where the inspected file is. If no .rubocop.yml is found there, the user’s home directory is checked.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rubocop/cli.rb', line 99

def config_from_dotfile(target_file_dir)
  return unless target_file_dir
  # @configs is a cache that maps directories to
  # configurations. We search for .rubocop.yml only if we haven't
  # already found it for the given directory.
  unless @configs[target_file_dir]
    dir = target_file_dir
    while dir != '/'
      path = File.join(dir, '.rubocop.yml')
      if File.exist?(path)
        @configs[target_file_dir] = YAML.load_file(path)
        break
      end
      dir = File.expand_path('..', dir)
    end
    path = File.join(Dir.home, '.rubocop.yml')
    @configs[target_file_dir] = YAML.load_file(path) if File.exist?(path)
  end
  @configs[target_file_dir]
end

#cops_on_duty(config) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/rubocop/cli.rb', line 120

def cops_on_duty(config)
  cops_on_duty = []

  Cop::Cop.all.each do |cop_klass|
    cop_config = config[cop_klass.name.split('::').last] if config
    cops_on_duty << cop_klass if cop_config.nil? || cop_config['Enabled']
  end

  cops_on_duty
end

#get_rid_of_invalid_byte_sequences(line) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/rubocop/cli.rb', line 79

def get_rid_of_invalid_byte_sequences(line)
  enc = line.encoding.name
  # UTF-16 works better in this algorithm but is not supported in 1.9.2.
  temporary_encoding = (RUBY_VERSION == '1.9.2') ? 'UTF-8' : 'UTF-16'
  line.encode!(temporary_encoding, enc, invalid: :replace, replace: '')
  line.encode!(enc, temporary_encoding)
end

#run(args = ARGV) ⇒ Fixnum

Entry point for the application logic. Here we do the command line arguments processing and inspect the target files

Returns:

  • (Fixnum) —

    UNIX exit code



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
74
75
76
77
 
# File 'lib/rubocop/cli.rb', line 15

def run(args = ARGV)
  $options = { mode: :default }

  OptionParser.new do |opts|
    opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'

    opts.on('-d', '--[no-]debug', 'Display debug info') do |d|
      $options[:debug] = d
    end
    opts.on('-e', '--emacs', 'Emacs style output') do
      $options[:mode] = :emacs_style
    end
    opts.on('-c FILE', '--config FILE', 'Configuration file') do |f|
      $options[:config] = YAML.load_file(f)
    end
    opts.on('-s', '--silent', 'Silence summary') do |s|
      $options[:silent] = s
    end
    opts.on('-v', '--version', 'Display version') do
      puts Rubocop::VERSION
      exit(0)
    end
  end.parse!(args)

  total_offences = 0
  @configs = {}

  target_files = target_files(args)
  config = $options[:config] || config_from_dotfile(target_files[0])

  cops = cops_on_duty(config)
  show_cops_on_duty(cops) if $options[:debug]

  target_files(args).each do |file|
    report = Report.create(file, $options[:mode])
    source = File.readlines(file).map do |line|
      get_rid_of_invalid_byte_sequences(line)
      line.chomp
    end

    tokens, sexp, correlations = CLI.rip_source(source)

    cops.each do |cop_klass|
      cop_config = config[cop_klass.name.split('::').last] if config
      cop_klass.config = cop_config
      cop = cop_klass.new
      cop.correlations = correlations
      cop.inspect(file, source, tokens, sexp)
      total_offences += cop.offences.count
      report << cop if cop.has_report?
    end

    report.display unless report.empty?
  end

  unless $options[:silent]
    print "\n#{target_files(args).count} files inspected, "
    puts "#{total_offences} offences detected"
      .send(total_offences.zero? ? :green : :red)
  end

  return total_offences == 0 ? 0 : 1
end

#show_cops_on_duty(cops) ⇒ Object 



131
132
133
134
135
 
# File 'lib/rubocop/cli.rb', line 131

def show_cops_on_duty(cops)
  puts '== Reporting for duty =='
  cops.each { |c| puts ' * '.yellow + c.to_s.green }
  puts '========================'
end

#target_files(args) ⇒ Array

Generate a list of target files by expanding globing patterns (if any). If args is empty recursively finds all Ruby source files in the current directory

Returns:

  • (Array) —

    array of filenames



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rubocop/cli.rb', line 141

def target_files(args)
  return Dir['**/*.rb'] if args.empty?

  files = []

  args.each do |target|
    if File.directory?(target)
      files << Dir["#{target}/**/*.rb"]
    elsif target =~ /\*/
      files << Dir[target]
    else
      files << target
    end
  end

  files.flatten
end