braid 1.1.9 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ddcc3421c5a2dffcf7634e71118d7392d9f506ab49064f25eb2c38f7f0d67b1
-  data.tar.gz: d3ad647f242d287ece52de41be7edb56cfdc3c469336ee84bb35c15257ca4d36
+  metadata.gz: f38ff51ac35694b840f6dbc049ae5bf630fc3b6cf0e6e781431c5f9190f12df1
+  data.tar.gz: de2a9463583afbbb4d0a380ffbef2d68defb9b505f7aa27a684e5bc53c5e4579
 SHA512:
-  metadata.gz: f002d88fa8bb752ab878d746c8b1ead6c73b80518d37a06f261eba2b99540c6081c7991a9f404ec0ca26c39165b6e9345725e4b4f49f52ad132ca1e359465e39
-  data.tar.gz: 4da0947c03c1846b073b331f4118f8b07e42b4138c3450b3f2ce6ba967e3a8451edf843622e3e6b6bbe4f5c70951866d7c6abbcc7e1211d10501b75fefa8e095
+  metadata.gz: 7cf1ec0a11f3f02788d41cb710e49263e3ea429d9e0db7ee856453a3616fc7d8350498e96401efed19f45afa90fe4ef61bdfa484568b5520c78cbd67988120d4
+  data.tar.gz: f7dd2378a8fcb3704db070f20a814c7c4f90956e34684ad22d68335ac3f0ed37ce268bd43ebcab92427ad017c74fa5ed4f5225bfda6cf7623c01643d2561ef23

data/lib/braid/command.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 module Braid
   class Command
     extend T::Sig
@@ -9,15 +9,13 @@ module Braid
     extend Operations::VersionControl
     include Operations::VersionControl
 
-    def self.run(command, *args)
+    sig {void}
+    def run
       verify_git_version!
       check_working_dir!
-
-      klass = Commands.const_get(command.to_s)
-      klass.new.run(*args)
-
+      run_internal
     rescue BraidError => error
-      handle_error(error)
+      Command.handle_error(error)
     end
 
     sig {params(error: BraidError).returns(T.noreturn)}
@@ -36,6 +34,11 @@ module Braid
       puts "Braid: #{str}"
     end
 
+    sig {void}
+    def initialize
+      @config = T.let(nil, T.nilable(Config))
+    end
+
     sig {params(str: String).void}
     def msg(str)
       self.class.msg(str)
@@ -43,7 +46,7 @@ module Braid
 
     sig {returns(Config)}
     def config
-      @config ||= Config.new({'mode' => config_mode})
+      @config ||= Config.new(mode: config_mode)
     end
 
     sig {returns(T::Boolean)}
@@ -58,23 +61,32 @@ module Braid
 
     private
 
+    # TODO (typing): We could make this method abstract if our fake Sorbet
+    # runtime supported abstract methods.
+    sig {void}
+    def run_internal
+      raise InternalError, 'Command.run_internal not overridden'
+    end
+
     sig {returns(Config::ConfigMode)}
     def config_mode
       Config::MODE_MAY_WRITE
     end
 
+    sig {params(mirror: Mirror).void}
     def setup_remote(mirror)
       existing_force = Braid.force
       begin
         Braid.force = true
-        Command.run(:Setup, mirror.path)
+        Commands::Setup.new(mirror.path).run
       ensure
         Braid.force = existing_force
       end
     end
 
-    def clear_remote(mirror, options)
-      git.remote_rm(mirror.remote) unless options['keep']
+    sig {params(mirror: Mirror).void}
+    def clear_remote(mirror)
+      git.remote_rm(mirror.remote)
     end
 
     sig {returns(T::Boolean)}
@@ -83,12 +95,12 @@ module Braid
     end
 
     sig {void}
-    def self.verify_git_version!
+    def verify_git_version!
       git.require_version!(REQUIRED_GIT_VERSION)
     end
 
     sig {void}
