geet 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc8920121911b4f4ce4fe3d0d090be3bef017587
-  data.tar.gz: 5a85cb49ef2e87aef1fb930e314c83042b3b2abd
+  metadata.gz: 24a7f62fafb16b3920cb80f2f8d426cab3122fa6
+  data.tar.gz: 1ee1a9199b4ded572993b15b437efeb70cf9ab98
 SHA512:
-  metadata.gz: d0a8ca5e66586a583c84e7113fef8e83e1e0897f9ab07f04bf0cf7cc4545d16f83ae43acbbef4e079255fd5233a3330b007d2a0e1b89fe85171f3075af260265
-  data.tar.gz: 617080f5cce9ddd914aaca259f68aee020251b5157bf352dd736d24e27555c72d6a13527a8698a3ffe3c78d594e42e2ad7dbbdc8e3aae589d277b132dc9f9693
+  metadata.gz: 37a3767213474b09a881ce84074d3f48240870bfd404f8b12609f78153d41ab995630445dd9901cba750c50b307db5cd2c303f7b2c45c607cd12c4f8d5798e67
+  data.tar.gz: 4f8686315885d94a7aae287432b4b9d1c3b1afcbc0ffaa20d937b9d50538817602481546c968b6f797e0f8877860eb2f9cdb9cc89ac55b28c21eeee54b83e644

data/.rubocop.yml

@@ -9,25 +9,48 @@ Layout/SpaceAroundOperators:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 32
+  Exclude:
+    - 'bin/geet'                                 # Program entry point switch/case
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'                        # RSpec is styled in long blocks
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/geet/git/repository.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/geet/github/api_interface.rb'         # Switch-case (HTTP) parameter decoding
+    - 'lib/geet/gitlab/api_interface.rb'         # Switch-case (HTTP) parameter decoding
+    - 'bin/geet'                                 # Program entry point switch/case
 
 Metrics/LineLength:
-  Max: 160
+  Max: 120
+  Exclude:
+    - 'lib/geet/git/repository.rb'               # Table-style code
+    - 'lib/geet/commandline/configuration.rb'    # Table-style code
 
 Metrics/MethodLength:
-  Max: 29
+  Max: 20
+  Exclude:
+    - 'bin/geet'                                 # Program entry point switch/case
+    - 'lib/geet/commandline/configuration.rb'    # Table-style code
 
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
 Metrics/PerceivedComplexity:
   Exclude:
-    - 'lib/geet/services/create_issue.rb'
+    - 'lib/geet/services/create_issue.rb'        # The creation method has many parameters
+    - 'lib/geet/services/create_pr.rb'           # The creation method has many parameters
+    - 'bin/geet'                                 # Program entry point switch/case
 
-Style/ConditionalAssignment:
+Style/BlockComments:
   Enabled: false
 
-Style/Documentation:
+Style/ConditionalAssignment:
   Enabled: false
 
 Style/DoubleNegation:
@@ -37,6 +60,9 @@ Style/GuardClause:
   Exclude:
     - 'lib/geet/git/repository.rb'
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/NegatedIf:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,7 +1,30 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-06 20:05:36 +0100 using RuboCop version 0.51.0.
+# on 2017-12-24 11:42:10 +0100 using RuboCop version 0.52.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'lib/geet/commandline/configuration.rb'
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 24
+
+# Offense count: 27
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+# 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/Gemfile

@@ -8,10 +8,12 @@ gem 'simple_scripting', '~> 0.9.3'
 
 group :development, :test do
   gem 'byebug', '~> 9.1.0'
+  gem 'rake', '~> 12.3.0'
+  gem 'rubocop', '~> 0.52.0'
 end
 
 group :test do
+  gem 'rspec', '~> 3.7.0'
   gem 'vcr', '~> 3.0.3'
   gem 'webmock', '~> 3.1.1'
-  gem 'rspec', '~> 3.7.0'
 end

data/Gemfile.lock

