Class: Leptris::XML::Element

Inherits:
Node
  • Object
show all
Defined in:
lib/leptris/xml/element.rb

Instance Attribute Summary

Attributes inherited from Node

#c_ptr, #document

Instance Method Summary collapse

Methods inherited from Node

#<=>, #==, #cdata?, #child, #children, #comment?, #css_path, #element?, #element_children, #ensure_alive!, #ensure_writable!, #first_element_child, #initialize, #inner_text, #inspect, #last_element_child, #line, #next_element, #next_sibling, #parent, #path, #previous_element, #previous_sibling, #processing_instruction?, #readonly_document?, #text, #text?, #traverse, #type, #unlink, wrap

Methods included from Searchable

#at, #at_css, #at_xpath, #css, #search, wrap_xpath_result, #xpath

Constructor Details

This class inherits a constructor from Leptris::XML::Node

Instance Method Details

#[](key) ⇒ Object Also known as: attr, get_attribute 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/leptris/xml/element.rb', line 34

def [](key)
  # Readonly: the attributes hash cannot go stale (ADR 0003) and
  # materializes on demand — repeated reads become hash lookups,
  # with no dispatch and no lifetime guard (a hash read cannot
  # use-after-free).
  if readonly_document?
    cached = attributes[key.to_s]
    return cached.nil? ? nil : cached.value
  end
  ensure_alive!
  Leptris::XML::FFI.leptris_element_attribute(@c_ptr, key.to_s)
end

#[]=(key, value) ⇒ Object Also known as: set_attribute 



49
50
51
52
53
54
 
# File 'lib/leptris/xml/element.rb', line 49

def []=(key, value)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_set_attribute(@c_ptr, key.to_s, value.to_s))
  value
end

#add_child(node_or_markup) ⇒ Object Also known as: << 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/leptris/xml/element.rb', line 227

def add_child(node_or_markup)
  ensure_writable!
  case node_or_markup
  when Leptris::XML::Node
    Leptris::XML::FFI.check_status(
      Leptris::XML::FFI.leptris_element_append_child(@c_ptr, node_or_markup.c_ptr))
    node_or_markup
  when String
    frag = Leptris::XML::DocumentFragment.parse(node_or_markup, @document)
    added = []
    frag.children.each do |n|
      Leptris::XML::FFI.check_status(
        Leptris::XML::FFI.leptris_element_append_child(@c_ptr, n.c_ptr))
      added << n
    end
    Leptris::XML::NodeSet.new(@document, added)
  else
    raise ArgumentError, "add_child expects a Node or String, got #{node_or_markup.class}"
  end
end

#add_namespace_definition(prefix, href) ⇒ Object Also known as: add_namespace 



317
318
319
320
321
322
323
 
# File 'lib/leptris/xml/element.rb', line 317

def add_namespace_definition(prefix, href)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_add_namespace_definition(
      @c_ptr, prefix.to_s, href.to_s))
  Leptris::XML::Namespace.new(self, href.to_s, prefix: prefix.nil? ? nil : prefix.to_s)
end

#add_next_sibling(node) ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/leptris/xml/element.rb', line 149

def add_next_sibling(node)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_insert_after(@c_ptr, node.c_ptr))
  node
end

#add_previous_sibling(node) ⇒ Object 



156
157
158
159
160
161
 
# File 'lib/leptris/xml/element.rb', line 156

def add_previous_sibling(node)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_insert_before(@c_ptr, node.c_ptr))
  node
end

#attribute_nodes ⇒ Object 



128
129
130
131
132
133
 
# File 'lib/leptris/xml/element.rb', line 128

def attribute_nodes
  return @attribute_nodes if readonly_cached?(:@attribute_nodes)
  result = each_attribute.to_a
  @attribute_nodes = result if @document&.readonly?
  result
end

#attribute_ns(uri, local) ⇒ Object

Expanded-name attribute access (libleptris 1.8.0): URI + local name with XML Namespaces 1.0 semantics — the written prefix never matters, only what it resolves to through this element's in-scope declarations. uri nil/"" matches no-namespace attributes only; xmlns declarations are invisible.



68
69
70
71
72
 
# File 'lib/leptris/xml/element.rb', line 68

def attribute_ns(uri, local)
  ensure_alive!
  Leptris::XML::FFI.leptris_element_attribute_ns(
    @c_ptr, uri&.to_s, local.to_s)
end

#attributes ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/leptris/xml/element.rb', line 120

def attributes
  return @attributes if readonly_cached?(:@attributes)
  result = {}
  each_attribute { |attr| result[attr.name] = attr }
  @attributes = result if @document&.readonly?
  result
end

#canonicalize(version = Leptris::XML::FFI::C14N_1_0, inclusive_namespaces = nil, with_comments: false, exclusive: false, mode: nil) ⇒ Object Also known as: c14n 



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/leptris/xml/element.rb', line 302

