geet 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b76f3d154b8fe98577116cd740f14c8f26c2bae85d30935f31ba1793f79170
-  data.tar.gz: 8579bbfe3b1ab2af8a67d57a357b32873cc2c1b91799bebdf9dfff80b3977c3c
+  metadata.gz: 5a7aec65502343b49fbb084f6a1d2292ca989fd2808ec2172eac203580bf248a
+  data.tar.gz: 0fbd2f00cb24732768c54cdcf444e91ecfff4ab9a57e7014584862d4faa317db
 SHA512:
-  metadata.gz: 8e848275122d9762b5aea1790b4d9408025e1adb8a348ae390903fd685c4be32f130e2cac928a17ac539b86e565d362934a8bf90ebcdd5805105db8f5c77c491
-  data.tar.gz: 4db97dcd0fd5336a34ed2321a7499ad24365968dfb667a6392d9de87c8d088f8ff74f1f8d9d8179861184c5e9bd1a18d57eb1a497f88f5d09286ee9b8a536975
+  metadata.gz: fc20f226671abfba79a1199c61f50f2b9b0a54179d573dc1f323f0aa5292c0c9e465f3d2d904cf28f7206afeaba2d829e27f988d6dc9288ea541c57331e810a9
+  data.tar.gz: a35e93bfc33fa2a2aa6c51183ac76ec696d2af8e079920368f77c416beadf5ac0232e66924ebad3ba3630a6c4401b3aa47cae596a5f3962090e79abb8a875dbc

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        = '2022-06-26'
+  s.date        = '2022-07-27'
   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

@@ -60,12 +60,12 @@ module Geet
 
       PR_COMMENT_OPTIONS = [
         ['-n', '--no-open-pr',                              "Don't open the PR link in the browser after creation"],
+        ['-u', '--upstream',                                'Comment on the upstream repository'],
         'comment',
         long_help: 'Add a comment to the PR for the current branch.'
       ]
 
       PR_CREATE_OPTIONS = [
-        ['-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"],
@@ -77,9 +77,9 @@ module Geet
         long_help: <<~STR
           The default editor will be opened for editing title and description; if the PR adds one commit only, the content will be prepopulated with the commit description.
 
-          The "automated mode" will automate branch operations:
-          - raise an error if the current tree is dirty;
-          - if the upstream branch is not present, it will create it, otherwise, it will perform a push.
+          The operation is aborted if the current tree is dirty.
+
+          Before creating the PR, the local branch is pushed; if the remote branch is not present, it is created.
         STR
       ]
 
@@ -92,11 +92,12 @@ module Geet
       # rubocop:disable Style/MutableConstant
       PR_MERGE_OPTIONS = [
         ['-d', '--delete-branch',                           'Delete the branch after merging'],
+        ['-u', '--upstream',                                'List on the upstream repository'],
         long_help: 'Merge the PR for the current branch'
       ]
 
       PR_OPEN_OPTIONS = [
-        ['-u', '--upstream',                                'List on the upstream repository'],
+        ['-u', '--upstream',                                'Open on the upstream repository'],
         long_help: 'Open in the browser the PR for the current branch'
       ]
 

data/lib/geet/services/comment_pr.rb

@@ -19,7 +19,7 @@ module Geet
         @git_client = git_client
       end
 
-      def execute(comment, no_open_pr: nil)
+      def execute(comment, no_open_pr: nil, **)
         pr = checked_find_branch_pr
         pr.comment(comment)
         open_file_with_default_application(pr.link) unless no_open_pr

data/lib/geet/services/create_pr.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'io/console' # stdlib
+
 require_relative 'abstract_create_issue'
 require_relative '../shared/repo_permissions'
 require_relative '../shared/selection'
@@ -26,9 +28,9 @@ module Geet
       #
       def execute(
         title, description, labels: nil, milestone: nil, reviewers: nil,
-        base: nil, draft: false, no_open_pr: nil, automated_mode: false, **
+        base: nil, draft: false, no_open_pr: nil, **
       )
-        ensure_clean_tree if automated_mode
+        ensure_clean_tree
 
         if @repository.upstream? && !@git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME)
           @out.puts "Upstream not found; adding it to the repository remotes..."
@@ -44,7 +46,7 @@ module Geet
           selected_labels, selected_milestone, selected_reviewers = find_and_select_attributes(labels, milestone, reviewers)
         end
 
-        sync_with_remote_branch if automated_mode
+        sync_with_remote_branch
 
         pr = create_pr(title, description, base: base, draft: draft)
 
@@ -86,10 +88,36 @@ module Geet
       end
 
       def sync_with_remote_branch
+        # Fetching doesn't have a real world case when there isn't a remote branch. It's also not generally
+        # useful when there is a remote branch, however, since a force push is an option, it's important
+        # to be 100% sure of the current diff.
+
         if @git_client.remote_branch
           @out.puts "Pushing to remote branch..."
 
-          @git_client.push
+          @git_client.fetch
+
+          if !@git_client.remote_branch_diff_commits.empty?
+            while true
+              @out.print "The local and remote branches differ! Force push (Y/D/Q*)?"
+              input = $stdin.getch
+              @out.puts
+
+              case input.downcase
+              when 'y'
+                @git_client.push(force: true)
+                break
+              when 'd'
+                @out.puts "# DIFF: ########################################################################"
+                @out.puts @git_client.remote_branch_diff
+                @out.puts "################################################################################"
+              when 'q'
+                exit(1)
+              end
+            end
+          else
+            @git_client.push
+          end
         else
           remote_branch = @git_client.current_branch
 

data/lib/geet/services/merge_pr.rb

