geet 0.3.0 → 0.3.1

data/lib/geet/github/api_interface.rb

@@ -11,9 +11,12 @@ 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'
 
-      def initialize(api_token, repository_path, upstream)
+      # repo_path: optional for operations that don't require a repository, eg. gist creation.
+      # upstream:  boolean; makes sense only when :repo_path is set.
+      #
+      def initialize(api_token, repo_path: nil, upstream: nil)
         @api_token = api_token
-        @repository_path = repository_path
+        @repository_path = repo_path
         @upstream = upstream
       end
 
@@ -69,7 +72,12 @@ module Geet
 
       def api_url(api_path)
         url = API_BASE_URL
-        url += "/repos/#{@repository_path}/" if !api_path.start_with?('/')
+
+        if !api_path.start_with?('/')
+          raise 'Missing repo path!' if @repository_path.nil?
+          url += "/repos/#{@repository_path}/"
+        end
+
         url + api_path
       end
 

data/lib/geet/github/gist.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'abstract_issue'
+require_relative '../github/gist'
 
 module Geet
   module Github

data/lib/geet/gitlab/api_interface.rb

@@ -11,9 +11,12 @@ module Geet
     class ApiInterface
       API_BASE_URL = 'https://gitlab.com/api/v4'
 
-      def initialize(api_token, path_with_namespace, upstream)
+      # repo_path: "path/namespace"; required for the current GitLab operations.
+      # upstream:  boolean; required for the current GitLab operations.
+      #
+      def initialize(api_token, repo_path:, upstream:)
         @api_token = api_token
-        @path_with_namespace = path_with_namespace
+        @path_with_namespace = repo_path
         @upstream = upstream
       end
 

data/lib/geet/helpers/os_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'English'
+require 'open3'
 require 'shellwords'
 
 module Geet
@@ -14,10 +15,42 @@ module Geet
         end
       end
 
-      def execute_command(description, *command_tokens)
-        system(*command_tokens.map(&:shellescape))
+      # Executes the command.
+      #
+      # If the command doesn't execute successfully, it will raise an error.
+      #
+      # On non-interactive runs, the stdout content is returned, stripped of the surrounding
+      # whitespaces.
+      #
+      # description:   optional string, to make the error clearer.
+      # 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
+      #
+      def execute_command(command, description: nil, interactive: false, silent_stderr: false)
+        description_message = " on #{description}" if description
 
-        raise "Error during #{description} (exit status: #{$CHILD_STATUS.exitstatus})" if !$CHILD_STATUS.success?
+        if interactive
+          system(command)
+
+          if !$CHILD_STATUS.success?
+            raise "Error#{description_message} (exit status: #{$CHILD_STATUS.exitstatus})"
+          end
+        else
+          Open3.popen3(command) do |_, stdout, stderr, wait_thread|
+            stdout_content = stdout.read
+            stderr_content = stderr.read
+
+            puts stderr_content if stderr_content != '' && !silent_stderr
+
+            if !wait_thread.value.success?
+              error_message = stderr_content.lines.first.strip
+              raise "Error#{description_message}: #{error_message})"
+            end
+
+            stdout_content.strip
+          end
+        end
       end
     end
   end

data/lib/geet/helpers/summary_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Geet
+  module Helpers
+    module SummaryHelper
+      # Split the summary in title and description.
+      # The description is optional, but the title mandatory.
+      #
+      def split_summary(summary)
+        raise "Missing title in summary!" if summary.to_s.strip.empty?
+
+        title, description = summary.split(/\r|\n/, 2)
+
+        # The title may have a residual newline char; the description may not be present,
+        # or have multiple blank lines.
+        [title.strip, description.to_s.strip]
+      end
+    end
+  end
+end

data/lib/geet/resources/{edit_summary_template.md → templates/edit_summary.md}

@@ -1,6 +1,3 @@
-
-
------------------------- >8 ------------------------
 Please enter above, the title and description for your changes.
 The first line is the title, and it's mandatory; lines between
 the second and the separator above, if present, are the description;

data/lib/geet/services/create_gist.rb

@@ -1,25 +1,35 @@
 # frozen_string_literal: true
 
 require_relative '../helpers/os_helper.rb'
+require_relative '../github/api_interface.rb'
+require_relative '../github/gist.rb'
 
 module Geet
   module Services
     class CreateGist
       include Geet::Helpers::OsHelper
 
