geet 0.3.15 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24fb5de6b678ccceae3bf6366beded7c208a6d44f75db7303063176436365a5d
-  data.tar.gz: 4de89e5bfd5414e12cdbf74badf7ed36254f657dc9b8c3fe54c85d8af617b025
+  metadata.gz: 277ed0b36c021a28cc688fd768955c5639d0658885f60ff45f2a70c179a1e507
+  data.tar.gz: f181e99e34416ebf216d4fb603fd213217a9d188060d38ac2e9770e02aa5befb
 SHA512:
-  metadata.gz: f7631017c938ebf68f5c94e142fe00ab7a905cfa3c01383ed61296c0e1db29e76d743d7818c524732755cd7231d654316428bd2b23d2ae450dc83fac3856058e
-  data.tar.gz: b6e366dd0e923d4b8a4e91781ba5820365a885b866b377907ad965d54f71ac2a9dd061900e8b011c1f54e5c7619bf87d58af7474039deb476d1f3322c745242b
+  metadata.gz: 1b5a73ec3c4ffb45daf21dba976f1c6330b0c4a4f2ee0ea3065674710026745834287586dc897b7ec3a1a645e1ed7a3d60f7ca580a46b5f47dc2ed25b6031ee7
+  data.tar.gz: 0a4b834f9fcba3502c6f6408511001ab35fc08c5a5c4987b9c51ad5a4a16708ff714a7f47d993cdcd1decf0cf57dad75f4147deab2ac65363cad8cb6f37ee605

data/.gitignore

@@ -1,3 +1,4 @@
 /.ruby-version
 /.ruby-gemset
 /Gemfile.lock
+/test_repos

data/.travis.yml

@@ -5,6 +5,13 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
+  - 3.0
+  - ruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
 # API tokens are always required, but not used in testing, since no requests are actually made.
 env:
   - GITHUB_API_TOKEN=phony GITLAB_API_TOKEN=phony

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

@@ -28,24 +28,31 @@ class GeetLauncher
       filename = options.delete(:filename)
       options[:publik] = options.delete(:public) if options.key?(:public)
 
-      Services::CreateGist.new.execute(filename, options)
+      Services::CreateGist.new.execute(filename, **options)
     when ISSUE_CREATE_COMMAND
       summary = options[:summary] || Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
       title, description = split_summary(summary)
 
       options = default_to_manual_selection(options, :labels, :milestone, :assignees)
 
-      Services::CreateIssue.new(repository).execute(title, description, options)
+      Services::CreateIssue.new(repository).execute(title, description, **options)
     when LABEL_CREATE_COMMAND
       name = options.delete(:name)
 
-      Services::CreateLabel.new(repository).execute(name, options)
+      Services::CreateLabel.new(repository).execute(name, **options)
     when ISSUE_LIST_COMMAND
       options = default_to_manual_selection(options, :assignee)
 
-      Services::ListIssues.new(repository).execute(options)
+      Services::ListIssues.new(repository).execute(**options)
     when LABEL_LIST_COMMAND
       Services::ListLabels.new(repository).execute
+    when MILESTONE_CLOSE_COMMAND
+      # Don't support user selection. This requires extra complexity, specifically, matching by number
+      # while displaying the titles (see AttributesSelectionManager).
+      #
+      options = {numbers: Shared::Selection::MANUAL_LIST_SELECTION_FLAG}
+
+      Services::CloseMilestones.new(repository).execute(**options)
     when MILESTONE_CREATE_COMMAND
       title = options.delete(:title)
 
@@ -55,20 +62,24 @@ class GeetLauncher
     when PR_COMMENT_COMMAND
       comment = options.delete(:comment)
 
-      Services::CommentPr.new(repository).execute(comment, options)
+      Services::CommentPr.new(repository).execute(comment, **options)
     when PR_CREATE_COMMAND
       summary = options[:summary] || edit_pr_summary(base: options[:base])
       title, description = split_summary(summary)
 
       options = default_to_manual_selection(options, :labels, :milestone, :reviewers)
 
-      Services::CreatePr.new(repository).execute(title, description, options)
+      Services::CreatePr.new(repository).execute(title, description, **options)
     when PR_LIST_COMMAND
       Services::ListPrs.new(repository).execute
     when PR_MERGE_COMMAND
-      Services::MergePr.new(repository).execute(options)
+      Services::MergePr.new(repository).execute(**options)
     when PR_OPEN_COMMAND
-      Services::OpenPr.new(repository).execute(options)
+      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        = '2019-09-03'
+  s.date        = '2021-07-09'
   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

@@ -8,6 +8,7 @@ module Geet
       LABEL_CREATE_COMMAND = 'label.create'
       ISSUE_LIST_COMMAND = 'issue.list'
       LABEL_LIST_COMMAND = 'label.list'
+      MILESTONE_CLOSE_COMMAND = 'milestone.close'
       MILESTONE_CREATE_COMMAND = 'milestone.create'
       MILESTONE_LIST_COMMAND = 'milestone.list'
       PR_COMMENT_COMMAND = 'pr.comment'
@@ -15,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

