Debian Codegraph @

rake_tasks/code_statistics.rb

raw
1 # From rails (http://rubyonrails.com)
2 #
3 # Improved by murphy
4 class CodeStatistics
5
6 TEST_TYPES = /\btest/i
7
8 # Create a new Code Statistic.
9 #
10 # Rakefile Example:
11 #
12 # desc 'Report code statistics (LOC) from the application'
13 # task :stats => :copy_files do
14 # require 'rake_helpers/code_statistics'
15 # CodeStatistics.new(
16 # ["Main", "lib"],
17 # ["Tests", "test"],
18 # ["Demos", "demo"]
19 # ).to_s
20 # end
21 def initialize(*pairs)
22 @pairs = pairs
23 @statistics = calculate_statistics
24 @total = if pairs.empty? then nil else calculate_total end
25 end
26
27 # Print a textual table viewing the stats
28 #
29 # Intended for console output.
30 def print
31 print_header
32 @pairs.each { |name, path| print_line name, @statistics[name] }
33 print_splitter
34
35 if @total
36 print_line 'Total', @total
37 print_splitter
38 end
39
40 print_code_test_stats
41 end
42
43 private
44
45 DEFAULT_FILE_PATTERN = /\.rb$/
46
47 def calculate_statistics
48 @pairs.inject({}) do |stats, (name, path, pattern, is_ruby_code)|
49 pattern ||= DEFAULT_FILE_PATTERN
50 path = File.join path, '*.rb'
51 stats[name] = calculate_directory_statistics path, pattern, is_ruby_code
52 stats
53 end
54 end
55
56 def calculate_directory_statistics directory, pattern = DEFAULT_FILE_PATTERN, is_ruby_code = true
57 is_ruby_code = true if is_ruby_code.nil?
58 stats = Hash.new 0
59
60 Dir[directory].each do |file_name|
61 p "Scanning #{file_name}..." if $VERBOSE
62 next unless file_name =~ pattern
63
64 lines = codelines = classes = modules = methods = 0
65 empty_lines = comment_lines = 0
66 in_comment_block = false
67
68 File.readlines(file_name).each do |line|
69 lines += 1
70 if line[/^\s*$/]
71 empty_lines += 1
72 elsif is_ruby_code
73 case line
74 when /^=end\b/
75 comment_lines += 1
76 in_comment_block = false
77 when in_comment_block
78 comment_lines += 1
79 when /^\s*class\b/
80 classes += 1
81 when /^\s*module\b/
82 modules += 1
83 when /^\s*def\b/
84 methods += 1
85 when /^\s*#/
86 comment_lines += 1
87 when /^=begin\b/
88 in_comment_block = false
89 comment_lines += 1
90 when /^__END__$/
91 in_comment_block = true
92 end
93 end
94 end
95
96 codelines = lines - comment_lines - empty_lines
97
98 stats[:lines] += lines
99 stats[:comments] += comment_lines
100 stats[:codelines] += codelines
101 stats[:classes] += classes
102 stats[:modules] += modules
103 stats[:methods] += methods
104 stats[:files] += 1
105 end
106
107 stats
108 end
109
110 def calculate_total
111 total = Hash.new 0
112 @statistics.each_value { |pair| pair.each { |k, v| total[k] += v } }
113 total
114 end
115
116 def calculate_code
117 code_loc = 0
118 @statistics.each { |k, v| code_loc += v[:codelines] unless k[TEST_TYPES] }
119 code_loc
120 end
121
122 def calculate_tests
123 test_loc = 0
124 @statistics.each { |k, v| test_loc += v[:codelines] if k[TEST_TYPES] }
125 test_loc
126 end
127
128 def print_header
129 print_splitter
130 puts "| T=Test Name | Files | Lines | LOC | Comments | Classes | Modules | Methods | M/C | LOC/M |"
131 print_splitter
132 end
133
134 def print_splitter
135 puts "+---------------------------+-------+-------+-------+----------+---------+---------+---------+-----+-------+"
136 end
137
138 def print_line name, statistics
139 m_over_c = (statistics[:methods] / (statistics[:classes] + statistics[:modules])) rescue m_over_c = 0
140 loc_over_m = (statistics[:codelines] / statistics[:methods]) - 2 rescue loc_over_m = 0
141
142 if name[TEST_TYPES]
143 name = "T #{name}"
144 else
145 name = " #{name}"
146 end
147
148 line = "| %-25s | %5d | %5d | %5d | %8d | %7d | %7d | %7d | %3d | %5d |" % (
149 [name, *statistics.values_at(:files, :lines, :codelines, :comments, :classes, :modules, :methods)] +
150 [m_over_c, loc_over_m] )
151
152 puts line
153 end
154
155 def print_code_test_stats
156 code = calculate_code
157 tests = calculate_tests
158
159 puts " Code LOC = #{code} Test LOC = #{tests} Code:Test Ratio = [1 : #{sprintf("%.2f", tests.to_f / code)}]"
160 puts ""
161 end
162
163 end
164
165 # Run a test script.
166 if $0 == __FILE__
167 $VERBOSE = true
168 CodeStatistics.new(
169 ['This dir', File.dirname(__FILE__)]
170 ).print
171 end