geet 0.27.2 → 0.27.3

data/lib/geet/services/create_pr.rb

@@ -1,28 +1,44 @@
 # frozen_string_literal: true
-# typed: true
+# typed: strict
 
-require 'io/console' # stdlib
+require "io/console" # stdlib
 
 module Geet
   module Services
     class CreatePr < AbstractCreateIssue
+      extend T::Sig
+
       include Geet::Shared::RepoPermissions
       include Geet::Shared::Selection
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
+      sig {
+        params(
+          repository: Git::Repository,
+          out: IO,
+          git_client: Utils::GitClient
+        ).void
+      }
       def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
         super(repository)
         @git_client = git_client
         @out = out
       end
 
-      # options:
-      #   :labels
-      #   :reviewers
-      #   :open_browser
-      #   :automerge
-      #
+      sig {
+        params(
+          title: String,
+          description: String,
+          labels: T.nilable(String),
+          milestone: T.nilable(String),
+          reviewers: T.nilable(String),
+          base: T.nilable(String),
+          draft: T::Boolean,
+          open_browser: T::Boolean,
+          automerge: T::Boolean
+        ).returns(T.any(Github::PR, Gitlab::PR))
+      }
       def execute(
         title, description, labels: nil, milestone: nil, reviewers: nil,
         base: nil, draft: false, open_browser: false, automerge: false
@@ -66,29 +82,47 @@ module Geet
 
       # Internal actions
 
+      sig { void }
       def ensure_clean_tree
-        raise 'The working tree is not clean!' if !@git_client.working_tree_clean?
+        raise "The working tree is not clean!" if !@git_client.working_tree_clean?
       end
 
+      sig {
+        params(
+          labels: T.nilable(String),
+          milestone: T.nilable(String),
+          reviewers: T.nilable(String)
+        ).returns([
+          T.nilable(T::Array[T.any(Github::Label, Gitlab::Label)]),
+          T.nilable(T.any(Github::Milestone, Gitlab::Milestone)),
+          T.nilable(T::Array[T.any(Github::User, Gitlab::User)]),
+        ])
+      }
       def find_and_select_attributes(labels, milestone, reviewers)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        selection_manager.add_attribute(:labels, 'label', labels, SELECTION_MULTIPLE, name_method: :name) if labels
-        selection_manager.add_attribute(:milestones, 'milestone', milestone, SELECTION_SINGLE, name_method: :title) if milestone
+        selection_manager.add_attribute(:labels, "label", labels, SELECTION_MULTIPLE, name_method: :name) if labels
+        selection_manager.add_attribute(:milestones, "milestone", milestone, SELECTION_SINGLE, name_method: :title) if milestone
 
         if reviewers
-          selection_manager.add_attribute(:collaborators, 'reviewer', reviewers, SELECTION_MULTIPLE, name_method: :username) do |all_reviewers|
+          selection_manager.add_attribute(:collaborators, "reviewer", reviewers, SELECTION_MULTIPLE, name_method: :username) do |all_reviewers|
             authenticated_user = @repository.authenticated_user
-            all_reviewers.delete_if { |reviewer| reviewer.username == authenticated_user.username }
+            reviewers_typed = T.cast(all_reviewers, T::Array[Github::User])
+            reviewers_typed.delete_if { |reviewer| reviewer.username == authenticated_user.username }
           end
         end
 
-        selection_manager.select_attributes
+        selected_attributes = selection_manager.select_attributes
+
+        selected_labels = T.cast(selected_attributes.shift, T.nilable(T::Array[Github::Label])) if labels
+        selected_milestone = T.cast(selected_attributes.shift, T.nilable(Github::Milestone)) if milestone
+        selected_reviewers = T.cast(selected_attributes.shift, T.nilable(T::Array[Github::User])) if reviewers
+
+        [selected_labels, selected_milestone, selected_reviewers]
       end
 
-      # `input` is a Sorbet workaround (error 7001).
-      #
-      def sync_with_remote_branch(input: T.untyped)
+      sig { void }
+      def sync_with_remote_branch
         # Fetching doesn't have a real world case when there isn't a remote branch. It's also not generally
         # useful when there is a remote branch, however, since a force push is an option, it's important
         # to be 100% sure of the current diff.
@@ -98,6 +132,8 @@ module Geet
 
           @git_client.fetch
 
+          input = T.let("", String)
+
           if !@git_client.remote_branch_diff_commits.empty?
             while true
               @out.print "The local and remote branches differ! Force push (Y/D/Q*)?"
@@ -105,14 +141,14 @@ module Geet
               @out.puts
 
               case input.downcase
-              when 'y'
+              when "y"
                 @git_client.push(force: true)
                 break
-              when 'd'
+              when "d"
                 @out.puts "# DIFF: ########################################################################"
                 @out.puts @git_client.remote_branch_diff
                 @out.puts "################################################################################"
-              when 'q'
+              when "q"
                 exit(1)
               end
             end
@@ -134,7 +170,7 @@ module Geet
             @out.puts
 
             case input.downcase.rstrip
-            when 'n', ''
+            when "n", ""
               # exit the cycle
             else
               retry
@@ -143,14 +179,30 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          title: String,
+          description: String,
+          base: T.nilable(String),
+          draft: T::Boolean
+        ).returns(T.any(Github::PR, Gitlab::PR))
+      }
       def create_pr(title, description, base:, draft:)
