git 5.1.0 → 5.2.0

data/redesign/remote_refactor_plan.md

@@ -1,164 +0,0 @@
-# Plan: RemoteInfo + RemoteOperations API Modernization
-
-> **Note:** Issue #919 fix (`BranchInfo#remote_name` for slash-containing remotes) is
-> deferred to a separate effort and is not part of this plan.
-
-## TL;DR
-
-Three PRs in order:
-
-- **PR 1** (smallest, independent): `remote_add` / `remote_set_url` return `nil`
-- **PR 2** (data layer foundation): `Git::RemoteInfo` value object + `Parsers::Remote`
-- **PR 3** (depends on PR 2): `remote_list` facade method + deprecate `remotes`
-
----
-
-## PR 1 — `remote_add` / `remote_set_url` return `nil` *(independent, smallest)*
-
-**Step A.** `remote_add` — remove `Git::Remote.new(self, name)`, return `nil` explicitly
-- File: `lib/git/repository/remote_operations.rb`
-
-**Step B.** `remote_set_url` — same change
-
-**Step C.** Fix deprecated wrappers (can no longer just forward the return value):
-- `add_remote` → call `remote_add(...)` then `Git::Remote.new(self, name)`
-- `set_remote_url` → call `remote_set_url(...)` then `Git::Remote.new(self, name)`
-
-**Step D.** Update YARD `@return` on `remote_add` and `remote_set_url` to `@return [void]`
-  (per project convention: methods with no meaningful return value use `@return [void]`,
-  matching `remote_set_branches` and other mutation-only methods)
-
-**Step E.** Update specs that assert `remote_add` / `remote_set_url` return a `Git::Remote`
-
-### Files changed in PR 1
-
-- `lib/git/repository/remote_operations.rb`
-- `spec/unit/git/repository/remote_operations_spec.rb`
-
----
-
-## PR 2 — `Git::RemoteInfo` data class + `Parsers::Remote` *(data layer foundation)*
-
-**Step 1.** Create `lib/git/remote_info.rb`:
-
-```ruby
-module Git
-  RemoteInfo = Data.define(
-    :name,            # String — required
-    :url,             # Array<String>
-    :push_url,        # Array<String>
-    :fetch,           # Array<String>
-    :push,            # Array<String>
-    :mirror,          # Boolean | nil
-    :skip_default_update, # Boolean | nil
-    :tag_opt,         # String | nil
-    :prune,           # Boolean | nil  (nil = inherit global fetch.prune)
-    :prune_tags,      # Boolean | nil  (nil = inherit global fetch.pruneTags)
-    :receivepack,     # String | nil
-    :uploadpack,      # String | nil
-    :promisor,        # Boolean | nil
-    :partial_clone_filter, # String | nil
-    :vcs              # String | nil
-  )
-end
-```
-
-- Multi-value fields (`:url`, `:push_url`, `:fetch`, `:push`) are always `Array<String>` (never
-  `nil`; may be empty). All other fields are nilable except `:name`.
-- Use **snake_case** field names throughout
-
-**Step 2.** Create `lib/git/parsers/remote.rb`:
-
-- `Git::Parsers::Remote.parse_list(config_entries)` — accepts an
-  `Array<Git::ConfigEntryInfo>` (as returned by `Git::Configuring#config_list`),
-  groups entries by remote name, and builds `RemoteInfo` objects
-- Using `Array<Git::ConfigEntryInfo>` as input naturally preserves duplicate keys
-  (e.g., multiple `remote.<name>.fetch` refspecs or multiple `url` values),
-  which a flat `Hash{String=>String}` cannot represent
-- Multi-value fields (`:url`, `:push_url`, `:fetch`, `:push`) are collected into arrays
-- Boolean fields are coerced matching git's own boolean rules:
-  - **True values**: `"true"`, `"yes"`, `"on"`, `"1"`, `""` (key present without a value) → `true`
-  - **False values**: `"false"`, `"no"`, `"off"`, `"0"` → `false`
-  - **Absent** (key not present in config at all) → `nil`
-  - **Unrecognized value**: raise `ArgumentError` (mirrors git's fatal error behavior)
-- Config key → Ruby field mapping (for keys that differ from the field name):
-
-| git config key | `RemoteInfo` field |
-|---|---|
-| `url` | `:url` (Array) |
-| `pushurl` | `:push_url` (Array) |
-| `fetch` | `:fetch` (Array) |
-| `push` | `:push` (Array) |
-| `tagOpt` | `:tag_opt` |
-| `partialclonefilter` | `:partial_clone_filter` |
-| `skipDefaultUpdate` | `:skip_default_update` |
-| `pruneTags` | `:prune_tags` |
-| `promisor` | `:promisor` (no case change, but in the mapping table) |
-| `mirror`, `prune`, `receivepack`, `uploadpack`, `vcs` | direct lowercase match |
-
-**Step 3.** Unit tests for `Parsers::Remote`:
-- Single remote with only required fields
-- Remote with multiple URLs and fetch specs
-- Multiple remotes in one config entry array
-- Empty input → empty array
-- Boolean field coercion (true/false/nil/raise on unrecognized value)
-
-### Files changed in PR 2
-
-- `lib/git/remote_info.rb` — new file
-- `lib/git/parsers/remote.rb` — new file
-- `spec/unit/git/remote_info_spec.rb` — new
-- `spec/unit/git/parsers/remote_spec.rb` — new
-
----
-
-## PR 3 — `remote_list` facade method + `remotes` deprecation *(depends on PR 2)*
-
-**Step 4.** Add `remote_list` to `Git::Repository::RemoteOperations`:
-- Calls `config_list` (the `Git::Configuring` instance method, already mixed into
-  `Git::Repository`) to get all config entries as `Array<Git::ConfigEntryInfo>`
-- Filters for entries whose key starts with `remote.`, passes to
-  `Git::Parsers::Remote.parse_list`
-- Returns `Array<Git::RemoteInfo>`
-- File: `lib/git/repository/remote_operations.rb`
-- Note: this replaces the use of `Private.config_list` (which returns a flat hash
-  that loses duplicate keys and cannot represent multi-value config fields)
-
-**Step 5.** Deprecate `remotes`:
-- Add `Git::Deprecation.warn(...)` pointing to `remote_list`
-- Keep returning `Array<Git::Remote>` for backward compat
-
-**Step 6.** Unit + integration tests for `remote_list`
-
-### Files changed in PR 3
-
-- `lib/git/repository/remote_operations.rb`
-- `spec/unit/git/repository/remote_operations_spec.rb`
-- `spec/integration/git/repository/remote_operations_spec.rb`
-
----
-
-## Decisions
-
-- `remote_show(name)` deferred — add after `remote_list` lands
-- `remotes` deprecated (not removed) — still returns `Array<Git::Remote>` for compat
-- `remote_add` / `remote_set_url` return `nil` — breaking change acceptable in beta
-- Deprecated wrappers (`add_remote`, `set_remote_url`) still return `Git::Remote`
-- `RemoteInfo` fields are **snake_case** (not camelCase)
-- Data source for `remote_list`: `Git::Configuring#config_list` (the instance method
-  mixed into `Git::Repository`), which returns `Array<Git::ConfigEntryInfo>` and
-  preserves duplicate keys — **not** `Private.config_list` (which returns a flat
-  `Hash{String=>String}` and cannot represent multi-value fields)
-- **Boolean fields** are three-state `true`/`false`/`nil`; `nil` means "not configured"
-  and is semantically distinct from `false` for `:prune` and `:prune_tags`
-  (those inherit from global `fetch.prune` / `fetch.pruneTags` when `nil`)
-- **Multi-value fields**: `:url`, `:push_url`, `:fetch`, `:push` are all `Array<String>`
-- **`require` statements** are an implementation detail; add as needed
-- **`config_remote`** — its relationship to `remote_list` is not addressed in this plan
-
-## Out of scope
-
-- Issue #919 fix (`BranchInfo#remote_name` for slash remotes) — separate effort
-- `Git::Remote#branch` deprecation — not part of this plan
-- `Git::Remote` and `Git::Branch` deprecation — separate future effort
-- `remote_show(name)` single-remote lookup — deferred until after `remote_list` lands

data/redesign/reverse_dependencies.sql

@@ -1,44 +0,0 @@
-WITH matching_dependencies AS (
-  SELECT
-    dependent_gem.name AS dependent_gem_name,
-    dependent_version.number AS dependent_version_number,
-    dependent_version.canonical_number AS dependent_version_canonical_number,
-    COALESCE(dependent_version.built_at, dependent_version.created_at) AS dependent_version_released_at,
-    dependencies.requirements,
-    COALESCE(linksets.code, linksets.home) AS url
-  FROM rubygems target_gem
-  JOIN dependencies
-    ON dependencies.rubygem_id = target_gem.id
-  JOIN versions dependent_version
-    ON dependent_version.id = dependencies.version_id
-  JOIN rubygems dependent_gem
-    ON dependent_gem.id = dependent_version.rubygem_id
-  LEFT JOIN linksets
-    ON linksets.rubygem_id = dependent_gem.id
-  WHERE target_gem.name = 'git'
-    AND (
-      dependencies.requirements LIKE '~> 4.%'
-      OR dependencies.requirements LIKE '>= %'
-    )
-),
-latest_dependencies AS (
-  SELECT DISTINCT ON (dependent_gem_name)
-    dependent_gem_name,
-    dependent_version_number,
-    dependent_version_released_at,
-    requirements,
-    url
-  FROM matching_dependencies
-  ORDER BY
-    dependent_gem_name,
-    dependent_version_canonical_number DESC NULLS LAST,
-    dependent_version_number DESC
-)
-SELECT
-  dependent_gem_name,
-  dependent_version_number,
-  dependent_version_released_at,
-  requirements,
-  url
-FROM latest_dependencies
-ORDER BY dependent_version_released_at DESC;

data/tasks/gem_tasks.rake

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-# Make it so that calling `rake release` just calls `rake release:rubygem_push` to
-# avoid creating and pushing a new tag.
-
-Rake::Task['release'].clear
-desc 'Customized release task to avoid creating a new tag'
-task release: 'release:rubygem_push'
-
-require 'rake/clean'
-CLOBBER << 'pkg'
-CLOBBER << 'Gemfile.lock'

data/tasks/npm_tasks.rake

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake/clean'
-
-CLOBBER << 'node_modules'
-CLOBBER << 'package-lock.json'
-CLOBBER << '.husky/_'

data/tasks/rspec.rake

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-# Skip parallel test execution when the PARALLEL_TESTS environment variable is set to a falsy value
-def parallel_tests_disabled_via_env?
-  parallel_tests_env = ENV.fetch('PARALLEL_TESTS', 'true').strip.downcase
-  %w[false 0 no off].include?(parallel_tests_env)
-end
-
-# Use parallel test execution for MRI where it cuts build times by 30-48%.
-# JRuby and TruffleRuby are slower with parallel_tests because each worker
-# process pays JVM/Truffle startup and warm-up overhead independently,
-# resulting in 18-28% slower builds vs. serial execution.
-def parallel_tests?
-  RUBY_ENGINE == 'ruby' && !parallel_tests_disabled_via_env?
-end
-
-# SPEC lets a developer target one or more specific files, e.g.
-# `SPEC=spec/unit/git/version_spec.rb rake spec:unit`, running just those files
-# instead of the whole directory. Both rspec and parallel_rspec recurse a bare
-# directory argument using their own default *_spec.rb pattern, so no explicit
-# --pattern flag is needed for the non-SPEC case.
-#
-# Matches are filtered to dir so that each task only ever runs the specs it owns,
-# no matter how broad SPEC is. This keeps every task self-consistent (a unit spec
-# can never be run by spec:integration under integration's runner and env) and lets
-# a single cross-layer glob drive `rake spec`, e.g.
-# `SPEC=spec/**/git/commands/add_spec.rb rake spec` runs the unit file under
-# spec:unit and the integration file under spec:integration. A SPEC that matches
-# files elsewhere in spec/ but none under dir yields no targets, and the caller
-# skips the task rather than falling back to running all of dir.
-def spec_targets(dir)
-  spec_files = ENV.fetch('SPEC', nil)&.strip
-  return [dir] if spec_files.nil? || spec_files.empty?
-
-  targets = FileList[spec_files].sort
-  raise "SPEC=#{spec_files.inspect} did not match any files" if targets.empty?
-
-  targets.select { |target| target.delete_prefix('./').start_with?(dir) }
-end
-
-# True when targets name exactly one spec file (as opposed to a directory, or
-# several files).
-def single_spec_file?(targets)
-  targets.one? && File.file?(targets.first)
-end
-
-# The runner for targets: parallel_rspec only when the task runs in parallel and
-# there is more than one spec file to spread across workers.
-#
-# A single file always uses plain rspec. Worker startup is pure overhead with nothing
-# to divide, and parallel_tests sets TEST_ENV_NUMBER in every worker, which makes
-# spec_helper fall back from the documentation formatter to plain dots -- the opposite
-# of what a run narrowed to one file wants.
-def spec_runner(targets, parallel:)
-  parallel && !single_spec_file?(targets) ? 'parallel_rspec' : 'rspec'
-end
-
-# Run the SPEC-filtered targets for dir, or announce a skip when SPEC selected nothing
-# under dir. Silently doing nothing would read as a passing run of the whole directory.
-def run_spec_task(name, dir, env, parallel:)
-  targets = spec_targets(dir)
-
-  if targets.empty?
-    puts "Skipping #{name}: SPEC=#{ENV.fetch('SPEC', nil)} matched no files under #{dir}"
-  else
-    sh env, 'bundle', 'exec', spec_runner(targets, parallel: parallel), *targets
-  end
-end
-
-def define_parallel_spec_task(name, dir, env: {})
-  task name do
-    run_spec_task(name, dir, env, parallel: true)
-  end
-end
-
-def define_serial_spec_task(name, dir, env: {})
-  task name do
-    run_spec_task(name, dir, env, parallel: false)
-  end
-end
-
-# Define a spec task that runs in parallel (via parallel_tests) when parallel_tests? is
-# true, and serially (via a direct `bundle exec rspec` call) otherwise. env, when given,
-# is passed to `sh` and scoped to just the spawned test subprocess(es).
-def define_spec_task(name, dir, desc_text, env: {})
-  desc desc_text
-  parallel_tests? ? define_parallel_spec_task(name, dir, env: env) : define_serial_spec_task(name, dir, env: env)
-end
-
-# Run only unit specs. These run in a few seconds, so parallel_tests startup
-# overhead isn't worth it - always run serially.
-desc 'Run unit RSpec tests (mocked, fast; SPEC=<glob> to run specific files)'
-define_serial_spec_task('spec:unit', 'spec/unit/')
-
-# Run only integration specs. Coverage is forced off (regardless of the COVERAGE
-# env var): integration tests intentionally aren't exhaustive, so tracking or
-# reporting coverage for them would misleadingly suggest that low integration
-# coverage is a problem to fix.
-define_spec_task(
-  'spec:integration', 'spec/integration/',
-  'Run integration RSpec tests (real git, slower; SPEC=<glob> to run specific files)',
-  env: { 'COVERAGE' => 'false' }
-)
-
-# Run all specs, keeping unit and integration output clearly separated
-desc 'Run unit and integration RSpec tests (SPEC=<glob> to run specific files)'
-task spec: %w[spec:unit spec:integration]
-
-CLEAN << 'coverage'
-CLEAN << '.rspec_status'
-CLEAN << 'rspec-report.xml'

data/tasks/rubocop.rake

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new

data/tasks/test_gem.rake

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-
-desc 'Build and install the git gem and run a sanity check'
-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+$/
-
-  puts 'Gem Test Succeeded'
-end

data/tasks/yard.rake

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# YARD documentation for this project can NOT be built with JRuby or TruffleRuby.
-# This project uses the redcarpet gem which can not be installed on JRuby.
-#
-unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
-  # yard:build
-
-  require 'yard'
-
-  YARD::Rake::YardocTask.new('yard:build') do |t|
-    t.files = %w[lib/**/*.rb]
-    t.stats_options = ['--list-undoc']
-  end
-
-  CLEAN << '.yardoc'
-  CLEAN << 'doc'
-
-  # yard:lint
-
-  # Lints YARD documentation against the project's standards and enforces the
-  # minimum documentation coverage threshold. Configuration lives in
-  # .yard-lint.yml.
-  #
-  # yard-lint requires Ruby >= 3.3, so the lint task is only defined and only
-  # included in the aggregate `yard` task on Ruby 3.3+.
-  #
-  yard_lint_supported = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.3.0')
-
-  if yard_lint_supported
-    desc 'Lint YARD documentation with yard-lint'
-    task :'yard:lint' do
-      sh 'bundle exec yard-lint lib/'
-    end
-  end
-
-  # yard:example-test
-
-  require 'yard_example_test/rake'
-
-  YardExampleTest::RakeTask.new('yard:example-test') do |task|
-    task.pattern = 'lib/git/commands/arguments.rb'
-  end
-
-  # yard
-
-  yard_tasks = %i[yard:build]
-  yard_tasks << :'yard:lint' if yard_lint_supported
-  yard_tasks << :'yard:example-test'
-
-  yard_steps = ['build']
-  yard_steps << 'lint' if yard_lint_supported
-  yard_steps << 'example-test'
-
-  desc "Run YARD documentation tasks (#{yard_steps.join(', ')})"
-  task yard: yard_tasks
-end