kvx 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea5530d34014e707b2437e10c43ba101ad30f72fbc213e4f130d1b8fd9771b56
-  data.tar.gz: 2eb9ef7dbb42e1e664921f05745871cf3486aa55e8abf2b34e91ef803106aff1
+  metadata.gz: 9593cb5e316de67bd9d1f60da12863f2a7b723455292fd47b90414f432bde395
+  data.tar.gz: 4d9895d44ab99d29b047f9b6fc3befe12c48a1593e90e96d5ce56035be0f8efb
 SHA512:
-  metadata.gz: 63bb7be7589852804c5b4ea5e1555c26f366f3bccef0429e7c50adac24d91a90e18c6c91ba03442450e989dd317cc9c656b4ec3768cd931fe2c90e4f05168ead
-  data.tar.gz: 96947516061e9d56379452bd1cdb5117c1c7af11ca182f03aa37da732844bfc834df82d415aca15bbce34a985f2935e996c501d2cbe993d333b2a14c11572364
+  metadata.gz: 752439f262e50697f9523030846b5c2ae8298ddce5abfc4478db06029594be76ca09679cd44f8ab43a8c8462b71dffe0cf5c9bd1d9744e19a9139d90e82aa85b
+  data.tar.gz: f851c04b8e76a5a39aa67463c48fbce12619d2d67a1fc7dff207eb501bbc187cad36715fb4da8e88b68dcbe6f12cab59f5e7299b8d29d45864fa714626fe19c8

data/lib/kvx.rb

@@ -16,7 +16,7 @@ hkey_gems
       require kvx
       class Kvx
       media_type kvx
-'
+'      
   end
 end
 
@@ -34,25 +34,27 @@ class Kvx
   attr_accessor :attributes, :summary
   attr_reader :to_h
 
-  def initialize(x=nil, summary: {}, body: {}, attributes: {}, debug: false)
+  def initialize(x=nil, summary: {}, body: {}, attributes: {}, 
+                 comment_char: nil, debug: false)
 
     @header = attributes.any?
     @identifier = 'kvx'
     @summary, @body = summary, body
     @ignore_blank_lines ||= false
-
+    
     @attributes, @debug = attributes, debug
-
+    @comment_char = comment_char
+    
     h = {
-      hash: :passthru,
-      :'rexle::element' => :xml_to_h,
+      hash: :passthru, 
+      :'rexle::element' => :xml_to_h, 
       string: :parse_string,
       rexle: :doc_to_h,
       :"rexle::element::value" => :parse_string
     }
-
+    
     if x then
-
+      
       sym = h[x.class.to_s.downcase.to_sym]
       puts 'sym: ' + sym.inspect if @debug
       @body = method(sym).call x
@@ -62,127 +64,127 @@ class Kvx
     methodize(@body)
 
   end
-
+  
   def import(s)
     @body = parse_string(s)
     methodize(@body)
   end
-
+    
   def item()
     @body
   end
-
-  alias body item
-
+  
+  alias body item  
+  
   def save(filename)
     FileX.write filename, self.to_s
   end
-
-  # flattening is helpful when passing the Hash object to
+  
+  # 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
-
+      
       if flatten then
         @summary.merge @body
       else
         {summary: deep_clone(@summary), body: deep_clone(@body)}
       end
-
+      
     end
-
+    
   end
-
+  
   def to_doc()
-
+    
     a = if @summary.empty? then
-
-      [self.class.to_s.downcase, @attributes, '', *make_xml(@body)]
-
+      
+      [self.class.to_s.downcase, @attributes, '', *make_xml(@body)]      
+      
     else
-
+      
       summary = make_xml(@summary)
-
+      
       tags_found = summary.assoc(:tags)
-
+      
       if tags_found then
         tags = tags_found.pop
-        tags_found.push *tags.split.map {|x| [:tag,{},x]}
+        tags_found.push *tags.split.map {|x| [:tag,{},x]} 
       end
 
       summary = [:summary, {}, *summary]
-
+      
       # -- 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
-
+      [self.class.to_s.downcase, @attributes, '', summary, body]      
+      
+    end    
+    
     puts 'a: ' + a.inspect if @debug
     doc = Rexle.new a
     doc.instructions = @instructions || []
     doc
