geet 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a73b4ce8509349204e7abc8c667856acf8baa421
-  data.tar.gz: b94ef51efb18f859f7aa547cb718861a2ca03eeb
+  metadata.gz: e527c60073723a00c502f04f5546b599f708cb71
+  data.tar.gz: efd1663ae8d3673833302dff6a1ffaf14ff61f87
 SHA512:
-  metadata.gz: f07424e685a1265e5e083889c9ee627893f63bbcb56d268b2fe5cfabd2e475f98bade4c9eca5e67da4a84e53e6652c3dbecb05fd5f4b3acbc8fe05819b9250d5
-  data.tar.gz: acabfcbaa84a7e3f0423706ca3a84a95ce779f8bf6771a6b1b02a7920a54b3068922ec241c61ad275af12fd7b08469ffd78fb91e575ecc0d8e335278a4aac968
+  metadata.gz: b7f2f095998602114752cf4ce083384715ac6d22a9bfe6814dc783a4f92ba581907f1212ce787b1af5345a59f68d3989150cc89bcd595ae53b3e7170fb0409e7
+  data.tar.gz: 438049ec26fedbf656f2909b1b307f91901b5d91a1f9e90d23f6dc64817f10461c7c4319786963a0af8949d9f371aa00495883556ef46bc1b813caebaff2cf02

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    geet (0.3.0)
-      simple_scripting (~> 0.9.3)
+    geet (0.3.1)
+      simple_scripting (~> 0.9.4)
       temp-fork-tp-filter (= 0.0.3)
 
 GEM
@@ -52,7 +52,7 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
-    simple_scripting (0.9.3)
+    simple_scripting (0.9.4)
       parseconfig (~> 1.0)
     temp-fork-tp-filter (0.0.3)
       necromancer (~> 0.4.0)

data/README.md

@@ -47,38 +47,19 @@ The default editor will be used for title/description:
 
 ![Issue creation editing screenshot](/extra/issue_editing.png?raw=true)
 
-More advanced issue creation, with labels and assignees:
-
-    $ geet issue create --label-patterns bug,wip --assignee-patterns john
-
-patterns are partial matches, so, for example, `johncarmack` will be matched as assignee in the first case.
-
-After creation, the issue page will be automatically opened in the default browser.
-
-### Using menus for options selection
-
-Geet supports selecting options (labels, collaborators, etc.), using the `-` parameter:
-
-    $ geet issue create --label-patterns -
-
-This will show a menu like the following:
+Labels, milestone and assignees will be asked with menu selection:
 
     Please select the label(s): (Use arrow keys, press Space to select and Enter to finish, and alphanumeric/underscore characters to filter)
     ‣ ⬡ bug
       ⬡ enhancement
       ⬡ not_an_issue
       ⬡ requires_design
-      ⬡ technical_debt
-      ⬡ top_priority
-      ⬡ ux
 
-Typing alphanumeric keys and underscore will enable filtering:
+Labels, milestone and assignees can be directly specified with the respective parameters:
 
-    Please select the label(s): (Filter: "b")
-    ‣ ⬡ bug
-      ⬡ technical_debt
+    $ geet issue create --labels bug,wip --assignees johncarmark --milestone 1.0
 
-When a filter is active, use `Backspace` to cancel the last character, and `Canc` to reset it.
+After creation, the issue page will be automatically opened in the default browser.
 
 ### Create a PR (with label, reviewers, and assigned to self)
 
@@ -92,7 +73,7 @@ The default editor will be used for title/description:
 
 More advanced PR creation, with label and reviewers, assigned to self:
 
-    $ geet pr create --label-patterns "code review" --reviewer-patterns kevin,tom,adrian
+    $ geet pr create --labels "code review" --reviewers kevin,tom,adrian
 
 After creation, the issue page will be automatically opened in the default browser.
 
@@ -143,6 +124,26 @@ Create a public gist, with description:
 
     $ geet gist create --public /path/to/myfile 'Gist description'
 
