Class: Moxml::Adapter::Oga

Inherits:
Base
  • Object
show all
Defined in:
lib/moxml/adapter/oga.rb

Class Method Summary collapse

Methods inherited from Base

create_cdata, create_comment, create_declaration, create_doctype, create_element, create_namespace, create_processing_instruction, create_text, duplicate_node, patch_node, prepare_for_new_document, sax_supported?, set_attribute_name, set_attribute_value

Methods included from XmlUtils

#encode_entities, #normalize_xml_value, #validate_comment_content, #validate_declaration_encoding, #validate_declaration_standalone, #validate_declaration_version, #validate_element_name, #validate_pi_target, #validate_prefix, #validate_uri

Class Method Details

.add_child(element, child_or_text) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/moxml/adapter/oga.rb', line 242

def add_child(element, child_or_text)
  child =
    if child_or_text.is_a?(String)
      create_native_text(child_or_text)
    else
      child_or_text
    end

  element.children << child
end

.add_next_sibling(node, sibling) ⇒ Object 



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/moxml/adapter/oga.rb', line 264

def add_next_sibling(node, sibling)
  if node.parent == sibling.parent
    # Oga doesn't manipulate children of the same parent
    dup_sibling = node.node_set.delete(sibling)
    index = node.node_set.index(node) + 1
    node.node_set.insert(index, dup_sibling)
  else
    node.after(sibling)
  end
end

.add_previous_sibling(node, sibling) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/moxml/adapter/oga.rb', line 253

def add_previous_sibling(node, sibling)
  if node.parent == sibling.parent
    # Oga doesn't manipulate children of the same parent
    dup_sibling = node.node_set.delete(sibling)
    index = node.node_set.index(node)
    node.node_set.insert(index, dup_sibling)
  else
    node.before(sibling)
  end
end

.at_xpath(node, expression, namespaces = nil) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/moxml/adapter/oga.rb', line 363

def at_xpath(node, expression, namespaces = nil)
  node.at_xpath(expression, namespaces: namespaces)
rescue ::Oga::XPath::Error => e
  raise Moxml::XPathError.new(
    e.message,
    expression: expression,
    adapter: "Oga",
    node: node,
  )
end

.attribute_element(attr) ⇒ Object 



201
202
203
 
# File 'lib/moxml/adapter/oga.rb', line 201

def attribute_element(attr)
  attr.element
end

.attributes(element) ⇒ Object 



205
206
207
208
209
210
211
212
 
# File 'lib/moxml/adapter/oga.rb', line 205

def attributes(element)
  return [] unless element.respond_to?(:attributes)

  # remove attributes-namespaces
  element.attributes.reject do |attr|
    attr.name == ::Oga::XML::Element::XMLNS_PREFIX || attr.namespace_name == ::Oga::XML::Element::XMLNS_PREFIX
  end
end

.cdata_content(node) ⇒ Object 



310
311
312
 
# File 'lib/moxml/adapter/oga.rb', line 310

def cdata_content(node)
  node.text
end

.children(node) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/moxml/adapter/oga.rb', line 161

def children(node)
  all_children = []

  if node.is_a?(::Oga::XML::Document)
    all_children += [node.xml_declaration,
                     node.doctype].compact
  end

  return all_children unless node.respond_to?(:children)

  all_children + node.children.reject do |child|
    child.is_a?(::Oga::XML::Text) &&
      child.text.strip.empty? &&
      !(child.previous.nil? && child.next.nil?)
  end
end

.comment_content(node) ⇒ Object 



318
319
320
 
# File 'lib/moxml/adapter/oga.rb', line 318

def comment_content(node)
  node.text
end

.create_document(_native_doc = nil) ⇒ Object 



52
53
54
 
# File 'lib/moxml/adapter/oga.rb', line 52

def create_document(_native_doc = nil)
  ::Oga::XML::Document.new
end

.create_native_cdata(content) ⇒ Object 



64
65
66
 
