ruby_git 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49c6945719de157cce37ff7fc1db26942f2e72cd52af4705d24dbf77f7417c3f
-  data.tar.gz: cf947e2e02562cc8815f074c1e60cabefa2bfa4904a010203f836c6f28c84fb8
+  metadata.gz: 9c3507b566d30abc32d770188184bf932f3af97985f579df84dfa24b3e6e9a96
+  data.tar.gz: 8fecb84e47a289736ecf79579a2de496b0520734a4a3d6199c5838e0543ba1d1
 SHA512:
-  metadata.gz: 8886578e9cd719cfb9495bcf557216ad57632b39ced741d6e88caab28e59c65ad5c2b9b3d03933ef7b43f5b5e8da66ee0222f54f0c39c4b4cedb6f26597d4f8d
-  data.tar.gz: b9ad7a689dd88b0f705880df7bd7b0abdf9dd472c0be9750f207918cf988b6d445f4b5e0c0e71204cfd220cb05444700c36bd59aefc5b43f82e20ec74d4b0a44
+  metadata.gz: b8c39128ee93c9a24cb6b07f7b99284f2373647c02d276aa76e9ccad9bfa3ce622ed12c7e0d0043bb3e4b4834069db626de9cc4885ec25fd89a8bac86b705bcc
+  data.tar.gz: bc37e79e11cead6979605727b5134fbbd528610977768bb7302c79cb7eebf7fa385ce1b07573d208f1ff7e4af29344a30e2ddf9e1a9c66a38d60330253b79271

