git 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f63d19e697e7cc1f9d6f8fed0a34ff32015c5ed24357f183f2493dca636953
-  data.tar.gz: 8e7619c86fee8af92c11d60c6af450e3814bbf77d456fcb3c6d3c914d985403f
+  metadata.gz: edf8c0ca68f2c4a5e2ecd4a72cfc49bf30edf8406bd7016ebd8e96e8bb016065
+  data.tar.gz: 76c74e062482a50b780c3af13767e5bbd9d361f7fe4aad44c593d11de53a3acf
 SHA512:
-  metadata.gz: 1f003e0ea707da5dc4a164c041407802650390e6a03b496d1960994dfd79cae393ab16da3ed062b0cbeaa6839e7d21931d8e9954d7c19fb8ec25cbbfb0f46fa7
-  data.tar.gz: 552efec7c3d8b2e09cfa1c943666e72a3d8aaa336a64252c7d955412cef092c5aede3e87ca7f17df0e8f673a9ed3b35cafcfcf04912b5c8e65ad0082ac415f46
+  metadata.gz: 49d11d3ae7d6a26365c594381f94d426130fa3d62c819d575b1b8868fa9af3f83b42ba81b0a9404e3aeedc422962f13d6f10203bdfd2074e9e9fbc36c1fc3422
+  data.tar.gz: bf6e926d267120715fbfef1d2008dc3f4951130cdfe6266203caceb9fe63bd55c02282b0798a39c3917ea927af6215da805253eb85210a35a531bc066e62ed78

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 node_modules
 package-lock.json
 ai-prompt.erb
+rubocop-report.json

data/.release-please-manifest.json

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

data/.rubocop.yml

@@ -0,0 +1,51 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+
+# Don't care about complexity offenses in the TestUnit tests This exclusions
+# will be removed when we switch to RSpec.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+
+Metrics/AbcSize:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+
+# Don't care so much about length of methods in tests
+Metrics/MethodLength:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+
+# Allow test data to have long lines
+Layout/LineLength:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+    - "*.gemspec"
+
+# Testing and gemspec DSL results in large blocks
+Metrics/BlockLength:
+  Exclude:
+    - "tests/test_helper.rb"
+    - "tests/units/**/*"
+    - "*.gemspec"
+
+# Don't force every test class to be described
+Style/Documentation:
+  Exclude:
+    - "tests/units/**/*"
+
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
+  TargetRubyVersion: 3.2

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-07-06 21:08:14 UTC using RuboCop version 1.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 1032

data/CHANGELOG.md

@@ -5,6 +5,63 @@
 
 # Change Log
 