+      API_TOKEN_KEY = 'GITHUB_API_TOKEN'
+      DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
+
+      def initialize
+        api_token = extract_env_api_token
+        @api_interface = Geet::Github::ApiInterface.new(api_token)
+      end
+
       # options:
       #   :description
       #   :publik:      defaults to false
       #   :no_browse    defaults to false
       #
-      def execute(repository, full_filename, description: nil, publik: false, no_browse: false, output: $stdout)
+      def execute(full_filename, description: nil, publik: false, no_browse: false, output: $stdout)
         content = IO.read(full_filename)
 
         gist_access = publik ? 'public' : 'private'
         output.puts "Creating a #{gist_access} gist..."
 
         filename = File.basename(full_filename)
-        gist = repository.create_gist(filename, content, description: description, publik: publik)
+        gist = Geet::Github::Gist.create(filename, content, @api_interface, description: description, publik: publik)
 
         if no_browse
           output.puts "Gist address: #{gist.link}"
@@ -27,6 +37,12 @@ module Geet
           open_file_with_default_application(gist.link)
         end
       end
+
+      private
+
+      def extract_env_api_token
+        ENV[API_TOKEN_KEY] || raise("#{API_TOKEN_KEY} not set!")
+      end
     end
   end
 end

data/lib/geet/services/create_issue.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'tmpdir'
 require_relative '../helpers/os_helper.rb'
 require_relative '../utils/manual_list_selection.rb'
 require_relative '../utils/pattern_matching_selection.rb'
@@ -11,6 +12,12 @@ module Geet
 
       MANUAL_LIST_SELECTION_FLAG = '-'.freeze
 
+      SUMMARY_BACKUP_FILENAME = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
+
+      def initialize(repository)
+        @repository = repository
+      end
+
       # options:
       #   :label_patterns
       #   :milestone_pattern:     number or description pattern.
@@ -18,21 +25,21 @@ module Geet
       #   :no_open_issue
       #
       def execute(
-          repository, title, description,
+          title, description,
           label_patterns: nil, milestone_pattern: nil, assignee_patterns: nil, no_open_issue: nil,
           output: $stdout, **
       )
         all_labels, all_milestones, all_collaborators = find_all_attribute_entries(
-          repository, label_patterns, milestone_pattern, assignee_patterns, output
+          label_patterns, milestone_pattern, assignee_patterns, output
         )
 
         labels = select_entries('label', all_labels, label_patterns, :multiple, :name) if label_patterns
         milestone, _ = select_entries('milestone', all_milestones, milestone_pattern, :single, :title) if milestone_pattern
-        assignees = select_entries('collaborator', all_collaborators, assignee_patterns, :multiple, nil) if assignee_patterns
+        assignees = select_entries('assignee', all_collaborators, assignee_patterns, :multiple, nil) if assignee_patterns
 
-        issue = create_issue(repository, title, description, output)
+        issue = create_issue(title, description, output)
 
-        edit_issue(repository, issue, labels, milestone, assignees, output)
+        edit_issue(issue, labels, milestone, assignees, output)
 
         if no_open_issue
           output.puts "Issue address: #{issue.link}"
@@ -41,54 +48,64 @@ module Geet
         end
 
         issue
+      rescue => error
+        save_summary(title, description, output) if title
+        raise
       end
 
       private
 
       # Internal actions
 
-      def find_all_attribute_entries(repository, label_patterns, milestone_pattern, assignee_patterns, output)
+      def find_all_attribute_entries(label_patterns, milestone_pattern, assignee_patterns, output)
         if label_patterns
           output.puts 'Finding labels...'
-          labels_thread = Thread.new { repository.labels }
+          labels_thread = Thread.new { @repository.labels }
         end
 
         if milestone_pattern
           output.puts 'Finding milestone...'
-          milestone_thread = Thread.new { repository.milestones }
+          milestone_thread = Thread.new { @repository.milestones }
         end
 
         if assignee_patterns
           output.puts 'Finding collaborators...'
-          reviewers_thread = Thread.new { repository.collaborators }
+          assignees_thread = Thread.new { @repository.collaborators }
         end
 
         labels = labels_thread&.value
         milestones = milestone_thread&.value
-        reviewers = reviewers_thread&.value
+        assignees = assignees_thread&.value
 
-        [labels, milestones, reviewers]
+        raise "No labels found!" if label_patterns && labels.empty?
+        raise "No milestones found!" if milestone_pattern && milestones.empty?
+        raise "No collaborators found!" if assignee_patterns && assignees.empty?
+
+        [labels, milestones, assignees]
       end
 
