debian-mirror-gitlab/lib/tasks/gettext.rake

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

176 lines
4.7 KiB
Ruby
Raw Normal View History

2021-02-22 17:27:13 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
require "gettext_i18n_rails/tasks"
namespace :gettext do
2017-09-10 17:25:29 +05:30
task :compile do
2019-12-04 20:38:33 +05:30
# See: https://gitlab.com/gitlab-org/gitlab-foss/issues/33014#note_31218998
2021-02-22 17:27:13 +05:30
FileUtils.touch(pot_file_path)
2017-09-10 17:25:29 +05:30
Rake::Task['gettext:po_to_json'].invoke
end
2018-03-17 18:26:18 +05:30
2019-09-04 21:01:54 +05:30
desc 'Regenerate gitlab.pot file'
2018-11-18 11:00:15 +05:30
task :regenerate do
2021-02-22 17:27:13 +05:30
ensure_locale_folder_presence!
# Clean up folders that do not contain a gitlab.po file
Pathname.new(locale_path).children.each do |child|
next unless child.directory?
folder_path = child.to_path
if File.exist?("#{folder_path}/gitlab.po")
# remove all translated files to speed up finding
FileUtils.rm Dir["#{folder_path}/gitlab.*"]
else
# remove empty translation folders so we don't generate un-needed .po files
puts "Deleting #{folder_path} as it does not contain a 'gitlab.po' file."
FileUtils.rm_r folder_path
end
end
2018-11-18 11:00:15 +05:30
# remove the `pot` file to ensure it's completely regenerated
2021-02-22 17:27:13 +05:30
FileUtils.rm_f(pot_file_path)
2018-11-18 11:00:15 +05:30
Rake::Task['gettext:find'].invoke
# leave only the required changes.
2021-01-03 14:25:43 +05:30
unless system(*%w(git -c core.hooksPath=/dev/null checkout -- locale/*/gitlab.po))
2020-11-24 15:15:51 +05:30
raise 'failed to cleanup generated locale/*/gitlab.po files'
end
2018-11-18 11:00:15 +05:30
2021-02-22 17:27:13 +05:30
raise 'gitlab.pot file not generated' unless File.exist?(pot_file_path)
2018-11-18 11:00:15 +05:30
# Remove timestamps from the pot file
2021-02-22 17:27:13 +05:30
pot_content = File.read pot_file_path
2018-11-18 11:00:15 +05:30
pot_content.gsub!(/^"POT?\-(?:Creation|Revision)\-Date\:.*\n/, '')
2021-02-22 17:27:13 +05:30
File.write pot_file_path, pot_content
2018-11-18 11:00:15 +05:30
puts <<~MSG
All done. Please commit the changes to `locale/gitlab.pot`.
MSG
end
2018-03-17 18:26:18 +05:30
desc 'Lint all po files in `locale/'
task lint: :environment do
require 'simple_po_parser'
require 'gitlab/utils'
2022-01-26 12:08:38 +05:30
require 'parallel'
2018-03-17 18:26:18 +05:30
FastGettext.silence_errors
files = Dir.glob(Rails.root.join('locale/*/gitlab.po'))
linters = files.map do |file|
locale = File.basename(File.dirname(file))
2021-02-22 17:27:13 +05:30
Gitlab::I18n::PoLinter.new(po_path: file, locale: locale)
2018-03-17 18:26:18 +05:30
end
2021-02-22 17:27:13 +05:30
linters.unshift(Gitlab::I18n::PoLinter.new(po_path: pot_file_path))
2018-03-17 18:26:18 +05:30
2022-01-26 12:08:38 +05:30
failed_linters = Parallel
.map(linters, progress: 'Linting po files') { |linter| linter if linter.errors.any? }
.compact
2018-03-17 18:26:18 +05:30
if failed_linters.empty?
puts 'All PO files are valid.'
else
failed_linters.each do |linter|
report_errors_for_file(linter.po_path, linter.errors)
end
raise "Not all PO-files are valid: #{failed_linters.map(&:po_path).to_sentence}"
end
end
2018-11-08 19:23:39 +05:30
task :updated_check do
# Removing all pre-translated files speeds up `gettext:find` as the
# files don't need to be merged.
# Having `LC_MESSAGES/gitlab.mo files present also confuses the output.
FileUtils.rm Dir['locale/**/gitlab.*']
2021-02-22 17:27:13 +05:30
FileUtils.rm_f pot_file_path
2018-11-08 19:23:39 +05:30
# `gettext:find` writes touches to temp files to `stderr` which would cause
# `static-analysis` to report failures. We can ignore these.
2019-02-15 15:39:39 +05:30
silence_stderr do
2018-11-08 19:23:39 +05:30
Rake::Task['gettext:find'].invoke
end
2021-02-22 17:27:13 +05:30
pot_diff = `git diff -- #{pot_file_path} | grep -E '^(\\+|-)msgid'`.strip
2018-11-08 19:23:39 +05:30
# reset the locale folder for potential next tasks
`git checkout -- locale`
if pot_diff.present?
raise <<~MSG
2021-02-22 17:27:13 +05:30
Changes in translated strings found, please update file `#{pot_file_path}` by running:
2018-11-08 19:23:39 +05:30
2018-11-18 11:00:15 +05:30
bin/rake gettext:regenerate
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
Then commit and push the resulting changes to `#{pot_file_path}`.
2018-11-08 19:23:39 +05:30
The diff was:
#{pot_diff}
MSG
end
end
2021-02-22 17:27:13 +05:30
private
# Customize list of translatable files
# See: https://github.com/grosser/gettext_i18n_rails#customizing-list-of-translatable-files
def files_to_translate
folders = %W(ee app lib config #{locale_path}).join(',')
exts = %w(rb erb haml slim rhtml js jsx vue handlebars hbs mustache).join(',')
Dir.glob(
"{#{folders}}/**/*.{#{exts}}"
)
end
2018-03-17 18:26:18 +05:30
def report_errors_for_file(file, errors_for_file)
puts "Errors in `#{file}`:"
errors_for_file.each do |message_id, errors|
puts " #{message_id}"
errors.each do |error|
spaces = ' ' * 4
error = error.lines.join("#{spaces}")
puts "#{spaces}#{error}"
end
end
end
2018-11-20 20:47:30 +05:30
2019-02-15 15:39:39 +05:30
def silence_stderr(&block)
2018-11-20 20:47:30 +05:30
old_stderr = $stderr.dup
$stderr.reopen(File::NULL)
$stderr.sync = true
yield
ensure
$stderr.reopen(old_stderr)
old_stderr.close
end
2021-02-22 17:27:13 +05:30
def ensure_locale_folder_presence!
unless Dir.exist?(locale_path)
raise <<~MSG
Cannot find '#{locale_path}' folder. Please ensure you're running this task from the gitlab repo.
MSG
end
end
def locale_path
@locale_path ||= Rails.root.join('locale')
end
def pot_file_path
@pot_file_path ||= File.join(locale_path, 'gitlab.pot')
end
2017-08-17 22:00:37 +05:30
end