immosquare-yaml 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 233ee6e552c634b6fb640a401882a01deb01f114f63ad3abdd3822e00c1895a8
-  data.tar.gz: 8e998672d8c72a2894e78d93eebf2dfdc8c6c4df892e0a1c4834399d4961d39f
+  metadata.gz: 8e9284e5c8a302af2d5c35d6a88ec0bbaea401be34629800f585347a9ad0de22
+  data.tar.gz: f9e2da6ee693fe3e001eaa6ec9d233bca746c805b2eaabacecc9152d4fe7e781
 SHA512:
-  metadata.gz: 3d089b20cfa08b4f73c5bf0483a01aea667104a5745c4cc4e8fca96200c9453efa271b192b3f0b6701edd4c105e69b8620fa7a39cd7cd92e8eb590a98d81d101
-  data.tar.gz: 07eaaf3c64d95808a28b8dc10f413ea18c18429878a980e5456b3e6779f6969b44d41770fbf413bdd51b9b131bc30a3c4c537f18737fcd9f9e89efb469021b44
+  metadata.gz: 523ee5214b2a8bef47ddad6f94c2035cc84eef36d2312a144b07757546f9487d7baeb2c88ecbd0e1558fc3571ec7c868f40518e214fd80b59320bf505c829293
+  data.tar.gz: 980155dbb44f8bba350c060b20d64f3cb0106f2d84d374b7aa6953ace6df467cdbb5db539830e9b93f1762b5d34c69ca28abecc7ba327dc3bb6c011056615439

data/lib/immosquare-yaml/shared_methods.rb

@@ -28,18 +28,5 @@ module ImmosquareYaml
         end
       end
     end
-
-    ##============================================================##
-    ## sort_by_key Function
-    ## Purpose: Sort a hash by its keys, optionally recursively, with
-    ## case-insensitive comparison and stripping of double quotes.
-    ## ============================================================ #
-    def sort_by_key(hash, recursive = false, &block)
-      block ||= proc {|a, b| a.to_s.downcase.gsub("\"", "") <=> b.to_s.downcase.gsub("\"", "") }
-      hash.keys.sort(&block).each_with_object({}) do |key, seed|
-        seed[key] = hash[key]
-        seed[key] = sort_by_key(seed[key], true, &block) if recursive && seed[key].is_a?(Hash)
-      end
-    end
   end
 end

data/lib/immosquare-yaml/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareYaml
-  VERSION = "0.1.11".freeze
+  VERSION = "0.1.13".freeze
 end

data/lib/immosquare-yaml.rb

@@ -1,9 +1,16 @@
+require          "English"
+require          "immosquare-extensions"
 require_relative "immosquare-yaml/configuration"
 require_relative "immosquare-yaml/shared_methods"
 require_relative "immosquare-yaml/translate"
 require_relative "immosquare-yaml/railtie" if defined?(Rails)
 
-
+##===========================================================================##
+## Importing the 'English' library allows us to use more human-readable
+## global variables, such as $INPUT_RECORD_SEPARATOR instead of $/,
+## which enhances code clarity and makes it easier to understand
+## the purpose of these variables in our code.
+##===========================================================================##
 module ImmosquareYaml
   extend SharedMethods
 
@@ -48,6 +55,7 @@ module ImmosquareYaml
       }.merge(options)
 
       begin
+        output_file_path = nil
         raise("File not found") if !File.exist?(file_path)
 
         ##===========================================================================##
@@ -67,7 +75,7 @@ module ImmosquareYaml
         ##===========================================================================##
         clean_yml(file_path)
         parsed_yml = parse(file_path)
-        parsed_yml = sort_by_key(parsed_yml, options[:sort])
+        parsed_yml = parsed_yml.sort_by_key(true)
         parsed_yml = dump(parsed_yml)
 
         ##===========================================================================##
@@ -82,7 +90,12 @@ module ImmosquareYaml
         File.write(output_file_path, parsed_yml)
         true
       rescue StandardError => e
+        ##===========================================================================##
+        ## Restore original content if necessary
+        ##===========================================================================##
+        File.write(file_path, original_content) if output_file_path != file_path && !original_content.nil?
         puts(e.message)
+        puts(e.backtrace)
         false
       end
     end
@@ -104,6 +117,7 @@ module ImmosquareYaml
       options = {:sort => true}.merge(options)
 
       begin
+        original_content = nil
         raise("File not found") if !File.exist?(file_path)
 
         ##===========================================================================##
@@ -112,22 +126,30 @@ module ImmosquareYaml
         original_content = File.read(file_path)
 
         ##===========================================================================##
-        ## clean, parse & Sort
+        ## clean the file
         ##===========================================================================##
         clean_yml(file_path)
+
+        ##===========================================================================##
+        ## parse the file & sort if necessary
+        ##===========================================================================##
         parsed_xml = parse_xml(file_path)
-        parsed_xml = sort_by_key(parsed_xml, options[:sort]) if options[:sort]
+        parsed_xml = parsed_xml.sort_by_key(true) if options[:sort]
 
         ##===========================================================================##
         ## Restore original content
         ##===========================================================================##
-        File.write(file_path, original_content)
+        File.write(file_path, original_content) if !original_content.nil?
 
         ##===========================================================================##
         ## Return the parsed YAML file
         ##===========================================================================##
         parsed_xml
       rescue StandardError => e
+        ##===========================================================================##
+        ## Restore original content
+        ##===========================================================================##
+        File.write(file_path, original_content) if !original_content.nil?
         puts(e.message)
         false
       end
@@ -222,21 +244,23 @@ module ImmosquareYaml
     ## The total number of lines in the normalized file.
     ##===========================================================================##
     def normalize_last_line(file_path)
+      end_of_line = $INPUT_RECORD_SEPARATOR
       ##============================================================##
       ## Read all lines from the file
       ## https://gist.github.com/guilhermesimoes/d69e547884e556c3dc95
       ##============================================================##
       content = File.read(file_path)
 
+
       ##===========================================================================##
       ## Remove all trailing empty lines at the end of the file
-      content.gsub!(/#{Regexp.escape($INPUT_RECORD_SEPARATOR)}+\z/, "")
       ##===========================================================================##
+      content.gsub!(/#{Regexp.escape(end_of_line)}+\z/, "")
 
       ##===========================================================================##
-      ## Append a newline at the end to maintain the file structure
-      ###===========================================================================##
-      content += $INPUT_RECORD_SEPARATOR
+      ## Append an EOL at the end to maintain the file structure
+      ##===========================================================================##
+      content << end_of_line
 
       ##===========================================================================##
       ## Write the modified lines back to the file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - IMMO SQUARE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: immosquare-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 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.