Surface foreseeable stringsdict conversion failures as clean user errors

The helper raised bare `RuntimeError`s for input/config problems a user
can fix — a missing or malformed `.stringsdict`/`.po`, colliding keys, a
source entry with no `other` form, or a `.po` whose declared `nplurals`
has drifted from the `PluralRules` table. fastlane treats a non-`Fastlane`
`Error` as an internal crash, so these surfaced as a stack trace with a
"report this bug" prompt instead of an actionable message — including the
plural-count guard, which is precisely the signal to regenerate the table.

Route them through `UI.user_error!` (the convention the other helpers
follow), so they raise `FastlaneCore::Interface::FastlaneError` and
fastlane prints them cleanly. `PluralRules::UnknownLocaleError` stays a
plain error converted by the reverse action, keeping that module free of a
UI dependency. The existing specs now assert the `FastlaneError` type so
this can't regress to a bare `raise`.

Author: jkmassel

lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_stringsdict_helper.rb

@@ -55,12 +55,12 @@ class StringsdictHelper
         #
         # @param [String] path The path to the `.stringsdict` file.
         # @return [Hash] The parsed plist dictionary.
-        # @raise [RuntimeError] If the file is missing or is not a plist dictionary.
+        # @raise [FastlaneCore::Interface::FastlaneError] If the file is missing or is not a plist dictionary.
         def self.read(path:)
-          raise "Stringsdict file not found: #{path}" unless File.exist?(path)
+          UI.user_error!("Stringsdict file not found: #{path}") unless File.exist?(path)
 
           data = Plist.parse_xml(path)
-          raise "Invalid stringsdict file (expected a plist dictionary at the root): #{path}" unless data.is_a?(Hash)
+          UI.user_error!("Invalid stringsdict file (expected a plist dictionary at the root): #{path}") unless data.is_a?(Hash)
 
           data
         end
@@ -84,7 +84,7 @@ def self.write(data:, path:)
         #        source `.stringsdict` files.
         # @param [String] output_path The `.pot` file to write.
         # @return [Integer] The number of plural entries written.
-        # @raise [RuntimeError] If two entries would produce the same `msgctxt`.
+        # @raise [FastlaneCore::Interface::FastlaneError] If two entries would produce the same `msgctxt`.
         def self.generate_pot(stringsdict_paths:, output_path:)
           po = GetText::PO.new
           po.order = :none
@@ -99,8 +99,8 @@ def self.generate_pot(stringsdict_paths:, output_path:)
               variables.each do |var_name, var_dict|
                 context = context_for(key: key, variable: var_name, single_variable: single)
                 if seen_contexts.key?(context)
-                  raise "Duplicate translation context '#{context}' generated from `#{path}` (also produced by " \
-                        "`#{seen_contexts[context]}`). Stringsdict keys must be unique across the files being converted."
+                  UI.user_error!("Duplicate translation context '#{context}' generated from `#{path}` (also produced by " \
+                                 "`#{seen_contexts[context]}`). Stringsdict keys must be unique across the files being converted.")
                 end
                 seen_contexts[context] = path
                 entries << build_pot_entry(context: context, var_dict: var_dict, key: key, variable: var_name)
@@ -130,8 +130,8 @@ def self.generate_pot(stringsdict_paths:, output_path:)
         # @return [Array<String>] Contexts present in the template for which the
         #         `.po` had no usable translation (filled from English as fallback).
         # @raise [PluralRules::UnknownLocaleError] If the locale has no mapping.
-        # @raise [RuntimeError] If a translated entry's form count doesn't match
-        #         the locale's expected plural-category count.
+        # @raise [FastlaneCore::Interface::FastlaneError] If a translated entry's form count
+        #         doesn't match the locale's expected plural-category count.
         def self.generate_stringsdict_from_po(po_path:, template_path:, locale:, output_path:)
           template = read(path: template_path)
           po = parse_po(po_path)
@@ -205,8 +205,8 @@ def self.build_pot_entry(context:, var_dict:, key:, variable:)
           singular = var_dict['one'] || var_dict['other']
           plural = var_dict['other']
           if singular.nil? || plural.nil?
