geet 0.26.0 → 0.27.0

data/lib/geet/gitlab/label.rb

@@ -1,32 +1,61 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Gitlab
     class Label
-      attr_reader :name, :color
+      extend T::Sig
 
+      sig { returns(String) }
+      attr_reader :name
+
+      sig { returns(String) }
+      attr_reader :color
+
+      sig {
+        params(
+          name: String,
+          color: String
+        ).void
+      }
       def initialize(name, color)
         @name = name
         @color = color
       end
 
-      # Returns a flat list of names in string form.
-      def self.list(api_interface, **)
+      sig {
+        params(
+          api_interface: ApiInterface
+        ).returns(T::Array[Label])
+      }
+      def self.list(api_interface)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/labels"
-        response = api_interface.send_request(api_path, multipage: true)
+        response = T.cast(
+          api_interface.send_request(api_path, multipage: true),
+          T::Array[T::Hash[String, T.untyped]]
+        )
 
         response.map do |label_entry|
-          name = label_entry.fetch('name')
-          color = label_entry.fetch('color').sub('#', '') # normalize
+          name = T.cast(label_entry.fetch('name'), String)
+          color = T.cast(label_entry.fetch('color'), String)
+
+          color = color.sub('#', '') # normalize
 
           new(name, color)
         end
       end
 
       # See https://docs.gitlab.com/ee/api/labels.html#create-a-new-label
-      def self.create(name, color, api_interface, **)
+      sig {
+        params(
+          name: String,
+          color: String,
+          api_interface: ApiInterface
+        ).returns(Label)
+      }
+      def self.create(name, color, api_interface)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/labels"
-        request_data = { name: name, color: "##{color}" }
+        request_data = { name:, color: "##{color}" }
 
         api_interface.send_request(api_path, data: request_data)
 

data/lib/geet/gitlab/milestone.rb

@@ -1,12 +1,30 @@
 # frozen_string_literal: true
+# typed: strict
 
 require 'date'
 
 module Geet
   module Gitlab
     class Milestone
-      attr_reader :number, :title, :due_on
+      extend T::Sig
 
+      sig { returns(Integer) }
+      attr_reader :number
+
+      sig { returns(String) }
+      attr_reader :title
+
+      sig { returns(T.nilable(Date)) }
+      attr_reader :due_on
+
+      sig {
+        params(
+          number: Integer,
+          title: String,
+          due_on: T.nilable(Date),
+          api_interface: ApiInterface
+        ).void
+      }
       def initialize(number, title, due_on, api_interface)
         @number = number
         @title = title
@@ -17,23 +35,40 @@ module Geet
 
       # See https://docs.gitlab.com/ee/api/milestones.html#list-project-milestones
       #
-      def self.list(api_interface, **)
+      sig {
+        params(
+          api_interface: ApiInterface
+        ).returns(T::Array[Milestone])
+      }
+      def self.list(api_interface)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/milestones"
 
-        response = api_interface.send_request(api_path, multipage: true)
+        response = T.cast(
+          api_interface.send_request(api_path, multipage: true),
+          T::Array[T::Hash[String, T.untyped]]
+        )
 
         response.map do |milestone_data|
-          number = milestone_data.fetch('iid')
-          title = milestone_data.fetch('title')
-          due_on = parse_due_date(milestone_data.fetch('due_date'))
+          number = T.cast(milestone_data.fetch('iid'), Integer)
+          title = T.cast(milestone_data.fetch('title'), String)
+          due_on = parse_due_date(
+            T.cast(milestone_data.fetch('due_date'), T.nilable(String))
+          )
 
           new(number, title, due_on, api_interface)
         end
       end
 
       class << self
+        extend T::Sig
+
         private
 
+        sig {
+          params(
+            raw_due_date: T.nilable(String)
+          ).returns(T.nilable(Date))
+        }
         def parse_due_date(raw_due_date)
           Date.parse(raw_due_date) if raw_due_date
         end

data/lib/geet/gitlab/pr.rb

@@ -1,10 +1,28 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Gitlab
     class PR
-      attr_reader :number, :title, :link
+      extend T::Sig
 
+      sig { returns(Integer) }
+      attr_reader :number
+
+      sig { returns(String) }
+      attr_reader :title
+
+      sig { returns(String) }
+      attr_reader :link
+
+      sig {
+        params(
+          number: Integer,
+          api_interface: ApiInterface,
+          title: String,
+          link: String
+        ).void
+      }
       def initialize(number, api_interface, title, link)
         @number = number
         @api_interface = api_interface
@@ -12,11 +30,19 @@ module Geet
         @link = link
       end
 