# File 'lib/moxml/adapter/oga.rb', line 64

def create_native_cdata(content)
  ::Oga::XML::Cdata.new(text: content)
end

.create_native_comment(content) ⇒ Object 



68
69
70
 
# File 'lib/moxml/adapter/oga.rb', line 68

def create_native_comment(content)
  ::Oga::XML::Comment.new(text: content)
end

.create_native_declaration(version, encoding, standalone) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/moxml/adapter/oga.rb', line 82

def create_native_declaration(version, encoding, standalone)
  attrs = {
    version: version,
    encoding: encoding,
    standalone: standalone,
  }.compact
  ::Moxml::Adapter::CustomizedOga::XmlDeclaration.new(attrs)
end

.create_native_doctype(name, external_id, system_id) ⇒ Object 



72
73
74
75
76
 
# File 'lib/moxml/adapter/oga.rb', line 72

def create_native_doctype(name, external_id, system_id)
  ::Oga::XML::Doctype.new(
    name: name, public_id: external_id, system_id: system_id, type: "PUBLIC",
  )
end

.create_native_element(name) ⇒ Object 



56
57
58
 
# File 'lib/moxml/adapter/oga.rb', line 56

def create_native_element(name)
  ::Oga::XML::Element.new(name: name)
end

.create_native_namespace(element, prefix, uri) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/moxml/adapter/oga.rb', line 107

def create_native_namespace(element, prefix, uri)
  ns = element.available_namespaces[prefix]
  return ns unless ns.nil?

  # Oga creates an attribute and registers a namespace
  set_attribute(element,
                [::Oga::XML::Element::XMLNS_PREFIX, prefix].compact.join(":"), uri)
  element.register_namespace(prefix, uri)
  ::Oga::XML::Namespace.new(name: prefix, uri: uri)
end

.create_native_processing_instruction(target, content) ⇒ Object 



78
79
80
 
# File 'lib/moxml/adapter/oga.rb', line 78

def create_native_processing_instruction(target, content)
  ::Oga::XML::ProcessingInstruction.new(name: target, text: content)
end

.create_native_text(content) ⇒ Object 



60
61
62
 
# File 'lib/moxml/adapter/oga.rb', line 60

def create_native_text(content)
  ::Oga::XML::Text.new(text: content)
end

.declaration_attribute(declaration, attr_name) ⇒ Object 



91
92
93
94
95
96
97
 
# File 'lib/moxml/adapter/oga.rb', line 91

def declaration_attribute(declaration, attr_name)
  unless ::Moxml::Declaration::ALLOWED_ATTRIBUTES.include?(attr_name.to_s)
    return
  end

  declaration.public_send(attr_name)
end

.document(node) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/moxml/adapter/oga.rb', line 190

def document(node)
  current = node
  current = current.parent while parent(current)

  current
end

.get_attribute(element, name) ⇒ Object 



229
230
231
 
# File 'lib/moxml/adapter/oga.rb', line 229

def get_attribute(element, name)
  element.attribute(name.to_s)
end

.get_attribute_value(element, name) ⇒ Object 



233
234
235
 
# File 'lib/moxml/adapter/oga.rb', line 233

def get_attribute_value(element, name)
  element[name.to_s]
end

.inner_text(node) ⇒ Object 



292
293
294
295
296
297
298
299
 
# File 'lib/moxml/adapter/oga.rb', line 292

def inner_text(node)
  if node.respond_to?(:inner_text)
    node.inner_text
  else
    # Oga::XML::Text node for example
    node.text
  end
end

.namespace(element) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/moxml/adapter/oga.rb', line 122

def namespace(element)
  if element.respond_to?(:namespace)
    element.namespace
  elsif element.respond_to?(:namespaces)
    element.namespaces.values.last
  end
rescue NoMethodError
  # Oga attributes fail with NoMethodError:
  # undefined method `available_namespaces' for nil:NilClass
  nil
end

.namespace_definitions(node) ⇒ Object 



