1
2
3
4
5
6
7
8
9
10
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
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
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
|
# frozen_string_literal: true
require "spec_helper"
if defined?(Encoding) && Encoding.default_external.name != "UTF-8"
# Poor man's ruby -E UTF-8, since it works on 1.8.7
Encoding.default_external = Encoding.find("UTF-8")
end
describe "The library itself" do
def check_for_spec_defs_with_single_quotes(filename)
failing_lines = []
File.readlines(filename).each_with_index do |line, number|
failing_lines << number + 1 if line =~ /^ *(describe|it|context) {1}'{1}/
end
return if failing_lines.empty?
"#{filename} uses inconsistent single quotes on lines #{failing_lines.join(", ")}"
end
def check_for_tab_characters(filename)
failing_lines = []
File.readlines(filename).each_with_index do |line, number|
failing_lines << number + 1 if line =~ /\t/
end
return if failing_lines.empty?
"#{filename} has tab characters on lines #{failing_lines.join(", ")}"
end
def check_for_extra_spaces(filename)
failing_lines = []
File.readlines(filename).each_with_index do |line, number|
next if line =~ /^\s+#.*\s+\n$/
next if %w(LICENCE.md).include?(line)
failing_lines << number + 1 if line =~ /\s+\n$/
end
return if failing_lines.empty?
"#{filename} has spaces on the EOL on lines #{failing_lines.join(", ")}"
end
def check_for_expendable_words(filename)
failing_line_message = []
useless_words = /\b(actually|obviously|just|clearly|basically|really)\b/i
File.readlines(filename).each_with_index do |line, number|
next unless word_found = useless_words.match(line)
failing_line_message << "#{filename} has '#{word_found}' on line #{number + 1}. Avoid using these kinds of weak modifiers."
end
failing_line_message unless failing_line_message.empty?
end
def check_for_specific_pronouns(filename)
failing_line_message = []
specific_pronouns = /\b(he|she|his|hers|him|her|himself|herself)\b/i
File.readlines(filename).each_with_index do |line, number|
next unless word_found = specific_pronouns.match(line)
failing_line_message << "#{filename} has '#{word_found}' on line #{number + 1}. Use more generic pronouns in documentation."
end
failing_line_message unless failing_line_message.empty?
end
RSpec::Matchers.define :be_well_formed do
match(&:empty?)
failure_message do |actual|
actual.join("\n")
end
end
it "has no malformed whitespace" do
exempt = /\.gitmodules|\.marshal|fixtures|vendor|ssl_certs|LICENSE/
error_messages = []
Dir.chdir(File.expand_path("../..", __FILE__)) do
`git ls-files -z`.split("\x0").each do |filename|
next if filename =~ exempt
error_messages << check_for_tab_characters(filename)
error_messages << check_for_extra_spaces(filename)
end
end
expect(error_messages.compact).to be_well_formed
end
it "uses double-quotes consistently in specs" do
included = /spec/
error_messages = []
Dir.chdir(File.expand_path("../", __FILE__)) do
`git ls-files -z`.split("\x0").each do |filename|
next unless filename =~ included
error_messages << check_for_spec_defs_with_single_quotes(filename)
end
end
expect(error_messages.compact).to be_well_formed
end
it "maintains language quality of the documentation" do
included = /ronn/
error_messages = []
Dir.chdir(File.expand_path("../../man", __FILE__)) do
`git ls-files -z`.split("\x0").each do |filename|
next unless filename =~ included
error_messages << check_for_expendable_words(filename)
error_messages << check_for_specific_pronouns(filename)
end
end
expect(error_messages.compact).to be_well_formed
end
it "can still be built" do
Dir.chdir(root) do
`gem build bundler.gemspec`
expect($?).to eq(0)
# clean up the .gem generated
system("rm bundler-#{Bundler::VERSION}.gem")
end
end
it "does not contain any warnings" do
Dir.chdir(root.join("lib")) do
exclusions = %w(
bundler/capistrano.rb
bundler/gem_tasks.rb
bundler/vlad.rb
)
lib_files = `git ls-files -z`.split("\x0").grep(/\.rb$/) - exclusions
lib_files.reject! {|f| f.start_with?("bundler/vendor") }
lib_files.map! {|f| f.chomp(".rb") }
sys_exec("ruby -w -I. ", :expect_err) do |input|
lib_files.each do |f|
input.puts "require '#{f}'"
end
end
expect(@err.split("\n")).to be_well_formed
expect(@out.split("\n")).to be_well_formed
end
end
end
|
