bundle_update_interactive 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '092dad2541b41d82be0c6d26b8dc6a4b72c9555fcef8743919849f8b57b67a24'
-  data.tar.gz: b73e37e2d76480af7fbbbc22a2d8957f5a364bdacdefd2c9122830895c9de929
+  metadata.gz: c5fa0d1bf9fc3114b352236559c7a91b460b6b2816b3cd0cd3b7bc848fd072b5
+  data.tar.gz: d70836e166741cf2efe13d188d393e094fe1adf50bb02e64f7e997a853dd65a2
 SHA512:
-  metadata.gz: e4dcf48f02f99ee78f8a08e23d0168846c344f0ff7d6c6d5c29c34c6cbf690e16ad2465a299bbf9a2dd8a349f8960737a14ba3d96fbc66864a857ddfabb0736d
-  data.tar.gz: 9789ed423ff5c6a30d2410e873af33126268825dd3571252d087149ab28154d55de04f5027ceb2fcc3ade3bdc04d6f877b55a7e0084ed4d73edc4dac50a2d12e
+  metadata.gz: ab496890f43f89d9519b3e14e32998fad0d888295419dd09ce2d69f546b09a8699e635c31a442aa3990d048dc09d0a864a488307c6f047213369c198aa8b3403
+  data.tar.gz: 4030b23f6982f0732f4a289d637ff94b1881e5b907377af69dcb0f5125c7fa19f29bb016a957c630a094268f30ecdda1d60f9978f1f9231a7e0cff4ca0b6ab23

data/README.md

@@ -42,6 +42,7 @@ bundle ui
 
 ## Options
 
