geet 0.1.12 → 0.2.0

data/lib/geet/commandline/editor.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+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.
+      #
+      # A summary is a composition with a title and an optional description;
+      # if the description is not found, a blank string is returned.
+      #
+      def edit_summary
+        raw_summary = edit_content_in_default_editor(IO.read(SUMMARY_TEMPLATE))
+
+        split_raw_summary(raw_summary)
+      end
+
+      private
+
+      # MAIN STEPS #######################################################################
+
+      # The gem `tty-editor` does this, although it requires in turn other 7/8 gems.
+      # Interestingly, the API `TTY::Editor.open(content: 'text')` is not very useful,
+      # as it doesn't return the filename (!).
+      #
+      def edit_content_in_default_editor(content)
+        tempfile = Tempfile.open(['geet_editor', '.md']) { |file| file << content }.path
+
+        execute_command('editing', system_editor, tempfile)
+
+        content = IO.read(tempfile)
+
+        File.unlink(tempfile)
+
+        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
+        ENV['EDITOR'] || ENV['VISUAL'] || 'vi'
+      end
+    end
+  end
+end

data/lib/geet/git/repository.rb

@@ -47,6 +47,10 @@ module Geet
         attempt_provider_call(:Label, :create, name, color, api_interface)
       end
 
+      def delete_branch(name)
+        attempt_provider_call(:Branch, :delete, name, api_interface)
+      end
+
       def abstract_issues(milestone: nil)
         attempt_provider_call(:AbstractIssue, :list, api_interface, milestone: milestone)
       end
@@ -139,7 +143,7 @@ module Geet
         if Kernel.const_defined?(full_class_name)
           klass = Kernel.const_get(full_class_name)
 
-          if ! klass.respond_to?(meth)
+          if !klass.respond_to?(meth)
             raise "The functionality invoked (#{class_name} #{meth}) is not currently supported!"
           end
 

data/lib/geet/github/abstract_issue.rb

@@ -22,21 +22,25 @@ module Geet
 
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
-      def self.list(api_interface, milestone: nil)
+      def self.list(api_interface, only_issues: false, milestone: nil)
         api_path = 'issues'
         request_params = { milestone: milestone } if milestone
 
         response = api_interface.send_request(api_path, params: request_params, multipage: true)
 
-        response.map do |issue_data|
+        abstract_issues_list = response.map do |issue_data|
           number = issue_data.fetch('number')
           title = issue_data.fetch('title')
           link = issue_data.fetch('html_url')
 
           klazz = issue_data.key?('pull_request') ? PR : Issue
 
-          klazz.new(number, api_interface, title, link)
+          if !only_issues || klazz == Issue
+            klazz.new(number, api_interface, title, link)
+          end
         end
+
+        abstract_issues_list.compact
       end
 
       # params:

data/lib/geet/github/api_interface.rb

@@ -24,6 +24,7 @@ module Geet
       # Send a request.
       #
       # Returns the parsed response, or an Array, in case of multipage.
+      # Where no body is present in the response, nil is returned.
       #
       # params:
       #   :api_path:    api path, will be appended to the API URL.
@@ -35,8 +36,9 @@ module Geet
       #   :data:        (Hash) if present, will generate a POST request, otherwise, a GET
       #   :multipage:   set true for paged Github responses (eg. issues); it will make the method
       #                 return an array, with the concatenated (parsed) responses
-      #   :http_method: :get, :patch, :post and :put are accepted, but only :patch/:put are meaningful,
-      #                 since the others are automatically inferred by :data.
+      #   :http_method: symbol format of the method (:get, :patch, :post, :put and :delete)
+      #                 :get and :post are automatically inferred by the present of :data; the other
+      #                 cases must be specified.
       #
       def send_request(api_path, params: nil, data: nil, multipage: false, http_method: nil)
         address = api_url(api_path)
@@ -46,7 +48,7 @@ module Geet
         loop do
           response = send_http_request(address, params: params, data: data, http_method: http_method)
 
-          parsed_response = JSON.parse(response.body)
+          parsed_response = JSON.parse(response.body) if response.body
 
           if error?(response)
             formatted_error = decode_and_format_error(parsed_response)
@@ -133,12 +135,14 @@ module Geet
         case http_method
         when :get
           Net::HTTP::Get
+        when :delete
+          Net::HTTP::Delete
         when :patch
           Net::HTTP::Patch
-        when :put
-          Net::HTTP::Put
         when :post
           Net::HTTP::Post
+        when :put
+          Net::HTTP::Put
         else
           raise "Unsupported HTTP method: #{http_method.inspect}"
         end

data/lib/geet/github/branch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Geet
+  module Github
+    class Branch
+      # See https://developer.github.com/v3/git/refs/#delete-a-reference
+      #
+      def self.delete(name, api_interface)
+        api_path = "git/refs/heads/#{name}"
+
+        api_interface.send_request(api_path, http_method: :delete)
+      end
+    end
+  end
+end

