Merge pull request magento-commerce/devdocs#3231

Add rake update:migrated_links_at

Author: dshevtsov

Rakefile

@@ -13,6 +13,8 @@ require 'html-proofer'
 require 'kramdown'
 require 'launchy'
 require 'colorator'
+require 'csv'
+require 'rdoc'
 
 # Require helper methods from the 'lib' directory
 Dir.glob('lib/**/*.rb') { |file| require_relative(file) }

rakelib/update.rake

@@ -48,6 +48,66 @@ namespace :update do
  update_dir subrepo['directory']
  end
  end
+
+ desc "Find and replace links from 'tmp/migrated-from-to.csv' in files at the provided directory.
+ Arguments:
+ - 'dir' is an absolute path to the directory to process the links. Required.
+ - 'exclude' is an fnmatch pattern for paths to exclude from processing. For fnmatch format, see https://ruby-doc.org/core-2.7.5/Dir.html#method-c-glob. Optional.
+ Examples:
+ rake update:migrated_links_at dir=path/to/codebase.
+ rake update:migrated_links_at dir=path/to/codebase exclude='**/Test/**'"
+ task :migrated_links_at do
+ # check if 'tmp/migrated-from-to.csv' exists
+ links_file = 'tmp/migrated-from-to.csv'
+ unless File.exist? links_file
+ abort 'FAILED. Missing "tmp/migrated-from-to.csv" file. Make sure that your _config.local.yml file contains the "migrated_log: generate_file" parameter.'
+ end
+ # check if the provided directory ('dir') exist
+ dir = File.expand_path(ENV['dir'])
+ unless dir
+ abort 'FAILED. Missing argument "dir". Provide a directory to check the links. Example: rake update:migrated_links_at dir=path/to/codebase'
+ end
+ unless Dir.exist?(dir)
+ abort "FAILED. Check the path provided through the 'dir' argument. The provide directory does not exist: #{dir}"
+ end
+ exclude = ENV['exclude']
+ # parse 'tmp/migrated-from-to.csv'
+ links = CSV.read links_file
+ # for each file in dir, find and replace all links
+ puts 'Work in progress...'.magenta
+ dir_glob_pattern = File.join(dir, '**', '*')
+ full_file_list = Dir[dir_glob_pattern]
+ # exclude paths by pattern from the file list if the 'exclude' argument was added
+ if exclude
+ exclude_glob_pattern = File.join(dir, exclude)
+ excluded_file_list = Dir[exclude_glob_pattern]
+ final_file_list = full_file_list - excluded_file_list
+ else
+ final_file_list = full_file_list
+ end
+
+ final_file_list.each do |file|
+ # ignore directory paths
+ next if File.directory? file
+ # ignore symlinks
+ next if File.symlink? file
+ # ignore empty files
+ next if File.zero? file
+ # ignore binary files
+ next if RDoc::Parser.binary? file
+
+ # read the file
+ content = File.read file
+ # iterate through the array of links
+ links.each do |redirect|
+ # replace first link from the array with the second links
+ content.gsub!(redirect[0], redirect[1])
+ end
+ # write the update content back to the file
+ File.write(file, content)
+ end
+ puts 'Done!'.green
+ end
 end
 
 def update_dir(dir)