geet 0.27.2 → 0.27.3

data/lib/geet/git/repository.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Git
     # This class represents, for convenience, both the local and the remote repository, but the
     # remote code is separated in each provider module.
     class Repository
+      extend T::Sig
+
       LOCAL_ACTION_ON_UPSTREAM_REPOSITORY_MESSAGE = <<~STR
         The action will be performed on a fork, but an upstream repository has been found!
       STR
@@ -15,28 +18,42 @@ module Geet
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
-      # warnings:               disable all the warnings.
-      # protected_repositories: warn when creating an issue/pr on this repositories (entry format:
-      #                         `owner/repo`).
-      #
+      sig {
+        params(
+          upstream: T::Boolean,
+          git_client: Utils::GitClient,
+          warnings: T::Boolean,                          # disable all the warnings
+          protected_repositories: T::Array[String]       # warn when creating an issue/pr on these repos (format: `owner/repo`)
+        )
+        .void
+      }
       def initialize(upstream: false, git_client: DEFAULT_GIT_CLIENT, warnings: true, protected_repositories: [])
         @upstream = upstream
         @git_client = git_client
-        @api_token = extract_env_api_token
+        @api_token = T.let(extract_env_api_token, String)
         @warnings = warnings
         @protected_repositories = protected_repositories
       end
 
       # REMOTE FUNCTIONALITIES (REPOSITORY)
 
+      sig { returns(T.any(T::Array[Github::User], T::Array[Gitlab::User])) }
       def collaborators
         attempt_provider_call(:User, :list_collaborators, api_interface)
       end
 
+      sig { returns(T.any(T::Array[Github::Label], T::Array[Gitlab::Label])) }
       def labels
         attempt_provider_call(:Label, :list, api_interface)
       end
 
+      sig {
+        params(
+          title: String,
+          description: String
+        )
+        .returns(T.any(Github::Issue, Gitlab::Issue))
+      }
       def create_issue(title, description)
         confirm(LOCAL_ACTION_ON_UPSTREAM_REPOSITORY_MESSAGE) if local_action_on_upstream_repository? && @warnings
         confirm(ACTION_ON_PROTECTED_REPOSITORY_MESSAGE) if action_on_protected_repository? && @warnings
@@ -44,30 +61,63 @@ module Geet
         attempt_provider_call(:Issue, :create, title, description, api_interface)
       end
 
+      sig {
+        params(
+          name: String,
+          color: String
+        )
+        .returns(T.any(Github::Label, Gitlab::Label))
+      }
       def create_label(name, color)
         attempt_provider_call(:Label, :create, name, color, api_interface)
       end
 
+      sig { params(name: String).void }
       def delete_branch(name)
         attempt_provider_call(:Branch, :delete, name, api_interface)
       end
 
+      sig {
+        params(
+          assignee: T.nilable(T.any(Github::User, Gitlab::User)),
+          milestone: T.nilable(T.any(Github::Milestone, Gitlab::Milestone))
+        )
+        .returns(T.any(T::Array[Github::AbstractIssue], T::Array[Gitlab::Issue]))
+      }
       def issues(assignee: nil, milestone: nil)
         attempt_provider_call(:Issue, :list, api_interface, assignee:, milestone:)
       end
 
+      sig {
+        params(
+          title: String
+        )
+        .returns(T.any(Github::Milestone, Gitlab::Milestone))
+      }
       def create_milestone(title)
         attempt_provider_call(:Milestone, :create, title, api_interface)
       end
 
+      sig { returns(T.any(T::Array[Github::Milestone], T::Array[Gitlab::Milestone])) }
       def milestones
         attempt_provider_call(:Milestone, :list, api_interface)
       end
 
+      sig { params(number: Integer).void }
       def close_milestone(number)
         attempt_provider_call(:Milestone, :close, number, api_interface)
       end
 