def canonicalize(version = Leptris::XML::FFI::C14N_1_0,
                 inclusive_namespaces = nil,
                 with_comments: false,
                 exclusive: false,
                 mode: nil)
  resolved_mode = mode || (exclusive ? Leptris::XML::FFI::C14N_MODE_EXCLUSIVE
                                     : Leptris::XML::FFI::C14N_MODE_CANONICAL)
  Leptris::XML::Serialization.canonicalize(
    Leptris::XML::FFI.method(:leptris_c14n_canonicalize_subtree_ex), @c_ptr,
    version: version, mode: resolved_mode,
    inclusive_namespaces: inclusive_namespaces,
    with_comments: with_comments)
end

#children=(node_or_nodes) ⇒ Object 



170
171
172
173
174
175
176
 
# File 'lib/leptris/xml/element.rb', line 170

def children=(node_or_nodes)
  ensure_writable!
  # Remove existing children, then attach the new ones in source order.
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_remove_children(@c_ptr))
  Array(node_or_nodes).each { |n| add_child(n) }
end

#content ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/leptris/xml/element.rb', line 19

def content
  return @content if readonly_cached?(:@content)
  ensure_alive!
  Leptris::XML::FFI.leptris_element_text(@c_ptr).tap do |text|
    @content = text if @document&.readonly?
  end
end

#content=(new_content) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/leptris/xml/element.rb', line 27

def content=(new_content)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_set_text(@c_ptr, new_content.to_s))
  new_content
end

#default_namespace=(href) ⇒ Object 



326
327
328
329
330
331
 
# File 'lib/leptris/xml/element.rb', line 326

def default_namespace=(href)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_set_default_namespace(@c_ptr, href.to_s))
  href
end

#dup ⇒ Object Also known as: clone

Raises:



220
221
222
223
224
 
# File 'lib/leptris/xml/element.rb', line 220

def dup
  copy_ptr = Leptris::XML::FFI.leptris_element_copy(@c_ptr, @document.c_ptr)
  raise Leptris::XML::Error, "leptris_element_copy failed" if copy_ptr.null?
  Leptris::XML::Node.wrap(copy_ptr, @document)
end

#each_attribute ⇒ Object

Iterates the element's attributes via the v1.1.0 linked-list face (one FFI call per attribute; the name_at/value_at indexing API re-walks the list per index, making it O(n^2) per element). The C attribute handle rides along so Attr can serve the per-attribute namespace accessors (libleptris 1.8.0).



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/leptris/xml/element.rb', line 93

def each_attribute
  return enum_for(:each_attribute) unless block_given?
  ensure_alive!
  attr = Leptris::XML::FFI.leptris_element_first_attribute(@c_ptr)
  until attr.nil? || attr.null?
    name = Leptris::XML::FFI.leptris_attribute_get_name(attr)
    value = Leptris::XML::FFI.leptris_attribute_get_value(@c_ptr, attr)
    yield Leptris::XML::Attr.new(name, value, self, c_handle: attr)
    attr = Leptris::XML::FFI.leptris_attribute_next(attr)
  end
  self
end

#has_attribute_ns?(uri, local) ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
77
78
 
# File 'lib/leptris/xml/element.rb', line 74

def has_attribute_ns?(uri, local)
  ensure_alive!
  Leptris::XML::FFI.leptris_element_has_attribute_ns(
    @c_ptr, uri&.to_s, local.to_s) != 0
end

#key?(name) ⇒ Boolean Also known as: has_attribute?

Returns:

  • (Boolean) 


57
58
59
60
 
# File 'lib/leptris/xml/element.rb', line 57

def key?(name)
  ensure_alive!
  Leptris::XML::FFI.leptris_element_has_attribute(@c_ptr, name.to_s) != 0
end

#keys ⇒ Object 



106
107
108
109
110
111
 
# File 'lib/leptris/xml/element.rb', line 106

def keys
  return @keys if readonly_cached?(:@keys)
  result = each_attribute.to_a.map(&:name)
  @keys = result if @document&.readonly?
  result
end

#name ⇒ Object Also known as: node_name 



4
5
6
7
8
 
# File 'lib/leptris/xml/element.rb', line 4

def name
  return @name if @name
  ensure_alive!
  @name = Leptris::XML::FFI.leptris_element_name(@c_ptr)
end

#name=(new_name) ⇒ Object Also known as: node_name= 



11
12
13
14
15
16
 
# File 'lib/leptris/xml/element.rb', line 11

def name=(new_name)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_set_name(@c_ptr, new_name))
  @name = new_name
end

#namespace ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/leptris/xml/element.rb', line 249

def namespace
  return @namespace if readonly_cached?(:@namespace)
  ensure_alive!
  uri = Leptris::XML::FFI.leptris_element_namespace(@c_ptr)
  result =
    if uri.nil? || uri.empty?
      nil
    else
      # The resolved namespace is reached via this element's own
      # prefix, so carry it through: consumers that distinguish
      # {"p" => "urn:p"} from the default {"nil => "urn:p"} need it.
      prefix = Leptris::XML::FFI.leptris_element_prefix(@c_ptr)
      prefix = nil if prefix.nil? || prefix.empty?
      Leptris::XML::Namespace.new(self, uri, prefix: prefix)
    end
  @namespace = result if @document&.readonly?
  result
