immosquare-yaml 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0027d98da59d293455ed3ecc827d8ea7b590ccaad6de14e5dae5600465435f24
-  data.tar.gz: 3aa9d65fac9378b573f6a6a7bb0ef11687b7907f452efa587c6a62856aae700c
+  metadata.gz: d9afa19ff5189bcdfaddb188ecc98ef79a37de47d53ba42946eb0fbcbdd37ddc
+  data.tar.gz: 9daa5ffd7cf997c57d65bc19a067a8d73d9fca89cc43c34a1db91d10d3f6550b
 SHA512:
-  metadata.gz: c07201514552bc8446fd47bfc642dd7929e6d249580c1fbaf61788199ecf298d9dee38fe6c6df56acbaeba1ca266eb52f2eeea8e22110d6b667a0b2ac41d42b8
-  data.tar.gz: abdc76c7496b7bd47ffa3a0c9906ced2e31f18de0c05a6d755e7259449f28145666281cbcec23aad9759303271478fdd0bc5f67749e1bba877dca261da167f67
+  metadata.gz: 90f7bba1a8418feaad8fa81dc958db7f891ea0d5279f4c0e282b8cc1521fed2935a2b9e92feca9aa961cb0f0ba27918366ae6c6d5f3448bdc6ec3dc9ac466dfb
+  data.tar.gz: f8b61971635c0626e2f3ef0d7e9d2311a2b6c518e5fd0e20e21e69a1a3587b86c0bbb4124c2b337614c5cdcbbfa4c318566d055eae85a4ca8c1b48e9ead42acb

data/lib/immosquare-yaml/shared_methods.rb

@@ -7,6 +7,7 @@ module ImmosquareYaml
     SIMPLE_QUOTE        = "'".freeze
     DOUBLE_QUOTE        = '"'.freeze
     DOUBLE_SIMPLE_QUOTE = "''".freeze
