hubmerge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39534401c1ee1e7c7251b9fa4d1a539d76e7bd5bb32da1c7177789b13f5ce119
+  data.tar.gz: efa9b1237baeeec7cd9b8458d142b8d7a3c14797b82b9d6dac7d3bc2f414df06
+SHA512:
+  metadata.gz: 16e70d1e9830a7337554bbc7d6a03945056cf88f1710cb333f7e124866414ab3cccf2ae017998a20983154a9ccd688240edafe1e5a9f581fec1bb2dd1910f497
+  data.tar.gz: 55c8416a9ffce1d278635656b31abb94ebfc1d56534922ec5f08463ec7a7440100e74d5d1ca35a34b3da6711dad67d1fc1faab1453cbe360bf701f1d81d0a83a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hubmerge.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    hubmerge (0.0.1)
+      octokit (~> 4.0)
+      tty-prompt (~> 0.18)
+      tty-spinner (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    equatable (0.5.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    necromancer (0.4.0)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    timers (4.3.0)
+    tty-color (0.4.3)
+    tty-cursor (0.6.1)
+    tty-prompt (0.18.1)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      timers (~> 4.0)
+      tty-cursor (~> 0.6.0)
+      tty-reader (~> 0.5.0)
+    tty-reader (0.5.0)
+      tty-cursor (~> 0.6.0)
+      tty-screen (~> 0.6.4)
+      wisper (~> 2.0.0)
+    tty-screen (0.6.5)
+    tty-spinner (0.9.0)
+      tty-cursor (~> 0.6.0)
+    wisper (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  hubmerge!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Paul Kuruvilla
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# HubMerge
+
+HubMerge helps you merge multiple GitHub Pull Requests with a friendly
+[TUI](https://en.wikipedia.org/wiki/Text-based_user_interface).
+
+## Installation
+
+```ruby
+gem install hubmerge
+```
+
+To authenticate with GitHub, HubMerge expects a `GITHUB_TOKEN` environment
+variable to be set. Visit [Github > Settings > Personal Access
+Tokens](https://github.com/settings/tokens) to create one. If this is not set,
+HubMerge will prompt for the value.
+
+## Usage
+
+HubMerge accepts parameters interactively. Just run `hubmerge` to get started.
+
+    $ hubmerge
+
+You can provide parameters via the CLI too (good to store in your shell history if you do this often!)
+
+    $ hubmerge --repo "rails/rails" --query "author:app/dependabot"
+
+By default, `hubmerge` will always ask for confirmation before merging PRs. If you want to avoid this, use the `--yes` flag. This is useful if you're running `hubmerge` as part of a script.
+
+## Advanced Usage
+
+HubMerge's primary use case is to merge PRs in a single repository. To support
+advanced use cases, HubMerge allows using any arbitrary Github [search
+filter](https://help.github.com/en/articles/searching-issues-and-pull-requests).
+
+When the `--repo` flag is omitted, the query is directly passed in as a search filter (prefixed with `is:pr is:open`). One can now embed repo/org/user filters into the search query itself.
+
+_Note_: This isn't supported in interactive mode, only via the CLI.
+
+**Multiple repositories**
+
+To merge PRs across multiple repositories:
+
+    $ hubmerge --query "repo:rails/rails repo:sinatra/sinatra author:app/dependabot"
+
+**Organization wide merges**
+
+To merge PRs across an entire org:
+
+    $ hubmerge --query "org:rails author:app/dependabot"
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rohitpaulk/hubmerge.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hubmerge"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/hubmerge

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "hubmerge"
+exit(HubMerge::Executable.new.run(ENV, ARGV))

data/hubmerge.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hubmerge/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hubmerge"
+  spec.version       = HubMerge::VERSION
+  spec.authors       = ["Paul Kuruvilla"]
+  spec.email         = ["rohitpaulk@gmail.com"]
+
+  spec.summary       = "Merge GitHub PRs in bulk!"
+  spec.description   = "A gem to merge multiple GitHub PRs that match a search query"
+  spec.homepage      = "https://github.com/rohitpaulk/hubmerge"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "octokit",  "~> 4.0"
+  spec.add_dependency "tty-prompt", "~> 0.18"
+  spec.add_dependency "tty-spinner", "~> 0.9"
+end

data/lib/hubmerge/merger.rb

@@ -0,0 +1,60 @@
+module HubMerge
+  class RetryError < RuntimeError
+  end
+
+  class UnmergeableError < RuntimeError
+  end
+
+  class Merger
+    MERGEABILITY_RETRY_COUNT = 5
+    MERGEABILITY_RETRY_DELAY = 5
+
+    def self.approve_if_not_approved(gh_client, pr)
+      repo = repo_from_pr(pr)
+      reviews = gh_client.pull_request_reviews(repo, pr.number)
+      unless reviews.find { |review| review.state == "APPROVED" }
+        gh_client.create_pull_request_review(repo, pr.number, event: "APPROVE")
+      end
+    end
+
+    # Throws UnmergeableError if not mergeable.
+    # Returns true if mergeable.
+    #
+    # Yes, this interface is weird. Makes it easier to deal with
+    # spinners.
+    def self.check_mergeability(gh_client, pr)
+      repo = repo_from_pr(pr)
+
+      with_retries(MERGEABILITY_RETRY_COUNT, MERGEABILITY_RETRY_DELAY) do
+        pr = gh_client.pull_request(repo, pr.number)
+        if pr.mergeable
+          return true
+        elsif pr.mergeable_state == "unknown"
+          raise RetryError
+        else
+          raise UnmergeableError.new(pr.mergeable_state)
+        end
+      end
+    end
+
+    def self.merge(gh_client, pr)
+      repo = repo_from_pr(pr)
+      gh_client.merge_pull_request(repo, pr.number)
+    end
+
+    def self.repo_from_pr(pr)
+      # GitHub doesn't return a full repository name in the response, only way
+      # to avoid an extra API call is to parse the `repository_url` string
+      pr.repository_url.sub("https://api.github.com/repos/", "")
+    end
+
+    def self.with_retries(n_tries, delay)
+      n_tries.times do
+        return yield
+      rescue RetryError
+        sleep delay
+        next
+      end
+    end
+  end
+end

data/lib/hubmerge/options.rb

@@ -0,0 +1,55 @@
+require "optparse"
+
+module HubMerge
+  class Options
+    def self.all
+      {
+        repo: {
+          short_switch: "-r",
+          long_switch: "--repo ORG/REPONAME",
+          type: String,
+          description: "Github repository to search for PRs in (example: rails/rails)",
+        },
+
+        query: {
+          short_switch: "-q",
+          long_switch: "--query ORG/REPONAME",
+          type: String,
+          description: "GitHub search query to run to find PRs (example: 'author:app/dependabot')",
+        },
+
+        merge_without_confirmation: {
+          short_switch: "-y",
+          long_switch: "--yes",
+          type: :flag,
+          description: "Merge without confirmation from user (default: false)",
+        },
+      }
+    end
+
+    def self.parse(argv)
+      parsed = {}
+      opt_parser = OptionParser.new
+
+      all.each do |key, params|
+        if params[:type] == :flag
+          opt_parser.on(
+            params[:short_switch],
+            params[:long_switch],
+            params[:description]
+          ) { |v| parsed[key] = v }
+        else
+          opt_parser.on(
+            params[:short_switch],
+            params[:long_switch],
+            params[:type],
+            params[:description]
+          ) { |v| parsed[key] = v }
+        end
+      end
+
+      opt_parser.parse(argv)
+      parsed
+    end
+  end
+end

data/lib/hubmerge/prompts.rb

@@ -0,0 +1,47 @@
+module HubMerge
+  class Prompts
+    def self.repo(github_client)
+      TTY::Prompt.new.ask(
+        "Enter a GitHub repository to look for PRs in: (example: 'rails/rails')"
+      )
+    end
+
+    def self.query
+      TTY::Prompt.new.ask(
+        "Enter a GitHub search query to find PRs (example: 'in:title automerge')",
+        default: "author: app/dependabot"
+      )
+    end
+
+    def self.github_token
+      github_token = TTY::Prompt.new.mask(
+        "Enter a github access token: (create one at https://github.com/settings/tokens)"
+      )
+      puts <<~EOF
+        To make this easier next time, you can set the `GITHUB_TOKEN` environment variable
+      EOF
+      github_token
+    end
+
+    def self.pull_requests_to_merge(pull_requests)
+      choices = pull_requests.map { |pr|
+        {
+          name: "##{pr.number} - #{pr.title}",
+          value: pr,
+        }
+      }
+
+      TTY::Prompt.new.multi_select(
+        "Which of these pull requests do you want to merge? (SPACE to select, ENTER to finalize)",
+        choices,
+        echo: false,
+        per_page: 20,
+        filter: true
+      )
+    end
+
+    def self.say(text)
+      puts text
+    end
+  end
+end

data/lib/hubmerge/spinner.rb

@@ -0,0 +1,43 @@
+module HubMerge
+  class SpinnerError < RuntimeError
+  end
+
+  class Spinner
+    def initialize
+      @active_parent_spinner = nil
+    end
+
+    def with_spinner(text)
+      spinner = TTY::Spinner.new(text)
+      spinner.auto_spin
+      yield
+    ensure
+      spinner.stop
+    end
+
+    def with_parent(text)
+      @active_parent_spinner = TTY::Spinner::Multi.new(text)
+      yield
+    ensure
+      @active_parent_spinner = nil
+    end
+
+    def with_child(text)
+      ensure_active_parent!
+
+      spinner = @active_parent_spinner.register(text)
+      spinner.auto_spin
+      result = yield
+      spinner.success
+      result
+    rescue SpinnerError => e
+      spinner.error(e.to_s)
+    end
+
+    def ensure_active_parent!
+      unless !!@active_parent_spinner
+        raise "#with_parent not called!"
+      end
+    end
+  end
+end

data/lib/hubmerge/version.rb

@@ -0,0 +1,3 @@
+module HubMerge
+  VERSION = "0.0.1"
+end

data/lib/hubmerge.rb

@@ -0,0 +1,108 @@
+require "octokit"
+require "tty-prompt"
+require "tty-spinner"
+
+require "hubmerge/version"
+
+require "hubmerge/options"
+require "hubmerge/prompts"
+require "hubmerge/merger"
+require "hubmerge/spinner"
+
+module HubMerge
+  class Executable
+    def initialize(opts = {})
+      # Overrides only used in tests
+      @spinner = opts[:spinner] || Spinner.new
+      @prompts = opts[:prompts] || Prompts
+      @github_client = opts[:github_client]
+      @merger = opts[:merger] || Merger
+    end
+
+    def run(env, argv)
+      check_or_prompt_github_token(env)
+      opts = Options.parse(argv)
+
+      query = check_or_prompt_search_query(opts)
+      prs = search_pull_requests(query)
+      if prs.empty?
+        @prompts.say("No pull requests found. Maybe try refining your search query?")
+        return 1
+      end
+
+      prs_to_merge = if opts[:merge_without_confirmation]
+        prs
+      else
+        @prompts.pull_requests_to_merge(prs)
+      end
+
+      if prs_to_merge.empty?
+        @prompts.say("No pull requests selected, aborting")
+        return 1
+      else
+        merge_pull_requests(prs_to_merge)
+        return 0
+      end
+    end
+
+    private
+
+    def merge_pull_requests(prs_to_merge)
+      total = prs_to_merge.count
+      prs_to_merge.each_with_index do |pr, index|
+        mergeable = false
+        @spinner.with_parent("[:spinner] PR ##{pr.number} (#{index + 1}/#{total})") do
+          mergeable = @spinner.with_child("[:spinner] Checking mergeability") {
+            begin
+              @merger.check_mergeability(github_client, pr)
+            rescue UnmergeableError => e
+              raise SpinnerError("(Mergability: #{e})")
+            end
+
+            true
+          }
+
+          next unless mergeable
+
+          @spinner.with_child("[:spinner] Approving") do
+            @merger.approve_if_not_approved(github_client, pr)
+          end
+
+          @spinner.with_child("[:spinner] Merging") do
+            @merger.merge(github_client, pr)
+          end
+        end
+      end
+    end
+
+    def search_pull_requests(query)
+      @spinner.with_spinner("[:spinner] Searching for PRs...") do
+        github_client.search_issues(query).items
+      end
+    end
+
+    def check_or_prompt_search_query(opts)
+      if opts.key?(:query) && opts.key?(:repo)
+        "is:pr is:open repo:#{opts[:repo]} #{opts[:query]}"
+      elsif opts.key?(:query)
+        "is:pr is:open #{opts[:query]}"
+      else
+        repo = opts[:repo] || @prompts.repo(github_client)
+        query = @prompts.query
+        "is:pr is:open repo:#{repo} #{query}"
+      end
+    end
+
+    def check_or_prompt_github_token(env)
+      @github_token = if env.key?("GITHUB_TOKEN")
+        env.fetch("GITHUB_TOKEN")
+      else
+        @prompts.github_token
+      end
+    end
+
+    def github_client
+      @github_client ||= Octokit::Client.new(access_token: @github_token)
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: hubmerge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Kuruvilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A gem to merge multiple GitHub PRs that match a search query
+email:
+- rohitpaulk@gmail.com
+executables:
+- hubmerge
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hubmerge
+- hubmerge.gemspec
+- lib/hubmerge.rb
+- lib/hubmerge/merger.rb
+- lib/hubmerge/options.rb
+- lib/hubmerge/prompts.rb
+- lib/hubmerge/spinner.rb
+- lib/hubmerge/version.rb
+homepage: https://github.com/rohitpaulk/hubmerge
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Merge GitHub PRs in bulk!
+test_files: []