kvx 0.9.1 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682f52238fb054d8d2eb1f53d25782d1b5cbdbce7da2431a3d1a107e6a8518a9
-  data.tar.gz: 1579826620b98ad2a70e1924b5220321e03cf9427f712eb3ce4b4719de5b9af3
+  metadata.gz: 9ddaef947e49b210dbee31fcf56ec84e3644681c6a790c9ec80cb9fe314cd9d8
+  data.tar.gz: 56fae3981651c158701eb34023477125fbe7dd0ee8421d49d0e15174f550aae4
 SHA512:
-  metadata.gz: 42807b79e8a251eaaa4c317b50863d0a58903d5777fcf7bd4148085911235c3f98a579cd6f8d2f55b67cb86d98b5771bcaedaf39be33ecf8375501fe046abfd6
-  data.tar.gz: 3157e3be4a3fe98219b13b38b94427a84885a379366f44b7cbad928675fc0c44d6935a94292e5ba38c11e3ef3bb43821778da0dbcd6243a508eaca3bdf69d284
+  metadata.gz: fd452778a00be2a43d078b61ffdbb2616c1b631a0a1806c6027453c739b755ac90c7cd7e804ee6fe0839dae01d083d02abbffb7900e54fa6b7ba6159abee3248
+  data.tar.gz: 27c99e9368bc2dfd7cd49527eed157a31a9e2a2bd3d8caaf357fb12c1c5ccf898dc8913a963fdb2594eacf660054403302bc9425b54dfc46e06b588565ed9dd7

data/lib/kvx.rb

@@ -36,7 +36,7 @@ class Kvx
 
   def initialize(x=nil, attributes: {}, debug: false)
 
-    @header = false
+    @header = attributes.any?
     @identifier = 'kvx'
     @summary = {}
     @ignore_blank_lines ||= false
@@ -76,12 +76,23 @@ class Kvx
     FileX.write filename, self.to_s
   end
   
-  def to_h()
+  # flattening is helpful when passing the Hash object to 
+  # RecordX as a new record
+  #
+  def to_h(flatten: false)
     
     if @summary.empty? then
+      
       deep_clone @body
+      
     else
-      {summary: deep_clone(@summary), body: deep_clone(@body)}
+      
+      if flatten then
+        @summary.merge @body
+      else
+        {summary: deep_clone(@summary), body: deep_clone(@body)}
+      end
+      
     end
     
   end
@@ -104,13 +115,24 @@ class Kvx
       end
 
       summary = [:summary, {}, *summary]
-      body = [:body, {}, *make_xml(@body)]
+      
+      # -- use the nested description Hash object if there are multiple lines
+      h = {}
+      
+      @body.each do |key, value|
+              
+        h[key] = value.is_a?(String) ? value : value[:description]
+        
+      end
+      
+      body = [:body, {}, *make_xml(h)]
       [self.class.to_s.downcase, @attributes, '', summary, body]      
       
     end    
     
+    puts 'a: ' + a.inspect if @debug
     doc = Rexle.new a
-    doc.instructions = @instructions
+    doc.instructions = @instructions || []
     doc
     
   end
@@ -126,11 +148,34 @@ class Kvx
       header = '<?' + @identifier
       header += attr
       header += "?>\n"
-      header += scan_to_s @summary
-      header += "\n----------------------------------\n\n"
+      
+      if @summary and @summary.any? then
+        header += scan_to_s @summary
+        header += "\n----------------------------------\n\n"
+      end
+      
     end
+
+    # -- use the nested description Hash object if there are multiple lines
+    h = {}
+    
+    @body.each do |key, value|
+            
+      h[key] = if value.is_a?(String) then
+      
+        if value.lines.length < 2 then
+          value 
+        else
+          "\n" + value.lines.map {|x| '  ' + x }.join          
+        end
+        
+      else
+          "\n" + value[:description].lines.map {|x| '  ' + x }.join
+      end
+      
+    end    
     
-    header + scan_to_s(@body)
+    header + scan_to_s(h)
 
   end    
 
@@ -140,6 +185,13 @@ class Kvx
     doc.xml(options)
 
   end
+  
+  # used by RecordX to update a KVX record
+  # id is unnecssary because there is only 1 record mapped to RecordX
+  #
+  def update(id=nil, hpair={})
+    @body.merge! hpair
+  end
 
   private
   