+### Using menus for options selection
+
+Menus can be used for selecting attributes (labels, collaborators, milestones...).
+
+This is an example of multiple choice selection:
+
+    Please select the label(s): (Use arrow keys, press Space to select and Enter to finish, and alphanumeric/underscore characters to filter)
+    ‣ ⬡ bug
+      ⬡ enhancement
+      ⬡ not_an_issue
+      ⬡ requires_design
+
+Typing alphanumeric keys and underscore will enable filtering:
+
+    Please select the label(s): (Filter: "b")
+    ‣ ⬡ bug
+      ⬡ technical_debt
+
+When a filter is active, use `Backspace` to cancel the last character, and `Canc` to reset it.
+
 ### Help
 
 Display the help:

data/bin/geet

@@ -1,11 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'simple_scripting/configuration'
 require_relative '../lib/geet/commandline/configuration.rb'
 require_relative '../lib/geet/commandline/commands.rb'
 require_relative '../lib/geet/commandline/editor.rb'
 require_relative '../lib/geet/git/repository.rb'
 require_relative '../lib/geet/helpers/summary_helper.rb'
+require_relative '../lib/geet/shared/constants.rb'
 require_relative '../lib/geet/utils/git_client.rb'
 Dir[File.join(__dir__, '../lib/geet/services/*.rb')].each { |filename| require filename }
 
@@ -19,7 +21,7 @@ class GeetLauncher
   def launch
     command, options = Commandline::Configuration.new.decode_argv || exit
 
-    repository = Git::Repository.new(upstream: !!options[:upstream])
+    repository = Git::Repository.new(upstream: !!options[:upstream], protected_repositories: protected_repositories)
 
     case command
     when GIST_CREATE_COMMAND
@@ -31,7 +33,7 @@ class GeetLauncher
       summary = options[:summary] || Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
       title, description = split_summary(summary)
 
-      options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
+      options = default_to_manual_selection(options, :labels, :milestone, :assignees)
 
       Services::CreateIssue.new(repository).execute(title, description, options)
     when LABEL_CREATE_COMMAND
@@ -39,6 +41,8 @@ class GeetLauncher
 
       Services::CreateLabel.new(repository).execute(name, options)
     when ISSUE_LIST_COMMAND
+      options = default_to_manual_selection(options, :assignee)
+
       Services::ListIssues.new(repository).execute(options)
     when LABEL_LIST_COMMAND
       Services::ListLabels.new(repository).execute
@@ -48,7 +52,7 @@ class GeetLauncher
       summary = options[:summary] || edit_pr_summary
       title, description = split_summary(summary)
 
-      options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
+      options = default_to_manual_selection(options, :labels, :milestone, :reviewers)
 
       Services::CreatePr.new(repository).execute(title, description, options)
     when PR_LIST_COMMAND
@@ -77,6 +81,20 @@ class GeetLauncher
       Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
     end
   end
+
+  def default_to_manual_selection(options, *params)
+    params.each do |param|
+      options[param] ||= Shared::Constants::MANUAL_LIST_SELECTION_FLAG
+    end
+
+    options
+  end
+
+  def protected_repositories
+    configuration = SimpleScripting::Configuration.load
+
+    configuration.protected_repositories.to_s.split(':')
+  end
 end
 
 GeetLauncher.new.launch if $PROGRAM_NAME == __FILE__

data/geet.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2018-01-25'
+  s.date        = '2018-01-28'
   s.email       = ['saverio.pub2@gmail.com']
   s.homepage    = 'https://github.com/saveriomiroddi/geet'
   s.summary     = 'Commandline interface for performing SCM (eg. GitHub) operations (eg. PR creation).'
   s.description = 'Commandline interface for performing SCM (eg. GitHub) operations (eg. PR creation).'
   s.license     = 'GPL-3.0'
 
-  s.add_runtime_dependency 'simple_scripting', '~> 0.9.3'
+  s.add_runtime_dependency 'simple_scripting', '~> 0.9.4'
   s.add_runtime_dependency 'temp-fork-tp-filter', '= 0.0.3'
 
   s.add_development_dependency 'rake', '~> 12.3.0'

data/lib/geet/commandline/configuration.rb

