geet 0.3.17 → 0.4.2

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/services/open_repo.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/os_helper'
+
+module Geet
+  module Services
+    # Open in the browser the current repository.
+    #
+    class OpenRepo
+      include Helpers::OsHelper
+
+      DEFAULT_GIT_CLIENT = Utils::GitClient.new
+
+      def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @out = out
+        @git_client = git_client
+      end
+
+      def execute(upstream: false)
+        remote_options = upstream ? {name: Utils::GitClient::UPSTREAM_NAME} : {}
+
+        repo_url = @git_client.remote(**remote_options)
+        repo_url = convert_repo_url_to_http_protocol(repo_url)
+
+        open_file_with_default_application(repo_url)
+
+        repo_url
+      end
+
+      private
+
+      # The repository URL may be in any of the git/http protocols.
+      #
+      def convert_repo_url_to_http_protocol(repo_url)
+        case repo_url
+        when /https:/
+        when /git@/
+        else
+          # Minimal error, due to match guaranteed by GitClient#remote.
+          raise
+        end
+
+        domain, _, path = repo_url.match(Utils::GitClient::REMOTE_URL_REGEX)[2..4]
+
+        "https://#{domain}/#{path}"
+      end
+    end
+  end
+end

data/lib/geet/utils/attributes_selection_manager.rb

@@ -88,6 +88,13 @@ module Geet
       #   select_entries('reviewer', all_collaborators, 'donaldduck', nil)
       #
       def select_entries(entry_type, entries, pattern, name_method)
+        # Support both formats Array and String.
+        # It seems that at some point, SimpleScripting started splitting arrays automatically, so until
+        # the code is adjusted accordingly, this accommodates both the CLI and the test suite.
+        # Tracked here: https://github.com/saveriomiroddi/geet/issues/171.
+        #
+        pattern = pattern.join(',') if pattern.is_a?(Array)
+
         if pattern == MANUAL_LIST_SELECTION_FLAG
           Geet::Utils::ManualListSelection.new.select_entries(entry_type, entries, name_method: name_method)
         else

data/lib/geet/utils/git_client.rb

@@ -11,19 +11,32 @@ module Geet
     class GitClient
       include Geet::Helpers::OsHelper
 
-      ORIGIN_NAME   = 'origin'
+      ORIGIN_NAME = 'origin'
       UPSTREAM_NAME = 'upstream'
 