+      sig {
+        params(
+          title: String,
+          description: String,
+          head: String,                                    # source branch
+          base: String,                                    # target branch
+          draft: T::Boolean
+        )
+        .returns(T.any(Github::PR, Gitlab::PR))
+      }
       def create_pr(title, description, head, base, draft)
         confirm(LOCAL_ACTION_ON_UPSTREAM_REPOSITORY_MESSAGE) if local_action_on_upstream_repository? && @warnings
         confirm(ACTION_ON_PROTECTED_REPOSITORY_MESSAGE) if action_on_protected_repository? && @warnings
@@ -75,30 +125,42 @@ module Geet
         attempt_provider_call(:PR, :create, title, description, head, api_interface, base, draft: draft)
       end
 
+      sig {
+        params(
+          owner: T.nilable(String),                                      # filter by repository owner
+          head: T.nilable(String),                                       # filter by source branch
+          milestone: T.nilable(T.any(Github::Milestone, Gitlab::Milestone))
+        )
+        .returns(T.any(T::Array[Github::PR], T::Array[Gitlab::PR]))
+      }
       def prs(owner: nil, head: nil, milestone: nil)
         attempt_provider_call(:PR, :list, api_interface, owner:, head:, milestone:)
       end
 
       # Returns the RemoteRepository instance.
       #
+      sig { returns(Github::RemoteRepository) }
       def remote
         attempt_provider_call(:RemoteRepository, :find, api_interface)
       end
 
       # REMOTE FUNCTIONALITIES (ACCOUNT)
 
+      sig { returns(Github::User) }
       def authenticated_user
         attempt_provider_call(:User, :authenticated, api_interface)
       end
 
       # OTHER/CONVENIENCE FUNCTIONALITIES
 
+      sig { returns(T::Boolean) }
       def upstream?
         @upstream
       end
 
       # For cases where it's necessary to work on the downstream repo.
       #
+      sig { returns(Git::Repository) }
       def downstream
         raise "downstream() is not available on not-upstream repositories!" if !upstream?
 
@@ -109,6 +171,7 @@ module Geet
 
       # PROVIDER
 
+      sig { returns(String) }
       def extract_env_api_token
         env_variable_name = "#{provider_name.upcase}_API_TOKEN"
 
@@ -117,6 +180,7 @@ module Geet
 
       # Attempt to find the provider class and send the specified method, returning a friendly
       # error (functionality X [Y] is missing) when a class/method is missing.
+      sig { params(class_name: Symbol, meth: Symbol, args: T.untyped).returns(T.untyped) }
       def attempt_provider_call(class_name, meth, *args)
         module_name = provider_name.capitalize
 
@@ -142,23 +206,27 @@ module Geet
 
       # WARNINGS
 
+      sig { params(message: String).void }
       def confirm(message)
         full_message = "WARNING! #{message.strip}\nPress Enter to continue, or Ctrl+C to exit now."
         print full_message
         gets
       end
 
+      sig { returns(T::Boolean) }
       def action_on_protected_repository?
         path = @git_client.path(upstream: @upstream)
         @protected_repositories.include?(path)
       end
 
+      sig { returns(T::Boolean) }
       def local_action_on_upstream_repository?
         @git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME) && !@upstream
       end
 
       # OTHER HELPERS
 
+      sig { returns(T.any(Github::ApiInterface, Gitlab::ApiInterface)) }
       def api_interface
         path = @git_client.path(upstream: @upstream)
         attempt_provider_call(:ApiInterface, :new, @api_token, repo_path: path, upstream: @upstream)
@@ -166,8 +234,9 @@ module Geet
 
       # Bare downcase provider name, eg. `github`
       #
+      sig { returns(String) }
       def provider_name
-        @git_client.provider_domain[/(.*)\.\w+/, 1]
+        T.must(@git_client.provider_domain[/(.*)\.\w+/, 1])
       end
     end
   end

data/lib/geet/github/abstract_issue.rb

@@ -48,7 +48,7 @@ module Geet
             )
         ).returns(T::Array[Geet::Github::AbstractIssue]) }
       def self.list(api_interface, milestone: nil, assignee: nil, &type_filter)
