Split Whitespace check into HardTabs and TrailingWhitespace

This will make the check more specific, and give users greater control
over which checks they can disable.

Change-Id: I4b9353e26f8dcf8b4c07376aaf3c86a8f33932e1
Reviewed-on: http://gerrit.causes.com/35606
Reviewed-by: Shane da Silva <shane@causes.com>
Tested-by: Shane da Silva <shane@causes.com>

Author: sds

config/default.yml

@@ -58,6 +58,9 @@ PreCommit:
     description: 'Analyzing with haml-lint'
     include: '**/*.haml'
 
+  HardTabs:
+    description: 'Checking for hard tabs'
+
   ImageOptim:
     description: 'Checking for optimizable images'
     include:
@@ -87,8 +90,8 @@ PreCommit:
     description: 'Analyzing with scss-lint'
     include: '**/*.scss'
 
-  Whitespace:
-    description: 'Checking for invalid whitespace'
+  TrailingWhitespace:
+    description: 'Checking for trailing whitespace'
 
   YamlSyntax:
     description: 'Checking YAML syntax'

lib/overcommit/hook/pre_commit/hard_tabs.rb

@@ -0,0 +1,16 @@
+module Overcommit::Hook::PreCommit
+  # Checks for hard tabs in files.
+  class HardTabs < Base
+    def run
+      paths = applicable_files.join(' ')
+
+      # Catches hard tabs
+      result = command("grep -IHn \"\\t\" #{paths}")
+      unless result.stdout.empty?
+        return :bad, "Hard tabs detected:\n#{result.stdout}"
+      end
+
+      :good
+    end
+  end
+end

lib/overcommit/hook/pre_commit/trailing_whitespace.rb

@@ -0,0 +1,15 @@
+module Overcommit::Hook::PreCommit
+  # Checks for trailing whitespace in files.
+  class TrailingWhitespace < Base
+    def run
+      paths = applicable_files.join(' ')
+
+      result = command("grep -IHn \"\\s$\" #{paths}")
+      unless result.stdout.empty?
+        return :bad, "Trailing whitespace detected:\n#{result.stdout}"
+      end
+
+      :good
+    end
+  end
+end

lib/overcommit/hook/pre_commit/whitespace.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Overcommit::Hook::PreCommit::HardTabs do
+  let(:config)  { Overcommit::ConfigurationLoader.default_configuration }
+  let(:context) { double('context') }
+  subject { described_class.new(config, context) }
+  let(:staged_file) { 'filename.txt' }
+
+  before do
+    subject.stub(:applicable_files).and_return([staged_file])
+  end
+
+  around do |example|
+    repo do
+      File.open(staged_file, 'w') { |f| f.write(contents) }
+      `git add #{staged_file}`
+      example.run
+    end
+  end
+
+  context 'when file contains hard tabs' do
+    let(:contents) { "Some\thard\ttabs" }
+
+    it { should fail_check }
+  end
+
+  context 'when file has no hard tabs' do
+    let(:contents) { 'Just some text' }
+
+    it { should pass }
+  end
+end

spec/overcommit/hook/pre_commit/hard_tabs_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Overcommit::Hook::PreCommit::Whitespace do
+describe Overcommit::Hook::PreCommit::TrailingWhitespace do
   let(:config)  { Overcommit::ConfigurationLoader.default_configuration }
   let(:context) { double('context') }
   subject { described_class.new(config, context) }
@@ -18,14 +18,14 @@
     end
   end
 
-  context 'when file contains hard tabs' do
-    let(:contents) { "Some\thard\ttabs" }
+  context 'when file contains trailing whitespace' do
+    let(:contents) { 'Some trailing whitespace   ' }
 
     it { should fail_check }
   end
 
-  context 'when file contains trailing whitespace' do
-    let(:contents) { 'Some trailing whitespace   ' }
+  context 'when file contains trailing tabs' do
+    let(:contents) { "Some trailing tabs\t\t" }
 
     it { should fail_check }
   end