geet 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24fb5de6b678ccceae3bf6366beded7c208a6d44f75db7303063176436365a5d
-  data.tar.gz: 4de89e5bfd5414e12cdbf74badf7ed36254f657dc9b8c3fe54c85d8af617b025
+  metadata.gz: 15603a9a3a61fd8b6c3a377bd8fb1f482c121078b153e0cb8f3bdf12609d01f2
+  data.tar.gz: cde2b52ebcc17f2af2e64466c5565a65fad846e946747d91dfd734e5ce108e2c
 SHA512:
-  metadata.gz: f7631017c938ebf68f5c94e142fe00ab7a905cfa3c01383ed61296c0e1db29e76d743d7818c524732755cd7231d654316428bd2b23d2ae450dc83fac3856058e
-  data.tar.gz: b6e366dd0e923d4b8a4e91781ba5820365a885b866b377907ad965d54f71ac2a9dd061900e8b011c1f54e5c7619bf87d58af7474039deb476d1f3322c745242b
+  metadata.gz: 5ea5d57a2f25a0f83910afe316194d335f11d04b4228324ab577845a74b62331705b3650b654cdb951e69c6fa76438441e1fa1caa3bf431e456acefc39f4457d
+  data.tar.gz: 06c954789d0e39cb723daa45de62c190817773cad1c29d1719524452c98731ded5f0cce8f72450f677c54688c38636b21538eca04226dafb45b00d16ab548806

data/.travis.yml

@@ -5,6 +5,12 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
+  - ruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
 # API tokens are always required, but not used in testing, since no requests are actually made.
 env:
   - GITHUB_API_TOKEN=phony GITLAB_API_TOKEN=phony

data/bin/geet

@@ -46,6 +46,13 @@ class GeetLauncher
       Services::ListIssues.new(repository).execute(options)
     when LABEL_LIST_COMMAND
       Services::ListLabels.new(repository).execute
+    when MILESTONE_CLOSE_COMMAND
+      # Don't support user selection. This requires extra complexity, specifically, matching by number
+      # while displaying the titles (see AttributesSelectionManager).
+      #
+      options = {numbers: Shared::Selection::MANUAL_LIST_SELECTION_FLAG}
+
+      Services::CloseMilestones.new(repository).execute(options)
     when MILESTONE_CREATE_COMMAND
       title = options.delete(:title)
 

data/geet.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2019-09-03'
+  s.date        = '2020-11-16'
   s.email       = ['saverio.pub2@gmail.com']
   s.homepage    = 'https://github.com/saveriomiroddi/geet'
   s.summary     = 'Commandline interface for performing SCM host operations, eg. create a PR on GitHub'

data/lib/geet/commandline/commands.rb

@@ -8,6 +8,7 @@ module Geet
       LABEL_CREATE_COMMAND = 'label.create'
       ISSUE_LIST_COMMAND = 'issue.list'
       LABEL_LIST_COMMAND = 'label.list'
+      MILESTONE_CLOSE_COMMAND = 'milestone.close'
       MILESTONE_CREATE_COMMAND = 'milestone.create'
       MILESTONE_LIST_COMMAND = 'milestone.list'
       PR_COMMENT_COMMAND = 'pr.comment'

data/lib/geet/commandline/configuration.rb

@@ -45,6 +45,10 @@ module Geet
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
+      MILESTONE_CLOSE_OPTIONS = [
+        long_help: 'Close milestones.'
+      ]
+
       MILESTONE_CREATE_OPTIONS = [
         'title',
         long_help: 'Create a milestone.'
@@ -109,6 +113,7 @@ module Geet
           'list' => LABEL_LIST_OPTIONS,
         },
         'milestone' => {
+          'close' => MILESTONE_CLOSE_OPTIONS,
           'create' => MILESTONE_CREATE_OPTIONS,
           'list' => MILESTONE_LIST_OPTIONS,
         },

data/lib/geet/git/repository.rb

@@ -70,6 +70,10 @@ module Geet
         attempt_provider_call(:Milestone, :list, api_interface)
       end
 
+      def close_milestone(number)
+        attempt_provider_call(:Milestone, :close, number, api_interface)
+      end
+
       def create_pr(title, description, head, base: nil)
         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