-        api_path = 'issues'
+        api_path = "issues"
 
         request_params = {}
         request_params[:milestone] = milestone.number if milestone
@@ -57,9 +57,9 @@ module Geet
         response = T.cast(api_interface.send_request(api_path, params: request_params, multipage: true), T::Array[T::Hash[String, T.untyped]])
 
         abstract_issues_list = response.map do |issue_data|
-          number = T.cast(issue_data.fetch('number'), Integer)
-          title = T.cast(issue_data.fetch('title'), String)
-          link = T.cast(issue_data.fetch('html_url'), String)
+          number = T.cast(issue_data.fetch("number"), Integer)
+          title = T.cast(issue_data.fetch("title"), String)
+          link = T.cast(issue_data.fetch("html_url"), String)
 
           new(number, api_interface, title, link) if type_filter.nil? || type_filter.call(issue_data)
         end

data/lib/geet/github/api_interface.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 # typed: strict
 
-require 'uri'
-require 'net/http'
-require 'json'
+require "uri"
+require "net/http"
+require "json"
 
 module Geet
   module Github
     class ApiInterface
       extend T::Sig
 
-      API_AUTH_USER = T.let('', String) # We don't need the login, as the API key uniquely identifies the user
-      API_BASE_URL = T.let('https://api.github.com', String)
-      GRAPHQL_API_URL = T.let('https://api.github.com/graphql', String)
+      API_AUTH_USER = T.let("", String) # We don't need the login, as the API key uniquely identifies the user
+      API_BASE_URL = T.let("https://api.github.com", String)
+      GRAPHQL_API_URL = T.let("https://api.github.com/graphql", String)
 
       sig { returns(T.nilable(String)) }
       attr_reader :repository_path
@@ -111,7 +111,7 @@ module Geet
         Net::HTTP.start(uri.host, use_ssl: true) do |http|
           request = Net::HTTP::Post.new(uri).tap do
             it.basic_auth API_AUTH_USER, @api_token
-            it['Accept'] = 'application/vnd.github.v3+json'
+            it["Accept"] = "application/vnd.github.v3+json"
             it.body = {query:, variables:}.to_json
           end
 
@@ -127,12 +127,12 @@ module Geet
             raise Geet::Shared::HttpError.new(error_message, response.code)
           end
 
-          if parsed_response&.key?('errors')
-            error_messages = T.cast(parsed_response['errors'], T::Array[T::Hash[String, T.untyped]]).map { |err| T.cast(err['message'], String) }.join(', ')
+          if parsed_response&.key?("errors")
+            error_messages = T.cast(parsed_response["errors"], T::Array[T::Hash[String, T.untyped]]).map { |err| T.cast(err["message"], String) }.join(", ")
             raise Geet::Shared::HttpError.new("GraphQL errors: #{error_messages}", response.code)
           end
 
-          T.cast(T.must(parsed_response).fetch('data'), T::Hash[String, T.untyped])
+          T.cast(T.must(parsed_response).fetch("data"), T::Hash[String, T.untyped])
         end
       end
 
@@ -146,8 +146,8 @@ module Geet
       def api_url(api_path)
         url = API_BASE_URL
 
-        if !api_path.start_with?('/')
-          raise 'Missing repo path!' if @repository_path.nil?
+        if !api_path.start_with?("/")
+          raise "Missing repo path!" if @repository_path.nil?
           url += "/repos/#{@repository_path}/"
         end
 
@@ -171,7 +171,7 @@ module Geet
 
           request.basic_auth API_AUTH_USER, @api_token
           request.body = data.to_json if data
-          request['Accept'] = 'application/vnd.github.v3+json'
+          request["Accept"] = "application/vnd.github.v3+json"
 
           http.request(request)
         end
@@ -184,7 +184,7 @@ module Geet
         ).returns(URI::Generic)
       }
       def encode_uri(address, params)
-        address += '?' + URI.encode_www_form(params) if params
+        address += "?" + URI.encode_www_form(params) if params
 
         URI(address)
       end
@@ -195,7 +195,7 @@ module Geet
         ).returns(T::Boolean)
       }
       def error?(response)
