ndr_dev_support 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a024102f34097eebbb099cd46d7a962238390cc3be9bea382308f0ae2615ec6
-  data.tar.gz: '0938834d58be0cd0e9b0442fc280d8b2cdca3874d3d76767d35c42c617bc34f8'
+  metadata.gz: 0ddf993378e5cd98d65313341b0af15677fb8934c42eebb91875d49b66b1ff27
+  data.tar.gz: fceda29b2a92b42b2d480926e9079c6f0f7cf2cfb42c6d7c1263fc58308a7bc1
 SHA512:
-  metadata.gz: 7769eed298f1f78be229193b218d83377e81f9410535c28ff44ec241aea43ec55cf7796e762aa2c57dc18decd9daa56c1b1b00e98d258d9b6491ea7b27973e17
-  data.tar.gz: 911e45911f29f14589f7ac63250b1bb1aa14541e76ed4022bb747d113e37aa62e470a326ae90628e3e5367d423f10e40b92bfc89d2177081c2ee34cc4846065e
+  metadata.gz: 22b80f92debe98a7092b9b7a1322792142e459e33b8d2cdc7dbaecbcbd3f4e8fa1757eeb033c0d1c98b36c5f2411130b6f7aa7a6c4a4ec13f06bf20436746290
+  data.tar.gz: be6721ab8d9ea0e37035cd593748f6d15ce7f958cf5fe5e934c13db2c9a8b61c7dbc751c1b217b47f18c9b3950272496af013190fd7e81f752367839d1b9af55

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## [Unreleased]
 * no unreleased changes
 
+## 6.0.3 / 2022-03-14
+### Added
+* Add `bundle:update` rake task to update bundled gem files
+
 ## 6.0.2 / 2022-01-14
 ### Fixed
 * Support Rails 7, Ruby 3.1

data/code_safety.yml

@@ -27,7 +27,7 @@ file safety:
   CHANGELOG.md:
     comments:
     reviewed_by: brian.shand
-    safe_revision: 773282057d09738cde2b4986c2e4a8a79ed40529
+    safe_revision: 5943e1a2ef7095e44858806ad16713cffc67c31b
   CODE_OF_CONDUCT.md:
     comments:
     reviewed_by: timgentry
@@ -226,12 +226,16 @@ file safety:
     safe_revision: ad38e92c6e56b9d81fdab10681d8f2924eeadf5a
   lib/ndr_dev_support/tasks.rb:
     comments:
-    reviewed_by: josh.pencheon
-    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
+    reviewed_by: brian.shand
+    safe_revision: 93f9ed210c6a19eee4884ea8a906067c65ee67f6
   lib/ndr_dev_support/version.rb:
     comments:
     reviewed_by: brian.shand
-    safe_revision: 773282057d09738cde2b4986c2e4a8a79ed40529
+    safe_revision: 5943e1a2ef7095e44858806ad16713cffc67c31b
+  lib/tasks/audit_bundle.rake:
+    comments:
+    reviewed_by: brian.shand
+    safe_revision: 93f9ed210c6a19eee4884ea8a906067c65ee67f6
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support

data/lib/ndr_dev_support/tasks.rb

@@ -1,4 +1,5 @@
 load 'tasks/audit_code.rake'
+load 'tasks/audit_bundle.rake'
 load 'tasks/ci/brakeman.rake'
 load 'tasks/ci/bundle_audit.rake'
 load 'tasks/ci/commit_cop.rake'

data/lib/ndr_dev_support/version.rb

@@ -2,5 +2,5 @@
 # This defines the NdrDevSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks (and our own).
 module NdrDevSupport
-  VERSION = '6.0.2'
+  VERSION = '6.0.3'
 end

data/lib/tasks/audit_bundle.rake

