bummr 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de386c3a0c041b1dc02b6fc5d75f2b6f3b473624
-  data.tar.gz: 1dc533f03683112f7604c8fb80ad236ebd55ce4e
+  metadata.gz: 389815b5180dc129c7eabe7f2d2a4652c0266a7e
+  data.tar.gz: 55dea3cebd0100b8a484a8994ef4657765a27b84
 SHA512:
-  metadata.gz: a837b59236235d1733ad24a770f63cf2b2b6c48739a1c538fc0ee2de807bf10c37824ebef30a5dc718b8e3d0cc9c57a75d7de273873824a36e395fdebbe6ecc1
-  data.tar.gz: 437a0facee5cf00915827b57604f3202a82104beccc07b867459b677856e0d10cc1edbeb6c0dfaa036723b343bb35844c1471969b474aee1eb5d3140724eacc8
+  metadata.gz: 47ac269d5bffa3e9f45d83eabe2befb31f5ad932e18aa5cdd3cf817b3bca3153c15166e12f2f5489682d3c058bbce77579fe68e4e7a3126a0b21acf7885182de
+  data.tar.gz: f953d5673838a0c6f00f6785ec65745fbac5f550285796d061fdf2221c4a8baff9d40bfda5d8c877d3530a34fcc6cd0e44da6e5db0bae9d9929aa8f3bf698a8d

data/README.md

@@ -15,7 +15,7 @@ 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.
 
-Please note that this gem is *alpha* stage and may have bugs.
+Please note that this gem is _alpha_ stage and may have bugs.
 
 ## Installation
 
@@ -23,6 +23,9 @@ Please note that this gem is *alpha* stage and may have bugs.
 $ 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"`
@@ -52,15 +55,16 @@ instructions in the Installation section of this README.
   before running the tests. Careful.
 - At this point, you can leave `bummr` to work for some time.
 - 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 
+  `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 `master` branch.
 
 ##### `bummr update`
 
 - Finds all your outdated gems
-- Updates them each individually, using `bundle update --source #{gemname}`
+- 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:
 - Options:
   - `--all` to include indirect dependencies (`bummr` defaults to direct dependencies only)
@@ -79,9 +83,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
 
@@ -90,12 +94,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
 
@@ -110,9 +108,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.rb

@@ -1,5 +1,6 @@
 # grouped by dependency order than alpha
 require 'bummr/log'
+require 'bummr/prompt'
 require "bummr/scm"
 require 'rainbow/ext/string'
 require 'open3'

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,9 +1,11 @@
 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"
@@ -23,7 +25,7 @@ module Bummr
 
     def update
       system("bundle install")
-      ask_questions
+      display_info
 
       if yes? "Are you ready to use Bummr? (y/n)"
         check
@@ -80,7 +82,7 @@ module Bummr
 
     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}".color(:yellow)

data/lib/bummr/git.rb

@@ -17,7 +17,7 @@ module Bummr
     end
 
     def rebase_interactive(sha)
-      system("git rebase -i #{BASE_BRANCH}")
+      system("git rebase -i #{BASE_BRANCH}") unless HEADLESS
     end
 
     def message(sha)

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

@@ -18,8 +18,7 @@ module Bummr
         "    - `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" +
-        "Lord Bummr\n\n"
+        "    - Run `bummr update` again.\n\n"
 
       puts message.color(:yellow)
     end

data/lib/bummr/updater.rb

@@ -36,7 +36,9 @@ module Bummr
         log("#{gem[:name]} not updated from #{gem[:installed]} to latest: #{gem[:newest]}")
       end
 
-      git.add("Gemfile Gemfile.lock vendor/cache")
+      git.add("Gemfile")
+      git.add("Gemfile.lock")
+      git.add("vendor/cache")
       git.commit(message)
     end
 

data/lib/bummr/version.rb

