module ConDuxml

Attributes

src_doc[R]

src_ns[R]

Public Instance Methods

instantiate(doc_or_node, opts={}) click to toggle source

instantiation takes a static design file and constructs a dynamic model by identifying certain keyword elements, executing their method on child nodes, then removing the interpolating keyword element. these are:

<instance> - when it contains design elements, it is removed but its reference ID is given to all children creating an XML-invisible arbitrary grouping

when it references an XML file, ID or path to an XML element, the target is copied and inserted in place of this element

@param doc_or_node [String, Doc, Element] XML document or path to one or XMl Element @return [Doc] resulting XML document

# File lib/con_duxml.rb, line 42
def instantiate(doc_or_node, opts={})
  if doc_or_node.is_a?(Element)
    new_node = doc_or_node.stub
    new_children = doc_or_node.nodes.collect do |src_node|
      if src_node.respond_to?(:nodes)
        src_node.activate.collect do |inst|
          inst.name.match(/con_duxml:/) ? instantiate(src_node) : instantiate(inst)
        end
      else
        src_node.clone
      end
    end.flatten
    if new_children.any?
      new_node << new_children
    end
    new_node
  else
    @src_doc = get_doc doc_or_node
    instance = instantiate(src_doc.root)
    @doc = Doc.new << instance
  end
end

transform(transforms, doc_or_path, opts={}) click to toggle source

@param transforms [String, Doc] transforms file or path to one @param doc_or_path [String, Doc] XML document or path to one that will provide content to be transformed @param opts [Hash] more to come TODO

:strict => [boolean] # true by default, throws errors when transform results violate given grammar; if false,
                     # saves error to doc.history and resumes transform

@return [Doc] result of transform; automatically saved to @doc

# File lib/con_duxml.rb, line 19
def transform(transforms, doc_or_path, opts={})
  @doc = Doc.new
  transforms = get_doc(transforms).root
  @src_doc = get_doc doc_or_path
  @src_ns = transforms[:src_ns]
  src_node = src_doc.locate(add_name_space_prefix(transforms[:source])).first
  doc.grammar = transforms[:grammar] if transforms[:grammar]
  doc.history.strict?(false) if opts[:strict].is_a?(FalseClass)
  add_observer doc.history
  @doc << activate(transforms.first, src_node).first
end

Private Instance Methods

get_doc(doc_or_path) click to toggle source

# File lib/con_duxml.rb, line 66
def get_doc(doc_or_path)
  case doc_or_path
    when Doc then doc_or_path
    when String then sax doc_or_path
    when Element then doc_or_path
    else
  end
end