ndr_dev_support 6.0.1 → 6.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8ff07e3e56e4665b16792797daed209e8842a69ea341959b6a6631eb8ced02
-  data.tar.gz: fcac18ced590c4d02cbe4664572a741f6ff439637064c5213af2d30b6d8c5efa
+  metadata.gz: c974533f2670deb4a3c97be7fcc5e979441873e779dd30db443b1e3813aee8eb
+  data.tar.gz: 62927ddd9ce5a70f3870543aa6e15734489bca3449eccf5d8b18e3e145c79fae
 SHA512:
-  metadata.gz: b85718ff1c1076d682c42b75c2257d89e40f0bb1b654c622a15006565b326499476a6d50d82c90bd6b0fcd8b5c70557d534a58866851364e256606b22a134e4a
-  data.tar.gz: e6fd89a89b2cae3cff85ea645feac1d9e26b6610305af90c4276d1b967352927272a62452adac95f271c22bf33a1e9b718100617a0f756d484d3f2db88a21da5
+  metadata.gz: b0960ae0595c55f024ec201113772e225087398cb24f30b63728d08712cbd2d80570a161b60b20f91f45de5948b977ed5bd647b6af783bcbb3d791390743ab40
+  data.tar.gz: 1e6a5753db64d820f8499170662a0677065ee3222257cc959bb688efeb5508d34c351c686be8272938b093ba3ac9a7423704732a3b347e0f83c4c385687dae57

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
-*no unreleased changes*
+* no unreleased changes
+
+## 6.0.4 / 2022-03-14
+### Fixed
+* bundle:update should commit code_safety.yml 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
 
 ## 6.0.1 / 2021-07-09
 ### Fixed

data/code_safety.yml

@@ -10,8 +10,8 @@ file safety:
     safe_revision: 0ce43640c417e174054f903fd82043948ebe8ccb
   ".github/workflows/test.yml":
     comments:
-    reviewed_by: joshpencheon
-    safe_revision: 366ef1122fa4502c25cba9e508c565989545ef25
+    reviewed_by: brian.shand
+    safe_revision: 65d59fe9bba9dc7d404f92b54a115b14e6697af9
   ".gitignore":
     comments:
     reviewed_by: josh.pencheon
@@ -27,7 +27,7 @@ file safety:
   CHANGELOG.md:
     comments:
     reviewed_by: brian.shand
-    safe_revision: d4d4ea4d2dcdf68819e75cbdac1009b145740b22
+    safe_revision: 25fcab1b2df9476bfa294085a46073b218785c19
   CODE_OF_CONDUCT.md:
     comments:
     reviewed_by: timgentry
@@ -72,6 +72,10 @@ file safety:
     comments:
     reviewed_by: joshpencheon
     safe_revision: f25001ef74c44ab727eef5cb29cef9a54525d36f
+  gemfiles/Gemfile.rails70:
+    comments:
+    reviewed_by: brian.shand
+    safe_revision: 65d59fe9bba9dc7d404f92b54a115b14e6697af9
   lib/minitest/rake_ci.rb:
     comments:
     reviewed_by: josh.pencheon
@@ -222,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: d4d4ea4d2dcdf68819e75cbdac1009b145740b22
+    safe_revision: 25fcab1b2df9476bfa294085a46073b218785c19
+  lib/tasks/audit_bundle.rake:
+    comments:
+    reviewed_by: brian.shand
+    safe_revision: 9682c3eb39a98d5a5256732af647a8bd7750826b
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
@@ -300,7 +308,7 @@ file safety:
   ndr_dev_support.gemspec:
     comments:
     reviewed_by: brian.shand
-    safe_revision: 5cb6964bee8c7a7856193232f6b06653235a8309
+    safe_revision: 65d59fe9bba9dc7d404f92b54a115b14e6697af9
   test/daemon/ci_server_test.rb:
     comments:
     reviewed_by: josh.pencheon

data/gemfiles/Gemfile.rails70

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activesupport', '~> 7.0.0'

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.1'.freeze
+  VERSION = '6.0.4'
 end

data/lib/tasks/audit_bundle.rake

@@ -0,0 +1,171 @@
+# 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[1]
+    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[1]
+
+    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 config/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

data/ndr_dev_support.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'webdrivers', '>= 3.9'
 
   # CI server dependencies:
-  spec.add_dependency 'activesupport', '< 7'
+  spec.add_dependency 'activesupport', '< 7.1'
   spec.add_dependency 'brakeman', '>= 4.7.1'
   spec.add_dependency 'bundler-audit'
   spec.add_dependency 'github-linguist'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.4
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -410,6 +410,7 @@ files:
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
 - gemfiles/Gemfile.rails61
+- gemfiles/Gemfile.rails70
 - lib/minitest/rake_ci.rb
 - lib/minitest/rake_ci_plugin.rb
 - lib/ndr_dev_support.rb
@@ -449,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