-        @out.puts 'Creating PR...'
+        @out.puts "Creating PR..."
 
         base ||= @git_client.main_branch
 
         @repository.create_pr(title, description, @git_client.current_branch, base, draft)
       end
 
+      sig {
+        params(
+          pr: T.any(Github::PR, Gitlab::PR),
+          labels: T.nilable(T::Array[T.any(Github::Label, Gitlab::Label)]),
+          milestone: T.nilable(T.any(Github::Milestone, Gitlab::Milestone)),
+          reviewers: T.nilable(T::Array[T.any(Github::User, Gitlab::User)])
+        ).void
+      }
       def edit_pr(pr, labels, milestone, reviewers)
         # labels/reviewers can be nil (parameter not passed) or empty array (parameter passed, but
         # nothing selected)
@@ -163,10 +215,16 @@ module Geet
         request_review_thread&.join
       end
 
+      sig {
+        params(
+          pr: T.any(Github::PR, Gitlab::PR),
+          selected_labels: T::Array[T.any(Github::Label, Gitlab::Label)]
+        ).returns(Thread)
+      }
       def add_labels(pr, selected_labels)
         raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
 
-        labels_list = selected_labels.map(&:name).join(', ')
+        labels_list = selected_labels.map(&:name).join(", ")
 
         @out.puts "Adding labels #{labels_list}..."
 
@@ -175,6 +233,12 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          pr: T.any(Github::PR, Gitlab::PR),
+          milestone: T.any(Github::Milestone, Gitlab::Milestone)
+        ).returns(Thread)
+      }
       def set_milestone(pr, milestone)
         raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
 
@@ -185,6 +249,12 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          pr: T.any(Github::PR, Gitlab::PR),
+          reviewers: T::Array[T.any(Github::User, Gitlab::User)]
+        ).returns(Thread)
+      }
       def request_review(pr, reviewers)
         raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
 
@@ -197,6 +267,11 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          pr: T.any(Github::PR, Gitlab::PR)
+        ).void
+      }
       def enable_automerge(pr)
         raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
 

data/lib/geet/services/list_issues.rb

@@ -22,7 +22,8 @@ module Geet
       sig {
         params(
           assignee: T.nilable(String)
-        ).returns(T::Array[T.any(Github::Issue, Gitlab::Issue)])
+        )
+        .returns(T.any(T::Array[Github::AbstractIssue], T::Array[Gitlab::Issue]))
       }
       def execute(assignee: nil)
         selected_assignee = find_and_select_attributes(assignee) if assignee
