Class: Rexle::Element

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLhelper

#doc_pretty_print, #doc_print, #pretty_print, #scan_print

Constructor Details

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

Returns a new instance of Element.



153
154
155
156
157
158
159
160
 
# File 'lib/rexle.rb', line 153

def initialize(name=nil, value='', 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_lookup ⇒ Object (readonly)

Returns the value of attribute child_lookup.



149
150
151
 
# File 'lib/rexle.rb', line 149

def child_lookup
  @child_lookup
end

#name ⇒ Object

Returns the value of attribute name.



148
149
150
 
# File 'lib/rexle.rb', line 148

def name
  @name
end

#parent ⇒ Object

Returns the value of attribute parent.



148
149
150
 
# File 'lib/rexle.rb', line 148

def parent
  @parent
end

#value ⇒ Object

Returns the value of attribute value.



148
149
150
 
# File 'lib/rexle.rb', line 148

def value
  @value
end

Instance Method Details

#add_attribute(*x) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/rexle.rb', line 378

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 Also known as: add 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/rexle.rb', line 353

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 



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

def add_text(s) @value = s; self end

#attribute(key) ⇒ Object 



393
394
395
396
 
# File 'lib/rexle.rb', line 393

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

#attributes ⇒ Object 



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

def attributes() @attributes end

#children ⇒ Object 



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

def children() @child_elements end

#children=(a) ⇒ Object 



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

def children=(a) @child_elements = a end

#clone ⇒ Object 



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

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

#count(path) ⇒ Object 



162
163
164
165
 
# File 'lib/rexle.rb', line 162

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

#deep_clone ⇒ Object 



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

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

#delete(obj = nil) ⇒ Object 



404
405
406
407
408
409
410
411
 
# File 'lib/rexle.rb', line 404

def delete(obj=nil)
  if obj then
    i = @child_elements.index(obj)
    [@child_elements, @child_lookup].each{|x| x.delete_at i} if i
  else
    self.parent.delete self
  end
end

#doc_root ⇒ Object 



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

def doc_root() @rexle.root end

#each(&blk) ⇒ Object 



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

def each(&blk) @child_elements.each(&blk) end

#element(s) ⇒ Object 



413
414
415
416
 
# File 'lib/rexle.rb', line 413

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

#elements(s = nil) ⇒ Object 



418
419
420
421
422
423
424
425
 
# File 'lib/rexle.rb', line 418

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 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rexle.rb', line 184

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 = {
      Array: proc {|x| block_given? ? x : x.flatten.uniq }, 
      String: 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, bucket, &blk)
    end

    #results = raw_results.inject(&:+)
    results = raw_results.last
    procs[results.class.to_s.to_sym].call(results) if results
    
  else
    m, xpath_value = fn_match.captures
    method(m.to_sym).call(xpath_value)
  end

end

#has_elements? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#inspect ⇒ Object 



368
369
370
371
372
373
374
 
# File 'lib/rexle.rb', line 368

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

#max(path) ⇒ Object 



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

def max(path) query_xpath(path).flatten.compact.map(&:to_i).max end

#original_clone ⇒ Object 



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

alias original_clone clone

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
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
348
349
350
351
 
# File 'lib/rexle.rb', line 214

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(/^\[/,'*[')
  #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[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[/^@/] then
      element_name = element_part[/^[\w:\*\.]+/]
    else

      condition = xpath_value[/^\[/] ? xpath_value : element_part
      element_name = nil
    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

  elsif (raw_path == '.' or raw_path == self.name) and attr_search.nil? then
    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){|e| r = e.xpath(a_path.join('/') + raw_condition.to_s + remaining_path, &blk); (r || e) }
        next if rtn_element.nil? or (rtn_element.is_a? Array and rtn_element.empty?)

        if 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 



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

def root() self end

#text(s = '') ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/rexle.rb', line 432

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

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



467
468
469
470
471
 
# File 'lib/rexle.rb', line 467

def xml(options={})
  o = {pretty: false}.merge(options)
  msg = o[:pretty] == false ? :doc_print : :doc_pretty_print
  method(msg).call(self.children)
end

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



179
180
181
182
 
# File 'lib/rexle.rb', line 179

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