ruby-git · jcouball · Jul 8, 2025 · Jul 8, 2025 · Jul 8, 2025 · Jul 8, 2025
diff --git a/lib/git.rb b/lib/git.rb
@@ -4,7 +4,7 @@
 require 'active_support/deprecation'
 
 module Git
-  Deprecation = ActiveSupport::Deprecation.new('3.0', 'Git')
+  Deprecation = ActiveSupport::Deprecation.new('5.0.0', 'Git')
 end
 
 require 'git/author'

diff --git a/lib/git/diff.rb b/lib/git/diff.rb
@@ -38,38 +38,31 @@ def each(&)
       @full_diff_files.map { |file| file[1] }.each(&)
     end
 
+    def size
+      stats_provider.total[:files]
+    end
+
     #
     # 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 size
-      Git::Deprecation.warn('Git::Diff#size is deprecated. Use Git::Base#diff_stats(...).total[:files] instead.')
-      stats_provider.total[:files]
-    end
-
     def lines
-      Git::Deprecation.warn('Git::Diff#lines is deprecated. Use Git::Base#diff_stats(...).lines instead.')
       stats_provider.lines
     end
 
     def deletions
-      Git::Deprecation.warn('Git::Diff#deletions is deprecated. Use Git::Base#diff_stats(...).deletions instead.')
       stats_provider.deletions
     end
 
     def insertions
-      Git::Deprecation.warn('Git::Diff#insertions is deprecated. Use Git::Base#diff_stats(...).insertions instead.')
       stats_provider.insertions
     end
 
     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

diff --git a/lib/git/log.rb b/lib/git/log.rb
@@ -90,28 +90,56 @@ def execute
 
     # @deprecated Use {#execute} and call `each` on the result.
     def each(&)
-      deprecate_and_run
+      Git::Deprecation.warn(
+        'Calling Git::Log#each is deprecated. Call #execute and then #each on the result object.'
+      )
+      run_log_if_dirty
       @commits.each(&)
     end
 
     # @deprecated Use {#execute} and call `size` on the result.
     def size
-      deprecate_and_run
+      Git::Deprecation.warn(
+        'Calling Git::Log#size is deprecated. Call #execute and then #size on the result object.'
+      )
+      run_log_if_dirty
       @commits&.size
     end
 
     # @deprecated Use {#execute} and call `to_s` on the result.
     def to_s
-      deprecate_and_run
+      Git::Deprecation.warn(
+        'Calling Git::Log#to_s is deprecated. Call #execute and then #to_s on the result object.'
+      )
+      run_log_if_dirty
       @commits&.map(&:to_s)&.join("\n")
     end
 
     # @deprecated Use {#execute} and call the method on the result.
-    %i[first last []].each do |method_name|
-      define_method(method_name) do |*args|
-        deprecate_and_run
-        @commits&.public_send(method_name, *args)
-      end
+    def first
+      Git::Deprecation.warn(
+        'Calling Git::Log#first is deprecated. Call #execute and then #first on the result object.'
+      )
+      run_log_if_dirty
+      @commits&.first
+    end
+
+    # @deprecated Use {#execute} and call the method on the result.
+    def last
+      Git::Deprecation.warn(
+        'Calling Git::Log#last is deprecated. Call #execute and then #last on the result object.'
+      )
+      run_log_if_dirty
+      @commits&.last
+    end
+
+    # @deprecated Use {#execute} and call the method on the result.
+    def [](index)
+      Git::Deprecation.warn(
+        'Calling Git::Log#[] is deprecated. Call #execute and then #[] on the result object.'
+      )
+      run_log_if_dirty
+      @commits&.[](index)
     end
 
     # @!endgroup
@@ -131,13 +159,5 @@ def run_log_if_dirty
       @commits = log_data.map { |c| Git::Object::Commit.new(@base, c['sha'], c) }
       @dirty = false
     end
-
-    def deprecate_and_run(method = caller_locations(1, 1)[0].label)
-      Git::Deprecation.warn(
-        "Calling Git::Log##{method} is deprecated. " \
-        "Call #execute and then ##{method} on the result object."
-      )
-      run_log_if_dirty
-    end
   end
 end
diff --git a/lib/git/stashes.rb b/lib/git/stashes.rb
@@ -12,7 +12,7 @@ def initialize(base)
 
       @base.lib.stashes_all.each do |indexed_message|
         _index, message = indexed_message
