immosquare-yaml 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c14b630cc0f5e121db85ea66b43d18c0d59ae69e2f99db80bdeaf7077b35c5ca
-  data.tar.gz: 06073e555050eb9d7971135fcdab6b6ec1d00f29f283c5ab68153c5306a0c8d9
+  metadata.gz: aef05b6cde6a978367813b253fe4dcc378674aa2b6e0192efe967caaf5babd21
+  data.tar.gz: 1bea9842a643d06132b023cf10c8e1f3624c94d83fdff9d62509017fc6873064
 SHA512:
-  metadata.gz: da0e7f956a8cf9e1f5a2bac7d03114961d2b2d2b31d41c40b54fe17d853102bd97012cca89d7425c80fd1b04498a847c10641e65690223ea34aec9fa5c1b5798
-  data.tar.gz: 463d134187834be1649dddf650615f440712282d07448b9254de0d57b4c8d64419091a114bc2c4d23630a4cb3c28408202ebc34e7d1b91a30cf6a7ef78e2975e
+  metadata.gz: b067dc205dd3e76680c7b76cc851a7676244fcbfb224865f8fdd7368ea185b7fc7612e282c621144b44c7edde5edb13e0dd7db43baa4d6a62ec9a5aa58bfbd1d
+  data.tar.gz: 226772ab6581607c3d41ba8e3fe0bdb360d12e900a4440eba6554d0eb646d7b518f91794dae055f6ff234a798f74b1f0678e5e908dd36e41170441e28f43884a

data/lib/immosquare-yaml.rb

@@ -32,10 +32,23 @@ module ImmosquareYaml
       ##============================================================##
       ## Default options
       ##============================================================##
-      options = {:sort => true}.merge(options)
+      options = {
+        :sort   => true,
+        :output => file_path
+      }.merge(options)
       
       begin
         raise("File not found") if !File.exist?(file_path)
+        
+        ##===========================================================================##
+        ## Setup variables
+        ##===========================================================================##
+        output_file_path = options[:output]
+
+        ##===========================================================================##
+        ## Backup original content for restoration after parsing if necessary
+        ##===========================================================================##
+        original_content = File.read(file_path) if output_file_path != file_path
 
         ##===========================================================================##
         ## The cleaning procedure is initialized with a comprehensive clean, transforming 
@@ -43,10 +56,20 @@ module ImmosquareYaml
         ## rewriting it to the YAML file in its cleaned and optionally sorted state.
         ##===========================================================================##
         clean_yml(file_path)
-        yaml_final = parse(file_path)
-        yaml_final = sort_by_key(yaml_final, options[:sort]) if options[:sort]
-        yaml_final = dump(yaml_final)
-        File.write(file_path, yaml_final)  
+        parsed_yml = parse(file_path)
+        parsed_yml = sort_by_key(parsed_yml, options[:sort])
+        parsed_yml = dump(parsed_yml)
+
+        ##===========================================================================##
+        ## Restore original content if necessary
+        ##===========================================================================##
+        File.write(file_path, original_content) if output_file_path != file_path
+        
+        ##===========================================================================##
+        ## Write the cleaned YAML content to the specified output file
+        ##===========================================================================##
+        FileUtils.mkdir_p(File.dirname(output_file_path))
+        File.write(output_file_path, parsed_yml)  
         true
       rescue StandardError => e
         puts(e.message)
@@ -73,10 +96,27 @@ module ImmosquareYaml
       begin
         raise("File not found") if !File.exist?(file_path)
 
+        ##===========================================================================##
+        ## Backup original content for restoration after parsing
+        ##===========================================================================##
+        original_content = File.read(file_path)
+
+        ##===========================================================================##
+        ## clean, parse & Sort
+        ##===========================================================================##
         clean_yml(file_path)
-        yaml_final = parse_xml(file_path)
-        yaml_final = sort_by_key(yaml_final, options[:sort]) if options[:sort]
-        yaml_final
+        parsed_xml = parse_xml(file_path)
+        parsed_xml = sort_by_key(parsed_xml, options[:sort]) if options[:sort]
+
+        ##===========================================================================##
+        ## Restore original content
+        ##===========================================================================##
+        File.write(file_path, original_content)
+
+        ##===========================================================================##
+        ## Return the parsed YAML file
+        ##===========================================================================##
+        parsed_xml
       rescue StandardError => e
         puts(e.message)
         false
