Rename include_branch_deletions to include_remote_ref_deletions

Upon further reflection, this API is not about remote branches, but
remote refs. Change its name to reflect that.

Author: sds

CHANGELOG.md

@@ -8,8 +8,9 @@
 * Add `GoFmt` pre-commit hook
 * Add `exclude_branches` hook option to disable hooks running on specific branches
 * Add `exclude_remotes` pre-push hook option to disable pre-push hooks running against specific remotes
-* Change default behavior of pre-push hooks to **not** run against deleted remote branches
-* Add `include_branch_deletions` pre-push hook option to allow running for a remote branch deletion
+* Change default behavior of pre-push hooks to **not** run against deleted remote refs
+* Add `include_remote_ref_deletions` pre-push hook option to allow running for a remote branch deletion
+* Rename `remote_branch_deletion?` pre-push hook helper to `remote_ref_deletion?`
 
 ## 0.51.0
 

README.md

@@ -228,7 +228,7 @@ Option                                  | Description
 `exclude`                               | File paths or glob patterns of files that do not apply to this hook. This is used to exclude any files that would have been matched by `include`.
 `exclude_branches`                      | List of branch names or glob patterns of branches that this hook should not run against.
 `exclude_remotes`                       | *`PrePush` hooks only.* List of remote names that the hook should not run against.
-`include_branch_deletions`              | *`PrePush` hooks only.* By default, `PrePush` hooks will **not** run for pushes that delete a remote branch. Set to `true` to have the hook run even for deleted remote branches.
+`include_remote_ref_deletions`          | *`PrePush` hooks only.* By default, `PrePush` hooks will **not** run for pushes that delete a remote ref (i.e. branches or tags). Set to `true` to have the hook run even for deleted remote ref.
 `problem_on_unmodified_line`            | How to treat errors reported on lines that weren't modified during the action captured by this hook (e.g. for pre-commit hooks, warnings/errors reported on lines that were not staged with `git add` may not be warnings/errors you care about). Valid values are `report`: report errors/warnings as-is regardless of line location (default); `warn`: report errors as warnings if they are on lines you didn't modify; and `ignore`: don't display errors/warnings at all if they are on lines you didn't modify (`ignore` is _not_ recommended).
 `on_fail`                               | Change the status of a failed hook to `warn` or `pass`. This allows you to treat failures as warnings or potentially ignore them entirely, but you should use caution when doing so as you might be hiding important information.
 `on_warn`                               | Similar to `on_fail`, change the status of a hook that returns a warning status to either `pass` (you wish to silence warnings entirely) or `fail` (you wish to treat all warnings as errors).

lib/overcommit/hook/pre_push/base.rb

@@ -12,7 +12,7 @@ class Base < Overcommit::Hook::Base
     def run?
       super &&
         !exclude_remotes.include?(remote_name) &&
-        (include_branch_deletions? || !@context.remote_branch_deletion?)
+        (include_remote_ref_deletions? || !@context.remote_ref_deletion?)
     end
 
     private
@@ -21,8 +21,8 @@ def exclude_remotes
       @config['exclude_remotes'] || []
     end
 
-    def include_branch_deletions?
-      @config['include_branch_deletions']
+    def include_remote_ref_deletions?
+      @config['include_remote_ref_deletions']
     end
   end
 end

lib/overcommit/hook_context/pre_push.rb

@@ -13,13 +13,13 @@ def remote_url
       @args[1]
     end
 
-    def remote_branch_deletion?
-      return @remote_branch_deletion if defined? @remote_branch_deletion
+    def remote_ref_deletion?
+      return @remote_ref_deletion if defined?(@remote_ref_deletion)
 
-      @remote_branch_deletion ||= input_lines.
-                                  first.
-                                  split(' ').
-                                  first == '(deleted)'
+      @remote_ref_deletion ||= input_lines.
+                               first.
+                               split(' ').
+                               first == '(deleted)'
     end
 
     def pushed_refs

spec/overcommit/hook/pre_push/base_spec.rb

