overcommit 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e46e06664c4b84241863650f3b1c0d0316f9c66b
-  data.tar.gz: 16c1e91603f5c6e3aef1316cd4a1aaeb60998eef
+  metadata.gz: 7d0cda7604db99089da1104e74e50dddb00119f6
+  data.tar.gz: 97ac88f0a6772146b35cbc5e4cf93e1a16a6a024
 SHA512:
-  metadata.gz: 7629c771c3a572032c7036af72799a0b3127fca7386d804c3fdb8609c766134853385564faa7c49296b86add33f7fe2de3ee339cdd814868c7f7cdc4142cd4f2
-  data.tar.gz: db1da032a04d2673e2b10875ea9e0e3fa9b0b6a7afe4af780ad5eb32f6e94b3f0531636d642ffb451cb01a850a7405178a7de248b8bbb7dea7307a5f91ad5753
+  metadata.gz: 92478e619197b1707b9646f809c8fa0bc102f6fb44106015f91e32e4707b6585518c0d41ede75ed17bee6dfb27aaf3c52cd64fafd9ea1e80180a67362d1a5503
+  data.tar.gz: 7b9cdc771310e3b140f254d7bf7b0472f9e5b5587627584bf140f7fed2fcd72fbf8312da85138909f12677bbf904105850d8db89e3e10b11fdef7d6928e3a53f

data/config/default.yml

@@ -785,6 +785,16 @@ PreCommit:
       - '**/*.yaml'
       - '**/*.yml'
 
+  YarnCheck:
+    enabled: false
+    description: 'Check yarn.lock dependencies'
+    required_executable: 'yarn'
+    flags: ['check', '--silent', '--no-progress', '--non-interactive']
+    install_command: 'npm install --global yarn'
+    include:
+      - 'package.json'
+      - 'yarn.lock'
+
 # Hooks that run after HEAD changes or a file is explicitly checked out.
 PostCheckout:
   ALL:
@@ -822,6 +832,12 @@ PostCheckout:
     flags: ['install']
     include: 'composer.json'
 
+  GitLfs:
+    enabled: false
+    description: 'Check status of lockable files tracked by Git LFS'
+    required_executable: 'git-lfs'
+    install_command: 'brew install git-lfs'
+
   IndexTags:
     enabled: false
     description: 'Generate tags file from source'
@@ -906,6 +922,12 @@ PostCommit:
     flags: ['HEAD~', 'HEAD']
     install_command: 'npm install -g git-guilt'
 
+  GitLfs:
+    enabled: false
+    description: 'Check status of lockable files tracked by Git LFS'
+    required_executable: 'git-lfs'
+    install_command: 'brew install git-lfs'
+
   IndexTags:
     enabled: false
     description: 'Generate tags file from source'
@@ -974,6 +996,12 @@ PostMerge:
     flags: ['install']
     include: 'composer.json'
 
+  GitLfs:
+    enabled: false
+    description: 'Check status of lockable files tracked by Git LFS'
+    required_executable: 'git-lfs'
+    install_command: 'brew install git-lfs'
+
   IndexTags:
     enabled: false
     description: 'Generate tags file from source'
@@ -1082,6 +1110,32 @@ PrePush:
     required: false
     quiet: false
 
+  Brakeman:
+    enabled: false
+    description: 'Check for security vulnerabilities'
+    required_executable: 'brakeman'
+    flags: ['--exit-on-warn', '--quiet', '--summary']
+    install_command: 'gem install brakeman'
+
+  GitLfs:
+    enabled: false
+    description: 'Upload files tracked by Git LFS'
+    required_executable: 'git-lfs'
+    install_command: 'brew install git-lfs'
+
+  Minitest:
+    enabled: false
+    description: 'Run Minitest test suite'
+    command: ['ruby', '-Ilib:test', '-rminitest', "-e 'exit! Minitest.run'"]
+    include: 'test/**/*_test.rb'
+
+  PhpUnit:
+    enabled: false
+    description: 'Run PhpUnit test suite'
+    command: 'vendor/bin/phpunit'
+    flags: ['--bootstrap', 'vendor/autoload.php', 'tests']
+    install_command: 'composer require --dev phpunit/phpunit'
+
   ProtectedBranches:
     enabled: false
     description: 'Check for illegal pushes to protected branches'
