safe_update 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe337285cafce984750adbc2cdebe202bb84ff56
-  data.tar.gz: 706d441b2c670f325203e6064ab940bbe1fe4b51
+  metadata.gz: 2691acf87593613225b1c53fc4786d330791082c
+  data.tar.gz: ed8afd4d7c0508445a1f2f37d847cfac7a647bba
 SHA512:
-  metadata.gz: a45361991a9bb4872aa331e258a0963259a136d5c7bbd7eec9c962974c6a3cf09059dc70d4ab38ae4ffbbae31bab885ceccf09af875ef4792ee61296085a7224
-  data.tar.gz: eeb43295a21a4ef7c050a69f1e46d6873ce5ac3b79cdaacf38ca94cdd1492c99d0d49df2ba2b2ed9746adaee61110df7f9c9dcbd029bc95cf97fbe14b1a96bce
+  metadata.gz: 76fa5e5858e0a02595dc15f7f459ca310187e05cf73d80a9d452e5aa56a64489b30912dae3e1756f122d0bd2a89bf214640ca2d6f173804e92d4f1183dca0a14
+  data.tar.gz: 9edfaab5bb002051bc1cc9fa135f930a5585b55de794ec1db7ab35012a58b159a0627eac3ffdf74d38c21a6f1b93b57863b390f0095abe31c2c04ebb71440676

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/README.md

@@ -36,12 +36,6 @@ Installed: 3.0.0.
 Running `bundle update sprockets-rails`...
 committing changes (message: 'bundle update sprockets-rails')...
 -------------
-OUTDATED GEM: unf_ext
-   Newest: 0.0.7.2.
-Installed: 0.0.7.1.
-Running `bundle update unf_ext`...
-committing changes (message: 'bundle update unf_ext')...
--------------
 OUTDATED GEM: uniform_notifier
    Newest: 1.10.0.
 Installed: 1.9.0.
@@ -52,6 +46,35 @@ committing changes (message: 'bundle update uniform_notifier')...
 FINISHED
 ```
 
+### Options
+
+Run `safe_update -h` to view all options:
+
+```
+Usage: safe_update [options]
+    -v, --version        Show version
+    -p, --push N         git push every N commits (so your CI can test changes as you go)
+    -t, --test COMMAND   Run tests after each commit. Don't update gems which break tests.
+```
+
+### Recommended workflow
+
+**Step 1**
+
+Checkout a new branch and run safe-update, pushing every commit so your CI builds can run:
+
+```
+git checkout -b run-safe_update && git push -u origin run-safe_update && safe_update -p 1
+```
+
+**Step 2**
+
+Once everything is good, merge the branch back into master and delete the branch:
+
+```
+git checkout master && git merge run-safe_update && git branch -d run-safe_update && git push origin --delete run-safe_update
+```
+
 ## Future
 
 I've knocked this up really quickly, and it's pretty MVP-ish. Ideas for future include:
@@ -65,7 +88,9 @@ I've knocked this up really quickly, and it's pretty MVP-ish. Ideas for future i
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+To install this gem (as in, your development copy of the code) 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
 

data/exe/safe_update

@@ -9,9 +9,14 @@ OptionParser.new do |opts|
   opts.on('-v', '--version', 'Show version') do |v|
     options[:version] = v
   end
-  opts.on('-p', '--push N', 'git push every N commits') do |p|
+
+  opts.on('-p', '--push N', 'git push every N commits (so your CI can test changes as you go)') do |p|
     options[:push] = p
   end
+
+  opts.on('-t', '--test COMMAND', "Run tests after each commit. Don't update gems which break tests.") do |test_command|
+    options[:test_command] = test_command
+  end
 end.parse!
 
 if options[:version]

data/lib/safe_update/git_repo.rb

@@ -0,0 +1,43 @@
+# This class models a git repo that we are running safe_update on,
+# and the operations we need to perform in the context
+# of running safe_update. This class is not unit tested.
+# It's simple code that mostly just makes system calls
+# to git.
+module SafeUpdate
+  class GitRepo
+    def perform_safety_checks
+      check_for_staged_changes
+      check_for_gemfile_lock_changes
+    end
+
+    def discard_local_changes
+      `git reset HEAD --hard`
+    end
+
+    def commit_gemfile_lock(message)
+      `git add Gemfile.lock`
+      `git commit -m '#{message}'`
+    end
+
+    def push
+      `git push`
+    end
+
+    private
+
+    def check_for_staged_changes
+      result = `git diff --name-only --cached`
+      if result.strip.length > 0
+        raise 'safe_update cannot run while git repo has staged changes'
+      end
+    end
+
+    def check_for_gemfile_lock_changes
+      result = `git diff --name-only`
+      if result.include? 'Gemfile.lock'
+        raise 'safe_update cannot run while there are uncommitted changes in Gemfile.lock'
+      end
+    end
+
+  end
+end

data/lib/safe_update/outdated_gem.rb

@@ -5,23 +5,42 @@ module SafeUpdate
     # line is a line from bundle outdated --parseable
     # eg. react-rails (newest 1.6.0, installed 1.5.0, requested ~> 1.0)
     # or. react-rails (newest 1.6.0, installed 1.5.0)
-    def initialize(line)
+    def initialize(line, git_repo = nil)
       @line = line
+      @git_repo = git_repo || GitRepo.new
       if name.to_s.empty?
         fail "Unexpected output from `bundle outdated --parseable`: #{@line}"
       end
     end
 
-    def update
+    def attempt_update(test_command = nil)
       puts '-------------'
       puts "OUTDATED GEM: #{name}"
       puts "   Newest: #{newest}. "
       puts "Installed: #{installed}."
       puts "Running `bundle update #{name}`..."
