overcommit 0.63.0 → 0.67.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9a2e23f1b830d2d9e8e500024cd01a1d368678b1f24039367ae88c90dc154a
-  data.tar.gz: 9c3fada758490c58d2341125315a988fe73fb9d4dc31c5167a400eddbff28846
+  metadata.gz: e81508d0f9854d0ad04bb88a192e479efd14d2dcb72520656e96ffbd42d2a10c
+  data.tar.gz: 58cf91765bfd9b4fc13f287f7d8d0fc5de9abdd5f4306e8c06a6e98b49df005e
 SHA512:
-  metadata.gz: 2773a91d43bf69aa97c9f65fab59934502c2b948ad5264a7dd0def628d6d9bb21b78ebfd868b3a5e0c9457f609ede41fa11fdd1e92708dc27bb87fc433361b91
-  data.tar.gz: 79e8e222951cbaea5875fbd2bab3268d47ead4dde32fad029e76b46bd4823546d8beee1473b42df1575879c64a7ae7bdc7e8da2e970f4ec6766b5b85163409dc
+  metadata.gz: 87650f7f66f4f2d1b652154f44a853aa6486e57befbc91c520f05ac28cce74ca291a7cb5681efcde73436f3bbc7bc7fa0c6eceb9fc8f4abeea44de94c54cd7f0
+  data.tar.gz: e9872666ee60dc587668c17331e476d3287e22a2b2ca3ddf656f9bf863d1c315f208458c2c5c21c0e0d7ae779e1cbd7357ebe5fd361be1812799b7018095257a

data/config/default.yml

@@ -32,6 +32,10 @@
 # your repository, and then set the `gemfile` option below to the name you gave
 # the file.
 # (Generate lock file by running `bundle install --gemfile=.overcommit_gems.rb`)
+#
+# NOTE: the following line will be parsed by a regexp rather than a proper YAML
+# parser, so avoid any values other than false or a string, and don't use inline
+# comments
 gemfile: false
 
 # Where to store hook plugins specific to a repository. These are loaded in

data/lib/overcommit/cli.rb

@@ -9,6 +9,7 @@ module Overcommit
   class CLI # rubocop:disable Metrics/ClassLength
     def initialize(arguments, input, logger)
       @arguments = arguments
+      @cli_options = {}
       @input     = input
       @log       = logger
       @options   = {}
@@ -28,6 +29,8 @@ module Overcommit
         sign
       when :run_all
         run_all
+      when :diff
+        diff
       end
     rescue Overcommit::Exceptions::ConfigurationSignatureChanged => e
       puts e
@@ -45,7 +48,7 @@ module Overcommit
       @parser = create_option_parser
 
       begin
-        @parser.parse!(@arguments)
+        @parser.parse!(@arguments, into: @cli_options)
 
         # Default action is to install
         @options[:action] ||= :install
@@ -98,6 +101,11 @@ module Overcommit
         @options[:action] = :run_all
         @options[:hook_to_run] = arg ? arg.to_s : 'run-all'
       end
+
+      opts.on('--diff [ref]', 'Run pre_commit hooks against the diff between a given ref. Defaults to `main`.') do |arg| # rubocop:disable Layout/LineLength
+        @options[:action] = :diff
+        arg
+      end
     end
 
     def add_other_options(opts)
@@ -209,6 +217,19 @@ module Overcommit
       halt(status ? 0 : 65)
     end
 
+    def diff
+      empty_stdin = File.open(File::NULL) # pre-commit hooks don't take input
+      context = Overcommit::HookContext.create('diff', config, @arguments, empty_stdin, **@cli_options) # rubocop:disable Layout/LineLength
+      config.apply_environment!(context, ENV)
+
+      printer = Overcommit::Printer.new(config, log, context)
+      runner  = Overcommit::HookRunner.new(config, log, context, printer)
+
+      status = runner.run
+
+      halt(status ? 0 : 65)
+    end
+
     # Used for ease of stubbing in tests
     def halt(status = 0)
       exit status

data/lib/overcommit/git_config.rb

@@ -17,7 +17,7 @@ module Overcommit
       path = `git config --get core.hooksPath`.chomp
       return File.join(Overcommit::Utils.git_dir, 'hooks') if path.empty?
 
-      File.absolute_path(path, Dir.pwd)
+      File.expand_path(path, Dir.pwd)
     end
   end
 end

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

