bummr 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dfc66045a4cf51578172ac7c875574465d60b019
-  data.tar.gz: 343b2794e4c16c57b938a26a41aa256df41216c3
+SHA256:
+  metadata.gz: 3defa139f960ba6926952a637df79639fa2ba63d42215ea3b6e91036fc2e229b
+  data.tar.gz: c97eef10397acf5441dd7d2ea3330afb9c6e8c98a4aaf1ea33508adb614368bb
 SHA512:
-  metadata.gz: 36acc698fe92f04a82c4158bf7600a9453dc2235cbb58c4a125fd05280eaf8abc60d811d9c8f4675ad29df9b14a55f6043ade5c79842daae6c58c3000487ab37
-  data.tar.gz: e68e9a0212deeb3211904b8549b4e7be67d2eb657bc389faaf964e17c9c7519d007aecac6d848a1196c8eae736430b6dc5d733b630088098241dd6a2a2ceb063
+  metadata.gz: 3ec5cb5fde39dabc1dc008fd28cbba5cc936a32785ce1605085b9db4e1aabcb04b866a2d8b0e8fa497c45c58507f4268841c3d1ffc91199e266a6a3389aaac72
+  data.tar.gz: 404c1a9e7aecf4140cbdd9fa5137b333731047a6eac06dd0ea018317db94f1926ab28a72dc5323127d49857d90ea52a42c7a449654edc8257ceb22aea7133015

data/.circleci/config.yml

@@ -0,0 +1,24 @@
+version: 2.1,
+orbs:
+  ruby: circleci/ruby@1.1.2
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:2.7-node
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: bundle install
+      - run:
+          name: Test
+          command: bundle exec rake
+      - run:
+          name:
+            Report coverage to codeclimate
+          command: bundle exec codeclimate-test-reporter
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.7.2

data/README.md

@@ -1,28 +1,39 @@
 # Bummr
 