-
+    
   end
-
+  
   def to_s()
-
+    
     header = ''
-
+    
     if @header or (@summary and @summary.any?) then
-
+      
       attr = @attributes ? ' ' + @attributes\
                                        .map {|x| "%s='%s'" % x }.join(' ') : ''
       header = '<?' + @identifier
       header += attr
       header += "?>\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
+          value 
         else
-          "\n" + value.lines.map {|x| '  ' + x }.join
+          "\n" + value.lines.map {|x| '  ' + x }.join          
         end
-
+        
       else
           "\n" + value[:description].lines.map {|x| '  ' + x }.join
       end
-
-    end
-
+      
+    end    
+    
     header + scan_to_s(h)
 
-  end
+  end    
 
   def to_xml(options={pretty: true})
-
+          
     doc = self.to_doc
     doc.xml(options)
 
@@ -243,7 +245,7 @@ s = "
 "
 
   end
-
+  
   # used by RecordX to update a KVX record
   # id is unnecssary because there is only 1 record mapped to RecordX
   #
@@ -252,9 +254,9 @@ s = "
   end
 
   private
-
+  
   def deep_clone(h)
-
+      
     h.inject({}) do |r, x|
 
       h2 = if x.last.is_a? Hash then
@@ -264,31 +266,31 @@ s = "
       end
       r.merge h2[0] => h2[1]
     end
-
-  end
-
+    
+  end  
+  
   def doc_to_h(doc)
     xml_to_h(doc.root)
   end
 
   def get_attributes(raw_attributes)
-#
+#     
     r1 = /([\w\-:]+\='[^']*)'/
     r2 = /([\w\-:]+\="[^"]*)"/
-
+    
     r =  raw_attributes.scan(/#{r1}|#{r2}/).map(&:compact)\
                                   .flatten.inject(Attributes.new) do |r, x|
-      attr_name, raw_val = x.split(/=/,2)
+      attr_name, raw_val = x.split(/=/,2) 
       val = attr_name != 'class' ? raw_val[1..-1] : raw_val[1..-1].split
       r.merge(attr_name.to_sym => val)
     end
 
     return r
   end
-
+  
   def hashify(e)
 
-    v = if e.has_elements? then
+    v = if e.has_elements? then 
       e.elements.inject({}) do |r, x|
         r.merge hashify(x)
       end
@@ -297,17 +299,17 @@ s = "
     end
 
     {e.name.to_sym => v}
-  end
+  end  
 
   def make_xml(h)
-
+    
     puts 'inside make_xml: ' + h.inspect if @debug
     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)
 
     buffer, type = RXFReader.read(s)
@@ -327,9 +329,9 @@ s = "
     end
 
   end
-
+  
   def methodize(h)
-
+    
     h.each do |k,v|
 
       define_singleton_method(k){v} unless self.methods.include? k
@@ -338,68 +340,68 @@ s = "
         define_singleton_method((k.to_s + '=').to_sym){|x| h[k] = x}
       end
 
-    end
-
+    end    
+    
   end
 
   def parse_to_h(s, header_pattern: %r(^<\?kvx[\s\?]))
 
     raw_txt, _ = RXFReader.read(s)
 
-    # does the raw_txt contain header information?
+    # does the raw_txt contain header information? 
     a = s.strip.lines
 
     txt = if a[0] =~ header_pattern then
-
+    
       raw_header = a.shift
       attr = get_attributes(raw_header)
-
+      
       if attr[:created] then
         attr[:last_modified] = Time.now.to_s
       else
-        attr[:created] = Time.now.to_s
+        attr[:created] = Time.now.to_s 
       end
-
+      
       @attributes.merge! attr
       @header = true
-      body, summary = a.join.strip.split(/^----*$/).reverse
+      body, summary = a.join.strip.split(/^----*$/).reverse      
       @summary = scan_to_h summary if summary
-
+      
       body
     else
       raw_txt
     end
-
+    
     scan_to_h(txt)
   end
 
   def passthru(x)
-
+    
     if x[:summary] and x[:body]
       @summary = deep_clone x[:summary]
       deep_clone x[:body]
-    else
+    else      
       deep_clone x
     end
-
+    
   end
