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.



323
324
325
326
327
328
329
330
331
 
# File 'lib/rexle.rb', line 323

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.



319
320
321
 
# File 'lib/rexle.rb', line 319

def child_elements
  @child_elements
end

#child_lookup ⇒ Object (readonly)

Returns the value of attribute child_lookup.



319
320
321
 
# File 'lib/rexle.rb', line 319

def child_lookup
  @child_lookup
end

#doc_id ⇒ Object (readonly)

Returns the value of attribute doc_id.



319
320
321
 
# File 'lib/rexle.rb', line 319

def doc_id
  @doc_id
end

#instructions ⇒ Object (readonly)

Returns the value of attribute instructions.



319
320
321
 
# File 'lib/rexle.rb', line 319

def instructions
  @instructions
end

#name ⇒ Object

Returns the value of attribute name.



318
319
320
 
# File 'lib/rexle.rb', line 318

def name
  @name
end

#parent ⇒ Object

Returns the value of attribute parent.



318
319
320
 
# File 'lib/rexle.rb', line 318

def parent
  @parent
end

#value ⇒ Object

Returns the value of attribute value.



318
319
320
 
# File 'lib/rexle.rb', line 318

def value
  @value
end

Instance Method Details

#add(item) ⇒ Object 



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/rexle.rb', line 656

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



686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/rexle.rb', line 686

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 



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/rexle.rb', line 639

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 



699
700
701
702
703
704
705
706
 
# File 'lib/rexle.rb', line 699

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

#at_css(selector) ⇒ Object 



349
350
351
 
# File 'lib/rexle.rb', line 349

def at_css(selector)
  self.root.element RexleCSS.new(selector).to_xpath
end

#attribute(key) ⇒ Object 



708
709
710
711
712
713
714
715
716
717
 
# File 'lib/rexle.rb', line 708

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

#attributes ⇒ Object 



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

def attributes() @attributes end

#children ⇒ Object 



721
722
723
724
725
726
727
728
729
 
# File 'lib/rexle.rb', line 721

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



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

def children=(a)   @child_elements = a   end

#clone ⇒ Object 



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

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

#contains(raw_args) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/rexle.rb', line 333

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 



843
844
845
 
# File 'lib/rexle.rb', line 843

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

#count(path) ⇒ Object 



344
345
346
347
 
# File 'lib/rexle.rb', line 344

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

#css(selector) ⇒ Object 



353
354
355
356
357
 
# File 'lib/rexle.rb', line 353

def css(selector)

  selector.split(',')\
              .flat_map{|x| self.root.xpath RexleCSS.new(x).to_xpath}
end

#deep_clone ⇒ Object 



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

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

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



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/rexle.rb', line 738

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 



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

def doc_root() @rexle.root                                  end

#each(&blk) ⇒ Object 



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

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

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



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

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

#element(s) ⇒ Object 



757
758
759
760
 
# File 'lib/rexle.rb', line 757

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

#elements(s = nil) ⇒ Object 



762
763
764
765
766
767
768
769
 
# File 'lib/rexle.rb', line 762

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 



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
 
# File 'lib/rexle.rb', line 404

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) 


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

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

#insert_after(node) ⇒ Object 



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

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

#insert_before(node) ⇒ Object 



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

def insert_before(node)  insert(node)                       end

#inspect ⇒ Object 



676
677
678
679
680
681
682
 
# File 'lib/rexle.rb', line 676

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

#map(&blk) ⇒ Object 



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

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

#max(path) ⇒ Object 



359
360
361
362
 
# File 'lib/rexle.rb', line 359

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

#next_element ⇒ Object Also known as: next_sibling 



373
374
375
376
377
378
379
380
381
 
# File 'lib/rexle.rb', line 373

def next_element()      
  
  id  = self.object_id
  a = self.parent.child_elements      
  i = a.index {|x| x.object_id == id} + 1
  
  a[i] if  i < a.length
    
end

#original_clone ⇒ Object 



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

alias original_clone clone

#previous_element ⇒ Object Also known as: previous_sibling 



385
386
387
388
389
390
391
392
393
 
# File 'lib/rexle.rb', line 385

def previous_element()      
  
  id  = self.object_id
  a = self.parent.child_elements      
  i = a.index {|x| x.object_id == id} - 1
  
  a[i] if  i >= 0 

end

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



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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/rexle.rb', line 445

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

    if element_name.is_a? String then
      ename, raw_selector = (element_name.split('::',2)).reverse
      
      selector = case raw_selector
        when 'following-sibling' then 1
        when 'preceding-sibling' then -1
      end
      
    else
      ename = element_name
    end        

    if ename != '..' then
      
      return_elements = @child_lookup.map.with_index.select do |x|
                  
        (x[0][0] == ename || ename == '.') or \
          (ename == '*' && x[0].is_a?(Array))
      end
      
      if selector then
        ne = return_elements.inject([]) do |r,x| 
          i = x.last + selector
          if i >= 0 then
            r << i
          else
            r
          end
        end

        return_elements = ne.map {|x| [@child_lookup[x], x] if x}
      end
    else
                
      remaining_xpath = raw_path[/\.\.\/(.*)/,1]
      # select the parent element
      return self.parent.xpath(remaining_xpath)
      
    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 



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

def root() self                                             end

#text(s = '') ⇒ Object 



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/rexle.rb', line 781

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 



800
801
802
 
# File 'lib/rexle.rb', line 800

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

#to_a ⇒ Object 



824
825
826
 
# File 'lib/rexle.rb', line 824

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

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



828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/rexle.rb', line 828

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 



397
398
399
400
401
402
 
# File 'lib/rexle.rb', line 397

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

  #return if path[/^(?:preceding|following)-sibling/]
  r = filter_xpath(path, rlist=[], &blk)
  r.is_a?(Array) ? r.compact : r      
end