-      # owner: required only for API compatibility. it's not required; if passed, it's only checked
-      #        against the API path to make sure it's correct.
-      #
       # See https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests
       #
+      sig {
+        params(
+          api_interface: ApiInterface,
+          milestone: T.nilable(Milestone),
+          assignee: T.nilable(User),
+          # Required only for API compatibility. it's not required; if passed, it's only checked
+          # against the API path to make sure it's correct.
+          owner: T.nilable(String),
+          head: T.nilable(String)
+        ).returns(T::Array[PR])
+      }
       def self.list(api_interface, milestone: nil, assignee: nil, owner: nil, head: nil)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/merge_requests"
 
@@ -27,19 +53,37 @@ module Geet
         request_params[:milestone] = milestone.title if milestone
         request_params[:source_branch] = head if head
 
-        response = api_interface.send_request(api_path, params: request_params, multipage: true)
+        response = T.cast(
+          api_interface.send_request(api_path, params: request_params, multipage: true),
+          T::Array[T::Hash[String, T.untyped]]
+        )
 
         response.map do |issue_data, result|
-          number = issue_data.fetch('iid')
-          title = issue_data.fetch('title')
-          link = issue_data.fetch('web_url')
+          number = T.cast(issue_data.fetch('iid'), Integer)
+          title = T.cast(issue_data.fetch('title'), String)
+          link = T.cast(issue_data.fetch('web_url'), String)
 
           new(number, api_interface, title, link)
         end
       end
 
+      # See https://docs.gitlab.com/ee/api/notes.html#create-new-merge-request-note
+      #
+      sig { params(comment: String).void }
+      def comment(comment)
+        api_path = "projects/#{@api_interface.path_with_namespace(encoded: true)}/merge_requests/#{number}/notes"
+        request_data = { body: comment }
+
+        @api_interface.send_request(api_path, data: request_data)
+      end
+
       # See https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
       #
+      sig {
+        params(
+          merge_method: T.nilable(String)
+        ).void
+      }
       def merge(merge_method: nil)
         raise ArgumentError, "GitLab does not support the merge_method parameter" if merge_method
 
@@ -49,8 +93,16 @@ module Geet
       end
 
       class << self
+        extend T::Sig
+
         private
 
+        sig {
+          params(
+            api_interface: ApiInterface,
+            owner: String
+          ).void
+        }
         def check_list_owner!(api_interface, owner)
           if !api_interface.path_with_namespace.start_with?("#{owner}/")
             raise "Mismatch owner/API path!: #{owner}<>#{api_interface.path_with_namespace}"

data/lib/geet/gitlab/user.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Gitlab
     class User
-      attr_reader :id, :username
+      extend T::Sig
 
+      sig { returns(Integer) }
+      attr_reader :id
+
+      sig { returns(String) }
+      attr_reader :username
+
+      sig {
+        params(
+          id: Integer,
+          username: String,
+          api_interface: ApiInterface
+        ).void
+      }
       def initialize(id, username, api_interface)
         @id = id
         @username = username
@@ -13,14 +27,22 @@ module Geet
 
       # Returns an array of User instances
       #
-      def self.list_collaborators(api_interface, **)
+      sig {
+        params(
+          api_interface: ApiInterface
+        ).returns(T::Array[User])
+      }
+      def self.list_collaborators(api_interface)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/members"
 
-        response = api_interface.send_request(api_path, multipage: true)
+        response = T.cast(
+          api_interface.send_request(api_path, multipage: true),
+          T::Array[T::Hash[String, T.untyped]]
+        )
 
         response.map do |user_entry|
-          id = user_entry.fetch('id')
-          username = user_entry.fetch('username')
+          id = T.cast(user_entry.fetch('id'), Integer)
+          username = T.cast(user_entry.fetch('username'), String)
 
           new(id, username, api_interface)
         end

data/lib/geet/helpers/services_workflow_helper.rb

@@ -36,7 +36,7 @@ module Geet
 
         @out.puts "Finding PR with head (#{owner}:#{head})..."
 
-        prs = @repository.prs(owner: owner, head: head)
+        prs = @repository.prs(owner:, head:)
 
         raise "Expected to find only one PR for the current branch; found: #{prs.size}" if prs.size != 1
 

data/lib/geet/services/comment_pr.rb

@@ -16,7 +16,7 @@ module Geet
         @git_client = git_client
       end
 
-      def execute(comment, open_browser: false, **)
+      def execute(comment, open_browser: false)
         pr = checked_find_branch_pr
         pr.comment(comment)
         open_file_with_default_application(pr.link) if open_browser

data/lib/geet/services/create_gist.rb

