geet 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37b511c318e9f2cb1c18ecf1a1f247236c841040
-  data.tar.gz: 61aeabbdbd6e3616e49247acf47ffbbbf18d8085
+  metadata.gz: a73b4ce8509349204e7abc8c667856acf8baa421
+  data.tar.gz: b94ef51efb18f859f7aa547cb718861a2ca03eeb
 SHA512:
-  metadata.gz: 6692e7597431f0d0ef9d194030086112985f7f1f2e4e0b6b8caf3c6dbeea565fd3d22b7b0033cf3290bf156e6f331e4e70ea6b3cf3be962e45110aa32ffdf05c
-  data.tar.gz: e57f240a2c9a3b0ecb65a874efa7f3c4c61e0102cd365c7a53ac6b2579367c37c95dae072014f33ac5d6077ca75df649aff0dd4e7912a92502503e5a6a0e554e
+  metadata.gz: f07424e685a1265e5e083889c9ee627893f63bbcb56d268b2fe5cfabd2e475f98bade4c9eca5e67da4a84e53e6652c3dbecb05fd5f4b3acbc8fe05819b9250d5
+  data.tar.gz: acabfcbaa84a7e3f0423706ca3a84a95ce779f8bf6771a6b1b02a7920a54b3068922ec241c61ad275af12fd7b08469ffd78fb91e575ecc0d8e335278a4aac968

data/Gemfile

@@ -2,19 +2,15 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gem 'simple_scripting', '~> 0.9.3'
-gem 'temp-fork-tp-filter', '= 0.0.3'
-
-group :development, :test do
-  gem 'byebug', '~> 9.1.0'
-  gem 'rake', '~> 12.3.0'
-  gem 'rubocop', '~> 0.52.0'
-end
+gemspec
 
 group :test do
   gem 'rspec', '~> 3.7.0'
   gem 'vcr', '~> 3.0.3'
   gem 'webmock', '~> 3.1.1'
 end
+
+group :tools do
+  gem 'byebug', '~> 9.1.0'
+  gem 'rubocop', '~> 0.52.0'
+end

data/Gemfile.lock

@@ -1,3 +1,10 @@
+PATH
+  remote: .
+  specs:
+    geet (0.3.0)
+      simple_scripting (~> 0.9.3)
+      temp-fork-tp-filter (= 0.0.3)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -75,11 +82,10 @@ PLATFORMS
 
 DEPENDENCIES
   byebug (~> 9.1.0)
+  geet!
   rake (~> 12.3.0)
   rspec (~> 3.7.0)
   rubocop (~> 0.52.0)
-  simple_scripting (~> 0.9.3)
-  temp-fork-tp-filter (= 0.0.3)
   vcr (~> 3.0.3)
   webmock (~> 3.1.1)
 

data/README.md

@@ -55,6 +55,31 @@ patterns are partial matches, so, for example, `johncarmack` will be matched as
 
 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:
+
+    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:
+
+    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.
+
 ### Create a PR (with label, reviewers, and assigned to self)
 
 Basic creation of a PR:
@@ -132,8 +157,8 @@ Examples:
 
 ## Development status
 
-Geet is in alpha status. Although I use it daily, new features are frequently added, and internal/external APIs/workflows may change.
+Geet is in beta status. Although I use it daily, new features are frequently added, and internal/external APIs/workflows may change.
 
-The public release will be 1.0, and is expected to be released in February 2018 or earlier.
+The public release will be 1.0.
 
 [BS img]: https://travis-ci.org/saveriomiroddi/geet.svg?branch=master

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--order rand']
+end
 
 task default: :spec

data/bin/geet

@@ -5,17 +5,20 @@ 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/utils/git.rb'
+require_relative '../lib/geet/helpers/summary_helper.rb'
+require_relative '../lib/geet/utils/git_client.rb'
 Dir[File.join(__dir__, '../lib/geet/services/*.rb')].each { |filename| require filename }
 
 class GeetLauncher
   include Geet
   include Geet::Commandline::Commands
+  include Geet::Helpers::SummaryHelper
+
+  SUMMARY_TEMPLATE = IO.read(File.expand_path('../lib/geet/resources/templates/edit_summary.md', __dir__))
 
   def launch
     command, options = Commandline::Configuration.new.decode_argv || exit
 
-    # `:upstream` is always false in the gist command case.
     repository = Git::Repository.new(upstream: !!options[:upstream])
 
     case command
@@ -23,40 +26,57 @@ class GeetLauncher
       filename = options.delete(:filename)
       options[:publik] = options.delete(:public) if options.key?(:public)
 