@@ -12,7 +12,7 @@ module Overcommit::Hook::PreCommit
 
     def run
       result = execute(command, args: applicable_files)
-      output = result.stdout.chomp
+      output = result.stdout + result.stderr.chomp
       return :pass if result.success? && output.empty?
 
       extract_messages(

data/lib/overcommit/hook_context/base.rb

@@ -18,10 +18,12 @@ module Overcommit::HookContext
     # @param config [Overcommit::Configuration]
     # @param args [Array<String>]
     # @param input [IO] standard input stream
-    def initialize(config, args, input)
+    # @param options [Hash] cli options
+    def initialize(config, args, input, **options)
       @config = config
       @args = args
       @input = input
+      @options = options
     end
 
     # Executes a command as if it were a regular git hook, passing all

data/lib/overcommit/hook_context/diff.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'overcommit/git_repo'
+
+require 'set'
+
+module Overcommit::HookContext
+  # Simulates a pre-commit context based on the diff with another git ref.
+  #
+  # This results in pre-commit hooks running against the changes between the current
+  # and another ref, which is useful for automated CI scripts.
+  class Diff < Base
+    def modified_files
+      @modified_files ||= Overcommit::GitRepo.modified_files(refs: @options[:diff])
+    end
+
+    def modified_lines_in_file(file)
+      @modified_lines ||= {}
+      @modified_lines[file] ||= Overcommit::GitRepo.extract_modified_lines(file,
+                                                                           refs: @options[:diff])
+    end
+
+    def hook_class_name
+      'PreCommit'
+    end
+
+    def hook_type_name
+      'pre_commit'
+    end
+
+    def hook_script_name
+      'pre-commit'
+    end
+
+    def initial_commit?
+      @initial_commit ||= Overcommit::GitRepo.initial_commit?
+    end
+  end
+end

data/lib/overcommit/hook_context.rb

@@ -2,13 +2,13 @@
 
 # Utility module which manages the creation of {HookContext}s.
 module Overcommit::HookContext
-  def self.create(hook_type, config, args, input)
+  def self.create(hook_type, config, args, input, **cli_options)
     hook_type_class = Overcommit::Utils.camel_case(hook_type)
     underscored_hook_type = Overcommit::Utils.snake_case(hook_type)
 
     require "overcommit/hook_context/#{underscored_hook_type}"
 
-    Overcommit::HookContext.const_get(hook_type_class).new(config, args, input)
+    Overcommit::HookContext.const_get(hook_type_class).new(config, args, input, **cli_options)
   rescue LoadError, NameError => e
     # Could happen when a symlink was created for a hook type Overcommit does
     # not yet support.

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.63.0'
+  VERSION = '0.67.1'
 end

data/template-dir/hooks/commit-msg

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/overcommit-hook

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/post-checkout

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/post-commit

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/post-merge

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/post-rewrite

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/pre-commit

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/pre-push

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/pre-rebase

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

data/template-dir/hooks/prepare-commit-msg

@@ -27,14 +27,8 @@ if hook_type == 'overcommit-hook'
 end
 
 # Check if Overcommit should invoke a Bundler context for loading gems
-require 'yaml'
-# rubocop:disable Style/RescueModifier
-gemfile =
-  begin
-    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
-  rescue ArgumentError
-    YAML.load_file('.overcommit.yml')['gemfile']
-  end rescue nil
+File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
+gemfile = Regexp.last_match(1)
 
 if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.63.0
+  version: 0.67.1
 platform: ruby
 authors:
 - Shane da Silva
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -48,16 +47,16 @@ dependencies:
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.3.9
 description: Utility to install, configure, and extend Git hooks
 email:
 - shane@dasilva.io
@@ -262,6 +261,7 @@ files:
 - lib/overcommit/hook_context.rb
 - lib/overcommit/hook_context/base.rb
 - lib/overcommit/hook_context/commit_msg.rb
+- lib/overcommit/hook_context/diff.rb
 - lib/overcommit/hook_context/helpers/file_modifications.rb
 - lib/overcommit/hook_context/helpers/stash_unstaged_changes.rb
 - lib/overcommit/hook_context/post_checkout.rb
@@ -304,7 +304,8 @@ files:
 homepage: https://github.com/sds/overcommit
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/sds/overcommit/blob/main/CHANGELOG.md
 post_install_message: Install hooks by running `overcommit --install` in your Git
   repository
 rdoc_options: []
@@ -321,8 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Git hook manager
 test_files: []