safe_update 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a34ecfbe5b686673a2abc202136461330aaa4f2f
-  data.tar.gz: ebea4606b6853cf0f3e27747eb3eebea8b7fd574
+  metadata.gz: bba79506d40fecac8ada14494ed6c4716cf0dd72
+  data.tar.gz: 4634161fd299cf504d1e5e8e9335f5792955af82
 SHA512:
-  metadata.gz: fc7aa962362fc264c326369a662f2e5e2a75bae8b6c5b196c4747cf48e9f0c49e7f73cf90eabc8bf3ee29bef75dd6e5d49b65446d4a5e5ff2fa4deb365d01724
-  data.tar.gz: 172d61cd95fcd536f9494ba89887e8d10f1fd94a00cd90826b04afcd250925a68860ebd62a0d4970e7152f39ebab454ec7a21c4c0d629e45f558ebf248b6f28e
+  metadata.gz: 6333d5fa8b75759fdee92de16ff01644dbc016ef4b6a53b3e7d9914f80bdb8edbe91a211271c605fa3ae61b5f1c648ed94a173278327a75b3ec778237b93c6a0
+  data.tar.gz: 748b56136a743b01c7f5510cbfe169d596173365f553416cff90d18a61f2b8609ca9344718c1734c76425568c2ee023bb9c079c3a0b27c27fce5ed11361f8e91

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.0

data/README.md

@@ -88,6 +88,8 @@ 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 test the presenter that displays progress to the terminal: `ruby ./spec/presenter_test.rb`
+
 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).

data/lib/safe_update/git_repo.rb

@@ -7,7 +7,9 @@ module SafeUpdate
   class GitRepo
     def perform_safety_checks
       check_for_staged_changes
-      check_for_gemfile_lock_changes
+      if gemfile_lock_has_changes?
+        raise 'safe_update cannot run while there are uncommitted changes in Gemfile.lock'
+      end
     end
 
     def discard_local_changes
@@ -23,6 +25,11 @@ module SafeUpdate
       `git push`
     end
 
+    def gemfile_lock_has_changes?
+      result = `git diff --name-only`
+      return result.include? 'Gemfile.lock'
+    end
+
     private
 
     def check_for_staged_changes
@@ -31,13 +38,5 @@ module SafeUpdate
         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

@@ -1,21 +1,24 @@
 module SafeUpdate
   class OutdatedGem
-    attr_reader :gem_name, :newest, :installed, :requested
+    STATUS_PENDING    = 'pending'
+    STATUS_UPDATING   = 'updating'
+    STATUS_TESTING    = 'testing'
+    STATUS_UPDATED    = 'updated'
+    STATUS_UNCHANGED  = 'unchanged'
+    STATUS_TESTS_FAIL = 'tests_fail'
+
+    attr_reader :gem_name, :newest, :installed, :requested, :current_status
     def initialize(opts = {})
       @gem_name  = opts[:gem_name]
       @newest    = opts[:newest]
       @installed = opts[:installed]
       @requested = opts[:requested]
       @git_repo  = opts[:git_repo] || GitRepo.new
+      @current_status = STATUS_PENDING
     end
 
     def attempt_update(test_command = nil)
-      puts '-------------'
-      puts "OUTDATED GEM: #{@gem_name}"
-      puts "   Newest: #{@newest}. "
-      puts "Installed: #{@installed}."
-      puts "Running `bundle update #{@gem_name}`..."
-
+      @current_status = STATUS_UPDATING
       `bundle update #{@gem_name}`
 
       # sometimes the gem may be outdated, but it's matching the
@@ -26,17 +29,25 @@ module SafeUpdate
       end
 
       if test_command
-        puts "Running tests with: #{test_command}"
+        @current_status = STATUS_TESTING
         result = system(test_command)
         if result != true
-          puts "tests failed - this gem won't be updated (test result: #{$?.to_i})"
+          @current_status = STATUS_TESTS_FAIL
           @git_repo.discard_local_changes
           return
         end
       end
 
-      puts "committing changes (message: '#{commit_message}')..."
-      @git_repo.commit_gemfile_lock(commit_message)
+      if @git_repo.gemfile_lock_has_changes?
+        @git_repo.commit_gemfile_lock(commit_message)
+        @current_status = STATUS_UPDATED
+      else
+        @current_status = STATUS_UNCHANGED
+      end
+    end
+
+    def being_operated_on_now?
+      [STATUS_UPDATING, STATUS_TESTING].include?(@current_status)
     end
 
     private

data/lib/safe_update/presenter.rb

