Class: Quality::Runner

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/quality/runner.rb

Overview

Knows how to run different quality tools based on a configuration already determined.

Instance Method Summary collapse

Constructor Details

#initialize(config, gem_spec: Gem::Specification, quality_checker_class: Quality::QualityChecker, count_io: IO, count_file: File, globber: Dir, which: Which.new) ⇒ Runner

Returns a new instance of Runner.



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/quality/runner.rb', line 24

def initialize(config, gem_spec: Gem::Specification,
               quality_checker_class: Quality::QualityChecker,
               count_io: IO, count_file: File,
               globber: Dir, which: Which.new)
  @config = config
  @gem_spec = gem_spec
  @quality_checker_class = quality_checker_class
  @count_io = count_io
  @count_file = count_file
  @globber = globber
  @which = which
end

Instance Method Details

#command_name(clazz, name) ⇒ Object 



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

def command_name(clazz, name)
  if clazz.respond_to? :command_name
    clazz.command_name
  else
    name
  end
end

#count_existing_violations(filename) ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/quality/runner.rb', line 72

def count_existing_violations(filename)
  existing_violations = @count_io.read(filename).to_i
  raise("Problem with file #{filename}") if existing_violations.negative?

  existing_violations
end

#minimum_threshold_for(cmd) ⇒ Object 



97
98
99
 
# File 'lib/quality/runner.rb', line 97

def minimum_threshold_for(cmd)
  @config.minimum_threshold[cmd.to_sym] || 0
end

#ratchet_quality_cmd(cmd, command_options, &count_violations_on_line) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/quality/runner.rb', line 101

def ratchet_quality_cmd(cmd,
                        command_options,
                        &count_violations_on_line)
  quality_checker = @quality_checker_class.new(cmd,
                                               command_options,
                                               @config.output_dir,
                                               @config.verbose,
                                               minimum_threshold_for(cmd))
  quality_checker.execute(&count_violations_on_line)
end

#run_quality ⇒ Object 



37
38
39
40
41
 
# File 'lib/quality/runner.rb', line 37

def run_quality
  tools.each do |tool_name, tool_exe, clazz|
    run_quality_with_tool(tool_name, tool_exe, clazz)
  end
end

#run_quality_with_tool(tool_name, tool_exe, clazz) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/quality/runner.rb', line 43

def run_quality_with_tool(tool_name, tool_exe, clazz)
  suppressed = @config.skip_tools.include? tool_name
  installed = @gem_spec.find_all_by_name(tool_name).any? ||
              !@which.which(tool_exe).nil?

  if installed && !suppressed
    clazz.new(self).method("quality_#{tool_name}".to_sym).call
  elsif !installed
    puts "#{tool_name} not installed"
  end
end

#run_ratchet ⇒ Object 



55
56
57
 
# File 'lib/quality/runner.rb', line 55

def run_ratchet
  @config.all_output_files.each { |filename| run_ratchet_on_file(filename) }
end

#run_ratchet_on_file(filename) ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/quality/runner.rb', line 59

def run_ratchet_on_file(filename)
  puts "Processing #{filename}"
  existing_violations = count_existing_violations(filename)
  new_violations = [0, existing_violations - 1].max
  write_violations(filename, new_violations)
end

#tools ⇒ Object 



87
88
89
90
91
92
93
94
95
 
# File 'lib/quality/runner.rb', line 87

def tools
  TOOL_CLASSES.symbols_and_classes.map do |_symbol, clazz|
    clazz_name = clazz.to_s
    raise unless clazz_name.start_with?('Quality::Tools::')

    name = clazz_name.split('::').last.underscore
    [name, command_name(clazz, name), clazz]
  end.compact
end

#write_violations(filename, new_violations) ⇒ Object 



66
67
68
69
70
 
# File 'lib/quality/runner.rb', line 66

def write_violations(filename, new_violations)
  @count_file.open(filename, 'w') do |file|
    file.write(new_violations.to_s + "\n")
  end
end