@@ -192,7 +244,10 @@ class Kvx
   def make_xml(h)
     
     puts 'inside make_xml: ' + h.inspect if @debug
-    RexleBuilder.new(h, debug: false).to_a[3..-1]
+    h2 = h.clone
+    h2.each {|key,value| value.delete :items if value.is_a?(Hash) }
+
+    RexleBuilder.new(h2, debug: false).to_a[3..-1]
   end
   
   def parse_string(s)
@@ -240,7 +295,7 @@ class Kvx
       @attributes.merge! attr
       @header = true
       body, summary = a.join.strip.split(/^----*$/).reverse      
-      @summary = scan_to_h summary
+      @summary = scan_to_h summary if summary
       
       body
     else
@@ -271,22 +326,45 @@ class Kvx
     
   
   def scan_to_h(txt)
+    
+    txt.gsub!(/^\w+:(?=$)/,'\0 ')
+    puts 'txt:'  + txt.inspect if @debug
+    
+    # auto indent any multiline values which aren't already indented
+    
+    indent = ''
+
+    lines = txt.gsub(/^-+$/m,'').lines.map do |line|
+
+      if not line[/^ *\w+:|^ +/] then
+        indent + '  ' + line
+      else
+        indent = line[/^ +/] || ''
+        line
+      end
+
+    end    
 
     puts ('inside scan_to_h').info if @debug
