bundleup 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82ad26069759aeaa4516bb5305da2d0d75a38e1c30d8efd275b3fd09df6f2697
-  data.tar.gz: 1cec30ec08cf62b3332c6b8b6539c4231fbf6b1bc29f2c8a4069b5afff2d0b83
+  metadata.gz: '02583d0ea6a0b389400ed3c24f312effae81880bbf2409ac25136681f6cd0028'
+  data.tar.gz: e1ffadae2408a04df7d336531b41329e9de416d4b3149644768ef526658561d0
 SHA512:
-  metadata.gz: 388e5e6c1ca95b073319c7cd5954348190c2ff1a2e63836659a966eebc7c4da8583474434c33a979d0f70bc69e02686d8a0c4829fcba4123e25b675665af2ee4
-  data.tar.gz: 651c38cc47925f3bafbbc30b50d777c58dfc2918ca3a1329c182ae38735d6e33fb287cb6ba9096b878c4c137746cdc6baa18726362a02eb036ab7a63db9e77a7
+  metadata.gz: e36564061fd34a361512543e26ded1f2158beb57f019eb3c67e8e1f626f00f1af02d83df19626c36632e07d0ffc1163507a006dacc2080a42fa1c522d6cfdeaa
+  data.tar.gz: db630caef95d92d94c68e83dbd82a9cd1bec082943f377efb1655361802e2f11c86f7800956ae71f7748caa5d22347ee90d5a9d87e83c51087a26bdef7727772

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Matt Brictson
+Copyright (c) 2021 Matt Brictson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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=main)](https://travis-ci.org/mattbrictson/bundleup)
+[![Build Status](https://circleci.com/gh/mattbrictson/bundleup/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/mattbrictson/bundleup?branch=main)
 
 **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`.
 
@@ -19,7 +19,7 @@ Here it is in action:
 ## Requirements
 
 - Bundler 1.16 or later
-- Ruby 2.5 or later
+- Ruby 2.6 or later
 
 ## Usage
 
@@ -44,7 +44,37 @@ Protip: Any extra command-line arguments will be passed along to `bundle update`
 bundleup --group=development
 ```
 
-## How it works
+### Experimental: `--update-gemfile`
+
+> 💡 This is an experimental feature that may be removed or changed in future versions.
+
+Normally bundleup only makes changes to your Gemfile.lock. It honors the version restrictions ("pins") in your Gemfile and will not update your Gemfile.lock to have versions that are not allowed. However with the `--update-gemfile` flag, bundleup can update the version pins in your Gemfile as well. Consider the following Gemfile:
+
+```ruby
+gem 'sidekiq', '~> 5.2'
+gem 'rubocop', '0.89.0'
+```
+
+Normally running `bundleup` will report that these gems are pinned and therefore cannot be updated to the latest versions. However, if you pass the `--update-gemfile` option like this:
+
+```
+$ bundleup --update-gemfile
+```
+
+Now bundleup will automatically edit your Gemfile pins as needed to bring those gems up to date. For example, bundleup would change the Gemfile to look like this:
+
+```ruby
+gem 'sidekiq', '~> 6.1'
+gem 'rubocop', '0.90.0'
+```
+
+Note that `--update-gemfile` will _not_ modify Gemfile entries that contain a comment, like this:
+
+```ruby
+gem 'sidekiq', '~> 5.2' # our monkey patch doesn't work on 6.0+
+```
+
+## How bundleup works
 
 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.)
 

data/lib/bundleup.rb

@@ -9,6 +9,7 @@ require "bundleup/report"
 require "bundleup/shell"
 require "bundleup/pin_report"
 require "bundleup/update_report"
+require "bundleup/version_spec"
 
 module Bundleup
   class << self

data/lib/bundleup/backup.rb

@@ -1,7 +1,7 @@
 module Bundleup
   class Backup
-    def self.restore_on_error(path)
-      backup = new(path)
+    def self.restore_on_error(*paths)
+      backup = new(*paths)
       begin
         yield(backup)
       rescue StandardError, Interrupt
@@ -10,17 +10,20 @@ module Bundleup
       end
     end
 
-    def initialize(path)
-      @path = path
-      @original_contents = IO.read(path)
+    def initialize(*paths)
+      @original_contents = paths.each_with_object({}) do |path, hash|
+        hash[path] = IO.read(path)
+      end
     end
 
     def restore
-      IO.write(path, original_contents)
+      original_contents.each do |path, contents|
+        IO.write(path, contents)
+      end
     end
 
     private
 
-    attr_reader :path, :original_contents
+    attr_reader :original_contents
   end
 end

data/lib/bundleup/cli.rb

@@ -9,7 +9,8 @@ module Bundleup
     def_delegators :Bundleup, :commands, :logger
 
     def initialize(args)
-      @args = args
+      @args = args.dup
+      @update_gemfile = @args.delete("--update-gemfile")
     end
 
     def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -18,24 +19,24 @@ module Bundleup
       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?
-
-        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."
+      Backup.restore_on_error("Gemfile", "Gemfile.lock") do |backup|
+        perform_analysis_and_optionally_bump_gemfile_versions do |update_report, pin_report|
+          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?
+
+          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
     end
@@ -80,6 +81,13 @@ module Bundleup
         these will be passed through to bundler. See #{blue('bundle update --help')} for the
         full list of the options that bundler supports.
 
+        Finally, bundleup also supports an experimental #{yellow('--update-gemfile')} option.
+        If specified, bundleup with modify the version restrictions specified in
+        your Gemfile so that it can install the latest version of each gem. For
+        instance, if your Gemfile specifies #{yellow('gem "sidekiq", "~> 5.2"')} but an update
+        to version 6.1.2 is available, bundleup will modify the Gemfile entry to
+        be #{yellow('gem "sidekiq", "~> 6.1"')} in order to permit the update.
+
         Examples:
 
             #{gray('# Update all gems')}
@@ -91,6 +99,9 @@ module Bundleup
             #{gray('# Only update the rake gem')}
             #{blue('$ bundleup rake')}
 
+            #{gray('# Experimental: modify Gemfile to allow the latest gem versions')}
+            #{blue('$ bundleup --update-gemfile')}
+
       USAGE
       true
     end
@@ -101,6 +112,25 @@ module Bundleup
       raise Error, "Gemfile and Gemfile.lock must both be present."
     end
 
+    def perform_analysis_and_optionally_bump_gemfile_versions # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      gemfile = Gemfile.new
+      lockfile_backup = Backup.new("Gemfile.lock")
+      update_report, pin_report, _, outdated_gems = perform_analysis
+      updatable_gems = gemfile.gem_pins_without_comments.slice(*outdated_gems.keys)
+
+      if updatable_gems.any? && @update_gemfile
+        lockfile_backup.restore
+        orig_gemfile = Gemfile.new
+        gemfile.relax_gem_pins!(updatable_gems.keys)
+        update_report, pin_report, new_versions, = perform_analysis
+        orig_gemfile.shift_gem_pins!(new_versions.slice(*updatable_gems.keys))
+        commands.install
+      end
+
+      logger.clear_line
+      yield(update_report, pin_report)
+    end
+
     def perform_analysis # rubocop:disable Metrics/AbcSize
       gem_comments = Gemfile.new.gem_comments
       commands.check? || commands.install
@@ -109,12 +139,10 @@ module Bundleup
       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]
+      [update_report, pin_report, new_versions, outdated_gems]
     end
   end
 end

data/lib/bundleup/gemfile.rb

@@ -1,18 +1,53 @@
 module Bundleup
   class Gemfile
+    attr_reader :path
+
     def initialize(path="Gemfile")
+      @path = path
       @contents = IO.read(path)
     end
 
     def gem_comments
-      gem_names.each_with_object({}) do |gem, hash|
-        comment = inline_comment(gem) || prefix_comment(gem)
-        hash[gem] = comment unless comment.nil?
+      gem_names.each_with_object({}) do |gem_name, hash|
+        comment = inline_comment(gem_name) || prefix_comment(gem_name)
+        hash[gem_name] = comment unless comment.nil?
+      end
+    end
+
+    def gem_pins_without_comments
+      (gem_names - gem_comments.keys).each_with_object({}) do |gem_name, hash|
+        next unless (match = gem_declaration_with_pinned_version_re(gem_name).match(contents))
+
+        version = match[1]
+        hash[gem_name] = VersionSpec.parse(version)
+      end
+    end
+
+    def relax_gem_pins!(gem_names)
+      gem_names.each do |gem_name|
+        rewrite_gem_version!(gem_name, &:relax)
+      end
+    end
+
+    def shift_gem_pins!(new_gem_versions)
+      new_gem_versions.each do |gem_name, new_version|
+        rewrite_gem_version!(gem_name) { |version_spec| version_spec.shift(new_version) }
       end
     end
 
     private
 
+    def rewrite_gem_version!(gem_name)
+      found = contents.sub!(gem_declaration_with_pinned_version_re(gem_name)) do |match|
+        version = Regexp.last_match[1]
+        match[Regexp.last_match.regexp, 1] = yield(VersionSpec.parse(version)).to_s
+        match
+      end
+      raise "Can't rewrite version for #{gem_name}; it does not have a pin" unless found
+
+      IO.write(path, contents)
+    end
+
     attr_reader :contents
 
     def gem_names
@@ -30,5 +65,9 @@ module Bundleup
     def gem_declaration_re(gem_name)
       /^\s*gem\s+["']#{Regexp.escape(gem_name)}["']/
     end
+
+    def gem_declaration_with_pinned_version_re(gem_name)
+      /#{gem_declaration_re(gem_name)},\s*["']([^'"]+)["']\s*$/
+    end
   end
 end

data/lib/bundleup/report.rb

@@ -3,7 +3,11 @@ require "forwardable"
 module Bundleup
   class Report
     extend Forwardable
-    def_delegators :rows, :empty?
+    def_delegators :rows, :empty?, :one?
+
+    def many?
+      rows.length > 1
+    end
 
     def to_s
       [

data/lib/bundleup/version.rb

@@ -1,3 +1,3 @@
 module Bundleup
-  VERSION = "2.0.0".freeze
+  VERSION = "2.2.0".freeze
 end

data/lib/bundleup/version_spec.rb

@@ -0,0 +1,54 @@
+module Bundleup
+  class VersionSpec
+    def self.parse(version)
+      return version if version.is_a?(VersionSpec)
+
+      version = version.strip
+      _, operator, number = version.match(/^([^\d\s]*)\s*(.+)/).to_a
+      operator = nil if operator.empty?
+
+      new(parts: number.split("."), operator: operator)
+    end
+
+    attr_reader :parts, :operator
+
+    def initialize(parts:, operator: nil)
+      @parts = parts
+      @operator = operator
+    end
+
+    def exact?
+      operator.nil?
+    end
+
+    def relax
+      return self if %w[!= > >=].include?(operator)
+      return self.class.parse(">= 0") if %w[< <=].include?(operator)
+
+      self.class.new(parts: parts, operator: ">=")
+    end
+
+    def shift(new_version) # rubocop:disable Metrics/AbcSize
+      return self.class.parse(new_version) if exact?
+      return self if Gem::Requirement.new(to_s).satisfied_by?(Gem::Version.new(new_version))
+      return self.class.new(parts: self.class.parse(new_version).parts, operator: "<=") if %w[< <=].include?(operator)
+
+      new_slice = self.class.parse(new_version).slice(parts.length)
+      self.class.new(parts: new_slice.parts, operator: "~>")
+    end
+
+    def slice(amount)
+      self.class.new(parts: parts[0, amount], operator: operator)
+    end
+
+    def to_s
+      [operator, parts.join(".")].compact.join(" ")
+    end
+
+    def ==(other)
+      return false unless other.is_a?(VersionSpec)
+
+      to_s == other.to_s
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundleup
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies: []
 description: Use `bundleup` whenever you want to update the locked Gemfile dependencies
   of a Ruby project. It shows exactly what gems will be updated with color output
@@ -38,6 +38,7 @@ files:
 - lib/bundleup/shell.rb
 - lib/bundleup/update_report.rb
 - lib/bundleup/version.rb
+- lib/bundleup/version_spec.rb
 homepage: https://github.com/mattbrictson/bundleup
 licenses:
 - MIT
@@ -54,14 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A friendlier command-line interface for Bundler’s `update` and `outdated`