Better handling of missing READMEs.

cc @celeduc

lib/cane/doc_check.rb

@@ -63,18 +63,7 @@ def missing_file_violations
       result = []
       return result if opts[:no_readme]
 
-      filenames = ['README', 'readme']
-      extensions = [''] + %w(
-        .markdown
-        .md
-        .mdown
-        .rdoc
-        .textile
-        .txt
-      )
-      combinations = filenames.product(extensions)
-
-      if combinations.none? {|n, x| Cane::File.exists?(n + x) }
+      if Cane::File.case_insensitive_glob("README*").none?
         result << { description: 'Missing documentation',
                     label: 'No README found' }
       end

lib/cane/file.rb

@@ -21,6 +21,10 @@ def open(path)
       def exists?(path)
         ::File.exists?(path)
       end
+
+      def case_insensitive_glob(glob)
+        Dir.glob(glob, ::File::FNM_CASEFOLD)
+      end
     end
   end
 end

spec/doc_check_spec.rb

@@ -57,20 +57,7 @@ class Doc; end
   it 'creates a violation for missing README' do
     file = fire_replaced_class_double("Cane::File")
     stub_const("Cane::File", file)
-    file.should_receive(:exists?).with("README").and_return(false)
-    file.should_receive(:exists?).with("README.md").and_return(false)
-    file.should_receive(:exists?).with("README.mdown").and_return(false)
-    file.should_receive(:exists?).with("README.markdown").and_return(false)
-    file.should_receive(:exists?).with("README.textile").and_return(false)
-    file.should_receive(:exists?).with("README.txt").and_return(false)
-    file.should_receive(:exists?).with("README.rdoc").and_return(false)
-    file.should_receive(:exists?).with("readme").and_return(false)
-    file.should_receive(:exists?).with("readme.md").and_return(false)
-    file.should_receive(:exists?).with("readme.mdown").and_return(false)
-    file.should_receive(:exists?).with("readme.markdown").and_return(false)
-    file.should_receive(:exists?).with("readme.textile").and_return(false)
-    file.should_receive(:exists?).with("readme.txt").and_return(false)
-    file.should_receive(:exists?).with("readme.rdoc").and_return(false)
+    file.should_receive(:case_insensitive_glob).with("README*").and_return([])
 
     violations = check("").violations
     violations.length.should == 1
@@ -80,6 +67,18 @@ class Doc; end
     ]
   end
 
+  it 'does not create a violation when readme exists' do
+    file = fire_replaced_class_double("Cane::File")
+    stub_const("Cane::File", file)
+    file
+      .should_receive(:case_insensitive_glob)
+      .with("README*")
+      .and_return(%w(readme.md))
+
+    violations = check("").violations
+    violations.length.should == 0
+  end
+
   it 'skips declared exclusions' do
     file_name = make_file <<-FILE.gsub /^\s{6}/, ''
       class NeedsDocumentation

spec/file_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'tmpdir'
+
+require 'cane/file'
+
+describe Cane::File do
+  describe '.case_insensitive_glob' do
+    it 'matches all kinds of readmes' do
+      expected = %w(
+        README
+        readme.md
+        ReaDME.TEXTILE
+      )
+
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          expected.each do |x|
+            FileUtils.touch(x)
+          end
+          Cane::File.case_insensitive_glob("README*").should == expected
+        end
+      end
+    end
+  end
+end