geet 0.3.14 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0d6f3d992faa566e45dd0c1316a2b9a0a2b6748cf49daeee209a33477f50c2
-  data.tar.gz: '080403688353f05f693edb9ebb1edcc2fa67d8fc2fdc1d349323104df4442f4a'
+  metadata.gz: b2329057378f97cc59535b5821aeeca1f527bca27bd4ced6bb3250e46a55042c
+  data.tar.gz: 680b9175785b58deac3d5df918b2b843168ac709aea396168bd35091b6b7810b
 SHA512:
-  metadata.gz: a80700d27dcaa3304132ec4c91e6b31ff5c81ea40573a37205f1d2da20a17e88e3ae21e4e99e6c9f5296ace0ca10c1689e395e7c6cf04b67a04a6cf5e31a4983
-  data.tar.gz: 3daedde1e53f5ce6cabbd10bce4f729a1d0b446c8f431e619981b49c821085f497ec8c5a794f543954f525ba25e01b4c7427b362252fb6e6c5ab3a5135472c64
+  metadata.gz: 9dbb35ae368c401562677fa3a84138b53e1f15d4741802b478dca6cc166e65c451bf892316dcc9c32add3ca503d031a53d7964ffcc8910713fd2255f4b7c0220
+  data.tar.gz: ecba5a04fd823553108c83bc1e7a182d81d3a3e08d8e875584213e05f966153419fd30a4237f63126a419bcb8ce1007a1ad55e093ff24ea7d1f038ca3ad9c0cf

data/.gitignore

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

data/.travis.yml

@@ -1,9 +1,17 @@
+dist: bionic
 language: ruby
 rvm:
   - 2.3
   - 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,16 +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 PR
+  - create gist, issue, milestone, PR
 
 ## Samples
 

data/bin/geet

@@ -28,43 +28,58 @@ 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)
+
+      Services::CreateMilestone.new(repository).execute(title)
     when MILESTONE_LIST_COMMAND
       Services::ListMilestones.new(repository).execute
     when PR_COMMENT_COMMAND
       comment = options.delete(:comment)
 
-      Services::CommentPr.new(repository).execute(comment)
+      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-08-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/commands.rb

@@ -8,12 +8,16 @@ 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'
       PR_CREATE_COMMAND = 'pr.create'
       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,11 +45,21 @@ 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.'
+      ]
+
       MILESTONE_LIST_OPTIONS = [
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
       PR_COMMENT_OPTIONS = [
+        ['-n', '--no-open-pr',                              "Don't open the PR link in the browser after creation"],
         'comment',
         long_help: 'Add a comment to the PR for the current branch.'
       ]
@@ -57,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'],
@@ -88,6 +98,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 = {
@@ -103,6 +122,8 @@ module Geet
           'list' => LABEL_LIST_OPTIONS,
         },
         'milestone' => {
+          'close' => MILESTONE_CLOSE_OPTIONS,
+          'create' => MILESTONE_CREATE_OPTIONS,
           'list' => MILESTONE_LIST_OPTIONS,
         },
         'pr' => {
@@ -112,6 +133,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

@@ -58,6 +58,10 @@ module Geet
         attempt_provider_call(:Issue, :list, api_interface, assignee: assignee, milestone: milestone)
       end
 
+      def create_milestone(title)
+        attempt_provider_call(:Milestone, :create, title, api_interface)
+      end
+
       def milestone(number)
         attempt_provider_call(:Milestone, :find, number, api_interface)
       end
@@ -66,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)
         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)
         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
@@ -115,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
 
@@ -21,9 +23,23 @@ module Geet
         @api_interface = api_interface
       end
 
+      # See https://developer.github.com/v3/issues/milestones/#create-a-milestone
+      def self.create(title, api_interface, **)
+        api_path = 'milestones'
+        request_data = { title: title }
+
+        response = api_interface.send_request(api_path, data: request_data)
+
+        number = response.fetch('number')
+        title = response.fetch('title')
+        due_on = nil
+
+        new(number, title, due_on, api_interface)
+      end
+
       # 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)
@@ -37,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)
@@ -50,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,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/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)