overcommit 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 043d9e4f69b46108c0de597ecf9640f31149c98e
-  data.tar.gz: 9b61ce0b7846dae6580ec4d8934b4f2ec6484eab
+  metadata.gz: 9e7a230157adc2af8bc8cf4b209e6b50d99d67a7
+  data.tar.gz: 190432fe93e3a69293a69b93bbd75460923f72b1
 SHA512:
-  metadata.gz: c4f4dc8af420e79565d242caf90eb37148fe7cbc4f1cd015627a4f8863a16f8237da519ed738c7620dff9c35b0a6f86614e5fae0923f0a4f1cb2c3f9f1fc2876
-  data.tar.gz: e1fd1a72991e8e708503cf870c68f333c4321eab536e010bc80eb2cff2b1f116c10f8710a540697d3d4ecd202e3e16e4a326ab8f37ede4762d800323c5d8af71
+  metadata.gz: 4e98e7cbe0771bb681380819fc688d27c06b6106ebb884d8bbd71ef132a77916eacf8d4fe42b997e6d70edc868436c47a7a437215258d091e337fe2474b9d001
+  data.tar.gz: 8481d1109df9d34d2d6306fbfb56db74e20a002444d91775aba9d5553a3e149cb37b9a0dbfacd33868f7a328fcb1a55f5371fc3f22075e15da679329e7b1b37c

data/config/default.yml

@@ -21,12 +21,6 @@ PostCheckout:
   ALL:
     required: false
     quiet: false
-  BundleCheck:
-    description: 'Checking Gemfile dependencies'
-    include:
-      - 'Gemfile'
-      - 'Gemfile.lock'
-      - '*.gemspec'
   IndexTags:
     description: 'Generating tags file from source'
     enabled: false

data/lib/overcommit/exceptions.rb

@@ -8,6 +8,9 @@ module Overcommit::Exceptions
   # Raised when a {HookContext} is unable to setup the environment before a run.
   class HookSetupFailed < StandardError; end
 
+  # Raised when a {HookContext} is unable to clean the environment after a run.
+  class HookCleanupFailed < StandardError; end
+
   # Raised when a hook run was cancelled by the user.
   class HookCancelled < StandardError; end
 

data/lib/overcommit/hook_context/pre_commit.rb

@@ -42,11 +42,11 @@ module Overcommit::HookContext
     # as if nothing ever changed.
     def cleanup_environment
       unless initial_commit? || (@stash_attempted && !@changes_stashed)
-        `git reset --hard &> /dev/null` # Ensure working tree is clean before popping stash
+        clear_working_tree # Ensure working tree is clean before restoring it
       end
 
       if @changes_stashed
-        `git stash pop --index --quiet`
+        restore_working_tree
       end
 
       Overcommit::GitRepo.restore_merge_state
@@ -69,6 +69,26 @@ module Overcommit::HookContext
 
   private
 
+    # Clears the working tree so that the stash can be applied.
+    def clear_working_tree
+      result = Overcommit::Utils.execute(%w[git reset --hard])
+      unless result.success?
+        raise Overcommit::Exceptions::HookCleanupFailed,
+              "Unable to cleanup working tree after #{hook_script_name} hooks run:" \
+              "\n#{result.stderr}"
+      end
+    end
+
+    # Applies the stash to the working tree to restore the user's state.
+    def restore_working_tree
+      result = Overcommit::Utils.execute(%w[git stash pop --index --quiet])
+      unless result.success?
+        raise Overcommit::Exceptions::HookCleanupFailed,
+              "Unable to restore working tree after #{hook_script_name} hooks run:" \
+              "\n#{result.stderr}"
+      end
+    end
+
     # Returns whether there are any changes to the working tree, staged or
     # otherwise.
     def any_changes?

data/lib/overcommit/hook_runner.rb

@@ -17,13 +17,18 @@ module Overcommit
 
     # Loads and runs the hooks registered for this {HookRunner}.
     def run
+      # ASSUMPTION: we assume the setup and cleanup calls will never need to be
+      # interrupted, i.e. they will finish quickly. Should further evidence
+      # suggest this assumption does not hold, we will have to separately wrap
+      # these calls to allow some sort of "are you sure?" double-interrupt
+      # functionality, but until that's deemed necessary let's keep it simple.
       InterruptHandler.isolate_from_interrupts do
         @context.setup_environment
         load_hooks
-        run_hooks
+        result = run_hooks
+        @context.cleanup_environment
+        result
       end