data/lib/geet/github/milestone.rb

@@ -7,6 +7,8 @@ module Geet
     class Milestone
       attr_reader :number, :title, :due_on
 
+      STATE_CLOSED = 'closed'
+
       class << self
         private
 
@@ -64,6 +66,17 @@ module Geet
           new(number, title, due_on, api_interface)
         end
       end
+
+      # See https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-a-milestone
+      #
+      # This is a convenience method; the underlying operation is a generic update.
+      #
+      def self.close(number, api_interface)
+        api_path = "milestones/#{number}"
+        request_data = { state: STATE_CLOSED }
+
+        api_interface.send_request(api_path, data: request_data)
+      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
 
@@ -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,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../helpers/services_workflow_helper'
+require_relative '../shared/branches'
 
 module Geet
   module Services
@@ -12,6 +13,7 @@ module Geet
     #
     class MergePr
       include Geet::Helpers::ServicesWorkflowHelper
+      include Geet::Shared::Branches
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
@@ -24,8 +26,29 @@ 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
 
@@ -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/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

data/lib/geet/version.rb

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

data/spec/integration/merge_pr_spec.rb

@@ -5,12 +5,25 @@ require 'spec_helper'
 require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/merge_pr'
 
+# Currently disabled: it requires updates following the addition of the automatic removal of the local
+# branch.
+# Specifically, `GitClient#upstream_branch_gone?` needs to be handled, since it returns the current
+# branch, while it's supposed to return
+#
 describe Geet::Services::MergePr do
   let(:git_client) { Geet::Utils::GitClient.new }
   let(:repository) { Geet::Git::Repository.new(git_client: git_client) }
   let(:owner) { 'donaldduck' }
   let(:branch) { 'mybranch' }
 
+  before :each do
+    expect(git_client).to receive(:fetch)
+    expect(git_client).to receive(:upstream_branch_gone?).and_return(true)
+    expect(git_client).to receive(:checkout).with('master')
+    expect(git_client).to receive(:rebase)
+    expect(git_client).to receive(:delete_branch).with('mybranch')
+  end
+
   context 'with github.com' do
     let(:repository_name) { 'testrepo_upstream' }
 
@@ -22,6 +35,10 @@ describe Geet::Services::MergePr do
       expected_output = <<~STR
         Finding PR with head (#{owner}:#{branch})...
         Merging PR ##{expected_pr_number}...
+        Fetching repository...
+        Checking out master...
+        Rebasing...
+        Deleting local branch mybranch...
       STR
 
       actual_output = StringIO.new
@@ -44,7 +61,11 @@ describe Geet::Services::MergePr do
       expected_output = <<~STR
         Finding PR with head (#{owner}:#{branch})...
         Merging PR ##{expected_pr_number}...
-        Deleting branch #{branch}...
+        Deleting remote branch #{branch}...
+        Fetching repository...
+        Checking out master...
+        Rebasing...
+        Deleting local branch mybranch...
       STR
 
       actual_output = StringIO.new
@@ -71,6 +92,10 @@ describe Geet::Services::MergePr do
       expected_output = <<~STR
         Finding PR with head (#{owner}:#{branch})...
         Merging PR ##{expected_pr_number}...
+        Fetching repository...
+        Checking out master...
+        Rebasing...
+        Deleting local branch mybranch...
       STR
 
       actual_output = StringIO.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geet
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_scripting
@@ -101,6 +101,7 @@ files:
 - lib/geet/helpers/summary_helper.rb
 - lib/geet/resources/templates/edit_summary.md
 - lib/geet/services/abstract_create_issue.rb
+- lib/geet/services/close_milestones.rb
 - lib/geet/services/comment_pr.rb
 - lib/geet/services/create_gist.rb
 - lib/geet/services/create_issue.rb
@@ -113,6 +114,7 @@ files:
 - lib/geet/services/list_prs.rb
 - lib/geet/services/merge_pr.rb
 - lib/geet/services/open_pr.rb
+- lib/geet/shared/branches.rb
 - lib/geet/shared/http_error.rb
 - lib/geet/shared/repo_permissions.rb
 - lib/geet/shared/selection.rb
@@ -185,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Commandline interface for performing SCM host operations, eg. create a PR