geet 0.3.17 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a475adafa9bb0791266b171ea0e8ba05caf076227f1d3b68efe75697479c2cca
-  data.tar.gz: e63c7d8d46c3f44b0962ee1c3445e3aaf076f03b41f218bfde957779decfd445
+  metadata.gz: c13aed62c61e4cdaf20931f657c101daee30925b36a9b87fcce3b86d009d3c69
+  data.tar.gz: 5f13669499214cb7b13d96f05a25547a19a472e9d855e6d58967f5ce3ba3d138
 SHA512:
-  metadata.gz: 1d19fde0bb7c9733ee7aaea4c249378077d242c56f92055f29c1f3eb27e200de06890f2d5e97c76a58ffc604c46674ceddd8fc349b17907cee89fdfabbd029c0
-  data.tar.gz: dbdad4b310621f063af44aabfe71fb485232a836085c5729a057d350911408db3e3dd18e7a40459ceb80d4cae000f279ceaf2798a1eaf9f6caeab7b704da3fa8
+  metadata.gz: 8cb5a717299f16140d7ce1506d0bba549b87d97e4405f1d32549ea519ba58ccb2e918ce0561ecf714fcc2d3660f1172890c6fee99fc53270216b6656c730e7b9
+  data.tar.gz: 7ad452d8d32f8e96b853925aa745ad7664a4dd14cd97754ea6ab47627718938bb8af03e52eb4db28e425d96605bff83de74332a196d79845fd78baa870cbeef9

data/README.md

@@ -18,17 +18,12 @@ The functionalities currently supported are:
 
 - Github/Gitlab:
   - create label
-  - list issues
-  - list labels
-  - list milestones
-  - list PRs
-  - merge PR
+  - list issues, labels, milestones, MR/PRs
+  - merge MR/PR
+  - open repository
 - Github:
   - comment PR
-  - create gist
-  - create issue
-  - create milestone
-  - create PR
+  - create gist, issue, milestone, PR
 
 ## Samples
 

data/bin/geet

@@ -76,6 +76,10 @@ class GeetLauncher
       Services::MergePr.new(repository).execute(**options)
     when PR_OPEN_COMMAND
       Services::OpenPr.new(repository).execute(**options)
+    when REPO_ADD_UPSTREAM_COMMAND
+      Services::AddUpstreamRepo.new(repository).execute
+    when REPO_OPEN_COMMAND
+      Services::OpenRepo.new(repository).execute(**options)
     else
       raise "Internal error - Unrecognized command #{command.inspect}"
     end

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-01-18'
+  s.date        = '2021-07-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/commands.rb

@@ -16,6 +16,8 @@ module Geet
       PR_LIST_COMMAND = 'pr.list'
       PR_MERGE_COMMAND = 'pr.merge'
       PR_OPEN_COMMAND = 'pr.open'
+      REPO_ADD_UPSTREAM_COMMAND = 'repo.add_upstream'
+      REPO_OPEN_COMMAND = 'repo.open'
     end
   end
 end

data/lib/geet/commandline/configuration.rb

@@ -67,7 +67,8 @@ 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"],
+        ['-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,9 +96,19 @@ module Geet
       ]
 
       PR_OPEN_OPTIONS = [
+        ['-u', '--upstream',                                'List on the upstream repository'],
         long_help: 'Open in the browser the PR for the current branch'
       ]
 
+      REPO_ADD_UPSTREAM_OPTIONS = [
+        long_help: 'Add the upstream repository to the current repository (configuration).'
+      ]
+
+      REPO_OPEN_OPTIONS = [
+        ['-u', '--upstream',                                'Open the upstream repository'],
+        long_help: 'Open the current repository in the browser'
+      ]
+
       # Commands decoding table
 
       COMMANDS_DECODING_TABLE = {
@@ -124,6 +135,10 @@ module Geet
           'merge' => PR_MERGE_OPTIONS,
           'open' => PR_OPEN_OPTIONS,
         },