-    ensure
-      @context.cleanup_environment
     end
 
   private
@@ -63,20 +68,23 @@ module Overcommit
 
       @printer.start_hook(hook)
 
+      status, output = nil, nil
+
       begin
         # Disable the interrupt handler during individual hook run so that
         # Ctrl-C actually stops the current hook from being run, but doesn't
         # halt the entire process.
-        InterruptHandler.disable!
-        status, output = hook.run_and_transform
+        InterruptHandler.disable_until_finished_or_interrupted do
+          status, output = hook.run_and_transform
+        end
       rescue => ex
         status = :fail
         output = "Hook raised unexpected error\n#{ex.message}"
       rescue Interrupt
+        # At this point, interrupt has been handled and protection is back in
+        # effect thanks to the InterruptHandler.
         status = :interrupt
         output = 'Hook was interrupted by Ctrl-C; restoring repo state...'
-      ensure
-        InterruptHandler.enable!
       end
 
       @printer.end_hook(hook, status, output)

data/lib/overcommit/interrupt_handler.rb

@@ -5,22 +5,65 @@ require 'singleton'
 class InterruptHandler
   include Singleton
 
-  attr_accessor :isolate_signals, :signal_received
+  attr_accessor :isolate_signals, :signal_received, :reenable_on_interrupt
 
   def initialize
     self.isolate_signals = false
     self.signal_received = false
+    self.reenable_on_interrupt = false
 
     Signal.trap('INT') do
       if isolate_signals
         self.signal_received = true
       else
-        raise Interrupt
+        if reenable_on_interrupt
+          self.reenable_on_interrupt = false
+          self.isolate_signals = true
+        end
+
+        raise Interrupt # Allow interrupt to propagate to code
       end
     end
   end
 
   class << self
+    # Provide a way to allow a single Ctrl-C interrupt to happen and atomically
+    # re-enable interrupt protections once that interrupt is propagated.
+    #
+    # This prevents a race condition where code like the following:
+    #
+    #  begin
+    #    InterruptHandler.disable!
+    #    ... do stuff ...
+    #  rescue Interrupt
+    #    ... handle it ...
+    #  ensure
+    #    InterruptHandler.enable!
+    #  end
+    #
+    # ...could have the `enable!` call to the interrupt handler not called in
+    # the event another interrupt was received in between the interrupt being
+    # handled and the `ensure` block being entered.
+    #
+    # Thus you should always write:
+    #
+    #  begin
+    #    InterruptHandler.disable_until_finished_or_interrupted do
+    #      ... do stuff ...
+    #    end
+    #  rescue Interrupt
+    #    ... handle it ...
+    #  rescue
+    #    ... handle any other exceptions ...
+    #  end
+    def disable_until_finished_or_interrupted
+      instance.reenable_on_interrupt = true
+      instance.isolate_signals = false
+      yield
+    ensure
+      instance.isolate_signals = true
+    end
+
     def disable!
       instance.isolate_signals = false
     end

data/lib/overcommit/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/template-dir/hooks/commit-msg

@@ -4,6 +4,14 @@
 # in all of your git hooks being symlinked to this file, allowing the framework
 # to manage your hooks for you.
 
+# Prevent a Ruby stack trace from appearing when we interrupt the hook.
+# Note that this will be overridden when Overcommit is loaded, since the
+# InterruptHandler will redefine the trap at that time.
+Signal.trap('INT') do
+  puts 'Hook run interrupted'
+  exit 130
+end
+
 # Required for Ruby 1.8 compatibility (for older OSX versions)
 if RUBY_VERSION.split('.')[0..1] == %w[1 8]
   require 'rubygems'
@@ -78,12 +86,13 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
-rescue Overcommit::Exceptions::HookSetupFailed => error
-  puts error
+rescue Overcommit::Exceptions::HookSetupFailed,
+       Overcommit::Exceptions::HookCleanupFailed => error
+  puts error.message
   exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
-  exit 1
+  exit 130 # Ctrl-C cancel
 rescue Overcommit::Exceptions::InvalidGitRepo => error
   puts error
   exit 64 # EX_USAGE

data/template-dir/hooks/overcommit-hook

@@ -4,6 +4,14 @@
 # in all of your git hooks being symlinked to this file, allowing the framework
 # to manage your hooks for you.
 
