Class: SimpleCov::Formatter::PHPUnit

Inherits:
SimpleFormatter
  • Object
show all
Defined in:
lib/simplecov-phpunit/simplecov-phpunit.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PHPUnit

Returns a new instance of PHPUnit.



11
12
13
14
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
 
# File 'lib/simplecov-phpunit/simplecov-phpunit.rb', line 11

def initialize
	super()
	
	@base_dir_path = Dir.pwd
	@coverage_dir_path = File.expand_path('coverage', @base_dir_path)
	assets_dst_path = File.expand_path('_assets', @coverage_dir_path)
	
	@ruby_version_html = %(<a href="https://www.ruby-lang.org/en/">Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}</a>)
	
	@simplecov_version_html = %(<a href="https://github.com/colszowka/simplecov">SimpleCov</a>)
	simplecov_gem = Gem::Specification.find_by_name('simplecov')
	if simplecov_gem
		@simplecov_version_html = %(<a href="https://github.com/colszowka/simplecov">SimpleCov #{simplecov_gem.version}</a>)
	end
	
	@simplecov_phpunit_version_html = %(<a href="https://github.com/TheFox/simplecov-phpunit">SimpleCov PHPUnit Formatter</a>)
	simplecov_phpunit_gem = Gem::Specification.find_by_name('simplecov-phpunit')
	if simplecov_phpunit_gem
		@simplecov_phpunit_version_html = %(<a href="https://github.com/TheFox/simplecov-phpunit">SimpleCov PHPUnit Formatter #{simplecov_phpunit_gem.version}</a>)
		
		assets_src_path = File.expand_path('assets', simplecov_phpunit_gem.full_gem_path)
		FileUtils.rm_rf(assets_dst_path)
		FileUtils.cp_r(assets_src_path, assets_dst_path)
	end
	
	@bootstrap_css_html = %(<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">)
	
	@style_css_href = '_assets/style.css'
	@style_css_html = %(<link href="#{@style_css_href}" rel="stylesheet" />)
	
	@jquery_js_html = %(<script src="https://code.jquery.com/jquery-1.12.4.min.js" crossorigin="anonymous"></script>)
	
	@bootstrap_js_html = %(<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>)
end

Instance Method Details

#format(result) ⇒ Object 



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/simplecov-phpunit/simplecov-phpunit.rb', line 46

def format(result)
	puts
	puts "write coverage for '#{@base_dir_path}'"
	
	total_status = status_by_percent(result.files.covered_percent)
	total_percent_f = '%.2f' % result.files.covered_percent
	
	index_html = ''
	index_html << <<-EOHTML
		<!DOCTYPE html>
		<html lang="en">
			<head>
				<meta charset="UTF-8" />
				<meta name="viewport" content="width=device-width, initial-scale=1.0" />
				
				<title>Code Coverage for #{@base_dir_path}</title>
				
				#{@bootstrap_css_html}
				#{@style_css_html}
				
			</head>
			<div class="container">
				<table class="table table-bordered">
					<thead>
						<tr>
							<td>&nbsp;</td>
							<td colspan="3"><div align="center"><strong>Code Coverage</strong></div></td>
						</tr>
						<tr>
							<td>&nbsp;</td>
							<td colspan="3"><div align="center"><strong>Lines</strong></div></td>
						</tr>
					</thead>
					<tr>
						<td class="#{total_status}">Total</td>
						<td class="#{total_status} big">
							<div class="progress">
								<div class="progress-bar progress-bar-#{total_status}" role="progressbar" aria-valuenow="#{total_percent_f}" aria-valuemin="0" aria-valuemax="100" style="width: #{total_percent_f}%">
									<span class="sr-only">#{total_percent_f}% covered (#{total_status})</span>
								</div>
							</div>
						</td>
						<td class="#{total_status} small"><div align="right">#{total_percent_f}%</div></td>
						<td class="#{total_status} small"><div align="right">#{result.files.covered_lines}&nbsp;/&nbsp;#{result.files.lines_of_code}</div></td>
					</tr>
		EOHTML
	
	result.files.each do |file|
		relative_file_path = file.filename[@base_dir_path.size.next..-1]
		# file_name = File.basename(file.filename)
		html_file_path =
			relative_file_path
			.split('/')
			.join('_') + '.html'
		
		puts "write coverage '#{relative_file_path}'"
		
		file_status = status_by_percent(file.covered_percent)
		file_percent_f = '%.2f' % file.covered_percent
		
		index_html << <<-EOHTML
			<tr>
				<td class="#{file_status}"><span class="glyphicon glyphicon-file"></span> <a href="#{html_file_path}">#{relative_file_path}</a></td>
				<td class="#{file_status} big">
					<div class="progress">
						<div class="progress-bar progress-bar-#{file_status}" role="progressbar" aria-valuenow="100.00" aria-valuemin="0" aria-valuemax="100" style="width: #{file_percent_f}%">
							<span class="sr-only">#{file_percent_f}% covered (#{file_status})</span>
						</div>
					</div>
				</td>
				<td class="#{file_status} small"><div align="right">#{file_percent_f}%</div></td>
				<td class="#{file_status} small"><div align="right">#{file.covered_lines.count}&nbsp;/&nbsp;#{file.lines_of_code}</div></td>
			</tr>
			EOHTML
		
		html = ''
		html << <<-EOHTML
			<!DOCTYPE html>
			<html lang="en">
				<head>
					<meta charset="UTF-8" />
					<meta name="viewport" content="width=device-width, initial-scale=1.0" />
					
					<title>Code Coverage for #{file.filename}</title>
					
					#{@bootstrap_css_html}
					#{@style_css_html}
					
				</head>
				<body>
					<header>
						<div class="container">
							<div class="row">
								<div class="col-md-12">
									<ol class="breadcrumb">
										<li><a href="index.html">#{@base_dir_path}</a></li>
										<li class="active">#{relative_file_path}</li>
									</ol>
								</div>
							</div>
						</div>
					</header>
					<div class="container">
						<table class="table table-bordered">
							<thead>
								<tr>
									<td>&nbsp;</td>
									<td colspan="3"><div align="center"><strong>Code Coverage</strong></div></td>
								</tr>
								<tr>
									<td>&nbsp;</td>
									<td colspan="3"><div align="center"><strong>Lines</strong></div></td>
								</tr>
							</thead>
							<tbody>
								<tr>
									<td class="#{file_status}">Covered</td>
									<td class="#{file_status} big">
										<div class="progress">
											<div class="progress-bar progress-bar-#{file_status}" role="progressbar" aria-valuenow="#{file_percent_f}" aria-valuemin="0" aria-valuemax="100" style="width: #{file_percent_f}%">
												<span class="sr-only">#{file_percent_f}% covered (#{file_status})</span>
											</div>
										</div>
									</td>
									<td class="#{file_status} small"><div align="right">#{file_percent_f}%</div></td>
									<td class="#{file_status} small"><div align="right">#{file.covered_lines.count}&nbsp;/&nbsp;#{file.lines_of_code}</div></td>
								</tr>
							</tbody>
						</table>
						<table id="code" class="table table-borderless table-condensed">
							<tbody>
			EOHTML
		
		file.lines.each do |line|
			# puts "  line #{line.line_number} #{line.coverage} #{line.status} #{line.src}"
			
			line_coverage = line.coverage ? line.coverage : ''
			line_src = CGI.escapeHTML(line.src.chomp)
			
			html << %(<tr)
			
			if line.covered?
				html << %( class="covered-by-large-tests")
			elsif line.missed?
				html << %( class="danger")
			elsif line.skipped?
				html << %( class="warning")
			end
			
			html << %(><td><div align="right"><a name="#{line.line_number}"></a><a href="##{line.line_number}">#{line.line_number}</a></div></td><td><div align="left">#{line_coverage}</div></td><td class="codeLine"><span class="default">#{line_src}</span></td></tr>)
		end
		
		html << <<-EOHTML
							</tbody>
						</table>
						<footer>
							<hr/>
							<h4>Legend</h4>
							<p>
							<span class="success"><strong>Executed</strong></span>
							<span class="danger"><strong>Not Executed</strong></span>
							<span class="warning"><strong>Skipped Code</strong></span>
							</p>
							<p>
							<small>Generated by #{@simplecov_phpunit_version_html} using #{@ruby_version_html} and #{@simplecov_version_html} at #{result.created_at.strftime('%F %T %z')}.</small>
							</p>
						</footer>
					</div>

					#{@jquery_js_html}
					#{@bootstrap_js_html}
					
				</body>
			</html>
			EOHTML
		
		html_file = File.open("#{@coverage_dir_path}/#{html_file_path}", 'wb')
		html_file.write(html.gsub(/^\t{6}/, ''))
		html_file.close
	end
	
	index_html << <<-EOHTML
				</table>
				<footer>
					<hr/>
					<h4>Legend</h4>
					<p>
						<span class="danger"><strong>Low</strong>: 0% to 49%</span>
						<span class="warning"><strong>Medium</strong>: 50% to 89%</span>
						<span class="success"><strong>High</strong>: 90% to 100%</span>
					</p>
					<p>
						<small>Generated by #{@simplecov_phpunit_version_html} using #{@ruby_version_html} and #{@simplecov_version_html} at #{result.created_at.strftime('%F %T %z')}.</small>
					</p>
				</footer>
			</div>
			
			#{@jquery_js_html}
			#{@bootstrap_js_html}
			
		</html>
		EOHTML
	
	index_html_file = File.open(File.expand_path('index.html', @coverage_dir_path), 'wb')
	index_html_file.write(index_html.gsub(/^\t{5}/, ''))
	index_html_file.close
	
	puts 'done'
	puts
end