-        !response.code.start_with?('2')
+        !response.code.start_with?("2")
       end
 
       sig {
@@ -204,22 +204,22 @@ module Geet
         ).returns(String)
       }
       def decode_and_format_error(parsed_response)
-        message = parsed_response['message']
+        message = parsed_response["message"]
 
-        if parsed_response.key?('errors')
-          message += ':'
+        if parsed_response.key?("errors")
+          message += ":"
 
-          error_details = parsed_response['errors'].map do |error_data|
-            error_code = error_data.fetch('code')
+          error_details = parsed_response["errors"].map do |error_data|
+            error_code = error_data.fetch("code")
 
-            if error_code == 'custom'
+            if error_code == "custom"
               " #{error_data.fetch('message')}"
             else
               " #{error_code} (#{error_data.fetch('field')})"
             end
           end
 
-          message += error_details.join(', ')
+          message += error_details.join(", ")
         end
 
         message
@@ -232,7 +232,7 @@ module Geet
       }
       def link_next_page(response_headers)
         # An array (or nil) is returned.
-        link_header = Array(response_headers['link'])
+        link_header = Array(response_headers["link"])
 
         return nil if link_header.empty?
 

data/lib/geet/github/gist.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 # typed: strict
 
-require_relative 'abstract_issue'
-require_relative '../github/gist'
+require_relative "abstract_issue"
+require_relative "../github/gist"
 
 module Geet
   module Github
@@ -19,13 +19,13 @@ module Geet
         ).returns(Geet::Github::Gist)
       }
       def self.create(filename, content, api_interface, description: nil, publik: false)
-        api_path = '/gists'
+        api_path = "/gists"
 
         request_data = prepare_request_data(filename, content, description, publik)
 
         response = T.cast(api_interface.send_request(api_path, data: T.unsafe(request_data)), T::Hash[String, T.untyped])
 
-        id = T.cast(response.fetch('id'), String)
+        id = T.cast(response.fetch("id"), String)
 
         new(id)
       end
@@ -55,15 +55,15 @@ module Geet
         }
         def prepare_request_data(filename, content, description, publik)
           request_data = {
-            'public' => publik,
-            'files' => {
+            "public" => publik,
+            "files" => {
               filename => {
-                'content' => content,
+                "content" => content,
               },
             },
           }
 
-          request_data['description'] = description if description
+          request_data["description"] = description if description
 
           request_data
         end

data/lib/geet/github/issue.rb

@@ -14,7 +14,7 @@ module Geet
         ).returns(Geet::Github::Issue)
       }
       def self.create(title, description, api_interface)
-        api_path = 'issues'
+        api_path = "issues"
         request_data = {title:, body: description}
 
         response = T.cast(
@@ -22,9 +22,9 @@ module Geet
           T::Hash[String, T.untyped]
         )
 
-        issue_number = T.cast(response.fetch('number'), Integer)
-        title = T.cast(response.fetch('title'), String)
-        link = T.cast(response.fetch('html_url'), String)
+        issue_number = T.cast(response.fetch("number"), Integer)
+        title = T.cast(response.fetch("title"), String)
+        link = T.cast(response.fetch("html_url"), String)
 
         new(issue_number, api_interface, title, link)
       end
@@ -42,7 +42,7 @@ module Geet
       }
       def self.list(api_interface, assignee: nil, milestone: nil, &type_filter)
         super do |issue_data|
-          !issue_data.key?('pull_request')
+          !issue_data.key?("pull_request")
         end
       end
     end

data/lib/geet/github/label.rb

@@ -29,12 +29,12 @@ module Geet
         ).returns(T::Array[Geet::Github::Label])
       }
       def self.list(api_interface)
-        api_path = 'labels'
+        api_path = "labels"
         response = T.cast(api_interface.send_request(api_path, multipage: true), T::Array[T::Hash[String, T.untyped]])
 
         response.map do |label_entry|
-          name = T.cast(label_entry.fetch('name'), String)
-          color = T.cast(label_entry.fetch('color'), String)
+          name = T.cast(label_entry.fetch("name"), String)
+          color = T.cast(label_entry.fetch("color"), String)
 
           new(name, color)
         end
@@ -49,7 +49,7 @@ module Geet
         ).returns(Geet::Github::Label)
       }
       def self.create(name, color, api_interface)
-        api_path = 'labels'
+        api_path = "labels"
         request_data = {name:, color:}
 
         api_interface.send_request(api_path, data: request_data)

data/lib/geet/github/milestone.rb

@@ -15,7 +15,7 @@ module Geet
       sig { returns(T.nilable(Date)) }
       attr_reader :due_on
 
-      STATE_CLOSED = 'closed'
+      STATE_CLOSED = "closed"
 
       class << self
         extend T::Sig
@@ -49,7 +49,7 @@ module Geet
         ).returns(Geet::Github::Milestone)
       }
       def self.create(title, api_interface)
-        api_path = 'milestones'
+        api_path = "milestones"
         request_data = {title: title}
 
         response = T.cast(
@@ -57,8 +57,8 @@ module Geet
           T::Hash[String, T.untyped]
         )
 
-        number = T.cast(response.fetch('number'), Integer)
-        title = T.cast(response.fetch('title'), String)
+        number = T.cast(response.fetch("number"), Integer)
+        title = T.cast(response.fetch("title"), String)
         due_on = nil
 
         new(number, title, due_on, api_interface)
@@ -72,7 +72,7 @@ module Geet
         ).returns(T::Array[Geet::Github::Milestone])
       }
       def self.list(api_interface)
-        api_path = 'milestones'
+        api_path = "milestones"
 
         response = T.cast(
           api_interface.send_request(api_path, multipage: true),
@@ -80,10 +80,10 @@ module Geet
         )
 
         response.map do |milestone_data|
-          number = T.cast(milestone_data.fetch('number'), Integer)
-          title = T.cast(milestone_data.fetch('title'), String)
+          number = T.cast(milestone_data.fetch("number"), Integer)
+          title = T.cast(milestone_data.fetch("title"), String)
           due_on = parse_iso_8601_timestamp(
-            T.cast(milestone_data.fetch('due_on'), T.nilable(String))
+            T.cast(milestone_data.fetch("due_on"), T.nilable(String))
           )
 
           new(number, title, due_on, api_interface)

data/lib/geet/github/pr.rb

@@ -36,7 +36,7 @@ module Geet
         ).returns(Geet::Github::PR)
       }
       def self.create(title, description, head, api_interface, base, draft: false)
-        api_path = 'pulls'
+        api_path = "pulls"
 
         if api_interface.upstream?
           authenticated_user = Geet::Github::User.authenticated(api_interface).username
@@ -47,10 +47,10 @@ module Geet
 
         response = T.cast(api_interface.send_request(api_path, data: request_data), T::Hash[String, T.untyped])
 
-        number = T.cast(response.fetch('number'), Integer)
-        title = T.cast(response.fetch('title'), String)
-        link = T.cast(response.fetch('html_url'), String)
-        node_id = T.cast(response['node_id'], T.nilable(String))
+        number = T.cast(response.fetch("number"), Integer)
+        title = T.cast(response.fetch("title"), String)
+        link = T.cast(response.fetch("html_url"), String)
+        node_id = T.cast(response["node_id"], T.nilable(String))
 
         new(number, api_interface, title, link, node_id:)
       end
@@ -74,7 +74,7 @@ module Geet
         check_list_params!(milestone, assignee, head)
 
         if head
-          api_path = 'pulls'
+          api_path = "pulls"
 
           # Technically, the upstream approach could be used for both, but it's actually good to have
           # both of them as reference.
@@ -96,8 +96,8 @@ module Geet
             # For this reason, we can't use that param, and have to filter manually.
             #
             unfiltered_response.select do |pr_data|
