bundleup 0.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a12520bbc6803f69e10659bf902b5ea02b1902e1c3115ab77ca13f9721e3190
-  data.tar.gz: 57e69c40eaa3639ebb05dbdacc28b8c38d189138b320146044a9ff145dc9bfa5
+  metadata.gz: 82ad26069759aeaa4516bb5305da2d0d75a38e1c30d8efd275b3fd09df6f2697
+  data.tar.gz: 1cec30ec08cf62b3332c6b8b6539c4231fbf6b1bc29f2c8a4069b5afff2d0b83
 SHA512:
-  metadata.gz: aeed97c4f56cab2a1bd993e5cdea4dd1f38381ad5604948ca38e98632572b9dbd1c162e86ee71a5bd015ea1647a57cafaf86e9d6a44db5553c260195e47df457
-  data.tar.gz: 59ba702fe9f6078299c5a439b43b1ec1ef134e7d54d66156bbee909a73d5a2f2d77eb2df1e6df0c081baa9fc30893fc70c5f8de67fe0d058ce93f9a002fa82d1
+  metadata.gz: 388e5e6c1ca95b073319c7cd5954348190c2ff1a2e63836659a966eebc7c4da8583474434c33a979d0f70bc69e02686d8a0c4829fcba4123e25b675665af2ee4
+  data.tar.gz: 651c38cc47925f3bafbbc30b50d777c58dfc2918ca3a1329c182ae38735d6e33fb287cb6ba9096b878c4c137746cdc6baa18726362a02eb036ab7a63db9e77a7

data/README.md