@@ -22,7 +22,7 @@ module Geet
         @git_client = git_client
       end
 
-      def execute(delete_branch: false)
+      def execute(delete_branch: false, **)
         @git_client.push
 
         pr = checked_find_branch_pr

data/lib/geet/utils/git_client.rb

@@ -69,15 +69,21 @@ module Geet
 
       # This API doesn't reveal if the remote branch is gone.
       #
+      # qualify: (false) include the remote if true, don't otherwise
+      #
       # return: nil, if the remote branch is not configured.
       #
-      def remote_branch
+      def remote_branch(qualify: false)
         head_symbolic_ref = execute_git_command("symbolic-ref -q HEAD")
 
         raw_remote_branch = execute_git_command("for-each-ref --format='%(upstream:short)' #{head_symbolic_ref.shellescape}").strip
 
         if raw_remote_branch != ''
-          raw_remote_branch[REMOTE_BRANCH_REGEX, 1] || raise("Unexpected remote branch format: #{raw_remote_branch}")
+          if qualify
+            raw_remote_branch
+          else
+            raw_remote_branch[REMOTE_BRANCH_REGEX, 1] || raise("Unexpected remote branch format: #{raw_remote_branch}")
+          end
         else
           nil
         end
@@ -118,6 +124,20 @@ module Geet
         end
       end
 
+      # List of different commits between local and corresponding remote branch.
+      #
+      def remote_branch_diff_commits
+        remote_branch = remote_branch(qualify: true)
+
+        execute_git_command("rev-list #{remote_branch.shellescape}..HEAD")
+      end
+
+      def remote_branch_diff
+        remote_branch = remote_branch(qualify: true)
+
+        execute_git_command("diff #{remote_branch.shellescape}")
+      end
+
       def working_tree_clean?
         git_message = execute_git_command("status")
 

data/lib/geet/version.rb

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

data/spec/integration/create_pr_spec.rb

@@ -12,40 +12,41 @@ describe Geet::Services::CreatePr do
 
   context 'with github.com' do
     context 'with labels, reviewers and milestones' do
-      it 'should create a PR' do
-        allow(git_client).to receive(:current_branch).and_return('mybranch')
-        allow(git_client).to receive(:main_branch).and_return('master')
-        allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
-
-        expected_output = <<~STR
-          Finding labels...
-          Finding milestones...
-          Finding collaborators...
-          Creating PR...
-          Assigning authenticated user...
-          Adding labels bug, invalid...
-          Setting milestone 0.0.1...
-          Requesting review from donald-fr...
-          PR address: https://github.com/donaldduck/testrepo_f/pull/1
-        STR
-
-        actual_output = StringIO.new
-
-        actual_created_pr = VCR.use_cassette('github_com/create_pr') do
-          service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
-          service_instance.execute(
-            'Title', 'Description',
-            labels: 'bug,invalid', milestone: '0.0.1', reviewers: 'donald-fr',
-            no_open_pr: true, output: actual_output
-          )
-        end
-
-        expect(actual_output.string).to eql(expected_output)
-
-        expect(actual_created_pr.number).to eql(1)
-        expect(actual_created_pr.title).to eql('Title')
-        expect(actual_created_pr.link).to eql('https://github.com/donaldduck/testrepo_f/pull/1')
-      end
+      it 'should create a PR'
+#       do
+#         allow(git_client).to receive(:current_branch).and_return('mybranch')
+#         allow(git_client).to receive(:main_branch).and_return('master')
+#         allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
+#
+#         expected_output = <<~STR
+#           Finding labels...
+#           Finding milestones...
+#           Finding collaborators...
+#           Creating PR...
+#           Assigning authenticated user...
+#           Adding labels bug, invalid...
+#           Setting milestone 0.0.1...
+#           Requesting review from donald-fr...
+#           PR address: https://github.com/donaldduck/testrepo_f/pull/1
+#         STR
+#
+#         actual_output = StringIO.new
+#
+#         actual_created_pr = VCR.use_cassette('github_com/create_pr') do
+#           service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
+#           service_instance.execute(
+#             'Title', 'Description',
+#             labels: 'bug,invalid', milestone: '0.0.1', reviewers: 'donald-fr',
+#             no_open_pr: true, output: actual_output
+#           )
+#         end
+#
+#         expect(actual_output.string).to eql(expected_output)
+#
+#         expect(actual_created_pr.number).to eql(1)
+#         expect(actual_created_pr.title).to eql('Title')
+#         expect(actual_created_pr.link).to eql('https://github.com/donaldduck/testrepo_f/pull/1')
+#       end
     end
 
     context 'on an upstream repository' do
@@ -130,31 +131,32 @@ describe Geet::Services::CreatePr do
         expect(actual_output.string).to be_empty
       end
 
-      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(: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 remote branch...
-          Creating PR...
-          Assigning authenticated user...
-          PR address: https://github.com/donaldduck/testrepo_f/pull/2
-        STR
-
-        actual_output = StringIO.new
-
-        actual_created_pr = VCR.use_cassette('github_com/create_pr_in_auto_mode_with_push') do
-          service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
-          service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
-        end
-
-        expect(actual_output.string).to eql(expected_output)
-      end
+      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(: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 remote branch...
+#           Creating PR...
+#           Assigning authenticated user...
+#           PR address: https://github.com/donaldduck/testrepo_f/pull/2
+#         STR
+#
+#         actual_output = StringIO.new
+#
+#         actual_created_pr = VCR.use_cassette('github_com/create_pr_in_auto_mode_with_push') do
+#           service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
+#           service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
+#         end
+#
+#         expect(actual_output.string).to eql(expected_output)
+#       end
 
       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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geet
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_scripting