ruby_git 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12470df80fc020031e73898e6332def5b5d6e7c419acb3036a58585263269b7
-  data.tar.gz: d1138d2381fc7272397357105b8e884a78bed2396289608df6dc746896018b4b
+  metadata.gz: 49c6945719de157cce37ff7fc1db26942f2e72cd52af4705d24dbf77f7417c3f
+  data.tar.gz: cf947e2e02562cc8815f074c1e60cabefa2bfa4904a010203f836c6f28c84fb8
 SHA512:
-  metadata.gz: f1cbdfcdea413421d06bf15ad2c205866dff32a1b92ffea0b260dbecf31fe62313fb6b355ae81fff9cb0f07fab26af622c90eeb28c1b1e28c63c27a02223e499
-  data.tar.gz: e51b5c257998f8a2c9cad6927bfd1b32d4f397c793b82edd6017a00b4581b9b6f6f00623f05ec9d2052b42a72c62fabc94268bb4caa6b1d6b408a3b2d5041f46
+  metadata.gz: 8886578e9cd719cfb9495bcf557216ad57632b39ced741d6e88caab28e59c65ad5c2b9b3d03933ef7b43f5b5e8da66ee0222f54f0c39c4b4cedb6f26597d4f8d
+  data.tar.gz: b9ad7a689dd88b0f705880df7bd7b0abdf9dd472c0be9750f207918cf988b6d445f4b5e0c0e71204cfd220cb05444700c36bd59aefc5b43f82e20ec74d4b0a44

data/.github/workflows/continuous_integration.yml

@@ -1,9 +1,6 @@
 name: Continuous Integration
 
 on:
-  push:
-    branches: [main]
-
   pull_request:
     branches: [main]
 
@@ -26,6 +23,10 @@ jobs:
   build:
     name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
 
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
+
     runs-on: ${{ matrix.operating-system }}
     continue-on-error: true
 
@@ -35,19 +36,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.1", "3.2", "3.3", "3.4"]
+        ruby: ["3.1", "3.4"]
         operating-system: [ubuntu-latest]
         fail_on_low_coverage: [true]
-        include:
-          - ruby: "3.1"
-            operating-system: windows-latest
-            fail_on_low_coverage: false
-          - ruby: "jruby-9.4"
-            operating-system: ubuntu-latest
-            fail_on_low_coverage: false
-          - ruby: "truffleruby-24"
-            operating-system: ubuntu-latest
-            fail_on_low_coverage: false
 
     steps:
       - name: Checkout
@@ -61,27 +52,3 @@ jobs:
 
       - name: Run rake
         run: bundle exec rake