-      def create_issue(repository, title, description, output)
+      def create_issue(title, description, output)
         output.puts 'Creating the issue...'
 
-        issue = repository.create_issue(title, description)
+        issue = @repository.create_issue(title, description)
       end
 
-      def edit_issue(repository, issue, labels, milestone, assignees, output)
-        add_labels_thread = add_labels(issue, labels, output) if labels
+      def edit_issue(issue, labels, milestone, assignees, output)
+        # labels can be nil (parameter not passed) or empty array (parameter passed, but nothing
+        # selected)
+        add_labels_thread = add_labels(issue, labels, output) if labels && !labels.empty?
         set_milestone_thread = set_milestone(issue, milestone, output) if milestone
 
+        # same considerations as above, but with additional upstream case.
         if assignees
-          assign_users_thread = assign_users(issue, assignees, output)
-        else
-          assign_users_thread = assign_authenticated_user(repository, issue, output)
+          assign_users_thread = assign_users(issue, assignees, output) if !assignees.empty?
+        elsif !@repository.upstream?
+          assign_users_thread = assign_authenticated_user(issue, output)
         end
 
         add_labels_thread&.join
         set_milestone_thread&.join
-        assign_users_thread.join
+        assign_users_thread&.join
       end
 
       def add_labels(issue, selected_labels, output)
@@ -117,14 +134,22 @@ module Geet
         end
       end
 
-      def assign_authenticated_user(repository, issue, output)
+      def assign_authenticated_user(issue, output)
         output.puts 'Assigning authenticated user...'
 
         Thread.new do
-          issue.assign_users(repository.authenticated_user)
+          issue.assign_users(@repository.authenticated_user)
         end
       end
 
+      def save_summary(title, description, output)
+        summary = "#{title}\n\n#{description}".strip + "\n"
+
+        IO.write(SUMMARY_BACKUP_FILENAME, summary)
+
+        output.puts "Error! Saved summary to #{SUMMARY_BACKUP_FILENAME}"
+      end
+
       # Generic helpers
 
       def select_entries(entry_type, entries, raw_patterns, selection_type, instance_method)

data/lib/geet/services/create_label.rb

@@ -3,8 +3,12 @@
 module Geet
   module Services
     class CreateLabel
-      def execute(repository, name, color: generate_random_color, output: $stdout)
-        label = create_label(repository, name, color, output)
+      def initialize(repository)
+        @repository = repository
+      end
+
+      def execute(name, color: generate_random_color, output: $stdout)
+        label = create_label(name, color, output)
 
         output.puts "Created with color ##{label.color}"
 
@@ -13,10 +17,10 @@ module Geet
 
       private
 
-      def create_label(repository, name, color, output)
+      def create_label(name, color, output)
         output.puts 'Creating label...'
 
-        repository.create_label(name, color)
+        @repository.create_label(name, color)
       end
 
       # Return a 6-digits hex random color.

data/lib/geet/services/create_pr.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'tmpdir'
 require_relative '../helpers/os_helper.rb'
 require_relative '../utils/manual_list_selection.rb'
 require_relative '../utils/pattern_matching_selection.rb'
@@ -9,28 +10,41 @@ module Geet
     class CreatePr
       include Geet::Helpers::OsHelper
 
+      DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
+
       MANUAL_LIST_SELECTION_FLAG = '-'.freeze
 
+      SUMMARY_BACKUP_FILENAME = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
+
+      def initialize(repository, git_client: DEFAULT_GIT_CLIENT)
+        @repository = repository
+        @git_client = git_client
+      end
+
       # options:
       #   :label_patterns
       #   :reviewer_patterns
       #   :no_open_pr
       #
       def execute(
-        repository, title, description, label_patterns: nil, milestone_pattern: nil, reviewer_patterns: nil,
-        no_open_pr: nil, output: $stdout, **
+        title, description, label_patterns: nil, milestone_pattern: nil, reviewer_patterns: nil,
+        no_open_pr: nil, automated_mode: false, output: $stdout, **
       )
+        ensure_clean_tree if automated_mode
+
         all_labels, all_milestones, all_collaborators = find_all_attribute_entries(
-          repository, label_patterns, milestone_pattern, reviewer_patterns, output
+          label_patterns, milestone_pattern, reviewer_patterns, output
         )
 
         labels = select_entries('label', all_labels, label_patterns, :multiple, :name) if label_patterns
         milestone, _ = select_entries('milestone', all_milestones, milestone_pattern, :single, :title) if milestone_pattern
