DRY up SubmoduleStatus hooks into single shared module

We have a couple of hooks that are duplicated across multiple different
hook types. Rather than force this duplication, we extract the shared
code into a module and store it under `Overcommit::Hook::Shared`
namespace.

Author: sds

lib/overcommit/hook/post_checkout/submodule_status.rb

@@ -1,30 +1,10 @@
+require 'overcommit/hook/shared/submodule_status'
+
 module Overcommit::Hook::PostCheckout
   # Checks the status of submodules in the current repository and
   # notifies the user if any are uninitialized, out of date with
   # the current index, or contain merge conflicts.
   class SubmoduleStatus < Base
-    def run
-      messages = []
-      submodule_statuses.each do |submodule_status|
-        path = submodule_status.path
-        if submodule_status.uninitialized?
-          messages << "Submodule #{path} is uninitialized."
-        elsif submodule_status.outdated?
-          messages << "Submodule #{path} is out of date with the current index."
-        elsif submodule_status.merge_conflict?
-          messages << "Submodule #{path} has merge conflicts."
-        end
-      end
-
-      return :pass if messages.empty?
-
-      [:warn, messages.join("\n")]
-    end
-
-    private
-
-    def submodule_statuses
-      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
-    end
+    include Overcommit::Hook::Shared::SubmoduleStatus
   end
 end

lib/overcommit/hook/post_commit/submodule_status.rb

@@ -1,30 +1,10 @@
+require 'overcommit/hook/shared/submodule_status'
+
 module Overcommit::Hook::PostCommit
   # Checks the status of submodules in the current repository and
   # notifies the user if any are uninitialized, out of date with
   # the current index, or contain merge conflicts.
   class SubmoduleStatus < Base
-    def run
-      messages = []
-      submodule_statuses.each do |submodule_status|
-        path = submodule_status.path
-        if submodule_status.uninitialized?
-          messages << "Submodule #{path} is uninitialized."
-        elsif submodule_status.outdated?
-          messages << "Submodule #{path} is out of date with the current index."
-        elsif submodule_status.merge_conflict?
-          messages << "Submodule #{path} has merge conflicts."
-        end
-      end
-
-      return :pass if messages.empty?
-
-      [:warn, messages.join("\n")]
-    end
-
-    private
-
-    def submodule_statuses
-      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
-    end
+    include Overcommit::Hook::Shared::SubmoduleStatus
   end
 end

lib/overcommit/hook/post_merge/submodule_status.rb

@@ -1,30 +1,10 @@
+require 'overcommit/hook/shared/submodule_status'
+
 module Overcommit::Hook::PostMerge
   # Checks the status of submodules in the current repository and
   # notifies the user if any are uninitialized, out of date with
   # the current index, or contain merge conflicts.
   class SubmoduleStatus < Base
-    def run
-      messages = []
-      submodule_statuses.each do |submodule_status|
-        path = submodule_status.path
-        if submodule_status.uninitialized?
-          messages << "Submodule #{path} is uninitialized."
-        elsif submodule_status.outdated?
-          messages << "Submodule #{path} is out of date with the current index."
-        elsif submodule_status.merge_conflict?
-          messages << "Submodule #{path} has merge conflicts."
-        end
-      end
-
-      return :pass if messages.empty?
-
-      [:warn, messages.join("\n")]
-    end
-
-    private
-
-    def submodule_statuses
-      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
-    end
+    include Overcommit::Hook::Shared::SubmoduleStatus
   end
 end

lib/overcommit/hook/post_rewrite/submodule_status.rb

@@ -1,30 +1,10 @@
+require 'overcommit/hook/shared/submodule_status'
+
 module Overcommit::Hook::PostRewrite
   # Checks the status of submodules in the current repository and
   # notifies the user if any are uninitialized, out of date with
   # the current index, or contain merge conflicts.
   class SubmoduleStatus < Base
-    def run
-      messages = []
-      submodule_statuses.each do |submodule_status|
-        path = submodule_status.path
-        if submodule_status.uninitialized?
-          messages << "Submodule #{path} is uninitialized."
-        elsif submodule_status.outdated?
-          messages << "Submodule #{path} is out of date with the current index."
-        elsif submodule_status.merge_conflict?
-          messages << "Submodule #{path} has merge conflicts."
-        end
-      end
-
-      return :pass if messages.empty?
-
-      [:warn, messages.join("\n")]
-    end
-
-    private
-
-    def submodule_statuses
-      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
-    end
+    include Overcommit::Hook::Shared::SubmoduleStatus
   end
 end

lib/overcommit/hook/shared/submodule_status.rb

@@ -0,0 +1,30 @@
+module Overcommit::Hook::Shared
+  # Shared code used by all `SubmoduleStatus` hooks to notify the user if any
+  # submodules are uninitialized, out of date with the current index, or contain
+  # merge conflicts.
+  module SubmoduleStatus
+    def run
+      messages = []
+      submodule_statuses.each do |submodule_status|
+        path = submodule_status.path
+        if submodule_status.uninitialized?
+          messages << "Submodule #{path} is uninitialized."
+        elsif submodule_status.outdated?
+          messages << "Submodule #{path} is out of date with the current index."
+        elsif submodule_status.merge_conflict?
+          messages << "Submodule #{path} has merge conflicts."
+        end
+      end
+
+      return :pass if messages.empty?
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def submodule_statuses
+      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
+    end
+  end
+end

lib/overcommit/utils.rb

@@ -91,6 +91,7 @@ def camel_case(str)
       def supported_hook_types
         Dir[File.join(HOOK_DIRECTORY, '*')].
           select { |file| File.directory?(file) }.
+          reject { |file| File.basename(file) == 'shared' }.
           map { |file| File.basename(file).gsub('_', '-') }
       end
 

spec/spec_helper.rb

@@ -7,6 +7,7 @@
 
 hook_types = Dir[File.join(Overcommit::HOOK_DIRECTORY, '*')].
   select { |f| File.directory?(f) }.
+  reject { |f| File.basename(f) == 'shared' }.
   sort
 
 hook_types.each do |hook_type|