git-fastclone 1.5.0 → 1.6.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b86bd9aa9bc5a377dd7d5b7b456eb0de1aee7ffd1e746642775d08042e9714f
-  data.tar.gz: '08dff02e06757c022c7ee0fec4890261c3d3efbee76130f2c7f4e0c2cdd91361'
+  metadata.gz: 691025585b07db11da08c4cba7a6a6f8adbc6fa869c4d05cb4fb4abe9f29231c
+  data.tar.gz: 68d8a58de28932d66eb99f37630bb3bb7a9ee5e23738ed6c9c50550cc72f8a74
 SHA512:
-  metadata.gz: ce36dfc95ed1d5621fc32df5721d1b796e1cdbb58c11952351dd124bf14a784bef8624e23bde74be3a3c848fff320201639b0e7737be44c8860860a0fb99a019
-  data.tar.gz: 77a296e5b3c6ea817fef4c0ca6df39c4f33e8f35626fd896d4f41ff9c201bf8de15c57a0543e7a8aac4cf63f7de352a00b01844c964657fb20192abbce3790a4
+  metadata.gz: 7594ba7271f38731ec3522e7af1f067d606ae3dc91860ffb9d0cff6a34dee62d1dee62a8c5a77d206f9fa9ef782ea44893a9542c1ef5ef5163176269a979c8cf
+  data.tar.gz: 4b0b325e9ca5c756a9efce9e28f6edc7d8a9084616e60de8e33feca4a890a9319946914eece980b192aa4dcc54da362fb93954071820b4008410c6a0abfee62c

data/lib/git-fastclone/version.rb

@@ -2,5 +2,5 @@
 
 # Version string for git-fastclone
 module GitFastCloneVersion
-  VERSION = '1.5.0'
+  VERSION = '1.6.0.pre1'
 end

data/lib/git-fastclone.rb

@@ -85,7 +85,7 @@ module GitFastClone
 
     attr_accessor :reference_dir, :prefetch_submodules, :reference_updated, :reference_mutex,
                   :options, :abs_clone_path, :using_local_repo, :verbose, :print_git_errors, :color,
-                  :flock_timeout_secs
+                  :flock_timeout_secs, :sparse_paths
 
     def initialize
       # Prefetch reference repos for submodules we've seen before
@@ -115,6 +115,8 @@ module GitFastClone
       self.color = false
 
       self.flock_timeout_secs = 0
+
+      self.sparse_paths = nil
     end
 
     def run
@@ -162,14 +164,21 @@ module GitFastClone
           options[:config] = config
         end
 
