Class: Excemel::Document

Inherits:
BlankSlate
  • Object
show all
Defined in:
lib/excemel/excemel.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Document

Create an Excemel Document The method expects a hash that contain the possible elements :root => value : The name of the root or top-most element of the document :xml => value : A string containing an XML document :url => value : A URL pointing to an XML document :file => filename : A filename pointing to an XML file :validate => true|false : whether to validate the document being read from

an XML string, URL or file

:resolve_includes => true|false replaces xi:include elements by the content they refer to :namespace => provides a namespace prefix to the elements



45
46
47
48
49
50
51
52
 
# File 'lib/excemel/excemel.rb', line 45

def initialize(options)
  resolve_includes = _extract_options(options, :resolve_includes, true)
  
  _build_document(options)
        
  @doc = XOM::XIncluder.resolve(@doc) if resolve_includes  
  @target = @root
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object

Dynamic Proxy behavior Add XML elements (tags) based on the name of the method called on the Document instance, blocks passed get processed recursively



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/excemel/excemel.rb', line 57

def method_missing(sym, *args, &block)
  unless %w(class to_s inspect).include?(sym.to_s)                                      
    sym = _extract_sym(args, sym)
    attrs, namespace, prefix, text = _process_args(args, sym)
    tag = _build_tag(sym, namespace)   
    _add_attributes(tag, attrs)
    
    if block
      _nested_structures(block, tag)
    elsif !text.nil?              
      tag.append_child text
    end
    
    @target.append_child tag
  end
  
  self
end

Instance Method Details

#attributes(attrs) ⇒ Object

Adds attributes to the current target element (pointer to an element in the document by default the root of the document)



183
184
185
 
# File 'lib/excemel/excemel.rb', line 183

def attributes(attrs)
  _add_attributes(@target, attrs)
end

#comment!(string) ⇒ Object

Appends a comment node at the current position in the document



82
83
84
85
86
 
# File 'lib/excemel/excemel.rb', line 82

def comment!(string)
  comment = XOM::Comment.new string
  @target.append_child(comment)
  self
end

#doc_type!(root_element_name, public_id = '', system_id = '') ⇒ Object

Appends an XML document type declaration at the current position in the document



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

def doc_type!(root_element_name, public_id='', system_id='')
  doctype = XOM::DocType.new(root_element_name, public_id, system_id)
  @doc.insert_child(doctype, 0)
  self
end

#extract_text ⇒ Object

Returns the value of the document as defined by XPath 1.0. This is the same as the value of the root element, which is the complete PCDATA content of the root element, without any tags, comments, or processing instructions after all entity and character references have been resolved.



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

def extract_text
  @doc.get_value
end

#nil? ⇒ Boolean

See Jim Weirich’s comment on builder (plus all the test frameworks seem to call nil? on objects being tested

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/excemel/excemel.rb', line 159

def nil?
  false
end

#processing_instruction!(target, data) ⇒ Object

Appends a processing instruction at the current position in the document



96
97
98
99
100
 
# File 'lib/excemel/excemel.rb', line 96

def processing_instruction!(target, data)
  pi = XOM::ProcessingInstruction.new(target, data)
  @target.append_child(pi)
  self
end

#query(xpath_query) ⇒ Object

Returns the values of the nodes selected by the XPath expression in the context of this node in document order as defined by XSLT. This XPath expression must not contain any namespace prefixes.



150
151
152
153
154
155
 
# File 'lib/excemel/excemel.rb', line 150

def query(xpath_query)
  nodes = @doc.query xpath_query      
  result = Array.new
  (0..nodes.size-1).each do |i| result << nodes.get(i).get_value end
  result
end

#tag!(sym, *args, &block) ⇒ Object

Create a tag named sym. Other than the first argument which is the tag name, the arguments are the same as the tags implemented via method_missing. XOM will throw an exception if you pass something with a prefix but no associated namespace



122
123
124
125
 
# File 'lib/excemel/excemel.rb', line 122

def tag!(sym, *args, &block)
  method_missing(sym.to_sym, *args, &block)
  self
end

#target!(xpath_query) ⇒ Object

Attempts to reposition the document pointer based on the first match of and XQuery expression. Return true is the pointer was successfully moved and false otherwise



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/excemel/excemel.rb', line 105

def target!(xpath_query)
  nodes = @doc.query xpath_query
  (0..nodes.size-1).each do |i| 
    node = nodes.get(i)
    if node.class == XOM::Element
      @target = node
      return true
    end        
  end
  return false
end

#text!(string) ⇒ Object

Appends a text node at the current position in the document



89
90
91
92
93
 
# File 'lib/excemel/excemel.rb', line 89

def text!(string)
  text = XOM::Text.new string
  @target.append_child(text)
  self
end

#to_canonical_form ⇒ Object

Returns XML in the format specified by the Canonica XML Version 1.0 (w3.org/TR/2001/REC-xml-c14n-20010315 or Exclusive XML) Canonicalization Version 1.0 (w3.org/TR/2002/REC-xml-exc-c14n-20020718/)



174
175
176
177
178
179
 
# File 'lib/excemel/excemel.rb', line 174

def to_canonical_form
  baos = Lang::ByteArrayOutputStream.new
  outputter = XOM::Canonicalizer.new baos
  outputter.write(@doc)
  baos.to_string
end

#to_pretty_xml(indent = 2, line_length = 0, encoding = 'utf-8', preserve_base_uri = true) ⇒ Object

Returns a pretty-formatted document with the given indent, max line length and encoding. The preserve_base_uri determines whether preserves the original base URIs by inserting extra xml:base attributes.



130
131
132
133
134
135
136
137
 
# File 'lib/excemel/excemel.rb', line 130

def to_pretty_xml(indent=2, line_length=0, encoding='utf-8', preserve_base_uri=true)
  baos = Lang::ByteArrayOutputStream.new      
  serializer = XOM::Serializer.new(baos, encoding)
  serializer.indent = indent 
  serializer.max_length = line_length
  serializer.write @doc 
  baos.to_string
end

#to_xml ⇒ Object

Returns the XML document as a single line, e.g. no formatting



77
78
79
 
# File 'lib/excemel/excemel.rb', line 77

def to_xml
  @doc.to_xml
end