geet 0.3.14 → 0.4.0

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
@@ -86,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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'shellwords'
 require_relative '../helpers/os_helper'
 
@@ -10,20 +11,33 @@ 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}
 
+      MAIN_BRANCH_CONFIG_ENTRY = 'custom.development-branch'
+
       CLEAN_TREE_MESSAGE_REGEX = /^nothing to commit, working tree clean$/
 
       def initialize(location: nil)
@@ -38,13 +52,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 +67,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 +83,43 @@ 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
+
+      # 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_command("git #{gitdir_option} status")
+        git_message = execute_git_command("status")
 
         !!(git_message =~ CLEAN_TREE_MESSAGE_REGEX)
       end
@@ -80,19 +131,26 @@ 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
 
       ##########################################################################
-      # 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
@@ -101,12 +159,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
@@ -116,12 +172,15 @@ 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}")
+      # 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
 
@@ -132,9 +191,10 @@ 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.
+        # If the remote is not defined, `git ls-remote` will return the passed value.
+        #
         remote_url != name
       end
 
@@ -142,12 +202,36 @@ 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
+        upstream_branch_option = "-u #{ORIGIN_NAME} #{upstream_branch.shellescape}" if upstream_branch
+
+        execute_git_command("push #{upstream_branch_option}")
+      end
+
+      # Performs pruning.
+      #
+      def fetch
+        execute_git_command("fetch --prune")
+      end
 
-        execute_command("git #{gitdir_option} push #{upstream_branch_option}")
+      def add_remote(name, url)
+        execute_git_command("remote add #{name.shellescape} #{url}")
       end
 
       ##########################################################################
@@ -156,8 +240,17 @@ 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!
+      #
+      # 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}", **options)
       end
     end
   end

data/lib/geet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geet
-  VERSION = '0.3.14'
+  VERSION = '0.4.0'
 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...
@@ -59,7 +59,7 @@ describe Geet::Services::CreateIssue do
 
         actual_created_issue = VCR.use_cassette('create_issue_upstream') do
           create_options = { no_open_issue: true, out: actual_output }
-          described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', create_options)
+          described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', **create_options)
         end
 
         expect(actual_output.string).to eql(expected_output)

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require_relative '../../lib/geet/git/repository'
+require_relative '../../lib/geet/services/create_milestone'
+
+describe Geet::Services::CreateMilestone do
+  let(:git_client) { Geet::Utils::GitClient.new }
+  let(:repository) { Geet::Git::Repository.new(git_client: git_client) }
+  let(:upstream_repository) { Geet::Git::Repository.new(upstream: true, git_client: git_client) }
+
+  context 'with github.com' do
+    it 'should create a milestone' do
+      allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_upstream')
+
+      expected_output = <<~STR
+        Creating milestone...
+      STR
+
+      actual_output = StringIO.new
+
+      actual_created_label = VCR.use_cassette('github_com/create_milestone') do
+        described_class.new(repository, out: actual_output).execute('my_milestone')
+      end
+
+      expect(actual_output.string).to eql(expected_output)
+
+      expect(actual_created_label.number).to eql(6)
+      expect(actual_created_label.title).to eql('my_milestone')
+      expect(actual_created_label.due_on).to be(nil)
+    end
+  end # context 'with github.com'
+end # describe Geet::Services::CreateLabel

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
@@ -133,10 +136,11 @@ 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)
 
-        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...
@@ -158,10 +162,11 @@ 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')
 
-        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"...