Class: MetricFu::Reek

Inherits:
Generator show all
Defined in:
lib/generators/reek.rb

Constant Summary collapse

REEK_REGEX = 
/^(\S+) (.*) \((.*)\)$/

Instance Attribute Summary

Attributes inherited from Generator

#report, #template

Instance Method Summary collapse

Methods inherited from Generator

class_name, #create_data_dir_if_missing, #create_metric_dir_if_missing, #create_output_dir_if_missing, generate_report, #generate_report, #initialize, #metric_directory, metric_directory, #remove_excluded_files, #round_to_tenths, #to_graph

Constructor Details

This class inherits a constructor from MetricFu::Generator

Instance Method Details

#analyze ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/generators/reek.rb', line 39

def analyze
  @matches = @output.chomp.split("\n\n").map{|m| m.split("\n") }
  @matches = @matches.map do |match|
    file_path = match.shift.split('--').first
    file_path = file_path.gsub('"', ' ').strip
    code_smells = match.map do |smell|
      match_object = smell.match(REEK_REGEX)
      next unless match_object
      {:method => match_object[1].strip,
       :message => match_object[2].strip,
       :type => match_object[3].strip}
    end.compact
    {:file_path => file_path, :code_smells => code_smells}
  end
end

#emit ⇒ Object 



6
7
8
9
10
11
12
 
# File 'lib/generators/reek.rb', line 6

def emit
  files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
  files = remove_excluded_files(files_to_reek.flatten)
  config_file_param = MetricFu.reek[:config_file_pattern] ? "--config #{MetricFu.reek[:config_file_pattern]}" : ''
  @output = `reek #{config_file_param} #{files.join(" ")}`
  @output = massage_for_reek_12 if reek_12?
end

#massage_for_reek_12 ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/generators/reek.rb', line 19

def massage_for_reek_12
  section_break = ''
  @output.split("\n").map do |line|
    case line
    when /^  /
      "#{line.gsub(/^  /, '')}\n"
    else
      parts = line.split(" -- ")
      if parts[1].nil?
        "#{line}\n"
      else
        warnings = parts[1].gsub(/ \(.*\):/, ':')
        result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
        section_break = "\n"
        result
      end
    end
  end.join
end

#per_file_info(out) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/generators/reek.rb', line 59

def per_file_info(out)
  @matches.each do |file_data|
    next if File.extname(file_data[:file_path]) == '.erb'
    begin
      line_numbers = MetricFu::LineNumbers.new(File.open(file_data[:file_path], 'r').read)
    rescue StandardError => e
      raise e unless e.message =~ /you shouldn't be able to get here/
      puts "ruby_parser blew up while trying to parse #{file_path}. You won't have method level reek information for this file."
      next
    end

    out[file_data[:file_path]] ||= {}
    file_data[:code_smells].each do |smell_data|
      line = line_numbers.start_line_for_method(smell_data[:method])
      out[file_data[:file_path]][line.to_s] ||= []
      out[file_data[:file_path]][line.to_s] << {:type => :reek,
                                                :description => "#{smell_data[:type]} - #{smell_data[:message]}"}
    end
  end
end

#reek_12? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
 
# File 'lib/generators/reek.rb', line 14

def reek_12?
  return false if @output.length == 0
  (@output =~ /^"/) != 0
end

#to_h ⇒ Object 



55
56
57
 
# File 'lib/generators/reek.rb', line 55

def to_h
  {:reek => {:matches => @matches}}
end