geet 0.3.11 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3028d791ef73b12a9f62d87bb5bf8816732458f83ff516710fcb05995a7e454d
-  data.tar.gz: bc08e3337f41536a1b52064fc4b6d54cda680206e71eae53d1a85a4dc2f1579c
+  metadata.gz: 15603a9a3a61fd8b6c3a377bd8fb1f482c121078b153e0cb8f3bdf12609d01f2
+  data.tar.gz: cde2b52ebcc17f2af2e64466c5565a65fad846e946747d91dfd734e5ce108e2c
 SHA512:
-  metadata.gz: cf3fbd2a20215ad7d41a5016bea9f35eeff72c5db9a811c1d5f8b77b427c22fd4b3ff7ed3314befe228e821e546c44dedb1c9ca48016d965990a5194ee4452ad
-  data.tar.gz: 131fd6221ab18b4aa41d8fb9bfbed26b4bb41e10f876d6341a9958f6e958755956ac540739424cb5758b3a51db427ee41a1a38fb6dbec4fd748392b3de707de8
+  metadata.gz: 5ea5d57a2f25a0f83910afe316194d335f11d04b4228324ab577845a74b62331705b3650b654cdb951e69c6fa76438441e1fa1caa3bf431e456acefc39f4457d
+  data.tar.gz: 06c954789d0e39cb723daa45de62c190817773cad1c29d1719524452c98731ded5f0cce8f72450f677c54688c38636b21538eca04226dafb45b00d16ab548806

data/.byebug_history

@@ -0,0 +1,5 @@
+n
+s
+n
+s
+owner

data/.travis.yml

@@ -1,9 +1,16 @@
+dist: bionic
 language: ruby
 rvm:
   - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
+  - 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

@@ -24,8 +24,10 @@ The functionalities currently supported are:
   - list PRs
   - merge PR
 - Github:
+  - comment PR
   - create gist
   - create issue
+  - create milestone
   - create PR
 
 ## Samples

data/bin/geet

@@ -46,8 +46,23 @@ class GeetLauncher
       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, options)
     when PR_CREATE_COMMAND
       summary = options[:summary] || edit_pr_summary(base: options[:base])
       title, description = split_summary(summary)
@@ -59,6 +74,8 @@ class GeetLauncher
       Services::ListPrs.new(repository).execute
     when PR_MERGE_COMMAND
       Services::MergePr.new(repository).execute(options)
+    when PR_OPEN_COMMAND
+      Services::OpenPr.new(repository).execute(options)
     else
       raise "Internal error - Unrecognized command #{command.inspect}"
     end

data/extra/anonymize_vcr_data

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+set -o errexit
+
+# We match ids with a length of 6 or more chars for simplicity - if we a generic `\d+` match is
+# performed, there are false positives (e.g. PR numbers).
+#
+# Note that since this is an associative array, there is not guaranteed ordering.
+#
+declare -A PATTERNS=(
+  ['Saverio']='Donald'
+  ['saverio']='donald'
+  ['Miroddi']='Duck'
+  ['miroddi']='duck'
+  ['("\w*id"):\d{6,}']='$1:123456'
+  ['\b(\w*id)=\d{6,}']='$1=123456'
+  ['u\/\d{6,}\b']='u\/123456'
+  ['(gravatar.com\/avatar\/)[0-9a-f]{16}']='${1}0123456789abcdef'
+)
+
+TEST_SUITES_LOCATION="$(git rev-parse --show-toplevel)/spec"
+
+if [[ "$1" == "-h" || "$1" == "--help" ]]; then
+  cat <<HELP
+Usage: $(basename "$0") [<files...>|<dirs...>]
+
+Anonymizes the private data in all the files in the project test suites subdirectory ('$TEST_SUITES_LOCATION').
+
+Before applying the changes, all the project files are added to the staging area.
+
+Private data patterns:
+
+HELP
+
+  for key in ${!PATTERNS[@]}; do
+    echo "- $key => ${PATTERNS[$key]}"
+  done
+
+  cat <<'HELP'
+HELP
+
+  exit 0
+fi
+
+if [[ ! -d "$TEST_SUITES_LOCATION" ]]; then
+  echo "The expected TEST_SUITES_LOCATION '$TEST_SUITES_LOCATION' doesn't exist!"
+  exit 1
+fi
+
+git add -A :/
+
+for pattern_from in ${!PATTERNS[@]}; do
+  pattern_to="${PATTERNS[$pattern_from]}"
+
+  grep -lP "$pattern_from" -r "$TEST_SUITES_LOCATION" | xargs -I {} perl -i -pe "s/$pattern_from/$pattern_to/g" "{}"
+done
+
+git difftool --extcmd='vim -d -c "windo set wrap" $5'

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-03-20'
+  s.date        = '2020-11-16'
   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,10 +8,14 @@ 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'
     end
   end
 end

data/lib/geet/commandline/configuration.rb

@@ -45,10 +45,25 @@ 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.'
+      ]
+
       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"],
@@ -79,6 +94,10 @@ module Geet
         long_help: 'Merge the PR for the current branch'
       ]
 
