Add support to split keys on a certain charater for yaml and rails format

Author: chrztoph

app/javascript/components/forms/AddEditExportConfigForm.tsx

@@ -334,12 +334,14 @@ export function AddEditExportConfigForm(props: IAddEditExportConfigFormProps) {
                         </Select>
                     </Form.Item>
 
-                    {selectedFileFormat?.attributes.format === "json" && (
+                    {(selectedFileFormat?.attributes.format === "json" ||
+                        selectedFileFormat?.attributes.format === "yaml" ||
+                        selectedFileFormat?.attributes.format === "rails") && (
                         <>
                             <h3>Split keys on</h3>
                             <p>
-                                Provide a string upon which the JSON keys are split and grouped together. This way you
-                                can created nested JSON.
+                                Provide a string upon which the keys are split and grouped together. This way you can
+                                create nested structures.
                             </p>
                             <Form.Item name="splitOn">
                                 <Input placeholder="For example: ." />

app/models/export_config.rb

@@ -528,13 +528,24 @@ def yaml(
       end
     end
 
+    final_data = converted_data
+
+    # If the export config has a split_on specified split it.
+    unless self.split_on.nil?
+      final_data = {}
+      converted_data.each do |key, value|
+        splitted = key.split(self.split_on)
+        deep_set(final_data, value, *splitted)
+      end
+    end
+
     language_file = Tempfile.new(language.id.to_s)
     data = {}
 
     if group_by_language_and_country_code
-      data[language.language_tag] = converted_data
+      data[language.language_tag] = final_data
     else
-      data = converted_data
+      data = final_data
     end
 
     yaml = YAML.dump(data.deep_stringify_keys)

spec/models/__snapshots__/create_rails_file_content_split_on.snap

@@ -0,0 +1,6 @@
+---
+de-AT:
+  a: b
+  x:
+    y:
+      z: d

spec/models/__snapshots__/create_yaml_file_content_plural_split_on.snap

@@ -0,0 +1,18 @@
+---
+a:
+  zero: zero text
+  one: one text
+  two: two text
+  few: few text
+  many: many text
+  other: b
+c:
+  zero: zero text
+  one: one text
+  two: two text
+  few: few text
+  many: many text
+  other: d
+x:
+  y:
+    z: '123'

spec/models/export_config_spec.rb

@@ -494,20 +494,21 @@ def export_data_value(text, pluralization_enabled: false, empty_plurals: false)
 
   # YAML
   context 'when file format is yaml' do
-    let(:export_config) do
+    it 'create yaml file content from parsed data' do
       export_config = ExportConfig.new
       export_config.file_format = FileFormat.find_by!(format: 'yaml')
       export_config.file_path = 'my_file_path'
-      export_config
-    end
 
-    it 'create yaml file content from parsed data' do
       files = export_config.files(@language, { 'a' => export_data_value('b'), 'c' => export_data_value('d') })
       files[0][:file].open
       expect(files[0][:file].read).to match_snapshot('create_yaml_file_content')
     end
 
     it 'create yaml file content from plural data' do
+      export_config = ExportConfig.new
+      export_config.file_format = FileFormat.find_by!(format: 'yaml')
+      export_config.file_path = 'my_file_path'
+
       files =
         export_config.files(
           @language,
@@ -520,22 +521,49 @@ def export_data_value(text, pluralization_enabled: false, empty_plurals: false)
       files[0][:file].open
       expect(files[0][:file].read).to match_snapshot('create_yaml_file_content_plural')
     end
+
+    it 'create yaml file content from plural data with split on' do
+      export_config = ExportConfig.new
+      export_config.file_format = FileFormat.find_by!(format: 'yaml')
+      export_config.file_path = 'my_file_path'
+      export_config.split_on = '.'
+
+      files =
+        export_config.files(
+          @language,
+          {
+            'a' => export_data_value('b', pluralization_enabled: true),
+            'c' => export_data_value('d', pluralization_enabled: true),
+            'x.y.z' => export_data_value('123')
+          }
+        )
+      files[0][:file].open
+      expect(files[0][:file].read).to match_snapshot('create_yaml_file_content_plural_split_on')
+    end
   end
 
   # Rails
   context 'when file format is rails' do
-    let(:export_config) do
+    it 'create rails file content from parsed data' do
       export_config = ExportConfig.new
       export_config.file_format = FileFormat.find_by!(format: 'rails')
       export_config.file_path = 'my_file_path'
-      export_config
-    end
 
-    it 'create rails file content from parsed data' do
       files = export_config.files(@language, { 'a' => export_data_value('b'), 'c' => export_data_value('d') })
       files[0][:file].open
       expect(files[0][:file].read).to match_snapshot('create_rails_file_content')
     end
+
+    it 'create rails file content from parsed data with split on' do
+      export_config = ExportConfig.new
+      export_config.file_format = FileFormat.find_by!(format: 'rails')
+      export_config.file_path = 'my_file_path'
+      export_config.split_on = '.'
+
+      files = export_config.files(@language, { 'a' => export_data_value('b'), 'x.y.z' => export_data_value('d') })
+      files[0][:file].open
+      expect(files[0][:file].read).to match_snapshot('create_rails_file_content_split_on')
+    end
   end
 
   # TOML