@@ -0,0 +1,170 @@
+# A rake task to update the bundled version of a gem
+
+# Assumes constant SAFETY_FILE and function repository_type are defined in another rake task.
+
+namespace :bundle do
+  desc <<~USAGE
+    Update to a later version of a gem interactively.
+
+    Usage: bundle:update gem=rails [version=6.0.4.7]
+
+    Updates the bundled gem (e.g. rails) version to e.g. 6.0.4.7
+    and provides instructions for committing changes.
+    It will attempt to modify a hardcoded version in the Gemfile if necessary.
+  USAGE
+  task(:update) do
+    unless %w[git git-svn].include?(repository_type)
+      warn 'Error: Requires a git working copy. Aborting.'
+      exit 1
+    end
+
+    gem = ENV['gem']
+    if gem.blank? || gem !~ /\A[a-zA-Z0-9_.-]+\z/
+      warn "Error: missing or invalid required 'gem' parameter. Aborting.\n\n"
+      system('rake -D bundle:update')
+      exit 1
+    end
+
+    gem_list = Bundler.with_unbundled_env { `bundle exec gem list ^#{gem}$` }
+    # Needs to match e.g. "nokogiri (1.12.5 x86_64-darwin)"
+    old_gem_version = gem_list.match(/ \(([0-9.]+)( [a-z0-9_-]*)?\)$/).to_a&.second
+    unless old_gem_version
+      warn <<~MSG.chomp
+        Cannot determine gem version for gem=#{gem}. Aborting. Output from bundle exec gem list:
+        #{gem_list}
+      MSG
+      exit 1
+    end
+    puts "Old #{gem} version from bundle: #{old_gem_version}"
+
+    new_gem_version = ENV['version'].presence
+    if new_gem_version && new_gem_version !~ /\A[0-9.a-zA-Z-]+\z/
+      warn "Error: invalid 'version' parameter. Aborting.\n\n"
+      system('rake -D bundle:update')
+      exit 1
+    end
+
+    unless Bundler.with_unbundled_env { system('bundle check 2> /dev/null') }
+      warn('Error: bundle check fails before doing anything.')
+      warn('Please clean up the Gemfile before running this. Aborting.')
+      exit 1
+    end
+
+    if gem == 'rails'
+      # If updating Rails and using activemodel-caution, prompt to put
+      # activemodel-caution gem in place, unless it's already installed for this rails version.
+      activemodel_caution = Bundler.
+                            with_unbundled_env { `bundle exec gem list activemodel-caution` }.
+                            match?(/^activemodel-caution \([0-9.]+\)$/)
+      if activemodel_caution && new_gem_version
+        file_pattern = "activemodel-caution-#{new_gem_version}*.gem"
+        unless Dir.glob("vendor/cache/#{file_pattern}").any? ||
+               Bundler.with_unbundled_env do
+                 `gem list ^activemodel-caution$ -i -v #{new_gem_version}`
+               end.match?(/^true$/)
+          warn("Error: missing #{file_pattern} file in vendor/cache")
+          warn('Copy this file to vendor/cache, then run this command again.')
+          exit 1
+        end
+      end
+    end
+
+    related_gems = if gem == 'rails'
+                     gem_list2 = Bundler.with_unbundled_env do
+                       `bundle exec gem list`
+                     end
+                     gem_list2.split("\n").
+                       grep(/[ (]#{old_gem_version}(.0)*[,)]/).
+                       collect { |row| row.split.first }
+                   else
+                     [gem]
+                   end
+    puts "Gems to update: #{related_gems.join(' ')}"
+
+    if new_gem_version
+      puts 'Tweaking Gemfile for new gem version'
+      cmd = ['sed', '-i', '.bak', '-E']
+      related_gems.each do |rgem|
+        cmd += ['-e', "s/(gem '(#{rgem})', '(~> )?)#{old_gem_version}(')/\\1#{new_gem_version}\\4/"]
+      end
+      cmd += %w[Gemfile]
+      system(*cmd)
+      File.delete('Gemfile.bak')
+
+      system('git diff Gemfile')
+    end
+
+    cmd = "bundle update --conservative --minor #{related_gems.join(' ')}"
+    puts "Running: #{cmd}"
+    Bundler.with_unbundled_env do
+      system(cmd)
+    end
+
+    unless Bundler.with_unbundled_env { system('bundle check 2> /dev/null') }
+      warn <<~MSG
+        Error: bundle check fails after trying to update Rails version. Aborting.
+        You will need to check your working copy, especially Gemfile, Gemfile.lock, vendor/cache
+      MSG
+      exit 1
+    end
+
+    if File.exist?(SAFETY_FILE)
+      # Remove references to unused files in code_safety.yml
+      system('rake audit:tidy_code_safety_file')
+    end
+
+    gem_list = Bundler.with_unbundled_env { `bundle exec gem list ^#{gem}$` }
+    new_gem_version2 = gem_list.match(/ \(([0-9.]+)( [a-z0-9_-]*)?\)$/).to_a&.second
+
+    if new_gem_version && new_gem_version != new_gem_version2
+      puts <<~MSG
+        Error: Tried to update gem #{gem} to version #{new_gem_version} but ended up at version #{new_gem_version2}. Aborting.
+        You will need to check your working copy, especially Gemfile, Gemfile.lock, vendor/cache
+        Try running:
+           bundle exec rake bundle:update gem=#{gem} version=#{new_gem_version2}
+      MSG
+      exit 1
+    end
+
+    # At this point, we have successfully updated all the local files.
+    # All that remains is to set up a branch, if necessary, and inform the user what to commit.
+
+    puts "Looking for changed files using git status\n\n"
+    files_to_git_rm = `git status vendor/cache/|grep 'deleted: ' | \
+                       grep -o ': .*' | sed -e 's/^: *//'`.split("\n")
+    files_to_git_add = `git status Gemfile Gemfile.lock code_safety.yml|grep 'modified: ' | \
+                        grep -o ': .*' | sed -e 's/^: *//'`.split("\n")
+    files_to_git_add += `git status vendor/cache|expand|grep '^\s*vendor/cache' | \
+                         sed -e 's/^ *//'`.split("\n")
+
+    if files_to_git_rm.empty? && files_to_git_add.empty?
+      puts <<~MSG
+        No changes were made. Please manually update the Gemfile, run
+          bundle update --conservative --minor #{related_gems.join(' ')}
+      MSG
+      puts '  rake audit:tidy_code_safety_file' if File.exist?(SAFETY_FILE)
+      puts <<~MSG
+        then run tests and git rm / git add any changes
+        including vendor/cache Gemfile Gemfile.lock code_safety.yml
+        then git commit
+      MSG
+      exit
+    end
+
+    if repository_type == 'git'
+      # Check out a fresh branch, if a git working copy (but not git-svn)
+      branch_name = "#{gem}_#{new_gem_version2.gsub('.', '_')}"
+      system('git', 'checkout', '-b', branch_name) # Create a new git branch
+    end
+
+    puts <<~MSG
+      Gemfile updated. Please use "git status" and "git diff" to check the local changes,
+      manually add any additional platform-specific gems required (e.g. for nokogiri),
+      re-run tests locally, then run the following to commit the changes:
+
+      $ git rm #{files_to_git_rm.join(' ')}
+      $ git add #{files_to_git_add.join(' ')}
+      $ git commit -m '# Bump #{gem} to #{new_gem_version2}'
+    MSG
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -450,6 +450,7 @@ files:
 - lib/ndr_dev_support/slack_message_publisher.rb
 - lib/ndr_dev_support/tasks.rb
 - lib/ndr_dev_support/version.rb
+- lib/tasks/audit_bundle.rake
 - lib/tasks/audit_code.rake
 - lib/tasks/ci/brakeman.rake
 - lib/tasks/ci/bundle_audit.rake