-        opts.on('--lock-timeout N', 'Timeout in seconds to acquire a lock on any reference repo.
-                Default is 0 which waits indefinitely.') do |timeout_secs|
+        opts.on('--lock-timeout N', 'Timeout in seconds to acquire a lock on any reference repo.',
+                'Default is 0 which waits indefinitely.') do |timeout_secs|
           self.flock_timeout_secs = timeout_secs.to_i
         end
 
-        opts.on('--pre-clone-hook command',
-                'An optional command that should be invoked before cloning mirror repo') do |command|
-          options[:pre_clone_hook] = command
+        opts.on('--pre-clone-hook script_file',
+                'An optional file that should be invoked before cloning mirror repo',
+                'No-op when a file is missing') do |script_file|
+          options[:pre_clone_hook] = script_file
+        end
+
+        opts.on('--sparse-paths PATHS',
+                'Comma-separated list of paths for sparse checkout.',
+                'Enables sparse checkout mode using git sparse-checkout.') do |paths|
+          self.sparse_paths = paths.split(',').map(&:strip)
         end
       end.parse!
     end
@@ -198,6 +207,16 @@ module GitFastClone
         raise msg
       end
 
+      # Validate that --branch is specified when using --sparse-paths
+      if sparse_paths && !options[:branch]
+        msg = "Error: --branch is required when using --sparse-paths\n" \
+              "Sparse checkouts need an explicit branch/revision to checkout.\n" \
+              'Usage: git-fastclone --sparse-paths <paths> --branch <branch> <url>'
+        raise msg.red if color
+
+        raise msg
+      end
+
       self.reference_dir = ENV['REFERENCE_REPO_DIR'] || DEFAULT_REFERENCE_REPO_DIR
       FileUtils.mkdir_p(reference_dir)
 
@@ -233,13 +252,23 @@ module GitFastClone
         clear_clone_dest_if_needed(attempt_number, clone_dest)
 
         clone_commands = ['git', 'clone', verbose ? '--verbose' : '--quiet']
-        clone_commands << '--reference' << mirror.to_s << url.to_s << clone_dest
+        clone_commands.push('--no-checkout', '--shared') if sparse_paths
+        # For sparse checkouts with --shared, clone directly from the local mirror
+        # For normal clones, use --reference and clone from the remote URL
+        if sparse_paths
+          clone_commands << mirror.to_s << clone_dest
+        else
+          clone_commands << '--reference' << mirror.to_s << url.to_s << clone_dest
+        end
         clone_commands << '--config' << config.to_s unless config.nil?
         fail_on_error(*clone_commands, quiet: !verbose, print_on_failure: print_git_errors)
+
+        # Configure sparse checkout if enabled
+        configure_sparse_checkout(clone_dest, rev) if sparse_paths
       end
 
-      # Only checkout if we're changing branches to a non-default branch
-      if rev
+      # Only checkout if we're changing branches to a non-default branch (for non-sparse clones)
+      if !sparse_paths && rev
         fail_on_error('git', 'checkout', '--quiet', rev.to_s, quiet: !verbose,
                                                               print_on_failure: print_git_errors,
                                                               chdir: File.join(abs_clone_path, src_dir))
@@ -257,6 +286,22 @@ module GitFastClone
       end
     end
 
+    def configure_sparse_checkout(clone_dest, rev)
+      puts 'Configuring sparse checkout...' if verbose
+
+      # Initialize sparse checkout with cone mode
+      fail_on_error('git', 'sparse-checkout', 'init', '--cone',
+                    quiet: !verbose, print_on_failure: print_git_errors, chdir: clone_dest)
+
+      # Set the sparse paths
+      fail_on_error('git', 'sparse-checkout', 'set', *sparse_paths,
+                    quiet: !verbose, print_on_failure: print_git_errors, chdir: clone_dest)
+
+      # Checkout the specified branch/revision
+      fail_on_error('git', 'checkout', '--quiet', rev.to_s,
+                    quiet: !verbose, print_on_failure: print_git_errors, chdir: clone_dest)
+    end
+
     def update_submodules(pwd, url)
       return unless File.exist?(File.join(abs_clone_path, pwd, '.gitmodules'))
 
@@ -292,13 +337,13 @@ module GitFastClone
       end
     end
 
-    def with_reference_repo_lock(url, &block)
+    def with_reference_repo_lock(url, &)
       # Sane POSIX implementations remove exclusive flocks when a process is terminated or killed
       # We block here indefinitely. Waiting for other git-fastclone processes to release the lock.
       # With the default timeout of 0 we will wait forever, this can be overridden on the command line.
       lockfile = reference_repo_lock_file(url, reference_dir, using_local_repo)
       Timeout.timeout(flock_timeout_secs) { lockfile.flock(File::LOCK_EX) }
-      with_reference_repo_thread_lock(url, &block)
+      with_reference_repo_thread_lock(url, &)
     ensure
       # Not strictly necessary to do this unlock as an ensure. If ever exception is caught outside this
       # primitive, ensure protection may come in handy.
@@ -306,12 +351,12 @@ module GitFastClone
       lockfile.close
     end
 
-    def with_reference_repo_thread_lock(url, &block)
+    def with_reference_repo_thread_lock(url, &)
       # We also need thread level locking because pre-fetch means multiple threads can
       # attempt to update the same repository from a single git-fastclone process
       # file locks in posix are tracked per process, not per userland thread.
       # This gives us the equivalent of pthread_mutex around these accesses.
-      reference_mutex[reference_repo_name(url)].synchronize(&block)
+      reference_mutex[reference_repo_name(url)].synchronize(&)
     end
 
     def update_submodule_reference(url, submodule_url_list)
@@ -452,7 +497,13 @@ module GitFastClone
     private def trigger_pre_clone_hook_if_needed(url, mirror, attempt_number)
       return if Dir.exist?(mirror) || !options.include?(:pre_clone_hook)
 
-      popen2e_wrapper(options[:pre_clone_hook], url.to_s, mirror.to_s, attempt_number.to_s, quiet: !verbose)
+      hook_command = options[:pre_clone_hook]
+      unless File.exist?(File.expand_path(hook_command))
+        puts 'pre_clone_hook script is missing' if verbose
+        return
+      end
+
+      popen2e_wrapper(hook_command, url.to_s, mirror.to_s, attempt_number.to_s, quiet: !verbose)
     end
   end
 end

data/spec/git_fastclone_runner_spec.rb

@@ -45,7 +45,6 @@ describe GitFastClone::Runner do
     it 'should initialize properly' do
       stub_const('GitFastClone::DEFAULT_REFERENCE_REPO_DIR', 'new_dir')
 
-      expect(Hash).to respond_to(:new).with(2).arguments
       expect(GitFastClone::DEFAULT_REFERENCE_REPO_DIR).to eq('new_dir')
       expect(subject.prefetch_submodules).to eq(true)
       expect(subject.reference_mutex).to eq({})
@@ -146,11 +145,13 @@ describe GitFastClone::Runner do
       end
     end
 
-    context 'with pre-clone-hook errors' do
+    context 'with pre-clone-hook' do
       let(:pre_clone_hook) { '/some/command' }
       before(:each) do
         subject.options[:pre_clone_hook] = pre_clone_hook
         subject.reference_dir = placeholder_arg
+        allow(File).to receive(:exist?).and_call_original
+        allow(File).to receive(:exist?).with(pre_clone_hook).and_return(true)
         allow(subject).to receive(:with_git_mirror).and_call_original
         allow(subject).to receive(:with_reference_repo_lock) do |_url, &block|
           block.call
@@ -192,6 +193,22 @@ describe GitFastClone::Runner do
 
         subject.clone(placeholder_arg, nil, '.', 'config')
       end
+
+      context 'non-existing script' do
+        before(:each) do
+          allow(File).to receive(:exist?).with(pre_clone_hook).and_return(false)
+        end
+
+        it 'does not invoke hook command' do
+          allow(subject).to receive(:fail_on_error)
+          expect(subject).not_to receive(:popen2e_wrapper).with(
+            pre_clone_hook, 'PH', 'PH/PH', '0',
+            { quiet: true }
+          )
+
+          subject.clone(placeholder_arg, nil, '.', 'config')
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-fastclone
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0.pre1
 platform: ruby
 authors:
 - Michael Tauraso
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -59,14 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: git-clone --recursive on steroids!