From c3594109aada6ada2b64d3bdbb69361bb4ec4ccc Mon Sep 17 00:00:00 2001 From: James Wen Date: Fri, 22 Apr 2016 21:02:52 -0400 Subject: Create quality check spec for leftover debugging/development mechanisms Example mechanisms: - sleep - binding.pry - debugger - focused rspec tests via fit --- spec/quality_spec.rb | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) 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 = [] -- cgit v1.2.1