-
+  
   def pretty_print(a, indent='')
-
-    a.map do |x|
+    
+    a.map do |x|  
       (x.is_a?(String) or x.nil?) ? x.to_s : pretty_print(x, indent + '  ')
     end.join("\n" + indent)
-
+    
   end
-
-
+    
+  
   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|
@@ -411,89 +413,95 @@ s = "
         line
       end
 
-    end
+    end    
     puts ('lines: ' + lines.inspect).debug if @debug
-
+    
     puts ('inside scan_to_h').info if @debug
-    raw_a = LineTree.new(lines.join.gsub(/(^-*$)|(?<=\S) +#.*/,'').strip,
+    txt = lines.join.gsub(/^-*$/,'')
+    
+    if @comment_char then
+      txt.gsub!(/(?<=\S) +#{@comment_char}.*|#{@comment_char}[^\n]+/,'') 
+    end
+    
+    raw_a = LineTree.new(txt.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
+    
+    # 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
         puts 'y: ' + y.inspect if @debug
         r << y.last[-1]
       end
-
+      
       r
-
+      
     end
 
     @body = a.inject({}) do |r, line|
-
+           
       s = line.shift
       puts ('s: ' + s.inspect).debug if @debug
-
+      
       if line.join.length > 0 then
-
+        
         puts 'line: ' + line.inspect if @debug
-
-        padding = line[0].length < 2 ? "\n" : "\n  "
+        
+        padding = line[0].length < 2 ? "\n" : "\n  "        
         s10 = line.map{|x| x.join(padding)}.join("\n")
-
+        
         r2 = if s10[/^ *\w+:[\n ]/] then
-
+          
           scan_to_h(s10)
-
+          
         else
 
-          desc = pretty_print(line).split(/\n(?=\w+: )/)
+          desc = pretty_print(line).split(/\n(?=\w+: )/)         
 
           txt2, remaining = desc
 
-          h = txt2.lines.inject([]) do |r, x|
+          h = txt2.lines.inject([]) do |r, x| 
             x.chomp!
             x.length > 0 ?  r << x : r
           end
-
-          r3 = {description: txt2, items: h}
+          
+          r3 = {description: txt2, items: LineTree.new(txt2).to_a(normalize: true)}
 
           if remaining then
             r3.merge!(scan_to_h remaining + "\n ")
           end
-
+          
           r3
         end
 
         r.merge({s[/[^:]+/].to_sym => r2})
-
+        
       else
-
+        
         value, name = s.split(/: */,2).reverse
-        name ||= 'description'
+        name ||= 'description'          
         v = value =~ /^\{\s*\}$/ ? {} : value.to_s
-
+        
         r.merge({name.to_sym => v})
-      end
+      end     
 
     end
-
+    
     puts ('@body: ' + @body.inspect).debug if @debug
     @body
 
-  end
-
-  def scan_to_s(h, indent='')
-
+  end     
+  
+  def scan_to_s(h, indent='')    
+    
     a = h.inject([]) do |r, x|
       if x.last.is_a? Hash then
         r << x.first.to_s + ":\n" + scan_to_s(x.last, '  ')
@@ -501,27 +509,27 @@ s = "
         r << "%s%s: %s" % [indent, *x]
       end
     end
-
+    
     @to_s = a.join("\n")
   end
-
+  
   def xml_to_h(node)
-
+    
     puts 'node: ' + node.xml.inspect if @debug
     @attributes = node.attributes.to_h
-
+    
     summary = node.element('summary')
-
+    
     if summary then
 
       etags = summary.element 'tags'
-
+      
       if etags then
 
         tags = etags.xpath('tag/text()')
         etags.delete 'tag'
         etags.text = tags.join(' ') if tags.any?
-
+        
       end
 
       @summary = hashify(summary)[:summary]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvx
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   kHNn+ERume1+043nzGdoGxJEUVUPYjRHDzWB1QG7OyRO+e9RZvsTQyTp2+EWVCPD
   haPJ+LVlPvQPLLPI124YDQp8
   -----END CERTIFICATE-----
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: line-tree
@@ -46,7 +46,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,7 +56,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: rxfreadwrite
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Kvx (Keys, Values, and XML) makes it convenient to store and retrieve the