data/lib/geet/github/gist.rb

@@ -6,7 +6,7 @@ module Geet
   module Github
     class Gist
       def self.create(filename, content, api_interface, description: nil, publik: false)
-        api_path = "/gists"
+        api_path = '/gists'
 
         request_data = prepare_request_data(filename, content, description, publik)
 

data/lib/geet/github/issue.rb

@@ -20,19 +20,7 @@ module Geet
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
       def self.list(api_interface)
-        api_path = 'issues'
-
-        response = api_interface.send_request(api_path, multipage: true)
-
-        response.each_with_object([]) do |issue_data, result|
-          if !issue_data.key?('pull_request')
-            number = issue_data.fetch('number')
-            title = issue_data.fetch('title')
-            link = issue_data.fetch('html_url')
-
-            result << new(number, api_interface, title, link)
-          end
-        end
+        super(api_interface, only_issues: true)
       end
     end
   end

data/lib/geet/github/label.rb

@@ -28,7 +28,7 @@ module Geet
       # See https://developer.github.com/v3/issues/labels/#create-a-label
       def self.create(name, color, api_interface)
         api_path = 'labels'
-        request_data = {name: name, color: color }
+        request_data = { name: name, color: color }
 
         api_interface.send_request(api_path, data: request_data)
 

data/lib/geet/gitlab/api_interface.rb

@@ -28,6 +28,7 @@ module Geet
       # Send a request.
       #
       # Returns the parsed response, or an Array, in case of multipage.
+      # Where no body is present in the response, nil is returned.
       #
       # params:
       #   :api_path:    api path, will be appended to the API URL.
@@ -39,8 +40,9 @@ module Geet
       #   :data:        (Hash) if present, will generate a POST request, otherwise, a GET
       #   :multipage:   set true for paged Github responses (eg. issues); it will make the method
       #                 return an array, with the concatenated (parsed) responses
-      #   :http_method: :get, :patch, :post and :put are accepted, but only :patch/:put are meaningful,
-      #                 since the others are automatically inferred by :data.
+      #   :http_method: symbol format of the method (:get, :patch, :post, :put and :delete)
+      #                 :get and :post are automatically inferred by the present of :data; the other
+      #                 cases must be specified.
       #
       def send_request(api_path, params: nil, data: nil, multipage: false, http_method: nil)
         address = api_url(api_path)
@@ -50,7 +52,7 @@ module Geet
         loop do
           response = send_http_request(address, params: params, data: data, http_method: http_method)
 
-          parsed_response = JSON.parse(response.body)
+          parsed_response = JSON.parse(response.body) if response.body
 
           if error?(response)
             formatted_error = decode_and_format_error(parsed_response)
@@ -126,12 +128,14 @@ module Geet
         case http_method
         when :get
           Net::HTTP::Get
+        when :delete
+          Net::HTTP::Delete
         when :patch
           Net::HTTP::Patch
-        when :put
-          Net::HTTP::Put
         when :post
           Net::HTTP::Post
+        when :put
+          Net::HTTP::Put
         else
           raise "Unsupported HTTP method: #{http_method.inspect}"
         end

data/lib/geet/helpers/os_helper.rb

@@ -1,17 +1,24 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'shellwords'
 
 module Geet
   module Helpers
     module OsHelper
-      def os_open(file_or_url)
+      def open_file_with_default_application(file_or_url)
         if `uname`.strip == 'Darwin'
           exec "open #{file_or_url.shellescape}"
         else
           exec "xdg-open #{file_or_url.shellescape}"
         end
       end
+
+      def execute_command(description, *command_tokens)
+        system(*command_tokens.map(&:shellescape))
+
+        raise "Error during #{description} (exit status: #{$CHILD_STATUS.exitstatus})" if !$CHILD_STATUS.success?
+      end
     end
   end
 end

data/lib/geet/resources/edit_summary_template.md

@@ -0,0 +1,7 @@
+
+
+------------------------ >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;
+the separator and any line below are ignored.

data/lib/geet/services/create_gist.rb

@@ -24,7 +24,7 @@ module Geet
         if no_browse
           output.puts "Gist address: #{gist.link}"
         else
-          os_open(gist.link)
+          open_file_with_default_application(gist.link)
         end
       end
     end

data/lib/geet/services/create_issue.rb

@@ -46,7 +46,7 @@ module Geet
         if no_open_issue
           output.puts "Issue address: #{issue.link}"
         else
-          os_open(issue.link)
+          open_file_with_default_application(issue.link)
         end
 
         issue

data/lib/geet/services/create_pr.rb

@@ -12,7 +12,10 @@ module Geet
       #   :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, **)