end

#namespace_definitions ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/leptris/xml/element.rb', line 268

def namespace_definitions
  return @namespace_definitions if readonly_cached?(:@namespace_definitions)
  ensure_alive!
  count = Leptris::XML::FFI.leptris_element_namespace_count(@c_ptr)
  result = count.times.map do |i|
    prefix = Leptris::XML::FFI.leptris_element_namespace_decl_prefix(@c_ptr, i)
    uri = Leptris::XML::FFI.leptris_element_namespace_decl_uri(@c_ptr, i)
    Leptris::XML::Namespace.new(self, uri, prefix: prefix)
  end
  @namespace_definitions = result if @document&.readonly?
  result
end

#namespaces ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/leptris/xml/element.rb', line 281

def namespaces
  return @namespaces if readonly_cached?(:@namespaces)
  scopes = {}
  node = self
  while node.is_a?(Leptris::XML::Element)
    node.namespace_definitions.each do |ns|
      key = ns.prefix ? "xmlns:#{ns.prefix}" : "xmlns"
      scopes[key] ||= ns.href
    end
    node = node.parent
  end
  @namespaces = scopes if @document&.readonly?
  scopes
end

#prefix ⇒ Object

The element's own namespace prefix (e.g. "foo" for foo:child/), or nil when the element has none.



137
138
139
140
 
# File 'lib/leptris/xml/element.rb', line 137

def prefix
  ensure_alive!
  Leptris::XML::FFI.leptris_element_prefix(@c_ptr)
end

#prepend_child(node) ⇒ Object 



142
143
144
145
146
147
 
# File 'lib/leptris/xml/element.rb', line 142

def prepend_child(node)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_prepend_child(@c_ptr, node.c_ptr))
  node
end

#remove_attribute(name) ⇒ Object Also known as: delete 



80
81
82
83
84
85
 
# File 'lib/leptris/xml/element.rb', line 80

def remove_attribute(name)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_remove_attribute(@c_ptr, name.to_s))
  self
end

#remove_child(node) ⇒ Object 



163
164
165
166
167
168
 
# File 'lib/leptris/xml/element.rb', line 163

def remove_child(node)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_remove_child(@c_ptr, node.c_ptr))
  node
end

#remove_namespace_definition(prefix) ⇒ Object 



333
334
335
336
337
338
 
# File 'lib/leptris/xml/element.rb', line 333

def remove_namespace_definition(prefix)
  ensure_writable!
  Leptris::XML::FFI.check_status(
    Leptris::XML::FFI.leptris_element_remove_namespace_definition(@c_ptr, prefix.to_s))
  self
end

#replace(new_node) ⇒ Object

Replace this element with new_node in the parent's child list. new_node must belong to the same document. Returns new_node.

Raises:



180
181
182
183
184
185
186
 
# File 'lib/leptris/xml/element.rb', line 180

def replace(new_node)
  parent = self.parent
  raise Leptris::XML::Error, "cannot replace a node with no parent" unless parent
  add_next_sibling(new_node)
  parent.remove_child(self)
  new_node
end

#swap(new_node) ⇒ Object

Like #replace but returns self for chaining.



189
190
191
192
 
# File 'lib/leptris/xml/element.rb', line 189

def swap(new_node)
  replace(new_node)
  self
end

#to_xml(indent: 0, no_decl: false, encoding: nil) ⇒ Object 



296
297
298
299
300
 
# File 'lib/leptris/xml/element.rb', line 296

def to_xml(indent: 0, no_decl: false, encoding: nil)
  Leptris::XML::Serialization.to_xml(
    Leptris::XML::FFI.method(:leptris_element_serialize_into), @c_ptr,
    indent: indent, no_decl: no_decl, encoding: encoding)
end

#values ⇒ Object 



113
114
115
116
117
118
 
# File 'lib/leptris/xml/element.rb', line 113

def values
  return @values if readonly_cached?(:@values)
  result = each_attribute.to_a.map(&:value)
  @values = result if @document&.readonly?
  result
end

#wrap(node_or_markup) ⇒ Object

Wrap this element in a new element parsed from markup or a dup of node. The wrapper takes this element's place in the tree, and this element becomes its only child. Returns self for chaining.

Raises:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/leptris/xml/element.rb', line 197

def wrap(node_or_markup)
  wrapper =
    case node_or_markup
    when Leptris::XML::Element then node_or_markup.dup
    when String
      frag_doc = Leptris::XML::Document.parse(node_or_markup)
      frag_doc.root or raise Leptris::XML::Error, "wrap markup has no root element"
    else
      raise ArgumentError, "wrap expects a String or Element, got #{node_or_markup.class}"
    end

  parent = self.parent
  raise Leptris::XML::Error, "cannot wrap a node with no parent" unless parent

  # Insert wrapper at self's position, then move self into wrapper.
  # add_child moves self (unlinks from old parent first), so no explicit
  # remove_child needed — and trying to remove after the move corrupts
  # the C tree (libleptris silently handles non-child args badly).
  add_next_sibling(wrapper)
  wrapper.add_child(self)
  self
end