geet 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2329057378f97cc59535b5821aeeca1f527bca27bd4ced6bb3250e46a55042c
-  data.tar.gz: 680b9175785b58deac3d5df918b2b843168ac709aea396168bd35091b6b7810b
+  metadata.gz: c2ebbfe0a429595d3584630edcde97a281aaa6482e9c3815c051af46b09c9630
+  data.tar.gz: 63840e956153e2301874e18531e1888e97b6b6d5b9d1f5c7e41d5263bee0433b
 SHA512:
-  metadata.gz: 9dbb35ae368c401562677fa3a84138b53e1f15d4741802b478dca6cc166e65c451bf892316dcc9c32add3ca503d031a53d7964ffcc8910713fd2255f4b7c0220
-  data.tar.gz: ecba5a04fd823553108c83bc1e7a182d81d3a3e08d8e875584213e05f966153419fd30a4237f63126a419bcb8ce1007a1ad55e093ff24ea7d1f038ca3ad9c0cf
+  metadata.gz: 1c78a72b2f9a876fed2b7647f5dd37a3f183a183562e5f4622921b3ab6b61bdc80e8eccb0b5f38a0ab7999a9f193a209197cff8b7174c0abd769f554f1f7ed93
+  data.tar.gz: e9f5a7eba5d9bac198c5a2b354727472318c18aad9a849004fb97c12dfd103deb08254868e929a502a4b75c32360c9f26ddc1dec8cac060a56134805de37ebd3

data/bin/geet

@@ -17,6 +17,7 @@ class GeetLauncher
   include Geet::Helpers::SummaryHelper
 
   SUMMARY_TEMPLATE = IO.read(File.expand_path('../lib/geet/resources/templates/edit_summary.md', __dir__))
+  SUMMARY_BACKUP = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
 
   def launch
     command, options = Commandline::Configuration.new.decode_argv || exit
@@ -88,21 +89,24 @@ class GeetLauncher
   private
 
   def edit_pr_summary(base: nil)
-    base ||= 'master'
-
     # Tricky. It would be best to have Git logic exlusively inside the services,
     # but at the same time, the summary editing should be out.
     git = Utils::GitClient.new
-    pr_commits = git.cherry(base)
+    pr_commits = git.cherry(base: base)
 
-    if pr_commits.size == 1
-      prepopulated_summary = git.show_description('HEAD')
-      cancel_pr_help = "In order to cancel the PR creation, delete the description above.\n"
+    summary =
+      if pr_commits.size == 1
+        prepopulated_summary = git.show_description('HEAD')
+        cancel_pr_help = "In order to cancel the PR creation, delete the description above.\n"
 
-      Commandline::Editor.new.edit_content(content: prepopulated_summary, help: SUMMARY_TEMPLATE + cancel_pr_help)
-    else
-      Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
-    end
+        Commandline::Editor.new.edit_content(content: prepopulated_summary, help: SUMMARY_TEMPLATE + cancel_pr_help)
+      else
+        Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
+      end
+
+    IO.write(SUMMARY_BACKUP, summary)
+
+    summary
   end
 
   def default_to_manual_selection(options, *params)

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        = '2021-06-08'
+  s.date        = '2021-10-26'
   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/configuration.rb

@@ -68,6 +68,7 @@ module Geet
         ['-A', '--automated-mode',                          "Automate the branch operations (see long help)"],
         ['-n', '--no-open-pr',                              "Don't open the PR link in the browser after creation"],
         ['-b', '--base develop',                            "Specify the base branch; defaults to the main branch"],
+        ['-d', '--draft',                                   "Create as draft"],
         ['-l', '--labels "legacy,code review"',             'Labels'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
         ['-r', '--reviewers john,tom,adrian,kevin',         'Reviewer logins'],
@@ -95,6 +96,7 @@ module Geet
       ]
 
       PR_OPEN_OPTIONS = [
+        ['-u', '--upstream',                                'List on the upstream repository'],
         long_help: 'Open in the browser the PR for the current branch'
       ]
 