@@ -123,6 +163,12 @@ module ImmosquareYaml
             line        += "-" if !value.end_with?(NEWLINE)
             lines << line
 
+            ##============================================================##
+            ## Remove quotes surrounding the value if they are present.
+            ## They are not necessary in this case after | or |-
+            ##============================================================##
+            value = value[1..-2] if (value.start_with?(DOUBLE_QUOTE) && value.end_with?(DOUBLE_QUOTE)) || (value.start_with?(SIMPLE_QUOTE) && value.end_with?(SIMPLE_QUOTE))
+
             ##=============================================================##
             ## We parse on the 2 types of line breaks
             ##=============================================================##
@@ -464,7 +510,7 @@ module ImmosquareYaml
       ## Re-add quotes if the key is in the list of reserved keys or is an integer
       ##============================================================##
       key = key.gsub(/\A(['“”‘’"]?)(.*)\1\z/, '\2')
-      key = "\"#{key}\"" if key.in?(RESERVED_KEYS) || is_int
+      key = "\"#{key}\"" if RESERVED_KEYS.include?(key) || is_int
       key
     end
     
@@ -528,33 +574,31 @@ module ImmosquareYaml
       ##=============================================================##
       ## Handling cases where the value must be surrounded by quotes
       ## if:
+      ## management of "" and " ". Not possible to have more spaces
+      ## because we have already removed the double spaces
+      ## else
       ## value.include?(": ")                   => key: text with: here
       ## value.include?(" #")                   => key: text with # here
       ## value.include?(NEWLINE)                => key: Line 1\nLine 2\nLine 3
       ## value.include?('\n')                   => key: Line 1"\n"Line 2"\n"Line 3
       ## value.start_with?(*YML_SPECIAL_CHARS)  => key: @text
       ## value.end_with?(":")                   => key: text:
-      ## value.in?(RESERVED_KEYS)               => key: YES
+      ## RESERVED_KEYS.include?(value)          => key: YES
       ## value.start_with?(SPACE)               => key: 'text'
       ## value.end_with?(SPACE)                 => key: text '
-      ## else:
-      ## management of "" and " ". Not possible to have more spaces
-      ## because we have already removed the double spaces
       ##=============================================================##
-      if value.present?
-        value = "\"#{value}\"" if (value.include?(": ") || 
+      if value.empty?
+        value = "\"#{value}\""
+      elsif with_quotes_verif == true
+        value = "\"#{value}\"" if value.include?(": ") || 
                                   value.include?(" #") ||
                                   value.include?(NEWLINE) || 
                                   value.include?('\n') || 
                                   value.start_with?(*YML_SPECIAL_CHARS) ||
                                   value.end_with?(":") ||
-                                  value.in?(RESERVED_KEYS) ||
+                                  RESERVED_KEYS.include?(value) ||
                                   value.start_with?(SPACE) || 
-                                  value.end_with?(SPACE)) &&
-                                  with_quotes_verif == true
-        
-      else
-        value = "\"#{value}\""
+                                  value.end_with?(SPACE)        
       end
       value
     end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImmosquareYaml
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - IMMO SQUARE
@@ -24,9 +24,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 0.2.5
-description: IMMOSQUARE-YAML is a lightweight and efficient YAML parser designed to
-  facilitate the handling of real estate data in YAML format, offering streamlined
-  processes and a simplified user experience.
+description: IMMOSQUARE-YAML is a specialized Ruby gem tailored primarily for parsing
+  and dumping YML translation files, addressing challenges faced with other parsers
+  like interpreting translation keys as booleans, multi-line strings, and more.
 email:
 - jules@immosquare.com
 executables: []
@@ -54,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
-summary: A YAML parser tailored for real estate solutions.
+summary: A YAML parser optimized for translation files.
 test_files: []