+
       `bundle update #{name}`
+
+      # sometimes the gem may be outdated, but it's matching the
+      # version required by the gemfile, so bundle update does nothing
+      # in which case, don't waste time on tests etc.
+      if false
+        return
+      end
+
+      if test_command
+        puts "Running tests with: #{test_command}"
+        result = system(test_command)
+        if result != true
+          puts "tests failed - this gem won't be updated (test result: #{$?.to_i})"
+          @git_repo.discard_local_changes
+          return
+        end
+      end
+
       puts "committing changes (message: '#{commit_message}')..."
-      `git add Gemfile.lock`
-      `git commit -m '#{commit_message}'`
+      @git_repo.commit_gemfile_lock(commit_message)
     end
 
     def name

data/lib/safe_update/updater.rb

@@ -1,27 +1,41 @@
 module SafeUpdate
   class Updater
-    def run(options = {})
-      options[:push] = options[:push].to_i if options[:push]
-      check_for_staged_changes
-      check_for_gemfile_lock_changes
-      output_array = bundle_outdated_parseable.split(/\n+/)
-      output_array.to_enum.with_index(1) do |line, index|
-        update_gem(line)
-        `git push` if options[:push] && index % options[:push] == 0
+    def initialize(git_repo = nil)
+      @git_repo = git_repo || GitRepo.new
+      @git_repo.perform_safety_checks
+    end
+    # push:
+    #   If push is eg. 3, we will run @git_repo.push every 3 commits.
+    #   If push is nil, we will never run git push.
+    # test_command:
+    #   Command to run your tests after each gem update.
+    #   If exit status is non-zero, the gem will not be updated.
+    def run(push: nil, test_command: nil)
+      run_git_push = (push && push.to_i > 0) ? true : false
+      push_interval = push.to_i if run_git_push
+
+      puts 'Finding outdated gems...'
+      outdated_gems.to_enum.with_index(1) do |outdated_gem, index|
+        outdated_gem.attempt_update(test_command)
+        @git_repo.push if run_git_push && index % push_interval == 0
       end
 
       # run it once at the very end, so the final commit can be tested in CI
-      `git push` if options[:push]
+      @git_repo.push if run_git_push
 
-      puts '-------------'
-      puts '-------------'
-      puts 'FINISHED'
+      display_finished_message
     end
 
     private
 
-    def update_gem(line)
-      OutdatedGem.new(line).update
+    def outdated_gems
+      return @outdated_gems if @outdated_gems
+
+      @outdated_gems = []
+      bundle_outdated_parseable.split(/\n+/).each do |line|
+        @outdated_gems << OutdatedGem.new(line, @git_repo)
+      end
+      return @outdated_gems
     end
 
     def bundle_outdated_parseable
@@ -37,22 +51,10 @@ module SafeUpdate
       output.strip
     end
 
-    def check_for_staged_changes
-      result = `git diff --name-only --cached`
-      if result.strip.length > 0
-        puts 'You have staged changes in git.'
-        puts 'Please commit or stash your changes before running safe_update'
-        exit 1
-      end
-    end
-
-    def check_for_gemfile_lock_changes
-      result = `git diff --name-only`
-      if result.include? 'Gemfile.lock'
-        puts 'You have uncommitted changes in your Gemfile.lock.'
-        puts 'Please commit or stash your changes before running safe_update'
-        exit 1
-      end
+    def display_finished_message
+      puts '-------------'
+      puts '-------------'
+      puts 'FINISHED'
     end
   end
 end

data/lib/safe_update/version.rb

@@ -1,3 +1,3 @@
 module SafeUpdate
-  VERSION = '0.2.0'
+  VERSION = '0.3.2'
 end

data/lib/safe_update.rb

@@ -8,6 +8,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'safe_update/version'
 require 'safe_update/updater'
 require 'safe_update/outdated_gem'
+require 'safe_update/git_repo'
 
 module SafeUpdate
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_update
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Joshua Paling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -71,6 +72,7 @@ files:
 - bin/setup
 - exe/safe_update
 - lib/safe_update.rb
+- lib/safe_update/git_repo.rb
 - lib/safe_update/outdated_gem.rb
 - lib/safe_update/updater.rb
 - lib/safe_update/version.rb
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Safely and automatically update your gems, one at a time, with one git commit