-    raw_a = LineTree.new(txt.gsub(/(^-*$)|(#.*)/,'').strip, 
-                                              ignore_blank_lines: @ignore_blank_lines).to_a
+    raw_a = LineTree.new(lines.join.gsub(/(^-*$)|(^ *#.*)/,'').strip, 
+                         ignore_blank_lines: @ignore_blank_lines).to_a
     puts ('raw_a: ' + raw_a.inspect).debug if @debug
     
     # if there are any orphan lines which aren't nested underneath a 
     #   label, they will be fixed using the following statement
     
     a = raw_a.chunk {|x| x[0][/^[^:]+:|.*/]}.inject([]) do |r,y|
+      
+      puts 'r: ' + r.inspect if @debug
+      
       if r.last and !y.first[/[^:]+:/] then
         r.last << y.last[-1]
       else
         r << y.last[-1]
       end
+      
       r
+      
     end
 
     @body = a.inject({}) do |r, line|
@@ -326,7 +404,7 @@ class Kvx
         
       else
         
-        value, name = s.split(': ',2).reverse
+        value, name = s.split(/: */,2).reverse
         name ||= 'description'          
         v = value =~ /^\{\s*\}$/ ? {} : value.to_s
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvx
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.6
 platform: ruby
 authors:
 - James Robertson
@@ -11,31 +11,31 @@ cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEXjCCAsagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFnZW1t
-  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMTkwODE1MTY1NjM2WhcN
-  MjAwODE0MTY1NjM2WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
-  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC6K+Kz
-  ybTob3TbRSTALvfrmAyCyc05LGgxBgTA/6ykxggtrw3V70p+6OFX4g9ReH2VIgKD
-  3cTf5DrsXYaZGobKl/r0G97lXnz7rh/3mWXgUcmsendVmVv6xbVZVqupBX3Sm8T0
-  3lkqzZMKI13/et6ggIhAhV5aGMmS0y53keS22NfQvOuRZ7bHHfCpIba3d9RyeX07
-  GTIvSHzqYuO25zeag+acDTWfJZzGGtdoapig23PH8VtWsO3vS59HIie7GmmZKeQO
-  ApLnhrtgtI65489vRKjO26AxDMY+i+k4YLQAR3W0ckGRkLtelztqTTBY7nLWiTUN
-  NsOSnpVAU5MSf7motYKD6op3eYOzZlhTe/o4wJmCwp7N0oIAnfrcMPhOsrjDJ6+l
-  LdfKWKU17onB48cF0G3Qc74m51/072wt5xxEISP/IqvaY/uchFkX9fWjZoL8+IR6
-  KSDMEmEtWX+6QcEykWX2DQCGOAo2j6TvLC0upfIKe2lznGgpnIYr/HHI8pECAwEA
-  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUrRGBNC9u
-  Vef0qbebM6xKI6i6950wJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
+  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjEwMjIwMjI0ODU5WhcN
+  MjIwMjIwMjI0ODU5WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
+  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDEZUlA
+  5Xwb1PhCpUwcey7fBjLJHAHnBg9lFLAFNGWr1QDpH166qx7w9Q9ckPeFNMiH5ZFs
+  /D9GrO+BVU3Lz5/CaL3q5eB3L8+JC+VjNiJijvynBa2TeB2aenlRqdUqvJ/RGTu0
+  9v8tWq/Mn3batCRCpuLJJ25C49hyzYts2UWetRAqfuvukJY+BoPISYntAs3g2elo
+  Za/9sY69ezCvOmwyw+B8dGXjqINlZxJKfuR3xf87uR/4vBC9DI4EE7dS1pjsyDws
+  d3e9fBWBKIMaZVdshc9rAnP6ARhWMnxYUjjqUDJiqXz5137HmWSOGWGGrnX0pfg2
+  WPVI7jN39s6Gd2nNGOgaiwlNpcNS7IPYHGU2+mDJxWSKn+suMjendpi/WSTQlLG4
+  PEZBk+B6CEy6yOLU4x5GN3US7wbwLOl0ASSAhb4vAG81pGIRYt5fGE4HdiYxDC/u
+  ixTFr3lGZyyHAZ0VMsjIoq3cpbSHxe6TiwBncq1H7z9XeEP/LzFlhdjnHR0CAwEA
+  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU6BARnAgl
+  1R3h9OomhJPcgy+HzWEwJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
   c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1hc3RlckBqYW1lc3JvYmVydHNvbi5ldTAN
-  BgkqhkiG9w0BAQsFAAOCAYEAIVCVx1F5zCIaU/nSY7m6T7hIKvk2FbdsCC+T8g5+
-  61+1vgg31FalXJlo/KMV879HxNHMvz99/wEFs7XfUEZy0yEXlv/7UNXYcIqMhI7A
-  WbFBbSQk6XqFVhlaToApdvxkOJKE6LCiVBpi8JpUcBdgwbb4nU3ClN+Fys0fDSSY
-  PlCrgzODwsgZB16XM5SJ8SIPvmGNU7i2kxopRvEoKzFkuRcR437MofYrROxuh4mS
-  xOKIAmDkVNBZm7F+GBxWV3dFlhBD0WkFZ5u7mFC8ETK7aGwfz65gcv/zZuiC2aAH
-  KzKMbj6nwMsGquFqseU2SwmpvyyP/hhqYYgV/6gHf8ZrSM0YH+2ESruR/fxla6yj
-  FpNMxFEOQ/xVXHve//AgIZBQlUDG55q0lhWZ2c0S/z12iD4cPFNW4PJ4wJDji6O4
-  KUxK0Cu0STvwoV6DE5WnnZSur8LrUOi7l9Nk6viqnO36QEwToCPb1F2eqzGV+jI1
-  WeCuyBYkl+4fwV5cb7w7t9YY
+  BgkqhkiG9w0BAQsFAAOCAYEAZZ3jLwdvRBNjGqxBFpwbE+6lOlMADiza+vUe5DLr
+  Pwi54Wf+IF91M56S6zxw3BQ6aIzTqltXdHMkVJokQeGqzrGfJQO5Yhnh1Y1kxRtl
+  ZXCMasMdAE6NvW+1FIT/ilZDAoeaoLcoQ4JylHW25Y/FZ9tt++6EEkDFWZn6zxxw
+  wETcFLVEdzWeyJyTnjrfVYCJMlHr+mR9gXx2Fgz8vjqCu2O39NXuJqO9BrmoxkoD
+  jGcTdRnq6g6KcNOHlJCw6jvZUHSTeTtBPUEGkSNS5L3GejW65iwHWLY/WNtI4kzQ
+  9uR/zCKdJ0zJ/N7OEpBBMg05VTSR2nBwlTmacHdL/keDUuIUDd2APddKSr5F+voZ
+  ci+ozAEgQCeqDFapyRPqMGm8fO7Sa4i4BxGnDf6G3K9P6Rg9yEzpSbGTED9U+nlX
+  m/+jxdgFjKKGxeZqunu9cp5ca9wSjjtKh/VA/3xZtPwokCa7vCMB+ZxUP0jvd++u
+  OTXy8k/zqddw/VfD/It1UUK4
   -----END CERTIFICATE-----
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: line-tree
@@ -103,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Kvx (Keys, Values, and XML) makes it convenient to store and retrieve the