@@ -1,3 +1,3 @@
 module Bummr
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/black_box/bummr_update_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+require "jet_black"
+
+describe "bummr update command" do
+  let(:session) { JetBlack::Session.new(options: { clean_bundler_env: true }) }
+  let(:bummr_gem_path) { File.expand_path("../../", __dir__) }
+
+  it "updates outdated gems" do
+    session.create_file "Gemfile", <<~RUBY
+      source "https://rubygems.org"
+      gem "rake", "~> 10.0"
+      gem "bummr", path: "#{bummr_gem_path}"
+    RUBY
+
+    session.create_file "Rakefile", <<~RUBY
+      task :default do
+        puts "Hello from the Rakefile"
+      end
+    RUBY
+
+    expect(session.run("bundle install --retry 3")).
+      to be_a_success.and have_stdout(/bummr .* from source/)
+
+    # Now allow newer versions of Rake to be installed
+    session.run("sed -i.bak 's/, \"~> 10.0\"//' Gemfile")
+
+    session.run("mkdir -p log")
+
+    expect(session.run("git init .")).
+      to be_a_success.and have_stdout("Initialized empty Git repository")
+
+    session.run("git config user.name 'Bummr Test'")
+    session.run("git config user.email 'test@example.com'")
+
+    expect(session.run("git add . && git commit -m 'Initial commit'")).
+      to be_a_success.and have_stdout("Initial commit")
+
+    session.run("git checkout -b bummr-branch")
+
+    update_result = session.run(
+      "bundle exec bummr update",
+      stdin: "y\ny\ny\n",
+      env: { EDITOR: nil, BUMMR_HEADLESS: "true" },
+    )
+
+    rake_gem_updated = /Update rake from 10\.\d\.\d to 1[1-9]\.\d\.\d/
+
+    expect(update_result).
+      to be_a_success.and have_stdout(rake_gem_updated)
+
+    expect(update_result).to have_stdout("Passed the build!")
+
+    expect(session.run("git log")).
+      to be_a_success.and have_stdout(rake_gem_updated)
+
+    expect(session.run("bundle show")).
+      to be_a_success.and have_stdout(/rake\s\(1[1-9]/)
+  end
+end

data/spec/lib/cli_spec.rb

@@ -30,7 +30,7 @@ describe Bummr::CLI do
         updater = double
         allow(updater).to receive(:update_gems)
 
-        expect(cli).to receive(:ask_questions)
+        expect(cli).to receive(:display_info)
         expect(cli).to receive(:yes?).and_return(true)
         expect(cli).to receive(:check)
         expect(cli).to receive(:log)
@@ -45,7 +45,7 @@ describe Bummr::CLI do
           allow_any_instance_of(Bummr::Outdated).to receive(:outdated_gems)
             .and_return []
 
-          expect(cli).to receive(:ask_questions)
+          expect(cli).to receive(:display_info)
           expect(cli).to receive(:yes?).and_return(true)
           expect(cli).to receive(:check)
           expect(cli).to receive(:log)
@@ -95,6 +95,24 @@ describe Bummr::CLI do
         end
       end
     end
+
+    context "when in headless mode" do
+      context "and there are no outdated gems" do
+        it "informs that there are no outdated gems" do
+          stub_const("HEADLESS", true)
+          allow_any_instance_of(Bummr::Outdated).to receive(:outdated_gems)
+            .and_return []
+
+          expect(cli).to receive(:display_info)
+          expect(cli).to receive(:check)
+          expect(cli).to receive(:log)
+          expect(cli).to receive(:system).with("bundle install")
+          expect(cli).to receive(:puts).with("No outdated gems to update".color(:green))
+
+          cli.update
+        end
+      end
+    end
   end
 
   describe "#test" do

data/spec/lib/prompt_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Bummr::Prompt do
+  let(:parent_class) do
+    Class.new do
+      def yes?(message)
+        "called parent with #{message}"
+      end
+    end
+  end
+  let(:object_class) { Class.new(parent_class) }
+  let(:object) { object_class.new }
+
+  before do
+    object.extend(Bummr::Prompt)
+  end
+
+  describe "#yes?" do
+    context "when HEADLESS is false" do
+      it "calls super" do
+        stub_const("HEADLESS", false)
+
+        expect(
+          object.yes?("foo")
+        ).to eq "called parent with foo"
+      end
+    end
+
+    context "when HEADLESS is nil" do
+      it "calls super" do
+        stub_const("HEADLESS", nil)
+
+        expect(
+          object.yes?("foo")
+        ).to eq "called parent with foo"
+      end
+    end
+
+    context "when HEADLESS is true" do
+      it "returns true and skips asking for user input" do
+        stub_const("HEADLESS", true)
+
+        expect(
+          object.yes?("foo")
+        ).to eq true
+      end
+    end
+  end
+end

data/spec/lib/updater_spec.rb

@@ -91,7 +91,9 @@ describe Bummr::Updater do
 
         updater.update_gem(gem, 0)
 
-        expect(git).to have_received(:add).with("Gemfile Gemfile.lock vendor/cache")
+        expect(git).to have_received(:add).with("Gemfile")
+        expect(git).to have_received(:add).with("Gemfile.lock")
+        expect(git).to have_received(:add).with("vendor/cache")
         expect(git).to have_received(:commit).with(commit_message)
       end
     end
@@ -111,7 +113,9 @@ describe Bummr::Updater do
 
         updater.update_gem(gem, 0)
 
-        expect(git).to have_received(:add).with("Gemfile Gemfile.lock vendor/cache")
+        expect(git).to have_received(:add).with("Gemfile")
+        expect(git).to have_received(:add).with("Gemfile.lock")
+        expect(git).to have_received(:add).with("vendor/cache")
         expect(git).to have_received(:commit).with(commit_message)
       end
     end

data/spec/spec_helper.rb

@@ -4,3 +4,4 @@ SimpleCov.start
 require 'pry'
 require 'bummr'
 require 'rainbow/ext/string'
+require 'jet_black/rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bummr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Lee Pender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jet_black
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -216,16 +230,19 @@ files:
 - lib/bummr/git.rb
 - lib/bummr/log.rb
 - lib/bummr/outdated.rb
+- lib/bummr/prompt.rb
 - lib/bummr/remover.rb
 - lib/bummr/scm.rb
 - lib/bummr/updater.rb
 - lib/bummr/version.rb
+- spec/black_box/bummr_update_spec.rb
 - spec/check_spec.rb
 - spec/lib/bisecter_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/git_spec.rb
 - spec/lib/log_spec.rb
 - spec/lib/outdated_spec.rb
+- spec/lib/prompt_spec.rb
 - spec/lib/remover_spec.rb
 - spec/lib/updater_spec.rb
 - spec/spec_helper.rb
@@ -254,12 +271,14 @@ signing_key:
 specification_version: 4
 summary: Helper script to intelligently update your Gemfile
 test_files:
+- spec/black_box/bummr_update_spec.rb
 - spec/check_spec.rb
 - spec/lib/bisecter_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/git_spec.rb
 - spec/lib/log_spec.rb
 - spec/lib/outdated_spec.rb
+- spec/lib/prompt_spec.rb
 - spec/lib/remover_spec.rb
 - spec/lib/updater_spec.rb
 - spec/spec_helper.rb