Upgrade to RSpec 3

As part of this upgrade, the following changes were made to fix some
deprecation warnings and unsupported syntax:

  * Replacement of `its` with an `it` block equivalent
  * Renaming of `failure_message_for_should` -> `failure_message` and
    similar for negated form
  * Replacing `be_true` with `== true` and `be_false` with `== false`

We've elected to keep the `should` syntax because it is convenient to do
so; we may switch entirely to `expect` at some point in the future.

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

Author: Shane da Silva

overcommit.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |s|
   s.add_dependency             'childprocess', '>= 0.5.1'
   s.add_dependency             'json', '>= 1.8' # For 1.8.7. support only
 
-  s.add_development_dependency 'rspec', '2.14.1'
+  s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'image_optim', '~> 0.13.0'
 end

spec/integration/committing_spec.rb

@@ -28,14 +28,18 @@
       `git config --local user.name ''`
     end
 
-    its(:status) { should_not be_zero }
+    it 'exits with a non-zero status' do
+      subject.status.should_not == 0
+    end
   end
 
   context 'when no hooks fail' do
     before do
       `git config --local user.name 'John Doe'`
     end
 
-    its(:status) { should be_zero }
+    it 'exits successfully' do
+      subject.status.should == 0
+    end
   end
 end

spec/integration/resolving_cherry_pick_conflict_spec.rb

@@ -37,7 +37,9 @@
     end
   end
 
-  its(:status) { should == 1 }
+  it 'exits with a non-zero status' do
+    subject.status.should_not == 0
+  end
 
   it 'does not remove the CHERRY_PICK_HEAD file' do
     subject

spec/integration/resolving_merge_conflict_spec.rb

@@ -37,8 +37,11 @@
     end
   end
 
-  its(:status) { should be_zero }
+  it 'exits successfully' do
+    subject.status.should == 0
+  end
 
-  # User should not get an error about MERGE_HEAD not existing
-  its(:stderr) { should_not include 'MERGE_HEAD'  }
+  it 'does not display an error about MERGE_HEAD missing' do
+    subject.stderr.should_not include 'MERGE_HEAD'
+  end
 end

spec/overcommit/configuration_spec.rb

@@ -93,12 +93,12 @@
     subject { config.for_hook('SomeHook', 'PreCommit') }
 
     it 'returns the subset of the config for the specified hook' do
-      subject['enabled'].should be_true
-      subject['quiet'].should be_false
+      subject['enabled'].should == true
+      subject['quiet'].should == false
     end
 
     it 'merges the the hook config with the ALL section' do
-      subject['required'].should be_false
+      subject['required'].should == false
     end
   end
 
@@ -213,22 +213,22 @@
       let(:env) { { 'SKIP' => 'AuthorName' } }
 
       it 'sets the skip option of the hook to true' do
-        subject.for_hook('AuthorName', 'PreCommit')['skip'].should be_true
+        subject.for_hook('AuthorName', 'PreCommit')['skip'].should == true
       end
 
       context 'and the hook is spelt with underscores' do
         let(:env) { { 'SKIP' => 'author_name' } }
 
         it 'sets the skip option of the hook to true' do
-          subject.for_hook('AuthorName', 'PreCommit')['skip'].should be_true
+          subject.for_hook('AuthorName', 'PreCommit')['skip'].should == true
         end
       end
 
       context 'and the hook is spelt with hyphens' do
         let(:env) { { 'SKIP' => 'author-name' } }
 
         it 'sets the skip option of the hook to true' do
-          subject.for_hook('AuthorName', 'PreCommit')['skip'].should be_true
+          subject.for_hook('AuthorName', 'PreCommit')['skip'].should == true
         end
       end
     end
@@ -237,14 +237,14 @@
       let(:env) { { 'SKIP' => 'all' } }
 
       it 'sets the skip option of the ALL section to true' do
-        subject.for_hook('ALL', 'PreCommit')['skip'].should be_true
+        subject.for_hook('ALL', 'PreCommit')['skip'].should == true
       end
 
       context 'and "all" is capitalized' do
         let(:env) { { 'SKIP' => 'ALL' } }
 
         it 'sets the skip option of the special ALL config to true' do
