geet 0.3.18 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b37d7ac48684dcd431b13c0e00cb9f999764ae714dec3c8d046102469f7f62f
-  data.tar.gz: 43a045941aff66c212314ae0de2c5c439434c75e89240ce2c59750f5759dcc5a
+  metadata.gz: b2329057378f97cc59535b5821aeeca1f527bca27bd4ced6bb3250e46a55042c
+  data.tar.gz: 680b9175785b58deac3d5df918b2b843168ac709aea396168bd35091b6b7810b
 SHA512:
-  metadata.gz: fe4aa67774fef6b5943ae4f6eb2950ec4d4c2b7f004aa963438e00904d80d01c3a73db8671567c718b6fc9b235a2e9d2002744ec891bce3ff4af1144ffa01d28
-  data.tar.gz: 14c3efa61fa206f3f3f70432c3683d394f9e4e4e09f6cefad757d96d11b88110559f393d22d296acef963d72d7117c668125724da79d8f1f6cbda9e35dfc367a
+  metadata.gz: 9dbb35ae368c401562677fa3a84138b53e1f15d4741802b478dca6cc166e65c451bf892316dcc9c32add3ca503d031a53d7964ffcc8910713fd2255f4b7c0220
+  data.tar.gz: ecba5a04fd823553108c83bc1e7a182d81d3a3e08d8e875584213e05f966153419fd30a4237f63126a419bcb8ce1007a1ad55e093ff24ea7d1f038ca3ad9c0cf

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-05-28'
+  s.date        = '2021-06-08'
   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

@@ -67,7 +67,7 @@ module Geet
       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 `master`"],
+        ['-b', '--base develop',                            "Specify the base branch; defaults to the main branch"],
         ['-l', '--labels "legacy,code review"',             'Labels'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
         ['-r', '--reviewers john,tom,adrian,kevin',         'Reviewer logins'],

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: nil)
+      def create_pr(title, description, head, base)
         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: base)
+        attempt_provider_call(:PR, :create, title, description, head, api_interface, base)
       end
 
       def prs(owner: nil, head: nil, milestone: nil)

data/lib/geet/github/issue.rb

@@ -8,7 +8,7 @@ module Geet
     class Issue < Geet::Github::AbstractIssue
       def self.create(title, description, api_interface, **)
         api_path = 'issues'
-        request_data = { title: title, body: description, base: 'master' }
+        request_data = { title: title, body: description }
 
         response = api_interface.send_request(api_path, data: request_data)
 

data/lib/geet/github/pr.rb

@@ -8,9 +8,8 @@ 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: nil)
+      def self.create(title, description, head, api_interface, base)
         api_path = 'pulls'
-        base ||= 'master'
 
         if api_interface.upstream?
           authenticated_user = Geet::Github::User.authenticated(api_interface).username

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/create_pr.rb

@@ -39,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)
 
         if user_has_write_permissions
           edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
@@ -95,10 +95,12 @@ module Geet
         end
       end
 
-      def create_pr(title, description, base)
+      def create_pr(title, description, base: nil)
         @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)
       end
 
       def edit_pr(pr, labels, milestone, reviewers)

data/lib/geet/services/merge_pr.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../helpers/services_workflow_helper'
-require_relative '../shared/branches'
 
 module Geet
   module Services
@@ -13,7 +12,7 @@ module Geet
     #
     class MergePr
       include Geet::Helpers::ServicesWorkflowHelper
-      include Geet::Shared::Branches
+      include Geet::Shared
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
@@ -39,11 +38,12 @@ module Geet
 
         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)
+          checkout_branch(main_branch)
           rebase
 
           delete_local_branch(pr_branch)

data/lib/geet/utils/git_client.rb

@@ -11,6 +11,7 @@ module Geet
     class GitClient
       include Geet::Helpers::OsHelper
 
+      ORIGIN_NAME = 'origin'
       UPSTREAM_NAME = 'upstream'
 
       # Simplified, but good enough, pattern.
@@ -35,6 +36,8 @@ module Geet
 
       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)
@@ -102,6 +105,19 @@ module Geet
         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_git_command("status")
 
@@ -203,7 +219,7 @@ module Geet
       # 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
@@ -227,10 +243,14 @@ module Geet
       # If executing a git command without calling this API, don't forget to split `gitdir_option`
       # and use it!
       #
-      def execute_git_command(command)
+      # 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}")
+        execute_command("git #{gitdir_option} #{command}", **options)
       end
     end
   end

data/lib/geet/version.rb

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

data/spec/integration/create_pr_spec.rb

