geet 0.3.1 → 0.3.2

data/lib/geet/utils/attributes_selection_manager.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'manual_list_selection'
+require_relative 'string_matching_selection'
+require_relative '../shared/constants'
+
+module Geet
+  module Utils
+    # Manages the retrieval and selection of attributes.
+    #
+    # Selecting an attribute happens in two steps: retrieval and selection.
+    #
+    # With this structure, the retrieval happens in parallel, cutting the time considerably when
+    # multiple attributes are required (typically, three).
+    #
+    class AttributesSelectionManager
+      include Geet::Shared::Constants
+
+      # Initialize the instance, and starts the background threads.
+      #
+      def initialize(repository, out: output)
+        @repository = repository
+        @out = out
+        @selections_data = []
+      end
+
+      def add_attribute(repository_call, description, pattern, selection_type, name_method: nil, &pre_selection_hook)
+        raise "Unrecognized selection type #{selection_type.inspect}" if ![:single, :multiple].include?(selection_type)
+
+        finder_thread = find_attribute_entries(repository_call)
+
+        @selections_data << [finder_thread, description, pattern, selection_type, name_method, pre_selection_hook]
+      end
+
+      # Select and return the attributes, in the same order they've been added.
+      #
+      def select_attributes
+        @selections_data.map do |finder_thread, description, pattern, selection_type, name_method, pre_selection_hook|
+          entries = finder_thread.value
+
+          entries = pre_selection_hook.(entries) if pre_selection_hook
+
+          case selection_type
+          when :single
+            select_entry(description, entries, pattern, name_method)
+          when :multiple
+            select_entries(description, entries, pattern, name_method)
+          end
+        end
+      end
+
+      private
+
+      def find_attribute_entries(repository_call)
+        @out.puts "Finding #{repository_call}..."
+
+        Thread.new do
+          @repository.send(repository_call)
+        end
+      end
+
+      # Sample call:
+      #
+      #   select_entry('milestone', all_milestones, '0.1.0', :title)
+      #
+      def select_entry(entry_type, entries, pattern, name_method)
+        if pattern == MANUAL_LIST_SELECTION_FLAG
+          Geet::Utils::ManualListSelection.new.select_entry(entry_type, entries, name_method: name_method)
+        else
+          Geet::Utils::StringMatchingSelection.new.select_entry(entry_type, entries, pattern, name_method: name_method)
+        end
+      end
+
+      # Sample call:
+      #
+      #   select_entries('reviewer', all_collaborators, 'donaldduck', nil)
+      #
+      def select_entries(entry_type, entries, pattern, name_method)
+        if pattern == MANUAL_LIST_SELECTION_FLAG
+          Geet::Utils::ManualListSelection.new.select_entries(entry_type, entries, name_method: name_method)
+        else
+          Geet::Utils::StringMatchingSelection.new.select_entries(entry_type, entries, pattern, name_method: name_method)
+        end
+      end
+    end
+  end
+end

data/lib/geet/utils/manual_list_selection.rb

@@ -9,56 +9,70 @@ module Geet
 
       PAGER_SIZE = 16
 
+      # Shows a prompt for selecting an entry from a list.
+      #
+      # Returns nil, without showing the prompt, if there are no entries.
+      #
       # entry_type:      description of the entries type.
-      # entries:         array of objects; if they're not strings, must also pass :instance_method.
+      # entries:         array of objects; if they're not strings, must also pass :name_method.
       #                  this value must not be empty.
-      # selection_type:  :single or :multiple
-      # instance_method: required when non-string objects are passed as entries; its invocation on
+      # name_method:     required when non-string objects are passed as entries; its invocation on
       #                  each object must return a string, which is used as key.
       #
-      # returns: the selected entry or array of entries. for single selection, if no entries are
-      #          chosen, nil is returned.
+      # returns: the selected entry. if no entries are nil is returned.
+      #
+      def select_entry(entry_type, entries, name_method: nil)
+        return nil if entries.empty?
+
+        check_entries(entries, entry_type)
+
+        entries = create_entries_map(entries, name_method)
+        entries = add_no_selection_entry(entries)
+
+        show_prompt(:select, entry_type, entries)
+      end
+
+      # Shows a prompt for selecting an entry from a list.
+      #
+      # Returns an empty array, without showing the prompt, if there are no entries.
+      #
+      # See #select_entry for the parameters.
       #
