Module: Handsoap::XmlQueryFront::BaseDriver

Included in:
LibXMLDriver, NokogiriDriver, REXMLDriver
Defined in:
lib/handsoap/xml_query_front.rb

Overview

Wraps the underlying (native) xml driver, and provides a uniform interface.

Instance Method Summary collapse

Instance Method Details

#/(expression) ⇒ Object

alias of xpath



189
190
191
 
# File 'lib/handsoap/xml_query_front.rb', line 189

def /(expression)
  self.xpath(expression)
end

#[](attribute_name) ⇒ Object

Returns the attribute value of the underlying element.

Shortcut for:

(node/"@attribute_name").to_s

Raises:

  • (NotImplementedError) 


197
198
199
 
# File 'lib/handsoap/xml_query_front.rb', line 197

def [](attribute_name)
  raise NotImplementedError.new
end

#add_namespace(prefix, uri) ⇒ Object

Registers a prefix to refer to a namespace.

You can either register a nemspace with this function or pass it explicitly to the xpath method.



113
114
115
 
# File 'lib/handsoap/xml_query_front.rb', line 113

def add_namespace(prefix, uri)
  @namespaces[prefix] = uri
end

#assert_prefixes!(expression, ns) ⇒ Object

Checks that an xpath-query doesn’t refer to any undefined prefixes in ns



117
118
119
120
121
 
# File 'lib/handsoap/xml_query_front.rb', line 117

def assert_prefixes!(expression, ns)
  expression.scan(/([a-zA-Z_][a-zA-Z0-9_.-]*):[^:]+/).map{|m| m[0] }.each do |prefix|
    raise "Undefined prefix '#{prefix}'" if ns[prefix].nil?
  end
end

#initialize(element, namespaces = {}) ⇒ Object 



106
107
108
109
 
# File 'lib/handsoap/xml_query_front.rb', line 106

def initialize(element, namespaces = {})
  @element = element
  @namespaces = namespaces
end

#native_element ⇒ Object

Returns the underlying native element.

You shouldn’t need to use this, since doing so would void portability.



163
164
165
 
# File 'lib/handsoap/xml_query_front.rb', line 163

def native_element
  @element
end

#node_name ⇒ Object

Returns the node name of the current element.

Raises:

  • (NotImplementedError) 


167
168
169
 
# File 'lib/handsoap/xml_query_front.rb', line 167

def node_name
  raise NotImplementedError.new
end

#to_boolean ⇒ Object

Returns the value of the element as an boolean.

See to_s



141
142
143
144
145
 
# File 'lib/handsoap/xml_query_front.rb', line 141

def to_boolean
  t = self.to_s
  return if t.nil?
  t.downcase == 'true'
end

#to_date ⇒ Object

Returns the value of the element as a ruby Time object.

See to_s



149
150
151
152
153
 
# File 'lib/handsoap/xml_query_front.rb', line 149

def to_date
  t = self.to_s
  return if t.nil?
  Time.iso8601(t)
end

#to_f ⇒ Object

Returns the value of the element as a float.

See to_s



133
134
135
136
137
 
# File 'lib/handsoap/xml_query_front.rb', line 133

def to_f
  t = self.to_s
  return if t.nil?
  t.to_f
end

#to_i ⇒ Object

Returns the value of the element as an integer.

See to_s



125
126
127
128
129
 
# File 'lib/handsoap/xml_query_front.rb', line 125

def to_i
  t = self.to_s
  return if t.nil?
  t.to_i
end

#to_raw ⇒ Object

Returns the outer XML for this element, preserving the original formatting.

Raises:

  • (NotImplementedError) 


185
186
187
 
# File 'lib/handsoap/xml_query_front.rb', line 185

def to_raw
  raise NotImplementedError.new
end

#to_s ⇒ Object

Returns the inner text content of this element, or the value (if it’s an attr or textnode).

The output is a UTF-8 encoded string, without xml-entities.

Raises:

  • (NotImplementedError) 


157
158
159
 
# File 'lib/handsoap/xml_query_front.rb', line 157

def to_s
  raise NotImplementedError.new
end

#to_xml ⇒ Object

Returns the outer XML for this element.

Raises:

  • (NotImplementedError) 


181
182
183
 
# File 'lib/handsoap/xml_query_front.rb', line 181

def to_xml
  raise NotImplementedError.new
end

#xpath(expression, ns = nil) ⇒ Object

Queries the document with XPath, relative to the current element.

ns Should be a Hash of prefix => namespace

Returns a NodeSelection

See add_namespace

Raises:

  • (NotImplementedError) 


177
178
179
 
# File 'lib/handsoap/xml_query_front.rb', line 177

def xpath(expression, ns = nil)
  raise NotImplementedError.new
end