+## [4.0.2](https://github.com/ruby-git/ruby-git/compare/v4.0.1...v4.0.2) (2025-07-08)
+
+
+### Bug Fixes
+
+* Call Git::Index#new correctly from initialize_components ([07dfab5](https://github.com/ruby-git/ruby-git/commit/07dfab5804874cbc52469bd40203b6d0b08be7a1))
+
+
+### Other Changes
+
+* Announce that the project has adopted RuboCop ([3d6cac9](https://github.com/ruby-git/ruby-git/commit/3d6cac94b47b3c1b1915f5c37f9e811041210ddc))
+* Update comment to be accurate ([3a87722](https://github.com/ruby-git/ruby-git/commit/3a87722760176db54dfef9631de6191b183ab223))
+
+## [4.0.1](https://github.com/ruby-git/ruby-git/compare/v4.0.0...v4.0.1) (2025-07-06)
+
+
+### Bug Fixes
+
+* Fix Rubocop Layout/LineLength offense ([52d80ac](https://github.com/ruby-git/ruby-git/commit/52d80ac592d9139655d47af8e764eebf8577fda7))
+* Fix Rubocop Lint/EmptyBlock offense ([9081f0f](https://github.com/ruby-git/ruby-git/commit/9081f0fb055e0d6cc693fd8f8bf47b2fa13efef0))
+* Fix Rubocop Lint/MissingSuper offense ([e9e91a8](https://github.com/ruby-git/ruby-git/commit/e9e91a88fc338944b816ee6929cadf06ff1daab5))
+* Fix Rubocop Lint/StructNewOverride offense ([141c2cf](https://github.com/ruby-git/ruby-git/commit/141c2cfd8215f5120f536f78b3c066751d74aabe))
+* Fix Rubocop Lint/SuppressedException offense ([4372a20](https://github.com/ruby-git/ruby-git/commit/4372a20b0b61e862efb7558f2274769ae17aa2c9))
+* Fix Rubocop Lint/UselessConstantScoping offense ([54c4a3b](https://github.com/ruby-git/ruby-git/commit/54c4a3bba206ab379a0849fbc9478db5b61e192a))
+* Fix Rubocop Metrics/AbcSize offense ([256d860](https://github.com/ruby-git/ruby-git/commit/256d8602a4024d1fbe432eda8bbcb1891fb726bc))
+* Fix Rubocop Metrics/BlockLength offense ([9c856ba](https://github.com/ruby-git/ruby-git/commit/9c856ba42d0955cb6c3f5848f9c3253b54fd3735))
+* Fix Rubocop Metrics/ClassLength offense (exclude tests) ([d70c800](https://github.com/ruby-git/ruby-git/commit/d70c800263ff1347109688dbb5b66940c6d64f2c))
+* Fix Rubocop Metrics/ClassLength offense (refactor Git::Log) ([1aae57a](https://github.com/ruby-git/ruby-git/commit/1aae57a631aa331a84c37122ffc8fa09b415c6c5))
+* Fix Rubocop Metrics/ClassLength offense (refactor Git::Status) ([e3a378b](https://github.com/ruby-git/ruby-git/commit/e3a378b6384bf1d0dc80ebc5aea792f9ff5b512a))
+* Fix Rubocop Metrics/CyclomaticComplexity offense ([abfcf94](https://github.com/ruby-git/ruby-git/commit/abfcf948a08578635f7e832c31deaf992e6f3fb1))
+* Fix Rubocop Metrics/MethodLength offense ([e708c36](https://github.com/ruby-git/ruby-git/commit/e708c3673321bdcae13516bd63f3c5d051b3ba33))
+* Fix Rubocop Metrics/ParameterLists offense ([c7946b0](https://github.com/ruby-git/ruby-git/commit/c7946b089aba648d0e56a7435f85ed337e33d116))
+* Fix Rubocop Metrics/PerceivedComplexity offense ([5dd5e0c](https://github.com/ruby-git/ruby-git/commit/5dd5e0c55fd37bb4baf3cf196f752a4f6c142ca7))
+* Fix Rubocop Naming/AccessorMethodName offense ([e9d9c4f](https://github.com/ruby-git/ruby-git/commit/e9d9c4f2488d2527176b87c547caecfae4040219))
+* Fix Rubocop Naming/HeredocDelimiterNaming offense ([b4297a5](https://github.com/ruby-git/ruby-git/commit/b4297a54ef4a0106e9786d10230a7219dcdbf0e8))
+* Fix Rubocop Naming/PredicateMethod offense ([d33f7a8](https://github.com/ruby-git/ruby-git/commit/d33f7a8969ef1bf47adbca16589021647d5d2bb9))
+* Fix Rubocop Naming/PredicatePrefix offense ([57edc79](https://github.com/ruby-git/ruby-git/commit/57edc7995750b8c1f792bcae480b9082e86d14d3))
+* Fix Rubocop Naming/VariableNumber offense ([3fba6fa](https://github.com/ruby-git/ruby-git/commit/3fba6fa02908c632891c67f32ef7decc388e8147))
+* Fix Rubocop Style/ClassVars offense ([a2f651a](https://github.com/ruby-git/ruby-git/commit/a2f651aea60e43b9b41271f03fe6cb6c4ef12b70))
+* Fix Rubocop Style/Documentation offense ([e80c27d](https://github.com/ruby-git/ruby-git/commit/e80c27dbb50b38e71db55187ce1a630682d2ef3b))
+* Fix Rubocop Style/IfUnlessModifier offense ([c974832](https://github.com/ruby-git/ruby-git/commit/c97483239e64477adab4ad047c094401ea008591))
+* Fix Rubocop Style/MultilineBlockChain offense ([dd4e4ec](https://github.com/ruby-git/ruby-git/commit/dd4e4ecf0932ab02fa58ebe7a4189b44828729f5))
+* Fix Rubocop Style/OptionalBooleanParameter offense ([c010a86](https://github.com/ruby-git/ruby-git/commit/c010a86cfc265054dc02ab4b7d778e4ba7e5426c))
+* Fix typo in status.rb ([284fae7](https://github.com/ruby-git/ruby-git/commit/284fae7d3606724325ec21b0da7794d9eae2f0bd))
+* Remove duplicate methods found by rubocop ([bd691c5](https://github.com/ruby-git/ruby-git/commit/bd691c58e3312662f07f8f96a1b48a7533f9a2e1))
+* Result of running rake rubocop:autocorrect ([8f1e3bb](https://github.com/ruby-git/ruby-git/commit/8f1e3bb25fb4567093e9b49af42847a918d7d0c4))
+* Result of running rake rubocop:autocorrect_all ([5c75783](https://github.com/ruby-git/ruby-git/commit/5c75783c0f50fb48d59012176cef7e985f7f83e2))
+
+
+### Other Changes
+
+* Add rubocop todo file to silence known offenses until they can be fixed ([2c36f8c](https://github.com/ruby-git/ruby-git/commit/2c36f8c9eb8ff14defe8f6fff1b6eb81d277f620))
+* Avoid deprecated dsa for tests keys ([1da8c28](https://github.com/ruby-git/ruby-git/commit/1da8c2894b727757a909d015fb5a4bcd00133f59))
+* Fix yarddoc error caused by rubocop autocorrect ([58c4af3](https://github.com/ruby-git/ruby-git/commit/58c4af3513df3c854e49380adfe5685023275684))
+* Integrate Rubocop with the project ([a04297d](https://github.com/ruby-git/ruby-git/commit/a04297d8d6568691b71402d9dbba36c45427ebc3))
+* Rename Gem::Specification variable from s to spec ([4d976c4](https://github.com/ruby-git/ruby-git/commit/4d976c443c3a3cf25cc2fec7caa213ae7f090853))
+
 ## [4.0.0](https://github.com/ruby-git/ruby-git/compare/v3.1.1...v4.0.0) (2025-07-02)
 
 

data/README.md

@@ -11,6 +11,7 @@
 [![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=main)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 
+- [📢 We Now Use RuboCop 📢](#-we-now-use-rubocop-)
 - [📢 Default Branch Rename 📢](#-default-branch-rename-)
 - [📢 We've Switched to Conventional Commits 📢](#-weve-switched-to-conventional-commits-)
 - [Summary](#summary)
@@ -23,6 +24,30 @@
 - [Ruby version support policy](#ruby-version-support-policy)
 - [License](#license)
 
+## 📢 We Now Use RuboCop 📢
+
+To improve code consistency and maintainability, the `ruby-git` project has now
+adopted [RuboCop](https://rubocop.org/) as our static code analyzer and formatter.
+
+This integration is a key part of our ongoing commitment to making `ruby-git` a
+high-quality, stable, and easy-to-contribute-to project. All new contributions will
+be expected to adhere to the style guidelines enforced by our RuboCop configuration.
+
+ RuboCop can be run from the project's Rakefile:
+
+```shell
+rake rubocop
+```
+
+RuboCop is also run  as part of the default rake task (by running `rake`) that is run
+in our Continuous Integration workflow.
+
+Going forward, any PRs that have any Robocop offenses will not be merged. In
+certain rare cases, it might be acceptable to disable a  RuboCop check for the most
+limited scope possible.
+
+If you have a problem fixing a  RuboCop offense, don't be afraid to ask a contributor.
+
 ## 📢 Default Branch Rename 📢
 
 On June 6th, 2025, the default branch was renamed from 'master' to 'main'.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'English'
 
@@ -12,12 +14,22 @@ task :test do
   # You can run individual test files (or multiple files) from the command
   # line with:
   #
-  # $ bin/test tests/units/test_archive.rb
+  # $ bin/test test_archive.rb
   #
-  # $ bin/test tests/units/test_archive.rb tests/units/test_object.rb
+  # $ bin/test test_archive.rb test_object.rb
 end
 default_tasks << :test
 
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+default_tasks << :rubocop
+
+# YARD
+
 unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
   #
   # YARD documentation for this project can NOT be built with JRuby.
@@ -51,7 +63,7 @@ default_tasks << :build
 task default: default_tasks
 
 desc 'Build and install the git gem and run a sanity check'
-task :'test:gem' => :install do
+task 'test:gem': :install do
   output = `ruby -e "require 'git'; g = Git.open('.'); puts g.log.size"`.chomp
   raise 'Gem test failed' unless $CHILD_STATUS.success?
   raise 'Expected gem test to return an integer' unless output =~ /^\d+$/

data/git.gemspec

@@ -1,52 +1,57 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'git/version'
 
-Gem::Specification.new do |s|
-  s.author = 'Scott Chacon and others'
-  s.email = 'schacon@gmail.com'
-  s.homepage = 'http://github.com/ruby-git/ruby-git'
-  s.license = 'MIT'
-  s.name = 'git'
-  s.summary = 'An API to create, read, and manipulate Git repositories'
-  s.description = <<~DESCRIPTION
+Gem::Specification.new do |spec|
+  spec.author = 'Scott Chacon and others'
+  spec.email = 'schacon@gmail.com'
+  spec.homepage = 'http://github.com/ruby-git/ruby-git'
+  spec.license = 'MIT'
+  spec.name = 'git'
+  spec.summary = 'An API to create, read, and manipulate Git repositories'
+  spec.description = <<~DESCRIPTION
     The git gem provides an API that can be used to
     create, read, and manipulate Git repositories by wrapping system calls to the git
     command line. The API can be used for working with Git in complex interactions
     including branching and merging, object inspection and manipulation, history, patch
     generation and more.
   DESCRIPTION
-  s.version = Git::VERSION
+  spec.version = Git::VERSION
 
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md"
+  spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  s.metadata['homepage_uri'] = s.homepage
-  s.metadata['source_code_uri'] = s.homepage
-  s.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}/file/CHANGELOG.md"
-  s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}"
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 3.2.0'
+  spec.requirements = ['git 2.28.0 or greater']
 
-  s.require_paths = ['lib']
-  s.required_ruby_version = '>= 3.2.0'
-  s.requirements = ['git 2.28.0 or greater']
+  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_dependency 'addressable', '~> 2.8'
+  spec.add_dependency 'process_executer', '~> 4.0'
+  spec.add_dependency 'rchardet', '~> 1.9'
 
-  s.add_runtime_dependency 'activesupport', '>= 5.0'
-  s.add_runtime_dependency 'addressable', '~> 2.8'
-  s.add_runtime_dependency 'process_executer', '~> 4.0'
-  s.add_runtime_dependency 'rchardet', '~> 1.9'
+  spec.add_development_dependency 'create_github_release', '~> 2.1'
+  spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'
+  spec.add_development_dependency 'minitar', '~> 1.0'
+  spec.add_development_dependency 'mocha', '~> 2.7'
+  spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'rubocop', '~> 1.77'
 
-  s.add_development_dependency 'create_github_release', '~> 2.1'
-  s.add_development_dependency 'minitar', '~> 1.0'
-  s.add_development_dependency 'mocha', '~> 2.7'
-  s.add_development_dependency 'rake', '~> 13.2'
-  s.add_development_dependency 'test-unit', '~> 3.6'
+  spec.add_development_dependency 'test-unit', '~> 3.6'
 
   unless RUBY_PLATFORM == 'java'
-    s.add_development_dependency 'redcarpet', '~> 3.6'
-    s.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
-    s.add_development_dependency 'yardstick', '~> 0.9'
+    spec.add_development_dependency 'redcarpet', '~> 3.6'
+    spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
+    spec.add_development_dependency 'yardstick', '~> 0.9'
   end
 
   # 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.
-  s.files = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tests|spec|features|bin)/}) }
   end
 end

data/lib/git/args_builder.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Git
+  # Takes a hash of user options and a declarative map and produces
+  # an array of command-line arguments. Also validates that only
+  # supported options are provided based on the map.
+  #
+  # @api private
+  class ArgsBuilder
+    # This hash maps an option type to a lambda that knows how to build the
+    # corresponding command-line argument. This is a scalable dispatch table.
+    ARG_BUILDERS = {
+      boolean: ->(config, value) { value ? config[:flag] : [] },
+
+      valued_equals: ->(config, value) { "#{config[:flag]}=#{value}" if value },
+
+      valued_space: ->(config, value) { [config[:flag], value.to_s] if value },
+
+      repeatable_valued_space: lambda do |config, value|
+        Array(value).flat_map { |v| [config[:flag], v.to_s] }
+      end,
+
+      custom: ->(config, value) { config[:builder].call(value) },
+
+      validate_only: ->(_config, _value) { [] } # Does not build any args
+    }.freeze
+
+    # Main entrypoint to validate options and build arguments
+    def self.build(opts, option_map)
+      validate!(opts, option_map)
+      new(opts, option_map).build
+    end
+
+    # Public validation method that can be called independently
+    def self.validate!(opts, option_map)
+      validate_unsupported_keys!(opts, option_map)
+      validate_configured_options!(opts, option_map)
+    end
+
+    def initialize(opts, option_map)
+      @opts = opts
+      @option_map = option_map
+    end
+
+    def build
+      @option_map.flat_map do |config|
+        type = config[:type]
+        next config[:flag] if type == :static
+
+        key = config[:keys].find { |k| @opts.key?(k) }
+        next [] unless key
+
+        build_arg_for_option(config, @opts[key])
+      end.compact
+    end
+
+    private
+
+    def build_arg_for_option(config, value)
+      builder = ARG_BUILDERS[config[:type]]
+      builder&.call(config, value) || []
+    end
+
+    private_class_method def self.validate_unsupported_keys!(opts, option_map)
+      all_valid_keys = option_map.flat_map { |config| config[:keys] }.compact
+      unsupported_keys = opts.keys - all_valid_keys
+
+      return if unsupported_keys.empty?
+
+      raise ArgumentError, "Unsupported options: #{unsupported_keys.map(&:inspect).join(', ')}"
+    end
+
+    private_class_method def self.validate_configured_options!(opts, option_map)
+      option_map.each do |config|
+        next unless config[:keys] # Skip static flags
+
+        check_for_missing_required_option!(opts, config)
+        validate_option_value!(opts, config)
+      end
+    end
+
+    private_class_method def self.check_for_missing_required_option!(opts, config)
+      return unless config[:required]
+
+      key_provided = config[:keys].any? { |k| opts.key?(k) }
+      return if key_provided
+
+      raise ArgumentError, "Missing required option: #{config[:keys].first}"
+    end
+
+    private_class_method def self.validate_option_value!(opts, config)
+      validator = config[:validator]
+      return unless validator
+
+      user_key = config[:keys].find { |k| opts.key?(k) }
+      return unless user_key # Don't validate if the user didn't provide the option
+
+      return if validator.call(opts[user_key])
+
+      raise ArgumentError, "Invalid value for option: #{user_key}"
+    end
+  end
+end

data/lib/git/author.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 module Git
+  # An author in a Git commit
   class Author
     attr_accessor :name, :email, :date
 
     def initialize(author_string)
-      if m = /(.*?) <(.*?)> (\d+) (.*)/.match(author_string)
-        @name = m[1]
-        @email = m[2]
-        @date = Time.at(m[3].to_i)
-      end
+      return unless (m = /(.*?) <(.*?)> (\d+) (.*)/.match(author_string))
+
+      @name = m[1]
+      @email = m[2]
+      @date = Time.at(m[3].to_i)
     end
   end
 end