+    CUSTOM_SEPARATOR    = "_#_#_".freeze
     WEIRD_QUOTES_REGEX  = /‘|’|“|”|‛|‚|„|‟|#{Regexp.quote(DOUBLE_SIMPLE_QUOTE)}/.freeze
     YML_SPECIAL_CHARS   = ["-", "`", "{", "}", "|", "[", "]", ">", ":", "\"", "'", "*", "=", "%", ",", "!", "?", "&", "#", "@"].freeze
     RESERVED_KEYS       = [

data/lib/immosquare-yaml/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareYaml
-  VERSION = "0.1.16".freeze
+  VERSION = "0.1.17".freeze
 end

data/lib/immosquare-yaml.rb

@@ -1,4 +1,5 @@
 require          "English"
+require          "psych"
 require          "immosquare-extensions"
 require_relative "immosquare-yaml/configuration"
 require_relative "immosquare-yaml/shared_methods"
@@ -16,9 +17,6 @@ module ImmosquareYaml
 
   class << self
 
-
-
-
     ##===========================================================================##
     ## Gem configuration
     ##===========================================================================##
@@ -151,6 +149,7 @@ module ImmosquareYaml
         ##===========================================================================##
         File.write(file_path, original_content) if !original_content.nil?
         puts(e.message)
+        puts(e.backtrace)
         false
       end
     end
@@ -215,6 +214,17 @@ module ImmosquareYaml
         when Hash
           lines << line
           dump(value, lines, indent + INDENT_SIZE)
+        when Array
+          formated_value = Psych.dump(value)
+          if formated_value == "--- []\n"
+            lines << "#{line} []"
+          else
+            formated_value = formated_value.gsub("---#{NEWLINE}", NOTHING)
+              .split(NEWLINE).map {|l| "#{SPACE * (INDENT_SIZE + indent)}#{l}" }
+              .join(NEWLINE)
+            lines << line
+            lines << formated_value
+          end
         end
       end
 
@@ -305,7 +315,6 @@ module ImmosquareYaml
         ##============================================================##
         current_line = current_line.rstrip
 
-
         ##===================================================================================#
         ## Detecting blank lines to specially handle the last line within a block;
         ## if we are inside a block or it's the last line, we avoid skipping
@@ -457,10 +466,18 @@ module ImmosquareYaml
         ## my key: line1 line2 line3
         ##============================================================##
         elsif split.size < 2
-          lines[-1] = (lines[-1] + " #{current_line.lstrip}").gsub(NEWLINE, NOTHING)
+          if current_line.lstrip.start_with?("-")
+            lines << current_line
+          else
+            lines[-1] = (lines[-1] + " #{current_line.lstrip}").gsub(NEWLINE, NOTHING)
+          end
         ##============================================================##
         ## Otherwise we are in the case of a classic line
-        ## key: value or key: without value
+        ## key: value
+        ## or
+        ## key: without value
+        ## - key: value (list)
+        ## - key: without value (list)
         ##============================================================##
         else
           key           = clean_key(key)
@@ -541,94 +558,129 @@ module ImmosquareYaml
       key
     end
 
+    ##============================================================##
+    ## " [apple, orange, 'banana']" => [apple, orange, 'banana']
+    ##============================================================##
+    def string_in_array(string)
+      begin
+        string_striped = string.strip
+        string_striped.match(/^\[.*\]$/) ? string_striped[1..-2].split(/,\s?/) : string
+      rescue StandardError
+        string
+      end
+    end
+
     ##============================================================##
     ## clean_value Function
     ## Purpose: Sanitize and standardize YAML values
     ## In YAML "inblock" scenarios, there's no need to add quotes
     ## around values as it's inherently handled.
     ## ============================================================ ##
-    def clean_value(value, with_quotes_verif = true)
+    def clean_value(values, with_quotes_verif = true)
       ##============================================================##
-      ## Convert value to string to prevent issues in subsequent operations
+      ## Convert key to array if not
+      ## fruits: [apple, orange, 'banana']
+      ## demo: "demo"
       ##============================================================##
-      value = value.to_s
+      is_array = string_in_array(values)
+      values   = is_array.instance_of?(String) ? [values] : is_array
 
-      ##============================================================##
-      ## Remove newline characters at the end of the value if present.
-      ## This should be done prior to strip operation to handle scenarios
-      ## where the value ends with a space followed by a newline.
-      ###============================================================##
-      value = value[0..-2] if value.end_with?(NEWLINE)
 
+      values = values.map do |value|
+        ##============================================================##
+        ## Convert value to string to prevent issues in subsequent operations
+        ##============================================================##
+        value = value.to_s
 
-      ##============================================================##
-      ## Clean up the value:
-      ## - Remove tabs, carriage returns, form feeds, and vertical tabs.
-      ## \t: corresponds to a tab
-      ## \r: corresponds to a carriage return
-      ## \f: corresponds to a form feed
-      ## \v: corresponds to a vertical tab
-      ## We keep the \n
-      ##============================================================##
-      value = value.gsub(/[\t\r\f\v]+/, NOTHING)
+        ##============================================================##
+        ## Remove newline characters at the end of the value if present.
+        ## This should be done prior to strip operation to handle scenarios
+        ## where the value ends with a space followed by a newline.
+        ###============================================================##
+        value = value[0..-2] if value.end_with?(NEWLINE)
 
-      ##============================================================##
-      ## Replace multiple spaces with a single space.
-      ##============================================================##
-      value = value.gsub(/ {2,}/, SPACE)
 
-      ##============================================================##
-      ## Trim leading and trailing spaces.
-      ##============================================================##
-      value = value.strip
+        ##============================================================##
+        ## Clean up the value:
+        ## - Remove tabs, carriage returns, form feeds, and vertical tabs.
+        ## \t: corresponds to a tab
+        ## \r: corresponds to a carriage return
+        ## \f: corresponds to a form feed
+        ## \v: corresponds to a vertical tab
+        ## We keep the \n
+        ##============================================================##
+        value = value.gsub(/[\t\r\f\v]+/, NOTHING)
 
-      ##============================================================##
-      ## Replace special quotes with standard single quotes.
-      ##============================================================##
-      value = value.gsub(WEIRD_QUOTES_REGEX, SIMPLE_QUOTE)
+        ##============================================================##
+        ## Replace multiple spaces with a single space.
+        ##============================================================##
+        value = value.gsub(/ {2,}/, SPACE)
 
-      ##============================================================##
-      ## Remove all quotes surrounding the value if they are present.
-      ## They will be re-added later if necessary.
-      ## """"value"""" => value
-      ##============================================================##
-      value = value[1..-2] while (value.start_with?(DOUBLE_QUOTE) && value.end_with?(DOUBLE_QUOTE)) || (value.start_with?(SIMPLE_QUOTE) && value.end_with?(SIMPLE_QUOTE))
+        ##============================================================##
+        ## Trim leading and trailing spaces.
+        ##============================================================##
+        value = value.strip
 
-      ##============================================================##
-      ## Convert emoji representations such as \U0001F600 to their respective emojis.
-      ##============================================================##
-      value = value.gsub(/\\U([0-9A-Fa-f]{8})/) { [::Regexp.last_match(1).to_i(16)].pack("U*") }
-
-      ##=============================================================##
-      ## 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:
-      ## RESERVED_KEYS.include?(value)          => key: YES
-      ## value.start_with?(SPACE)               => key: 'text'
-      ## value.end_with?(SPACE)                 => key: text '
-      ##=============================================================##
-      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?(":") ||
-                                  RESERVED_KEYS.include?(value) ||
-                                  value.start_with?(SPACE) ||
-                                  value.end_with?(SPACE)
+        ##============================================================##
+        ## Replace special quotes with standard single quotes.
+        ##============================================================##
+        value = value.gsub(WEIRD_QUOTES_REGEX, SIMPLE_QUOTE)
+
+        ##============================================================##
+        ## Remove all quotes surrounding the value if they are present.
+        ## They will be re-added later if necessary.
+        ## """"value"""" => value
+        ##============================================================##
+        value = value[1..-2] while (value.start_with?(DOUBLE_QUOTE) && value.end_with?(DOUBLE_QUOTE)) || (value.start_with?(SIMPLE_QUOTE) && value.end_with?(SIMPLE_QUOTE))
+
+        ##============================================================##
+        ## Convert emoji representations such as \U0001F600 to their respective emojis.
+        ##============================================================##
+        value = value.gsub(/\\U([0-9A-Fa-f]{8})/) { [::Regexp.last_match(1).to_i(16)].pack("U*") }
+
+        ##=============================================================##
+        ## 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:
+        ## RESERVED_KEYS.include?(value)          => key: YES
+        ## value.start_with?(SPACE)               => key: 'text'
+        ## value.end_with?(SPACE)                 => key: text '
+        ##=============================================================##
+        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?(":") ||
+                                    (is_array ? false : RESERVED_KEYS.include?(value)) ||
+                                    value.start_with?(SPACE) ||
+                                    value.end_with?(SPACE)
+        end
+        value
+      end
+      is_array.instance_of?(String) ? values.first : "[#{values.join(", ")}]"
+    end
+
+    ##============================================================##
+    ## Normalize indentation for array values without intent
+    ## for the first level.
+    ##============================================================##
+    def normalize_indentation(lines)
+      initial_indentation = lines.first.match(/^(\s*)/)[1].length
+      lines.map do |line|
+        line[initial_indentation..(line.end_with?(NEWLINE) ? -2 : -1)]
       end
-      value
     end
 
     ##============================================================##
@@ -641,8 +693,11 @@ module ImmosquareYaml
     def parse_xml(file_path)
       nested_hash = {}
       inblock     = nil
+      inlist      = nil
+      inlist_data = nil
       last_keys   = []
 
+
       ##============================================================##
       ## We go over each line of the file to create a hash.
       ## We put the multiline blocks in an array to recover
@@ -669,11 +724,34 @@ module ImmosquareYaml
         inblock = nil if !inblock.nil? && !blank_line && indent_level <= inblock
 
 
+        ##============================================================##
+        ## inlist Enter
+        ##============================================================##
+        if inlist.nil? && !blank_line && line.strip.start_with?("-")
+          inlist      = indent_level
+          inlist_data = []
+        end
+
+        ##============================================================##
+        ## inlist Exit
+        ## We use Pscyh to parse the yaml of the list content
+        ##============================================================##
+        if !inlist.nil? && !blank_line && indent_level < inlist
+          yaml                = normalize_indentation(inlist_data).join(NEWLINE)
+          current_key         = last_keys.last
+          parent_keys         = last_keys[0..-2]
+          result              = parent_keys.reduce(nested_hash) {|hash, k| hash[k] }
+          result[current_key] = Psych.safe_load(yaml, :permitted_classes => [Date])
+          inlist              = nil
+          inlist_data         = []
+        end
+
         ##============================================================##
         ## Set the key level based on indentation
         ##============================================================##
         last_keys = last_keys[0, (blank_line ? inblock + INDENT_SIZE : indent_level) / INDENT_SIZE]
 
+
         ##============================================================##
         ## If inside a multi-line block, append the line to the current key's value
         ##============================================================##
@@ -683,6 +761,11 @@ module ImmosquareYaml
           result                = parent_keys.reduce(nested_hash) {|hash, k| hash[k] }
           result[current_key][1] << line.strip
         ##============================================================##
+        ## Handle list declarations.
+        ##============================================================##
+        elsif !inlist.nil?
+          inlist_data << line
+        ##============================================================##
         ## Handle multi-line key declarations.
         ## We no longer have the >
         ## because it is transformed in the clean_xml into |
@@ -691,7 +774,7 @@ module ImmosquareYaml
           inblock     = indent_level
           block_type  = line.gsub("#{key}:", NOTHING).strip
           result      = last_keys.reduce(nested_hash) {|hash, k| hash[k] }
-          result[key] = [block_type, []]
+          result[key] = ["#{CUSTOM_SEPARATOR}#{block_type}#{CUSTOM_SEPARATOR}", []]
           last_keys << key
         ##============================================================##
         ## Handle regular key-value pair declarations
@@ -703,11 +786,12 @@ module ImmosquareYaml
             result[key] = {}
             last_keys << key
           else
-            result[key] = value.strip == "null" ? nil : value
+            result[key] = value.strip == "null" ? nil : string_in_array(value)
           end
         end
       end
 
+
       ##============================================================##
       ## We go over each value then we process if it is a has
       ## | with final newline
@@ -716,14 +800,13 @@ module ImmosquareYaml
       ## |4- without newline and indentation of 4
       ##============================================================##
       deep_transform_values(nested_hash) do |value|
-        if value.is_a?(Array)
-          style_type   = value[0]
+        if value.is_a?(Array) && !value[0].nil? && value[0].instance_of?(String) && value[0].start_with?(CUSTOM_SEPARATOR) && value[0].end_with?(CUSTOM_SEPARATOR)
+          style_type   = value[0].gsub(CUSTOM_SEPARATOR, NOTHING)
           indent_supp  = style_type.scan(/\d+/).first&.to_i || 0
           indent_supp  = [indent_supp - INDENT_SIZE, 0].max
           value[1]     = value[1].map {|l| "#{SPACE * indent_supp}#{l}" }
           text         = value[1].join(NEWLINE)
           modifier     = style_type[-1]
-
           case modifier
           when "+"
             text << NEWLINE unless text.end_with?(NEWLINE)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - IMMO SQUARE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.1.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.1.11
 - !ruby/object:Gem::Dependency
   name: iso-639
   requirement: !ruby/object:Gem::Requirement