summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Wen <jrw2175@columbia.edu>2016-04-22 21:02:52 -0400
committerJames Wen <jrw2175@columbia.edu>2016-05-09 20:08:02 -0400
commitc3594109aada6ada2b64d3bdbb69361bb4ec4ccc (patch)
tree82dc62a95a67f269cd7ab19e605acdf75bc5290c
parent0f20a951d6056249bdbcb16a4ec9ba195237e273 (diff)
downloadbundler-c3594109aada6ada2b64d3bdbb69361bb4ec4ccc.tar.gz
Create quality check spec for leftover debugging/development mechanisms
Example mechanisms: - sleep - binding.pry - debugger - focused rspec tests via fit
-rw-r--r--spec/quality_spec.rb31
1 files changed, 31 insertions, 0 deletions
diff --git a/spec/quality_spec.rb b/spec/quality_spec.rb
index ce03839c17..043958a74d 100644
--- a/spec/quality_spec.rb
+++ b/spec/quality_spec.rb
@@ -18,6 +18,23 @@ describe "The library itself" do
"#{filename} uses inconsistent single quotes on lines #{failing_lines.join(", ")}"
end
+ def check_for_debugging_mechanisms(filename)
+ debugging_mechanisms_regex = /
+ (binding\.pry)|
+ (debugger)|
+ (sleep\s*\(?\d+)|
+ (fit\s*\(?("|\w))
+ /x
+
+ failing_lines = []
+ File.readlines(filename).each_with_index do |line, number|
+ failing_lines << number + 1 if line =~ debugging_mechanisms_regex
+ end
+
+ return if failing_lines.empty?
+ "#{filename} has debugging mechanisms (like binding.pry, sleep, debugger, rspec focusing, etc.) on lines #{failing_lines.join(", ")}"
+ end
+
def check_for_tab_characters(filename)
failing_lines = []
File.readlines(filename).each_with_index do |line, number|
@@ -97,6 +114,20 @@ describe "The library itself" do
expect(error_messages.compact).to be_well_formed
end
+ it "does not include any leftover debugging or development mechanisms" do
+ included = /spec/
+ exempt = /quality\_spec\.rb/
+ error_messages = []
+ Dir.chdir(File.expand_path("../", __FILE__)) do
+ `git ls-files -z`.split("\x0").each do |filename|
+ next unless filename =~ included
+ next if filename =~ exempt
+ error_messages << check_for_debugging_mechanisms(filename)
+ end
+ end
+ expect(error_messages.compact).to be_well_formed
+ end
+
it "maintains language quality of the documentation" do
included = /ronn/
error_messages = []