git 3.1.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea6b964531a2d91cdc46c4e4c7a6d9f79251f246f2c8856c271b989c6d22800
-  data.tar.gz: 3fd581082807719899cdbe85eea5ca8eca35803402f6822c66bd5b95b27de10b
+  metadata.gz: 93f63d19e697e7cc1f9d6f8fed0a34ff32015c5ed24357f183f2493dca636953
+  data.tar.gz: 8e7619c86fee8af92c11d60c6af450e3814bbf77d456fcb3c6d3c914d985403f
 SHA512:
-  metadata.gz: ae34ed0370f1ac66b68c03e13ef16d9415e531f3ebe0b7af906dc6d9150c4fc0eec63da7dde987530f7a24bf17966cb3053b40723e0056c78652763340b8e71c
-  data.tar.gz: ec675f610d8d193dac8c0debca9de1480d154b3d09c34e172dbb0e68d7a47625fdcb7d8bef7a5625e3fef8dfd10e029e1ff682ee033b698beebae43414b3454f
+  metadata.gz: 1f003e0ea707da5dc4a164c041407802650390e6a03b496d1960994dfd79cae393ab16da3ed062b0cbeaa6839e7d21931d8e9954d7c19fb8ec25cbbfb0f46fa7
+  data.tar.gz: 552efec7c3d8b2e09cfa1c943666e72a3d8aaa336a64252c7d955412cef092c5aede3e87ca7f17df0e8f673a9ed3b35cafcfcf04912b5c8e65ad0082ac415f46

data/.github/workflows/continuous_integration.yml

@@ -22,18 +22,26 @@ jobs:
       fail-fast: false
       matrix:
         # Only the latest versions of JRuby and TruffleRuby are tested
-        ruby: ["3.1", "3.2", "3.3", "3.4", "truffleruby-24.1.2", "jruby-9.4.12.0"]
+        ruby: ["3.2", "3.3", "3.4", "truffleruby-24.2.1", "jruby-10.0.0.1"]
         operating-system: [ubuntu-latest]
         experimental: [No]
+        java_version: [""]
         include:
-          - # Only test with minimal Ruby version on Windows
-            ruby: 3.1
+          - ruby: 3.2
             operating-system: windows-latest
+            experimental: No
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
 
+      - name: Setup Java
+        if: matrix.java_version != ''
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java_version }}
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/experimental_continuous_integration.yml

@@ -27,16 +27,25 @@ jobs:
             ruby: head
             operating-system: ubuntu-latest
             experimental: Yes
+            java_version: ""
 
           - # Since JRuby on Windows is known to not work, consider this experimental
             ruby: jruby-head
             operating-system: windows-latest
             experimental: Yes
+            java_version: "21"
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
 
+      - name: Setup Java
+        if: matrix.java_version != ''
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java_version }}
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.1.1"
+  ".": "4.0.0"
 }

data/CHANGELOG.md

@@ -5,6 +5,25 @@
 
 # Change Log
 
