braid 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad14f6dd7a5d428c5796bbd19039aae6e59f5803d93da3889fe0a92a8afd032b
-  data.tar.gz: 9d6bcfd73c5a306f853e6b9653edda5aff6a7bbd3541b6ab644bd7b96bc510e6
+  metadata.gz: 6efac3d863ec38976f90032c012ebe9acca8911a9316608d7dfe704cc0d8925b
+  data.tar.gz: 5c5c8870bbf0702767234ee5b467324c7c25914ed3de06ac67ef903f87ca4ee7
 SHA512:
-  metadata.gz: 817cd08525921352f103a81f05b6c550e8eaff62fb647c04d0ecb746e6ed425a78ef1bea4a477786675c406b0e23982f36a52eea205278a3b25ccee6e64ecdf5
-  data.tar.gz: 76d9e62b1d58a437a8eae77f879b5a66ec6a30cda270d267cc458e621a3f1560fa192f5cc435b5e718c9f093691464d458b049d2e236864d0faea6e801c89629
+  metadata.gz: dcb55a781668a47cdae99c5e013844b3234c7edcaeec21d71f64174dfc6ae3339acf89083b3256244fd430bdf035285d44cd9244d2abd6808b97f1c3c0be41cf
+  data.tar.gz: b8143594481cb94c3ca8c099e02c4c231be84e4a742b5e2047a7e79c82ea0e47c1b8e1ece68719130870aa613f5bca20182eb85e62f1d45a8bca210c0e163f80

data/lib/braid/check_gem.rb

@@ -1,3 +1,10 @@
+# Since this file can't safely depend on the Sorbet runtime, it isn't prudent to
+# try to commit to `typed: true` even if the file currently passes type checking
+# without needing any references to `T`.  Like `exe/braid`, this file doesn't
+# have much code worth type checking.
+#
+# typed: false
+
 # Braid has several entry points that run code from Ruby gems (either Braid
 # itself or dependencies such as Sorbet) and expect to get the correct versions
 # (either the same copy of Braid or versions of dependencies consistent with the

data/lib/braid/command.rb

@@ -17,6 +17,11 @@ module Braid
       klass.new.run(*args)
 
     rescue BraidError => error
+      handle_error(error)
+    end
+
+    sig {params(error: BraidError).returns(T.noreturn)}
+    def self.handle_error(error)
       case error
         when Operations::ShellExecutionError
           msg "Shell error: #{error.message}"

data/lib/braid/commands/add.rb

@@ -1,15 +1,55 @@
+# typed: true
 module Braid
   module Commands
     class Add < Command
+      # Returns the default branch name of the repository at the given URL, or
+      # nil if it couldn't be determined.
+      #
+      # We won't be able to determine a default branch in certain cases that we
+      # expect to be unusual in the context of Braid, such as if the HEAD is
+      # detached or points to a ref outside of `refs/heads`.  (Presumably, the
+      # same thing happens if the server is too old to report symrefs to us.)
+      # In those cases, a plausible alternative behavior would be to just lock
+      # the mirror to the remote HEAD revision, but that's probably not what the
+      # user wants.  It's much more likely that something is wrong and Braid
+      # should report an error.
+      def get_default_branch_name(url)
+        head_targets = []
+        # The `HEAD` parameter here doesn't appear to do an exact match (it
+        # appears to match any ref with `HEAD` as the last path component, such
+        # as `refs/remotes/origin/HEAD` in the unusual case where the repository
+        # contains its own remote-tracking branches), but it reduces the data we
+        # have to scan a bit.
+        git.ls_remote('--symref', url, 'HEAD').split("\n").each do |line|
+          m = /^ref: (.*)\tHEAD$/.match(line)
+          head_targets.push(m[1]) if m
+        end
+        return nil unless head_targets.size == 1
+        m = /^refs\/heads\/(.*)$/.match(head_targets[0])
+        return nil unless m
+        m[1]
+      end
+
       def run(url, options = {})
         with_reset_on_error do