-        @stashes.unshift(Git::Stash.new(@base, message, true))
+        @stashes.unshift(Git::Stash.new(@base, message, save: true))
       end
     end
 

diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -12,8 +12,19 @@
 $stdout.sync = true
 $stderr.sync = true
 
-# Silence deprecation warnings during tests
-Git::Deprecation.behavior = :silence
+# Make tests that emit a deprecation warning fail
+
+# Deprecation warnings should not be ignored.
+
+# This is important so that:
+# * when a user sees a deprecation warning, they can be confident it is coming from
+#   their code and not this gem
+# * test output is clean and does not contain noisey deprecation warnings
+
+# Tests whose purpose is to test that a deprecation warning is issued in the right
+# circumstance should mock Git::Deprecation#warn to avoid raising an error.
+#
+Git::Deprecation.behavior = :raise
 
 module Test
   module Unit

diff --git a/tests/units/test_base.rb b/tests/units/test_base.rb
@@ -88,20 +88,23 @@ def test_commit
       git.add('test_file_1')
       git.add('test_file_2')
 
-      base_commit_id = git.log[0].objectish
+      commits = git.log.execute
+      base_commit_id = commits[0].objectish
 
       git.commit('Test Commit')
 
-      original_commit_id = git.log[0].objectish
+      commits = git.log.execute
+      original_commit_id = commits[0].objectish
 
       create_file('test_commit/test_file_3', 'content test_file_3')
 
       git.add('test_file_3')
 
       git.commit(nil, amend: true)
 
-      assert(git.log[0].objectish != original_commit_id)
-      assert(git.log[1].objectish == base_commit_id)
+      commits = git.log.execute
+      assert(commits[0].objectish != original_commit_id)
+      assert(commits[1].objectish == base_commit_id)
     end
   end
 end
diff --git a/tests/units/test_commit_with_empty_message.rb b/tests/units/test_commit_with_empty_message.rb
@@ -20,7 +20,8 @@ def test_with_allow_empty_message_option
     Dir.mktmpdir do |dir|
       git = Git.init(dir)
       git.commit('', { allow_empty: true, allow_empty_message: true })
-      assert_equal(1, git.log.to_a.size)
+      commits = git.log.execute
+      assert_equal(1, commits.to_a.size)
     end
   end
 end
diff --git a/tests/units/test_git_dir.rb b/tests/units/test_git_dir.rb
@@ -62,11 +62,13 @@ def test_git_dir_outside_work_tree
         # * the commit was added to the log
         #
         max_log_size = 100
-        assert_equal(64, git.log(max_log_size).size)
+        commits = git.log(max_log_size).execute
+        assert_equal(64, commits.size)
         git.add(file)
         git.commit('This is a new commit')
         assert_equal(false, git.status.changed?(file))
-        assert_equal(65, git.log(max_log_size).size)
+        commits = git.log(max_log_size).execute
+        assert_equal(65, commits.size)
       end
     end
   end

diff --git a/tests/units/test_git_path.rb b/tests/units/test_git_path.rb
@@ -9,18 +9,18 @@ def setup
   end
 
   def test_initalize_with_good_path_and_check_path
-    path = Git::Path.new(@git.index.to_s, true)
+    path = Git::Path.new(@git.index.to_s, must_exist: true)
     assert_equal @git.index.to_s, path.to_s
   end
 
   def test_initialize_with_bad_path_and_check_path
     assert_raises ArgumentError do
-      Git::Path.new('/this path does not exist', true)
+      Git::Path.new('/this path does not exist', must_exist: true)
     end
   end
 
   def test_initialize_with_bad_path_and_no_check
-    path = Git::Path.new('/this path does not exist', false)
+    path = Git::Path.new('/this path does not exist', must_exist: false)
     assert path.to_s.end_with?('/this path does not exist')
 
     assert(path.to_s.match(%r{^(?:[A-Z]:)?/this path does not exist$}))

diff --git a/tests/units/test_index_ops.rb b/tests/units/test_index_ops.rb
@@ -94,9 +94,10 @@ def test_revert
       g.commit('second-commit')
       g.gcommit('HEAD')
 
-      commits = g.log(10_000).count
+      commits = g.log(10_000).execute
       g.revert(first_commit.sha)
-      assert_equal(commits + 1, g.log(10_000).count)
+      commits_after_revert = g.log(10_000).execute
+      assert_equal(commits.count + 1, commits_after_revert.count)
       assert(!File.exist?('test-file2'))
     end
   end