@@ -27,7 +27,7 @@ module Geet
         @out.puts "Creating a #{gist_access} gist..."
 
         filename = File.basename(full_filename)
-        gist = Geet::Github::Gist.create(filename, content, @api_interface, description: description, publik: publik)
+        gist = Geet::Github::Gist.create(filename, content, @api_interface, description:, publik:)
 
         if open_browser
           open_file_with_default_application(gist.link)

data/lib/geet/services/create_issue.rb

@@ -1,21 +1,27 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     class CreateIssue < AbstractCreateIssue
+      extend T::Sig
+
       include Geet::Shared::RepoPermissions
       include Geet::Shared::Selection
 
-      # options:
-      #   :labels
-      #   :milestone:     number or description pattern.
-      #   :assignees
-      #   :open_browser
-      #
+      sig {
+        params(
+          title: String,
+          description: String,
+          labels: T.nilable(String),
+          milestone: T.nilable(String), # Number or description pattern
+          assignees: T.nilable(String),
+          open_browser: T::Boolean
+        ).returns(T.any(Github::Issue, Gitlab::Issue))
+      }
       def execute(
           title, description,
-          labels: nil, milestone: nil, assignees: nil, open_browser: false,
-          **
+          labels: nil, milestone: nil, assignees: nil, open_browser: false
       )
         # Inefficient (in worst case, triples the pre issue creation waiting time: #is_collaborator?,
         # #has_permissions?, and the attributes batch), but not trivial to speed up. Not difficult
@@ -48,6 +54,17 @@ module Geet
 
       # Internal actions
 
+      sig {
+        params(
+          labels: T.nilable(String),
+          milestone: T.nilable(String),
+          assignees: 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, assignees)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
@@ -58,12 +75,26 @@ module Geet
         selection_manager.select_attributes
       end
 
+      sig {
+        params(
+          title: String,
+          description: String
+        ).returns(T.any(Github::Issue, Gitlab::Issue))
+      }
       def create_issue(title, description)
         @out.puts 'Creating the issue...'
 
         issue = @repository.create_issue(title, description)
       end
 
+      sig {
+        params(
+          issue: T.any(Github::Issue, Gitlab::Issue),
+          labels: T.nilable(T::Array[T.any(Github::Label, Gitlab::Label)]),
+          milestone: T.nilable(T.any(Github::Milestone, Gitlab::Milestone)),
+          assignees: T.nilable(T::Array[T.any(Github::User, Gitlab::User)])
+        ).void
+      }
       def edit_issue(issue, labels, milestone, assignees)
         # labels can be nil (parameter not passed) or empty array (parameter passed, but nothing
         # selected)
@@ -82,7 +113,15 @@ module Geet
         assign_users_thread&.join
       end
 
+      sig {
+        params(
+          issue: T.any(Github::Issue, Gitlab::Issue),
+          selected_labels: T::Array[T.any(Github::Label, Gitlab::Label)]
+        ).returns(Thread)
+      }
       def add_labels(issue, selected_labels)
+        raise "Functionality unsupported on GitLab!" if issue.is_a?(Gitlab::Issue)
+
         labels_list = selected_labels.map(&:name).join(', ')
 
         @out.puts "Adding labels #{labels_list}..."
@@ -92,7 +131,15 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          issue: T.any(Github::Issue, Gitlab::Issue),
+          milestone: T.any(Github::Milestone, Gitlab::Milestone)
+        ).returns(Thread)
+      }
       def set_milestone(issue, milestone)
+        raise "Functionality unsupported on GitLab!" if issue.is_a?(Gitlab::Issue)
+
         @out.puts "Setting milestone #{milestone.title}..."
 
         Thread.new do
@@ -100,7 +147,15 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          issue: T.any(Github::Issue, Gitlab::Issue),
+          users: T::Array[T.any(Github::User, Gitlab::User)]
+        ).returns(Thread)
+      }
       def assign_users(issue, users)
+        raise "Functionality unsupported on GitLab!" if issue.is_a?(Gitlab::Issue)
+
         usernames = users.map(&:username)
 
         @out.puts "Assigning users #{usernames.join(', ')}..."
@@ -110,7 +165,14 @@ module Geet
         end
       end
 
+      sig {
+        params(
+          issue: T.any(Github::Issue, Gitlab::Issue)
+        ).returns(Thread)
+      }
       def assign_authenticated_user(issue)
+        raise "Functionality unsupported on GitLab!" if issue.is_a?(Gitlab::Issue)
+
         @out.puts 'Assigning authenticated user...'
 
         Thread.new do

data/lib/geet/services/create_pr.rb