@@ -45,6 +45,10 @@ module Geet
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
+      MILESTONE_CLOSE_OPTIONS = [
+        long_help: 'Close milestones.'
+      ]
+
       MILESTONE_CREATE_OPTIONS = [
         'title',
         long_help: 'Create a milestone.'
@@ -63,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'],
@@ -94,6 +99,15 @@ module Geet
         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 = {
@@ -109,6 +123,7 @@ module Geet
           'list' => LABEL_LIST_OPTIONS,
         },
         'milestone' => {
+          'close' => MILESTONE_CLOSE_OPTIONS,
           'create' => MILESTONE_CREATE_OPTIONS,
           'list' => MILESTONE_LIST_OPTIONS,
         },
@@ -119,6 +134,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

@@ -70,17 +70,27 @@ module Geet
         attempt_provider_call(:Milestone, :list, api_interface)
       end
 
-      def create_pr(title, description, head, base: nil)
+      def close_milestone(number)
+        attempt_provider_call(:Milestone, :close, number, api_interface)
+      end
+
+      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
@@ -119,7 +129,11 @@ module Geet
             raise "The functionality invoked (#{class_name}.#{meth}) is not currently supported!"
           end
 
-          klass.send(meth, *args)
+          # Can't use ruby2_keywords, because the method definitions use named keyword arguments.
+          #
+          kwargs = args.last.is_a?(Hash) ? args.pop : {}
+
+          klass.send(meth, *args, **kwargs)
         else
           raise "The class referenced (#{full_class_name}) is not currently supported!"
         end

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

@@ -5,7 +5,7 @@ module Geet
     class Branch
       # See https://developer.github.com/v3/git/refs/#delete-a-reference
       #
-      def self.delete(name, api_interface)
+      def self.delete(name, api_interface, **)
         api_path = "git/refs/heads/#{name}"
 
         api_interface.send_request(api_path, http_method: :delete)

data/lib/geet/github/issue.rb

@@ -6,9 +6,9 @@ module Geet
     autoload :AbstractIssue, File.expand_path('abstract_issue', __dir__)
 
     class Issue < Geet::Github::AbstractIssue
-      def self.create(title, description, api_interface)
+      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/label.rb

@@ -11,7 +11,7 @@ module Geet
       end
 
       # Returns a flat list of names in string form.
-      def self.list(api_interface)
+      def self.list(api_interface, **)
         api_path = 'labels'
         response = api_interface.send_request(api_path, multipage: true)
 
@@ -24,7 +24,7 @@ module Geet
       end
 
       # See https://developer.github.com/v3/issues/labels/#create-a-label
-      def self.create(name, color, api_interface)
+      def self.create(name, color, api_interface, **)
         api_path = 'labels'
         request_data = { name: name, color: color }
 

data/lib/geet/github/milestone.rb

@@ -7,6 +7,8 @@ module Geet
     class Milestone
       attr_reader :number, :title, :due_on
 
+      STATE_CLOSED = 'closed'
+
       class << self
         private
 
@@ -22,7 +24,7 @@ module Geet
       end
 
       # See https://developer.github.com/v3/issues/milestones/#create-a-milestone
-      def self.create(title, api_interface)
+      def self.create(title, api_interface, **)
         api_path = 'milestones'
         request_data = { title: title }
 
@@ -37,7 +39,7 @@ module Geet
 
       # See https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
       #
-      def self.find(number, api_interface)
+      def self.find(number, api_interface, **)
         api_path = "milestones/#{number}"
 
         response = api_interface.send_request(api_path)
@@ -51,7 +53,7 @@ module Geet
 
       # See https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
       #
-      def self.list(api_interface)
+      def self.list(api_interface, **)
         api_path = 'milestones'
 
         response = api_interface.send_request(api_path, multipage: true)
@@ -64,6 +66,17 @@ module Geet
           new(number, title, due_on, api_interface)
         end
       end
+
+      # See https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-a-milestone
+      #
+      # This is a convenience method; the underlying operation is a generic update.
+      #
+      def self.close(number, api_interface, **)
+        api_path = "milestones/#{number}"
+        request_data = { state: STATE_CLOSED }
+
+        api_interface.send_request(api_path, data: request_data)
+      end
     end
   end
 end

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)
 

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/github/user.rb

@@ -45,7 +45,7 @@ module Geet
 
       # See https://developer.github.com/v3/users/#get-the-authenticated-user
       #
-      def self.authenticated(api_interface)
+      def self.authenticated(api_interface, **_)
         api_path = '/user'
 
         response = api_interface.send_request(api_path)
@@ -55,7 +55,7 @@ module Geet
 
       # Returns an array of User instances
       #
-      def self.list_collaborators(api_interface)
+      def self.list_collaborators(api_interface, **)
         api_path = 'collaborators'
         response = api_interface.send_request(api_path, multipage: true)
 

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/gitlab/label.rb

@@ -11,7 +11,7 @@ module Geet
       end
 
       # Returns a flat list of names in string form.
-      def self.list(api_interface)
+      def self.list(api_interface, **)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/labels"
         response = api_interface.send_request(api_path, multipage: true)
 
@@ -24,7 +24,7 @@ module Geet
       end
 
       # See https://docs.gitlab.com/ee/api/labels.html#create-a-new-label
-      def self.create(name, color, api_interface)
+      def self.create(name, color, api_interface, **)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/labels"
         request_data = { name: name, color: "##{color}" }