+## [4.0.0](https://github.com/ruby-git/ruby-git/compare/v3.1.1...v4.0.0) (2025-07-02)
+
+
+### ⚠ BREAKING CHANGES
+
+* Users will need to be on Ruby 3.2 or greater
+
+### Features
+
+* Add Log#execute to run the log and return an immutable result ([ded54c4](https://github.com/ruby-git/ruby-git/commit/ded54c4b551aefb7de35b9505ce14f2061d1708c))
+* **diff:** Refactor Git::Diff to separate concerns and improve AP ([e22eb10](https://github.com/ruby-git/ruby-git/commit/e22eb10bf2e4049f1a0fb325341ef7489f25e66e))
+* Upgrade minimally supported Ruby to 3.2 ([fb93ef1](https://github.com/ruby-git/ruby-git/commit/fb93ef14def222d6eca29f49a5f810a3d6de5787))
+
+
+### Other Changes
+
+* Remove unneeded explicit return statements ([28e07ae](https://github.com/ruby-git/ruby-git/commit/28e07ae2e91a8defd52549393bf6f3fcbede122e))
+* Upgrade to ProcessExecuter 4.x ([5b00d3b](https://github.com/ruby-git/ruby-git/commit/5b00d3b9c4063c9988d844eec9ddedddb8c26446))
+
 ## [3.1.1](https://github.com/ruby-git/ruby-git/compare/v3.1.0...v3.1.1) (2025-07-02)
 
 

data/README.md

@@ -18,6 +18,7 @@
 - [Major Objects](#major-objects)
 - [Errors Raised By This Gem](#errors-raised-by-this-gem)
 - [Specifying And Handling Timeouts](#specifying-and-handling-timeouts)
+- [Deprecations](#deprecations)
 - [Examples](#examples)
 - [Ruby version support policy](#ruby-version-support-policy)
 - [License](#license)
@@ -202,6 +203,24 @@ rescue Git::TimeoutError => e
 end
 ```
 
+## Deprecations
+
+This gem uses ActiveSupport's deprecation mechanism to report deprecation warnings.
+
+You can silence deprecation warnings by adding this line to your source code:
+
+```ruby
+Git::Deprecation.behavior = :silence
+```
+
+See [the Active Support Deprecation
+documentation](https://api.rubyonrails.org/classes/ActiveSupport/Deprecation.html)
+for more details.
+
+If deprecation warnings are silenced, you should reenable them before upgrading the
+git gem to the next major version. This will make it easier to identify changes
+needed for the upgrade.
+
 ## Examples
 
 Here are a bunch of examples of how to use the Ruby/Git package.

data/git.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |s|
   s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}"
 
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 3.0.0'
+  s.required_ruby_version = '>= 3.2.0'
   s.requirements = ['git 2.28.0 or greater']
 
   s.add_runtime_dependency 'activesupport', '>= 5.0'
   s.add_runtime_dependency 'addressable', '~> 2.8'
-  s.add_runtime_dependency 'process_executer', '~> 1.3'
+  s.add_runtime_dependency 'process_executer', '~> 4.0'
   s.add_runtime_dependency 'rchardet', '~> 1.9'
 
   s.add_development_dependency 'create_github_release', '~> 2.1'

data/lib/git/base.rb

@@ -782,6 +782,27 @@ module Git
       shas.map { |sha| gcommit(sha) }
     end
 
+# Returns a Git::Diff::Stats object for accessing diff statistics.
+    #
+    # @param objectish [String] The first commit or object to compare. Defaults to 'HEAD'.
+    # @param obj2 [String, nil] The second commit or object to compare.
+    # @return [Git::Diff::Stats]
+    def diff_stats(objectish = 'HEAD', obj2 = nil)
+      Git::DiffStats.new(self, objectish, obj2)
+    end
+
+    # Returns a Git::Diff::PathStatus object for accessing the name-status report.
+    #
+    # @param objectish [String] The first commit or object to compare. Defaults to 'HEAD'.
+    # @param obj2 [String, nil] The second commit or object to compare.
+    # @return [Git::Diff::PathStatus]
+    def diff_path_status(objectish = 'HEAD', obj2 = nil)
+      Git::DiffPathStatus.new(self, objectish, obj2)
+    end
+
+    # Provided for backwards compatibility
+    alias diff_name_status diff_path_status
+
     private
 
     # Normalize options before they are sent to Git::Base.new

data/lib/git/command_line.rb

@@ -192,8 +192,13 @@ module Git
     def run(*args, out: nil, err: nil, normalize:, chomp:, merge:, chdir: nil, timeout: nil)
       git_cmd = build_git_cmd(args)
       begin
-        result = ProcessExecuter.run(env, *git_cmd, out: out, err: err, merge:, chdir: (chdir || :not_set), timeout: timeout, raise_errors: false)
-      rescue ProcessExecuter::Command::ProcessIOError => e
+        options = { chdir: (chdir || :not_set), timeout_after: timeout, raise_errors: false }
+        options[:out] = out unless out.nil?
+        options[:err] = err unless err.nil?
+        options[:merge_output] = merge unless merge.nil?
+
+        result = ProcessExecuter.run_with_capture(env, *git_cmd, **options)
+      rescue ProcessExecuter::ProcessIOError => e
         raise Git::ProcessIOError.new(e.message), cause: e.exception.cause
       end
       process_result(result, normalize, chomp, timeout)
@@ -274,14 +279,10 @@ module Git
     # @api private
     #
     def post_process(raw_output, normalize, chomp)
-      if raw_output.respond_to?(:string)
-        output = raw_output.string.dup
-        output = output.lines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join if normalize
-        output.chomp! if chomp
-        output
-      else
-        nil
-      end
+      output = raw_output.dup
+      output = output.lines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join if normalize
+      output.chomp! if chomp
+      output
     end
   end
 end

data/lib/git/command_line_result.rb

@@ -19,15 +19,21 @@ module Git
     #   result = Git::CommandLineResult.new(git_cmd, status, stdout, stderr)
     #
     # @param git_cmd [Array<String>] the git command that was executed
-    # @param status [Process::Status] the status of the process
-    # @param stdout [String] the output of the process
-    # @param stderr [String] the error output of the process
+    # @param status [ProcessExecuter::ResultWithCapture] the status of the process
+    # @param stdout [String] the processed stdout of the process
+    # @param stderr [String] the processed stderr of the process
     #
     def initialize(git_cmd, status, stdout, stderr)
       @git_cmd = git_cmd
       @status = status
       @stdout = stdout
       @stderr = stderr
+
+      # ProcessExecuter::ResultWithCapture changed the timeout? method to timed_out?
+      # in version 4.x. This is a compatibility layer to maintain the old method name
+      # for backward compatibility.
+      #
+      status.define_singleton_method(:timeout?) { timed_out? }
     end
 
     # @attribute [r] git_cmd

data/lib/git/diff.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-module Git
+require_relative 'diff_path_status'
+require_relative 'diff_stats'
 
-  # object that holds the last X commits on given branch
+module Git
+  # object that holds the diff between two commits
   class Diff
     include Enumerable
 
@@ -12,63 +14,68 @@ module Git
       @to = to && to.to_s
 
       @path = nil
-      @full_diff = nil
       @full_diff_files = nil
-      @stats = nil
     end
     attr_reader :from, :to
 
-    def name_status
-      cache_name_status
-    end
-
     def path(path)
       @path = path
-      return self
+      self
     end
 
-    def size
-      cache_stats
-      @stats[:total][:files]
+    def patch
+      @base.lib.diff_full(@from, @to, { path_limiter: @path })
     end
+    alias_method :to_s, :patch
 
-    def lines
-      cache_stats
-      @stats[:total][:lines]
+    def [](key)
+      process_full
+      @full_diff_files.assoc(key)[1]
     end
 
-    def deletions
-      cache_stats
-      @stats[:total][:deletions]
+    def each(&block)
+      process_full
+      @full_diff_files.map { |file| file[1] }.each(&block)
     end
 
-    def insertions
-      cache_stats
-      @stats[:total][:insertions]
+    #
+    # DEPRECATED METHODS
+    #
+
+    def name_status
+      Git::Deprecation.warn("Git::Diff#name_status is deprecated. Use Git::Base#diff_path_status instead.")
+      path_status_provider.to_h
     end
 
-    def stats
-      cache_stats
-      @stats
+    def size
+      Git::Deprecation.warn("Git::Diff#size is deprecated. Use Git::Base#diff_stats(...).total[:files] instead.")
+      stats_provider.total[:files]
     end
 
-    # if file is provided and is writable, it will write the patch into the file
-    def patch(file = nil)
-      cache_full
-      @full_diff
+
+
+    def lines
+      Git::Deprecation.warn("Git::Diff#lines is deprecated. Use Git::Base#diff_stats(...).lines instead.")
+      stats_provider.lines
     end
-    alias_method :to_s, :patch
 
-    # enumerable methods
+    def deletions
+      Git::Deprecation.warn("Git::Diff#deletions is deprecated. Use Git::Base#diff_stats(...).deletions instead.")
+      stats_provider.deletions
+    end
 
-    def [](key)
-      process_full
-      @full_diff_files.assoc(key)[1]
+    def insertions
+      Git::Deprecation.warn("Git::Diff#insertions is deprecated. Use Git::Base#diff_stats(...).insertions instead.")
+      stats_provider.insertions
     end
 
-    def each(&block) # :yields: each Git::DiffFile in turn
-      process_full
-      @full_diff_files.map { |file| file[1] }.each(&block)
+    def stats
+      Git::Deprecation.warn("Git::Diff#stats is deprecated. Use Git::Base#diff_stats instead.")
+      # CORRECTED: Re-create the original hash structure for backward compatibility
+      {
+        files: stats_provider.files,
+        total: stats_provider.total
+      }
     end
 
     class DiffFile
@@ -102,56 +109,48 @@ module Git
 
     private
 
-      def cache_full
-        @full_diff ||= @base.lib.diff_full(@from, @to, {:path_limiter => @path})
-      end
-
-      def process_full
-        return if @full_diff_files
-        cache_full
-        @full_diff_files = process_full_diff
-      end
+    def process_full
+      return if @full_diff_files
+      @full_diff_files = process_full_diff
+    end
 
-      def cache_stats
-        @stats ||=  @base.lib.diff_stats(@from, @to, {:path_limiter => @path})
-      end
+    # CORRECTED: Pass the @path variable to the new objects
+    def path_status_provider
+      @path_status_provider ||= Git::DiffPathStatus.new(@base, @from, @to, @path)
+    end
 
-      def cache_name_status
-        @name_status ||= @base.lib.diff_name_status(@from, @to, {:path => @path})
-      end
+    # CORRECTED: Pass the @path variable to the new objects
+    def stats_provider
+      @stats_provider ||= Git::DiffStats.new(@base, @from, @to, @path)
+    end
 
-      # break up @diff_full
-      def process_full_diff
-        defaults = {
-          :mode => '',
-          :src => '',
-          :dst => '',
-          :type => 'modified'
-        }
-        final = {}
-        current_file = nil
-        @full_diff.split("\n").each do |line|
-          if m = %r{\Adiff --git ("?)a/(.+?)\1 ("?)b/(.+?)\3\z}.match(line)
-            current_file = Git::EscapedPath.new(m[2]).unescape
-            final[current_file] = defaults.merge({:patch => line, :path => current_file})
-          else
-            if m = /^index ([0-9a-f]{4,40})\.\.([0-9a-f]{4,40})( ......)*/.match(line)
-              final[current_file][:src] = m[1]
-              final[current_file][:dst] = m[2]
-              final[current_file][:mode] = m[3].strip if m[3]
-            end
-            if m = /^([[:alpha:]]*?) file mode (......)/.match(line)
-              final[current_file][:type] = m[1]
-              final[current_file][:mode] = m[2]
-            end
-            if m = /^Binary files /.match(line)
-              final[current_file][:binary] = true
-            end
-            final[current_file][:patch] << "\n" + line
+    def process_full_diff
+      defaults = {
+        mode: '', src: '', dst: '', type: 'modified'
+      }
+      final = {}
+      current_file = nil
+      patch.split("\n").each do |line|
+        if m = %r{\Adiff --git ("?)a/(.+?)\1 ("?)b/(.+?)\3\z}.match(line)
+          current_file = Git::EscapedPath.new(m[2]).unescape
+          final[current_file] = defaults.merge({ patch: line, path: current_file })
+        else
+          if m = /^index ([0-9a-f]{4,40})\.\.([0-9a-f]{4,40})( ......)*/.match(line)
+            final[current_file][:src] = m[1]
+            final[current_file][:dst] = m[2]
+            final[current_file][:mode] = m[3].strip if m[3]
+          end
+          if m = /^([[:alpha:]]*?) file mode (......)/.match(line)
+            final[current_file][:type] = m[1]
+            final[current_file][:mode] = m[2]
+          end
+          if m = /^Binary files /.match(line)
+            final[current_file][:binary] = true
           end
+          final[current_file][:patch] << "\n" + line
         end
-        final.map { |e| [e[0], DiffFile.new(@base, e[1])] }
       end
-
+      final.map { |e| [e[0], DiffFile.new(@base, e[1])] }
+    end
   end
 end

data/lib/git/diff_path_status.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Git
+  class DiffPathStatus
+    include Enumerable
+
+    # @private
+    def initialize(base, from, to, path_limiter = nil)
+      # Eagerly check for invalid arguments
+      [from, to].compact.each do |arg|
+        raise ArgumentError, "Invalid argument: '#{arg}'" if arg.start_with?('-')
+      end
+
+      @base = base
+      @from = from
+      @to = to
+      @path_limiter = path_limiter
+      @path_status = nil
+    end
+
+    # Iterates over each file's status.
+    #
+    # @yield [path, status]
+    def each(&block)
+      fetch_path_status.each(&block)
+    end
+
+    # Returns the name-status report as a Hash.
+    #
+    # @return [Hash<String, String>] A hash where keys are file paths
+    #   and values are their status codes.
+    def to_h
+      fetch_path_status
+    end
+
+    private
+
+    # Lazily fetches and caches the path status from the git lib.
+    def fetch_path_status
+      @path_status ||= @base.lib.diff_path_status(
+        @from, @to, { path: @path_limiter }
+      )
+    end
+  end
+end

data/lib/git/diff_stats.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Git
+  # Provides access to the statistics of a diff between two commits,
+  # including insertions, deletions, and file-level details.
+  class DiffStats
+    # @private
+    def initialize(base, from, to, path_limiter = nil)
+      # Eagerly check for invalid arguments
+      [from, to].compact.each do |arg|
+        raise ArgumentError, "Invalid argument: '#{arg}'" if arg.start_with?('-')
+      end
+
+      @base = base
+      @from = from
+      @to = to
+      @path_limiter = path_limiter
+      @stats = nil
+    end
+
+    # Returns the total number of lines deleted.
+    def deletions
+      fetch_stats[:total][:deletions]
+    end
+
+    # Returns the total number of lines inserted.
+    def insertions
+      fetch_stats[:total][:insertions]
+    end
+
+    # Returns the total number of lines changed (insertions + deletions).
+    def lines
+      fetch_stats[:total][:lines]
+    end
+
+    # Returns a hash of statistics for each file in the diff.
+    #
+    # @return [Hash<String, {insertions: Integer, deletions: Integer}>]
+    def files
+      fetch_stats[:files]
+    end
+
+    # Returns a hash of the total statistics for the diff.
+    #
+    # @return [{insertions: Integer, deletions: Integer, lines: Integer, files: Integer}]
+    def total
+      fetch_stats[:total]
+    end
+
+    private
+
+    # Lazily fetches and caches the stats from the git lib.
+    def fetch_stats
+      @stats ||= @base.lib.diff_stats(
+        @from, @to, { path_limiter: @path_limiter }
+      )
+    end
+  end
+end

data/lib/git/lib.rb

@@ -217,7 +217,7 @@ module Git
 
       arr_opts << commit_ish if commit_ish
 
-      return command('describe', *arr_opts)
+      command('describe', *arr_opts)
     end
 
     # Return the commits that are within the given revision range
@@ -472,7 +472,7 @@ module Git
 
       hsh['message'] = data.join("\n") + "\n"
 
-      return hsh
+      hsh
     end
 
     CAT_FILE_HEADER_LINE = /\A(?<key>\w+) (?<value>.*)\z/
@@ -543,7 +543,7 @@ module Git
 
       hsh['message'] = data.join("\n") + "\n"
 
-      return hsh
+      hsh
     end
 
     def process_commit_log_data(data)
@@ -584,7 +584,7 @@ module Git
 
       hsh_array << hsh if hsh
 
-      return hsh_array
+      hsh_array
     end
 
     def ls_tree(sha, opts = {})
@@ -758,7 +758,7 @@ module Git
           :unborn
         end
 
-      return HeadState.new(state, branch_name)
+      HeadState.new(state, branch_name)
     end
 
     def branch_current
@@ -848,7 +848,7 @@ module Git
       hsh
     end
 
-    def diff_name_status(reference1 = nil, reference2 = nil, opts = {})
+    def diff_path_status(reference1 = nil, reference2 = nil, opts = {})
       assert_args_are_not_options('commit or commit range', reference1, reference2)
 
       opts_arr = ['--name-status']
@@ -1488,7 +1488,7 @@ module Git
           gz.write(file_content)
         end
       end
-      return file
+      file
     end
 
     # returns the current version of git, as an Array of Fixnums.

data/lib/git/log.rb

@@ -6,13 +6,13 @@ module Git
   #
   # @example The last (default number) of commits
   #   git = Git.open('.')
-  #   Git::Log.new(git) #=> Enumerable of the last 30 commits
+  #   Git::Log.new(git).execute #=> Enumerable of the last 30 commits
   #
   # @example The last n commits
-  #   Git::Log.new(git).max_commits(50) #=> Enumerable of last 50 commits
+  #   Git::Log.new(git).max_commits(50).execute #=> Enumerable of last 50 commits
   #
   # @example All commits returned by `git log`
-  #   Git::Log.new(git).max_count(:all) #=> Enumerable of all commits
+  #   Git::Log.new(git).max_count(:all).execute #=> Enumerable of all commits
   #
   # @example All commits that match complex criteria
   #   Git::Log.new(git)
@@ -20,12 +20,62 @@ module Git
   #     .object('README.md')
   #     .since('10 years ago')
   #     .between('v1.0.7', 'HEAD')
+  #     .execute
   #
   # @api public
   #
   class Log
     include Enumerable
 
+    # An immutable collection of commits returned by Git::Log#execute
+    #
+    # This object is an Enumerable that contains Git::Object::Commit objects.
+    # It provides methods to access the commit data without executing any
+    # further git commands.
+    #
+    # @api public
+    class Result
+      include Enumerable
+
+      # @private
+      def initialize(commits)
+        @commits = commits
+      end
+
+      # @return [Integer] the number of commits in the result set
+      def size
+        @commits.size
+      end
+
+      # Iterates over each commit in the result set
+      #
+      # @yield [Git::Object::Commit]
+      def each(&block)
+        @commits.each(&block)
+      end
+
+      # @return [Git::Object::Commit, nil] the first commit in the result set
+      def first
+        @commits.first
+      end
+
+      # @return [Git::Object::Commit, nil] the last commit in the result set
+      def last
+        @commits.last
+      end
+
+      # @param index [Integer] the index of the commit to return
+      # @return [Git::Object::Commit, nil] the commit at the given index
+      def [](index)
+        @commits[index]
+      end
+
+      # @return [String] a string representation of the log
+      def to_s
+        map { |c| c.to_s }.join("\n")
+      end
+    end
+
     # Create a new Git::Log object
     #
     # @example
@@ -44,6 +94,25 @@ module Git
       max_count(max_count)
     end
 
+    # Executes the git log command and returns an immutable result object.
+    #
+    # This is the preferred way to get log data. It separates the query
+    # building from the execution, making the API more predictable.
+    #
+    # @example
+    #   query = g.log.since('2 weeks ago').author('Scott')
+    #   results = query.execute
+    #   puts "Found #{results.size} commits"
+    #   results.each do |commit|
+    #     # ...
+    #   end
+    #
+    # @return [Git::Log::Result] an object containing the log results
+    def execute
+      run_log
+      Result.new(@commits)
+    end
+
     # The maximum number of commits to return
     #
     # @example All commits returned by `git log`
@@ -82,90 +151,97 @@ module Git
     def object(objectish)
       dirty_log
       @object = objectish
-      return self
+      self
     end
 
     def author(regex)
       dirty_log
       @author = regex
-      return self
+      self
     end
 
     def grep(regex)
       dirty_log
       @grep = regex
-      return self
+      self
     end
 
     def path(path)
       dirty_log
       @path = path
-      return self
+      self
     end
 
     def skip(num)
       dirty_log
       @skip = num
-      return self
+      self
     end
 
     def since(date)
       dirty_log
       @since = date
-      return self
+      self
     end
 
     def until(date)
       dirty_log
       @until = date
-      return self
+      self
     end
 
     def between(sha1, sha2 = nil)
       dirty_log
       @between = [sha1, sha2]
-      return self
+      self
     end
 
     def cherry
       dirty_log
       @cherry = true
-      return self
+      self
     end
 
     def merges
       dirty_log
       @merges = true
-      return self
+      self
     end
 
     def to_s
-      self.map { |c| c.to_s }.join("\n")
+      deprecate_method(__method__)
+      check_log
+      @commits.map { |c| c.to_s }.join("\n")
     end
 
     # forces git log to run
 
     def size
+      deprecate_method(__method__)
       check_log
       @commits.size rescue nil
     end
 
     def each(&block)
+      deprecate_method(__method__)
       check_log
       @commits.each(&block)
     end
 
     def first
+      deprecate_method(__method__)
       check_log
       @commits.first rescue nil
     end
 
     def last
+      deprecate_method(__method__)
       check_log
       @commits.last rescue nil
     end
 
     def [](index)
+      deprecate_method(__method__)
       check_log
       @commits[index] rescue nil
     end
@@ -173,6 +249,10 @@ module Git
 
     private
 
+      def deprecate_method(method_name)
+        Git::Deprecation.warn("Calling Git::Log##{method_name} is deprecated and will be removed in a future version. Call #execute and then ##{method_name} on the result object.")
+      end
+
       def dirty_log
         @dirty_flag = true
       end

data/lib/git/version.rb

@@ -3,5 +3,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='3.1.1'
+  VERSION='4.0.0'
 end

data/lib/git.rb

@@ -65,7 +65,7 @@ module Git
   end
 
   def self.config
-    return Base.config
+    Base.config
   end
 
   def global_config(name = nil, value = nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +222,8 @@ files:
 - lib/git/command_line_result.rb
 - lib/git/config.rb
 - lib/git/diff.rb
+- lib/git/diff_path_status.rb
+- lib/git/diff_stats.rb
 - lib/git/encoding_utils.rb
 - lib/git/errors.rb
 - lib/git/escaped_path.rb
@@ -248,8 +250,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/3.1.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/3.1.1
+  changelog_uri: https://rubydoc.info/gems/git/4.0.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/4.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -257,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="