@@ -25,7 +25,7 @@ module Geet
       #
       def execute(
         title, description, labels: nil, milestone: nil, reviewers: nil,
-        base: nil, draft: false, open_browser: false, automerge: false, **
+        base: nil, draft: false, open_browser: false, automerge: false
       )
         ensure_clean_tree
 
@@ -45,7 +45,7 @@ module Geet
 
         sync_with_remote_branch
 
-        pr = create_pr(title, description, base: base, draft: draft)
+        pr = create_pr(title, description, base:, draft:)
 
         if user_has_write_permissions
           edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
@@ -164,6 +164,8 @@ module Geet
       end
 
       def add_labels(pr, selected_labels)
+        raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
+
         labels_list = selected_labels.map(&:name).join(', ')
 
         @out.puts "Adding labels #{labels_list}..."
@@ -174,6 +176,8 @@ module Geet
       end
 
       def set_milestone(pr, milestone)
+        raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
+
         @out.puts "Setting milestone #{milestone.title}..."
 
         Thread.new do
@@ -182,6 +186,8 @@ module Geet
       end
 
       def request_review(pr, reviewers)
+        raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
+
         reviewer_usernames = reviewers.map(&:username)
 
         @out.puts "Requesting review from #{reviewer_usernames.join(', ')}..."
@@ -192,18 +198,21 @@ module Geet
       end
 
       def enable_automerge(pr)
+        raise "Functionality unsupported on GitLab!" if pr.is_a?(Gitlab::PR)
+
         if !pr.respond_to?(:enable_automerge)
           raise "Automerge is not supported for this repository provider"
         elsif !pr.respond_to?(:node_id) || pr.node_id.nil?
           raise "Automerge requires node_id from the API (not available in the response)"
         end
 
-        @out.puts "Enabling automerge..."
+        @out.print "Enabling automerge... "
 
         begin
-          pr.enable_automerge
+          merge_method = pr.enable_automerge
+          @out.puts merge_method
         rescue Geet::Shared::HttpError => e
-          @out.puts "Warning: Could not enable automerge: #{e.message}"
+          @out.puts "", "WARNING: Could not enable automerge: #{e.message}"
         end
       end
     end

data/lib/geet/services/list_issues.rb

@@ -1,16 +1,30 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     class ListIssues
+      extend T::Sig
+
       include Geet::Shared::Selection
 
+      sig {
+        params(
+          repository: Git::Repository,
+          out: StringIO
+        ).void
+      }
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end
 
-      def execute(assignee: nil, **)
+      sig {
+        params(
+          assignee: T.nilable(String)
+        ).returns(T::Array[T.any(Github::Issue, Gitlab::Issue)])
+      }
+      def execute(assignee: nil)
         selected_assignee = find_and_select_attributes(assignee) if assignee
 
         issues = @repository.issues(assignee: selected_assignee)
@@ -22,6 +36,11 @@ module Geet
 
       private
 
+      sig {
+        params(
+          assignee: String
+        ).returns(T.any(Github::User, Gitlab::User))
+      }
       def find_and_select_attributes(assignee)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 

data/lib/geet/services/merge_pr.rb

@@ -20,7 +20,7 @@ module Geet
         @git_client = git_client
       end
 
-      def execute(delete_branch: false, squash: false, **)
+      def execute(delete_branch: false, squash: false)
         merge_method = 'squash' if squash
 
         @git_client.fetch

data/lib/geet/services/open_pr.rb

@@ -1,22 +1,37 @@
 # frozen_string_literal: true
+# typed: strict
 
 module Geet
   module Services
     # Open in the browser the PR for the current branch.
     #
     class OpenPr
+      extend T::Sig
+
       include Geet::Helpers::OsHelper
       include Geet::Helpers::ServicesWorkflowHelper
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
+      sig {
+        params(
+          repository: Git::Repository,
+          out: 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
 
-      def execute(delete_branch: false, **)
+      sig {
+        params(
+          delete_branch: T::Boolean
+        ).returns(T.any(Github::PR, Gitlab::PR))
+      }
+      def execute(delete_branch: false)
         pr = checked_find_branch_pr
         open_file_with_default_application(pr.link)
         pr

data/lib/geet/version.rb

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

data/spec/integration/create_issue_spec.rb

@@ -57,8 +57,7 @@ describe Geet::Services::CreateIssue do
         actual_output = StringIO.new
 
         actual_created_issue = VCR.use_cassette('create_issue_upstream') do
-          create_options = { out: actual_output }
-          described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', **create_options)
+          described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description')
         end
 
         expect(actual_output.string).to eql(expected_output)