-        reviewers = select_entries('collaborator', all_collaborators, reviewer_patterns, :multiple, nil) if reviewer_patterns
+        reviewers = select_entries('reviewer', all_collaborators, reviewer_patterns, :multiple, nil) if reviewer_patterns
 
-        pr = create_pr(repository, title, description, output)
+        sync_with_upstream_branch(output) if automated_mode
 
-        edit_pr(repository, pr, labels, milestone, reviewers, output)
+        pr = create_pr(title, description, output)
+
+        edit_pr(pr, labels, milestone, reviewers, output)
 
         if no_open_pr
           output.puts "PR address: #{pr.link}"
@@ -39,47 +53,74 @@ module Geet
         end
 
         pr
+      rescue => error
+        save_summary(title, description, output) if title
+        raise
       end
 
       private
 
       # Internal actions
 
-      def find_all_attribute_entries(repository,label_patterns, milestone_pattern, reviewer_patterns, output)
+      def ensure_clean_tree
+        raise 'The working tree is not clean!' if !@git_client.working_tree_clean?
+      end
+
+      def find_all_attribute_entries(label_patterns, milestone_pattern, reviewer_patterns, output)
         if label_patterns
           output.puts 'Finding labels...'
-          labels_thread = Thread.new { repository.labels }
+          labels_thread = Thread.new { @repository.labels }
         end
 
         if milestone_pattern
           output.puts 'Finding milestone...'
-          milestone_thread = Thread.new { repository.milestones }
+          milestone_thread = Thread.new { @repository.milestones }
         end
 
         if reviewer_patterns
           output.puts 'Finding collaborators...'
-          reviewers_thread = Thread.new { repository.collaborators }
+          reviewers_thread = Thread.new { @repository.collaborators }
         end
 
         labels = labels_thread&.value
         milestones = milestone_thread&.value
         reviewers = reviewers_thread&.value
 
+        raise "No labels found!" if label_patterns && labels.empty?
+        raise "No milestones found!" if milestone_pattern && milestones.empty?
+        raise "No collaborators found!" if reviewer_patterns && reviewers.empty?
+
         [labels, milestones, reviewers]
       end
 
-      def create_pr(repository, title, description, output)
+      def sync_with_upstream_branch(output)
+        if @git_client.upstream_branch
+          output.puts "Pushing to upstream branch..."
+
+          @git_client.push
+        else
+          upstream_branch = @git_client.current_branch
+
+          output.puts "Creating upstream branch #{upstream_branch.inspect}..."
+
+          @git_client.push(upstream_branch: upstream_branch)
+        end
+      end
+
+      def create_pr(title, description, output)
         output.puts 'Creating PR...'
 
-        repository.create_pr(title, description, repository.current_branch)
+        @repository.create_pr(title, description, @git_client.current_branch)
       end
 
-      def edit_pr(repository, pr, labels, milestone, reviewers, output)
-        assign_user_thread = assign_authenticated_user(pr, repository, output)
+      def edit_pr(pr, labels, milestone, reviewers, output)
+        assign_user_thread = assign_authenticated_user(pr, output)
 
-        add_labels_thread = add_labels(pr, labels, output) if labels
+        # labels/reviewers can be nil (parameter not passed) or empty array (parameter passed, but
+        # nothing selected)
+        add_labels_thread = add_labels(pr, labels, output) if labels && !labels.empty?
         set_milestone_thread = set_milestone(pr, milestone, output) if milestone
-        request_review_thread = request_review(pr, reviewers, output) if reviewers
+        request_review_thread = request_review(pr, reviewers, output) if reviewers && !reviewers.empty?
 
         assign_user_thread.join
         add_labels_thread&.join
@@ -87,11 +128,11 @@ module Geet
         request_review_thread&.join
       end
 
-      def assign_authenticated_user(pr, repository, output)
+      def assign_authenticated_user(pr, output)
         output.puts 'Assigning authenticated user...'
 
         Thread.new do
-          pr.assign_users(repository.authenticated_user)
+          pr.assign_users(@repository.authenticated_user)
         end
       end
 
@@ -121,6 +162,14 @@ module Geet
         end
       end
 
+      def save_summary(title, description, output)
+        summary = "#{title}\n\n#{description}".strip + "\n"
+
+        IO.write(SUMMARY_BACKUP_FILENAME, summary)
+
+        output.puts "Error! Saved summary to #{SUMMARY_BACKUP_FILENAME}"
+      end
+
       # Generic helpers
 
       def select_entries(entry_type, entries, raw_patterns, selection_type, instance_method)