@@ -22,9 +22,9 @@ module Geet
       # rubocop:disable Style/MutableConstant
       ISSUE_CREATE_OPTIONS = [
         ['-n', '--no-open-issue',                           "Don't open the issue link in the browser after creation"],
-        ['-l', '--label-patterns "bug,help wanted"',        'Label patterns'],
+        ['-l', '--labels "bug,help wanted"',                'Labels'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
-        ['-a', '--assignee-patterns john,tom,adrian,kevin', 'Assignee login patterns'],
+        ['-a', '--assignees john,tom,adrian,kevin',         'Assignee logins'],
         ['-s', '--summary title_and_description',           'Set the summary (title and optionally description'],
         ['-u', '--upstream',                                'Create on the upstream repository'],
         long_help: 'The default editor will be opened for editing title and description.'
@@ -37,7 +37,7 @@ module Geet
       ].freeze
 
       ISSUE_LIST_OPTIONS = [
-        ['-a', '--assignee-pattern john',                   'Assignee pattern'],
+        ['-a', '--assignee john',                           'Assignee login'],
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
@@ -52,9 +52,9 @@ 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"],
-        ['-l', '--label-patterns "legacy,code review"',     'Label patterns'],
+        ['-l', '--labels "legacy,code review"',             'Labels'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
-        ['-r', '--reviewer-patterns john,tom,adrian,kevin', 'Reviewer login patterns'],
+        ['-r', '--reviewers john,tom,adrian,kevin',         'Reviewer logins'],
         ['-s', '--summary title_and_description',           'Set the summary (title and optionally description'],
         ['-u', '--upstream',                                'Create on the upstream repository'],
         long_help: <<~STR

data/lib/geet/git/repository.rb

@@ -8,18 +8,26 @@ module Geet
     # This class represents, for convenience, both the local and the remote repository, but the
     # remote code is separated in each provider module.
     class Repository
-      CONFIRM_ACTION_TEXT = <<~STR
-        WARNING! The action will be performed on a fork, but an upstream repository has been found!
-        Press Enter to continue, or Ctrl+C to exit now.
+      LOCAL_ACTION_ON_UPSTREAM_REPOSITORY_MESSAGE = <<~STR
+        The action will be performed on a fork, but an upstream repository has been found!
+      STR
+
+      ACTION_ON_PROTECTED_REPOSITORY_MESSAGE = <<~STR
+        This action will be performed on a protected repository!
       STR
 
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
-      def initialize(upstream: false, git_client: DEFAULT_GIT_CLIENT, warnings: true)
+      # warnings:               disable all the warnings.
+      # protected_repositories: warn when creating an issue/pr on this repositories (entry format:
+      #                         `owner/repo`).
+      #
+      def initialize(upstream: false, git_client: DEFAULT_GIT_CLIENT, warnings: true, protected_repositories: [])
         @upstream = upstream
         @git_client = git_client
         @api_token = extract_env_api_token
         @warnings = warnings
+        @protected_repositories = protected_repositories
       end
 
       # REMOTE FUNCTIONALITIES (REPOSITORY)
@@ -33,7 +41,9 @@ module Geet
       end
 
       def create_issue(title, description)
-        ask_confirm_action if local_action_with_upstream_repository? && @warnings
+        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(:Issue, :create, title, description, api_interface)
       end
 
@@ -62,7 +72,9 @@ module Geet
       end
 
       def create_pr(title, description, head)
-        ask_confirm_action if local_action_with_upstream_repository? && @warnings
+        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)
       end
 
@@ -87,7 +99,6 @@ module Geet
       # PROVIDER
 
       def extract_env_api_token
-        provider_name = @git_client.provider_domain[/(.*)\.\w+/, 1]
         env_variable_name = "#{provider_name.upcase}_API_TOKEN"
 
         ENV[env_variable_name] || raise("#{env_variable_name} not set!")
@@ -121,22 +132,30 @@ module Geet
         Dir[files_pattern].each { |filename| require filename }
       end
 
-      # OTHER HELPERS
+      # WARNINGS
 
-      def api_interface
-        path = @git_client.path(upstream: @upstream)
-        attempt_provider_call(:ApiInterface, :new, @api_token, repo_path: path, upstream: @upstream)
+      def confirm(message)
+        full_message = "WARNING! #{message.strip}\nPress Enter to continue, or Ctrl+C to exit now."
+        print full_message
+        gets
       end
 
-      def ask_confirm_action
-        print CONFIRM_ACTION_TEXT.rstrip
-        gets
+      def action_on_protected_repository?
+        path = @git_client.path(upstream: @upstream)
+        @protected_repositories.include?(path)
       end
 
-      def local_action_with_upstream_repository?
+      def local_action_on_upstream_repository?
         @git_client.remote_defined?('upstream') && !@upstream
       end
 
+      # OTHER HELPERS
+
+      def api_interface
+        path = @git_client.path(upstream: @upstream)
+        attempt_provider_call(:ApiInterface, :new, @api_token, repo_path: path, upstream: @upstream)
+      end
+
       # Bare downcase provider name, eg. `github`
       #
       def provider_name

data/lib/geet/services/abstract_create_issue.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+require_relative '../helpers/os_helper'
+require_relative '../utils/attributes_selection_manager'
+require_relative '../utils/manual_list_selection'
+require_relative '../utils/string_matching_selection'
+
+module Geet
+  module Services
+    class AbstractCreateIssue
+      include Geet::Helpers::OsHelper
+
+      SUMMARY_BACKUP_FILENAME = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
+
+      def initialize(repository, out: $stdout)
+        @repository = repository
+        @out = out
+      end
+
+      private
+
+      def save_summary(title, description)
+        summary = "#{title}\n\n#{description}".strip + "\n"
+
+        IO.write(SUMMARY_BACKUP_FILENAME, summary)
+
+        @out.puts "Error! Saved summary to #{SUMMARY_BACKUP_FILENAME}"
+      end
+    end
+  end
+end

data/lib/geet/services/create_gist.rb

@@ -12,7 +12,9 @@ module Geet
       API_TOKEN_KEY = 'GITHUB_API_TOKEN'
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
-      def initialize
+      def initialize(out: $stdout)
+        @out = out
+
         api_token = extract_env_api_token
         @api_interface = Geet::Github::ApiInterface.new(api_token)
       end
@@ -22,17 +24,17 @@ module Geet
       #   :publik:      defaults to false
       #   :no_browse    defaults to false
       #
-      def execute(full_filename, description: nil, publik: false, no_browse: false, output: $stdout)
+      def execute(full_filename, description: nil, publik: false, no_browse: false)
         content = IO.read(full_filename)
 
         gist_access = publik ? 'public' : 'private'
-        output.puts "Creating a #{gist_access} gist..."
+        @out.puts "Creating a #{gist_access} gist..."
 
         filename = File.basename(full_filename)
         gist = Geet::Github::Gist.create(filename, content, @api_interface, description: description, publik: publik)
 
         if no_browse
-          output.puts "Gist address: #{gist.link}"
+          @out.puts "Gist address: #{gist.link}"
         else
           open_file_with_default_application(gist.link)
         end

data/lib/geet/services/create_issue.rb

@@ -1,55 +1,36 @@
 # 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'
+require_relative 'abstract_create_issue'
 
 module Geet
   module Services
-    class CreateIssue
-      include Geet::Helpers::OsHelper
-
-      MANUAL_LIST_SELECTION_FLAG = '-'.freeze
-
-      SUMMARY_BACKUP_FILENAME = File.join(Dir.tmpdir, 'last_geet_edited_summary.md')
-
-      def initialize(repository)
-        @repository = repository
-      end
-
+    class CreateIssue < AbstractCreateIssue
       # options:
-      #   :label_patterns
-      #   :milestone_pattern:     number or description pattern.
-      #   :assignee_patterns
+      #   :labels
+      #   :milestone:     number or description pattern.
+      #   :assignees
       #   :no_open_issue
       #
       def execute(
           title, description,
-          label_patterns: nil, milestone_pattern: nil, assignee_patterns: nil, no_open_issue: nil,
-          output: $stdout, **
+          labels: nil, milestone: nil, assignees: nil, no_open_issue: nil,
+          **
       )
-        all_labels, all_milestones, all_collaborators = find_all_attribute_entries(
-          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('assignee', all_collaborators, assignee_patterns, :multiple, nil) if assignee_patterns
+        selected_labels, selected_milestone, selected_assignees = find_and_select_attributes(labels, milestone, assignees)
 
-        issue = create_issue(title, description, output)
+        issue = create_issue(title, description)
 
-        edit_issue(issue, labels, milestone, assignees, output)
+        edit_issue(issue, selected_labels, selected_milestone, selected_assignees)
 
         if no_open_issue
-          output.puts "Issue address: #{issue.link}"
+          @out.puts "Issue address: #{issue.link}"
         else
           open_file_with_default_application(issue.link)
         end
 
         issue
       rescue => error
-        save_summary(title, description, output) if title
+        save_summary(title, description) if title
         raise
       end
 
@@ -57,50 +38,33 @@ module Geet
 
       # Internal actions
 
-      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 }
-        end
-
-        if milestone_pattern
-          output.puts 'Finding milestone...'
-          milestone_thread = Thread.new { @repository.milestones }
-        end
-
-        if assignee_patterns
-          output.puts 'Finding collaborators...'
-          assignees_thread = Thread.new { @repository.collaborators }
-        end
+      def find_and_select_attributes(labels, milestone, assignees)
+        selection_manager = Geet::Utils::AttributesSelectionManager.new(@repository, out: @out)
 
-        labels = labels_thread&.value
-        milestones = milestone_thread&.value
-        assignees = assignees_thread&.value
+        selection_manager.add_attribute(:labels, 'label', labels, :multiple, name_method: :name) if labels
+        selection_manager.add_attribute(:milestones, 'milestone', milestone, :single, name_method: :title) if milestone
+        selection_manager.add_attribute(:collaborators, 'assignee', assignees, :multiple) if assignees
 
-        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]
+        selection_manager.select_attributes
       end
 
-      def create_issue(title, description, output)
-        output.puts 'Creating the issue...'
+      def create_issue(title, description)
+        @out.puts 'Creating the issue...'
 
         issue = @repository.create_issue(title, description)
       end
 
-      def edit_issue(issue, labels, milestone, assignees, output)
+      def edit_issue(issue, labels, milestone, assignees)
         # 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
+        add_labels_thread = add_labels(issue, labels) if labels && !labels.empty?
+        set_milestone_thread = set_milestone(issue, milestone) if milestone
 
         # same considerations as above, but with additional upstream case.
         if assignees
-          assign_users_thread = assign_users(issue, assignees, output) if !assignees.empty?
+          assign_users_thread = assign_users(issue, assignees) if !assignees.empty?
         elsif !@repository.upstream?
-          assign_users_thread = assign_authenticated_user(issue, output)
+          assign_users_thread = assign_authenticated_user(issue)
         end
 
         add_labels_thread&.join
@@ -108,57 +72,39 @@ module Geet
         assign_users_thread&.join
       end
 
-      def add_labels(issue, selected_labels, output)
+      def add_labels(issue, selected_labels)
         labels_list = selected_labels.map(&:name).join(', ')
 
-        output.puts "Adding labels #{labels_list}..."
+        @out.puts "Adding labels #{labels_list}..."
 
         Thread.new do
           issue.add_labels(selected_labels.map(&:name))
         end
       end
 
-      def set_milestone(issue, milestone, output)
-        output.puts "Setting milestone #{milestone.title}..."
+      def set_milestone(issue, milestone)
+        @out.puts "Setting milestone #{milestone.title}..."
 
         Thread.new do
           issue.edit(milestone: milestone.number)
         end
       end
 
-      def assign_users(issue, users, output)
-        output.puts "Assigning users #{users.join(', ')}..."
+      def assign_users(issue, users)
+        @out.puts "Assigning users #{users.join(', ')}..."
 
         Thread.new do
           issue.assign_users(users)
         end
       end
 
-      def assign_authenticated_user(issue, output)
-        output.puts 'Assigning authenticated user...'
+      def assign_authenticated_user(issue)
+        @out.puts 'Assigning authenticated user...'
 
         Thread.new do
           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)
-        if raw_patterns == MANUAL_LIST_SELECTION_FLAG
-          Geet::Utils::ManualListSelection.new.select(entry_type, entries, selection_type, instance_method: instance_method)
-        else
-          Geet::Utils::PatternMatchingSelection.new.select(entry_type, entries, raw_patterns, instance_method: instance_method)
-        end
-      end
     end
   end
 end