-      Services::CreateGist.new.execute(repository, filename, options)
+      Services::CreateGist.new.execute(filename, options)
     when ISSUE_CREATE_COMMAND
-      title, description = Commandline::Editor.new.edit_summary
+      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)
 
-      Services::CreateIssue.new.execute(repository, title, description, options)
+      Services::CreateIssue.new(repository).execute(title, description, options)
     when LABEL_CREATE_COMMAND
       name = options.delete(:name)
 
-      Services::CreateLabel.new.execute(repository, name, options)
+      Services::CreateLabel.new(repository).execute(name, options)
     when ISSUE_LIST_COMMAND
-      Services::ListIssues.new.execute(repository, options)
+      Services::ListIssues.new(repository).execute(options)
     when LABEL_LIST_COMMAND
-      Services::ListLabels.new.execute(repository)
+      Services::ListLabels.new(repository).execute
     when MILESTONE_LIST_COMMAND
-      Services::ListMilestones.new.execute(repository)
+      Services::ListMilestones.new(repository).execute
     when PR_CREATE_COMMAND
-      # Tricky. It would be best to have Git logic exlusively inside the services,
-      # but at the same time, the summary editing should be out.
-      git = Utils::Git.new(repository)
-      summary = git.cherry('master').size == 1 ? git.show_description('HEAD') : ''
+      summary = options[:summary] || edit_pr_summary
+      title, description = split_summary(summary)
 
-      title, description = Commandline::Editor.new.edit_summary(summary: summary)
       options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
 
-      Services::CreatePr.new.execute(repository, title, description, options)
+      Services::CreatePr.new(repository).execute(title, description, options)
     when PR_LIST_COMMAND
-      Services::ListPrs.new.execute(repository)
+      Services::ListPrs.new(repository).execute
     when PR_MERGE_COMMAND
-      Services::MergePr.new.execute(repository, options)
+      Services::MergePr.new(repository).execute(options)
     else
       raise "Internal error - Unrecognized command #{command.inspect}"
     end
   end
+
+  private
+
+  def edit_pr_summary
+    # Tricky. It would be best to have Git logic exlusively inside the services,
+    # but at the same time, the summary editing should be out.
+    git = Utils::GitClient.new
+    pr_commits = git.cherry('master')
+
+    if pr_commits.size == 1
+      prepopulated_summary = git.show_description('HEAD')
+      cancel_pr_help = "In order to cancel the PR creation, delete the description above.\n"
+
+      Commandline::Editor.new.edit_content(content: prepopulated_summary, help: SUMMARY_TEMPLATE + cancel_pr_help)
+    else
+      Commandline::Editor.new.edit_content(help: SUMMARY_TEMPLATE)
+    end
+  end
 end
 
 GeetLauncher.new.launch if $PROGRAM_NAME == __FILE__

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        = '2018-01-19'
+  s.date        = '2018-01-25'
   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).'
@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'simple_scripting', '~> 0.9.3'
   s.add_runtime_dependency 'temp-fork-tp-filter', '= 0.0.3'
 
+  s.add_development_dependency 'rake', '~> 12.3.0'
+
   s.files         = `git ls-files`.split("\n")
   s.executables   << 'geet'
   s.require_paths = ['lib']

data/lib/geet/commandline/configuration.rb