@@ -1115,28 +1169,11 @@ PrePush:
     required_executable: 'rake'
     install_command: 'gem install rake'
 
-  Minitest:
-    enabled: false
-    description: 'Run Minitest test suite'
-    command: ['ruby', '-Ilib:test', '-rminitest', "-e 'exit! Minitest.run'"]
-    include: 'test/**/*_test.rb'
-
   TestUnit:
     enabled: false
     description: 'Run Test::Unit test suite'
     command: ['ruby', '-Ilib:test', '-rtest/unit', "-e 'exit! Test::Unit::AutoRunner.run'"]
 
-  Brakeman:
-    enabled: false
-    description: 'Check for security vulnerabilities'
-    required_executable: 'brakeman'
-    flags: ['--exit-on-warn', '--quiet', '--summary']
-    install_command: 'gem install brakeman'
-
-  GitLfs:
-    enabled: false
-    description: 'Upload files tracked by Git LFS'
-
 # Hooks that run during `git rebase`, before any commits are rebased.
 # If a hook fails, the rebase is aborted.
 PreRebase:

data/lib/overcommit/hook/pre_commit/yarn_check.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Check if local yarn.lock matches package.json when either changes, unless
+  # yarn.lock is ignored by git.
+  #
+  # @see https://yarnpkg.com/en/docs/cli/check
+  class YarnCheck < Base
+    LOCK_FILE = 'yarn.lock'.freeze
+
+    # A lot of the errors returned by `yarn check` are outside the developer's control
+    # (are caused by bad package specification, in the hands of the upstream maintainer)
+    # So limit reporting to errors the developer can do something about
+    ACTIONABLE_ERRORS = [
+      'Lockfile does not contain pattern'.freeze,
+    ].freeze
+
+    def run
+      # Ignore if yarn.lock is not tracked by git
+      ignored_files = execute(%w[git ls-files -o -i --exclude-standard]).stdout.split("\n")
+      return :pass if ignored_files.include?(LOCK_FILE)
+
+      previous_lockfile = File.exist?(LOCK_FILE) ? File.read(LOCK_FILE) : nil
+      result = execute(command)
+      new_lockfile = File.exist?(LOCK_FILE) ? File.read(LOCK_FILE) : nil
+
+      # `yarn check` also throws many warnings, which should be ignored here
+      errors_regex = Regexp.new("^error (.*)(#{ACTIONABLE_ERRORS.join('|')})(.*)$")
+      errors = errors_regex.match(result.stderr)
+      unless errors.nil? && previous_lockfile == new_lockfile
+        return :fail, "#{LOCK_FILE} is not up-to-date -- run `yarn install`"
+      end
+
+      :pass
+    end
+  end
+end

data/lib/overcommit/hook/pre_push/php_unit.rb

@@ -0,0 +1,14 @@
+module Overcommit::Hook::PrePush
+  # Runs `phpunit` test suite before push
+  #
+  # @see https://phpunit.de/
+  class PhpUnit < Base
+    def run
+      result = execute(command)
+      return :pass if result.success?
+
+      output = result.stdout + result.stderr
+      [:fail, output]
+    end
+  end
+end

data/lib/overcommit/hook_context/base.rb

@@ -102,6 +102,13 @@ module Overcommit::HookContext
       @input_lines ||= input_string.split("\n")
     end
 
+    # Returns a message to display on failure.
+    #
+    # @return [String]
+    def post_fail_message
+      nil
+    end
+
     private
 
     def filter_modified_files(modified_files)

data/lib/overcommit/hook_context/commit_msg.rb

@@ -31,6 +31,10 @@ module Overcommit::HookContext
       @args[0]
     end
 
+    def post_fail_message
+      "Failed commit message:\n" + commit_message_lines.join
+    end
+
     private
 
     def raw_commit_message_lines

data/lib/overcommit/hook_context/pre_push.rb

@@ -18,9 +18,14 @@ module Overcommit::HookContext
     end
 
     def modified_files