+      PR_OPEN_OPTIONS = [
+        long_help: 'Open in the browser the PR for the current branch'
+      ]
+
       # Commands decoding table
 
       COMMANDS_DECODING_TABLE = {
@@ -94,12 +113,16 @@ module Geet
           'list' => LABEL_LIST_OPTIONS,
         },
         'milestone' => {
+          'close' => MILESTONE_CLOSE_OPTIONS,
+          'create' => MILESTONE_CREATE_OPTIONS,
           'list' => MILESTONE_LIST_OPTIONS,
         },
         'pr' => {
+          'comment' => PR_COMMENT_OPTIONS,
           'create' => PR_CREATE_OPTIONS,
           'list' => PR_LIST_OPTIONS,
           'merge' => PR_MERGE_OPTIONS,
+          'open' => PR_OPEN_OPTIONS,
         },
       }
 

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,6 +70,10 @@ module Geet
         attempt_provider_call(:Milestone, :list, api_interface)
       end
 
+      def close_milestone(number)
+        attempt_provider_call(:Milestone, :close, number, api_interface)
+      end
+
       def create_pr(title, description, head, base: nil)
         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
@@ -73,8 +81,8 @@ module Geet
         attempt_provider_call(:PR, :create, title, description, head, api_interface, base: base)
       end
 
-      def prs(head: nil, milestone: nil)
-        attempt_provider_call(:PR, :list, api_interface, head: head, milestone: milestone)
+      def prs(owner: nil, head: nil, milestone: nil)
+        attempt_provider_call(:PR, :list, api_interface, owner: owner, head: head, milestone: milestone)
       end
 
       # REMOTE FUNCTIONALITIES (ACCOUNT)

data/lib/geet/github/abstract_issue.rb

@@ -61,6 +61,15 @@ module Geet
         @api_interface.send_request(api_path, data: request_data)
       end
 
+      # See https://developer.github.com/v3/issues/comments/#create-a-comment
+      #
+      def comment(comment)
+        api_path = "issues/#{@number}/comments"
+        request_data = { body: comment }
+
+        @api_interface.send_request(api_path, data: request_data)
+      end
+
       # See https://developer.github.com/v3/issues/#edit-an-issue
       #
       def edit(milestone:)

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,6 +23,20 @@ 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)
@@ -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

@@ -28,12 +28,12 @@ module Geet
 
       # See https://developer.github.com/v3/pulls/#list-pull-requests
       #
-      def self.list(api_interface, milestone: nil, assignee: nil, head: nil)
+      def self.list(api_interface, milestone: nil, assignee: nil, owner: nil, head: nil)
         check_list_params!(milestone, assignee, head)
 
         if head
           api_path = 'pulls'
-          request_params = { head: head }
+          request_params = { head: "#{owner}:#{head}" }
 
           response = api_interface.send_request(api_path, params: request_params, multipage: true)
 

data/lib/geet/gitlab/pr.rb

@@ -12,11 +12,16 @@ module Geet
         @link = link
       end
 
+      # owner: required only for API compatibility. it's not required; if passed, it's only checked
+      #        against the API path to make sure it's correct.
+      #
       # See https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests
       #
-      def self.list(api_interface, milestone: nil, assignee: nil, head: nil)
+      def self.list(api_interface, milestone: nil, assignee: nil, owner: nil, head: nil)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/merge_requests"
 
+        check_list_owner!(api_interface, owner) if owner
+
         request_params = {}
         request_params[:assignee_id] = assignee.id if assignee
         request_params[:milestone] = milestone.title if milestone
@@ -40,6 +45,16 @@ module Geet
 
         @api_interface.send_request(api_path, http_method: :put)
       end
+
+      class << self
+        private
+
+        def check_list_owner!(api_interface, owner)
+          if !api_interface.path_with_namespace.start_with?("#{owner}/")
+            raise "Mismatch owner/API path!: #{owner}<>#{api_interface.path_with_namespace}"
+          end
+        end
+      end
     end # PR
   end # Gitlab
 end # Geet

data/lib/geet/helpers/services_workflow_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'open3'
+require 'shellwords'
+
+module Geet
+  module Helpers
+    # 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)
+        @out.puts "Finding PR with head (#{owner}:#{head})..."
+
+        prs = @repository.prs(owner: owner, head: head)
+
+        raise "Expected to find only one PR for the current branch; found: #{prs.size}" if prs.size != 1
+
+        prs[0]
+      end
+    end
+  end
+end

data/lib/geet/services/close_milestones.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../shared/selection'
+
+module Geet
+  module Services
+    class CloseMilestones
+      include Geet::Shared::Selection
+
+      def initialize(repository, out: $stdout)
+        @repository = repository
+        @out = out
+      end
+
+      def execute(numbers: nil)
+        numbers = find_and_select_milestone_numbers(numbers)
+
+        close_milestone_threads = close_milestones(numbers)
+
+        close_milestone_threads.each(&:join)
+      end
+
+      private
+
+      def find_and_select_milestone_numbers(numbers)
+        selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
+
+        selection_manager.add_attribute(:milestones, 'milestone', numbers, SELECTION_MULTIPLE, name_method: :title)
+
+        milestones = selection_manager.select_attributes[0]
+
+        milestones.map(&:number)
+      end
+
+      def close_milestones(numbers)
+        @out.puts "Closing milestones #{numbers.join(', ')}..."
+
+        numbers.map do |number|
+          Thread.new do
+            @repository.close_milestone(number)
+          end
+        end
+      end
+    end # CloseMilestones
+  end # Services
+end # Geet