-    def self.check_working_dir!
+    def check_working_dir!
       # If we aren't in a git repository at all, git.is_inside_worktree will
       # propagate a "fatal: Not a git repository" ShellException.
       unless git.is_inside_worktree
@@ -104,7 +116,12 @@ module Braid
       git.ensure_clean!
     end
 
-    def with_reset_on_error
+    sig {
+      type_parameters(:R).params(
+        blk: T.proc.returns(T.type_parameter(:R))
+      ).returns(T.type_parameter(:R))
+    }
+    def with_reset_on_error(&blk)
       bail_on_local_changes!
 
       work_head = git.head
@@ -124,11 +141,16 @@ module Braid
       git.add(CONFIG_FILE)
     end
 
+    sig {params(mirror: Mirror, revision: T.nilable(String)).returns(String)}
     def display_revision(mirror, revision = nil)
-      revision ||= mirror.revision
+      # This shouldn't be called while `mirror.revision` is nil in the middle of
+      # `braid add`.  TODO (typing): Remove `T.must` if we restructure the code
+      # so `mirror.revision` is annotated as non-nil.
+      revision ||= T.must(mirror.revision)
       "'#{revision[0, 7]}'"
     end
 
+    sig {params(mirror: Mirror).returns(Operations::Git::ObjectID)}
     def determine_repository_revision(mirror)
       if mirror.tag
         if use_local_cache?
@@ -148,6 +170,7 @@ module Braid
       end
     end
 
+    sig {params(mirror: Mirror, revision: T.nilable(Operations::Git::ObjectExpr)).returns(Operations::Git::ObjectID)}
     def validate_new_revision(mirror, revision)
       if revision.nil?
         determine_repository_revision(mirror)

data/lib/braid/commands/add.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Add < Command
@@ -13,6 +13,7 @@ module Braid
       # 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.
+      sig {params(url: String).returns(T.nilable(String))}
       def get_default_branch_name(url)
         head_targets = []
         # The `HEAD` parameter here doesn't appear to do an exact match (it
@@ -30,28 +31,37 @@ module Braid
         m[1]
       end
 
-      def run(url, options = {})
+      sig {params(url: String, options: Mirror::Options).void}
+      def initialize(url, options)
+        @url = url
+        @options = options
+      end
+
+      private
+
+      sig {void}
+      def run_internal
         with_reset_on_error do
-          if options['branch'].nil? && options['tag'].nil? && options['revision'].nil?
-            default_branch = get_default_branch_name(url)
+          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
+            @options.branch = default_branch
           end
 
-          mirror           = config.add_from_options(url, options)
+          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
+          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? ? '' : " branch '#{mirror.branch}'"
           tag_message      = mirror.tag.nil? ? '' : " tag '#{mirror.tag}'"
-          revision_message = options['revision'] ? " at #{display_revision(mirror, options['revision'])}" : ''
+          revision_message = @options.revision ? " at #{display_revision(mirror, @options.revision)}" : ''
           msg "Adding mirror of '#{mirror.url}'#{branch_message}#{tag_message}#{revision_message}."
 
           # these commands are explained in the subtree merge guide
@@ -61,7 +71,7 @@ MSG
           setup_remote(mirror)
           mirror.fetch
 
-          new_revision = validate_new_revision(mirror, options['revision'])
+          new_revision = validate_new_revision(mirror, @options.revision)
           target_item = mirror.upstream_item_for_revision(new_revision)
 
           git.add_item_to_index(target_item, mirror.path, true)
@@ -73,7 +83,7 @@ MSG
           git.commit("Add mirror '#{mirror.path}' at #{display_revision(mirror)}")
           msg "Added mirror at #{display_revision(mirror)}."
 
-          clear_remote(mirror, options)
+          clear_remote(mirror)
         end
       end
     end

data/lib/braid/commands/diff.rb

@@ -1,14 +1,27 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Diff < Command
-      def run(path = nil, options = {})
-        path ? diff_one(path, options) : diff_all(options)
+      class Options < T::Struct
+        prop :git_diff_args, T::Array[String]
+        prop :keep, T::Boolean
+      end
+
+      sig {params(path: T.nilable(String), options: Options).void}
+      def initialize(path, options)
+        @path = path
+        @options = options
       end
 
       private
 
