kvx 0.8.1 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f794c4d01915c9f9daca5f022efe68074b1b87e5b3867af9abf3d23c25aaad49
-  data.tar.gz: c9a8025b2011970603b351d4e87e7e717603860b496a7aa8f12baf327bc77f85
+  metadata.gz: c255b6ca87fbc7ec29656a2f7e33a4bf6770f33fbdeb17a9ec9743051055530f
+  data.tar.gz: baffbe4607834ba2ef49c78b21059b92d9e344d5c6fdd9d7a04252d2d0409d49
 SHA512:
-  metadata.gz: ef0d61a2a8652c4294b655ec9f9a9431911bafacb7a483f653b689d6e54bd8bab1cdafb43ff7d62af615f58ecd424ae125affed80842881a50418842e81b7674
-  data.tar.gz: ef65f0b80a84ce5e674120e8a7a00685b1d65b1bb7be1dc9a94dab2da033e736be07c7b8913ca0564571c8d13e2e2e2f6242a599f5ed5a642f3c01c9dce5c986
+  metadata.gz: c03ade6587fa5c1475aac9badde784b5929766d60d59ea53d70ca698b9bbe973acfcf9f4173ab5c2056dba13acb102b7a5c2fba509897f504b10d299489032b5
+  data.tar.gz: c38a4f5f215403a51006cfd1004a8a7a5977e3a034c9d994445c58a48bbd8fa5c7976e60691309c0013a17781d64dfaeb12e802e9c820ad099450785da34f022

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,12 +115,25 @@ 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    
     
-    Rexle.new a
+    puts 'a: ' + a.inspect if @debug
+    doc = Rexle.new a
+    doc.instructions = @instructions || []
+    doc
     
   end
   
@@ -124,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 = {}
     
-    header + scan_to_s(@body)
+    @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(h)
 
   end    
 
@@ -138,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
   
@@ -197,7 +251,15 @@ class Kvx
     
     buffer, type = RXFHelper.read(s)
     puts ('buffer: ' + buffer.inspect).debug if @debug
-    buffer.lstrip =~ /^<\?xml/ ? xml_to_h(Rexle.new(buffer).root) : parse_to_h(buffer)
+    
+    if buffer.lstrip =~ /^<\?xml/ then
+      doc = Rexle.new(buffer)
+      @instructions = doc.instructions
+      puts '@instructions: ' + @instructions.inspect if @debug
+      xml_to_h(doc.root)
+    else
+      parse_to_h(buffer)
+    end
     
   end
   
@@ -230,7 +292,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
@@ -286,7 +348,7 @@ class Kvx
       
       if line.join.length > 0 then 
 
-        r2 = if line[0][0][/^[^:]+:/] then
+        r2 = if line[0][0][/^[^:]+: /] then
 
           padding = line[0].length < 2 ? "\n" : "\n  "
           
@@ -345,6 +407,9 @@ class Kvx
   
   def xml_to_h(node)
     
+    puts 'node: ' + node.xml.inspect if @debug
+    @attributes = node.attributes.to_h
+    
     summary = node.element('summary')
     
     if summary then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvx
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.4
 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: 2019-08-15 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: line-tree
@@ -43,40 +43,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rxfhelper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 
 email: james@jamesrobertson.eu
 executables: []
@@ -103,7 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Kvx (Keys, Values, and XML) makes it convenient to store and retrieve the