git 5.0.5 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e6fda47311cb6c004daa4c42830658e97f5c95a37f325da3dee7bee64f8222
-  data.tar.gz: 7ce4dd95073b4419f883ca79fc2985352575ac909c22739be7d3c43ae4d734b8
+  metadata.gz: 10e1f676a8b4122760435d18757f8dbb0f67e8e0f59f2e85463c0c7c93add807
+  data.tar.gz: 47687fd4a08c52945fb1eb8aa668429e33c7e4e9ce06f6a8664dc2f83e0372bc
 SHA512:
-  metadata.gz: 3e3420fd700a1440102c3a8b186841ce3cfc3c442f7f80afb9691e1a337b35e947a8ffdf668916889218c839393e5971706667f4df492a04ead0afb27ecd1925
-  data.tar.gz: d0a7ea7e2150e56bcd0da3cd4c86645b1430eb4193f8610709bd2d07394fbb320ec3d9b7b77e2eafb42324ba58740437ac5b433c2575058d7e01a72bc23998d5
+  metadata.gz: 3073e1e644e4d927de4e78bb6b0a8f082e6c757353a68b53c0ac2035c8ebee978e8d4a0a4c3a5fcaccece86ce5139f433af86716193ae2f8b0a0d26d6d9119c0
+  data.tar.gz: dcc552a33be697647b62e780492d454d3da93b1c9c8de218363f5118125abc59c7aa331ed15c1b69eb87e2b60b205db466b9e5da7cc59022d0a1ae9f55d0384a

data/.github/workflows/continuous_integration.yml

@@ -207,10 +207,25 @@ jobs:
       # `update-locale` is deliberately not run: it edits /etc/default/locale, which is
       # only consulted for logins that do not already set LANG and LC_ALL, and this job
       # sets both explicitly.
+      #
+      # The two apt settings below exist because this step reaches out to the Ubuntu
+      # archive, which is the only part of this job that can fail for reasons that have
+      # nothing to do with the code under test:
+      #
+      #   * `Acquire::Retries` retries an individual download that fails outright,
+      #     rather than failing the job on one unlucky mirror.
+      #   * `timeout-minutes` bounds a mirror that accepts the connection and then
+      #     stops responding, which retries cannot help with. Without it the step
+      #     inherits the 6 hour job default: run 32087601711 sat here for 12 minutes
+      #     before it was cancelled by hand, and would otherwise have held a runner
+      #     for the rest of the day. The whole job normally finishes in 53-118
+      #     seconds, so 5 minutes is generous while still failing the same morning.
+      #
       - name: Install the German locale and message catalogs
+        timeout-minutes: 5
         run: |
-          sudo apt-get update -qq
-          sudo apt-get install -y --no-install-recommends language-pack-de
+          sudo apt-get -o Acquire::Retries=3 update -qq
+          sudo apt-get -o Acquire::Retries=3 install -y --no-install-recommends language-pack-de
           sudo locale-gen de_DE.UTF-8
 
       # Ruby 3.4 to share the bundler cache the lint job already warms. Nothing about

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.0.5"
+  ".": "5.1.0"
 }

data/.rubocop.yml

@@ -26,6 +26,13 @@ Layout/LineLength:
 Style/OneClassPerFile:
   Enabled: false
 
+# The repository is stored with LF line endings, but this cop defaults to `native`,
+# which expects CRLF on Windows and so reports every file in the project as an
+# offense there. Pinning it to `lf` makes the lint verdict identical on every
+# platform, which is the same reason CI runs RuboCop on one runtime only.
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
 AllCops:
   # Must match the floor of required_ruby_version in the gemspec: TargetRubyVersion
   # decides which syntax RuboCop permits and suggests, so a value above the floor

data/CHANGELOG.md

@@ -5,6 +5,30 @@
 
 # Change Log
 