-      def diff_all(options = {})
+      sig {void}
+      def run_internal
+        @path ? diff_one(@path) : diff_all
+      end
+
+      sig {void}
+      def diff_all
         # We don't want "git diff" to invoke the pager once for each mirror.
         # TODO: Invoke the default pager once for the entire output.
         Operations::with_modified_environment({ 'GIT_PAGER' => ''}) do
@@ -16,31 +29,35 @@ module Braid
             separator
             msg "Diffing #{path}\n"
             separator
-            show_diff(path, options)
+            show_diff(path)
           end
         end
       end
 
-      def diff_one(path, options = {})
-        show_diff(path, options)
+      sig {params(path: String).void}
+      def diff_one(path)
+        show_diff(path)
       end
 
+      sig {void}
       def separator
         puts "=======================================================\n"
       end
 
-      def show_diff(path, options = {})
+      sig {params(path: String).void}
+      def show_diff(path)
         mirror = config.get!(path)
         setup_remote(mirror)
         mirror.fetch_base_revision_if_missing
 
         # XXX: Warn if the user specifies file paths that are outside the
         # mirror?  Currently, they just won't match anything.
-        git.diff_to_stdout(mirror.diff_args(options['git_diff_args']))
+        git.diff_to_stdout(mirror.diff_args(@options.git_diff_args))
 
-        clear_remote(mirror, options)
+        clear_remote(mirror) unless @options.keep
       end
 
+      sig {returns(Config::ConfigMode)}
       def config_mode
         Config::MODE_READ_ONLY
       end

data/lib/braid/commands/push.rb

@@ -1,9 +1,10 @@
-# typed: true
+# typed: strict
 require 'fileutils'
 require 'tmpdir'
 
 module Braid
     class NoPushToTag < BraidError
+      sig {returns(String)}
       def message
         "mirror is based off a tag. Can not push to a tag: #{super}"
       end
@@ -11,12 +12,26 @@ module Braid
 
   module Commands
     class Push < Command
-      def run(path, options = {})
-        mirror = config.get!(path)
+      class Options < T::Struct
+        prop :keep, T::Boolean
+        prop :branch, T.nilable(String)
+      end
+
+      sig {params(path: String, options: Options).void}
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      private
 
-        branch = options['branch'] || mirror.branch
+      sig {void}
+      def run_internal
+        mirror = config.get!(@path)
 
-        raise NoPushToTag, path unless branch
+        branch = @options.branch || mirror.branch
+
+        raise NoPushToTag, @path unless branch
 
         setup_remote(mirror)
         mirror.fetch
@@ -24,14 +39,14 @@ module Braid
         base_revision = determine_repository_revision(mirror)
         unless mirror.merged?(base_revision)
           msg 'Mirror is not up to date. Stopping.'
-          clear_remote(mirror, options)
+          clear_remote(mirror) unless @options.keep
           return
         end
 
         diff = mirror.diff
         if diff.empty?
           msg 'No local changes found. Stopping.'
-          clear_remote(mirror, options)
+          clear_remote(mirror) unless @options.keep
           return
         end
         local_mirror_item = git.get_tree_item('HEAD', mirror.path)
@@ -115,14 +130,13 @@ module Braid
         end
         FileUtils.rm_r(clone_dir)
 
-        clear_remote(mirror, options)
+        clear_remote(mirror) unless @options.keep
       end
-    end
 
-    private
-
-    def config_mode
-      Config::MODE_READ_ONLY  # Surprisingly enough.
+      sig {returns(Config::ConfigMode)}
+      def config_mode
+        Config::MODE_READ_ONLY  # Surprisingly enough.
+      end
     end
   end
 end

data/lib/braid/commands/remove.rb

