geet 0.3.15 → 0.4.1

data/lib/geet/gitlab/milestone.rb

@@ -17,7 +17,7 @@ module Geet
 
       # See https://docs.gitlab.com/ee/api/milestones.html#list-project-milestones
       #
-      def self.list(api_interface)
+      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)

data/lib/geet/gitlab/user.rb

@@ -13,7 +13,7 @@ module Geet
 
       # Returns an array of User instances
       #
-      def self.list_collaborators(api_interface)
+      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)

data/lib/geet/helpers/os_helper.rb

@@ -26,14 +26,15 @@ module Geet
       # interactive:   set when required; in this case, a different API will be used (`system()`
       #                instead of `popen3`).
       # silent_stderr: don't print the stderr output
+      # allow_error:   don't raise error on failure
       #
-      def execute_command(command, description: nil, interactive: false, silent_stderr: false)
+      def execute_command(command, description: nil, interactive: false, silent_stderr: false, allow_error: false)
         description_message = " on #{description}" if description
 
         if interactive
           system(command)
 
-          if !$CHILD_STATUS.success?
+          if !$CHILD_STATUS.success? && !allow_error
             raise "Error#{description_message} (exit status: #{$CHILD_STATUS.exitstatus})"
           end
         else
@@ -43,7 +44,7 @@ module Geet
 
             puts stderr_content if stderr_content != '' && !silent_stderr
 
-            if !wait_thread.value.success?
+            if !wait_thread.value.success? && !allow_error
               error_message = stderr_content.lines.first&.strip || "Error running command #{command.inspect}"
               raise "Error#{description_message}: #{error_message}"
             end

data/lib/geet/services/add_upstream_repo.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Geet
+  module Services
+    # Add the upstream repository to the current repository (configuration).
+    #
+    class AddUpstreamRepo
+      DEFAULT_GIT_CLIENT = Utils::GitClient.new
+
+      def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @out = out
+        @git_client = git_client
+      end
+
+      def execute
+        raise "Upstream remote already existing!" if @git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME)
+
+        parent_path = @repository.remote.parent_path
+
+        parent_url = compose_parent_url(parent_path)
+
+        @git_client.add_remote(Utils::GitClient::UPSTREAM_NAME, parent_url)
+      end
+
+      private
+
+      # Use the same protocol as the main repository.
+      #
+      def compose_parent_url(parent_path)
+        protocol, domain, separator, _, suffix = @git_client.remote_components
+
+        "#{protocol}#{domain}#{separator}#{parent_path}#{suffix}"
+      end
+    end
+  end
+end

data/lib/geet/services/close_milestones.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../shared/selection'
+
+module Geet
+  module Services
+    class CloseMilestones
+      include Geet::Shared::Selection
+
+      def initialize(repository, out: $stdout)
+        @repository = repository
+        @out = out
+      end
+
+      def execute(numbers: nil)
+        numbers = find_and_select_milestone_numbers(numbers)
+
+        close_milestone_threads = close_milestones(numbers)
+
+        close_milestone_threads.each(&:join)
+      end
+
+      private
+
+      def find_and_select_milestone_numbers(numbers)
+        selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
+
+        selection_manager.add_attribute(:milestones, 'milestone', numbers, SELECTION_MULTIPLE, name_method: :title)
+
+        milestones = selection_manager.select_attributes[0]
+
+        milestones.map(&:number)
+      end
+
+      def close_milestones(numbers)
+        @out.puts "Closing milestones #{numbers.join(', ')}..."
+
+        numbers.map do |number|
+          Thread.new do
+            @repository.close_milestone(number)
+          end
+        end
+      end
+    end # CloseMilestones
+  end # Services
+end # Geet

data/lib/geet/services/create_issue.rb

@@ -2,11 +2,13 @@
 
 require_relative 'abstract_create_issue'
 require_relative '../shared/repo_permissions'
+require_relative '../shared/selection'
 
 module Geet
   module Services
     class CreateIssue < AbstractCreateIssue
       include Geet::Shared::RepoPermissions
+      include Geet::Shared::Selection
 
       # options:
       #   :labels
@@ -56,9 +58,9 @@ module Geet
       def find_and_select_attributes(labels, milestone, assignees)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        selection_manager.add_attribute(:labels, 'label', labels, :multiple, name_method: :name) if labels