@@ -3,13 +3,20 @@ GEM
   specs:
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
     byebug (9.1.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     hashdiff (0.3.7)
+    parallel (1.12.1)
     parseconfig (1.0.8)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
     public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rake (12.3.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -23,9 +30,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
     simple_scripting (0.9.3)
       parseconfig (~> 1.0)
+    unicode-display_width (1.3.0)
     vcr (3.0.3)
     webmock (3.1.1)
       addressable (>= 2.3.6)
@@ -37,7 +53,9 @@ PLATFORMS
 
 DEPENDENCIES
   byebug (~> 9.1.0)
+  rake (~> 12.3.0)
   rspec (~> 3.7.0)
+  rubocop (~> 0.52.0)
   simple_scripting (~> 0.9.3)
   vcr (~> 3.0.3)
   webmock (~> 3.1.1)

data/README.md

@@ -1,20 +1,21 @@
+[![Build Status][BS IMG]](https://travis-ci.org/saveriomiroddi/geet)
+
 # Geet
 
 Command line interface for performing Git hosting service operations.
 
-The current version supports only creating PRs/issues.
-
 This tool is very similar to [Hub](https://github.com/github/hub), but it supports a different set of operations, fully specified via command line.
 
 Please see the [development status](#development-status) section for informations about the current development.
 
-## Providers support
+## Operation/providers support
 
 The functionalities currently supported are:
 
 - Github:
   - create gist
   - create issue
+  - create label
   - create PR
   - list issues
   - list labels
@@ -38,27 +39,37 @@ All the commands need to be run from the git repository.
 
 ### Create an issue (with label and assignees)
 
-Basic creation of an issue (after creation, will open the page in the browser):
+Basic creation of an issue:
+
+    $ geet issue create
+
+The default editor will be used for title/description:
 
-    $ geet issue create 'Issue title' 'Multi
-    > line
-    > description'
+![Issue creation editing screenshot](/extra/issue_editing.png?raw=true)
 
 More advanced issue creation, with labels and assignees:
 
-    $ geet issue create 'Issue title' 'Issue description' --label-patterns bug,wip --assignee-patterns john
+    $ 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.
+
 ### Create a PR (with label, reviewers, and assigned to self)
 
-Basic creation of a PR (after creation, will open the page in the browser):
+Basic creation of a PR:
+
+    $ geet pr create
+
+The default editor will be used for title/description:
 
-    $ geet pr create 'PR title' 'Description'
+![Issue creation editing screenshot](/extra/pr_editing.png?raw=true)
 
 More advanced PR creation, with label and reviewers, assigned to self:
 
-    $ geet pr create 'PR title' 'Closes #1' --label-patterns "code review" --reviewer-patterns kevin,tom,adrian
+    $ geet pr create --label-patterns "code review" --reviewer-patterns kevin,tom,adrian
+
+After creation, the issue page will be automatically opened in the default browser.
 
 ### List issues/PRs
 
@@ -76,6 +87,27 @@ List the open PRs, in default order (inverse creation date):
     $ geet pr list
     > 21. Add PRs listing support (https://github.com/saveriomiroddi/geet/pull/21)
 
+### List milestones
+
+    $ geet milestone list
+    > 9. 0.2.0
+    >   4. Allow writing description in an editor (https://github.com/saveriomiroddi/geet/issues/4)
+    > 6. 0.2.1
+    >   69. Display warning when some operations are performed on a forked repository (https://github.com/saveriomiroddi/geet/issues/69)
+    >   60. Update Create PR test suite; the UTs are not inspecting some of the changes (https://github.com/saveriomiroddi/geet/issues/60)
+    >   51. Services should take repository in the initializer (https://github.com/saveriomiroddi/geet/issues/51)
+    > 7. 0.2.2
+    >   43. PR Merging: upstream support (https://github.com/saveriomiroddi/geet/issues/43)
+    >   35. Improve design of repository-independent actions (https://github.com/saveriomiroddi/geet/issues/35)
+
+### List labels
+
+    $ geet label list
+    > - bug (#ee0701)
+    > - enhancement (#84b6eb)
+    > - technical_debt (#ee0701)
+    > - top_priority (#d93f0b)
+
 ### Create a gist
 
 Create a private gist:
@@ -103,3 +135,5 @@ Examples:
 Geet is in alpha 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.
+
+[BS img]: https://travis-ci.org/saveriomiroddi/geet.svg?branch=master

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/geet

@@ -3,6 +3,7 @@
 
 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'
 Dir[File.join(__dir__, '../lib/geet/services/*.rb')].each { |filename| require filename }
 
@@ -11,9 +12,7 @@ class GeetLauncher
   include Geet::Commandline::Commands
 
   def launch
-    commandline_configuration = Commandline::Configuration.new
-
-    command, options = commandline_configuration.decode_argv || exit
+    command, options = Commandline::Configuration.new.decode_argv || exit
 
     # `:upstream` is always false in the gist command case.
     repository = Git::Repository.new(upstream: !!options[:upstream])
@@ -25,7 +24,7 @@ class GeetLauncher
 
       Services::CreateGist.new.execute(repository, filename, options)
     when ISSUE_CREATE_COMMAND
-      title, description = options.values_at(:title, :description)
+      title, description = Commandline::Editor.new.edit_summary
       options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
 
       Services::CreateIssue.new.execute(repository, title, description, options)
@@ -40,20 +39,18 @@ class GeetLauncher
     when MILESTONE_LIST_COMMAND
       Services::ListMilestones.new.execute(repository)
     when PR_CREATE_COMMAND
-      title, description = options.values_at(:title, :description)
+      title, description = Commandline::Editor.new.edit_summary
       options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
 
       Services::CreatePr.new.execute(repository, title, description, options)
     when PR_LIST_COMMAND
       Services::ListPrs.new.execute(repository)
     when PR_MERGE_COMMAND
-      Services::MergePr.new.execute(repository)
+      Services::MergePr.new.execute(repository, options)
     else
       raise "Internal error - Unrecognized command #{command.inspect}"
     end
   end
 end
 
-if __FILE__ == $0
-  GeetLauncher.new.launch
-end
+GeetLauncher.new.launch if $PROGRAM_NAME == __FILE__

data/geet.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.name        = 'geet'
   s.version     = Geet::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.3.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2017-12-23'
+  s.date        = '2017-12-30'
   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).'

data/lib/geet/commandline/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Geet
   module Commandline
     module Commands
@@ -12,4 +14,4 @@ module Geet
       PR_MERGE_COMMAND = 'pr.merge'
     end
   end
-end
+end

data/lib/geet/commandline/configuration.rb

@@ -17,15 +17,17 @@ module Geet
         '[description]'
       ].freeze
 
+      # SimpleScripting 0.9.3 doesn't allow frozen arrays when hash options are present.
+      #
+      # 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'],
         ['-m', '--milestone number_or_pattern',             'Milestone number or description pattern'],
         ['-a', '--assignee-patterns john,tom,adrian,kevin', 'Assignee login patterns. Defaults to authenticated user'],
         ['-u', '--upstream',                                'Create on the upstream repository'],
-        'title',
-        'description'
-      ].freeze
+        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'],
@@ -36,11 +38,9 @@ module Geet
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
-      LABEL_LIST_OPTIONS = [
-      ].freeze
+      LABEL_LIST_OPTIONS = [].freeze
 
-      MILESTONE_LIST_OPTIONS = [
-      ].freeze
+      MILESTONE_LIST_OPTIONS = [].freeze
 
       PR_CREATE_OPTIONS = [
         ['-n', '--no-open-pr',                              "Don't open the PR link in the browser after creation"],
@@ -48,43 +48,49 @@ module Geet
         ['-m', '--milestone number_or_pattern',             'Milestone number or description pattern'],
         ['-r', '--reviewer-patterns john,tom,adrian,kevin', 'Reviewer login patterns'],
         ['-u', '--upstream',                                'Create on the upstream repository'],
-        'title',
-        'description'
-      ].freeze
+        long_help: 'The default editor will be opened for editing title and description.'
+      ]
 
       PR_LIST_OPTIONS = [
         ['-u', '--upstream',                                'List on the upstream repository'],
       ].freeze
 
+      # SimpleScripting 0.9.3 doesn't allow frozen arrays when hash options are present.
+      #
       # rubocop:disable Style/MutableConstant
       PR_MERGE_OPTIONS = [
+        ['-d', '--delete-branch',                           'Delete the branch after merging'],
         long_help: 'Merge the PR for the current branch'
       ]
 
+      # Commands decoding table
+
+      COMMANDS_DECODING_TABLE = {
+        'gist' => {
+          'create' => GIST_CREATE_OPTIONS,
+        },
+        'issue' => {
+          'create' => ISSUE_CREATE_OPTIONS,
+          'list' => ISSUE_LIST_OPTIONS,
+        },
+        'label' => {
+          'create' => LABEL_CREATE_OPTIONS,
+          'list' => LABEL_LIST_OPTIONS,
+        },
+        'milestone' => {
+          'list' => MILESTONE_LIST_OPTIONS,
+        },
+        'pr' => {
+          'create' => PR_CREATE_OPTIONS,
+          'list' => PR_LIST_OPTIONS,
+          'merge' => PR_MERGE_OPTIONS,
+        },
+      }
+
       # Public interface
 
       def decode_argv
-        SimpleScripting::Argv.decode(
-          'gist' => {
-            'create' => GIST_CREATE_OPTIONS,
-          },
-          'issue' => {
-            'create' => ISSUE_CREATE_OPTIONS,
-            'list' => ISSUE_LIST_OPTIONS,
-          },
-          'label' => {
-            'create' => LABEL_CREATE_OPTIONS,
-            'list' => LABEL_LIST_OPTIONS,
-          },
-          'milestone' => {
-            'list' => MILESTONE_LIST_OPTIONS,
-          },
-          'pr' => {
-            'create' => PR_CREATE_OPTIONS,
-            'list' => PR_LIST_OPTIONS,
-            'merge' => PR_MERGE_OPTIONS,
-          },
-        )
+        SimpleScripting::Argv.decode(COMMANDS_DECODING_TABLE)
       end
     end
   end