@@ -1,9 +1,22 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Remove < Command
-      def run(path, options = {})
-        mirror = config.get!(path)
+      class Options < T::Struct
+        prop :keep, T::Boolean
+      end
+
+      sig {params(path: String, options: Options).void}
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      private
+
+      sig {void}
+      def run_internal
+        mirror = config.get!(@path)
 
         with_reset_on_error do
           msg "Removing mirror from '#{mirror.path}'."
@@ -13,7 +26,7 @@ module Braid
           config.remove(mirror)
           add_config_file
 
-          if options[:keep]
+          if @options.keep
             msg "Not removing remote '#{mirror.remote}'" if verbose?
           elsif git.remote_url(mirror.remote)
             msg "Removed remote '#{mirror.path}'" if verbose?

data/lib/braid/commands/setup.rb

@@ -1,13 +1,20 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Setup < Command
-      def run(path = nil)
-        path ? setup_one(path) : setup_all
+      sig {params(path: T.nilable(String)).void}
+      def initialize(path = nil)
+        @path = path
       end
 
       private
 
+      sig {void}
+      def run_internal
+        @path ? setup_one(@path) : setup_all
+      end
+
+      sig {void}
       def setup_all
         msg 'Setting up all mirrors.'
         config.mirrors.each do |path|
@@ -15,6 +22,7 @@ module Braid
         end
       end
 
+      sig {params(path: String).void}
       def setup_one(path)
         mirror = config.get!(path)
 
@@ -33,6 +41,7 @@ module Braid
         git.remote_add(mirror.remote, url)
       end
 
+      sig {returns(Config::ConfigMode)}
       def config_mode
         Config::MODE_READ_ONLY
       end

data/lib/braid/commands/status.rb

@@ -1,23 +1,31 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Status < Command
-      def run(path = nil, options = {})
-        path ? status_one(path, options) : status_all(options)
+      sig {params(path: T.nilable(String)).void}
+      def initialize(path)
+        @path = path
       end
 
       private
 
-      def status_all(options = {})
+      sig {void}
+      def run_internal
+        @path ? status_one(@path) : status_all
+      end
+
+      sig {void}
+      def status_all
         print "\n"
         msg "Listing all mirrors.\n=======================================================\n"
         config.mirrors.each do |path|
-          status_one(path, options)
+          status_one(path)
         end
         print "\n"
       end
 
-      def status_one(path, options = {})
+      sig {params(path: String).void}
+      def status_one(path)
         mirror = config.get!(path)
         setup_remote(mirror)
         mirror.fetch
@@ -31,7 +39,7 @@ module Braid
           print " [BRANCH=#{mirror.branch}]"
         end
         msg "Fetching new commits for '#{mirror.path}'." if verbose?
-        new_revision = validate_new_revision(mirror, options['revision'])
+        new_revision = validate_new_revision(mirror, nil)
         print ' (Remote Modified)' if new_revision.to_s != mirror.base_revision.to_s
         local_file_count = git.read_ls_files(mirror.path).split.size
         if 0 == local_file_count
@@ -40,9 +48,10 @@ module Braid
           print ' (Locally Modified)'
         end
         print "\n"
-        clear_remote(mirror, options)
+        clear_remote(mirror)
       end
 
+      sig {returns(Config::ConfigMode)}
       def config_mode
         Config::MODE_READ_ONLY
       end

data/lib/braid/commands/update.rb

@@ -1,26 +1,47 @@
-# typed: true
+# typed: strict
 module Braid
   module Commands
     class Update < Command
-      def run(path, options = {})
-        path ? update_one(path, options) : update_all(options)
+      class Options < T::Struct
+        prop :branch, T.nilable(String)
+        prop :tag, T.nilable(String)
+        prop :revision, T.nilable(Operations::Git::ObjectExpr)
+        prop :head, T::Boolean
+        prop :keep, T::Boolean
       end
 
-      protected
+      sig {params(path: T.nilable(String), options: Options).void}
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      private
+
+      sig {void}
+      def run_internal
+        @path ? update_one(@path) : update_all
+      end
+
+      sig {void}
+      def update_all
+        # Maintain previous behavior of ignoring these options when updating all
+        # mirrors.  TODO: Should we make it an error if the options were passed?
+        @options.revision = nil
+        @options.head = false
 