-        selection_manager.add_attribute(:milestones, 'milestone', milestone, :single, name_method: :title) if milestone
-        selection_manager.add_attribute(:collaborators, 'assignee', assignees, :multiple, name_method: :username) if assignees
+        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(:collaborators, 'assignee', assignees, SELECTION_MULTIPLE, name_method: :username) if assignees
 
         selection_manager.select_attributes
       end

data/lib/geet/services/create_pr.rb

@@ -2,11 +2,13 @@
 
 require_relative 'abstract_create_issue'
 require_relative '../shared/repo_permissions'
+require_relative '../shared/selection'
 
 module Geet
   module Services
     class CreatePr < AbstractCreateIssue
       include Geet::Shared::RepoPermissions
+      include Geet::Shared::Selection
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
@@ -23,7 +25,7 @@ module Geet
       #
       def execute(
         title, description, labels: nil, milestone: nil, reviewers: nil,
-        base: nil, no_open_pr: nil, automated_mode: false, **
+        base: nil, draft: false, no_open_pr: nil, automated_mode: false, **
       )
         ensure_clean_tree if automated_mode
 
@@ -37,7 +39,7 @@ module Geet
 
         sync_with_upstream_branch if automated_mode
 
-        pr = create_pr(title, description, base)
+        pr = create_pr(title, description, base: base, draft: draft)
 
         if user_has_write_permissions
           edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
@@ -66,11 +68,11 @@ module Geet
       def find_and_select_attributes(labels, milestone, reviewers)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        selection_manager.add_attribute(:labels, 'label', labels, :multiple, name_method: :name) if labels
-        selection_manager.add_attribute(:milestones, 'milestone', milestone, :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, :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 }
           end
@@ -93,10 +95,12 @@ module Geet
         end
       end
 
-      def create_pr(title, description, base)
+      def create_pr(title, description, base:, draft:)
         @out.puts 'Creating PR...'
 
-        @repository.create_pr(title, description, @git_client.current_branch, base: base)
+        base ||= @git_client.main_branch
+
+        @repository.create_pr(title, description, @git_client.current_branch, base, draft)
       end
 
       def edit_pr(pr, labels, milestone, reviewers)

data/lib/geet/services/list_issues.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../utils/attributes_selection_manager'
+require_relative '../shared/selection'
 
 module Geet
   module Services
     class ListIssues
+      include Geet::Shared::Selection
+
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
@@ -25,7 +28,7 @@ module Geet
       def find_and_select_attributes(assignee)
         selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        selection_manager.add_attribute(:collaborators, 'assignee', assignee, :single, name_method: :username)
+        selection_manager.add_attribute(:collaborators, 'assignee', assignee, SELECTION_SINGLE, name_method: :username)
 
         selection_manager.select_attributes[0]
       end

data/lib/geet/services/merge_pr.rb

@@ -12,6 +12,7 @@ module Geet
     #
     class MergePr
       include Geet::Helpers::ServicesWorkflowHelper
+      include Geet::Shared
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
@@ -24,8 +25,30 @@ module Geet
       def execute(delete_branch: false)
         merge_owner, merge_head = find_merge_head
         pr = checked_find_branch_pr(merge_owner, merge_head)
+
         merge_pr(pr)
-        do_delete_branch if delete_branch
+
+        if delete_branch
+          branch = @git_client.current_branch
+
+          delete_remote_branch(branch)
+        end
+
+        fetch_repository
+
+        if upstream_branch_gone?
+          pr_branch = @git_client.current_branch
+          main_branch = @git_client.main_branch
+
+          # The rebase could also be placed after the branch deletion. There are pros/cons;
+          # currently, it's not important.
+          #
+          checkout_branch(main_branch)
+          rebase
+
+          delete_local_branch(pr_branch)
+        end
+
         pr
       end
 
@@ -37,10 +60,38 @@ module Geet
         pr.merge
       end
 
-      def do_delete_branch
-        @out.puts "Deleting branch #{@git_client.current_branch}..."
+      def delete_remote_branch(branch)
+        @out.puts "Deleting remote branch #{branch}..."
+
+        @repository.delete_branch(branch)
+      end
+
+      def fetch_repository
+        @out.puts "Fetching repository..."
+
+        @git_client.fetch
+      end
+
+      def upstream_branch_gone?
+        @git_client.upstream_branch_gone?
+      end
+
+      def checkout_branch(branch)
+        @out.puts "Checking out #{branch}..."
+
+        @git_client.checkout(branch)
+      end
+
+      def rebase
+        @out.puts "Rebasing..."
+
+        @git_client.rebase
+      end
+
+      def delete_local_branch(branch)
+        @out.puts "Deleting local branch #{branch}..."
 
-        @repository.delete_branch(@git_client.current_branch)
+        @git_client.delete_branch(branch)
       end
     end
   end

data/lib/geet/services/open_repo.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/os_helper'
+
+module Geet
+  module Services
+    # Open in the browser the current repository.
+    #
+    class OpenRepo
+      include Helpers::OsHelper
+
+      DEFAULT_GIT_CLIENT = Utils::GitClient.new
+
+      def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @out = out
+        @git_client = git_client
+      end
+
+      def execute(upstream: false)
+        remote_options = upstream ? {name: Utils::GitClient::UPSTREAM_NAME} : {}
+
+        repo_url = @git_client.remote(**remote_options)
+        repo_url = convert_repo_url_to_http_protocol(repo_url)
+
+        open_file_with_default_application(repo_url)
+
+        repo_url
+      end
+
+      private
+
+      # The repository URL may be in any of the git/http protocols.
+      #
+      def convert_repo_url_to_http_protocol(repo_url)
+        case repo_url
+        when /https:/
+        when /git@/
+        else
+          # Minimal error, due to match guaranteed by GitClient#remote.
+          raise
+        end
+
+        domain, _, path = repo_url.match(Utils::GitClient::REMOTE_URL_REGEX)[2..4]
+
+        "https://#{domain}/#{path}"
+      end
+    end
+  end
+end

data/lib/geet/shared/selection.rb

@@ -4,6 +4,9 @@ module Geet
   module Shared
     module Selection
       MANUAL_LIST_SELECTION_FLAG = '-'.freeze
+
+      SELECTION_SINGLE = :single
+      SELECTION_MULTIPLE = :multiple
     end
   end
 end

data/lib/geet/utils/attributes_selection_manager.rb

@@ -30,8 +30,10 @@ module Geet
         @selections_data = []
       end
 
+      # selection_type: SELECTION_SINGLE or SELECTION_MULTIPLE
+      #
       def add_attribute(repository_call, description, pattern, selection_type, name_method: nil, &pre_selection_hook)
-        raise "Unrecognized selection type #{selection_type.inspect}" if ![:single, :multiple].include?(selection_type)
+        raise "Unrecognized selection type #{selection_type.inspect}" if ![SELECTION_SINGLE, SELECTION_MULTIPLE].include?(selection_type)
 
         finder_thread = find_attribute_entries(repository_call)
 
@@ -47,9 +49,9 @@ module Geet
           entries = pre_selection_hook.(entries) if pre_selection_hook
 
           case selection_type
-          when :single
+          when SELECTION_SINGLE
             select_entry(description, entries, pattern, name_method)
-          when :multiple
+          when SELECTION_MULTIPLE
             select_entries(description, entries, pattern, name_method)
           end
         end
@@ -86,6 +88,13 @@ module Geet
       #   select_entries('reviewer', all_collaborators, 'donaldduck', nil)
       #
       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)
+
         if pattern == MANUAL_LIST_SELECTION_FLAG
           Geet::Utils::ManualListSelection.new.select_entries(entry_type, entries, name_method: name_method)
         else

data/lib/geet/utils/git_client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'shellwords'
 require_relative '../helpers/os_helper'
 
@@ -10,20 +11,33 @@ module Geet
     class GitClient
       include Geet::Helpers::OsHelper
 
-      ORIGIN_NAME   = 'origin'
+      ORIGIN_NAME = 'origin'
       UPSTREAM_NAME = 'upstream'
 