@@ -1,7 +1,7 @@
 # bundleup
 
 [![Gem Version](https://badge.fury.io/rb/bundleup.svg)](http://badge.fury.io/rb/bundleup)
-[![Build Status](https://travis-ci.org/mattbrictson/bundleup.svg?branch=master)](https://travis-ci.org/mattbrictson/bundleup)
+[![Build Status](https://travis-ci.org/mattbrictson/bundleup.svg?branch=main)](https://travis-ci.org/mattbrictson/bundleup)
 
 **Run `bundleup` on a Ruby project containing a Gemfile to see what gem dependencies need updating.** It is a friendlier command-line interface to [Bundler’s][bundler] `bundle update` and `bundle outdated`.
 
@@ -14,12 +14,12 @@ You might like bundleup because it:
 
 Here it is in action:
 
-<img src="https://raw.github.com/mattbrictson/bundleup/master/sample.png" width="599" height="553" alt="Sample output">
+<img src="./demo.gif" width="682" height="351" alt="Sample output">
 
 ## Requirements
 
 - Bundler 1.16 or later
-- Ruby 2.4 or later
+- Ruby 2.5 or later
 
 ## Usage
 
@@ -46,7 +46,7 @@ bundleup --group=development
 
 ## How it works
 
-bundleup starts by making a backup copy of your Gemfile.lock. Next it runs `bundle list`, then `bundle update` and `bundle list` again to find what gems versions are being used before and after Bundler does its updating magic. (Since gems are actually being installed into your Ruby environment during these steps, the process may take a few moments to complete, especially if gems with native extensions need to be compiled.)
+bundleup starts by making a backup copy of your Gemfile.lock. Next it runs `bundle check` (and `bundle install` if any gems are missing in your local environment), `bundle list`, then `bundle update` and `bundle list` again to find what gems versions are being used before and after Bundler does its updating magic. (Since gems are actually being installed into your Ruby environment during these steps, the process may take a few moments to complete, especially if gems with native extensions need to be compiled.)
 
 Finally, bundleup runs `bundle outdated` to see the gems that were _not_ updated due to Gemfile restrictions.
 
@@ -54,7 +54,7 @@ After displaying its findings, bundleup gives you the option of keeping the chan
 
 ## Roadmap
 
-bundleup is a very simple script at this point, but it could be more. Some possibilities:
+bundleup is very simple at this point, but it could be more. Some possibilities:
 
 - Automatically commit the Gemfile.lock changes with a nice commit message
 - Integrate with bundler-audit to mark upgrades that have important security fixes

data/exe/bundleup

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
 
 require "bundleup"
-Bundleup::CLI.new.run
+
+begin
+  Bundleup::CLI.new(ARGV).run
+rescue Bundleup::CLI::Error => e
+  Bundleup.logger.error(e.message)
+  exit(false)
+end

data/lib/bundleup.rb

@@ -1,7 +1,21 @@
 require "bundleup/version"
-require "bundleup/console"
-require "bundleup/bundle_commands"
-require "bundleup/gem_status"
-require "bundleup/gemfile"
-require "bundleup/upgrade"
+require "bundleup/backup"
+require "bundleup/colors"
 require "bundleup/cli"
+require "bundleup/commands"
+require "bundleup/gemfile"
+require "bundleup/logger"
+require "bundleup/report"
+require "bundleup/shell"
+require "bundleup/pin_report"
+require "bundleup/update_report"
+
+module Bundleup
+  class << self
+    attr_accessor :commands, :logger, :shell
+  end
+end
+
+Bundleup.commands = Bundleup::Commands.new
+Bundleup.logger = Bundleup::Logger.new
+Bundleup.shell = Bundleup::Shell.new

data/lib/bundleup/backup.rb

@@ -0,0 +1,26 @@
+module Bundleup
+  class Backup
+    def self.restore_on_error(path)
+      backup = new(path)
+      begin
+        yield(backup)
+      rescue StandardError, Interrupt
+        backup.restore
+        raise
+      end
+    end
+
+    def initialize(path)
+      @path = path
+      @original_contents = IO.read(path)
+    end
+
+    def restore
+      IO.write(path, original_contents)
+    end
+
+    private
+
+    attr_reader :path, :original_contents
+  end
+end

data/lib/bundleup/cli.rb

@@ -1,86 +1,120 @@
+require "forwardable"
+
 module Bundleup
   class CLI
-    include Console
-
-    def run
-      puts \
-        "Please wait a moment while I upgrade your Gemfile.lock..."
-
-      committed = false
-      review_upgrades
-      review_pins
-      committed = upgrades.any? && confirm_commit
-      puts "Done!" if committed
-    ensure
-      restore_lockfile unless committed
+    Error = Class.new(StandardError)
+
+    include Colors
+    extend Forwardable
+    def_delegators :Bundleup, :commands, :logger
+
+    def initialize(args)
+      @args = args
     end
 
-    private
+    def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      print_usage && return if (args & %w[-h --help]).any?
+
+      assert_gemfile_and_lock_exist!
+
+      logger.puts "Please wait a moment while I upgrade your Gemfile.lock..."
+      Backup.restore_on_error("Gemfile.lock") do |backup|
+        update_report, pin_report = perform_analysis
+
+        if update_report.empty?
+          logger.ok "Nothing to update."
+          logger.puts "\n#{pin_report}" unless pin_report.empty?
+          break
+        end
+
+        logger.puts
+        logger.puts update_report
+        logger.puts pin_report unless pin_report.empty?
 
-    def review_upgrades
-      if upgrades.any?
-        puts "\nThe following gem(s) will be updated:\n\n"
-        print_upgrades_table
-      else
-        ok("Nothing to update.")
+        if logger.confirm?("Do you want to apply these changes?")
+          logger.ok "Done!"
+        else
+          backup.restore
+          logger.puts "Your original Gemfile.lock has been restored."
+        end
       end
     end
 
-    def review_pins
-      return if pins.empty?
+    private
 
-      puts "\nNote that the following gem(s) are being held back:\n\n"
-      print_pins_table
-    end
+    attr_reader :args
 
-    def confirm_commit
-      confirm("\nDo you want to apply these changes?")
-    end
+    def print_usage # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      logger.puts(<<~USAGE.gsub(/^/, "  "))
 
-    def restore_lockfile
-      return unless defined?(@upgrade)
-      return unless upgrade.lockfile_changed?
+        Usage: #{green('bundleup')} #{yellow('[GEMS...] [OPTIONS]')}
 
-      upgrade.undo
-      puts "Your original Gemfile.lock has been restored."
-    end
+        Use #{blue('bundleup')} in place of #{blue('bundle update')} to interactively update your project
+        Gemfile.lock to the latest gem versions. Bundleup will show what gems will
+        be updated, color-code them based on semver, and ask you to confirm the
+        updates before finalizing them. For example:
 
-    def upgrade
-      @upgrade ||= Upgrade.new(ARGV)
-    end
+            The following gems will be updated:
 
-    def upgrades
-      upgrade.upgrades
-    end
+            #{yellow('bundler-audit 0.6.1   → 0.7.0.1')}
+            i18n          1.8.2   → 1.8.5
+            #{red('json          2.2.0   → (removed)')}
+            parser        2.7.1.1 → 2.7.1.4
+            #{red('rails         e063bef → 57a4ead')}
+            #{blue('rubocop-ast   (new)   → 0.3.0')}
+            #{red('thor          0.20.3  → 1.0.1')}
+            #{yellow('zeitwerk      2.3.0   → 2.4.0')}
 
-    def pins
-      upgrade.pins
-    end
+            #{yellow('Do you want to apply these changes [Yn]?')}
 
-    def print_upgrades_table
-      rows = tableize(upgrades) do |g|
-        [g.name, g.old_version || "(new)", "→", g.new_version || "(removed)"]
-      end
-      upgrades.zip(rows).each do |g, row|
-        puts color(g.color, row)
-      end
-    end
+        Bundleup will also let you know if there are gems that can't be updated
+        because they are pinned in the Gemfile. Any relevant comments from the
+        Gemfile will also be included, explaining the pins:
 
-    def print_pins_table
-      rows = tableize(pins) do |g|
-        [g.name, g.new_version, "→", g.newest_version, *pin_reason(g)]
-      end
-      puts rows.join("\n")
+            Note that the following gems are being held back:
+
+            rake    12.3.3 → 13.0.1 : pinned at ~> 12.0   #{gray('# Not ready for 13 yet')}
+            rubocop 0.89.0 → 0.89.1 : pinned at  = 0.89.0
+
+        You may optionally specify one or more #{yellow('GEMS')} or pass #{yellow('OPTIONS')} to bundleup;
+        these will be passed through to bundler. See #{blue('bundle update --help')} for the
+        full list of the options that bundler supports.
+
+        Examples:
+
+            #{gray('# Update all gems')}
+            #{blue('$ bundleup')}
+
+            #{gray('# Only update gems in the development group')}
+            #{blue('$ bundleup --group=development')}
+
+            #{gray('# Only update the rake gem')}
+            #{blue('$ bundleup rake')}
+
+      USAGE
+      true
     end
 
-    def pin_reason(gem)
-      notes = color(:gray, gemfile.gem_comment(gem.name))
-      pin_operator, pin_version = gem.pin.split(" ", 2)
-      [":", "pinned at", pin_operator.rjust(2), pin_version, notes]
+    def assert_gemfile_and_lock_exist!
+      return if File.exist?("Gemfile") && File.exist?("Gemfile.lock")
+
+      raise Error, "Gemfile and Gemfile.lock must both be present."
     end
 
-    def gemfile
-      @gemfile ||= Gemfile.new
+    def perform_analysis # rubocop:disable Metrics/AbcSize
+      gem_comments = Gemfile.new.gem_comments
+      commands.check? || commands.install
+      old_versions = commands.list
+      commands.update(args)
+      new_versions = commands.list
+      outdated_gems = commands.outdated
+
+      logger.clear_line
+
+      update_report = UpdateReport.new(old_versions: old_versions, new_versions: new_versions)
+      pin_report = PinReport.new(gem_versions: new_versions, outdated_gems: outdated_gems, gem_comments: gem_comments)
+
+      [update_report, pin_report]
     end
   end
 end

data/lib/bundleup/colors.rb

@@ -0,0 +1,56 @@
+module Bundleup
+  module Colors
+    ANSI_CODES = {
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      gray: 90
+    }.freeze
+    private_constant :ANSI_CODES
+
+    class << self
+      attr_writer :enabled
+
+      def enabled?
+        return @enabled if defined?(@enabled)
+
+        @enabled = determine_color_support
+      end
+
+      private
+
+      def determine_color_support
+        if ENV["CLICOLOR_FORCE"] == "1"
+          true
+        elsif ENV["TERM"] == "dumb"
+          false
+        else
+          tty?($stdout) && tty?($stderr)
+        end
+      end
+
+      def tty?(io)
+        io.respond_to?(:tty?) && io.tty?
+      end
+    end
+
+    module_function
+
+    def plain(str)
+      str
+    end
+
+    def strip(str)
+      str.gsub(/\033\[[0-9;]*m/, "")
+    end
+
+    ANSI_CODES.each do |name, code|
+      define_method(name) do |str|
+        return str if str.to_s.empty?
+
+        Colors.enabled? ? "\e[0;#{code};49m#{str}\e[0m" : str
+      end
+    end
+  end
+end

data/lib/bundleup/commands.rb

@@ -0,0 +1,40 @@
+require "forwardable"
+
+module Bundleup
+  class Commands
+    GEMFILE_ENTRY_REGEXP = /\* (\S+) \((\S+)(?: (\S+))?\)/.freeze
+    OUTDATED_2_1_REGEXP = /\* (\S+) \(newest (\S+),.* requested (.*)\)/.freeze
+    OUTDATED_2_2_REGEXP = /^(\S+)\s\s+\S+\s\s+(\d\S+)\s\s+(\S.*?)(?:$|\s\s)/.freeze
+
+    extend Forwardable
+    def_delegators :Bundleup, :shell
+
+    def check?
+      shell.run?(%w[bundle check])
+    end
+
+    def install
+      shell.run(%w[bundle install])
+    end
+
+    def list
+      output = shell.capture(%w[bundle list])
+      output.scan(GEMFILE_ENTRY_REGEXP).each_with_object({}) do |(name, ver, sha), gems|
+        gems[name] = sha || ver
+      end
+    end
+
+    def outdated
+      output = shell.capture(%w[bundle outdated], raise_on_error: false)
+      expr = output.match?(/^Gem\s+Current\s+Latest/) ? OUTDATED_2_2_REGEXP : OUTDATED_2_1_REGEXP
+
+      output.scan(expr).each_with_object({}) do |(name, newest, pin), gems|
+        gems[name] = { newest: newest, pin: pin }
+      end
+    end
+
+    def update(args=[])
+      shell.run(%w[bundle update] + args)
+    end
+  end
+end

data/lib/bundleup/gemfile.rb

@@ -4,14 +4,21 @@ module Bundleup
       @contents = IO.read(path)
     end
 
-    def gem_comment(gem_name)
-      inline_comment(gem_name) || prefix_comment(gem_name)
+    def gem_comments
+      gem_names.each_with_object({}) do |gem, hash|
+        comment = inline_comment(gem) || prefix_comment(gem)
+        hash[gem] = comment unless comment.nil?
+      end
     end
 
     private
 
     attr_reader :contents
 
+    def gem_names
+      contents.scan(/^\s*gem\s+["'](.+?)["']/).flatten.uniq
+    end
+
     def inline_comment(gem_name)
       contents[/#{gem_declaration_re(gem_name)}.*(#\s*\S+.*)/, 1]
     end

data/lib/bundleup/logger.rb

@@ -0,0 +1,64 @@
+require "io/console"
+
+module Bundleup
+  class Logger
+    extend Forwardable
+    def_delegators :@stdout, :print, :puts, :tty?
+    def_delegators :@stdin, :gets
+
+    def initialize(stdin: $stdin, stdout: $stdout, stderr: $stderr)
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @spinner = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏].cycle
+    end
+
+    def ok(message)
+      puts Colors.green("✔ #{message}")
+    end
+
+    def error(message)
+      stderr.puts Colors.red("ERROR: #{message}")
+    end
+
+    def attention(message)
+      puts Colors.yellow(message)
+    end
+
+    def confirm?(question)
+      print Colors.yellow(question.sub(/\??\z/, " [Yn]? "))
+      gets =~ /^($|y)/i
+    end
+
+    def clear_line
+      print "\r".ljust(console_width - 1)
+      print "\r"
+    end
+
+    def while_spinning(message, &block)
+      thread = Thread.new(&block)
+      thread.report_on_exception = false
+      message = message.ljust(console_width - 2)
+      print "\r#{Colors.blue([spinner.next, message].join(' '))}" until wait_for_exit(thread, 0.1)
+      thread.value
+    end
+
+    private
+
+    attr_reader :spinner, :stderr
+
+    def console_width
+      width = IO.console.winsize.last if tty?
+      width.to_i.positive? ? width : 80
+    end
+
+    def wait_for_exit(thread, seconds)
+      thread.join(seconds)
+    rescue StandardError
+      # Sanity check. If we get an exception, the thread should be dead.
+      raise if thread.alive?
+
+      thread
+    end
+  end
+end