data/lib/geet/git/repository.rb

@@ -74,11 +74,11 @@ module Geet
         attempt_provider_call(:Milestone, :close, number, api_interface)
       end
 
-      def create_pr(title, description, head, base)
+      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
 
-        attempt_provider_call(:PR, :create, title, description, head, api_interface, base)
+        attempt_provider_call(:PR, :create, title, description, head, api_interface, base, draft: draft)
       end
 
       def prs(owner: nil, head: nil, milestone: nil)

data/lib/geet/github/abstract_issue.rb

@@ -22,6 +22,9 @@ module Geet
 
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
+      # This works both for Issues and PRs, however, when the `/pulls` API (path) is used, additional
+      # information is provided (e.g. `head`).
+      #
       def self.list(api_interface, milestone: nil, assignee: nil, &type_filter)
         api_path = 'issues'
 

data/lib/geet/github/pr.rb

@@ -8,7 +8,7 @@ module Geet
     class PR < AbstractIssue
       # See https://developer.github.com/v3/pulls/#create-a-pull-request
       #
-      def self.create(title, description, head, api_interface, base)
+      def self.create(title, description, head, api_interface, base, draft: false)
         api_path = 'pulls'
 
         if api_interface.upstream?
@@ -16,7 +16,7 @@ module Geet
           head = "#{authenticated_user}:#{head}"
         end
 
-        request_data = { title: title, body: description, head: head, base: base }
+        request_data = { title: title, body: description, head: head, base: base, draft: draft }
 
         response = api_interface.send_request(api_path, data: request_data)
 
@@ -32,14 +32,34 @@ module Geet
 
         if head
           api_path = 'pulls'
-          request_params = { head: "#{owner}:#{head}" }
 
-          response = api_interface.send_request(api_path, params: request_params, multipage: true)
+          # Technically, the upstream approach could be used for both, but it's actually good to have
+          # both of them as reference.
+          #
+          # For upstream pulls, the owner is the authenticated user, otherwise, the repository owner.
+          #
+          response = if api_interface.upstream?
+            unfiltered_response = api_interface.send_request(api_path, multipage: true)
+
+            # VERY weird. From the docs, it's not clear if the user/org is required in the `head` parameter,
+            # but:
+            #
+            # - if it isn't included (eg. `anything`), the parameter is ignored
+            # - if it's included (eg. `saveriomiroddi:local_branch_name`), an empty resultset is returned.
+            #
+            # For this reason, we can't use that param, and have to filter manually.
+            #
+            unfiltered_response.select { |pr_data| pr_data.fetch('head').fetch('label') == "#{owner}:#{head}" }
+          else
+            request_params = { head: "#{owner}:#{head}" }
+
+            api_interface.send_request(api_path, params: request_params, multipage: true)
+          end
 
-          response.map do |issue_data|
-            number = issue_data.fetch('number')
-            title = issue_data.fetch('title')
-            link = issue_data.fetch('html_url')
+          response.map do |pr_data|
+            number = pr_data.fetch('number')
+            title = pr_data.fetch('title')
+            link = pr_data.fetch('html_url')
 
             new(number, api_interface, title, link)
           end

data/lib/geet/helpers/services_workflow_helper.rb

@@ -9,17 +9,19 @@ module Geet
     # 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)
+      def checked_find_branch_pr
+        owner = if @repository.upstream?
+          @repository.authenticated_user.username
+        else
+          @git_client.owner
+        end
+
+        head = @git_client.current_branch
+
         @out.puts "Finding PR with head (#{owner}:#{head})..."
 
         prs = @repository.prs(owner: owner, head: head)

data/lib/geet/services/abstract_create_issue.rb

@@ -12,22 +12,10 @@ module Geet
     class AbstractCreateIssue
       include Geet::Helpers::OsHelper
 
