Class: Rexle::Element

Inherits:
Object
  • Object
show all
Includes:
XMLhelper
Defined in:
lib/rexle.rb

Direct Known Subclasses

CData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLhelper

#doc_pretty_print, #doc_print, #pretty_print, #processing_instructions, #scan_print, #scan_to_a

Constructor Details

#initialize(name = nil, value = nil, attributes = {}, rexle = nil) ⇒ Element

Returns a new instance of Element.



262
263
264
265
266
267
268
269
270
 
# File 'lib/rexle.rb', line 262

def initialize(name=nil, value=nil, attributes={}, rexle=nil)

  @rexle = rexle      
  super()
  @name, @value, @attributes = name.to_s, value, attributes
  raise "Element name must not be blank" unless name
  @child_elements = []
  @child_lookup = []
end

Instance Attribute Details

#child_elements ⇒ Object (readonly)

Returns the value of attribute child_elements.



258
259
260
 
# File 'lib/rexle.rb', line 258

def child_elements
  @child_elements
end

#child_lookup ⇒ Object (readonly)

Returns the value of attribute child_lookup.



258
259
260
 
# File 'lib/rexle.rb', line 258

def child_lookup
  @child_lookup
end

#doc_id ⇒ Object (readonly)

Returns the value of attribute doc_id.



258
259
260
 
# File 'lib/rexle.rb', line 258

def doc_id
  @doc_id
end

#instructions ⇒ Object (readonly)

Returns the value of attribute instructions.



258
259
260
 
# File 'lib/rexle.rb', line 258

def instructions
  @instructions
end

#name ⇒ Object

Returns the value of attribute name.



257
258
259
 
# File 'lib/rexle.rb', line 257

def name
  @name
end

#parent ⇒ Object

Returns the value of attribute parent.



257
258
259
 
# File 'lib/rexle.rb', line 257

def parent
  @parent
end

#value ⇒ Object

Returns the value of attribute value.



257
258
259
 
# File 'lib/rexle.rb', line 257

def value
  @value
end

Instance Method Details

#add(item) ⇒ Object 



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/rexle.rb', line 526

def add(item)   

  if item.is_a? Rexle::Element then

    if self.doc_id == item.doc_id then

      new_item = item.deep_clone
      add_element new_item
      item.delete
      item = new_item
      new_item
    else
      add_element item
    end
  else
    add_element item
  end

end

#add_attribute(*x) ⇒ Object

alias add add_element



556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/rexle.rb', line 556

def add_attribute(*x)

  procs = {
    Hash: lambda {|x| x[0] || {}},
    String: lambda {|x| Hash[*x]},
    Symbol: lambda {|x| Hash[*x]}
  }

  h = procs[x[0].class.to_s.to_sym].call(x)

  @attributes.merge! h
end

#add_element(item) ⇒ Object 



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/rexle.rb', line 509

def add_element(item)
  
  if item.is_a? Rexle::Element then

    @child_lookup << [item.name, item.attributes, item.value]
    @child_elements << item
    # add a reference from this element (the parent) to the child
    item.parent = self
    item        
  elsif item.is_a? String then
    @child_lookup << item
    @child_elements << item             
  elsif item.is_a? Rexle then
    self.add_element(item.root)
  end
end

#add_text(s) ⇒ Object 



569
570
571
572
573
574
575
576
 
# File 'lib/rexle.rb', line 569

def add_text(s)
  if @child_elements.length < 1 then
    @value = s; 
  else
    self.add s
  end
  self 
end

#attribute(key) ⇒ Object 



578
579
580
581
 
# File 'lib/rexle.rb', line 578

def attribute(key) 
  key = key.to_sym if key.is_a? String
  @attributes[key].gsub('&lt;','<').gsub('&gt;','>')
end

#attributes ⇒ Object 



583
 
# File 'lib/rexle.rb', line 583

def attributes() @attributes end

#children ⇒ Object 



585
586
587
588
589
590
591
592
593
 
# File 'lib/rexle.rb', line 585

