Module: JsLocaleHelper
- Defined in:
- lib/js_locale_helper.rb
Class Method Summary collapse
- .clear_cache! ⇒ Object
- .compile_message_format(path, locale, format) ⇒ Object
-
.deep_delete_matches(deleting_from, checking_hashes) ⇒ Object
deeply removes keys from “deleting_from” that are already present in “checking_hashes”.
- .find_locale(locale_chain, path, type, fallback_to_english:) ⇒ Object
- .find_message_format_locale(locale_chain, fallback_to_english:) ⇒ Object
- .find_moment_locale(locale_chain, timezone_names: false) ⇒ Object
- .generate_message_format(message_formats, locale, filename) ⇒ Object
- .join_key(prefix, key) ⇒ Object
- .load_translations(locale) ⇒ Object
- .load_translations_merged(*locales) ⇒ Object
- .moment_format_function(name) ⇒ Object
- .moment_formats ⇒ Object
- .moment_locale(locale, timezone_names: false) ⇒ Object
- .output_client_overrides(main_locale) ⇒ Object
- .output_extra_locales(bundle, locale) ⇒ Object
- .output_locale(locale) ⇒ Object
- .plugin_client_files(locale_str) ⇒ Object
- .plugin_translations(locale_str) ⇒ Object
- .reloadable_plugins(locale_sym, ctx) ⇒ Object
- .remove_message_formats!(translations, locale) ⇒ Object
- .reset_context ⇒ Object
- .strip_out_message_formats!(hash, prefix = "", message_formats = {}) ⇒ Object
- .translations_for(locale_str) ⇒ Object
- .with_context ⇒ Object
Class Method Details
.clear_cache! ⇒ Object
114 115 116 117 118 |
# File 'lib/js_locale_helper.rb', line 114 def self.clear_cache! @loaded_translations = nil @plugin_translations = nil @loaded_merges = nil end |
.compile_message_format(path, locale, format) ⇒ Object
341 342 343 344 345 346 347 348 349 350 |
# File 'lib/js_locale_helper.rb', line 341 def self.(path, locale, format) with_context do |ctx| ctx.load(path) if File.exist?(path) ctx.eval("mf = new MessageFormat('#{locale}');") ctx.eval("mf.precompile(mf.parse(#{format.inspect}))") end rescue MiniRacer::EvalError => e = +"Invalid Format: " << e. "function(){ return #{.inspect};}" end |
.deep_delete_matches(deleting_from, checking_hashes) ⇒ Object
deeply removes keys from “deleting_from” that are already present in “checking_hashes”
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/js_locale_helper.rb', line 73 def self.deep_delete_matches(deleting_from, checking_hashes) checking_hashes.compact! new_hash = deleting_from.dup deleting_from.each do |key, value| if value.is_a?(Hash) new_at_key = deep_delete_matches(deleting_from[key], checking_hashes.map { |h| h[key] }) if new_at_key.empty? new_hash.delete(key) else new_hash[key] = new_at_key end else new_hash.delete(key) if checking_hashes.any? { |h| h.include?(key) } end end new_hash end |
.find_locale(locale_chain, path, type, fallback_to_english:) ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/js_locale_helper.rb', line 256 def self.find_locale(locale_chain, path, type, fallback_to_english:) locale_chain.map!(&:to_s) locale_chain.each do |locale| plugin_locale = DiscoursePluginRegistry.locales[locale] return plugin_locale[type] if plugin_locale&.has_key?(type) locale = yield(locale) if block_given? filename = File.join(path, "#{locale}.js") return locale, filename if File.exist?(filename) end locale_chain.map! { |locale| yield(locale) } if block_given? # try again, but this time only with the language itself locale_chain = locale_chain.map { |l| l.split(/[-_]/)[0] }.uniq.reject { |l| locale_chain.include?(l) } if locale_chain.any? locale_data = find_locale(locale_chain, path, type, fallback_to_english: false) return locale_data if locale_data end # English should always work ["en", File.join(path, "en.js")] if fallback_to_english end |
.find_message_format_locale(locale_chain, fallback_to_english:) ⇒ Object
251 252 253 254 |
# File 'lib/js_locale_helper.rb', line 251 def self.(locale_chain, fallback_to_english:) path = "#{Rails.root}/lib/javascripts/locale" find_locale(locale_chain, path, :message_format, fallback_to_english: fallback_to_english) end |
.find_moment_locale(locale_chain, timezone_names: false) ⇒ Object
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/js_locale_helper.rb', line 235 def self.find_moment_locale(locale_chain, timezone_names: false) if timezone_names path = "#{Rails.root}/vendor/assets/javascripts/moment-timezone-names-locale" type = :moment_js_timezones else path = "#{Rails.root}/vendor/assets/javascripts/moment-locale" type = :moment_js end find_locale(locale_chain, path, type, fallback_to_english: false) do |locale| locale = MOMENT_LOCALE_MAPPING[locale] if MOMENT_LOCALE_MAPPING.key?(locale) # moment.js uses a different naming scheme for locale files locale.tr("_", "-").downcase end end |
.generate_message_format(message_formats, locale, filename) ⇒ Object
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/js_locale_helper.rb', line 301 def self.(, locale, filename) formats = .map { |k, v| k.inspect << " : " << (filename, locale, v) } .join(", ") result = +"MessageFormat = {locale: {}};\n" result << "I18n._compiledMFs = {#{formats}};\n" result << File.read(filename) << "\n" if locale != "en" # Include "en" pluralization rules for use in fallbacks _, en_filename = (["en"], fallback_to_english: false) result << File.read(en_filename) << "\n" end result << File.read("#{Rails.root}/lib/javascripts/messageformat-lookup.js") << "\n" end |
.join_key(prefix, key) ⇒ Object
382 383 384 |
# File 'lib/js_locale_helper.rb', line 382 def self.join_key(prefix, key) prefix.blank? ? key : "#{prefix}.#{key}" end |
.load_translations(locale) ⇒ Object
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/js_locale_helper.rb', line 32 def self.load_translations(locale) @loaded_translations ||= HashWithIndifferentAccess.new @loaded_translations[locale] ||= begin locale_str = locale.to_s # load default translations yml_file = "#{Rails.root}/config/locales/client.#{locale_str}.yml" if File.exist?(yml_file) translations = YAML.load_file(yml_file) else # If we can't find a base file in Discourse, it might only exist in a plugin # so let's start with a basic object we can merge into translations = { locale_str => { "js" => {}, "admin_js" => {}, "wizard_js" => {} } } end # merge translations (plugin translations overwrite default translations) if translations[locale_str] && plugin_translations(locale_str) translations[locale_str]["js"] ||= {} translations[locale_str]["admin_js"] ||= {} translations[locale_str]["wizard_js"] ||= {} if plugin_translations(locale_str)["js"] translations[locale_str]["js"].deep_merge!(plugin_translations(locale_str)["js"]) end if plugin_translations(locale_str)["admin_js"] translations[locale_str]["admin_js"].deep_merge!( plugin_translations(locale_str)["admin_js"], ) end if plugin_translations(locale_str)["wizard_js"] translations[locale_str]["wizard_js"].deep_merge!( plugin_translations(locale_str)["wizard_js"], ) end end translations end end |
.load_translations_merged(*locales) ⇒ Object
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/js_locale_helper.rb', line 92 def self.load_translations_merged(*locales) locales = locales.uniq.compact @loaded_merges ||= {} @loaded_merges[locales.join("-")] ||= begin all_translations = {} merged_translations = {} loaded_locales = [] locales .map(&:to_s) .each do |locale| all_translations[locale] = load_translations(locale) merged_translations[locale] = deep_delete_matches( all_translations[locale][locale], loaded_locales.map { |l| merged_translations[l] }, ) loaded_locales << locale end merged_translations end end |
.moment_format_function(name) ⇒ Object
291 292 293 294 |
# File 'lib/js_locale_helper.rb', line 291 def self.moment_format_function(name) format = I18n.t("dates.#{name}") "moment.fn.#{name.camelize(:lower)} = function(){ return this.format('#{format}'); };\n" end |
.moment_formats ⇒ Object
283 284 285 286 287 288 289 |
# File 'lib/js_locale_helper.rb', line 283 def self.moment_formats result = +"" result << moment_format_function("short_date_no_year") result << moment_format_function("short_date") result << moment_format_function("long_date") result << "moment.fn.relativeAge = function(opts){ return Discourse.Formatter.relativeAge(this.toDate(), opts)};\n" end |
.moment_locale(locale, timezone_names: false) ⇒ Object
296 297 298 299 |
# File 'lib/js_locale_helper.rb', line 296 def self.moment_locale(locale, timezone_names: false) _, filename = find_moment_locale([locale], timezone_names: timezone_names) filename && File.exist?(filename) ? File.read(filename) << "\n" : "" end |
.output_client_overrides(main_locale) ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/js_locale_helper.rb', line 170 def self.output_client_overrides(main_locale) all_overrides = {} has_overrides = false I18n.fallbacks[main_locale].each do |locale| overrides = all_overrides[locale] = TranslationOverride .where(locale: locale) .where("translation_key LIKE 'js.%' OR translation_key LIKE 'admin_js.%'") .pluck(:translation_key, :value, :compiled_js) has_overrides ||= overrides.present? end return "" if !has_overrides result = +"I18n._overrides = {};" existing_keys = Set.new = [] all_overrides.each do |locale, overrides| translations = {} overrides.each do |key, value, compiled_js| next if existing_keys.include?(key) existing_keys << key if key.end_with?("_MF") << "#{key.inspect}: #{compiled_js}" else translations[key] = value end end result << "I18n._overrides['#{locale}'] = #{translations.to_json};" if translations.present? end result << "I18n._mfOverrides = {#{.join(", ")}};" result end |
.output_extra_locales(bundle, locale) ⇒ Object
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/js_locale_helper.rb', line 211 def self.output_extra_locales(bundle, locale) translations = translations_for(locale) locales = translations.keys locales.each do |l| translations[l].keys.each do |k| bundle_translations = translations[l].delete(k) translations[l].deep_merge!(bundle_translations) if k == bundle end end return "" if translations.blank? output = +"if (!I18n.extras) { I18n.extras = {}; }" locales.each { |l| output << <<~JS } if (!I18n.extras["#{l}"]) { I18n.extras["#{l}"] = {}; } Object.assign(I18n.extras["#{l}"], #{translations[l].to_json}); JS output end |
.output_locale(locale) ⇒ Object
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/js_locale_helper.rb', line 137 def self.output_locale(locale) locale_str = locale.to_s fallback_locale_str = LocaleSiteSetting.fallback_locale(locale_str)&.to_s translations = translations_for(locale_str) = (translations, locale) mf_locale, mf_filename = ([locale_str], fallback_to_english: true) result = (, mf_locale, mf_filename) translations.keys.each do |l| translations[l].keys.each { |k| translations[l].delete(k) unless k == "js" } end # I18n result << "I18n.translations = #{translations.to_json};\n" result << "I18n.locale = '#{locale_str}';\n" if fallback_locale_str && fallback_locale_str != "en" result << "I18n.fallbackLocale = '#{fallback_locale_str}';\n" end if mf_locale != "en" result << "I18n.pluralizationRules.#{locale_str} = MessageFormat.locale.#{mf_locale};\n" end # moment result << File.read("#{Rails.root}/vendor/assets/javascripts/moment.js") result << File.read("#{Rails.root}/vendor/assets/javascripts/moment-timezone-with-data.js") result << moment_locale(locale_str) result << moment_locale(locale_str, timezone_names: true) result << moment_formats result end |
.plugin_client_files(locale_str) ⇒ Object
4 5 6 7 |
# File 'lib/js_locale_helper.rb', line 4 def self.plugin_client_files(locale_str) files = Dir["#{Rails.root}/plugins/*/config/locales/client*.#{locale_str}.yml"] I18n::Backend::DiscourseI18n.sort_locale_files(files) end |
.plugin_translations(locale_str) ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/js_locale_helper.rb', line 16 def self.plugin_translations(locale_str) @plugin_translations ||= HashWithIndifferentAccess.new @plugin_translations[locale_str] ||= begin translations = {} plugin_client_files(locale_str).each do |file| if plugin_translations = YAML.load_file(file)[locale_str] translations.deep_merge!(plugin_translations) end end translations end end |
.reloadable_plugins(locale_sym, ctx) ⇒ Object
9 10 11 12 13 14 |
# File 'lib/js_locale_helper.rb', line 9 def self.reloadable_plugins(locale_sym, ctx) return unless Rails.env.development? I18n.fallbacks[locale_sym].each do |locale| plugin_client_files(locale.to_s).each { |file| ctx.depend_on(file) } end end |
.remove_message_formats!(translations, locale) ⇒ Object
352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/js_locale_helper.rb', line 352 def self.(translations, locale) = {} I18n.fallbacks[locale] .map(&:to_s) .each do |l| next unless translations.key?(l) %w[js admin_js].each do |k| .merge!((translations[l][k])) end end end |
.reset_context ⇒ Object
320 321 322 323 |
# File 'lib/js_locale_helper.rb', line 320 def self.reset_context @ctx&.dispose @ctx = nil end |
.strip_out_message_formats!(hash, prefix = "", message_formats = {}) ⇒ Object
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/js_locale_helper.rb', line 366 def self.(hash, prefix = "", = {}) if hash.is_a?(Hash) hash.each do |key, value| if value.is_a?(Hash) .merge!( (value, join_key(prefix, key), ), ) elsif key.to_s.end_with?("_MF") [join_key(prefix, key)] = value hash.delete(key) end end end end |
.translations_for(locale_str) ⇒ Object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/js_locale_helper.rb', line 120 def self.translations_for(locale_str) clear_cache! if Rails.env.development? locale_sym = locale_str.to_sym translations = I18n.with_locale(locale_sym) do if locale_sym == :en load_translations(locale_sym) else load_translations_merged(*I18n.fallbacks[locale_sym]) end end Marshal.load(Marshal.dump(translations)) end |
.with_context ⇒ Object
326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/js_locale_helper.rb', line 326 def self.with_context @mutex.synchronize do yield( @ctx ||= begin ctx = MiniRacer::Context.new(timeout: 15_000, ensure_gc_after_idle: 2000) ctx.load( "#{Rails.root}/app/assets/javascripts/node_modules/messageformat/messageformat.js", ) ctx end ) end end |