-
-  coverage:
-    name: Report test coverage to CodeClimate
-
-    needs: [build]
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Initialize Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.1
-          bundler-cache: true
-
-      - name: Report test coverage
-        uses: paambaati/codeclimate-action@v9
-        env:
-          CC_TEST_REPORTER_ID: b86e77bc6980a43dc09314502fe13334e0f663770b840628ca0716e6dcdeeb5d
-        with:
-          coverageCommand: bundle exec rake spec
-          coverageLocations: ${{github.workspace}}/coverage/lcov/*.lcov:lcov

data/.github/workflows/enforce_conventional_commits.yml

@@ -9,6 +9,10 @@ jobs:
   commit-lint:
     name: Verify Conventional Commits
 
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
+
     runs-on: ubuntu-latest
 
     steps:

data/.github/workflows/experimental_ruby_builds.yml

@@ -1,9 +1,6 @@
 name: Experimental Ruby Builds
 
 on:
-  push:
-    branches: [main]
-
   workflow_dispatch:
 
 env:
@@ -34,19 +31,28 @@ jobs:
       matrix:
         fail_on_low_coverage: [true]
         include:
+          - ruby: "3.1"
+            operating-system: windows-latest
+            fail_on_low_coverage: false
           - ruby: head
             operating-system: ubuntu-latest
           - ruby: head
             operating-system: windows-latest
+          - ruby: "truffleruby-24"
+            operating-system: ubuntu-latest
+            fail_on_low_coverage: false
           - ruby: truffleruby-head
             operating-system: ubuntu-latest
             fail_on_low_coverage: false
-          - ruby: jruby-head
+          - ruby: "jruby-9.4"
             operating-system: ubuntu-latest
             fail_on_low_coverage: false
           - ruby: "jruby-9.4"
             operating-system: windows-latest
             fail_on_low_coverage: false
+          - ruby: jruby-head
+            operating-system: ubuntu-latest
+            fail_on_low_coverage: false
           - ruby: jruby-head
             operating-system: windows-latest
             fail_on_low_coverage: false

data/.github/workflows/release.yml

@@ -0,0 +1,51 @@
+---
+name: Release Gem
+description: |
+  This workflow creates a new release on GitHub and publishes the gem to
+  RubyGems.org.
+
+  The workflow uses the `googleapis/release-please-action` to handle the
+  release creation process and the `rubygems/release-gem` action to publish
+  the gem.
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: RubyGems
+      url: https://rubygems.org/gems/ruby_git
+
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v4
+
+      - name: Create release
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.AUTO_RELEASE_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Push to RubyGems.org
+        uses: rubygems/release-gem@v1
+        if: ${{ steps.release.outputs.release_created }}

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.3"
+}

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [0.3.3](https://github.com/main-branch/ruby_git/compare/v0.3.2...v0.3.3) (2025-04-17)
+
+
+### Bug Fixes
+
+* Do not trigger build workflows after merging to main or for release PRs ([0678dd3](https://github.com/main-branch/ruby_git/commit/0678dd347235aaa9f55d84853de94d01935f974d))
+* Move unneeded builds from continuous_integration to experimental_ruby_builds ([2d15e1c](https://github.com/main-branch/ruby_git/commit/2d15e1c7aef848e4d3cc857e6f606a0f68d7bf6f))
+
+## [0.3.2](https://github.com/main-branch/ruby_git/compare/v0.3.1...v0.3.2) (2025-04-16)
+
+
+### Bug Fixes
+
+* Automate commit-to-publish workflow ([9850fed](https://github.com/main-branch/ruby_git/commit/9850fed2230f154eaf6319644d0e6b40c5352e7f))
+
 ## v0.3.1 (2025-03-28)
 
 [Full Changelog](https://github.com/main-branch/ruby_git/compare/v0.3.0..v0.3.1)

data/README.md

@@ -7,8 +7,6 @@ and the order of implementing new features.
 [![Build Status](https://github.com/main-branch/ruby_git/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/ruby_git/actions/workflows/continuous_integration.yml)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/ruby_git/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/ruby_git/file/CHANGELOG.md)
-[![Maintainability](https://api.codeclimate.com/v1/badges/5403e4613b7518f70da7/maintainability)](https://codeclimate.com/github/main-branch/ruby_git/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/5403e4613b7518f70da7/test_coverage)](https://codeclimate.com/github/main-branch/ruby_git/test_coverage)
 [![Slack](https://img.shields.io/badge/slack-main--branch/ruby__git-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C01CHR7TMM2)
 
 Git Is Hard™ but it doesn't have to be that way. Git has this reputation because it has an

data/Rakefile

@@ -17,6 +17,13 @@ Bundler::Audit::Task.new
 require 'bundler'
 require 'bundler/gem_tasks'
 
+# Make it so that calling `rake release` just calls `rake release:rubygems_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'
+
 # RSpec
 
 require 'rspec/core/rake_task'

data/lib/ruby_git/repository.rb

@@ -26,8 +26,36 @@ module RubyGit
     #
     # @param [String] repository_path the path to the repository
     #
+    #   The purpose of this flag is to allow tests to not have to mock the
+    #   normalization of the path. This allows testing that the right git command
+    #   is contructed based on the options passed any particular method.
+    #
+    # @raise [ArgumentError] if the path is not a directory
+    #
     def initialize(repository_path)
-      @path = File.realpath(repository_path)
+      @path = normalize_path(repository_path)
+    end
+
+    private
+
+    # Expand and convert the given path to an absolute, real path
+    #
+    # @example Expand the path
+    #   normalize_path('~/repository.git') #=> '/Users/james/repository.git'
+    #
+    # @example Convert to an absolute path
+    #   File.chdir('/User/james/repository/.git')
+    #   normalize_path('.') #=> '/User/james/repository/.git'
+    #
+    # @param path [String] the path to normalize
+    #
+    # @return [String]
+    #
+    # @api private
+    def normalize_path(path)
+      raise ArgumentError, "Directory '#{path}' does not exist." unless File.directory?(path)
+
+      File.realpath(File.expand_path(path))
     end
   end
 end

data/lib/ruby_git/version.rb

@@ -3,5 +3,5 @@
 module RubyGit
   # The ruby_git gem version
   #
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 end

data/lib/ruby_git/worktree.rb

@@ -105,17 +105,6 @@ module RubyGit
       new(cloned_to(clone_output))
     end
 
-    # Get path of the cloned worktree from `git clone` stderr output
-    #
-    # @param clone_output [String] the stderr output of the `git clone` command
-    #
-    # @return [String] the path of the cloned worktree
-    #
-    # @api private
-    def self.cloned_to(clone_output)
-      clone_output.match(/Cloning into ['"](.+)['"]\.\.\./)[1]
-    end
-
     # Show the working tree and index status
     #
     # @example worktree = Worktree.open(worktree_path) worktree.status #=>
@@ -154,7 +143,7 @@ module RubyGit
       command << '--' unless path_specs.empty?
       command.concat(path_specs)
       options = { out: StringIO.new, err: StringIO.new }
-      status_output = run(*command, **options).stdout
+      status_output = run_with_context(*command, **options).stdout
       RubyGit::Status.parse(status_output)
     end
 
@@ -194,7 +183,7 @@ module RubyGit
 
       options = { out: StringIO.new, err: StringIO.new }
 
-      run(*command, **options)
+      run_with_context(*command, **options)
     end
 
     # Return the repository associated with the worktree
@@ -206,42 +195,95 @@ module RubyGit
     # @return [RubyGit::Repository] the repository associated with the worktree
     #
     def repository
-      @repository ||= begin
-        command = %w[rev-parse --git-dir]
-        options = { chdir: path, chomp: true, out: StringIO.new, err: StringIO.new }
-        # rev-parse path might be relative to the worktree, thus the need to expand it
-        git_dir = File.realpath(RubyGit::CommandLine.run(*command, **options).stdout, path)
-        Repository.new(git_dir)
-      end
+      @repository ||= Repository.new(repository_path)
     end
 
     private
 
+    # The path to the repository associated with this worktree
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def repository_path
+      command = %w[rev-parse --git-dir]
+      options = { chdir: path, chomp: true, out: StringIO.new, err: StringIO.new }
+      # rev-parse path might be relative to the worktree, thus the need to expand it
+      File.realpath(RubyGit::CommandLine.run(*command, **options).stdout, path)
+    end
+
     # Create a Worktree object
     #
     # @param worktree_path [String] a path anywhere in the worktree
     #
+    #   The purpose of this flag is to allow tests to not have to mock the
+    #   normalization of the path. This allows testing that the right git command
+    #   is contructed based on the options passed any particular method.
+    #
+    # @raise [ArgumentError] if the path is not a directory or the path is not in a
+    #   git working tree
+    #
+    # @return [RubyGit::Worktree] the worktree whose root is at `path`
     # @api private
     #
     def initialize(worktree_path)
-      raise RubyGit::Error, "Path '#{worktree_path}' not valid." unless File.directory?(worktree_path)
-
-      @path = root_path(worktree_path)
+      @path = normalize_path(worktree_path)
       RubyGit.logger.debug("Created #{inspect}")
     end
 
-    # Find the root path of a Git working tree containing `path`
+    # Get path of the cloned worktree from `git clone` stderr output
     #
-    # @raise [RubyGit::FailedError] if the path is not in a Git working tree
+    # @param clone_output [String] the stderr output of the `git clone` command
+    #
+    # @return [String] the path of the cloned worktree
+    #
+    # @api private
+    private_class_method def self.cloned_to(clone_output)
+      clone_output.match(/Cloning into ['"](.+)['"]\.\.\./)[1]
+    end
+
+    # Return the absolute path to the root of the working tree containing path
+    #
+    # @example Expand the path
+    #   normalize_path('~/worktree') #=> '/Users/james/worktree'
+    #
+    # @example Convert to an absolute path
+    #   File.chdir('/User/james/worktree')
+    #   normalize_path('.') #=> '/User/james/worktree'
+    #
+    # @param path [String] a (possibly relative) path within the worktree
+    #
+    # @return [String]
+    #
+    # @raise [ArgumentError] if the path is not a directory or the path is not in a
+    #   git working tree
+    #
+    # @api private
+    #
+    def normalize_path(path)
+      raise ArgumentError, "Directory '#{path}' does not exist." unless File.directory?(path)
+
+      begin
+        root_path(path)
+      rescue RubyGit::FailedError => e
+        raise ArgumentError, e.message
+      end
+    end
+
+    # Find the root path of a Git working tree containing `path`
     #
     # @return [String] the root path of the Git working tree containing `path`
     #
+    # @raise [ArgumentError] if the path is not in a Git working tree
+    #
     # @api private
     #
     def root_path(worktree_path)
       command = %w[rev-parse --show-toplevel]
       options = { chdir: worktree_path, chomp: true, out: StringIO.new, err: StringIO.new }
-      File.realpath(RubyGit::CommandLine.run(*command, **options).stdout)
+      root_path = RubyGit::CommandLine.run(*command, **options).stdout
+      File.realpath(File.expand_path(root_path))
     end
 
     # Run a Git command in this worktree
@@ -255,7 +297,7 @@ module RubyGit
     #
     # @api private
     #
-    def run(*command, **options)
+    def run_with_context(*command, **options)
       RubyGit::CommandLine.run(*command, repository_path: repository.path, worktree_path: path, **options)
     end
 

data/release-please-config.json

@@ -0,0 +1,22 @@
+{
+  "bootstrap-sha": "b03a7aebb563e4a25eca7f664dd39c7a0595eb61",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "ruby_git",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/ruby_git/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

data/ruby_git.gemspec

@@ -56,7 +56,7 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'yardstick', '~> 0.9'
   end
 
-  spec.add_dependency 'process_executer', '~> 3.0'
+  spec.add_dependency 'process_executer', '~> 3.2'
   spec.add_dependency 'rchardet', '~> 1.9'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_git
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -203,14 +203,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement
@@ -241,9 +241,11 @@ files:
 - ".github/workflows/continuous_integration.yml"
 - ".github/workflows/enforce_conventional_commits.yml"
 - ".github/workflows/experimental_ruby_builds.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".husky/commit-msg"
 - ".markdownlint.yml"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
@@ -283,6 +285,7 @@ files:
 - lib/ruby_git/worktree.rb
 - package.json
 - pre-commit
+- release-please-config.json
 - ruby_git.gemspec
 homepage: https://github.com/main-branch/ruby_git
 licenses:
@@ -291,8 +294,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/ruby_git
   source_code_uri: https://github.com/main-branch/ruby_git
-  documentation_uri: https://rubydoc.info/gems/ruby_git/0.3.1
-  changelog_uri: https://rubydoc.info/gems/ruby_git/0.3.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/ruby_git/0.3.3
+  changelog_uri: https://rubydoc.info/gems/ruby_git/0.3.3/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -311,7 +314,7 @@ requirements:
 - 'Platform: Mac, Linux, or Windows'
 - 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
 - Git 2.28.0 or later
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An object-oriented interface to working with the git command line
 test_files: []