-      # For simplicity, we match any character except the ones the separators.
-      REMOTE_ORIGIN_REGEX = %r{
+      # Simplified, but good enough, pattern.
+      #
+      # Relevant matches:
+      #
+      #   1: protocol + suffix
+      #   2: domain
+      #   3: domain<>path separator
+      #   4: path (repo, project)
+      #   5: suffix
+      #
+      REMOTE_URL_REGEX = %r{
         \A
-        (?:https://(.+?)/|git@(.+?):)
-        ([^/]+/.*?)
-        (?:\.git)?
+        (https://|git@)
+        (.+?)
+        ([/:])
+        (.+/.+?)
+        (\.git)?
         \Z
       }x
 
-      UPSTREAM_BRANCH_REGEX = %r{\A[^/]+/([^/]+)\Z}
+      REMOTE_BRANCH_REGEX = %r{\A[^/]+/(.+)\Z}
+
+      MAIN_BRANCH_CONFIG_ENTRY = 'custom.development-branch'
 
       CLEAN_TREE_MESSAGE_REGEX = /^nothing to commit, working tree clean$/
 
@@ -52,25 +65,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:
@@ -78,7 +89,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)
 
@@ -92,6 +103,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")
 
@@ -109,15 +133,22 @@ module Geet
       end
 
       ##########################################################################
-      # REPOSITORY/REMOTE APIS
+      # REPOSITORY/REMOTE QUERYING APIS
       ##########################################################################
 
+      # Return the components of the remote, according to REMOTE_URL_REGEX; doesn't include the full
+      # match.
+      #
+      def remote_components(name: nil)
+        remote.match(REMOTE_URL_REGEX)[1..]
+      end
+
       # Example: `donaldduck/geet`
       #
       def path(upstream: false)
-        remote_name = upstream ? UPSTREAM_NAME : ORIGIN_NAME
+        remote_name_option = upstream ? {name: UPSTREAM_NAME} : {}
 
-        remote(remote_name)[REMOTE_ORIGIN_REGEX, 3]
+        remote(**remote_name_option)[REMOTE_URL_REGEX, 4]
       end
 
       def owner
@@ -126,12 +157,10 @@ module Geet
 
       def provider_domain
         # We assume that it's not possible to have origin and upstream on different providers.
-        #
-        remote_url = remote(ORIGIN_NAME)
 
-        domain = remote_url[REMOTE_ORIGIN_REGEX, 1] || remote_url[REMOTE_ORIGIN_REGEX, 2]
+        domain = remote()[REMOTE_URL_REGEX, 2]
 
-        raise "Can't identify domain in the provider domain string: #{domain}" if domain !~ /(.*)\.\w+/
+        raise "Can't identify domain in the provider domain string: #{domain}" if domain !~ /\w+\.\w+/
 
         domain
       end
@@ -141,12 +170,15 @@ module Geet
       #
       # The result is in the format `git@github.com:donaldduck/geet.git`
       #
-      def remote(name)
+      # options
+      #   :name:           remote name; if unspecified, the default remote is used.
+      #
+      def remote(name: nil)
         remote_url = execute_git_command("ls-remote --get-url #{name}")
 
-        if remote_url == name
+        if !remote_defined?(name)
           raise "Remote #{name.inspect} not found!"
-        elsif remote_url !~ REMOTE_ORIGIN_REGEX
+        elsif remote_url !~ REMOTE_URL_REGEX
           raise "Unexpected remote reference format: #{remote_url.inspect}"
         end
 
@@ -159,7 +191,8 @@ module Geet
       def remote_defined?(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.
+        # If the remote is not defined, `git ls-remote` will return the passed value.
+        #
         remote_url != name
       end
 
@@ -181,12 +214,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 #{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.
@@ -195,6 +228,10 @@ module Geet
         execute_git_command("fetch --prune")
       end
 
+      def add_remote(name, url)
+        execute_git_command("remote add #{name.shellescape} #{url}")
+      end
+
       ##########################################################################
       # INTERNAL HELPERS
       ##########################################################################
@@ -204,10 +241,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.17'
+  VERSION = '0.4.2'
 end

data/spec/integration/comment_pr_spec.rb

@@ -17,7 +17,7 @@ describe Geet::Services::CommentPr do
 
     it 'should add a comment to the PR for the current branch' do
       allow(git_client).to receive(:current_branch).and_return(branch)
-      allow(git_client).to receive(:remote).with('origin').and_return("git@github.com:#{owner}/#{repository_name}")
+      allow(git_client).to receive(:remote).with(no_args).and_return("git@github.com:#{owner}/#{repository_name}")
 
       expected_pr_number = 3
       expected_output = <<~STR

data/spec/integration/create_issue_spec.rb

@@ -12,7 +12,7 @@ describe Geet::Services::CreateIssue do
 
   context 'with labels, assignees and milestones' do
     it 'should create an issue' do
-      allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
+      allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
 
       expected_output = <<~STR
         Finding labels...
@@ -47,8 +47,8 @@ describe Geet::Services::CreateIssue do
     context 'without labels, assignees and milestones' do
       it 'should create an upstream issue' do
         allow(git_client).to receive(:current_branch).and_return('mybranch')
-        allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
-        allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:momcorp/therepo')
+        allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo')
+        allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:momcorp/therepo')
 
         expected_output = <<~STR
           Creating the issue...

data/spec/integration/create_label_spec.rb

@@ -13,7 +13,7 @@ describe Geet::Services::CreateLabel do
   context 'with github.com' do
     context 'with user-specified color' do
       it 'should create a label' do
-        allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
+        allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo')
 
         expected_output = <<~STR
           Creating label...
@@ -34,8 +34,8 @@ describe Geet::Services::CreateLabel do
 
       context 'upstream' do
         it 'should create a label' do
-          allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
-          allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:donaldduck-fr/testrepo_gh')
+          allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo')
+          allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:donaldduck-fr/testrepo_gh')
 
           expected_output = <<~STR
             Creating label...
@@ -58,7 +58,7 @@ describe Geet::Services::CreateLabel do
 
     context 'with auto-generated color' do
       it 'should create a label' do
-        allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
+        allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo')
 
         actual_output = StringIO.new
 
@@ -87,7 +87,7 @@ describe Geet::Services::CreateLabel do
 
   context 'with gitlab.com' do
     it 'should create a label' do
-      allow(git_client).to receive(:remote).with('origin').and_return('git@gitlab.com:donaldduck/testproject')
+      allow(git_client).to receive(:remote).with(no_args).and_return('git@gitlab.com:donaldduck/testproject')
 
       expected_output = <<~STR
         Creating label...

data/spec/integration/create_milestone_spec.rb

@@ -12,7 +12,7 @@ describe Geet::Services::CreateMilestone do
 
   context 'with github.com' do
     it 'should create a milestone' do
-      allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_upstream')
+      allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_upstream')
 
       expected_output = <<~STR
         Creating milestone...

data/spec/integration/create_pr_spec.rb

@@ -14,7 +14,8 @@ 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(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
+        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...
@@ -50,8 +51,9 @@ 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(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
-        allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:donald-fr/testrepo_u')
+        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')
 
         expected_output = <<~STR
           Creating PR...
@@ -80,8 +82,9 @@ 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(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
-            allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:donald-fr/testrepo_u')
+            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')
 
             expected_output = <<~STR
               Creating PR...
@@ -112,7 +115,7 @@ describe Geet::Services::CreatePr do
     context 'in automated mode' do
       it 'should raise an error when the working tree is dirty' do
         allow(git_client).to receive(:working_tree_clean?).and_return(false)
-        allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
+        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
@@ -130,16 +133,17 @@ describe Geet::Services::CreatePr do
         expect(actual_output.string).to eql(expected_output)
       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')
-        expect(git_client).to receive(:upstream_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('origin').and_return('git@github.com:donaldduck/testrepo_f')
+        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
@@ -155,16 +159,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')
-        expect(git_client).to receive(:upstream_branch).and_return(nil)
-        expect(git_client).to receive(:push).with(upstream_branch: 'mybranch')
+        allow(git_client).to receive(:main_branch).and_return('master')
+        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('origin').and_return('git@github.com:donaldduck/testrepo_f')
+        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