-          subject.for_hook('ALL', 'PreCommit')['skip'].should be_true
+          subject.for_hook('ALL', 'PreCommit')['skip'].should == true
         end
       end
     end

spec/overcommit/hook_context/post_checkout_spec.rb

@@ -28,11 +28,11 @@
     context 'when the flag is 0' do
       let(:branch_flag) { '0' }
 
-      it { should be_false }
+      it { should == false }
     end
 
     context 'when the flag is 1' do
-      it { should be_true }
+      it { should == true }
     end
   end
 
@@ -42,11 +42,11 @@
     context 'when the flag is 0' do
       let(:branch_flag) { '0' }
 
-      it { should be_true }
+      it { should == true }
     end
 
     context 'when the flag is 1' do
-      it { should be_false }
+      it { should == false }
     end
   end
 end

spec/overcommit/hook_context/pre_commit_spec.rb

@@ -146,7 +146,7 @@
 
       it 'deletes the file' do
         subject
-        File.exist?('tracked-file').should be_false
+        File.exist?('tracked-file').should == false
       end
     end
   end

spec/overcommit/hook_signer_spec.rb

@@ -44,12 +44,12 @@ def run
     end
 
     context 'when the hook code and config are the same' do
-      it { should be_false }
+      it { should == false }
 
       context 'and the user has specified they wish to skip the hook' do
         let(:modified_hook_config) { hook_config.merge('skip' => true) }
 
-        it { should be_false }
+        it { should == false }
       end
     end
 
@@ -64,13 +64,13 @@ def run
         end
       RUBY
 
-      it { should be_true }
+      it { should == true }
     end
 
     context 'when the hook config has changed' do
       let(:modified_hook_config) { { 'enabled' => true } }
 
-      it { should be_true }
+      it { should == true }
     end
   end
 end

spec/overcommit/installer_spec.rb

@@ -32,7 +32,7 @@
         context 'and Overcommit hooks were not previously installed' do
           it 'installs the master hook into the hooks directory' do
             subject
-            File.file?(File.join(hooks_dir, 'overcommit-hook')).should be_true
+            File.file?(File.join(hooks_dir, 'overcommit-hook')).should == true
           end
 
           it 'symlinks all supported hooks to the master hook' do
@@ -50,7 +50,7 @@
 
           it 'keeps the master hook' do
             expect { subject }.to_not change {
-              File.file?(File.join(hooks_dir, 'overcommit-hook')).should be_true
+              File.file?(File.join(hooks_dir, 'overcommit-hook')).should == true
             }
           end
 

spec/spec_helper.rb

@@ -19,4 +19,13 @@
   config.include GitSpecHelpers
   config.include OutputHelpers
   config.include ShellHelpers
+
+  # Continue to enable the older `should` syntax for expectations
+  config.expect_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
 end

spec/support/matchers/hook.rb

@@ -46,14 +46,14 @@ def failure_message(actual, error_message)
     check_matcher.matches?(actual)
   end
 
-  failure_message_for_should do
+  failure_message do
     check_matcher.failure_message(
       actual,
       'expected that the hook would fail'
     )
   end
 
-  failure_message_for_should_not do
+  failure_message_when_negated do
     'expected that the hook would not fail'
   end
 
@@ -67,14 +67,14 @@ def failure_message(actual, error_message)
     check_matcher.matches?(actual)
   end
 
-  failure_message_for_should do
+  failure_message do
     check_matcher.failure_message(
       actual,
       'expected that the check would pass'
     )
   end
 
-  failure_message_for_should_not do
+  failure_message_when_negated do
     'expected that the check would not pass'
   end
 
@@ -88,14 +88,14 @@ def failure_message(actual, error_message)
     check_matcher.matches?(check)
   end
 
-  failure_message_for_should do
+  failure_message do
     check_matcher.failure_message(
       actual,
       'expected that the check would report a warning'
     )
   end
 
-  failure_message_for_should_not do
+  failure_message_when_negated do
     'expected that the check would not report a warning'
   end