-      def select(entry_type, entries, selection_type, instance_method: nil)
-        check_entries(entries)
+      # returns: array of entries.
+      #
+      def select_entries(entry_type, entries, name_method: nil)
+        return [] if entries.empty?
 
-        entries = create_entries_map(entries, instance_method)
+        check_entries(entries, entry_type)
 
-        result = show_prompt(entry_type, selection_type, entries)
+        entries = create_entries_map(entries, name_method)
 
-        result
+        show_prompt(:multi_select, entry_type, entries)
       end
 
       private
 
-      def check_entries(entries)
+      def check_entries(entries, entry_type)
         raise "No #{entry_type} provided!" if entries.empty?
       end
 
-      def create_entries_map(entries, instance_method)
+      def create_entries_map(entries, name_method)
         entries.each_with_object({}) do |entry, current_map|
-          key = instance_method ? entry.send(instance_method) : entry
+          key = name_method ? entry.send(name_method) : entry
           current_map[key] = entry
         end
       end
 
-      def show_prompt(entry_type, selection_type, entries)
-        prompt_title = "Please select the #{entry_type}(s):"
-
-        case selection_type
-        when :single
-          entries = add_no_selection_entry(entries)
-          TTY::Prompt.new.select(prompt_title, entries, filter: true, per_page: PAGER_SIZE)
-        when :multiple
-          TTY::Prompt.new.multi_select(prompt_title, entries, filter: true, per_page: PAGER_SIZE)
-        else
-          raise "Unexpected selection type: #{selection_type.inspect}"
-        end
-      end
-
       def add_no_selection_entry(entries)
         {NO_SELECTION_KEY => nil}.merge(entries)
       end
+
+      def show_prompt(invocation_method, entry_type, entries)
+        # Arguably inexact phrasing for avoiding language complexities.
+        prompt_title = "Please select the #{entry_type}(s):"
+
+        TTY::Prompt.new.send(invocation_method, prompt_title, entries, filter: true, per_page: PAGER_SIZE)
+      end
     end
   end
 end

data/lib/geet/utils/string_matching_selection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Geet
+  module Utils
+    class StringMatchingSelection
+      def select_entry(entry_type, entries, pattern, name_method: nil)
+        entries_found = entries.select do |entry|
+          entry = entry.send(name_method) if name_method
+          entry.downcase == pattern.downcase
+        end
+
+        case entries_found.size
+        when 1
+          entries_found.first
+        when 0
+          raise "No entry found for #{entry_type} pattern: #{pattern.inspect}"
+        else
+          raise "Multiple entries found for #{entry_type} pattern #{pattern.inspect}: #{entries_found}"
+        end
+      end
+
+      def select_entries(entry_type, entries, raw_patterns, name_method: nil)
+        patterns = raw_patterns.split(',')
+
+        patterns.map do |pattern|
+          # Haha.
+          select_entry(entry_type, entries, pattern, name_method: name_method)
+        end
+      end
+    end
+  end
+end

data/lib/geet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geet
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/integration/create_gist_spec.rb

@@ -18,8 +18,8 @@ describe Geet::Services::CreateGist do
     actual_output = StringIO.new
 
     VCR.use_cassette('create_gist_public') do