+## [5.1.0](https://github.com/ruby-git/ruby-git/compare/v5.0.5...v5.1.0) (2026-08-18)
+
+
+### Features
+
+* **grep:** Expose perl_regexp on the Git::Repository#grep facade ([759436f](https://github.com/ruby-git/ruby-git/commit/759436f7b59ac5028e38a2158a9a354720640415))
+* **log:** Expose perl_regexp on the log path ([df8ea33](https://github.com/ruby-git/ruby-git/commit/df8ea33bb7d019d1a52fbb99370d9ffd67bf279f))
+
+
+### Other Changes
+
+* Add fiddle as a Windows development dependency ([1847989](https://github.com/ruby-git/ruby-git/commit/18479892529bd1f992596cbc055a9a42be326680))
+* Bound the locale job's apt step so a stalled mirror fails fast ([3a5d83b](https://github.com/ruby-git/ruby-git/commit/3a5d83b7685091a4abbde2c84c0136214fa66e5d))
+* Cover the perl_regexp escape hatch for non-ASCII regex matching ([55e2ded](https://github.com/ruby-git/ruby-git/commit/55e2ded4563a39a0389dbbd52f8425da9a1e3aea))
+* Document the Git for Windows byte-matching regex limitation ([9aaedbd](https://github.com/ruby-git/ruby-git/commit/9aaedbd94488bcfeef05cc56dfce61ce69f529fc))
+* Document the windows symlink privilege requirement ([696dff3](https://github.com/ruby-git/ruby-git/commit/696dff3cbf09647bbfa51279f7e35fc8a85eaab4))
+* Express development dependency conditions as named predicates ([acca20a](https://github.com/ruby-git/ruby-git/commit/acca20a43a6fb79f6b36de900ac8aa8c2488d87f))
+* Fix a broken section link in the pre-review checklist ([719f595](https://github.com/ruby-git/ruby-git/commit/719f595af69c1afcf6b025d1a2bb920963738f80))
+* Make integration fixtures independent of git and platform settings ([c2a1592](https://github.com/ruby-git/ruby-git/commit/c2a159287ec007793c125929029303707669c8ad))
+* Pin rubocop to lf line endings ([7f40413](https://github.com/ruby-git/ruby-git/commit/7f40413c3eded1af7a3dede02e1d94d7dc9c829b))
+* Pin test repository config from a single source ([6e227b7](https://github.com/ruby-git/ruby-git/commit/6e227b70f59f4bbaf2bbc1d30a4b1b86ffbe6afc))
+* Scope the symlink rescue to the symlink call ([c2bed8f](https://github.com/ruby-git/ruby-git/commit/c2bed8fefdd8bdf2efa84432c318b2b39ba223d2))
+* Skip the symlink specs when the host cannot create symlinks ([8e9b667](https://github.com/ruby-git/ruby-git/commit/8e9b667daeb6a179a02df7c946a495c7b7e6fce5))
+
 ## [5.0.5](https://github.com/ruby-git/ruby-git/compare/v5.0.4...v5.0.5) (2026-08-09)
 
 

data/CONTRIBUTING.md

@@ -10,6 +10,7 @@
 - [How to report an issue or request a feature](#how-to-report-an-issue-or-request-a-feature)
 - [Local development setup](#local-development-setup)
   - [Prerequisites](#prerequisites)
+    - [A note for Windows contributors](#a-note-for-windows-contributors)
   - [Bootstrap the project](#bootstrap-the-project)
   - [Verify the toolchain](#verify-the-toolchain)
   - [Contributor validation policy](#contributor-validation-policy)
@@ -97,6 +98,18 @@ prerequisite is missing.
 | git | `>= 2.28.0` (matches `git.gemspec` `requirements`) | Older git versions are not supported and the test suite will not pass against them. |
 | Node.js / npm | Optional | Required only to install the local Conventional Commit `commit-msg` hook (Husky + commitlint). If npm is missing, `bin/setup` will warn and continue — CI will still validate commit messages. |
 
+#### A note for Windows contributors
+
+A few unit specs create real symlinks, which on Windows requires
+`SeCreateSymbolicLinkPrivilege`. A non-elevated process only holds that privilege
+when Developer Mode is enabled (Settings → System → For developers). Without it
+those specs skip rather than fail, so `bundle exec rake` still passes — but the
+behavior they cover goes unverified locally.
+
+The same privilege decides whether Git for Windows materializes the committed
+`.claude/skills` symlink, so enabling Developer Mode fixes both at once. See
+[Agent configuration](#agent-configuration).
+
 ### Bootstrap the project
 
 From the project root, run:
@@ -181,7 +194,7 @@ Before moving a pull request out of draft or requesting a review, confirm:
 - [ ] `bundle exec rake` passes locally on your branch (see
   [Local development setup](#local-development-setup)).
 - [ ] New or changed code has accompanying tests under `spec/`
-  (see [Unit tests](#unit-tests)).
+  (see [Unit tests vs Integration tests](#unit-tests-vs-integration-tests)).
 - [ ] Every commit message follows [Conventional Commits](#commit-message-guidelines).
 - [ ] User-facing changes are documented in `README.md` and/or YARD as appropriate.
 
@@ -967,9 +980,21 @@ below either threshold.
 
 This is enforceable without being onerous because unit coverage in this project is
 deterministic: `lib/` has no Ruby-version, Ruby-engine, or platform conditionals, and
-no unit spec is conditionally skipped. Every supported MRI runtime measures exactly
-the same lines and branches, so a coverage failure is always something the pull
-request introduced.
+the handful of unit specs that are conditionally skipped are redundant for coverage —
+every `lib/` line and branch they reach is also reached by a spec that always runs.
+Every supported MRI runtime therefore measures exactly the same lines and branches, so
+a coverage failure is always something the pull request introduced.
+
+A new conditional skip in `spec/unit/` must preserve that property. Verify it on a
+host where the guard actually skips: run the full unit suite there and confirm it
+still reports 100% line and branch coverage. A conditionally skipped unit spec that
+is the only thing covering a line would turn this gate into a platform-dependent
+failure, which is exactly what the policy exists to prevent.
+
+Write the guard the same way the rest of the suite does: a reusable predicate in
+`spec/spec_helper.rb` (`unless_git`, `unless_command`, `unless_pcre`,
+`unless_ci_build`) used as `skip:` metadata, or — for a one-off capability that the
+`before` block is already exercising — a `rescue` in that block that calls `skip`.
 
 What the policy does and does not cover:
 

data/README.md

@@ -30,6 +30,8 @@ Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?log
 - [Errors Raised by This Gem](#errors-raised-by-this-gem)
 - [Specifying and Handling Timeouts](#specifying-and-handling-timeouts)
 - [Deprecations](#deprecations)
+- [Platform Limitations](#platform-limitations)
+  - [Regex Metacharacters on Git for Windows](#regex-metacharacters-on-git-for-windows)
 - [Project Policies](#project-policies)
   - [Ruby Version Support Policy](#ruby-version-support-policy)
   - [Git Version Support Policy](#git-version-support-policy)
@@ -302,6 +304,71 @@ needed for the upgrade.
 For the full list of deprecated methods and their replacements, see
 [UPGRADING.md](UPGRADING.md).
 
+## Platform Limitations
+
+### Regex Metacharacters on Git for Windows
+
+On Git for Windows, git's regex engine matches **bytes** rather than characters. A
+metacharacter such as `.`, or a POSIX character class such as `[[:alpha:]]`, therefore
+never matches a whole multi-byte character. The same call matches on Linux and macOS.
+
+The failure is silent — nothing raises, and the result is indistinguishable from a
+pattern that genuinely does not occur:
+
+```ruby
+# File content, commit message, and config value are all 'ÄPFEL sind gut'.
+# 'Ä' is two bytes in UTF-8 (C3 84), so '.' has to match both to match the character.
+
+repo.grep('^.PFEL')                              # => {} on Windows, matches elsewhere
+repo.log.grep('^.PFEL').execute.size             # =>  0 on Windows, 1 elsewhere
+repo.config_get_all('test.desc', '^.PFEL')       # => [] on Windows, matches elsewhere
+```
+
+This is a property of the regex engine git bundles on that platform, not something the
+gem sets. It is unaffected by the locale: the behavior is identical under `en_US.UTF-8`,
+`C.UTF-8`, `C`, and with no `LC_ALL` set at all. Literal (metacharacter-free) patterns
+and case-insensitive matching are unaffected on every platform.
+
+**Workaround.** Perl-compatible regular expressions do match characters on Git for
+Windows, so the surfaces that can reach a PCRE engine accept an opt-in selector:
+
+```ruby
+repo.grep('^.PFEL', nil, perl_regexp: true)      # matches on every platform
+repo.log.perl_regexp.grep('^.PFEL').execute      # matches on every platform
+repo.full_log_commits(grep: '^.PFEL', perl_regexp: true)
+```
+
+Two caveats:
+
+- **PCRE is a different dialect** than git's default POSIX basic/extended regular
+  expressions. Selecting it is a deliberate choice by the caller, so the gem does not
+  substitute it automatically based on the host.
+- **PCRE must be compiled in.** Git for Windows and the mainstream Linux and macOS
+  packages ship it, but git built without `USE_LIBPCRE` fails with `cannot use
+  Perl-compatible regexes...`.
+
+**There is no workaround for `git config` value patterns.** They are POSIX extended
+regular expressions with no PCRE mode, so `config_get`, `config_get_all`,
+`config_get_regexp`, `config_replace_all`, `config_unset`, and `config_unset_all` cannot
+match a metacharacter against a non-ASCII character on Git for Windows. Match on ASCII
+text or an exact value instead.
+
+`config_replace_all` deserves particular care, because there the failure is not merely an
+empty result. When the value pattern selects nothing, `git config --replace-all` *adds*
+the new value as an additional entry rather than replacing one, and exits zero:
+
+```ruby
+# Existing value of test.desc is 'ÄPFEL sind gut'
+repo.config_replace_all('test.desc', 'NEW', '^.PFEL')
+
+repo.config_get_all('test.desc').map(&:value)
+# => ["NEW"]                     elsewhere — replaced, as intended
+# => ["ÄPFEL sind gut", "NEW"]   on Windows — original kept, duplicate added
+```
+
+So a replace can silently leave the original value in place and add a second entry beside
+it. Confirm with `config_get_all` when the key must end up single-valued.
+
 ## Project Policies
 
 These documents set expectations for behavior, contribution workflows, AI-assisted

data/git.gemspec

@@ -46,31 +46,59 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'process_executer', '~> 4.0'
   spec.add_dependency 'rchardet', '~> 1.9'
 
+  # Not every development dependency is installed on every runtime. Each predicate
+  # below names one reason for holding a gem back, which keeps the dependency list
+  # itself a flat, readable list. Deriving one predicate from another also keeps
+  # coupled gems from drifting apart when a condition changes.
+  #
+  # These are local variables rather than methods deliberately. The Gemfile uses
+  # `gemspec`, so Bundler evaluates this file on every `bundle exec`, and a top-level
+  # `def` -- including one written inside this block, since a block is not a definition
+  # scope -- would define a private method on Object in every one of those processes.
+
+  # JRuby (which reports RUBY_PLATFORM as 'java') and TruffleRuby build no C extensions
+  # and do not run the docs build.
+  mri = !(RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby')
+
+  # irb stopped being a default gem in Ruby 3.4. JRuby and TruffleRuby ship their own.
+  install_irb = mri
+
+  # Ruby 4.0.0 dropped fiddle from the default gems. On Windows, irb loads
+  # reline/io/windows.rb, which requires fiddle/import for the Win32 console API, so
+  # bin/console cannot start without it; every other platform takes reline's ANSI IO
+  # gate and never loads that file. Derived from install_irb because fiddle exists only
+  # to serve irb and, being a C extension, could not install where irb is not.
+  install_fiddle = install_irb && Gem.win_platform?
+
+  # The docs toolchain is supported on MRI only. redcarpet, YARD's Markdown renderer,
+  # is also a C extension and so could not install on JRuby regardless.
+  install_docs = mri
+
+  # yard-lint requires Ruby >= 3.3.
+  install_yard_lint = install_docs && Gem.ruby_version >= Gem::Version.new('3.3.0')
+
+  # i18n 1.15+ uses Fiber.[] (Ruby 3.2 Fiber storage), which TruffleRuby < 34.0.0 does
+  # not implement, so those runtimes hold at the last release that works there.
+  pin_old_i18n = RUBY_ENGINE == 'truffleruby' &&
+                 Gem::Version.new(RUBY_ENGINE_VERSION) < Gem::Version.new('34.0.0')
+
   spec.add_development_dependency 'create_github_release', '~> 2.1'
+  spec.add_development_dependency 'fiddle', '~> 1.1' if install_fiddle
   spec.add_development_dependency 'fuubar', '~> 2.5'
+  spec.add_development_dependency 'i18n', '< 1.15' if pin_old_i18n
+  spec.add_development_dependency 'irb', '~> 1.16' if install_irb
   spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'
   spec.add_development_dependency 'parallel_tests', '~> 5.6'
   spec.add_development_dependency 'rake', '~> 13.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.6' if install_docs
   spec.add_development_dependency 'rspec', '~> 3.13'
   spec.add_development_dependency 'rubocop', '~> 1.82'
   spec.add_development_dependency 'simplecov', '~> 1.0'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.9'
   spec.add_development_dependency 'simplecov-rspec', '~> 1.1'
-
-  if RUBY_ENGINE == 'truffleruby' && Gem::Version.new(RUBY_ENGINE_VERSION) < Gem::Version.new('34.0.0')
-    # i18n 1.15+ uses Fiber.[] (Ruby 3.2 Fiber storage) which TruffleRuby < 34.0.0 does not implement
-    spec.add_development_dependency 'i18n', '< 1.15'
-  end
-
-  unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
-    spec.add_development_dependency 'irb', '~> 1.16'
-    spec.add_development_dependency 'redcarpet', '~> 3.6'
-    spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
-    spec.add_development_dependency 'yard_example_test', '~> 0.2', '>= 0.2.1'
-
-    # yard-lint requires Ruby >= 3.3, so it is only installed on Ruby 3.3+.
-    spec.add_development_dependency 'yard-lint', '~> 1.8' if Gem.ruby_version >= Gem::Version.new('3.3.0')
-  end
+  spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28' if install_docs
+  spec.add_development_dependency 'yard_example_test', '~> 0.2', '>= 0.2.1' if install_docs
+  spec.add_development_dependency 'yard-lint', '~> 1.8' if install_yard_lint
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/git/configuring.rb

@@ -88,6 +88,14 @@ module Git
     #
     # @raise [Git::FailedError] if git exits with an unexpected non-zero status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
     def config_get(name, value_regex = nil, **options)
       Private.assert_valid_opts!(CONFIG_GET_ALLOWED_OPTS, **options)
       assert_valid_scope!(**options)
@@ -139,6 +147,14 @@ module Git
     #
     # @raise [Git::FailedError] if git exits with an unexpected non-zero status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
     def config_get_all(name, value_regex = nil, **options)
       Private.assert_valid_opts!(CONFIG_GET_ALL_ALLOWED_OPTS, **options)
       assert_valid_scope!(**options)
@@ -238,6 +254,14 @@ module Git
     #
     # @raise [Git::FailedError] if git exits with an unexpected non-zero status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
     def config_get_regexp(name_regex, value_regex = nil, **options)
       Private.assert_valid_opts!(CONFIG_GET_REGEXP_ALLOWED_OPTS, **options)
       assert_valid_scope!(**options)
@@ -529,6 +553,22 @@ module Git
     #
     #   @raise [Git::FailedError] if git exits with a non-zero exit status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
+    # @note A `value_regex` that selects nothing does not make this method a no-op.
+    #   `git config --replace-all` *adds* `value` as an additional entry when no
+    #   existing value matches, and exits zero. On Git for Windows, a `value_regex`
+    #   whose metacharacters span non-ASCII text therefore leaves the value it was
+    #   meant to replace in place and silently creates a duplicate entry beside it.
+    #   Confirm the result with {#config_get_all}, or match on ASCII text, when the
+    #   key must end up single-valued.
+    #
     def config_replace_all(name, value, value_regex = nil, **)
       Private.assert_valid_opts!(CONFIG_REPLACE_ALL_ALLOWED_OPTS, **)
       assert_valid_scope!(**)
@@ -621,6 +661,14 @@ module Git
     #
     #   @raise [Git::FailedError] if git exits with a non-zero exit status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
     def config_unset(name, value_regex = nil, **)
       Private.assert_valid_opts!(CONFIG_UNSET_ALLOWED_OPTS, **)
       assert_valid_scope!(**)
@@ -666,6 +714,14 @@ module Git
     #
     #   @raise [Git::FailedError] if git exits with a non-zero exit status
     #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather than
+    #   characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` in `value_regex` never matches a whole multi-byte character. The
+    #   failure is silent: nothing raises, and the outcome is indistinguishable from a
+    #   `value_regex` that genuinely matches nothing. `git config` value patterns are
+    #   POSIX extended regular expressions with no PCRE mode, so unlike
+    #   {Git::Repository#grep} there is no alternate regex engine to select here.
+    #
     def config_unset_all(name, value_regex = nil, **)
       Private.assert_valid_opts!(CONFIG_UNSET_ALL_ALLOWED_OPTS, **)
       assert_valid_scope!(**)

data/lib/git/log.rb

@@ -142,6 +142,25 @@ module Git
     #
     def grep(regex)         = set_option(:grep, regex)
 
+    # Interprets {#grep} and {#author} patterns as Perl-compatible regular expressions
+    #
+    # Selects PCRE instead of git's default POSIX basic regular expressions for
+    # every pattern in the query. Requires a git built with PCRE support.
+    #
+    # @example Match a metacharacter against a non-ASCII character on Git for Windows
+    #   repo.log.perl_regexp.grep('^.PFEL').execute
+    #
+    # @return [Git::Log] the current query builder
+    #
+    # @note On Git for Windows, git's default regex engine matches *bytes* rather
+    #   than characters, so a metacharacter such as `.` or a POSIX class such as
+    #   `[[:alpha:]]` never matches a whole multi-byte character. The match fails
+    #   silently: git exits zero and the result is empty. PCRE does match characters
+    #   on that platform, but it is a different dialect than git's default, so
+    #   selecting it is a deliberate choice by the caller.
+    #
+    def perl_regexp         = set_option(:perl_regexp, true)
+
     # Limits commits to those that touch the given path or paths
     #
     # @param path [String, Pathname, Array<String, Pathname>] path limiter input

data/lib/git/repository/logging.rb

@@ -18,7 +18,7 @@ module Git
       # @return [Array<Symbol>] the supported option keys
       #
       FULL_LOG_COMMITS_ALLOWED_OPTS = %i[
-        count all cherry since until grep author between object path_limiter skip merges
+        count all cherry since until grep author between object path_limiter skip merges perl_regexp
       ].freeze
       private_constant :FULL_LOG_COMMITS_ALLOWED_OPTS
 
@@ -68,6 +68,13 @@ module Git
       #
       # @option opts [Boolean, nil] :merges (nil) include only merge commits
       #
+      # @option opts [Boolean, nil] :perl_regexp (nil) interpret the `:grep` and
+      #   `:author` patterns as Perl-compatible regular expressions (PCRE) instead of
+      #   git's default POSIX basic regular expressions
+      #
+      #   Requires a git built with PCRE support; git otherwise fails with
+      #   "cannot use Perl-compatible regexes...".
+      #
       # @return [Array<Hash>] the parsed raw log output for each commit
       #
       # @raise [ArgumentError] if unsupported options are provided
@@ -76,6 +83,14 @@ module Git
       #
       # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
+      # @note On Git for Windows, git's default regex engine matches *bytes* rather
+      #   than characters, so a metacharacter such as `.` or a POSIX class such as
+      #   `[[:alpha:]]` never matches a whole multi-byte character in a `:grep` or
+      #   `:author` pattern. The match fails silently: git exits zero and the result
+      #   is empty. Pass `perl_regexp: true` to select PCRE, which does match
+      #   characters. PCRE is a different dialect than git's default, so this is a
+      #   deliberate choice by the caller rather than a transparent substitution.
+      #
       # @see https://git-scm.com/docs/git-log git-log
       #
       def full_log_commits(opts = {})
@@ -113,6 +128,14 @@ module Git
       module Private
         module_function
 
+        # Log option keys forwarded to {Git::Commands::Log#call} under the same name
+        #
+        # The remaining options are renamed or reshaped by {#log_base_call_options}.
+        #
+        # @return [Array<Symbol>] the pass-through option keys
+        #
+        PASSTHROUGH_LOG_OPTS = %i[all cherry since until grep author perl_regexp].freeze
+
         # Validates the :count log option
         #
         # @param opts [Hash] the log options
@@ -195,6 +218,9 @@ module Git
         # @option opts [String, nil] :author (nil) only include commits whose author
         #   matches this pattern
         #
+        # @option opts [Boolean, nil] :perl_regexp (nil) interpret the `:grep` and
+        #   `:author` patterns as Perl-compatible regular expressions
+        #
         # @option opts [Integer, nil] :count (nil) maximum number of commits to return
         #
         # @option opts [String, Pathname, Array<String, Pathname>, nil] :path_limiter (nil)
@@ -207,16 +233,14 @@ module Git
         # @return [Hash] keyword options for {Git::Commands::Log#call}
         #
         def log_base_call_options(opts, extra = {})
-          {
-            all: opts[:all],
-            cherry: opts[:cherry],
-            since: opts[:since],
-            until: opts[:until],
-            grep: opts[:grep],
-            author: opts[:author],
-            max_count: opts[:count],
-            path: opts[:path_limiter] ? Array(opts[:path_limiter]) : nil
-          }.merge(extra).compact
+          opts
+            .slice(*PASSTHROUGH_LOG_OPTS)
+            .merge(
+              max_count: opts[:count],
+              path: opts[:path_limiter] ? Array(opts[:path_limiter]) : nil
+            )
+            .merge(extra)
+            .compact
         end
 
         # Executes git log and parses the raw output

data/lib/git/repository/object_operations.rb

@@ -454,7 +454,7 @@ module Git
       end
 
       # Option keys accepted by {#grep}
-      GREP_ALLOWED_OPTS = %i[ignore_case i invert_match v extended_regexp E object].freeze
+      GREP_ALLOWED_OPTS = %i[ignore_case i invert_match v extended_regexp E perl_regexp P object].freeze
       private_constant :GREP_ALLOWED_OPTS
 
       # Search tracked file contents in a git tree for a pattern
@@ -475,6 +475,9 @@ module Git
       # @example Case-insensitive search
       #   repo.grep('todo', nil, ignore_case: true)
       #
+      # @example Match a metacharacter against a non-ASCII character on Git for Windows
+      #   repo.grep('^.PFEL', nil, perl_regexp: true)
+      #
       # @param pattern [String] the pattern to search for
       #
       # @param path_limiter [String, Pathname, Array<String, Pathname>, nil]
@@ -499,6 +502,14 @@ module Git
       #
       #   Alias: :E
       #
+      # @option opts [Boolean, nil] :perl_regexp (nil) use Perl-compatible regular
+      #   expressions (PCRE) for the pattern
+      #
+      #   Requires a git built with PCRE support; git otherwise fails with
+      #   "cannot use Perl-compatible regexes...".
+      #
+      #   Alias: :P
+      #
       # @return [Hash<String, Array<Array(Integer, String)>>] a hash mapping
       #   each `"treeish:filename"` key to an array of `[line_number, text]`
       #   pairs; returns an empty hash when no lines match
@@ -508,6 +519,16 @@ module Git
       # @raise [Git::FailedError] if git exits with a non-zero status and
       #   stderr is non-empty (e.g. bad object reference)
       #
+      # @note On Git for Windows, git's default regex engine matches *bytes* rather
+      #   than characters, so a metacharacter such as `.` or a POSIX class such as
+      #   `[[:alpha:]]` never matches a whole multi-byte character. The failure is
+      #   silent: nothing raises, and the empty hash returned is indistinguishable
+      #   from a pattern that genuinely does not occur in the tree. Pass
+      #   `perl_regexp: true` to select PCRE, which does match characters. PCRE is a
+      #   different dialect than git's default POSIX basic/extended regular
+      #   expressions, so this is a deliberate choice by the caller rather than a
+      #   transparent substitution, and it requires a git built with PCRE support.
+      #
       # @see https://git-scm.com/docs/git-grep git-grep documentation
       #
       def grep(pattern, path_limiter = nil, opts = {})

data/lib/git/version.rb

@@ -4,7 +4,7 @@ module Git
   # The current gem version
   #
   # @return [String] the current gem version
-  VERSION = '5.0.5'
+  VERSION = '5.1.0'
 
   # Represents a git version with major, minor, and patch components
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.1.0
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: main_branch_shared_rubocop_config
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +149,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -205,34 +233,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: irb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -631,8 +631,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: https://rubydoc.info/gems/git/5.0.5/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.0.5
+  changelog_uri: https://rubydoc.info/gems/git/5.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.1.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: