fix: fix Rubocop Style/OptionalBooleanParameter offense

jcouball · jcouball · commit c010a86cfc26 · 2025-07-03T16:10:33.000-07:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -6,16 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 5
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/git/base.rb'
-    - 'lib/git/object.rb'
-    - 'lib/git/path.rb'
-    - 'lib/git/stash.rb'
-
 # Offense count: 64
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -241,14 +241,24 @@ def repo_size
                .sum { |file| File.stat(file).size.to_i }
     end
 
-    def set_index(index_file, check = true)
+    def set_index(index_file, check = nil, must_exist: nil)
+      Git::Deprecation.warn('The "check" argument is deprecated and will be removed in a future version. Use "must_exist:" instead.') unless check.nil?
+
+      # default is true
+      must_exist = must_exist.nil? && check.nil? ? true : must_exist | check
+
       @lib = nil
-      @index = Git::Index.new(index_file.to_s, check)
+      @index = Git::Index.new(index_file.to_s, must_exist:)
     end
 
-    def set_working(work_dir, check = true)
+    def set_working(work_dir, check = nil, must_exist: nil)
+      Git::Deprecation.warn('The "check" argument is deprecated and will be removed in a future version. Use "must_exist:" instead.') unless check.nil?
+
+      # default is true
+      must_exist = must_exist.nil? && check.nil? ? true : must_exist | check
+
       @lib = nil
-      @working_directory = Git::WorkingDirectory.new(work_dir.to_s, check)
+      @working_directory = Git::WorkingDirectory.new(work_dir.to_s, must_exist:)
     end
 
     # returns +true+ if the branch exists locally
@@ -258,7 +268,7 @@ def local_branch?(branch)
     end
 
     def is_local_branch?(branch) # rubocop:disable Naming/PredicatePrefix
-      Git.deprecated('Git::Base#is_local_branch? is deprecated. Use Git::Base#local_branch? instead.')
+      Git.deprecation('Git::Base#is_local_branch? is deprecated. Use Git::Base#local_branch? instead.')
       local_branch?(branch)
     end
 
@@ -759,7 +769,7 @@ def status
 
     # @return [Git::Object::Tag] a tag object
     def tag(tag_name)
-      Git::Object.new(self, tag_name, 'tag', true)
+      Git::Object::Tag.new(self, tag_name)
     end
 
     # Find as good common ancestors as possible for a merge
diff --git a/lib/git/object.rb b/lib/git/object.rb
@@ -251,18 +251,36 @@ def check_commit
     # Annotated tags contain additional metadata such as the tagger's name, email, and
     # the date when the tag was created, along with a message.
     #
+    # TODO: Annotated tags are not objects
+    #
     class Tag < AbstractObject
       attr_accessor :name
 
-      def initialize(base, sha, name)
+      # @overload initialize(base, name)
+      #   @param base [Git::Base] The Git base object
+      #   @param name [String] The name of the tag
+      #
+      # @overload initialize(base, sha, name)
+      #   @param base [Git::Base] The Git base object
+      #   @param sha [String] The SHA of the tag object
+      #   @param name [String] The name of the tag
+      #
+      def initialize(base, sha, name = nil)
+        if name.nil?
+          name = sha
+          sha = base.lib.tag_sha(name)
+          raise Git::UnexpectedResultError, "Tag '#{name}' does not exist." if sha == ''
+        end
+
         super(base, sha)
+
         @name = name
         @annotated = nil
         @loaded = false
       end
 
       def annotated?
-        @annotated ||= (@base.lib.cat_file_type(name) == 'tag')
+        @annotated = @annotated.nil? ? (@base.lib.cat_file_type(name) == 'tag') : @annotated
       end
 
       def message
@@ -298,12 +316,10 @@ def check_tag
 
     # if we're calling this, we don't know what type it is yet
     # so this is our little factory method
-    def self.new(base, objectish, type = nil, is_tag = false)
+    def self.new(base, objectish, type = nil, is_tag = false) # rubocop:disable Style/OptionalBooleanParameter
       if is_tag
-        sha = base.lib.tag_sha(objectish)
-        raise Git::UnexpectedResultError, "Tag '#{objectish}' does not exist." if sha == ''
-
-        return Git::Object::Tag.new(base, sha, objectish)
+        Git::Deprecation.warn('Git::Object.new with is_tag argument is deprecated. Use Git::Object::Tag.new instead.')
+        return Git::Object::Tag.new(base, objectish)
       end
 
       type ||= base.lib.cat_file_type(objectish)
diff --git a/lib/git/path.rb b/lib/git/path.rb
@@ -9,10 +9,15 @@ module Git
   class Path
     attr_accessor :path
 
-    def initialize(path, check_path = true)
+    def initialize(path, check_path = nil, must_exist: nil)
+      Git::Deprecation.warn('The "check_path" argument is deprecated and will be removed in a future version. Use "must_exist:" instead.') unless check_path.nil?
+
+      # default is true
+      must_exist = must_exist.nil? && check_path.nil? ? true : must_exist || check_path
+
       path = File.expand_path(path)
 
-      raise ArgumentError, 'path does not exist', [path] if check_path && !File.exist?(path)
+      raise ArgumentError, 'path does not exist', [path] if must_exist && !File.exist?(path)
 
       @path = path
     end
diff --git a/lib/git/stash.rb b/lib/git/stash.rb
@@ -3,10 +3,15 @@
 module Git
   # A stash in a Git repository
   class Stash
-    def initialize(base, message, existing = false)
+    def initialize(base, message, existing = nil, save: nil)
+      Git::Deprecation.warn('The "existing" argument is deprecated and will be removed in a future version. Use "save:" instead.') unless existing.nil?
+
+      # default is false
+      save = existing.nil? && save.nil? ? false : save | existing
+
       @base = base
       @message = message
-      save unless existing
+      self.save unless save
     end
 
     def save