@@ -14,6 +14,7 @@ describe Geet::Services::CreatePr 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
@@ -50,6 +51,7 @@ describe Geet::Services::CreatePr do
     context 'on an upstream repository' do
       it 'should create an upstream 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')
         allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:donald-fr/testrepo_u')
 
@@ -80,6 +82,7 @@ describe Geet::Services::CreatePr do
         context 'without 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')
             allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:donald-fr/testrepo_u')
 
@@ -133,6 +136,7 @@ describe Geet::Services::CreatePr do
       it 'should push to the upstream 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(:push)
 
@@ -158,6 +162,7 @@ describe Geet::Services::CreatePr do
       it "should create an upstream 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')
 

data/spec/integration/merge_pr_spec.rb

@@ -15,11 +15,12 @@ describe Geet::Services::MergePr do
   let(:repository) { Geet::Git::Repository.new(git_client: git_client) }
   let(:owner) { 'donaldduck' }
   let(:branch) { 'mybranch' }
+  let(:main_branch) { 'main' }
 
   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(:checkout).with(main_branch)
     expect(git_client).to receive(:rebase)
     expect(git_client).to receive(:delete_branch).with('mybranch')
   end
@@ -29,6 +30,7 @@ describe Geet::Services::MergePr do
 
     it 'should merge the PR for the current branch' do
       allow(git_client).to receive(:current_branch).and_return(branch)
+      allow(git_client).to receive(:main_branch).and_return(main_branch)
       allow(git_client).to receive(:remote).with(no_args).and_return("git@github.com:#{owner}/#{repository_name}")
 
       expected_pr_number = 1
@@ -36,7 +38,7 @@ describe Geet::Services::MergePr do
         Finding PR with head (#{owner}:#{branch})...
         Merging PR ##{expected_pr_number}...
         Fetching repository...
-        Checking out master...
+        Checking out #{main_branch}...
         Rebasing...
         Deleting local branch mybranch...
       STR
@@ -55,6 +57,7 @@ describe Geet::Services::MergePr do
 
     it 'should merge the PR for the current branch, with branch deletion' do
       allow(git_client).to receive(:current_branch).and_return(branch)
+      allow(git_client).to receive(:main_branch).and_return(main_branch)
       allow(git_client).to receive(:remote).with(no_args).and_return("git@github.com:#{owner}/#{repository_name}")
 
       expected_pr_number = 2
@@ -63,7 +66,7 @@ describe Geet::Services::MergePr do
         Merging PR ##{expected_pr_number}...
         Deleting remote branch #{branch}...
         Fetching repository...
-        Checking out master...
+        Checking out #{main_branch}...
         Rebasing...
         Deleting local branch mybranch...
       STR
@@ -86,6 +89,7 @@ describe Geet::Services::MergePr do
 
     it 'should merge the PR for the current branch' do
       allow(git_client).to receive(:current_branch).and_return(branch)
+      allow(git_client).to receive(:main_branch).and_return(main_branch)
       allow(git_client).to receive(:remote).with(no_args).and_return("git@gitlab.com:#{owner}/#{repository_name}")
 
       expected_pr_number = 4
@@ -93,7 +97,7 @@ describe Geet::Services::MergePr do
         Finding PR with head (#{owner}:#{branch})...
         Merging PR ##{expected_pr_number}...
         Fetching repository...
-        Checking out master...
+        Checking out #{main_branch}...
         Rebasing...
         Deleting local branch mybranch...
       STR

data/spec/vcr_cassettes/create_issue.yml

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

data/spec/vcr_cassettes/create_issue_upstream.yml

@@ -152,7 +152,7 @@ http_interactions:
     uri: https://api.github.com/repos/momcorp/therepo/issues
     body:
       encoding: UTF-8
-      string: '{"title":"Title","body":"Description","base":"master"}'
+      string: '{"title":"Title","body":"Description"}'
     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.3.18
+  version: 0.4.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_scripting
@@ -117,7 +117,6 @@ files:
 - lib/geet/services/merge_pr.rb
 - lib/geet/services/open_pr.rb
 - lib/geet/services/open_repo.rb
-- lib/geet/shared/branches.rb
 - lib/geet/shared/http_error.rb
 - lib/geet/shared/repo_permissions.rb
 - lib/geet/shared/selection.rb
@@ -191,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.19
 signing_key: 
 specification_version: 4
 summary: Commandline interface for performing SCM host operations, eg. create a PR

data/lib/geet/shared/branches.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Geet
-  module Shared
-    module Branches
-      MAIN_BRANCH = 'master'
-    end
-  end
-end