-      SUMMARY_BACKUP_FILENAME = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
-
       def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end
-
-      private
-
-      def save_summary(title, description)
-        summary = "#{title}\n\n#{description}".strip + "\n"
-
-        IO.write(SUMMARY_BACKUP_FILENAME, summary)
-
-        @out.puts "Error! Saved summary to #{SUMMARY_BACKUP_FILENAME}"
-      end
     end
   end
 end

data/lib/geet/services/comment_pr.rb

@@ -20,8 +20,7 @@ module Geet
       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 = checked_find_branch_pr
         pr.comment(comment)
         open_file_with_default_application(pr.link) unless no_open_pr
         pr

data/lib/geet/services/create_issue.rb

@@ -46,9 +46,6 @@ module Geet
         end
 
         issue
-      rescue => error
-        save_summary(title, description) if title
-        raise
       end
 
       private

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, 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,9 +37,9 @@ module Geet
           selected_labels, selected_milestone, selected_reviewers = find_and_select_attributes(labels, milestone, reviewers)
         end
 
-        sync_with_upstream_branch if automated_mode
+        sync_with_remote_branch if automated_mode
 
-        pr = create_pr(title, description, base: base)
+        pr = create_pr(title, description, base: base, draft: draft)
 
         if user_has_write_permissions
           edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
@@ -52,9 +52,6 @@ module Geet
         end
 
         pr
-      rescue => error
-        save_summary(title, description) if title
-        raise
       end
 
       private
@@ -81,26 +78,26 @@ module Geet
         selection_manager.select_attributes
       end
 
-      def sync_with_upstream_branch
-        if @git_client.upstream_branch
-          @out.puts "Pushing to upstream branch..."
+      def sync_with_remote_branch
+        if @git_client.remote_branch
+          @out.puts "Pushing to remote branch..."
 
           @git_client.push
         else
-          upstream_branch = @git_client.current_branch
+          remote_branch = @git_client.current_branch
 
-          @out.puts "Creating upstream branch #{upstream_branch.inspect}..."
+          @out.puts "Creating remote branch #{remote_branch.inspect}..."
 
-          @git_client.push(upstream_branch: upstream_branch)
+          @git_client.push(remote_branch: remote_branch)
         end
       end
 
-      def create_pr(title, description, base: nil)
+      def create_pr(title, description, base:, draft:)
         @out.puts 'Creating PR...'
 
         base ||= @git_client.main_branch
 
-        @repository.create_pr(title, description, @git_client.current_branch, base)
+        @repository.create_pr(title, description, @git_client.current_branch, base, draft)
       end
 
       def edit_pr(pr, labels, milestone, reviewers)

data/lib/geet/services/merge_pr.rb

@@ -23,8 +23,7 @@ module Geet
       end
 
       def execute(delete_branch: false)
-        merge_owner, merge_head = find_merge_head
-        pr = checked_find_branch_pr(merge_owner, merge_head)
+        pr = checked_find_branch_pr
 
         merge_pr(pr)
 
@@ -36,7 +35,7 @@ module Geet
 
         fetch_repository
 
-        if upstream_branch_gone?
+        if remote_branch_gone?
           pr_branch = @git_client.current_branch
           main_branch = @git_client.main_branch
 
@@ -72,8 +71,8 @@ module Geet
         @git_client.fetch
       end
 
-      def upstream_branch_gone?
-        @git_client.upstream_branch_gone?
+      def remote_branch_gone?
+        @git_client.remote_branch_gone?
       end
 
       def checkout_branch(branch)

data/lib/geet/services/open_pr.rb

@@ -19,9 +19,8 @@ module Geet
         @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)
+      def execute(delete_branch: false, **)
+        pr = checked_find_branch_pr
         open_file_with_default_application(pr.link)
         pr
       end

data/lib/geet/utils/git_client.rb

@@ -34,7 +34,7 @@ module Geet
         \Z
       }x
 