-      @modified_files ||= Overcommit::GitRepo.modified_files(
-        refs: "#{pushed_refs[0].remote_sha1}..#{pushed_refs[0].local_sha1}"
-      )
+      @modified_files ||= pushed_refs.map(&:modified_files).flatten.uniq
+    end
+
+    def modified_lines_in_file(file)
+      @modified_lines ||= {}
+      @modified_lines[file] = pushed_refs.each_with_object(Set.new) do |pushed_ref, set|
+        set.merge(pushed_ref.modified_lines_in_file(file))
+      end
     end
 
     PushedRef = Struct.new(:local_ref, :local_sha1, :remote_ref, :remote_sha1) do
@@ -40,12 +45,24 @@ module Overcommit::HookContext
         deleted? || forced?
       end
 
+      def modified_files
+        Overcommit::GitRepo.modified_files(refs: ref_range)
+      end
+
+      def modified_lines_in_file(file)
+        Overcommit::GitRepo.extract_modified_lines(file, refs: ref_range)
+      end
+
       def to_s
         "#{local_ref} #{local_sha1} #{remote_ref} #{remote_sha1}"
       end
 
       private
 
+      def ref_range
+        "#{remote_sha1}..#{local_sha1}"
+      end
+
       def overwritten_commits
         return @overwritten_commits if defined? @overwritten_commits
         result = Overcommit::Subprocess.spawn(%W[git rev-list #{remote_sha1} ^#{local_sha1}])

data/lib/overcommit/hook_runner.rb

@@ -51,7 +51,7 @@ module Overcommit
 
     attr_reader :log
 
-    def run_hooks
+    def run_hooks # rubocop:disable Metrics/MethodLength
       if @hooks.any?(&:enabled?)
         @printer.start_run
 
@@ -74,7 +74,14 @@ module Overcommit
 
         print_results
 
-        !(@failed || @interrupted)
+        hook_failed = @failed || @interrupted
+
+        if hook_failed
+          message = @context.post_fail_message
+          @printer.hook_run_failed(message) unless message.nil?
+        end
+
+        !hook_failed
       else
         @printer.nothing_to_run
         true # Run was successful

data/lib/overcommit/printer.rb

@@ -75,6 +75,12 @@ module Overcommit
       end
     end
 
+    def hook_run_failed(message)
+      log.newline
+      log.log message
+      log.newline
+    end
+
     private
 
     def print_header(hook)
@@ -125,9 +131,7 @@ module Overcommit
         self.class.__send__(:alias_method, old_method, method_name)
 
         self.class.send(:define_method, new_method) do |*args|
-          @lock.synchronize do
-            __send__(old_method, *args)
-          end
+          @lock.synchronize { __send__(old_method, *args) }
         end
 
         self.class.__send__(:alias_method, method_name, new_method)

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.42.0'.freeze
+  VERSION = '0.43.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -196,10 +196,11 @@ files:
 - lib/overcommit/hook/pre_commit/xml_syntax.rb
 - lib/overcommit/hook/pre_commit/yaml_lint.rb
 - lib/overcommit/hook/pre_commit/yaml_syntax.rb
+- lib/overcommit/hook/pre_commit/yarn_check.rb
 - lib/overcommit/hook/pre_push/base.rb
 - lib/overcommit/hook/pre_push/brakeman.rb
-- lib/overcommit/hook/pre_push/git_lfs.rb
 - lib/overcommit/hook/pre_push/minitest.rb
+- lib/overcommit/hook/pre_push/php_unit.rb
 - lib/overcommit/hook/pre_push/protected_branches.rb
 - lib/overcommit/hook/pre_push/pytest.rb
 - lib/overcommit/hook/pre_push/python_nose.rb
@@ -274,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Git hook manager

data/lib/overcommit/hook/pre_push/git_lfs.rb

@@ -1,20 +0,0 @@
-module Overcommit::Hook::PrePush
-  # Invokes Git LFS command that uploads files tracked by Git LFS to the LFS storage
-  #
-  # @see https://git-lfs.github.com/
-  class GitLfs < Base
-    def run
-      unless in_path?('git-lfs')
-        return :warn, 'This repository is configured for Git LFS but \'git-lfs\' ' \
-        "was not found on your path.\nIf you no longer wish to use Git LFS, " \
-        'disable this hook by removing or setting \'enabled: false\' for GitLFS ' \
-        'hook in your .overcommit.yml file'
-      end
-
-      result = execute(['git', 'lfs', 'pre-push', remote_name, remote_url])
-      return :fail, result.stderr unless result.success?
-
-      :pass
-    end
-  end
-end