345
346
347
348
349
 
# File 'lib/moxml/adapter/oga.rb', line 345

def namespace_definitions(node)
  return [] unless node.respond_to?(:namespaces)

  node.namespaces.values
end

.namespace_prefix(namespace) ⇒ Object 



334
335
336
337
338
339
 
# File 'lib/moxml/adapter/oga.rb', line 334

def namespace_prefix(namespace)
  # nil for the default namespace
  return if namespace.name == ::Oga::XML::Element::XMLNS_PREFIX

  namespace.name
end

.namespace_uri(namespace) ⇒ Object 



341
342
343
 
# File 'lib/moxml/adapter/oga.rb', line 341

def namespace_uri(namespace)
  namespace.uri
end

.next_sibling(node) ⇒ Object 



182
183
184
 
# File 'lib/moxml/adapter/oga.rb', line 182

def next_sibling(node)
  node.next
end

.node_name(node) ⇒ Object 



153
154
155
 
# File 'lib/moxml/adapter/oga.rb', line 153

def node_name(node)
  node.name
end

.node_type(node) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/moxml/adapter/oga.rb', line 138

def node_type(node)
  case node
  when ::Oga::XML::Element then :element
  when ::Oga::XML::Text then :text
  when ::Oga::XML::Cdata then :cdata
  when ::Oga::XML::Comment then :comment
  when ::Oga::XML::Attribute then :attribute
  when ::Oga::XML::Namespace then :namespace
  when ::Oga::XML::ProcessingInstruction then :processing_instruction
  when ::Oga::XML::Document then :document
  when ::Oga::XML::Doctype then :doctype
  else :unknown
  end
end

.parent(node) ⇒ Object 



178
179
180
 
# File 'lib/moxml/adapter/oga.rb', line 178

def parent(node)
  node.parent if node.respond_to?(:parent)
end

.parse(xml, options = {}) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/moxml/adapter/oga.rb', line 17

def parse(xml, options = {})
  native_doc = begin
    ::Oga.parse_xml(xml, strict: options[:strict])
  rescue LL::ParserError => e
    raise Moxml::ParseError.new(
      e.message,
      source: xml.is_a?(String) ? xml[0..100] : nil,
    )
  end

  DocumentBuilder.new(Context.new(:oga)).build(native_doc)
end

.previous_sibling(node) ⇒ Object 



186
187
188
 
# File 'lib/moxml/adapter/oga.rb', line 186

def previous_sibling(node)
  node.previous
end

.processing_instruction_content(node) ⇒ Object 



326
327
328
 
# File 'lib/moxml/adapter/oga.rb', line 326

def processing_instruction_content(node)
  node.text
end

.processing_instruction_target(node) ⇒ Object 



134
135
136
 
# File 'lib/moxml/adapter/oga.rb', line 134

def processing_instruction_target(node)
  node.name
end

.remove(node) ⇒ Object 



275
276
277
 
# File 'lib/moxml/adapter/oga.rb', line 275

def remove(node)
  node.remove
end

.remove_attribute(element, name) ⇒ Object 



237
238
239
240
 
# File 'lib/moxml/adapter/oga.rb', line 237

def remove_attribute(element, name)
  attr = element.attribute(name.to_s)
  element.attributes.delete(attr) if attr
end

.replace(node, new_node) ⇒ Object 



279
280
281
 
# File 'lib/moxml/adapter/oga.rb', line 279

def replace(node, new_node)
  node.replace(new_node)
end

.replace_children(node, new_children) ⇒ Object 



283
284
285
286
 
# File 'lib/moxml/adapter/oga.rb', line 283

def replace_children(node, new_children)
  node.children = []
  new_children.each { |child| add_child(node, child) }
end

.root(document) ⇒ Object 



197
198
199
 
# File 'lib/moxml/adapter/oga.rb', line 197

def root(document)
  document.children.find { |node| node.is_a?(::Oga::XML::Element) }
end