+          if options['branch'].nil? && options['tag'].nil? && options['revision'].nil?
+            default_branch = get_default_branch_name(url)
+            if default_branch.nil?
+              raise BraidError, <<-MSG
+Failed to detect the default branch of the remote repository.  Please specify
+the branch you want to use via the --branch option.
+MSG
+            end
+            options['branch'] = default_branch
+          end
+
           mirror           = config.add_from_options(url, options)
           add_config_file
 
           mirror.branch = nil if options['revision']
           raise BraidError, 'Can not add mirror specifying both a revision and a tag' if options['revision'] && mirror.tag
 
-          branch_message   = (mirror.branch.nil? || mirror.branch == 'master') ? '' : " branch '#{mirror.branch}'"
+          branch_message   = mirror.branch.nil? ? '' : " branch '#{mirror.branch}'"
           tag_message      = mirror.tag.nil? ? '' : " tag '#{mirror.tag}'"
           revision_message = options['revision'] ? " at #{display_revision(mirror, options['revision'])}" : ''
           msg "Adding mirror of '#{mirror.url}'#{branch_message}#{tag_message}#{revision_message}."

data/lib/braid/commands/diff.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class Diff < Command

data/lib/braid/commands/push.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'fileutils'
 require 'tmpdir'
 

data/lib/braid/commands/remove.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class Remove < Command

data/lib/braid/commands/setup.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class Setup < Command

data/lib/braid/commands/status.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class Status < Command

data/lib/braid/commands/update.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class Update < Command

data/lib/braid/commands/upgrade_config.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Braid
   module Commands
     class UpgradeConfig < Command

data/lib/braid/main.rb

@@ -1,13 +1,24 @@
+# typed: true
+
 require 'braid'
 
 require 'rubygems'
 require 'main'
 
+# This is needed for `T` below to resolve to `Braid::T` when using the fake
+# Sorbet runtime.  TODO: Indent the contents and accept the large diff?
+module Braid
+
 Home = File.expand_path(ENV['HOME'] || '~')
 
 # mostly blantantly stolen from ara's punch script
 # main kicks ass!