+- `--commit` [applies each gem update in a discrete git commit](#git-commits)
 - `--latest` [modifies the Gemfile if necessary to allow the latest gem versions](#allow-latest-versions)
 - `-D` / `--exclusively=GROUP` [limits updatable gems by Gemfile groups](#limit-impact-by-gemfile-groups)
 
@@ -69,6 +70,27 @@ Some gems, notably `rails`, are composed of smaller gems like `actionpack`, `act
 
 Therefore, if any Rails component has a security vulnerability, `bundle update-interactive` will automatically roll up that information into a single `rails` line item, so you can select it and upgrade all of its components in one shot.
 
+### Git commits
+
+Sometimes, updating gems can lead to bugs or regressions. To facilitate troubleshooting, `update-interactive` offers the ability to commit each selected gem update in its own git commit, complete with a descriptive commit message. You can then make use of tools like `git bisect` to more easily find the update that introduced the problem.
+
+To enable this behavior, pass the `--commit` option:
+
+```
+bundle update-interactive --commit
+```
+
+The gems you select to be updated will be applied in separate commits, like this:
+
+```
+* c9801382 Update activeadmin 3.2.2 → 3.2.3
+* 9957254b Update rexml 3.3.5 → 3.3.6
+* 4a4f2072 Update sass 1.77.6 → 1.77.8
+```
+
+> [!NOTE]
+> In rare cases, Bundler may not be able to update a gem separately, due to interdependencies between gem versions. If this happens, you will see a message like "attempted to update [GEM] but its version stayed the same."
+
 ### Held back gems
 
 When a newer version of a gem is available, but updating is not allowed due to a Gemfile requirement, `update-interactive` will report that the gem has been held back.

data/lib/bundle_update_interactive/cli/options.rb

@@ -61,9 +61,12 @@ module BundleUpdateInteractive
       end
 
       def build_parser(options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        OptionParser.new do |parser|
+        OptionParser.new do |parser| # rubocop:disable Metrics/BlockLength
           parser.summary_indent = "  "
           parser.summary_width = 24
+          parser.on("--commit", "Create a git commit for each selected gem update") do
+            options.commit = true
+          end
           parser.on("--latest", "Modify the Gemfile to allow the latest gem versions") do
             options.latest = true
           end
@@ -90,13 +93,18 @@ module BundleUpdateInteractive
     end
 
     attr_accessor :exclusively
-    attr_writer :latest
+    attr_writer :commit, :latest
 
     def initialize
       @exclusively = []
+      @commit = false
       @latest = false
     end
 
+    def commit?
+      @commit
+    end
+
     def latest?
       @latest
     end

data/lib/bundle_update_interactive/cli.rb

@@ -17,7 +17,13 @@ module BundleUpdateInteractive
       puts "Updating the following gems."
       puts Table.updatable(selected_gems).render
       puts
-      updater.apply_updates(*selected_gems.keys)
+
+      if options.commit?
+        GitCommitter.new(updater).apply_updates_as_individual_commits(*selected_gems.keys)
+      else
+        updater.apply_updates(*selected_gems.keys)
+      end
+
       puts_gemfile_modified_notice if updater.modified_gemfile?
     rescue Exception => e # rubocop:disable Lint/RescueException
       handle_exception(e)

data/lib/bundle_update_interactive/git_committer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module BundleUpdateInteractive
+  class GitCommitter
+    def initialize(updater)
+      @updater = updater
+    end
+
+    def apply_updates_as_individual_commits(*gem_names)
+      assert_git_executable!
+      assert_working_directory_clean!
+
+      gem_names.flatten.each do |name|
+        updates = updater.apply_updates(name)
+        updated_gem = updates[name] || updates.values.first
+        next if updated_gem.nil?
+
+        commit_message = format_commit_message(updated_gem)
+        system "git add Gemfile Gemfile.lock", exception: true
+        system "git commit -m #{commit_message.shellescape}", exception: true
+      end
+    end
+
+    def format_commit_message(outdated_gem)
+      [
+        "Update",
+        outdated_gem.name,
+        outdated_gem.current_version.to_s,
+        outdated_gem.current_git_version,
+        "→",
+        outdated_gem.updated_version.to_s,
+        outdated_gem.updated_git_version
+      ].compact.join(" ")
+    end
+
+    private
+
+    attr_reader :updater
+
+    def assert_git_executable!
+      success = begin
+        `git --version`
+        Process.last_status.success?
+      rescue SystemCallError
+        false
+      end
+      raise Error, "git could not be executed" unless success
+    end
+
+    def assert_working_directory_clean!
+      status = `git status --untracked-files=no --porcelain`.strip
+      return if status.empty?
+
+      raise Error, "`git status` reports uncommitted changes; please commit or stash them them first!\n#{status}"
+    end
+  end
+end

data/lib/bundle_update_interactive/updater.rb

@@ -18,6 +18,11 @@ module BundleUpdateInteractive
     def apply_updates(*gem_names)
       expanded_names = expand_gems_with_exact_dependencies(*gem_names)
       BundlerCommands.update_gems_conservatively(*expanded_names)
+
+      # Return the gems that were actually updated based on observed changes to the lock file
+      updated_gems = build_outdated_gems(File.read("Gemfile.lock"))
+      @current_lockfile = Lockfile.parse
+      updated_gems
     end
 
     # Overridden by Latest::Updater subclass
@@ -32,7 +37,11 @@ module BundleUpdateInteractive
     def find_updatable_gems
       return {} if candidate_gems && candidate_gems.empty?
 
-      updated_lockfile = Lockfile.parse(BundlerCommands.read_updated_lockfile(*Array(candidate_gems)))
+      build_outdated_gems(BundlerCommands.read_updated_lockfile(*Array(candidate_gems)))
+    end
+
+    def build_outdated_gems(lockfile_contents)
+      updated_lockfile = Lockfile.parse(lockfile_contents)
       current_lockfile.entries.each_with_object({}) do |current_lockfile_entry, hash|
         name = current_lockfile_entry.name
         updated_lockfile_entry = updated_lockfile && updated_lockfile[name]

data/lib/bundle_update_interactive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BundleUpdateInteractive
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundle_update_interactive
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/bundle_update_interactive/cli/table.rb
 - lib/bundle_update_interactive/error.rb
 - lib/bundle_update_interactive/gemfile.rb
+- lib/bundle_update_interactive/git_committer.rb
 - lib/bundle_update_interactive/http.rb
 - lib/bundle_update_interactive/latest/gem_requirement.rb
 - lib/bundle_update_interactive/latest/gemfile_editor.rb
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: Adds an update-interactive command to Bundler