@@ -44,9 +45,9 @@ module Geet
       def find_and_select_attributes(assignee)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        selection_manager.add_attribute(:collaborators, 'assignee', assignee, SELECTION_SINGLE, name_method: :username)
+        selection_manager.add_attribute(:collaborators, "assignee", assignee, SELECTION_SINGLE, name_method: :username)
 
-        selection_manager.select_attributes[0]
+        T.cast(selection_manager.select_attributes[0], T.any(Github::User, Gitlab::User))
       end
     end
   end

data/lib/geet/services/list_labels.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     class ListLabels
+      extend T::Sig
+
+      sig { params(repository: Git::Repository, out: T.any(IO, StringIO)).void }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end
 
+      sig {
+        returns(T::Array[T.any(Github::Label, Gitlab::Label)])
+      }
       def execute
         labels = @repository.labels
 

data/lib/geet/services/list_milestones.rb

@@ -1,13 +1,25 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     class ListMilestones
+      extend T::Sig
+
+      sig {
+        params(
+          repository: Git::Repository,
+          out: T.any(IO, StringIO)
+        ).void
+      }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end
 
+      sig {
+        returns(T::Array[T.any(Github::Milestone, Gitlab::Milestone)])
+      }
       def execute
         milestones = find_milestones
         all_milestone_entries = find_all_milestone_entries(milestones)
@@ -33,24 +45,41 @@ module Geet
 
       # Not included in the Milestone class because descriptions (which will be customizable)
       # are considered formatters, conceptually external to the class.
+      sig {
+        params(
+          milestone: T.any(Github::Milestone, Gitlab::Milestone)
+        ).returns(String)
+      }
       def milestone_description(milestone)
         description = "#{milestone.number}. #{milestone.title}"
         description += " (due #{milestone.due_on})" if milestone.due_on
         description
       end
 
+      sig {
+        returns(T::Array[T.any(Github::Milestone, Gitlab::Milestone)])
+      }
       def find_milestones
-        @out.puts 'Finding milestones...'
+        @out.puts "Finding milestones..."
 
         @repository.milestones
       end
 
-      # Returns the structure:
-      #
-      # { milestone => {issues: [...], prs: [...]}}
-      #
+      sig {
+        params(
+          milestones: T::Array[T.any(Github::Milestone, Gitlab::Milestone)]
+        ).returns(
+          T::Hash[
+            T.any(Github::Milestone, Gitlab::Milestone),
+            {
+              issues: T::Array[T.any(Github::Issue, Gitlab::Issue)],
+              prs: T::Array[T.any(Github::PR, Gitlab::PR)],
+            }
+          ]
+        )
+      }
       def find_all_milestone_entries(milestones)
-        @out.puts 'Finding issues and PRs...'
+        @out.puts "Finding issues and PRs..."
 
         all_milestone_entries = {}
         all_threads = []

data/lib/geet/services/list_prs.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     class ListPrs
+      extend T::Sig
+
+      sig { params(repository: Git::Repository, out: T.any(IO, StringIO)).void }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end
 
+      sig {
+        returns(T::Array[T.any(Github::PR, Gitlab::PR)])
+      }
       def execute
         prs = @repository.prs
 

data/lib/geet/services/merge_pr.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
@@ -9,19 +10,29 @@ module Geet
     # constraints, but speeds up the workflow.
     #
     class MergePr
+      extend T::Sig
+
       include Geet::Helpers::ServicesWorkflowHelper
       include Geet::Shared
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
+      sig { params(repository: Git::Repository, out: T.any(IO, StringIO), git_client: Utils::GitClient).void }
       def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
         @repository = repository
         @out = out
         @git_client = git_client
       end
 
+      sig {
+        params(
+          delete_branch: T::Boolean,
+          squash: T::Boolean
+        )
+        .returns(T.any(Github::PR, Gitlab::PR))
+      }
       def execute(delete_branch: false, squash: false)
