geet 0.23.0 → 0.24.0

data/lib/geet/utils/attributes_selection_manager.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
-
-require_relative 'manual_list_selection'
-require_relative 'string_matching_selection'
-require_relative '../shared/selection'
+# typed: true
 
 module Geet
   module Utils
@@ -14,6 +11,8 @@ module Geet
     # multiple attributes are required (typically, three).
     #
     class AttributesSelectionManager
+      extend T::Sig
+
       include Geet::Shared::Selection
 
       # Workaround for VCR not supporting multithreading; see https://github.com/vcr/vcr/issues/200.
@@ -24,6 +23,7 @@ module Geet
 
       # Initialize the instance, and starts the background threads.
       #
+      sig { params(repository: T.untyped, out: T.any(IO, StringIO)).void }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
@@ -32,6 +32,16 @@ module Geet
 
       # selection_type: SELECTION_SINGLE or SELECTION_MULTIPLE
       #
+      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
+      }
       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)
 
@@ -42,6 +52,7 @@ module Geet
 
       # Select and return the attributes, in the same order they've been added.
       #
+      sig { returns(T.untyped) }
       def select_attributes
         @selections_data.map do |finder_thread, description, pattern, selection_type, name_method, pre_selection_hook|
           entries = finder_thread.value

data/lib/geet/utils/git_client.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
+# typed: true
 
 require 'English'
 require 'shellwords'
-require_relative '../helpers/os_helper'
 
 module Geet
   module Utils
     # Represents the git program interface; used for performing git operations.
     #
     class GitClient
+      extend T::Sig
+
       include Geet::Helpers::OsHelper
 
       ORIGIN_NAME = 'origin'
@@ -40,6 +42,7 @@ module Geet
 
       CLEAN_TREE_MESSAGE_REGEX = /^nothing to commit, working tree clean$/
 
+      sig { params(location: T.untyped ).void }
       def initialize(location: nil)
         @location = location
       end

data/lib/geet/utils/manual_list_selection.rb

@@ -1,27 +1,28 @@
 # frozen_string_literal: true
+# typed: strict
 
 require 'tty-prompt'
 
 module Geet
   module Utils
     class ManualListSelection
+      extend T::Sig
+
       NO_SELECTION_KEY = '(none)'
 
       PAGER_SIZE = 16
 
       # Shows a prompt for selecting an entry from a list.
       #
-      # Returns nil, without showing the prompt, if there are no entries.
-      #
-      # entry_type:      description of the entries type.
-      # entries:         array of objects; if they're not strings, must also pass :name_method.
-      #                  this value must not be empty.
-      # name_method:     required when non-string objects are passed as entries; its invocation on
-      #                  each object must return a string, which is used as key.
-      #
-      # returns: the selected entry. if the null entry (NO_SELECTION_KEY) is selected, nil is
-      #          returned.
-      #
+      sig {
+        type_parameters(:T).params(
+          entry_type: String,                        # description of the entries type.
+          entries: T::Array[T.type_parameter(:T)],   # array of objects; if they're not strings, must also pass :name_method.
+          name_method: T.nilable(Symbol)             # required when non-string objects are passed as entries; its invocation
+                                                     # on each object must return a string, which is used as key.
+        ).returns(T.nilable(T.type_parameter(:T)))   # selected entry. nil is returned if the null entry (NO_SELECTION_KEY) is
+                                                     # selected, or if there are no entries.
+      }
       def select_entry(entry_type, entries, name_method: nil)
         return nil if entries.empty?
 
@@ -37,12 +38,17 @@ module Geet
 
       # Shows a prompt for selecting an entry from a list.
       #
-      # Returns an empty array, without showing the prompt, if there are no entries.
-      #
       # See #select_entry for the parameters.
       #
       # returns: array of entries.
       #
+      sig {
+        type_parameters(:T).params(
+          entry_type: String,
+          entries: T::Array[T.type_parameter(:T)],
+          name_method: T.nilable(Symbol)
+        ).returns(T::Array[T.type_parameter(:T)])   # empty array, without showing the prompt, if there are no entries.
+      }
       def select_entries(entry_type, entries, name_method: nil)
         return [] if entries.empty?
 
@@ -55,10 +61,17 @@ module Geet
 
       private
 
+      sig { params(entries: T::Array[T.untyped], entry_type: String).void }
       def check_entries(entries, entry_type)
         raise "No #{entry_type} provided!" if entries.empty?
       end
 
+      sig {
+        params(
+          entries: T::Array[T.untyped],
+          name_method: T.nilable(Symbol)
+        ).returns(T::Hash[String, T.untyped])
+      }
       def create_entries_map(entries, name_method)
         entries.each_with_object({}) do |entry, current_map|
           key = name_method ? entry.send(name_method) : entry
@@ -66,17 +79,29 @@ module Geet
         end
       end
 
+      sig {
+        type_parameters(:T).params(entries: T::Hash[String, T.type_parameter(:T)]
+        ).returns(T::Hash[String, T.type_parameter(:T)])
+      }
       def add_no_selection_entry(entries)
         {NO_SELECTION_KEY => nil}.merge(entries)
       end
 
+      sig {
+        type_parameters(:T).params(
+          invocation_method: Symbol,
+          entry_type: String,
+          entries: T::Hash[String, T.type_parameter(:T)]
+        ).returns(T.type_parameter(:T))
+      }
       def show_prompt(invocation_method, entry_type, entries)
         # Arguably inexact phrasing for avoiding language complexities.
         prompt_title = "Please select the #{entry_type}(s):"
 
-        TTY::Prompt.new.send(invocation_method, prompt_title, entries, filter: true, per_page: PAGER_SIZE)
+        ::TTY::Prompt.new.send(invocation_method, prompt_title, entries, filter: true, per_page: PAGER_SIZE)
       end
 
+      sig { params(entry: T.untyped).returns(T::Boolean) }
       def no_selection?(entry)
         entry == NO_SELECTION_KEY
       end

data/lib/geet/utils/string_matching_selection.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Utils
     class StringMatchingSelection
+      extend T::Sig
+
+      sig { params(entry_type: String, entries: T::Array[T.untyped], pattern: String, name_method: T.nilable(Symbol)).returns(T.untyped) }
       def select_entry(entry_type, entries, pattern, name_method: nil)
         entries_found = entries.select do |entry|
           entry = entry.send(name_method) if name_method
@@ -19,6 +23,7 @@ module Geet
         end
       end
 
+      sig { params(entry_type: String, entries: T::Array[T.untyped], raw_patterns: String, name_method: T.nilable(Symbol)).returns(T::Array[T.untyped]) }
       def select_entries(entry_type, entries, raw_patterns, name_method: nil)
         patterns = raw_patterns.split(',')
 

data/lib/geet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geet
-  VERSION = '0.23.0'
+  VERSION = '0.24.0'
 end

data/lib/geet.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect("pr" => "PR")
+loader.setup
+
+module Geet
+end

data/sorbet/config

@@ -1,5 +1,7 @@
 --disable-watchman
 --suppress-payload-superclass-redefinition-for=Reline::ANSI
 --dir=.
---ignore=lib
 --ignore=spec
+# Without a Bundler lockfile, we need to ignore gems vendored in CI, to avoid typechecking gem sources
+# that may clash with those in the repo.
+--ignore=vendor/bundle