+        'repo' => {
+          'add_upstream' => REPO_ADD_UPSTREAM_OPTIONS,
+          'open' => REPO_OPEN_OPTIONS,
+        },
       }
 
       # Public interface

data/lib/geet/git/repository.rb

@@ -74,17 +74,23 @@ 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, 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: base)
+        attempt_provider_call(:PR, :create, title, description, head, api_interface, base, draft: draft)
       end
 
       def prs(owner: nil, head: nil, milestone: nil)
         attempt_provider_call(:PR, :list, api_interface, owner: owner, head: head, milestone: milestone)
       end
 
+      # Returns the RemoteRepository instance.
+      #
+      def remote
+        attempt_provider_call(:RemoteRepository, :find, api_interface)
+      end
+
       # REMOTE FUNCTIONALITIES (ACCOUNT)
 
       def authenticated_user

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

@@ -11,6 +11,8 @@ module Geet
       API_AUTH_USER = '' # We don't need the login, as the API key uniquely identifies the user
       API_BASE_URL = 'https://api.github.com'
 
+      attr_reader :repository_path
+
       # repo_path: optional for operations that don't require a repository, eg. gist creation.
       # upstream:  boolean; makes sense only when :repo_path is set.
       #

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,16 +8,15 @@ 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, draft: false)
         api_path = 'pulls'
-        base ||= 'master'
 
         if api_interface.upstream?
           authenticated_user = Geet::Github::User.authenticated(api_interface).username
           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)
 
@@ -33,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/github/remote_repository.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Geet
+  module Github
+    # A remote repository. Currently only provides the parent path.
+    #
+    # It's a difficult choice whether to independently use the repository path, or relying on the one
+    # stored in the ApiInterface.
+    # The former design is conceptually cleaner, but it practically (as of the current design) introduces
+    # duplication. All in all, for simplicity, the latter design is chosen, but is subject to redesign.
+    #
+    class RemoteRepository
+      # Nil if the repository is not a fork.
+      #
+      attr_reader :parent_path
+
+      def initialize(api_interface, parent_path: nil)
+        @api_interface = api_interface
+        @parent_path = parent_path
+      end
+
+      # Get the repository parent path.
+      #
+      # https://docs.github.com/en/rest/reference/repos#get-a-repository
+      #
+      def self.find(api_interface)
+        api_path = "/repos/#{api_interface.repository_path}"
+
+        response = api_interface.send_request(api_path)
+
+        parent_path = response['parent']&.fetch("full_name")
+
+        self.new(api_interface, parent_path: parent_path)
+      end
+    end # module RemoteRepository
+  end # module GitHub
+end # module Geet

data/lib/geet/gitlab/api_interface.rb

@@ -10,6 +10,8 @@ module Geet
     class ApiInterface
       API_BASE_URL = 'https://gitlab.com/api/v4'
 
+      attr_reader :repository_path
+
       # repo_path: "path/namespace"; required for the current GitLab operations.
       # upstream:  boolean; required for the current GitLab operations.
       #

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Geet
+  module Services
+    # Add the upstream repository to the current repository (configuration).
+    #
+    class AddUpstreamRepo
+      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
+        raise "Upstream remote already existing!" if @git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME)
+
+        parent_path = @repository.remote.parent_path
+
+        parent_url = compose_parent_url(parent_path)
+
+        @git_client.add_remote(Utils::GitClient::UPSTREAM_NAME, parent_url)
+      end
+
+      private
+
+      # Use the same protocol as the main repository.
+      #
+      def compose_parent_url(parent_path)
+        protocol, domain, separator, _, suffix = @git_client.remote_components
+
+        "#{protocol}#{domain}#{separator}#{parent_path}#{suffix}"
+      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_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)
+        pr = create_pr(title, description, base: base, draft: draft)
 
         if user_has_write_permissions
           edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
@@ -81,24 +81,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)
+      def create_pr(title, description, base:, draft:)
         @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, draft)
       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
 
@@ -24,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)
 
@@ -37,13 +35,14 @@ module Geet
 
         fetch_repository
 
-        if upstream_branch_gone?
+        if remote_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)
@@ -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)