-Main {
+T.unsafe(Main).run {
+  # `Main` is somewhat mind-bending and I'm unsure what the type of `self`
+  # actually is here, but whatever it is, we don't have a type declaration for
+  # it.
+  T.bind(self, T.untyped)
+
   description <<-TXT
     braid is a simple tool to help track git repositories inside a git repository.
 
@@ -20,7 +31,8 @@ Main {
   # The "main" library doesn't provide a way to do this??
   def check_no_extra_args!
     if @argv.length > 0
-      die 'Extra argument(s) passed to command.'
+      Braid::Command.handle_error(
+        Braid::BraidError.new('Extra argument(s) passed to command.'))
     end
   end
 
@@ -123,7 +135,7 @@ Main {
 
     mixin :optional_local_path, :option_verbose, :option_keep_remote
 
-    synopsis(Main::Usage.default_synopsis(self) + ' [-- git_diff_arg*]')
+    synopsis(T.unsafe(Main::Usage).default_synopsis(self) + ' [-- git_diff_arg*]')
 
     run {
       if @argv.length > 0 && @argv[0] == '--'
@@ -318,3 +330,5 @@ Main {
 
   run { help! }
 }
+
+end

data/lib/braid/mirror.rb

@@ -86,7 +86,7 @@ DESC
       raise NoTagAndBranch if options['tag'] && options['branch']
 
       tag = options['tag']
-      branch = options['branch'] || (tag.nil? ? 'master' : nil)
+      branch = options['branch']
 
       path = (options['path'] || extract_path_from_url(url, options['remote_path'])).sub(/\/$/, '')
       raise PathRequired unless path

data/lib/braid/operations.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'singleton'
 require 'rubygems'
 require 'tempfile'
@@ -56,7 +58,7 @@ module Braid
       include Singleton
 
       def self.command;
-        name.split('::').last.downcase;
+        T.unsafe(name).split('::').last.downcase;
       end
 
       # hax!
@@ -89,6 +91,9 @@ module Braid
       end
 
       def method_missing(name, *args)
+        # We have to use this rather than `T.unsafe` because `invoke` is
+        # private.  See https://sorbet.org/docs/type-assertions#tbind.
+        T.bind(self, T.untyped)
         invoke(name, *args)
       end
 
@@ -138,12 +143,7 @@ module Braid
       # 'MERGE_MSG'), taking into account worktree configuration.  The returned
       # path may be absolute or relative to the current working directory.
       def repo_file_path(path)
-        if require_version('2.5')  # support for --git-path
-          invoke(:rev_parse, '--git-path', path)
-        else
-          # Git < 2.5 doesn't support linked worktrees anyway.
-          File.join(invoke(:rev_parse, '--git-dir'), path)
-        end
+        invoke(:rev_parse, '--git-path', path)
       end
 
       # If the current directory is not inside a git repository at all, this
@@ -273,7 +273,7 @@ module Braid
         if path.nil? || path == ''
           tree
         else
-          m = /^([^ ]*) ([^ ]*) ([^\t]*)\t.*$/.match(invoke(:ls_tree, tree, path))
+          m = T.must(/^([^ ]*) ([^ ]*) ([^\t]*)\t.*$/.match(invoke(:ls_tree, tree, path)))
           mode = m[1]
           type = m[2]
           hash = m[3]
@@ -293,9 +293,7 @@ module Braid
       # file).
       def add_item_to_index(item, path, update_worktree)
         if item.is_a?(BlobWithMode)
-          # Our minimum git version is 1.6.0 and the new --cacheinfo syntax
-          # wasn't added until 2.0.0.
-          invoke(:update_index, '--add', '--cacheinfo', item.mode, item.hash, path)
+          invoke(:update_index, '--add', '--cacheinfo', "#{item.mode},#{item.hash},#{path}")
           if update_worktree
             # XXX If this fails, we've already updated the index.
             invoke(:checkout_index, path)
@@ -390,6 +388,7 @@ module Braid
 
       def clone(*args)
         # overrides builtin
+        T.bind(self, T.untyped)  # Ditto the comment in `method_missing`.
         invoke(:clone, *args)
       end
 
@@ -407,11 +406,11 @@ module Braid
         dir = path(url)
 
         # remove local cache if it was created with --no-checkout
-        if File.exists?("#{dir}/.git")
+        if File.exist?("#{dir}/.git")
           FileUtils.rm_r(dir)
         end
 
-        if File.exists?(dir)
+        if File.exist?(dir)
           Dir.chdir(dir) do
             git.fetch
           end

data/lib/braid/sorbet/fake_runtime.rb

@@ -36,6 +36,10 @@ module Braid
     def self.must(value)
       value
     end
+    def self.unsafe(value)
+      value
+    end
+    def self.bind(value, type); end
 
     class FakeType
       include Singleton
@@ -52,6 +56,9 @@ module Braid
     def self.untyped
       FAKE_TYPE
     end
+    def self.noreturn
+      FAKE_TYPE
+    end
     Boolean = FAKE_TYPE
     module Array
       def self.[](type)

data/lib/braid/version.rb

@@ -1,3 +1,6 @@
+# Ditto the comment in `check_gem.rb` regarding the `typed` sigil.
+# typed: false
+
 module Braid
-  VERSION = '1.1.7'.freeze
+  VERSION = '1.1.8'.freeze
 end

data/lib/braid.rb

@@ -12,14 +12,13 @@ module Braid
   # See the background in the "Supported environments" section of README.md.
   #
   # The newest Git feature that Braid is currently known to rely on is
-  # `receive.denyCurrentBranch = updateInstead` (in
-  # spec/integration/push_spec.rb), which was added in Git 2.3.0 (in 2015).  It
+  # `git ls-remote --symref`, which was added in Git 2.8.0 (in 2016).  It
   # doesn't seem worth even a small amount of work to remove that dependency and
   # support even older versions of Git.  So set that as the declared requirement
   # for now.  In general, a reasonable approach might be to try to support the
   # oldest version of Git in current "long-term support" versions of popular OS
   # distributions.
-  REQUIRED_GIT_VERSION = '2.3.0'
+  REQUIRED_GIT_VERSION = '2.8.0'
 
   @verbose = T.let(false, T::Boolean)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braid
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - Cristi Balan
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: main
@@ -97,6 +97,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple tool for tracking vendor branches in git.
 email: evil@che.lu norbert.crombach@primetheory.org peter@realityforge.org matt@mattmccutchen.net
 executables: