geet 0.3.12 → 0.3.17

data/lib/geet/helpers/services_workflow_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'open3'
+require 'shellwords'
+
+module Geet
+  module Helpers
+    # Helper for services common workflow, for example, find the merge head.
+    #
+    module ServicesWorkflowHelper
+      # Requires: @git_client
+      #
+      def find_merge_head
+        [@git_client.owner, @git_client.current_branch]
+      end
+
+      # Expect to find only one.
+      #
+      # Requires: @out, @repository.
+      #
+      def checked_find_branch_pr(owner, head)
+        @out.puts "Finding PR with head (#{owner}:#{head})..."
+
+        prs = @repository.prs(owner: owner, head: head)
+
+        raise "Expected to find only one PR for the current branch; found: #{prs.size}" if prs.size != 1
+
+        prs[0]
+      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/comment_pr.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/os_helper'
+require_relative '../helpers/services_workflow_helper'
+
+module Geet
+  module Services
+    # Add a comment to the PR for the current branch.
+    #
+    class CommentPr
+      include Geet::Helpers::OsHelper
+      include Geet::Helpers::ServicesWorkflowHelper
+
+      DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
+
+      def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @out = out
+        @git_client = git_client
+      end
+
+      def execute(comment, no_open_pr: nil)
+        merge_owner, merge_head = find_merge_head
+        pr = checked_find_branch_pr(merge_owner, merge_head)
+        pr.comment(comment)
+        open_file_with_default_application(pr.link) unless no_open_pr
+        pr
+      end
+    end
+  end
+end

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_milestone.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Geet
+  module Services
+    class CreateMilestone
+      def initialize(repository, out: $stdout)
+        @repository = repository
+        @out = out
+      end
+
+      def execute(title)
+        create_milestone(title)
+      end
+
+      private
+
+      def create_milestone(title)
+        @out.puts 'Creating milestone...'
+
+        @repository.create_milestone(title)
+      end
+    end # class CreateMilestone
+  end # module Services
+end # module Geet

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
 
@@ -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

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative '../helpers/services_workflow_helper'
+require_relative '../shared/branches'
+
 module Geet
   module Services
     # Merges the PR for the current branch.
@@ -9,6 +12,9 @@ module Geet
     # constraints, but speeds up the workflow.
     #
     class MergePr
+      include Geet::Helpers::ServicesWorkflowHelper
+      include Geet::Shared::Branches
+
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
       def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
@@ -20,38 +26,72 @@ 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
+
+          # 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
 
       private
 
-      def find_merge_head
-        [@git_client.owner, @git_client.current_branch]
+      def merge_pr(pr)
+        @out.puts "Merging PR ##{pr.number}..."
+
+        pr.merge
       end
 
-      # Expect to find only one.
-      def checked_find_branch_pr(owner, head)
-        @out.puts "Finding PR with head (#{owner}:#{head})..."
+      def delete_remote_branch(branch)
+        @out.puts "Deleting remote branch #{branch}..."
 
-        prs = @repository.prs(owner: owner, head: head)
+        @repository.delete_branch(branch)
+      end
 
-        raise "Expected to find only one PR for the current branch; found: #{prs.size}" if prs.size != 1
+      def fetch_repository
+        @out.puts "Fetching repository..."
 
-        prs[0]
+        @git_client.fetch
       end
 
-      def merge_pr(pr)
-        @out.puts "Merging PR ##{pr.number}..."
+      def upstream_branch_gone?
+        @git_client.upstream_branch_gone?
+      end
 
-        pr.merge
+      def checkout_branch(branch)
+        @out.puts "Checking out #{branch}..."
+
+        @git_client.checkout(branch)
+      end
+
+      def rebase
+        @out.puts "Rebasing..."
+
+        @git_client.rebase
       end
 
-      def do_delete_branch
-        @out.puts "Deleting branch #{@git_client.current_branch}..."
+      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_pr.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/os_helper'
+require_relative '../helpers/services_workflow_helper'
+
+module Geet
+  module Services
+    # Open in the browser the PR for the current branch.
+    #
+    class OpenPr
+      include Geet::Helpers::OsHelper
+      include Geet::Helpers::ServicesWorkflowHelper
+
+      DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
+
+      def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @out = out
+        @git_client = git_client
+      end
+
+      def execute(delete_branch: false)
+        merge_owner, merge_head = find_merge_head
+        pr = checked_find_branch_pr(merge_owner, merge_head)
+        open_file_with_default_application(pr.link)
+        pr
+      end
+    end
+  end
+end

data/lib/geet/shared/branches.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Geet
+  module Shared
+    module Branches
+      MAIN_BRANCH = 'master'
+    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

data/lib/geet/utils/git_client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'shellwords'
 require_relative '../helpers/os_helper'
 
@@ -38,13 +39,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 +54,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 +70,30 @@ 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
+
       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,7 +105,7 @@ 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
 
       ##########################################################################
@@ -117,7 +142,7 @@ 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}")
+        remote_url = execute_git_command("ls-remote --get-url #{name}")
 
         if remote_url == name
           raise "Remote #{name.inspect} not found!"
@@ -132,7 +157,7 @@ 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.
         remote_url != name
@@ -142,12 +167,32 @@ 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
 
-        execute_command("git #{gitdir_option} push #{upstream_branch_option}")
+        execute_git_command("push #{upstream_branch_option}")
+      end
+
+      # Performs pruning.
+      #
+      def fetch
+        execute_git_command("fetch --prune")
       end
 
       ##########################################################################
@@ -156,8 +201,13 @@ 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!
+      #
+      def execute_git_command(command)
+        gitdir_option = "-C #{@location.shellescape}" if @location
+
+        execute_command("git #{gitdir_option} #{command}")
       end
     end
   end