Merge pull request #61 from rspec/enforce_doc_coverage_rules

Enforce doc coverage rules

Author: JonRowe

travis/script/functions.sh

@@ -57,6 +57,13 @@ function rspec_support_compatible {
   fi
 }
 
+function documentation_enforced {
+  if [ -x ./bin/yard ]; then
+    return 0
+  else
+    return 1
+  fi
+}
 
 function clone_repo {
   if [ ! -d $1 ]; then # don't clone if the dir is already there
@@ -118,3 +125,17 @@ function run_spec_suite_for {
     popd
   fi;
 }
+
+function check_documentation_coverage {
+  bin/yard stats --list-undoc | ruby -e "
+    while line = gets
+      coverage ||= line[/([\d\.]+)% documented/, 1]
+      puts line
+    end
+
+    unless Float(coverage) == 100
+      puts \"\n\nMissing documentation coverage (currently at #{coverage}%)\"
+      exit(1)
+    end
+  "
+}

travis/script/run_build

@@ -5,6 +5,10 @@ source script/functions.sh
 run_specs_and_record_done
 run_cukes
 
+if documentation_enforced; then
+  check_documentation_coverage
+fi
+
 if is_mri; then
   run_specs_one_by_one
   run_spec_suite_for "rspec-core"