-      described_class.new.execute(
-        tempfile.path, description: 'testdescription', publik: true, no_browse: true, output: actual_output
+      described_class.new(out: actual_output).execute(
+        tempfile.path, description: 'testdescription', publik: true, no_browse: true
       )
     end
 
@@ -35,8 +35,8 @@ describe Geet::Services::CreateGist do
     actual_output = StringIO.new
 
     VCR.use_cassette('create_gist_private') do
-      described_class.new.execute(
-        tempfile.path, description: 'testdescription', no_browse: true, output: actual_output
+      described_class.new(out: actual_output).execute(
+        tempfile.path, description: 'testdescription', no_browse: true
       )
     end
 

data/spec/integration/create_issue_spec.rb

@@ -16,7 +16,7 @@ describe Geet::Services::CreateIssue do
 
       expected_output = <<~STR
         Finding labels...
-        Finding milestone...
+        Finding milestones...
         Finding collaborators...
         Creating the issue...
         Adding labels bug, invalid...
@@ -28,10 +28,10 @@ describe Geet::Services::CreateIssue do
       actual_output = StringIO.new
 
       actual_created_issue = VCR.use_cassette('create_issue') do
-        described_class.new(repository).execute(
+        described_class.new(repository, out: actual_output).execute(
           'Title', 'Description',
-          label_patterns: 'bug,invalid', milestone_pattern: '0.0.1', assignee_patterns: 'nald-ts,nald-fr',
-          no_open_issue: true, output: actual_output
+          labels: 'bug,invalid', milestone: '0.0.1', assignees: 'donald-ts,donald-fr',
+          no_open_issue: true
         )
       end
 
@@ -56,8 +56,8 @@ describe Geet::Services::CreateIssue do
     actual_output = StringIO.new
 
     actual_created_issue = VCR.use_cassette('create_issue_upstream') do
-      create_options = { no_open_issue: true, output: actual_output }
-      described_class.new(upstream_repository).execute('Title', 'Description', create_options)
+      create_options = { no_open_issue: true, out: actual_output }
+      described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', create_options)
     end
 
     expect(actual_output.string).to eql(expected_output)

data/spec/integration/create_label_spec.rb

@@ -22,7 +22,7 @@ describe Geet::Services::CreateLabel do
       actual_output = StringIO.new
 
       actual_created_label = VCR.use_cassette('create_label') do
-        described_class.new(repository).execute('my_label', color: 'c64c64', output: actual_output)
+        described_class.new(repository, out: actual_output).execute('my_label', color: 'c64c64')
       end
 
       expect(actual_output.string).to eql(expected_output)
@@ -44,7 +44,7 @@ describe Geet::Services::CreateLabel do
         actual_output = StringIO.new
 
         actual_created_label = VCR.use_cassette('create_label_upstream') do
-          described_class.new(upstream_repository).execute('my_label', color: 'c64c64', output: actual_output)
+          described_class.new(upstream_repository, out: actual_output).execute('my_label', color: 'c64c64')
         end
 
         expect(actual_output.string).to eql(expected_output)
@@ -67,7 +67,7 @@ describe Geet::Services::CreateLabel do
       actual_output = StringIO.new
 
       actual_created_label = VCR.use_cassette('create_label_with_random_color') do
-        described_class.new(repository).execute('my_label', output: actual_output)
+        described_class.new(repository, out: actual_output).execute('my_label')
       end
 
       expected_output = format(expected_output_template, color: actual_created_label.color)

data/spec/integration/create_pr_spec.rb

@@ -17,32 +17,32 @@ describe Geet::Services::CreatePr do
 
       expected_output = <<~STR
         Finding labels...
-        Finding milestone...
+        Finding milestones...
         Finding collaborators...
         Creating PR...
         Assigning authenticated user...
-        Adding labels other_bug, invalid...
-        Setting milestone 0.0.1...
-        Requesting review from donald-ts, donald-fr...
-        PR address: https://github.com/donaldduck/testrepo/pull/3
+        Adding labels bug, invalid...
+        Setting milestone milestone 1...
+        Requesting review from donald-fr...
+        PR address: https://github.com/donaldduck/testrepo/pull/39
       STR
 
       actual_output = StringIO.new
 
       actual_created_pr = VCR.use_cassette('create_pr') do
-        service_instance = described_class.new(repository, git_client: git_client)
+        service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
         service_instance.execute(
           'Title', 'Description',
-          label_patterns: '_bug,invalid', milestone_pattern: '0.0.1', reviewer_patterns: 'nald-ts,nald-fr',
+          labels: 'bug,invalid', milestone: 'milestone 1', reviewers: 'donald-fr',
           no_open_pr: true, output: actual_output
         )
       end
 
       expect(actual_output.string).to eql(expected_output)
 
-      expect(actual_created_pr.number).to eql(3)
+      expect(actual_created_pr.number).to eql(39)
       expect(actual_created_pr.title).to eql('Title')
-      expect(actual_created_pr.link).to eql('https://github.com/donaldduck/testrepo/pull/3')
+      expect(actual_created_pr.link).to eql('https://github.com/donaldduck/testrepo/pull/39')
     end
   end
 
@@ -60,7 +60,7 @@ describe Geet::Services::CreatePr do
     actual_output = StringIO.new
 
     actual_created_pr = VCR.use_cassette('create_pr_upstream') do
-      service_instance = described_class.new(upstream_repository, git_client: git_client)
+      service_instance = described_class.new(upstream_repository, out: actual_output, git_client: git_client)
       service_instance.execute('Title', 'Description', no_open_pr: true, output: actual_output)
     end
 
@@ -83,7 +83,7 @@ describe Geet::Services::CreatePr do
       actual_output = StringIO.new
 
       operation = -> do
-        service_instance = described_class.new(repository, git_client: git_client)
+        service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
         service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
       end
 
@@ -110,7 +110,7 @@ describe Geet::Services::CreatePr do
       actual_output = StringIO.new
 
       actual_created_pr = VCR.use_cassette('create_pr_in_auto_mode_with_push') do
-        service_instance = described_class.new(repository, git_client: git_client)
+        service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
         service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
       end
 
@@ -135,7 +135,7 @@ describe Geet::Services::CreatePr do
       actual_output = StringIO.new
 
       actual_created_pr = VCR.use_cassette('create_pr_in_auto_mode_create_upstream') do
-        service_instance = described_class.new(repository, git_client: git_client)
+        service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
         service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
       end
 

data/spec/integration/list_issues_spec.rb

@@ -23,7 +23,7 @@ describe Geet::Services::ListIssues do
       actual_output = StringIO.new
 
       service_result = VCR.use_cassette('github_com/list_issues') do
-        described_class.new(repository).execute(output: actual_output)
+        described_class.new(repository, out: actual_output).execute
       end
 
       actual_issue_numbers = service_result.map(&:number)
@@ -37,7 +37,7 @@ describe Geet::Services::ListIssues do
         allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_gh')
 
         expected_output = <<~STR
-          Finding assignee...
+          Finding collaborators...
           12. test issue 3 (https://github.com/donaldduck/testrepo_gh/issues/12)
           10. test issue 1 (https://github.com/donaldduck/testrepo_gh/issues/10)
         STR
@@ -46,7 +46,7 @@ describe Geet::Services::ListIssues do
         actual_output = StringIO.new
 
         service_result = VCR.use_cassette('github_com/list_issues_with_assignee') do
-          described_class.new(repository).execute(assignee_pattern: 'donald-fr', output: actual_output)
+          described_class.new(repository, out: actual_output).execute(assignee: 'donald-fr', )
         end
 
         actual_issue_numbers = service_result.map(&:number)
@@ -69,7 +69,7 @@ describe Geet::Services::ListIssues do
       actual_output = StringIO.new
 
       service_result = VCR.use_cassette('github_com/list_issues_upstream') do
-        described_class.new(upstream_repository).execute(output: actual_output)
+        described_class.new(upstream_repository, out: actual_output).execute
       end
 
       actual_issue_numbers = service_result.map(&:number)
@@ -92,7 +92,7 @@ describe Geet::Services::ListIssues do
       actual_output = StringIO.new
 
       service_result = VCR.use_cassette('gitlab_com/list_issues') do
-        described_class.new(repository).execute(output: actual_output)
+        described_class.new(repository, out: actual_output).execute
       end
 
       actual_issue_numbers = service_result.map(&:number)

data/spec/integration/list_labels_spec.rb

@@ -24,7 +24,7 @@ describe Geet::Services::ListLabels do
 
       actual_output = StringIO.new
       actual_labels = VCR.use_cassette('github.com/list_labels') do
-        described_class.new(repository).execute(output: actual_output)
+        described_class.new(repository, out: actual_output).execute
       end
 
       actual_label_names = actual_labels.map(&:name)
@@ -45,7 +45,7 @@ describe Geet::Services::ListLabels do
 
       actual_output = StringIO.new
       actual_labels = VCR.use_cassette('github.com/list_labels_upstream') do
-        described_class.new(upstream_repository).execute(output: actual_output)
+        described_class.new(upstream_repository, out: actual_output).execute
       end
 
       actual_label_names = actual_labels.map(&:name)
@@ -73,7 +73,7 @@ describe Geet::Services::ListLabels do
 
       actual_output = StringIO.new
       actual_labels = VCR.use_cassette('gitlab.com/list_labels') do
-        described_class.new(repository).execute(output: actual_output)
+        described_class.new(repository, out: actual_output).execute
       end
 
       actual_label_names = actual_labels.map(&:name)