-        merge_method = 'squash' if squash
+        merge_method = "squash" if squash
 
         @git_client.fetch
 
@@ -62,42 +73,49 @@ module Geet
 
       private
 
+      sig { void }
       def check_no_missing_upstream_commits
-        missing_upstream_commits = @git_client.cherry('HEAD', head: :main_branch)
+        missing_upstream_commits = @git_client.cherry("HEAD", head: :main_branch)
 
         raise "Found #{missing_upstream_commits.size} missing upstream commits!" if missing_upstream_commits.any?
       end
 
+      sig { params(pr: T.any(Github::PR, Gitlab::PR), merge_method: T.nilable(String)).void }
       def merge_pr(pr, merge_method: nil)
         @out.puts "Merging PR ##{pr.number}..."
 
         pr.merge(merge_method:)
       end
 
+      sig { params(branch: String).void }
       def delete_remote_branch(branch)
         @out.puts "Deleting remote branch #{branch}..."
 
         @repository.delete_branch(branch)
       end
 
+      sig { void }
       def fetch_repository
         @out.puts "Fetching repository..."
 
         @git_client.fetch
       end
 
+      sig { params(branch: String).void }
       def checkout_branch(branch)
         @out.puts "Checking out #{branch}..."
 
         @git_client.checkout(branch)
       end
 
+      sig { void }
       def rebase
         @out.puts "Rebasing..."
 
         @git_client.rebase
       end
 
+      sig { params(branch: String, force: T::Boolean).void }
       def delete_local_branch(branch, force:)
         @out.puts "Deleting local branch #{branch}..."
 

data/lib/geet/services/open_pr.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # typed: strict
 
-require 'stringio'
+require "stringio"
 
 module Geet
   module Services
@@ -18,7 +18,7 @@ module Geet
       sig {
         params(
           repository: Git::Repository,
-          out: StringIO,
+          out: IO,
           git_client: Utils::GitClient
         ).void
       }

data/lib/geet/services/open_repo.rb

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     # Open in the browser the current repository.
     #
     class OpenRepo
+      extend T::Sig
+
       include Helpers::OsHelper
 
       DEFAULT_GIT_CLIENT = Utils::GitClient.new
 
+      sig { params(repository: Git::Repository, out: IO, git_client: Utils::GitClient).void }
       def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
         @repository = repository
         @out = out
         @git_client = git_client
       end
 
+      sig { params(upstream: T::Boolean).returns(String) }
       def execute(upstream: false)
         remote_options = upstream ? {name: Utils::GitClient::UPSTREAM_NAME} : {}
 
@@ -30,6 +35,7 @@ module Geet
 
       # The repository URL may be in any of the git/http protocols.
       #
+      sig { params(repo_url: String).returns(String) }
       def convert_repo_url_to_http_protocol(repo_url)
         case repo_url
         when /https:/
@@ -39,7 +45,7 @@ module Geet
           raise
         end
 
-        domain, _, path = repo_url.match(Utils::GitClient::REMOTE_URL_REGEX)[2..4]
+        domain, _, path = T.must(repo_url.match(Utils::GitClient::REMOTE_URL_REGEX))[2..4]
 
         "https://#{domain}/#{path}"
       end

data/lib/geet/shared/repo_permissions.rb

@@ -6,10 +6,10 @@ module Geet
     module RepoPermissions
       extend T::Sig
 