-      UPSTREAM_BRANCH_REGEX = %r{\A[^/]+/([^/]+)\Z}
+      REMOTE_BRANCH_REGEX = %r{\A[^/]+/(.+)\Z}
 
       MAIN_BRANCH_CONFIG_ENTRY = 'custom.development-branch'
 
@@ -48,11 +48,13 @@ module Geet
       # BRANCH/TREE APIS
       ##########################################################################
 
-      # Return the commit shas between HEAD and `limit`, excluding the already applied commits
+      # Return the commit SHAs between HEAD and `base`, excluding the already applied commits
       # (which start with `-`)
       #
-      def cherry(limit)
-        raw_commits = execute_git_command("cherry #{limit.shellescape}")
+      def cherry(base: nil)
+        base ||= main_branch
+
+        raw_commits = execute_git_command("cherry #{base.shellescape}")
 
         raw_commits.split("\n").grep(/^\+/).map { |line| line[3..-1] }
       end
@@ -65,25 +67,23 @@ module Geet
         branch
       end
 
-      # 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.
+      # return: nil, if the remote branch is not configured.
       #
-      def upstream_branch
+      def remote_branch
         head_symbolic_ref = execute_git_command("symbolic-ref -q HEAD")
 
-        raw_upstream_branch = execute_git_command("for-each-ref --format='%(upstream:short)' #{head_symbolic_ref.shellescape}").strip
+        raw_remote_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}")
+        if raw_remote_branch != ''
+          raw_remote_branch[REMOTE_BRANCH_REGEX, 1] || raise("Unexpected remote branch format: #{raw_remote_branch}")
         else
           nil
         end
       end
 
-      # TODO: May be merged with :upstream_branch, although it would require designing how a gone
+      # TODO: May be merged with :remote_branch, although it would require designing how a gone
       # remote branch is expressed.
       #
       # Sample command output:
@@ -91,7 +91,7 @@ module Geet
       #     ## add_milestone_closing...origin/add_milestone_closing [gone]
       #      M spec/integration/merge_pr_spec.rb
       #
-      def upstream_branch_gone?
+      def remote_branch_gone?
         git_command = "status -b --porcelain"
         status_output = execute_git_command(git_command)
 
@@ -216,12 +216,12 @@ module Geet
         execute_git_command("rebase")
       end
 
-      # upstream_branch: create an upstream branch.
+      # remote_branch: create an upstream branch.
       #
-      def push(upstream_branch: nil)
-        upstream_branch_option = "-u #{ORIGIN_NAME} #{upstream_branch.shellescape}" if upstream_branch
+      def push(remote_branch: nil)
+        remote_branch_option = "-u #{ORIGIN_NAME} #{remote_branch.shellescape}" if remote_branch
 
-        execute_git_command("push #{upstream_branch_option}")
+        execute_git_command("push #{remote_branch_option}")
       end
 
       # Performs pruning.

data/lib/geet/version.rb

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

data/spec/integration/create_pr_spec.rb

@@ -117,10 +117,6 @@ describe Geet::Services::CreatePr do
         allow(git_client).to receive(:working_tree_clean?).and_return(false)
         allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
 
-        expected_output = <<~STR
-          Error! Saved summary to /tmp/last_geet_edited_summary.md
-        STR
-
         actual_output = StringIO.new
 
         operation = -> do
@@ -129,21 +125,20 @@ describe Geet::Services::CreatePr do
         end
 
         expect(operation).to raise_error(RuntimeError, 'The working tree is not clean!')
-
-        expect(actual_output.string).to eql(expected_output)
+        expect(actual_output.string).to be_empty
       end
 
-      it 'should push to the upstream branch' do
+      it 'should push to the remote branch' do
         allow(git_client).to receive(:working_tree_clean?).and_return(true)
         allow(git_client).to receive(:current_branch).and_return('mybranch')
         allow(git_client).to receive(:main_branch).and_return('master')