-[![CircleCI](https://circleci.com/gh/lpender/bummr.svg?style=svg)](https://circleci.com/gh/lpender/bummr)
+[![CircleCI](https://circleci.com/gh/lpender/bummr.svg?style=shield)](https://circleci.com/gh/lpender/bummr)
 [![Code Climate](https://codeclimate.com/github/lpender/bummr/badges/gpa.svg)](https://codeclimate.com/github/lpender/bummr)
-[![Test Coverage](https://codeclimate.com/github/lpender/bummr/badges/coverage.svg)](https://codeclimate.com/github/lpender/bummr/coverage)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/52d6651bf8cd5e729b11/test_coverage)](https://codeclimate.com/github/lpender/bummr/test_coverage)
 
 Updating Gems one by one is a bumm(e)r: especially when one gem causes your build
 to fail.
 
-Gems should be updated in [separate commits](http://ilikestuffblog.com/2012/07/01/you-should-update-one-gem-at-a-time-with-bundler-heres-how/).
+Gems should be updated in [separate commits](https://thoughtbot.com/blog/keep-your-gems-up-to-date).
 
 The bummr gem allows you to automatically update all gems which pass your
 build in separate commits, and logs the name and sha of each gem that fails.
 
-Bummr assumes you have good test coverage and follow a [pull-request workflow]
-with `master` as your default branch.
+Bummr assumes you have good test coverage and follow a [pull-request workflow].
 
-Please note that this gem is *alpha* stage and may have bugs.
+By default, bummr will assume your base branch is named `master`. If you would
+like to designate a different base branch, you can set the `BASE_BRANCH`
+environment variable: `export BASE_BRANCH='main'`
+
+## Compatibility
+
+| Bundler Version | Bummr Version |
+| --------------- | ------------- |
+| <= 2.1          | <= 0.6.0      |
+| >= 2.2          | >= 1.0.0      |
 
-## Installation
+## Setup
 
 ```bash
 $ gem install bummr
 ```
 
+To run headless (skip interactive rebasing/confirmation), use
+`BUMMR_HEADLESS=true bundle exec bummr update`.
+
 By default, bummr will use `bundle exec rake` to run your build.
 
 To customize your build command, `export BUMMR_TEST="./bummr-build.sh"`
@@ -30,13 +41,9 @@ To customize your build command, `export BUMMR_TEST="./bummr-build.sh"`
 If you prefer, you can [run the build more than once], to protect against
 brittle tests and false positives.
 
-By default, bummr will assume your base branch is named `master`. If you would
-like to designate a different base branch, you can set the `BASE_BRANCH`
-environment variable: `export BASE_BRANCH='develop'`
-
 [run the build more than once]: https://gist.github.com/lpender/f6b55e7f3649db3b6df5
 
-## Usage:
+## Usage
 
 Using bummr can take anywhere from a few minutes to several hours, depending
 on the number of outdated gems you have and the number of tests in your test
@@ -46,26 +53,33 @@ For the purpose of these instructions, we are assuming that your base branch is
 `master`. If you would like to specify a different base branch, see the
 instructions in the Installation section of this README.
 
-- After installing, create a new, clean branch off of your `master` branch.
+- After installing, create a new, clean branch off of your main branch.
 - Run `bummr update`. This may take some time.
 - `Bummr` will give you the opportunity to interactively rebase your branch
-  before running the tests. Delete any commits for gems which you don't want
-  to update and close the file.
+  before running the tests. Careful.
 - At this point, you can leave `bummr` to work for some time.
-- If your build fails, `bummr` will attempt to automatically remove breaking
-  commits, until the build passes, logging any failures to `/log/bummr.log`.
-- Once your build passes, open a pull-request and merge it to your `master` branch.
+- If your build fails, `bummr` will notify you of failures, logging the failures to
+  `log/bummr.log`. At this point it is recommended that you lock that gem version in
+  your Gemfile and start the process over from the top. Alternatively, you may wish
+  to implement code changes which fix the problem.
+- Once your build passes, open a pull-request and merge it to your main branch.
 
 ##### `bummr update`
 
-- Finds all your outdated gems
-- Updates them each individually, using `bundle update --source #{gemname}`
-- Commits each gem update separately, with a commit message like:
 - Options:
+
   - `--all` to include indirect dependencies (`bummr` defaults to direct dependencies only)
   - `--group` to update only gems from a specific group (i.e. `test`, `development`)
+  - `--gem` to update only a specific gem (i.e. `tzinfo`)
+
+- Finds all your outdated gems
+- Updates them each individually, using `bundle update --source #{gemname}`. To use a less
+  conservative update strategy, start `bummr update` with the `--all` option.
+- Commits each gem update separately, with a commit message like:
 
-`Update gemname from 0.0.1 to 0.0.2`
+```
+Update gemname from 0.0.1 to 0.0.2
+```
 
 - Runs `git rebase -i master` to allow you the chance to review and make changes.
 - Runs `bummr test`
@@ -78,9 +92,9 @@ instructions in the Installation section of this README.
 ##### `bummr bisect`
 
 - `git bisect`s against master.
-- Finds the bad commit and attempts to remove it.
+- Upon finding the bad commit, runs `git bisect reset` and notifies the developer on
+  how best to proceed.
 - Logs the bad commit in `log/bummr.log`.
-- Runs `bummr test`.
 
 ## Notes
 
@@ -89,12 +103,6 @@ instructions in the Installation section of this README.
 - Once the build passes, you can push your branch and create a pull-request!
 - You may wish to `tail -f log/bummr.log` in a separate terminal window so you
   can see which commits are being removed.
-- Bummr conservatively updates gems using `bundle update --source gemname`
-- Bummr automatically rebases out commits which fail the build using an "ours"
-  merge strategy.
-- Bummr may not be able to remove the bad commit due to a merge conflict, in
-  which case you will have to remove it manually, continue the rebase, and
-  run `bummr test` again.
 
 ## License
 
@@ -109,9 +117,9 @@ wish to use it with.
 
 `rake` will run the suite of unit tests.
 
-I'd like to create feature tests, but because Bummr relies on command line
-manipulations which need to be doubled, I'm waiting on [this
-issue](https://github.com/bjoernalbers/aruba-doubles/issues/5)
+The suite relies on Oliver Peate's [jet
+black](https://github.com/odlp/jet_black) testing library for command line feature
+tests.
 
 ## Thank you!
 

data/bummr.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "guard"
+  spec.add_development_dependency "jet_black", "~> 0.3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-remote"
   spec.add_development_dependency "pry-nav"

data/lib/bummr/bisecter.rb

@@ -20,7 +20,7 @@ module Bummr
           end
 
           if line == "bisect run success\n"
-            Bummr::Rebaser.instance.remove_commit(sha)
+            Bummr::Remover.instance.remove_commit(sha)
           end
         end
       end

data/lib/bummr/check.rb

@@ -1,6 +1,7 @@
 module Bummr
   class Check < Thor
     include Singleton
+    include Bummr::Prompt
 
     desc "check", "Run automated checks to see if bummr can be run"
     def check(fullcheck=true)

data/lib/bummr/cli.rb

@@ -1,28 +1,40 @@
 TEST_COMMAND = ENV["BUMMR_TEST"] || "bundle exec rake"
 BASE_BRANCH = ENV["BASE_BRANCH"] || "master"
+HEADLESS = ENV["BUMMR_HEADLESS"] || false
 
 module Bummr
   class CLI < Thor
     include Bummr::Log
+    include Bummr::Prompt
+    include Bummr::Scm
 
     desc "check", "Run automated checks to see if bummr can be run"
     def check(fullcheck=true)
       Bummr::Check.instance.check(fullcheck)
     end
 
-    desc "update", "Update outdated gems, run tests, bisect if tests fail"
+    desc "update",
+      "Update outdated gems, run tests, bisect if tests fail\n\n" +
+      "--all: Update indirect dependencies\n" +
+      "--group: Specify a group from the Gemfile to update\n" +
+      "--gem: Specify a specific gem to update\n" +
+      "\n"
+
+
     method_option :all, type: :boolean, default: false
     method_option :group, type: :string
+    method_option :gem, type: :string
+
     def update
-      ask_questions
+      system("bundle install")
+      display_info
 
       if yes? "Are you ready to use Bummr? (y/n)"
         check
         log("Bummr update initiated #{Time.now}")
-        system("bundle")
 
         outdated_gems = Bummr::Outdated.instance.outdated_gems(
-          all_gems: options[:all], group: options[:group]
+          all_gems: options[:all], group: options[:group], gem: options[:gem]
         )
 
         if outdated_gems.empty?
@@ -30,7 +42,7 @@ module Bummr
         else
           Bummr::Updater.new(outdated_gems).update_gems
 
-          system("git rebase -i #{BASE_BRANCH}")
+          git.rebase_interactive(BASE_BRANCH)
           test
         end
       else
@@ -41,15 +53,17 @@ module Bummr
     desc "test", "Test for a successful build and bisect if necesssary"
     def test
       check(false)
-      system "bundle"
-      puts "Testing the build!".color(:green)
 
-      if system(TEST_COMMAND) == false
-        bisect
-      else
-        puts "Passed the build!".color(:green)
-        puts "See log/bummr.log for details".color(:yellow)
-        system("cat log/bummr.log")
+      if yes? "Do you want to test the build now? (y/n)"
+        system "bundle install"
+        puts "Testing the build!".color(:green)
+
+        if system(TEST_COMMAND) == false
+          bisect
+        else
+          puts "Passed the build!".color(:green)
+          puts "See log/bummr.log for details".color(:yellow)
+        end
       end
     end
 
@@ -57,20 +71,42 @@ module Bummr
     def bisect
       check(false)
 
-      Bummr::Bisecter.instance.bisect
+      if yes? "Would you like to bisect in order to find which gem is causing " +
+              "your build to break? (y/n)"
+        Bummr::Bisecter.instance.bisect
+      end
+    end
+
+    desc "remove_commit", "Remove a commit from the history"
+    def remove_commit(sha)
+      Bummr::Remover.instance.remove_commit(sha)
     end
 
     private
 
-    def ask_questions
+    def display_info
+      puts "Bummr #{VERSION}"
       puts "To run Bummr, you must:"
-      puts "- Be in the root path of a clean git branch off of #{BASE_BRANCH}"
+      puts "- Be in the root path of a clean git branch off of " + "#{BASE_BRANCH}".color(:yellow)
       puts "- Have no commits or local changes"
       puts "- Have a 'log' directory, where we can place logs"
       puts "- Have your build configured to fail fast (recommended)"
       puts "- Have locked any Gem version that you don't wish to update in your Gemfile"
       puts "- It is recommended that you lock your versions of `ruby` and `rails` in your `Gemfile`"
-      puts "Your test command is: '#{TEST_COMMAND}'"
+      puts "\n"
+      puts "Your test command is: " + "'#{TEST_COMMAND}'".color(:yellow)
+      puts "\n"
+      print_received_options
+    end
+
+    def print_received_options
+      puts "Bummr will run with the following options:"
+
+      options.each do |key, value|
+        puts "--#{key.color(:yellow)}: #{value}"
+      end
+
+      puts "\nRun `#{"bummr help update".color(:yellow)}` for more information.\n\n"
     end
   end
 end

data/lib/bummr/git.rb

@@ -0,0 +1,31 @@
+module Bummr
+  class Git
+    include Singleton
+    include Log
+
+    def initialize
+      @git_commit = ENV.fetch("BUMMR_GIT_COMMIT") { "git commit" }
+    end
+
+    def add(files)
+      system("git add #{files}")
+    end
+
+    def commit(message)
+      log "Commit: #{message}".color(:green)
+      system("#{git_commit} -m '#{message}'")
+    end
+
+    def rebase_interactive(sha)
+      system("git rebase -i #{BASE_BRANCH}") unless HEADLESS
+    end
+
+    def message(sha)
+      `git log --pretty=format:'%s' -n 1 #{sha}`
+    end
+
+    private
+
+    attr_reader :git_commit
+  end
+end

data/lib/bummr/outdated.rb

@@ -1,5 +1,6 @@
 require 'open3'
 require 'singleton'
+require 'bundler'
 
 module Bummr
   class Outdated
@@ -9,8 +10,10 @@ module Bummr
       results = []
 
       bundle_options =  ""
+      bundle_options << " --parseable" if Gem::Version.new(Bundler::VERSION) >= Gem::Version.new("2")
       bundle_options << " --strict" unless options[:all_gems]
       bundle_options << " --group #{options[:group]}" if options[:group]
+      bundle_options << " #{options[:gem]}" if options[:gem]
 
       Open3.popen2("bundle outdated" + bundle_options) do |_std_in, std_out|
         while line = std_out.gets
@@ -27,7 +30,7 @@ module Bummr
     end
 
     def parse_gem_from(line)
-      regex = / \* (.*) \(newest (\d[\d\.]*\d)[,\s] installed (\d[\d\.]*\d)[\),\s]/.match line
+      regex = /(?:\s+\* )?(.*) \(newest (\d[\d\.]*\d)[,\s] installed (\d[\d\.]*\d)[\),\s]/.match line
 
       unless regex.nil?
         { name: regex[1], newest: regex[2], installed: regex[3] }

data/lib/bummr/prompt.rb

@@ -0,0 +1,14 @@
+module Bummr
+  module Prompt
+    def yes?(*args)
+      headless? || super
+    end
+
+    private
+
+    def headless?
+      HEADLESS == true ||
+        HEADLESS == "true"
+    end
+  end
+end

data/lib/bummr/remover.rb

@@ -0,0 +1,26 @@
+module Bummr
+  class Remover < Thor
+    include Singleton
+    include Log
+    include Scm
+
+    desc "remove_commit", "Remove a commit from the history"
+    def remove_commit(sha)
+      log "Bad commit: #{git.message(sha)}, #{sha}".color(:red)
+      log "Resetting..."
+      system("git bisect reset")
+
+      message = "\nThe commit:\n\n `#{sha} #{git.message(sha)}`\n\n" +
+        "Is breaking the build.\n\n" +
+        "Please do one of the following: \n\n" +
+        " 1. Update your code to work with the latest version of this gem.\n\n" +
+        " 2. Perform the following steps to lock the gem version:\n\n" +
+        "    - `git reset --hard master`\n" +
+        "    - Lock the version of this Gem in your Gemfile.\n" +
+        "    - Commit the changes.\n" +
+        "    - Run `bummr update` again.\n\n"
+
+      puts message.color(:yellow)
+    end
+  end
+end

data/lib/bummr/scm.rb

@@ -0,0 +1,9 @@
+module Bummr
+  module Scm
+    private
+
+    def git
+      Bummr::Git.instance
+    end
+  end
+end