-      # For simplicity, we match any character except the ones the separators.
-      REMOTE_ORIGIN_REGEX = %r{
+      # Simplified, but good enough, pattern.
+      #
+      # Relevant matches:
+      #
+      #   1: protocol + suffix
+      #   2: domain
+      #   3: domain<>path separator
+      #   4: path (repo, project)
+      #   5: suffix
+      #
+      REMOTE_URL_REGEX = %r{
         \A
-        (?:https://(.+?)/|git@(.+?):)
-        ([^/]+/.*?)
-        (?:\.git)?
+        (https://|git@)
+        (.+?)
+        ([/:])
+        (.+/.+?)
+        (\.git)?
         \Z
       }x
 
       UPSTREAM_BRANCH_REGEX = %r{\A[^/]+/([^/]+)\Z}
 
+      MAIN_BRANCH_CONFIG_ENTRY = 'custom.development-branch'
+
       CLEAN_TREE_MESSAGE_REGEX = /^nothing to commit, working tree clean$/
 
       def initialize(location: nil)
@@ -38,13 +52,13 @@ module Geet
       # (which start with `-`)
       #
       def cherry(limit)
-        raw_commits = execute_command("git #{gitdir_option} cherry #{limit.shellescape}")
+        raw_commits = execute_git_command("cherry #{limit.shellescape}")
 
         raw_commits.split("\n").grep(/^\+/).map { |line| line[3..-1] }
       end
 
       def current_branch
-        branch = execute_command("git #{gitdir_option} rev-parse --abbrev-ref HEAD")
+        branch = execute_git_command("rev-parse --abbrev-ref HEAD")
 
         raise "Couldn't find current branch" if branch == 'HEAD'
 
@@ -53,12 +67,14 @@ module Geet
 
       # Not to be confused with `upstream` repository!
       #
+      # This API doesn't reveal if the remote branch is gone.
+      #
       # return: nil, if the upstream branch is not configured.
       #
       def upstream_branch
-        head_symbolic_ref = execute_command("git #{gitdir_option} symbolic-ref -q HEAD")
+        head_symbolic_ref = execute_git_command("symbolic-ref -q HEAD")
 
-        raw_upstream_branch = execute_command("git #{gitdir_option} for-each-ref --format='%(upstream:short)' #{head_symbolic_ref.shellescape}").strip
+        raw_upstream_branch = execute_git_command("for-each-ref --format='%(upstream:short)' #{head_symbolic_ref.shellescape}").strip
 
         if raw_upstream_branch != ''
           raw_upstream_branch[UPSTREAM_BRANCH_REGEX, 1] || raise("Unexpected upstream format: #{raw_upstream_branch}")
@@ -67,8 +83,43 @@ module Geet
         end
       end
 
+      # TODO: May be merged with :upstream_branch, although it would require designing how a gone
+      # remote branch is expressed.
+      #
+      # Sample command output:
+      #
+      #     ## add_milestone_closing...origin/add_milestone_closing [gone]
+      #      M spec/integration/merge_pr_spec.rb
+      #
+      def upstream_branch_gone?
+        git_command = "status -b --porcelain"
+        status_output = execute_git_command(git_command)
+
+        # Simplified branch naming pattern. The exact one (see https://stackoverflow.com/a/3651867)
+        # is not worth implementing.
+        #
+        if status_output =~ %r(^## .+\.\.\..+?( \[gone\])?$)
+          !!$LAST_MATCH_INFO[1]
+        else
+          raise "Unexpected git command #{git_command.inspect} output: #{status_output}"
+        end
+      end
+
+      # See https://saveriomiroddi.github.io/Conveniently-Handling-non-master-development-default-branches-in-git-hub
+      #
+      def main_branch
+        branch_name = execute_git_command("config --get #{MAIN_BRANCH_CONFIG_ENTRY}", allow_error: true)
+
+        if branch_name.empty?
+          full_branch_name = execute_git_command("rev-parse --abbrev-ref #{ORIGIN_NAME}/HEAD")
+          full_branch_name.split('/').last
+        else
+          branch_name
+        end
+      end
+
       def working_tree_clean?
-        git_message = execute_command("git #{gitdir_option} status")
+        git_message = execute_git_command("status")
 
         !!(git_message =~ CLEAN_TREE_MESSAGE_REGEX)
       end
@@ -80,19 +131,26 @@ module Geet
       # Show the description ("<subject>\n\n<body>") for the given git object.
       #
       def show_description(object)
-        execute_command("git #{gitdir_option} show --quiet --format='%s\n\n%b' #{object.shellescape}")
+        execute_git_command("show --quiet --format='%s\n\n%b' #{object.shellescape}")
       end
 
       ##########################################################################
-      # REPOSITORY/REMOTE APIS
+      # REPOSITORY/REMOTE QUERYING APIS
       ##########################################################################
 
+      # Return the components of the remote, according to REMOTE_URL_REGEX; doesn't include the full
+      # match.
+      #
+      def remote_components(name: nil)
+        remote.match(REMOTE_URL_REGEX)[1..]
+      end
+
       # Example: `donaldduck/geet`
       #
       def path(upstream: false)
-        remote_name = upstream ? UPSTREAM_NAME : ORIGIN_NAME
+        remote_name_option = upstream ? {name: UPSTREAM_NAME} : {}
 
-        remote(remote_name)[REMOTE_ORIGIN_REGEX, 3]
+        remote(**remote_name_option)[REMOTE_URL_REGEX, 4]
       end
 
       def owner
@@ -101,12 +159,10 @@ module Geet
 
       def provider_domain
         # We assume that it's not possible to have origin and upstream on different providers.
-        #
-        remote_url = remote(ORIGIN_NAME)
 
-        domain = remote_url[REMOTE_ORIGIN_REGEX, 1] || remote_url[REMOTE_ORIGIN_REGEX, 2]
+        domain = remote()[REMOTE_URL_REGEX, 2]
 
-        raise "Can't identify domain in the provider domain string: #{domain}" if domain !~ /(.*)\.\w+/
+        raise "Can't identify domain in the provider domain string: #{domain}" if domain !~ /\w+\.\w+/
 
         domain
       end
@@ -116,12 +172,15 @@ module Geet
       #
       # The result is in the format `git@github.com:donaldduck/geet.git`
       #
-      def remote(name)
-        remote_url = execute_command("git #{gitdir_option} ls-remote --get-url #{name}")
+      # options
+      #   :name:           remote name; if unspecified, the default remote is used.
+      #
+      def remote(name: nil)
+        remote_url = execute_git_command("ls-remote --get-url #{name}")
 
-        if remote_url == name
+        if !remote_defined?(name)
           raise "Remote #{name.inspect} not found!"
-        elsif remote_url !~ REMOTE_ORIGIN_REGEX
+        elsif remote_url !~ REMOTE_URL_REGEX
           raise "Unexpected remote reference format: #{remote_url.inspect}"
         end
 
@@ -132,9 +191,10 @@ module Geet
       # purposes, any any action that needs to work with the remote, uses #remote.
       #
       def remote_defined?(name)
-        remote_url = execute_command("git #{gitdir_option} ls-remote --get-url #{name}")
+        remote_url = execute_git_command("ls-remote --get-url #{name}")
 
-        # If the remote is not define, `git ls-remote` will return the passed value.
+        # If the remote is not defined, `git ls-remote` will return the passed value.
+        #
         remote_url != name
       end
 
@@ -142,12 +202,36 @@ module Geet
       # OPERATION APIS
       ##########################################################################
 
+      def checkout(branch)
+        execute_git_command("checkout #{branch.shellescape}")
+      end
+
+      # Unforced deletion.
+      #
+      def delete_branch(branch)
+        execute_git_command("branch --delete #{branch.shellescape}")
+      end
+
+      def rebase
+        execute_git_command("rebase")
+      end
+
       # upstream_branch: create an upstream branch.
       #
       def push(upstream_branch: nil)
-        upstream_branch_option = "-u origin #{upstream_branch.shellescape}" if upstream_branch
+        upstream_branch_option = "-u #{ORIGIN_NAME} #{upstream_branch.shellescape}" if upstream_branch
+
+        execute_git_command("push #{upstream_branch_option}")
+      end
+
+      # Performs pruning.
+      #
+      def fetch
+        execute_git_command("fetch --prune")
+      end
 
-        execute_command("git #{gitdir_option} push #{upstream_branch_option}")
+      def add_remote(name, url)
+        execute_git_command("remote add #{name.shellescape} #{url}")
       end
 
       ##########################################################################
@@ -156,8 +240,17 @@ module Geet
 
       private
 
-      def gitdir_option
-        "-C #{@location.shellescape}" if @location
+      # If executing a git command without calling this API, don't forget to split `gitdir_option`
+      # and use it!
+      #
+      # options (passed to :execute_command):
+      # - allow_error
+      # - (others)
+      #
+      def execute_git_command(command, **options)
+        gitdir_option = "-C #{@location.shellescape}" if @location
+
+        execute_command("git #{gitdir_option} #{command}", **options)
       end
     end
   end