-        expect(git_client).to receive(:upstream_branch).and_return('mybranch')
+        expect(git_client).to receive(:remote_branch).and_return('mybranch')
         expect(git_client).to receive(:push)
 
         allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
 
         expected_output = <<~STR
-          Pushing to upstream branch...
+          Pushing to remote branch...
           Creating PR...
           Assigning authenticated user...
           PR address: https://github.com/donaldduck/testrepo_f/pull/2
@@ -159,17 +154,17 @@ describe Geet::Services::CreatePr do
         expect(actual_output.string).to eql(expected_output)
       end
 
-      it "should create an upstream branch, when there isn't one (is not tracked)" do
+      it "should create a remote branch, when there isn't one (is not tracked)" do
         allow(git_client).to receive(:working_tree_clean?).and_return(true)
         allow(git_client).to receive(:current_branch).and_return('mybranch')
         allow(git_client).to receive(:main_branch).and_return('master')
-        expect(git_client).to receive(:upstream_branch).and_return(nil)
-        expect(git_client).to receive(:push).with(upstream_branch: 'mybranch')
+        expect(git_client).to receive(:remote_branch).and_return(nil)
+        expect(git_client).to receive(:push).with(remote_branch: 'mybranch')
 
         allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
 
         expected_output = <<~STR
-          Creating upstream branch "mybranch"...
+          Creating remote branch "mybranch"...
           Creating PR...
           Assigning authenticated user...
           PR address: https://github.com/donaldduck/testrepo_f/pull/4

data/spec/integration/merge_pr_spec.rb

@@ -7,7 +7,7 @@ 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
+# Specifically, `GitClient#remote_branch_gone?` needs to be handled, since it returns the current
 # branch, while it's supposed to return
 #
 describe Geet::Services::MergePr do
@@ -19,7 +19,7 @@ describe Geet::Services::MergePr do
 
   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(:remote_branch_gone?).and_return(true)
     expect(git_client).to receive(:checkout).with(main_branch)
     expect(git_client).to receive(:rebase)
     expect(git_client).to receive(:delete_branch).with('mybranch')

data/spec/vcr_cassettes/github_com/create_pr.yml

@@ -686,7 +686,7 @@ http_interactions:
     uri: https://api.github.com/repos/donaldduck/testrepo_f/pulls
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master"}'
+      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master","draft":false}'
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3

data/spec/vcr_cassettes/github_com/create_pr_in_auto_mode_create_upstream.yml

@@ -381,7 +381,7 @@ http_interactions:
     uri: https://api.github.com/repos/donaldduck/testrepo_f/pulls
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master"}'
+      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master","draft":false}'
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3

data/spec/vcr_cassettes/github_com/create_pr_in_auto_mode_with_push.yml

@@ -381,7 +381,7 @@ http_interactions:
     uri: https://api.github.com/repos/donaldduck/testrepo_f/pulls
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master"}'
+      string: '{"title":"Title","body":"Description","head":"mybranch","base":"master","draft":false}'
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3

data/spec/vcr_cassettes/github_com/create_pr_upstream.yml

@@ -459,7 +459,7 @@ http_interactions:
     uri: https://api.github.com/repos/donald-fr/testrepo_u/pulls
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","head":"donaldduck:mybranch","base":"master"}'
+      string: '{"title":"Title","body":"Description","head":"donaldduck:mybranch","base":"master","draft":false}'
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3

data/spec/vcr_cassettes/github_com/create_pr_upstream_without_write_permissions.yml

@@ -230,7 +230,7 @@ http_interactions:
     uri: https://api.github.com/repos/donald-fr/testrepo_u/pulls
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","head":"donaldduck:mybranch","base":"master"}'
+      string: '{"title":"Title","body":"Description","head":"donaldduck:mybranch","base":"master","draft":false}'
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geet
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_scripting
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.19
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Commandline interface for performing SCM host operations, eg. create a PR