Module: OM::XML::Document

Extended by:

ActiveSupport::Concern

Defined in:

lib/om/xml/document.rb

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary (collapse)

• - (Object) ox_namespaces

  Returns a hash combining the current documents namespaces (provided by nokogiri) and any namespaces that have been set up by your Terminology.

Instance Method Summary (collapse)

• - (Object) add_child_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and add it as a child of target_node, where target_node is one of:

  • a Nokogiri::XML::Node

  • a single-element Nokogiri::XML::NodeSet

  • a term_pointer array resolving to a single-element Nokogiri::XML::NodeSet

  Additional arguments will be passed to the template unaltered.

• - (Object) add_next_sibling_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and insert it as the following sibling of target_node.

• - (Object) add_previous_sibling_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and insert it as the preceding sibling of target_node.

• - (Object) after_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and insert it as the following sibling of target_node.

• - (Object) before_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and insert it as the preceding sibling of target_node.

• - (Object) find_by_terms(*term_pointer)

  term_pointer Variable length array of values in format [:accessor_name, :accessor_name …] or [:accessor_name=>index, :accessor_name …] @example:.

• - (Object) find_by_terms_and_value(*term_pointer)

  Applies the property's corresponding xpath query, returning the result Nokogiri::XML::NodeSet.

• - (Object) find_by_xpath(xpath)
• - (Object) method_missing(method_name, *args)
• - (Boolean) ng_xml_changed?
• - (Object) ng_xml_will_change!
• - (Boolean) node_exists?(*term_pointer)

  Test whether the document has a node corresponding to the given term_pointer.

• - (Object) replace_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and replace target_node with it.

• - (Object) swap_node(target_node, node_type, *args, &block)

  Instantiate a node_type template and replace target_node with it.

• - (Object) template(node_type, *args)
• - (Object) template_registry

  Access the class's template registry.

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# File 'lib/om/xml/document.rb', line 80

def method_missing(method_name, *args)
  if matches = /([^=]+)=$/.match(method_name.to_s)
    name = matches[1].to_sym
  end
  
  name ||= method_name
  
  begin
    term = self.class.terminology.retrieve_term(name)
    
    if /=$/.match(method_name.to_s)
      node = OM::XML::DynamicNode.new(name, nil, self, term)
      return node.val=args
    else
      return OM::XML::DynamicNode.new(name, args.first, self, term)
    end
  rescue OM::XML::Terminology::BadPointerError
    super
  end
end

61
62
63

# File 'lib/om/xml/document.rb', line 61

def ox_namespaces
  @ox_namespaces
end

148
149
150

# File 'lib/om/xml/document.rb', line 148

def add_child_node(target_node, node_type, *args, &block)
  manipulate_node(:add_child, target_node, node_type, *args, &block)
end

154
155
156

# File 'lib/om/xml/document.rb', line 154

def add_next_sibling_node(target_node, node_type, *args, &block)
  manipulate_node(:add_next_sibling, target_node, node_type, *args, &block)
end

160
161
162

# File 'lib/om/xml/document.rb', line 160

def add_previous_sibling_node(target_node, node_type, *args, &block)
  manipulate_node(:add_previous_sibling, target_node, node_type, *args, &block)
end

166
167
168

# File 'lib/om/xml/document.rb', line 166

def after_node(target_node, node_type, *args, &block)
  manipulate_node(:after, target_node, node_type, *args, &block)
end

172
173
174

# File 'lib/om/xml/document.rb', line 172

def before_node(target_node, node_type, *args, &block)
  manipulate_node(:before, target_node, node_type, *args, &block)
end

find_by_terms( {:person => 1}, :first_name )

find_by_terms( [:person, 1, :first_name] )

find_by_terms('//oxns:name[@type="personal"][contains(oxns:role, "donor")]')

121
122
123
124

# File 'lib/om/xml/document.rb', line 121

def find_by_terms(*term_pointer)
  xpath = self.class.terminology.xpath_with_indexes(*term_pointer)
  find_by_xpath(xpath) unless xpath.nil?
end

107
108
109
110

# File 'lib/om/xml/document.rb', line 107

def find_by_terms_and_value(*term_pointer)
  xpath = self.class.terminology.xpath_for(*term_pointer)
  find_by_xpath(xpath) unless xpath.nil?
end

102
103
104

# File 'lib/om/xml/document.rb', line 102

def find_by_xpath(xpath)
  ng_xml.xpath(xpath, ox_namespaces)
end

76
77
78

# File 'lib/om/xml/document.rb', line 76

def ng_xml_changed?
  changed.include?('ng_xml')
end

71
72
73
74

# File 'lib/om/xml/document.rb', line 71

def ng_xml_will_change!
  # throw away older version.
  changed_attributes['ng_xml'] = nil
end

128
129
130

# File 'lib/om/xml/document.rb', line 128

def node_exists?(*term_pointer)
  !find_by_terms(*term_pointer).empty?
end

178
179
180

# File 'lib/om/xml/document.rb', line 178

def replace_node(target_node, node_type, *args, &block)
  manipulate_node(:replace, target_node, node_type, *args, &block)
end

184
185
186

# File 'lib/om/xml/document.rb', line 184

def swap_node(target_node, node_type, *args, &block)
  manipulate_node(:swap, target_node, node_type, *args, &block)
end

137
138
139

# File 'lib/om/xml/document.rb', line 137

def template(node_type, *args)
  template_registry.instantiate(node_type, *args)
end

133
134
135

# File 'lib/om/xml/document.rb', line 133

def template_registry
  self.class.template_registry
end