+      def execute(
+        repository, title, description, label_patterns: nil, milestone_pattern: nil, reviewer_patterns: nil,
+        no_open_pr: nil, output: $stdout, **
+      )
         labels_thread = select_labels(repository, label_patterns, output) if label_patterns
         milestone_thread = find_milestone(repository, milestone_pattern, output) if milestone_pattern
         reviewers_thread = select_reviewers(repository, reviewer_patterns, output) if reviewer_patterns
@@ -36,7 +39,7 @@ module Geet
         if no_open_pr
           output.puts "PR address: #{pr.link}"
         else
-          os_open(pr.link)
+          open_file_with_default_application(pr.link)
         end
 
         pr

data/lib/geet/services/merge_pr.rb

@@ -3,10 +3,11 @@
 module Geet
   module Services
     class MergePr
-      def execute(repository, output: $stdout)
+      def execute(repository, delete_branch: false, output: $stdout)
         merge_head = find_merge_head(repository)
         pr = checked_find_branch_pr(repository, merge_head, output)
         merge_pr(pr, output)
+        do_delete_branch(repository, output) if delete_branch
         pr
       end
 
@@ -32,6 +33,12 @@ module Geet
 
         pr.merge
       end
+
+      def do_delete_branch(repository, output)
+        output.puts "Deleting branch #{repository.current_branch}..."
+
+        repository.delete_branch(repository.current_branch)
+      end
     end
   end
 end

data/lib/geet/version.rb

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

data/spec/integration/create_gist_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'tempfile'
 
@@ -6,7 +8,7 @@ require_relative '../../lib/geet/services/create_gist'
 
 describe Geet::Services::CreateGist do
   let(:repository) { Geet::Git::Repository.new }
-  let(:tempfile) { Tempfile.open('geet_gist') { |file| file << "testcontent" } }
+  let(:tempfile) { Tempfile.open('geet_gist') { |file| file << 'testcontent' } }
 
   it 'should create a public gist' do
     expected_output = <<~STR
@@ -16,7 +18,7 @@ describe Geet::Services::CreateGist do
 
     actual_output = StringIO.new
 
-    VCR.use_cassette("create_gist_public") do
+    VCR.use_cassette('create_gist_public') do
       described_class.new.execute(
         repository, tempfile.path,
         description: 'testdescription', publik: true, no_browse: true, output: actual_output
@@ -34,7 +36,7 @@ describe Geet::Services::CreateGist do
 
     actual_output = StringIO.new
 
-    VCR.use_cassette("create_gist_private") do
+    VCR.use_cassette('create_gist_private') do
       described_class.new.execute(
         repository, tempfile.path,
         description: 'testdescription', no_browse: true, output: actual_output

data/spec/integration/create_issue_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require_relative '../../lib/geet/git/repository'
@@ -24,7 +26,7 @@ describe Geet::Services::CreateIssue do
 
       actual_output = StringIO.new
 
-      actual_created_issue = VCR.use_cassette("create_issue") do
+      actual_created_issue = VCR.use_cassette('create_issue') do
         described_class.new.execute(
           repository, 'Title', 'Description',
           label_patterns: 'bug,invalid', milestone_pattern: '0.0.1', assignee_patterns: 'nald-ts,nald-fr',
@@ -53,8 +55,9 @@ describe Geet::Services::CreateIssue do
 
     actual_output = StringIO.new
 
-    actual_created_issue = VCR.use_cassette("create_issue_upstream") do
-      described_class.new.execute(upstream_repository, 'Title', 'Description', no_open_issue: true, output: actual_output)
+    actual_created_issue = VCR.use_cassette('create_issue_upstream') do
+      create_options = { no_open_issue: true, output: actual_output }
+      described_class.new.execute(upstream_repository, 'Title', 'Description', create_options)
     end
 
     expect(actual_output.string).to eql(expected_output)

data/spec/integration/create_label_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require_relative '../../lib/geet/git/repository'
@@ -17,7 +19,7 @@ describe Geet::Services::CreateLabel do
 
       actual_output = StringIO.new
 
-      actual_created_label = VCR.use_cassette("create_label") do
+      actual_created_label = VCR.use_cassette('create_label') do
         described_class.new.execute(repository, 'my_label', color: 'c64c64', output: actual_output)
       end
 
@@ -34,16 +36,16 @@ describe Geet::Services::CreateLabel do
 
       expected_output_template = <<~STR
         Creating label...
-        Created with color #%s
+        Created with color #%<color>s
       STR
 
       actual_output = StringIO.new
 
-      actual_created_label = VCR.use_cassette("create_label_with_random_color") do
+      actual_created_label = VCR.use_cassette('create_label_with_random_color') do
         described_class.new.execute(repository, 'my_label', output: actual_output)
       end
 
-      expected_output = expected_output_template % actual_created_label.color
+      expected_output = format(expected_output_template, color: actual_created_label.color)
 
       expect(actual_output.string).to eql(expected_output)