.sax_parse(xml, handler) ⇒ void

This method returns an undefined value.

SAX parsing implementation for Oga

Parameters:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/moxml/adapter/oga.rb', line 35

def sax_parse(xml, handler)
  bridge = OgaSAXBridge.new(handler)

  xml_string = xml.respond_to?(:read) ? xml.read : xml.to_s

  # Manually call start_document (Oga doesn't)
  handler.on_start_document

  ::Oga.sax_parse_xml(bridge, xml_string)

  # Manually call end_document (Oga doesn't)
  handler.on_end_document
rescue StandardError => e
  error = Moxml::ParseError.new(e.message)
  handler.on_error(error)
end

.serialize(node, _options = {}) ⇒ Object 



374
375
376
377
 
# File 'lib/moxml/adapter/oga.rb', line 374

def serialize(node, _options = {})
  # Expand empty tags, encode attributes, etc
  ::Moxml::Adapter::CustomizedOga::XmlGenerator.new(node).to_xml
end

.set_attribute(element, name, value) ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/moxml/adapter/oga.rb', line 214

def set_attribute(element, name, value)
  namespace_name = nil
  if name.to_s.include?(":")
    namespace_name, name = name.to_s.split(":",
                                           2)
  end

  attr = ::Oga::XML::Attribute.new(
    name: name.to_s,
    namespace_name: namespace_name,
    value: value.to_s,
  )
  element.add_attribute(attr)
end

.set_cdata_content(node, content) ⇒ Object 



314
315
316
 
# File 'lib/moxml/adapter/oga.rb', line 314

def set_cdata_content(node, content)
  node.text = content
end

.set_comment_content(node, content) ⇒ Object 



322
323
324
 
# File 'lib/moxml/adapter/oga.rb', line 322

def set_comment_content(node, content)
  node.text = content
end

.set_declaration_attribute(declaration, attr_name, value) ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/moxml/adapter/oga.rb', line 99

def set_declaration_attribute(declaration, attr_name, value)
  unless ::Moxml::Declaration::ALLOWED_ATTRIBUTES.include?(attr_name.to_s)
    return
  end

  declaration.public_send("#{attr_name}=", value)
end

.set_namespace(element, ns_or_string) ⇒ Object 



118
119
120
 
# File 'lib/moxml/adapter/oga.rb', line 118

def set_namespace(element, ns_or_string)
  element.namespace_name = ns_or_string.to_s
end

.set_node_name(node, name) ⇒ Object 



157
158
159
 
# File 'lib/moxml/adapter/oga.rb', line 157

def set_node_name(node, name)
  node.name = name
end

.set_processing_instruction_content(node, content) ⇒ Object 



330
331
332
 
# File 'lib/moxml/adapter/oga.rb', line 330

def set_processing_instruction_content(node, content)
  node.text = content
end

.set_root(doc, element) ⇒ Object 



12
13
14
15
 
# File 'lib/moxml/adapter/oga.rb', line 12

def set_root(doc, element)
  doc.children.clear # Clear any existing children
  doc.children << element
end

.set_text_content(node, content) ⇒ Object 



301
302
303
304
305
306
307
308
 
# File 'lib/moxml/adapter/oga.rb', line 301

def set_text_content(node, content)
  if node.respond_to?(:inner_text=)
    node.inner_text = content
  else
    # Oga::XML::Text node for example
    node.text = content
  end
end

.text_content(node) ⇒ Object 



288
289
290
 
# File 'lib/moxml/adapter/oga.rb', line 288

def text_content(node)
  node.text
end

.xpath(node, expression, namespaces = nil) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/moxml/adapter/oga.rb', line 351

def xpath(node, expression, namespaces = nil)
  node.xpath(expression, {},
             namespaces: namespaces&.transform_keys(&:to_s)).to_a
rescue ::LL::ParserError => e
  raise Moxml::XPathError.new(
    e.message,
    expression: expression,
    adapter: "Oga",
    node: node,
  )
end