lapidarist 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1105156709cc99e5c061836d1815d84721de11b80ae92f90e9404fa9461f7f49
-  data.tar.gz: b2cbcbe7c210fefcbd870baa5c9de71d5ce4065f9e208a8f36359e6a7daeea05
+  metadata.gz: 99fe161d7e3d3242d0d10b602695450f45ce091fff7a7145ed5a4276fe492752
+  data.tar.gz: c17bebcb2a4950bff0a72ced8081ff3f66c4b8f1159b69c3f6e2ada8e68a7eba
 SHA512:
-  metadata.gz: c4bc4c2ca10de53d0d6af8ff6154290171870029fa72366347577aad742f36e0e6ef7acf43ede35df0c03f789bf016b321748d897d16995c038b068833bf8cd8
-  data.tar.gz: 62dc6f447328f0ce79287c826a716126a6cffe689216724b58416d2c2a3f330580a9de558cf89829456359b2ddfc80287688585de4e2291ce9fb6116b60fd1c7
+  metadata.gz: f3f8ae3c3281d86276683334fd3c26bcb87d00d0473ae880a4d9476e696c3f5562259d125284e4c084a897e526a7b8ebef51c729c84255ce66fad6d30b7a9155
+  data.tar.gz: be46e3ffcddcba98f2278e9ef879b2ea1bd63877041ad5b86601d5390bb97da1c5f96c8f028cead290362f689165736030b300b20d39d11021e4627206d5789f

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+* errors return status of 2 instead of 1
+* capture invalid option error, and display message
+* capture interrupt and clean up git commits
+
+### Bug fixes
+
+* when the version doesn't change (but dependencies do), do not attempt any more recursive updates
+
 ### New features
 
 ## 0.1.1 (2018-08-11)

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/attack/lapidarist.svg?style=svg)](https://circleci.com/gh/attack/lapidarist)
 
-Take the manual work out of updaeting your ruby gems, and let Lapidarist do the work.
+Take the manual work out of updating your ruby gems, and let Lapidarist do the work.
 
 You can run it from the command line yourself to update the gems of your project, or
 automate it to run and update for you.
@@ -31,11 +31,132 @@ Lapidarist depends on `bundler` and `git`.
 lapidarist -d . -t 'rspec spec' --all
 ```
 
+### Options
+
 To see all the options available
 ```sh
 lapidarist -h
 ```
 
+#### `-t`, `--test TEST_SCRIPT`
+
+Test script to assert that the gems updates are safe to commit.
+This is run after any batch of updates, or during git bisect to investigate a
+failing update.
+
+#### `-a`, `--all`
+
+By default, Lapidarist will only update gems that are listed in the Gemfile.
+Use this option to also selectively update gems (or sub-dependencies) that are
+not listed in the Gemfile.
+
+#### `-q`, `--quiet`
+
+Do not print anything to stdout. This will take precedence over logging
+verbosity levels and debugging output.
+
+#### `-v`
+
+Increase verbosity of stdout output. Repeat this option up to three times
+for to control the level of detail.
+
+#### `-f`, `--commit-flags`
+
+When Lapidarist commits gem updates extra flags can be requested to append
+to this command. A common use case is to bypass local git hooks with `--no-verify`.
+
+#### `-l`
+
+Path to log file. This is location where Lapidarist will write a log with full
+verbosity. This file will be reset for each run.
+
+#### `-n`
+
+By default, Lapidarist will attempt to update all outdated gems. Use this option
+to limit the number of gems that are updated to a maximum number.
+
+#### `--one`, `-n 1`
+
+This is the same as `-n 1`, and limits Lapidarist to only update one gem.
+
+#### `-g`, `--group`
+
+Limit gems to be updated to a specified group(s). Multiple groups can be can
+be permitted by using this option multiple times.
+
+#### `--major`, `--minor`, `--patch`
+
+Limit gem updates to a specific maximum level.  This option is passed directly to
+`bundle update` and follows the logic controlled by bundler.
+
+#### `-r`, `--recursive`
+
+By default, Lapidarist will only try to update a gem once.  With this option,
+if an update fails then Lapidarist will try again using a lower maximum level.
+For example, if a gem had updates available at a patch level, a minor level and
+a major level, and an update failed when updating to the major level, then with
+this option Lapidarist will try again at the minor then patch levels until all
+levels are exhausted or an update is accepted.
+
+This option will respect the maximum update level option, and will only try
+lower available levels, if any.
+
+#### `-o`, `--ordered`
+
+By default, Lapidarist will randomize the order of gems it attempts to update.
+This option can be used to prevent randomization and force Lapidarist to respect
+the order from `bundle outdated`, which is essentially in alphabetical order.
+
+#### `--seed`
+
+By default, Lapidarist will randomize the order of gems it attempts to update
+with a randomly generated seed. This option can be used to control the seed and
+thus the resulting random order.
+
+#### `--promote`
+
+By default, Lapidarist will randomize the order of all gems it attempts to update.
+With this option gems can be promoted to the top of the order so that the specified
+gem(s) will be updated first before any non-promoted gems.
+
+This option can be a comma delimited list or the result of using this option
+multiple times.
+
+#### `--demote`
+
+By default, Lapidarist will randomize the order of all gems it attempts to update.
+With this option gems can be demoted to the bottom of the order so that the specified
+gem(s) will be updated last after any non-demoted gems.
+
+This option can be a comma delimited list or the result of using this option
+multiple times.
+
+If a gem is both promoted and demoted, then demoted will be preferred and the
+promotion will be ignored.
+
+#### `--only`
+
+By default, Lapidarist will attempt to update all outdated gems.  With this
+option Lapidarist will only attempt to update the outdated gems that match
+those specified, and ignore updating any other gems.
+
+This option can be a comma delimited list or the result of using this option
+multiple times.
+
+#### `--except`
+
+By default, Lapidarist will attempt to update all outdated gems.  With this
+option Lapidarist will attempt to update the all outdated gems except those that
+match the ones specified.
+
+This option can be a comma delimited list or the result of using this option
+multiple times.
+
+If both `--only` and `--except` are given, then a hybrid of the two options will
+be used, essentially behaving like `--only` but excluding any gems provided
+using `--except` (ie `lapidarist --only foo,bar --except foo` is equivalent to
+`lapidarist --only bar`)
+
 ## Development
 
 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.

data/lib/lapidarist.rb

@@ -19,12 +19,20 @@ require_relative 'lapidarist/test_command'
 require_relative 'lapidarist/update'
 require_relative 'lapidarist/outdated'
 require_relative 'lapidarist/sha'
+require_relative 'lapidarist/find_failure'
 
+require_relative 'lapidarist/threads'
 require_relative 'lapidarist/summary'
 require_relative 'lapidarist/status'
 require_relative 'lapidarist/cli'
 
 module Lapidarist
+  STATUS_SUCCESS = 0
+  STATUS_FAILED = 1
+  STATUS_ERROR = 2
+
+  class Abort < StandardError; end
+
   class << self
     def config
       @config ||= Lapidarist::Configuration.new
@@ -33,5 +41,9 @@ module Lapidarist
     def logger
       @logger ||= Lapidarist::Logger.new.tap { |l| l.setup }
     end
+
+    def threads
+      @threads ||= Lapidarist::Threads.new
+    end
   end
 end

data/lib/lapidarist/cli.rb

@@ -4,7 +4,6 @@ module Lapidarist
       @args = args
       @git = GitCommand.new
       @test = TestCommand.new
-      @outdated = Outdated.new
       @update = Update.new
       @sha = Sha.new
     end
@@ -12,16 +11,15 @@ module Lapidarist
     def run
       Options.new(args).parse
       Lapidarist.logger.header('Starting lapidarist')
-      Lapidarist.logger.debug("directory: #{Lapidarist.config.directory}", :options)
-      Lapidarist.logger.debug("test_script: #{Lapidarist.config.test_script}", :options)
+      trap_interrupt
 
       unless git.clean?
         Lapidarist.logger.footer('stopping, there are uncommitted changes')
-        return 1
+        return STATUS_ERROR
       end
 
       sha.record_good
-      gems = outdated.run
+      gems = Lapidarist::Outdated.new.run
 
       status = nil
       attempt = 0
@@ -50,42 +48,48 @@ module Lapidarist
           status = Status.new(gems, attempt)
           break
         else
-          Lapidarist.logger.footer('test failed, investigating failure')
+          Lapidarist.logger.footer('test failed')
         end
 
-        failed_gem =
-          if updated_gems.one?
-            updated_but_failed_gem = updated_gems.first
-            git.reset_hard('HEAD^')
-
-            Gem.from(
-              updated_but_failed_gem,
-              attempt: attempt,
-              status: :failed,
-              updated_version: updated_but_failed_gem.latest_attempt.version
-            )
-          else
-            failed_gem_name = git.bisect(sha.last_good, test)
-            updated_but_failed_gem = updated_gems.detect { |g| g.name == failed_gem_name }
-            gems = gems.merge(updated_gems.take(sha.new_commit_count))
-            sha.record_good
-
-            Gem.from(
-              updated_but_failed_gem,
-              attempt: attempt,
-              status: :failed,
-              updated_version: updated_but_failed_gem.latest_attempt.version
-            )
-          end
-        gems = gems.merge(failed_gem)
+        failed_gem = Lapidarist::FindFailure.new(
+          gems: updated_gems,
+          attempt: attempt,
+          last_good_sha: sha.last_good
+        ).run
+        gems = gems.merge(updated_gems.take(sha.new_commit_count)).merge(failed_gem)
+        sha.record_good
+
+        if Lapidarist.config.debug
+          Summary.new(gems).display_debug
+        end
       end
 
       Summary.new(gems).display
       return status.to_i
+
+    rescue OptionParser::InvalidOption => e
+      warn e.message
+      warn 'For usage information, use --help'
+      return STATUS_ERROR
+    rescue Lapidarist::Abort => e
+      git.reset_hard(sha.last_good)
+      Summary.new(gems).display
+      return STATUS_ERROR
+    end
+
+    def trap_interrupt
+      Signal.trap('INT') do
+        warn
+        warn 'Cleaning up and exiting... Interrupt again to exit immediately.'
+
+        Lapidarist.threads.stop
+
+        raise Lapidarist::Abort
+      end
     end
 
     private
 
-    attr_reader :args, :git, :test, :outdated, :update, :sha
+    attr_reader :args, :git, :test, :update, :sha
   end
 end

data/lib/lapidarist/configuration.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'pathname'
 
 module Lapidarist
   class Configuration < OpenStruct

data/lib/lapidarist/find_failure.rb

@@ -0,0 +1,35 @@
+module Lapidarist
+  class FindFailure
+    def initialize(gems:, attempt:, last_good_sha:)
+      @gems = gems
+      @attempt = attempt
+      @last_good_sha = last_good_sha
+      @git = GitCommand.new
+      @test = TestCommand.new
+    end
+
+    def run
+      Lapidarist.logger.header('Investigating failure')
+
+      updated_but_failed_gem =
+        if gems.one?
+          git.reset_hard('HEAD^')
+          gems.first
+        else
+          failed_gem_name = git.bisect(last_good_sha, test)
+          gems.detect { |gem| gem.name == failed_gem_name }
+        end
+
+      Gem.from(
+        updated_but_failed_gem,
+        attempt: attempt,
+        status: :failed,
+        updated_version: updated_but_failed_gem.latest_attempt.version
+      )
+    end
+
+    private
+
+    attr_reader :gems, :attempt, :last_good_sha, :git, :test
+  end
+end

data/lib/lapidarist/gem.rb

@@ -131,7 +131,6 @@ module Lapidarist
     private
 
     def version_changed?
-      # use VersionChange
       updated_version && installed_version != updated_version
     end
 

data/lib/lapidarist/level.rb

@@ -28,6 +28,7 @@ module Lapidarist
   MAJOR = Level.new(name: :major, index: 1)
   MINOR = Level.new(name: :minor, index: 2)
   PATCH = Level.new(name: :patch, index: 3)
+  NONE = Level.new(name: "", index: 4)
 
   LEVELS = [MAJOR, MINOR, PATCH].freeze
 end

data/lib/lapidarist/options.rb

@@ -12,7 +12,7 @@ module Lapidarist
           Lapidarist.config.directory = Pathname.new(d)
         end
 
-        opts.on("-t", "--test TEST_SCRIPT", "Test script given to git bisect.") do |t|
+        opts.on("-t", "--test TEST_SCRIPT", "Test script to assert that the gems updates are safe to commit.") do |t|
           Lapidarist.config.test_script = t
         end
 
@@ -28,7 +28,7 @@ module Lapidarist
           Lapidarist.config.verbosity += 1
         end
 
-        opts.on("-f", "--commit-flags flags", "Append flags to the commit command.") do |t|
+        opts.on("-f", "--commit-flags FLAGS", "Append flags to the commit command.") do |t|
           Lapidarist.config.commit_flags = t
         end
 

data/lib/lapidarist/sha.rb

@@ -8,7 +8,10 @@ module Lapidarist
     def record_good
       good_sha = git.head
       Lapidarist.logger.debug("good sha: #{good_sha}")
-      @good_shas << good_sha
+
+      unless last_good == good_sha
+        @good_shas << good_sha
+      end
     end
 
     def last_good

data/lib/lapidarist/shell.rb

@@ -14,13 +14,15 @@ module Lapidarist
       Lapidarist.logger.info "COMMAND > `#{command}`", 1
 
       if block_given?
-        Open3.popen2e(command, chdir: Lapidarist.config.directory) do |_std_in, std_out_err|
+        Open3.popen2e(command, chdir: Lapidarist.config.directory) do |_std_in, std_out_err, wait_thr|
+          Lapidarist.threads << wait_thr
           yield(std_out_err)
         end
       else
         out_err = []
 
         status = Open3.popen2e(command, chdir: Lapidarist.config.directory) do |_std_in, std_out_err, wait_thr|
+          Lapidarist.threads << wait_thr
           while line = std_out_err.gets
             Lapidarist.logger.std_out_err(line, label || command)
             out_err << line
@@ -36,12 +38,14 @@ module Lapidarist
 
     def pipe_multiple_commands(*commands)
       if block_given?
-        Open3.pipeline_r(*commands, chdir: Lapidarist.config.directory) do |std_out, _ts|
+        Open3.pipeline_r(*commands, chdir: Lapidarist.config.directory) do |std_out, ts|
+          Lapidarist.threads << ts
           yield(std_out)
         end
       else
         output = ''
-        Open3.pipeline_r(*commands, chdir: Lapidarist.config.directory) do |std_out, _ts|
+        Open3.pipeline_r(*commands, chdir: Lapidarist.config.directory) do |std_out, ts|
+          Lapidarist.threads << ts
           output = std_out.read
         end
         output

data/lib/lapidarist/status.rb

@@ -6,7 +6,11 @@ module Lapidarist
     end
 
     def to_i
-      gems.updated.any? || attempt == 1
+      if gems.updated.any? || attempt == 1
+        STATUS_SUCCESS
+      else
+        STATUS_FAILED
+      end
     end
 
     private

data/lib/lapidarist/summary.rb

@@ -9,17 +9,15 @@ module Lapidarist
       Lapidarist.logger.summary 'Summary'
       Lapidarist.logger.summary '-'*50
       Lapidarist.logger.summary "#{object_count(gems.updated, 'gem', 'gems')} updated, #{object_count(gems.failed, 'gem', 'gems')} failed and #{object_count(gems.skipped, 'gem', 'gems')} skipped in #{object_count(gems.attempts, 'attempt', 'attempts')}"
-      gems.each do |gem|
-        gem.attempts.each do |i, data|
-          case data.status
-          when :updated
-            Lapidarist.logger.summary " + updated #{gem.name} from #{gem.installed_version} to #{data.version}"
-          when :failed
-            Lapidarist.logger.summary " x failed #{gem.name} from #{gem.installed_version} to #{data.version}"
-          when :skipped
-            Lapidarist.logger.summary " - skipped #{gem.name} (#{data.reason})"
-          end
-        end
+      summarize_attempts do |summary|
+        Lapidarist.logger.summary summary
+      end
+    end
+
+    def display_debug
+      Lapidarist.logger.debug "#{object_count(gems.updated, 'gem', 'gems')} updated, #{object_count(gems.failed, 'gem', 'gems')} failed and #{object_count(gems.skipped, 'gem', 'gems')} skipped in #{object_count(gems.attempts, 'attempt', 'attempts')}"
+      summarize_attempts do |summary|
+        Lapidarist.logger.debug summary
       end
     end
 
@@ -41,5 +39,22 @@ module Lapidarist
         "#{length} #{plural}"
       end
     end
+
+    def summarize_attempts
+      gems.each do |gem|
+        gem.attempts.each do |i, data|
+          summary =
+            case data.status
+            when :updated
+              " + updated #{gem.name} from #{gem.installed_version} to #{data.version}"
+            when :failed
+              " x failed #{gem.name} from #{gem.installed_version} to #{data.version}"
+            when :skipped
+              " - skipped #{gem.name} (#{data.reason})"
+            end
+          yield summary
+        end
+      end
+    end
   end
 end

data/lib/lapidarist/threads.rb

@@ -0,0 +1,42 @@
+module Lapidarist
+  class Threads
+    def initialize
+      @threads = []
+      @abort = false
+    end
+
+    def <<(thread)
+      @threads += Array(thread)
+    end
+
+    def stop
+      if aborting?
+        kill
+        exit! STATUS_ERROR
+      else
+        @abort = true
+        abort
+      end
+    end
+
+    def aborting?
+      @abort
+    end
+
+    private
+
+    attr_reader :threads
+
+    def alive
+      threads.select { |thread| thread.alive? }
+    end
+
+    def abort
+      alive.each { |thread| Process.kill("INT", thread.pid) }
+    end
+
+    def kill
+      alive.each { |thread| Process.kill("KILL", thread.pid) }
+    end
+  end
+end

data/lib/lapidarist/version.rb

@@ -1,3 +1,3 @@
 module Lapidarist
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/lapidarist/version_change.rb

@@ -33,6 +33,12 @@ module Lapidarist
           Lapidarist::MINOR
         elsif updated_segments && updated_segments[0] == installed_segments[0] && updated_segments[1] == installed_segments[1] && updated_segments[2] > installed_segments[2]
           Lapidarist::PATCH
+        elsif updated_segments && (
+          (updated_segments[0] == installed_segments[0] && updated_segments[1] == installed_segments[1] && updated_segments[2] <= installed_segments[2]) ||
+          (updated_segments[0] == installed_segments[0] && updated_segments[1] <= installed_segments[1]) ||
+          updated_segments[0] <= installed_segments[0]
+        )
+          Lapidarist::NONE
         end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lapidarist
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Gangl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,7 @@ files:
 - lib/lapidarist/bundle_command.rb
 - lib/lapidarist/cli.rb
 - lib/lapidarist/configuration.rb
+- lib/lapidarist/find_failure.rb
 - lib/lapidarist/gem.rb
 - lib/lapidarist/gem_version.rb
 - lib/lapidarist/gems.rb
@@ -93,6 +94,7 @@ files:
 - lib/lapidarist/status.rb
 - lib/lapidarist/summary.rb
 - lib/lapidarist/test_command.rb
+- lib/lapidarist/threads.rb
 - lib/lapidarist/update.rb
 - lib/lapidarist/version.rb
 - lib/lapidarist/version_change.rb