@@ -0,0 +1,95 @@
+require 'curses'
+
+module SafeUpdate
+  class Presenter
+    # outdated_gems is an array of instances of SafeUpdate::OutdatedGem
+
+    SPINNER_STATES = ['|', '/', '-', '\\']
+
+    def initialize
+      Curses.noecho
+      Curses.init_screen
+
+      @tick = 1
+      @running = true
+    end
+
+    def call(outdated_gems)
+      @outdated_gems = outdated_gems
+      while @running do
+        @tick += 1
+        update_screen
+        sleep 0.3
+      end
+    end
+
+    def stop
+      @running = false
+      print_final_output
+    end
+
+    private
+
+    def print_final_output
+      Curses.close_screen
+      puts title
+      puts header
+      @outdated_gems.each do |outdated_gem|
+        puts present_single_gem(outdated_gem)
+      end
+    end
+
+    def update_screen
+      Curses.setpos(0, 0)
+      Curses.addstr(title)
+      Curses.refresh
+
+      Curses.setpos(1, 0)
+      Curses.addstr(header)
+      Curses.refresh
+
+      @outdated_gems.each_with_index do |outdated_gem, i|
+        Curses.setpos(i + 2, 0)
+        line = present_single_gem(outdated_gem)
+        Curses.addstr(line)
+        Curses.refresh
+      end
+    end
+
+    def title
+      '=> Updating your gems... safely   ' + current_spinner_state
+    end
+
+    def current_spinner_state
+      div, remainder = @tick.divmod(SPINNER_STATES.length)
+      SPINNER_STATES[remainder]
+    end
+
+    def header
+      return [
+        fixed_length_string('GEM', 15),
+        fixed_length_string('INSTALLED', 10),
+        fixed_length_string('REQUESTED', 10),
+        fixed_length_string('NEWEST', 7),
+        fixed_length_string('STATUS', 10)
+        ].join(' | ')
+    end
+
+    def present_single_gem(outdated_gem)
+      status = outdated_gem.current_status
+      status += ' ' + current_spinner_state if outdated_gem.being_operated_on_now?
+      return [
+        fixed_length_string(outdated_gem.gem_name, 15),
+        fixed_length_string(outdated_gem.installed, 10),
+        fixed_length_string(outdated_gem.requested || '    -', 10),
+        fixed_length_string(outdated_gem.newest, 7),
+        fixed_length_string(status, 10)
+      ].join(' | ')
+    end
+
+    # inspired by http://stackoverflow.com/questions/14714936/fix-ruby-string-to-n-characters
+    def fixed_length_string(str, length)
+      "%-#{length}.#{length}s" % str
+    end
+  end
+end

data/lib/safe_update/updater.rb

@@ -15,6 +15,11 @@ module SafeUpdate
       push_interval = push.to_i if run_git_push
 
       puts 'Finding outdated gems...'
+      outdated_gems = get_outdated_gems
+
+      presenter = SafeUpdate::Presenter.new
+      Thread.new { presenter.call(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
@@ -23,19 +28,13 @@ module SafeUpdate
       # run it once at the very end, so the final commit can be tested in CI
       @git_repo.push if run_git_push
 
-      display_finished_message
+      presenter.stop
     end
 
     private
 
-    def outdated_gems
-      BundleOutdatedParser.new.call
-    end
-
-    def display_finished_message
-      puts '-------------'
-      puts '-------------'
-      puts 'FINISHED'
+    def get_outdated_gems
+      @outdated_gems ||= BundleOutdatedParser.new.call
     end
   end
 end

data/lib/safe_update/version.rb

@@ -1,3 +1,3 @@
 module SafeUpdate
-  VERSION = '0.3.3'
+  VERSION = '0.4.1'
 end

data/lib/safe_update.rb

@@ -10,6 +10,7 @@ require 'safe_update/updater'
 require 'safe_update/outdated_gem'
 require 'safe_update/bundle_outdated_parser'
 require 'safe_update/git_repo'
+require 'safe_update/presenter'
 
 module SafeUpdate
 end

data/safe_update.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'curses', '~> 1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_update
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Joshua Paling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: 
 email:
 - joshua.paling@gmail.com
@@ -75,6 +89,7 @@ files:
 - lib/safe_update/bundle_outdated_parser.rb
 - lib/safe_update/git_repo.rb
 - lib/safe_update/outdated_gem.rb
+- lib/safe_update/presenter.rb
 - lib/safe_update/updater.rb
 - lib/safe_update/version.rb
 - safe_update.gemspec
@@ -98,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Safely and automatically update your gems, one at a time, with one git commit