-      PERMISSION_ADMIN = 'admin'
-      PERMISSION_WRITE = 'write'
-      PERMISSION_READ = 'read'
-      PERMISSION_NONE = 'none'
+      PERMISSION_ADMIN = "admin"
+      PERMISSION_WRITE = "write"
+      PERMISSION_READ = "read"
+      PERMISSION_NONE = "none"
 
       ALL_PERMISSIONS = T.let(T.unsafe(nil), T::Array[String]) if defined?(T::sig)
       ALL_PERMISSIONS = [

data/lib/geet/shared/selection.rb

@@ -4,9 +4,9 @@
 module Geet
   module Shared
     module Selection
-      MANUAL_LIST_SELECTION_FLAG = '-'
+      MANUAL_LIST_SELECTION_FLAG = "-"
       # Don't select anything; return the null value.
-      SKIP_LIST_SELECTION_FLAG = ''
+      SKIP_LIST_SELECTION_FLAG = ""
 
       SELECTION_SINGLE = :single
       SELECTION_MULTIPLE = :multiple

data/lib/geet/utils/attributes_selection_manager.rb

@@ -23,7 +23,7 @@ module Geet
 
       # Initialize the instance, and starts the background threads.
       #
-      sig { params(repository: T.untyped, out: T.any(IO, StringIO)).void }
+      sig { params(repository: Geet::Git::Repository, out: T.any(IO, StringIO)).void }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
@@ -34,13 +34,14 @@ module Geet
       #
       sig {
         params(
-          repository_call: T.untyped,
-          description: T.untyped,
-          pattern: T.untyped,
-          selection_type: T.untyped,
-          name_method: T.untyped,
-          pre_selection_hook: T.nilable(T.proc.params(all_reviewers: T::Array[T.untyped]).void)
-        ).void
+          repository_call: Symbol,
+          description: String,
+          pattern: T.nilable(String),
+          selection_type: Symbol,
+          name_method: T.nilable(Symbol),
+          pre_selection_hook: T.nilable(T.proc.params(entries: T::Array[T.anything]).returns(T::Array[T.anything]))
+        )
+        .void
       }
       def add_attribute(repository_call, description, pattern, selection_type, name_method: nil, &pre_selection_hook)
         raise "Unrecognized selection type #{selection_type.inspect}" if ![SELECTION_SINGLE, SELECTION_MULTIPLE].include?(selection_type)
@@ -52,7 +53,7 @@ module Geet
 
       # Select and return the attributes, in the same order they've been added.
       #
-      sig { returns(T.untyped) }
+      sig { returns(T::Array[T.anything]) }
       def select_attributes
         @selections_data.map do |finder_thread, description, pattern, selection_type, name_method, pre_selection_hook|
           entries = finder_thread.value
@@ -70,6 +71,7 @@ module Geet
 
       private
 
+      sig { params(repository_call: Symbol).returns(Thread) }
       def find_attribute_entries(repository_call)
         @out.puts "Finding #{repository_call}..."
 
@@ -86,6 +88,15 @@ module Geet
       #
       #   select_entry('milestone', all_milestones, '0.1.0', :title)
       #
+      sig {
+        params(
+          entry_type: String,
+          entries: T::Array[T.anything],
+          pattern: String,
+          name_method: T.nilable(Symbol)
+        )
+        .returns(T.nilable(T.anything))
+      }
       def select_entry(entry_type, entries, pattern, name_method)
         case pattern
         when MANUAL_LIST_SELECTION_FLAG
@@ -101,13 +112,22 @@ module Geet
       #
       #   select_entries('reviewer', all_collaborators, 'donaldduck', nil)
       #
+      sig {
+        params(
+          entry_type: String,
+          entries: T::Array[T.anything],
+          pattern: T.any(String, T::Array[String]),
+          name_method: T.nilable(Symbol)
+        )
+        .returns(T::Array[T.anything])
+      }
       def select_entries(entry_type, entries, pattern, name_method)
         # Support both formats Array and String.
         # It seems that at some point, SimpleScripting started splitting arrays automatically, so until
         # the code is adjusted accordingly, this accommodates both the CLI and the test suite.
         # Tracked here: https://github.com/saveriomiroddi/geet/issues/171.
         #
-        pattern = pattern.join(',') if pattern.is_a?(Array)
+        pattern = pattern.join(",") if pattern.is_a?(Array)
 
         case pattern
         when MANUAL_LIST_SELECTION_FLAG