-              pr_head = T.cast(pr_data.fetch('head'), T::Hash[String, T.untyped])
-              label = T.cast(pr_head.fetch('label'), String)
+              pr_head = T.cast(pr_data.fetch("head"), T::Hash[String, T.untyped])
+              label = T.cast(pr_head.fetch("label"), String)
 
               label == "#{owner}:#{head}"
             end
@@ -111,15 +111,15 @@ module Geet
           end
 
           response.map do |pr_data|
-            number = T.cast(pr_data.fetch('number'), Integer)
-            title = T.cast(pr_data.fetch('title'), String)
-            link = T.cast(pr_data.fetch('html_url'), String)
+            number = T.cast(pr_data.fetch("number"), Integer)
+            title = T.cast(pr_data.fetch("title"), String)
+            link = T.cast(pr_data.fetch("html_url"), String)
 
             new(number, api_interface, title, link)
           end
         else
           result = super(api_interface, milestone:, assignee:) do |issue_data|
-            issue_data.key?('pull_request')
+            issue_data.key?("pull_request")
           end
 
           T.cast(result, T::Array[Geet::Github::PR])
@@ -207,22 +207,22 @@ module Geet
           }
         GRAPHQL
 
-        owner, name = T.must(@api_interface.repository_path).split('/')
+        owner, name = T.must(@api_interface.repository_path).split("/")
 
         response = @api_interface.send_graphql_request(query, variables: {owner:, name:, number:})
-        repo_data = response['repository'].transform_keys(&:to_sym)
-        commit_count = repo_data[:pullRequest]['commits']['totalCount']
+        repo_data = response["repository"].transform_keys(&:to_sym)
+        commit_count = repo_data[:pullRequest]["commits"]["totalCount"]
 
         if commit_count == 1 && repo_data[:squashMergeAllowed]
-          'SQUASH'
+          "SQUASH"
         elsif repo_data[:mergeCommitAllowed]
-          'MERGE'
+          "MERGE"
         elsif repo_data[:squashMergeAllowed]
-          'SQUASH'
+          "SQUASH"
         elsif repo_data[:rebaseMergeAllowed]
-          'REBASE'
+          "REBASE"
         else
-          raise 'No merge methods are allowed on this repository'
+          raise "No merge methods are allowed on this repository"
         end
       end
 

data/lib/geet/github/remote_repository.rb

@@ -43,7 +43,7 @@ module Geet
 
         response = T.cast(api_interface.send_request(api_path), T::Hash[String, T.untyped])
 
-        parent_hash = T.cast(response['parent'], T.nilable(T::Hash[String, T.untyped]))
+        parent_hash = T.cast(response["parent"], T.nilable(T::Hash[String, T.untyped]))
         parent_path = T.cast(parent_hash&.fetch("full_name)"), T.nilable(String))
 
         new(api_interface, parent_path:)

data/lib/geet/github/user.rb

@@ -63,11 +63,11 @@ module Geet
         ).returns(Geet::Github::User)
       }
       def self.authenticated(api_interface)
-        api_path = '/user'
+        api_path = "/user"
 
         response = T.cast(api_interface.send_request(api_path), T::Hash[String, T.untyped])
 
-        login = T.cast(response.fetch('login'), String)
+        login = T.cast(response.fetch("login"), String)
 
         new(login, api_interface)
       end
@@ -78,11 +78,11 @@ module Geet
         ).returns(T::Array[Geet::Github::User])
       }
       def self.list_collaborators(api_interface)
-        api_path = 'collaborators'
+        api_path = "collaborators"
         response = T.cast(api_interface.send_request(api_path, multipage: true), T::Array[T::Hash[String, T.untyped]])
 
         response.map do |user_entry|
-          login = T.cast(user_entry.fetch('login'), String)
+          login = T.cast(user_entry.fetch("login"), String)
           new(login, api_interface)
         end
       end
@@ -100,7 +100,7 @@ module Geet
 
         response = T.cast(api_interface.send_request(api_path), T::Hash[String, T.untyped])
 
-        permission = T.cast(response.fetch('permission'), String)
+        permission = T.cast(response.fetch("permission"), String)
 
         check_permission!(permission)