@@ -4,7 +4,7 @@
 
 describe Overcommit::Hook::PrePush::Base do
   let(:remote_name) { 'origin' }
-  let(:remote_branch_deletion?) { false }
+  let(:remote_ref_deletion?) { false }
   let(:config) { double('config') }
   let(:context) { double('context') }
   let(:hook) { described_class.new(config, context) }
@@ -14,7 +14,7 @@
 
     before do
       allow(context).to receive(:remote_name).and_return(remote_name)
-      allow(context).to receive(:remote_branch_deletion?).and_return(remote_branch_deletion?)
+      allow(context).to receive(:remote_ref_deletion?).and_return(remote_ref_deletion?)
       allow(config).to receive(:for_hook).and_return(hook_config)
     end
 
@@ -44,52 +44,52 @@
       end
     end
 
-    context 'with include_branch_deletions specified' do
+    context 'with include_remote_ref_deletions specified' do
       let(:hook_config) do
-        { 'include_branch_deletions' => include_branch_deletions }
+        { 'include_remote_ref_deletions' => include_remote_ref_deletions }
       end
-      let(:remote_branch_deletion?) { false }
-      let(:include_branch_deletions) { false }
+      let(:remote_ref_deletion?) { false }
+      let(:include_remote_ref_deletions) { false }
 
       context 'when remote branch is not being deleted' do
-        let(:remote_branch_deletion?) { false }
+        let(:remote_ref_deletion?) { false }
 
-        context 'when include_branch_deletions is not specified' do
-          let(:include_branch_deletions) { nil }
+        context 'when include_remote_ref_deletions is not specified' do
+          let(:include_remote_ref_deletions) { nil }
 
           it { subject.should == true }
         end
 
-        context 'when include_branch_deletions is false' do
-          let(:include_branch_deletions) { false }
+        context 'when include_remote_ref_deletions is false' do
+          let(:include_remote_ref_deletions) { false }
 
           it { subject.should == true }
         end
 
-        context 'when include_branch_deletions is true' do
-          let(:include_branch_deletions) { true }
+        context 'when include_remote_ref_deletions is true' do
+          let(:include_remote_ref_deletions) { true }
 
           it { subject.should == true }
         end
       end
 
       context 'when remote branch is being deleted' do
-        let(:remote_branch_deletion?) { true }
+        let(:remote_ref_deletion?) { true }
 
-        context 'when include_branch_deletions is not specified' do
-          let(:include_branch_deletions) { nil }
+        context 'when include_remote_ref_deletions is not specified' do
+          let(:include_remote_ref_deletions) { nil }
 
           it { subject.should == false }
         end
 
-        context 'when include_branch_deletions is false' do
-          let(:include_branch_deletions) { false }
+        context 'when include_remote_ref_deletions is false' do
+          let(:include_remote_ref_deletions) { false }
 
           it { subject.should == false }
         end
 
-        context 'when include_branch_deletions is true' do
-          let(:include_branch_deletions) { true }
+        context 'when include_remote_ref_deletions is true' do
+          let(:include_remote_ref_deletions) { true }
 
           it { subject.should == true }
         end

spec/overcommit/hook_context/pre_push_spec.rb

@@ -23,8 +23,8 @@
     it { should == remote_url }
   end
 
-  describe '#remote_branch_deletion?' do
-    subject { context.remote_branch_deletion? }
+  describe '#remote_ref_deletion?' do
+    subject { context.remote_ref_deletion? }
 
     before do
       input.stub(:read).and_return("#{local_ref} #{local_sha1} #{remote_ref} #{remote_sha1}\n")
@@ -70,7 +70,7 @@
       input.stub(:read).and_return("#{local_ref} #{local_sha1} #{remote_ref} #{remote_sha1}\n")
     end
 
-    it 'should parse commit info from the input' do
+    it 'parses commit info from the input' do
       pushed_refs.length.should == 1
       pushed_refs.each do |pushed_ref|
         pushed_ref.local_ref.should == local_ref