@@ -24,13 +24,15 @@ module Geet
         ['-n', '--no-open-issue',                           "Don't open the issue link in the browser after creation"],
         ['-l', '--label-patterns "bug,help wanted"',        'Label patterns'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
-        ['-a', '--assignee-patterns john,tom,adrian,kevin', 'Assignee login patterns. Defaults to authenticated user'],
+        ['-a', '--assignee-patterns john,tom,adrian,kevin', 'Assignee login patterns'],
+        ['-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.'
       ]
 
       LABEL_CREATE_OPTIONS = [
         ['-c', '--color color',                             '6-digits hex color; if not specified, a random one is created'],
+        ['-u', '--upstream',                                'Create on the upstream repository'],
         'name',
       ].freeze
 
@@ -39,18 +41,29 @@ module Geet
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
-      LABEL_LIST_OPTIONS = [].freeze
+      LABEL_LIST_OPTIONS = [
+        ['-u', '--upstream',                                'List on the upstream repository'],
+      ].freeze
 
-      MILESTONE_LIST_OPTIONS = [].freeze
+      MILESTONE_LIST_OPTIONS = [
+        ['-u', '--upstream',                                'List on the upstream repository'],
+      ].freeze
 
       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'],
         ['-m', '--milestone 1.5.0',                         'Milestone title pattern'],
         ['-r', '--reviewer-patterns john,tom,adrian,kevin', 'Reviewer login patterns'],
+        ['-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; if the PR adds one commit only, '\
-                   'the content will be prepopulated with the commit description.'
+        long_help: <<~STR
+          The default editor will be opened for editing title and description; if the PR adds one commit only, the content will be prepopulated with the commit description.
+
+          The "automated mode" will automate branch operations:
+          - raise an error if the current tree is dirty;
+          - if the upstream branch is not present, it will create it, otherwise, it will perform a push.
+        STR
       ]
 
       PR_LIST_OPTIONS = [

data/lib/geet/commandline/editor.rb

@@ -7,23 +7,24 @@ require_relative '../helpers/os_helper.rb'
 module Geet
   module Commandline
     class Editor
-      # Liberally ripp..., ahem, inspired from git.
-      SUMMARY_TEMPLATE = File.expand_path('../resources/edit_summary_template.md', __dir__)
-      SUMMARY_TEMPLATE_SEPARATOR = '------------------------ >8 ------------------------'
-
       include Geet::Helpers::OsHelper
 
-      # Edits a summary in the default editor, providing the SUMMARY_TEMPLATE.
+      # Git style!
+      HELP_SEPARATOR = '------------------------ >8 ------------------------'
+
+      # Edits a content in the default editor, optionally providing help.
       #
-      # A summary is a composition with a title and an optional description;
-      # if the description is not found, a blank string is returned.
+      # When the help is provided, it's appended to the bottom, separated by HELP_SEPARATOR.
+      # The help is stripped after the content if edited.
       #
-      def edit_summary(summary: '')
-        full_summary = summary + IO.read(SUMMARY_TEMPLATE)
+      def edit_content(content: '', help: nil)
+        content += "\n\n" + HELP_SEPARATOR + "\n" + help if help
 
-        raw_summary = edit_content_in_default_editor(full_summary)
+        edited_content = edit_content_in_default_editor(content)
 
-        split_raw_summary(raw_summary)
+        edited_content = edited_content.split(HELP_SEPARATOR, 2).first if help
+
+        edited_content.strip
       end
 
       private
@@ -36,8 +37,9 @@ module Geet
       #
       def edit_content_in_default_editor(content)
         tempfile = Tempfile.open(['geet_editor', '.md']) { |file| file << content }.path
+        command = "#{system_editor} #{tempfile.shellescape}"
 
-        execute_command('editing', system_editor, tempfile)
+        execute_command(command, description: 'editing', interactive: true)
 
         content = IO.read(tempfile)
 
@@ -46,18 +48,6 @@ module Geet
         content
       end
 
-      def split_raw_summary(raw_summary)
-        raw_summary, _ = raw_summary.strip.split(SUMMARY_TEMPLATE_SEPARATOR, 2)
-
-        raise "Missing title!" if raw_summary.empty?
-
-        title, description = raw_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
-
       # HELPERS ##########################################################################
 
       def system_editor

data/lib/geet/git/repository.rb

@@ -1,28 +1,25 @@
 # frozen_string_literal: true
 
 require 'shellwords'
+require_relative '../utils/git_client'
 
 module Geet
   module Git
     # This class represents, for convenience, both the local and the remote repository, but the
     # remote code is separated in each provider module.
     class Repository
-      # For simplicity, we match any character except the ones the separators.
-      REMOTE_ORIGIN_REGEX = %r{
-        \A
-        (?:https://(.+?)/|git@(.+?):)
-        ([^/]+/.*?)
-        (?:\.git)?
-        \Z
-      }x
-
-      ORIGIN_NAME   = 'origin'
-      UPSTREAM_NAME = 'upstream'
-
-      def initialize(upstream: false, location: nil)
+      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.
+      STR
+
+      DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
+
+      def initialize(upstream: false, git_client: DEFAULT_GIT_CLIENT, warnings: true)
         @upstream = upstream
-        @location = location
+        @git_client = git_client
         @api_token = extract_env_api_token
+        @warnings = warnings
       end
 
       # REMOTE FUNCTIONALITIES (REPOSITORY)
@@ -35,12 +32,8 @@ module Geet
         attempt_provider_call(:Label, :list, api_interface)
       end
 
-      def create_gist(filename, content, description: nil, publik: false)
-        attempt_provider_call(:Gist, :create, filename, content, api_interface, description: description, publik: publik)
-      end
-
       def create_issue(title, description)
-        ask_confirm_action if location_action_with_upstream_repository?
+        ask_confirm_action if local_action_with_upstream_repository? && @warnings
         attempt_provider_call(:Issue, :create, title, description, api_interface)
       end
 
@@ -69,7 +62,7 @@ module Geet
       end
 
       def create_pr(title, description, head)
-        ask_confirm_action if location_action_with_upstream_repository?
+        ask_confirm_action if local_action_with_upstream_repository? && @warnings
         attempt_provider_call(:PR, :create, title, description, head, api_interface)
       end
 
@@ -85,69 +78,25 @@ module Geet
 
       # OTHER/CONVENIENCE FUNCTIONALITIES
 
-      def current_branch
-        gitdir_option = "--git-dir #{@location.shellescape}/.git" if @location
-        branch = `git #{gitdir_option} rev-parse --abbrev-ref HEAD`.strip
-
-        raise "Couldn't find current branch" if branch == 'HEAD'
-
-        branch
+      def upstream?
+        @upstream
       end
 
       private
 
-      # REPOSITORY METADATA
-
-      # The result is in the format `git@github.com:donaldduck/geet.git`
-      #
-      def remote(name)
-        gitdir_option = "--git-dir #{@location.shellescape}/.git" if @location
-        remote_url = `git #{gitdir_option} ls-remote --get-url #{name}`.strip
-
-        if remote_url == name
-          raise "Remote #{name.inspect} not found!"
-        elsif remote_url !~ REMOTE_ORIGIN_REGEX
-          raise "Unexpected remote reference format: #{remote_url.inspect}"
-        end
-
-        remote_url
-      end
-
-      # "Lightweight" version of #remote.
-      # Doesn't sanity check for the remote url format; this action is for querying
-      # purposes, any any action that needs to work with the remote, uses #remote.
-      #
-      def has_remote?(name)
-        gitdir_option = "--git-dir #{@location.shellescape}/.git" if @location
-        remote_url = `git #{gitdir_option} ls-remote --get-url #{name}`.strip
-
-        remote_url != name
-      end
-
       # PROVIDER
 
       def extract_env_api_token
-        env_variable_name = "#{provider_domain[/(.*)\.\w+/, 1].upcase}_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!")
       end
 
-      def provider_domain
-        # We assume that it's not possible to have origin and upstream on different providers.
-        #
-        remote_url = remote(ORIGIN_NAME)
-
-        domain = remote_url[REMOTE_ORIGIN_REGEX, 1] || remote_url[REMOTE_ORIGIN_REGEX, 2]
-
-        raise "Can't identify domain in the provider domain string: #{provider_domain}" if domain !~ /(.*)\.\w+/
-
-        domain
-      end
-
       # Attempt to find the provider class and send the specified method, returning a friendly
       # error (functionality X [Y] is missing) when a class/method is missing.
       def attempt_provider_call(class_name, meth, *args)
-        module_name = provider_domain[/(.*)\.\w+/, 1].capitalize
+        module_name = provider_name.capitalize
 
         require_provider_modules
 
@@ -167,8 +116,7 @@ module Geet
       end
 
       def require_provider_modules
-        provider_dirname = provider_domain[/(.*)\.\w+/, 1]
-        files_pattern = "#{__dir__}/../#{provider_dirname}/*.rb"
+        files_pattern = "#{__dir__}/../#{provider_name}/*.rb"
 
         Dir[files_pattern].each { |filename| require filename }
       end
@@ -176,25 +124,23 @@ module Geet
       # OTHER HELPERS
 
       def api_interface
-        attempt_provider_call(:ApiInterface, :new, @api_token, path(upstream: @upstream), @upstream)
-      end
-
-      # Example: `donaldduck/geet`
-      #
-      def path(upstream: false)
-        remote_name = upstream ? UPSTREAM_NAME : ORIGIN_NAME
-
-        remote(remote_name)[REMOTE_ORIGIN_REGEX, 3]
+        path = @git_client.path(upstream: @upstream)
+        attempt_provider_call(:ApiInterface, :new, @api_token, repo_path: path, upstream: @upstream)
       end
 
       def ask_confirm_action
-        puts "WARNING! The action will be performed on a fork, but an upstream repository has been found!"
-        print "Press Enter to continue, or Ctrl+C to exit now."
+        print CONFIRM_ACTION_TEXT.rstrip
         gets
       end
 
-      def location_action_with_upstream_repository?
-        has_remote?('upstream') && !@upstream
+      def local_action_with_upstream_repository?
+        @git_client.remote_defined?('upstream') && !@upstream
+      end
+
+      # Bare downcase provider name, eg. `github`
+      #
+      def provider_name
+        @git_client.provider_domain[/(.*)\.\w+/, 1]
       end
     end
   end