-            raise "Stringsdict entry '#{key}' is missing a required plural form " \
-                  "(needs at least 'other'; 'one' recommended for the singular)."
+            UI.user_error!("Stringsdict entry '#{key}' is missing a required plural form " \
+                           "(needs at least 'other'; 'one' recommended for the singular).")
           end
 
           warn_dropped_categories(key: key, variable: variable, var_dict: var_dict)
@@ -256,9 +256,9 @@ def self.translated_forms(parsed_po:, context:, source_var:)
         def self.validate_form_count!(forms:, categories:, context:, locale:)
           return if forms.size == categories.size
 
-          raise "Translation for '#{context}' has #{forms.size} plural form(s) but locale '#{locale}' " \
-                "expects #{categories.size} (#{categories.join(', ')}). The translation system's plural " \
-                'configuration for this locale does not match the expected CLDR categories.'
+          UI.user_error!("Translation for '#{context}' has #{forms.size} plural form(s) but locale '#{locale}' " \
+                         "expects #{categories.size} (#{categories.join(', ')}). The translation system's plural " \
+                         'configuration for this locale does not match the expected CLDR categories.')
         end
 
         # A translated entry that has some — but not all — of its plural forms
@@ -313,7 +313,7 @@ def self.english_variable(source_var)
         end
 
         def self.parse_po(path)
-          raise "PO file not found: #{path}" unless File.exist?(path)
+          UI.user_error!("PO file not found: #{path}") unless File.exist?(path)
 
           po = GetText::PO.new
           GetText::POParser.new.parse(File.read(path), po)
@@ -339,10 +339,10 @@ def self.guard_po_plural_count!(po_path:, locale:, categories:)
           declared = declared_nplurals(po_path)
           return if declared.nil? || declared == categories.size
 
-          raise "Locale '#{locale}': the .po declares nplurals=#{declared}, but the expected plural mapping has " \
-                "#{categories.size} categor#{categories.size == 1 ? 'y' : 'ies'} (#{categories.join(', ')}). " \
-                "GlotPress's plural rule for this locale no longer matches the PluralRules table — regenerate it " \
-                '(rakelib/generate_ios_plural_rules.rb).'
+          UI.user_error!("Locale '#{locale}': the .po declares nplurals=#{declared}, but the expected plural mapping has " \
+                         "#{categories.size} categor#{categories.size == 1 ? 'y' : 'ies'} (#{categories.join(', ')}). " \
+                         "GlotPress's plural rule for this locale no longer matches the PluralRules table — regenerate it " \
+                         '(rakelib/generate_ios_plural_rules.rb).')
         end
 
         def self.add_header(po_data)

spec/ios_stringsdict_helper_spec.rb

@@ -51,7 +51,7 @@ def convert_po_to_stringsdict(po_content, template:, locale:)
 
     it 'raises if the file is missing' do
       expect { described_class.read(path: 'does-not-exist.stringsdict') }
-        .to raise_error(/Stringsdict file not found/)
+        .to raise_error(FastlaneCore::Interface::FastlaneError, /Stringsdict file not found/)
     end
   end
 
@@ -112,7 +112,7 @@ def convert_po_to_stringsdict(po_content, template:, locale:)
             stringsdict_paths: [fixture('simple.stringsdict'), fixture('simple.stringsdict')],
             output_path: pot
           )
-        end.to raise_error(/Duplicate translation context/)
+        end.to raise_error(FastlaneCore::Interface::FastlaneError, /Duplicate translation context/)
       end
     end
 
@@ -129,7 +129,7 @@ def convert_po_to_stringsdict(po_content, template:, locale:)
           path: bad
         )
         expect { described_class.generate_pot(stringsdict_paths: bad, output_path: File.join(dir, 'o.pot')) }
-          .to raise_error(/missing a required plural form/)
+          .to raise_error(FastlaneCore::Interface::FastlaneError, /missing a required plural form/)
       end
     end
 
@@ -302,7 +302,7 @@ def convert_po_to_stringsdict(po_content, template:, locale:)
       # plural rule has drifted from the table — the signal to regenerate it.
       expect do
         convert_po_to_stringsdict(simple_po(forms: %w[a b], nplurals: 2), template: simple, locale: 'ru')
-      end.to raise_error(/declares nplurals=2.*3 categor/m)
+      end.to raise_error(FastlaneCore::Interface::FastlaneError, /declares nplurals=2.*3 categor/m)
     end
   end
 end