+# Prevent a Ruby stack trace from appearing when we interrupt the hook.
+# Note that this will be overridden when Overcommit is loaded, since the
+# InterruptHandler will redefine the trap at that time.
+Signal.trap('INT') do
+  puts 'Hook run interrupted'
+  exit 130
+end
+
 # Required for Ruby 1.8 compatibility (for older OSX versions)
 if RUBY_VERSION.split('.')[0..1] == %w[1 8]
   require 'rubygems'
@@ -78,12 +86,13 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
-rescue Overcommit::Exceptions::HookSetupFailed => error
-  puts error
+rescue Overcommit::Exceptions::HookSetupFailed,
+       Overcommit::Exceptions::HookCleanupFailed => error
+  puts error.message
   exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
-  exit 1
+  exit 130 # Ctrl-C cancel
 rescue Overcommit::Exceptions::InvalidGitRepo => error
   puts error
   exit 64 # EX_USAGE

data/template-dir/hooks/post-checkout

@@ -4,6 +4,14 @@
 # in all of your git hooks being symlinked to this file, allowing the framework
 # to manage your hooks for you.
 
+# Prevent a Ruby stack trace from appearing when we interrupt the hook.
+# Note that this will be overridden when Overcommit is loaded, since the
+# InterruptHandler will redefine the trap at that time.
+Signal.trap('INT') do
+  puts 'Hook run interrupted'
+  exit 130
+end
+
 # Required for Ruby 1.8 compatibility (for older OSX versions)
 if RUBY_VERSION.split('.')[0..1] == %w[1 8]
   require 'rubygems'
@@ -78,12 +86,13 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
-rescue Overcommit::Exceptions::HookSetupFailed => error
-  puts error
+rescue Overcommit::Exceptions::HookSetupFailed,
+       Overcommit::Exceptions::HookCleanupFailed => error
+  puts error.message
   exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
-  exit 1
+  exit 130 # Ctrl-C cancel
 rescue Overcommit::Exceptions::InvalidGitRepo => error
   puts error
   exit 64 # EX_USAGE

data/template-dir/hooks/pre-commit

@@ -4,6 +4,14 @@
 # in all of your git hooks being symlinked to this file, allowing the framework
 # to manage your hooks for you.
 
+# Prevent a Ruby stack trace from appearing when we interrupt the hook.
+# Note that this will be overridden when Overcommit is loaded, since the
+# InterruptHandler will redefine the trap at that time.
+Signal.trap('INT') do
+  puts 'Hook run interrupted'
+  exit 130
+end
+
 # Required for Ruby 1.8 compatibility (for older OSX versions)
 if RUBY_VERSION.split('.')[0..1] == %w[1 8]
   require 'rubygems'
@@ -78,12 +86,13 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
-rescue Overcommit::Exceptions::HookSetupFailed => error
-  puts error
+rescue Overcommit::Exceptions::HookSetupFailed,
+       Overcommit::Exceptions::HookCleanupFailed => error
+  puts error.message
   exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
-  exit 1
+  exit 130 # Ctrl-C cancel
 rescue Overcommit::Exceptions::InvalidGitRepo => error
   puts error
   exit 64 # EX_USAGE

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -94,7 +94,6 @@ files:
 - lib/overcommit/hook/commit_msg/hard_tabs.rb
 - lib/overcommit/hook/commit_msg/text_width.rb
 - lib/overcommit/hook/commit_msg/base.rb
-- lib/overcommit/hook/post_checkout/bundle_check.rb
 - lib/overcommit/hook/post_checkout/index_tags.rb
 - lib/overcommit/hook/post_checkout/base.rb
 - lib/overcommit/hook/base.rb

data/lib/overcommit/hook/post_checkout/bundle_check.rb

@@ -1,33 +0,0 @@
-module Overcommit::Hook::PostCheckout
-  # If Gemfile dependencies were modified since HEAD was changed, check if
-  # currently installed gems satisfy the dependencies.
-  class BundleCheck < Base
-    def run
-      unless in_path?('bundle')
-        return :warn, 'bundler not installed -- run `gem install bundler`'
-      end
-
-      if dependencies_changed? && !dependencies_satisfied?
-        return :warn, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
-      end
-
-      :pass
-    end
-
-  private
-
-    LOCK_FILE = 'Gemfile.lock'
-
-    def dependencies_changed?
-      result = execute(%w[git diff --exit-code --name-only] + [new_head, previous_head])
-
-      result.stdout.split("\n").any? do |file|
-        Array(config['include']).any? { |glob| Dir[glob].include?(file) }
-      end
-    end
-
-    def dependencies_satisfied?
-      execute(%w[bundle check]).success?
-    end
-  end
-end