def children()
  #return unless @value
  r = (@value.to_s.empty? ? [] : [@value])  + @child_elements
  def r.is_an_empty_string?()
    self.length == 1 and self.first == ''
  end      
  
  return r
end

#children=(a) ⇒ Object

alias child_elements children



597
 
# File 'lib/rexle.rb', line 597

def children=(a)   @child_elements = a   end

#clone ⇒ Object 



600
 
# File 'lib/rexle.rb', line 600

def clone() Element.new(@name, @value, @attributes) end

#contains(raw_args) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
 
# File 'lib/rexle.rb', line 272

def contains(raw_args)
  path, raw_val = raw_args.split(',',2)
  val = raw_val.strip[/^["']?.*["']?$/]      
  
  anode = query_xpath(path)
  return unless anode
  a = scan_contents(anode.first)
 
  [a.grep(/#{val}/).length > 0]
end

#content(options = {}) ⇒ Object 



703
704
705
 
# File 'lib/rexle.rb', line 703

def content(options={})
  CGI.unescapeHTML(xml(options))
end

#count(path) ⇒ Object 



283
284
285
286
 
# File 'lib/rexle.rb', line 283

def count(path)
  length = query_xpath(path).flatten.compact.length
  length
end

#deep_clone ⇒ Object 



599
 
# File 'lib/rexle.rb', line 599

def deep_clone() Rexle.new(self.xml).root end

#delete(obj = nil) ⇒ Object Also known as: remove 



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/rexle.rb', line 602

def delete(obj=nil)

  if obj then

    if obj.is_a? String then
      e = self.element obj
      e.delete if e
    else
      i = @child_elements.index(obj)
      [@child_elements, @child_lookup].each{|x| x.delete_at i} if i
    end
  else

    self.parent.delete(self) if self.parent
  end
end

#doc_root ⇒ Object 



635
 
# File 'lib/rexle.rb', line 635

def doc_root() @rexle.root                                  end

#each(&blk) ⇒ Object 



636
 
# File 'lib/rexle.rb', line 636

def each(&blk)    self.children.each(&blk)                  end

#each_recursive(&blk) ⇒ Object Also known as: traverse 



637
 
# File 'lib/rexle.rb', line 637

def each_recursive(&blk) recursive_scan(self.children,&blk) end

#element(s) ⇒ Object 



621
622
623
624
 
# File 'lib/rexle.rb', line 621

def element(s) 
  r = self.xpath(s)
  r.is_a?(Array) ? r.first : r
end

#elements(s = nil) ⇒ Object 



626
627
628
629
630
631
632
633
 
# File 'lib/rexle.rb', line 626

def elements(s=nil)
  procs = {
    NilClass: proc {Elements.new(@child_elements.select{|x| x.is_a? Rexle::Element })},
    String: proc {|x| @child_elements[x]}
  }

  procs[s.class.to_s.to_sym].call(s)      
end

#filter_xpath(path, rlist = [], &blk) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/rexle.rb', line 308

def filter_xpath(path, rlist=[], &blk)

  # is it a function
  fn_match = path.match(/^(\w+)\(["']?([^\)]*)["']?\)$/)

  #    Array: proc {|x| x.flatten.compact}, 
  if (fn_match and fn_match.captures.first[/^(attribute|@)/]) or fn_match.nil? then 

    procs = {
      #jr061012 Array: proc {|x| block_given? ? x : x.flatten.uniq },
      Array: proc { |x| 
        if block_given? then 
          x.flatten(1) 
        else
          rs = x.flatten
          rs.any?{|x| x == true or x == false} ? rs : rs.uniq(&:object_id) 
        end
      }, 
      String: proc {|x| x},
      Hash: proc {|x| x},
      TrueClass: proc{|x| x},
      FalseClass: proc{|x| x},
      :"Rexle::Element" => proc {|x| [x]}
    }
    bucket = []
    raw_results = path.split('|').map do |xp|
      query_xpath(xp.strip, bucket, &blk)         
    end

    results = raw_results

    procs[results.class.to_s.to_sym].call(results) if results
    
  else

    m, xpath_value = fn_match.captures        
    xpath_value.empty? ? method(m.to_sym).call : method(m.to_sym).call(xpath_value) 
  end

end

#has_elements? ⇒ Boolean

Returns:

  • (Boolean) 


639
 
# File 'lib/rexle.rb', line 639

def has_elements?() !self.elements.empty?                   end

#insert_after(node) ⇒ Object 



640
 
# File 'lib/rexle.rb', line 640

def insert_after(node)   insert(node, 1)                    end

#insert_before(node) ⇒ Object 



641
 
# File 'lib/rexle.rb', line 641

def insert_before(node)  insert(node)                       end

#inspect ⇒ Object 



546
547
548
549
550
551
552
 
# File 'lib/rexle.rb', line 546

def inspect()
  if self.xml.length > 30 then
  "%s ... </>" % self.xml[/<[^>]+>/]
  else
    self.xml
  end  
end

#map(&blk) ⇒ Object 



642
 
# File 'lib/rexle.rb', line 642

def map(&blk)    self.children.map(&blk)                    end

#max(path) ⇒ Object 



288
289
290
291
 
# File 'lib/rexle.rb', line 288

def max(path) 
  a = query_xpath(path).flatten.select{|x| x.is_a? String}.map(&:to_i)
  a.max 
end

#original_clone ⇒ Object 



260
 
# File 'lib/rexle.rb', line 260

alias original_clone clone

#query_xpath(raw_xpath_value, rlist = [], &blk) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/rexle.rb', line 349

def query_xpath(raw_xpath_value, rlist=[], &blk)

  #remove any pre'fixes
 #@rexle.prefixes.each {|x| xpath_value.sub!(x + ':','') }
  flag_func = false            

  xpath_value = raw_xpath_value.sub('child::','./')
  #xpath_value.sub!(/\.\/(?=[\/])/,'')

  if xpath_value[/^[\w\/]+\s*=.*/] then        
    flag_func = true

    xpath_value.sub!(/^\w+\s*=.*/,'.[\0]')
    xpath_value.sub!(/\/([\w]+\s*=.*)/,'[\1]')

    #result = self.element xpath_value        
    #return [(result.is_a?(Rexle::Element) ? true : false)]
  end

  #xpath_value.sub!(/^attribute::/,'*/attribute::')
  raw_path, raw_condition = xpath_value.sub(/^\.?\/(?!\/)/,'')\
      .match(/([^\[]+)(\[[^\]]+\])?/).captures 

  remaining_path = ($').to_s

  r = raw_path[/^([^\/]+)(?=\/\/)/,1] 
  if r then
    a_path = raw_path.split(/(?=\/\/)/,2)
  else
    a_path = raw_path.split('/',2)
  end
  
  condition = raw_condition if a_path.length <= 1

  if raw_path[0,2] == '//' then
    s = ''
  elsif raw_path == 'text()'        
    a_path.shift
    return @value
  else

    attribute = xpath_value[/^(attribute::|@)(.*)/,2] 
  
    return @attributes  if attribute == '*'
    return [@attributes[attribute.to_sym]] if attribute and @attributes and @attributes.has_key?(attribute.to_sym)
    s = a_path.shift
  end      

  # isolate the xpath to return just the path to the current element

  elmnt_path = s[/^([\w:\-\*]+\[[^\]]+\])|[\/]+{,2}[^\/]+/]
  element_part = elmnt_path[/(^@?[^\[]+)?/,1] if elmnt_path

  if element_part then

    unless element_part[/^(@|[@\.\w]+[\s=])/] then
      element_name = element_part[/^[\w:\-\*\.]+/]

    else
      if xpath_value[/^\[/] then
        condition = xpath_value
        element_name = nil
      else
        condition = element_part
        attr_search = format_condition('[' + condition + ']')
        return [attribute_search(attr_search, self, self.attributes) != nil]            
      end

    end

  end

  #element_name ||= '*'
  raw_condition = '' if condition

  attr_search = format_condition(condition) if condition and condition.length > 0      
  attr_search2 = xpath_value[/^\[(.*)\]$/,1]

  if attr_search2 then
    r4 = attribute_search(attr_search, self, self.attributes)
    return r4
  end
  
  
  return_elements = []

  if raw_path[0,2] == '//' then

    regex = /\[(\d+)\]$/
    n = xpath_value[regex,1]
    xpath_value.slice!(regex)

    rs = scan_match(self, xpath_value).flatten.compact
    return n ? rs[n.to_i-1] : rs

  #jr101013 elsif (raw_path == '.' or raw_path == self.name) and attr_search.nil? then
  #jr101013  return  [self]
  else

    return_elements = @child_lookup.map.with_index.select do |x|    
      (x[0][0] == element_name || element_name == '.') or \
        (element_name == '*' && x[0].is_a?(Array))
    end

  end


  if return_elements.length > 0 then

    if (a_path + [remaining_path]).join.empty? then

      rlist = return_elements.map.with_index {|x,i| filter(x, i+1, attr_search, &blk)}.compact          
      rlist = rlist[0] if rlist.length == 1

    else

      rlist << return_elements.map.with_index do |x,i| 

        rtn_element = filter(x, i+1, attr_search) do |e| 
          r = e.xpath(a_path.join('/') + raw_condition.to_s \
                + remaining_path, &blk)
          #(r || e) 
        end

        next if rtn_element.nil? or (rtn_element.is_a? Array and rtn_element.empty?)

        if rtn_element.is_a? Hash then
          rtn_element
        elsif rtn_element.is_a? Array then
          rtn_element
        elsif (rtn_element.is_a? String) || (rtn_element.is_a?(Array) and not(rtn_element[0].is_a? String))
          rtn_element
        elsif rtn_element.is_a? Rexle::Element
          rtn_element
        end
      end
      #

      rlist = rlist.flatten(1) unless rlist.length > 1 and rlist[0].is_a? Array

    end

    rlist.compact! if rlist.is_a? Array

  else

    # strip off the 1st element from the XPath
    new_xpath = xpath_value[/^\/\/[\w:\-]+\/(.*)/,1]

    if new_xpath then
      self.xpath(new_xpath + raw_condition.to_s + remaining_path, rlist,&blk)
    end
  end

  rlist = rlist.flatten(1) unless not(rlist.is_a? Array) or (rlist.length > 1 and rlist[0].is_a? Array)
  rlist = [rlist] if rlist.is_a? Rexle::Element
  rlist = (rlist.length > 0 ? true : false) if flag_func == true
  rlist
end

#root ⇒ Object 



643
 
# File 'lib/rexle.rb', line 643

def root() self                                             end

#text(s = '') ⇒ Object 



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/rexle.rb', line 645

def text(s='')

  if s.empty? then
    result = @value
  else
    e = self.element(s)
    result = e.value if e
  end
  #result = CGI.unescape_html result.to_s
 
  def result.unescape()
    s = self.clone
    %w(&lt; < &gt; > &amp; & &pos; ').each_slice(2){|x| s.gsub!(*x)}
    s
  end

  result
end

#texts ⇒ Object 



664
665
666
 
# File 'lib/rexle.rb', line 664

def texts()
  [@value] + @child_elements.select {|x| x.is_a? String}
end

#to_a ⇒ Object 



684
685
686
 
# File 'lib/rexle.rb', line 684

def to_a()
  [self.name, self.value, self.attributes, *scan_to_a(self.children)]
end

#xml(options = {}) ⇒ Object Also known as: to_s 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/rexle.rb', line 688

def xml(options={})
  h = {
    Hash: lambda {|x|
      o = {pretty: false}.merge(x)
      msg = o[:pretty] == false ? :doc_print : :doc_pretty_print
      method(msg).call(self.children)
    },
    String: lambda {|x| 
      r = self.element(x)
      r ? r.xml : ''
    }
  }
  h[options.class.to_s.to_sym].call options
end

#xpath(path, rlist = [], &blk) ⇒ Object 



302
303
304
305
306
 
# File 'lib/rexle.rb', line 302

def xpath(path, rlist=[], &blk)

  r = filter_xpath(path, rlist=[], &blk)
  r.is_a?(Array) ? r.compact : r      
end