-      def update_all(options = {})
-        options.reject! { |k, v| %w(revision head).include?(k) }
         msg 'Updating all mirrors.'
         config.mirrors.each do |path|
           bail_on_local_changes!
-          update_one(path, options)
+          update_one(path)
         end
       end
 
-      def update_one(path, options = {})
+      sig {params(path: String).void}
+      def update_one(path)
         bail_on_local_changes!
 
-        raise BraidError, "Do not specify --head option anymore. Please use '--branch MyBranch' to track a branch or '--tag MyTag' to track a branch" if options['head']
+        raise BraidError, "Do not specify --head option anymore. Please use '--branch MyBranch' to track a branch or '--tag MyTag' to track a branch" if @options.head
 
         mirror           = config.get!(path)
 
@@ -31,16 +52,16 @@ module Braid
         original_branch = mirror.branch
         original_tag = mirror.tag
 
-        raise BraidError, 'Can not update mirror specifying both a revision and a tag' if options['revision'] && options['tag']
-        raise BraidError, 'Can not update mirror specifying both a branch and a tag' if options['branch'] && options['tag']
+        raise BraidError, 'Can not update mirror specifying both a revision and a tag' if @options.revision && @options.tag
+        raise BraidError, 'Can not update mirror specifying both a branch and a tag' if @options.branch && @options.tag
 
-        if options['tag']
-          mirror.tag = options['tag']
+        if @options.tag
+          mirror.tag = @options.tag
           mirror.branch = nil
-        elsif options['branch']
+        elsif @options.branch
           mirror.tag = nil
-          mirror.branch = options['branch']
-        elsif options['revision']
+          mirror.branch = @options.branch
+        elsif @options.revision
           mirror.tag = nil
           mirror.branch = nil
         end
@@ -51,11 +72,14 @@ module Braid
         msg "Fetching new commits for '#{mirror.path}'." if verbose?
         mirror.fetch
 
-        new_revision = options['revision']
+        new_revision = @options.revision
         begin
           new_revision = validate_new_revision(mirror, new_revision)
         rescue InvalidRevision
           # Ignored as it means the revision matches expected
+          # This can only happen if new_revision was non-nil.
+          # TODO (typing): Untangle the logic and remote this `T.must`.
+          new_revision = T.must(new_revision)
         end
 
         from_desc =
@@ -68,19 +92,19 @@ module Braid
           msg "Switching mirror '#{mirror.path}' to branch '#{mirror.branch}' from #{from_desc}."
         elsif mirror.tag && original_tag != mirror.tag
           msg "Switching mirror '#{mirror.path}' to tag '#{mirror.tag}' from #{from_desc}."
-        elsif options['revision'] && original_revision != options['revision']
-          msg "Switching mirror '#{mirror.path}' to revision '#{options['revision']}' from #{from_desc}."
+        elsif @options.revision && original_revision != @options.revision
+          msg "Switching mirror '#{mirror.path}' to revision '#{@options.revision}' from #{from_desc}."
         else
           switching = false
         end
 
         if !switching &&
           (
-            (options['revision'] && was_locked && new_revision == mirror.base_revision) ||
-            (options['revision'].nil? && !was_locked && mirror.merged?(git.rev_parse(new_revision)))
+            (@options.revision && was_locked && new_revision == mirror.base_revision) ||
+            (@options.revision.nil? && !was_locked && mirror.merged?(git.rev_parse(new_revision)))
           )
           msg "Mirror '#{mirror.path}' is already up to date."
-          clear_remote(mirror, options)
+          clear_remote(mirror) unless @options.keep
           return
         end
 
@@ -120,7 +144,7 @@ module Braid
 
         git.commit(commit_message)
         msg "Updated mirror to #{display_revision(mirror)}."
-        clear_remote(mirror, options)
+        clear_remote(mirror) unless @options.keep
       end
     end
   end