data/.release-please-manifest.json

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

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [0.3.4](https://github.com/main-branch/ruby_git/compare/v0.3.3...v0.3.4) (2025-04-17)
+
+
+### Features
+
+* Add initial_branch option to RubyGit::Worktree.init ([9f5e8da](https://github.com/main-branch/ruby_git/commit/9f5e8daca1599d46c9a53429b24f4fff47f148b6))
+* Add initial_branch option to RubyGit.init ([c0007e5](https://github.com/main-branch/ruby_git/commit/c0007e501c2768e921c1aef618c8edb4969e5e95))
+
+
+### Bug Fixes
+
+* Rewrap any errors raised by Process.spawn in RubyGit::SpawnError ([1ed4444](https://github.com/main-branch/ruby_git/commit/1ed4444c12ff1598af8915eac0c568bbaa865c84))
+
 ## [0.3.3](https://github.com/main-branch/ruby_git/compare/v0.3.2...v0.3.3) (2025-04-17)
 
 

data/lib/ruby_git/command_line/runner.rb

@@ -187,20 +187,39 @@ module RubyGit
       #
       # @api private
       #
-      def run_with_chdir(args, options)
-        return ProcessExecuter.run_with_options(args, options) unless jruby? && options.chdir != :not_set
+      def run_with_chdir(args, options) # rubocop:disable Metrics/MethodLength
+        return run_and_handle_spawn_error(args, options) unless jruby? && options.chdir != :not_set
 
         # :nocov: Not executed in MRI Ruby
-        Dir.chdir(options.chdir) do
-          saved_chdir = options.chdir
-          options.merge!(chdir: :not_set)
-          ProcessExecuter.run_with_options(args, options).tap do
-            options.merge!(chdir: saved_chdir)
+        begin
+          Dir.chdir(options.chdir) do
+            saved_chdir = options.chdir
+            options.merge!(chdir: :not_set)
+            run_and_handle_spawn_error(args, options).tap do
+              options.merge!(chdir: saved_chdir)
+            end
           end
+        rescue Errno::ENOENT, Errno::ENOTDIR => e
+          raise RubyGit::SpawnError, "chdir(#{options.chdir}) failed: #{e.message}"
         end
         # :nocov:
       end
 
+      # Catch ProcessExecuter::SpawnError and raise a RubyGit::SpawnError in its place
+      #
+      # @param args [Array<String>] the command to run
+      # @param options [RubyGit::CommandLine::Options] the options to pass to `Process.spawn`
+      #
+      # @return [ProcessExecuter::Result] the result of the command
+      #
+      # @api private
+      #
+      def run_and_handle_spawn_error(args, options)
+        ProcessExecuter.run_with_options(args, options)
+      rescue ProcessExecuter::SpawnError => e
+        raise RubyGit::SpawnError, e.message
+      end
+
       # Returns true if running on JRuby
       #
       # @return [Boolean]

data/lib/ruby_git/errors.rb

@@ -21,6 +21,7 @@ module RubyGit
   #     │   └─> RubyGit::SignaledError
   #     │       └─> RubyGit::TimeoutError
   #     ├─> RubyGit::ProcessIOError
+  #     ├─> RubyGit::SpawnError
   #     └─> RubyGit::UnexpectedResultError
   # ```
   #
@@ -32,6 +33,7 @@ module RubyGit
   # | `SignaledError` | This error is raised when the git command line is terminated as a result of receiving a signal. This could happen if the process is forcibly terminated or if there is a serious system error. |
   # | `TimeoutError` | This is a specific type of `SignaledError` that is raised when the git command line operation times out and is killed via the SIGKILL signal. This happens if the operation takes longer than the timeout duration configured in `Git.config.timeout` or via the `:timeout` parameter given in git methods that support timeouts. |
   # | `ProcessIOError` | An error was encountered reading or writing to a subprocess. |
+  # | `SpawnError` | An error was encountered when spawning a subprocess and it never started. |
   # | `UnexpectedResultError` | The command line ran without error but did not return the expected results. |
   #
   # @example Rescuing a generic error
@@ -166,4 +168,10 @@ module RubyGit
   # @api public
   #
   class UnexpectedResultError < RubyGit::Error; end
+
+  # Raised when the git command could not be spawned
+  #
+  # @api public
+  #
+  class SpawnError < RubyGit::Error; end
 end

data/lib/ruby_git/option_validators.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubyGit
+  # Module containing option validators for RubyGit
+  # @api public
+  module OptionValidators
+    # Raise an error if an option is not a Boolean (or optionally nil) value
+    # @param name [String] the name of the option
+    # @param value [Object] the value of the option
+    # @param nullable [Boolean] whether the option can be nil (default is false)
+    # @return [void]
+    # @raise [ArgumentError] if the option is not a Boolean (or optionally nil) value
+    # @api private
+    def validate_boolean_option(name:, value:, nullable: false)
+      return if nullable && value.nil?
+
+      return if [true, false].include?(value)
+
+      raise ArgumentError, "The '#{name}:' option must be a Boolean value but was #{value.inspect}"
+    end
+
+    # Raise an error if an option is not a String (or optionally nil) value
+    # @param name [String] the name of the option
+    # @param value [Object] the value of the option
+    # @param nullable [Boolean] whether the option can be nil (default is false)
+    # @return [void]
+    # @raise [ArgumentError] if the option is not a String (or optionally nil) value
+    # @api private
+    def validate_string_option(name:, value:, nullable: false)
+      return if nullable && value.nil?
+
+      return if value.is_a?(String)
+
+      raise ArgumentError, "The '#{name}:' option must be a String or nil but was #{value.inspect}"
+    end
+  end
+end

data/lib/ruby_git/version.rb

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

data/lib/ruby_git/worktree.rb

@@ -7,6 +7,9 @@ module RubyGit
   # Create a new Worktree using {.init}, {.clone}, or {.open}.
   #
   class Worktree
+    extend RubyGit::OptionValidators
+    include RubyGit::OptionValidators
+
     # The root path of the working tree
     #
     # @example
@@ -26,19 +29,24 @@ module RubyGit
     # @see https://git-scm.com/docs/git-init git-init
     #
     # @example
-    #   worktree = Worktree.init(worktree_path)
+    #   worktree = Worktree.init(worktree_path, initial_branch: 'main')
     #
-    # @param [String] worktree_path the root path of a Git working tree
+    # @param worktree_path [String] the root path of a Git working tree
+    # @param initial_branch [String] the initial branch in the newly created repository
     #
-    # @raise [RubyGit::Error] if worktree_path is not a directory
+    # @raise [ArgumentError] if worktree_path does not exist or is not a directory
+    # @raise [RubyGit::Error] if there is an error initializing the repository
     #
     # @return [RubyGit::Worktree] the working tree whose root is at `path`
     #
-    def self.init(worktree_path)
-      raise RubyGit::Error, "Path '#{worktree_path}' not valid." unless File.directory?(worktree_path)
+    def self.init(worktree_path, initial_branch: nil)
+      validate_string_option(name: :initial_branch, value: initial_branch, nullable: true)
 
       command = ['init']
+      command << '--initial-branch' << initial_branch unless initial_branch.nil?
+
       options = { chdir: worktree_path, out: StringIO.new, err: StringIO.new }
+
       RubyGit::CommandLine.run(*command, **options)
 
       new(worktree_path)
@@ -300,20 +308,5 @@ module RubyGit
     def run_with_context(*command, **options)
       RubyGit::CommandLine.run(*command, repository_path: repository.path, worktree_path: path, **options)
     end
-
-    # Raise an error if an option is not a Boolean (or optionally nil) value
-    # @param name [String] the name of the option
-    # @param value [Object] the value of the option
-    # @param nullable [Boolean] whether the option can be nil (default is false)
-    # @return [void]
-    # @raise [ArgumentError] if the option is not a Boolean (or optionally nil) value
-    # @api private
-    def validate_boolean_option(name:, value:, nullable: false)
-      return if nullable && value.nil?
-
-      return if [true, false].include?(value)
-
-      raise ArgumentError, "The '#{name}:' option must be a Boolean value but was #{value.inspect}"
-    end
   end
 end

data/lib/ruby_git.rb

@@ -3,6 +3,7 @@
 require_relative 'ruby_git/command_line'
 require_relative 'ruby_git/encoding_normalizer'
 require_relative 'ruby_git/errors'
+require_relative 'ruby_git/option_validators'
 require_relative 'ruby_git/repository'
 require_relative 'ruby_git/status'
 require_relative 'ruby_git/version'
@@ -79,16 +80,17 @@ module RubyGit
   # @see https://git-scm.com/docs/git-init git-init
   #
   # @example
-  #   worktree = Worktree.init(worktree_path)
+  #   worktree = Worktree.init(worktree_path, initial_branch: 'main')
   #
-  # @param [String] worktree_path the root path of a worktree
+  # @param worktree_path [String] the root path of a worktree
+  # @param initial_branch [String] the initial branch in the newly created repository
   #
   # @raise [RubyGit::Error] if worktree_path is not a directory
   #
   # @return [RubyGit::Worktree] the worktree whose root is at `path`
   #
-  def self.init(worktree_path)
-    RubyGit::Worktree.init(worktree_path)
+  def self.init(worktree_path, initial_branch:)
+    RubyGit::Worktree.init(worktree_path, initial_branch:)
   end
 
   # Open an existing Git working tree that contains worktree_path

data/release-please-config.json

@@ -8,9 +8,10 @@
       "version-file": "lib/ruby_git/version.rb",
       "bump-minor-pre-major": true,
       "bump-patch-for-minor-pre-major": true,
-      "draft": false,
+      "draft": true,
       "prerelease": false,
-      "include-component-in-tag": false
+      "include-component-in-tag": false,
+      "pull-request-title-pattern": "chore: release v${version}"
     }
   },
   "plugins": [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_git
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - James Couball
@@ -268,6 +268,7 @@ files:
 - lib/ruby_git/command_line/runner.rb
 - lib/ruby_git/encoding_normalizer.rb
 - lib/ruby_git/errors.rb
+- lib/ruby_git/option_validators.rb
 - lib/ruby_git/repository.rb
 - lib/ruby_git/status.rb
 - lib/ruby_git/status/branch.rb
@@ -294,8 +295,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.3
-  changelog_uri: https://rubydoc.info/gems/ruby_git/0.3.3/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/ruby_git/0.3.4
+  changelog_uri: https://rubydoc.info/gems/ruby_git/0.3.4/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: