Module: HappyMapper::ClassMethods

Defined in:
lib/happymapper.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) after_parse(&block)



48
49
50
# File 'lib/happymapper.rb', line 48

def after_parse(&block)
  after_parse_callbacks.push(block)
end

- (Object) after_parse_callbacks



44
45
46
# File 'lib/happymapper.rb', line 44

def after_parse_callbacks
  @after_parse_callbacks ||= []
end

- (Object) attribute(name, type, options = {})



21
22
23
24
25
26
# File 'lib/happymapper.rb', line 21

def attribute(name, type, options={})
  attribute = Attribute.new(name, type, options)
  @attributes[to_s] ||= []
  @attributes[to_s] << attribute
  attr_accessor attribute.method_name.intern
end

- (Object) attributes



28
29
30
# File 'lib/happymapper.rb', line 28

def attributes
  @attributes[to_s] || []
end

- (Object) content(name)



39
40
41
42
# File 'lib/happymapper.rb', line 39

def content(name)
  @content = name
  attr_accessor name
end

- (Object) element(name, type, options = {})



32
33
34
35
36
37
# File 'lib/happymapper.rb', line 32

def element(name, type, options={})
  element = Element.new(name, type, options)
  @elements[to_s] ||= []
  @elements[to_s] << element
  attr_accessor element.method_name.intern
end

- (Object) elements



52
53
54
# File 'lib/happymapper.rb', line 52

def elements
  @elements[to_s] || []
end

- (Object) has_many(name, type, options = {})



60
61
62
# File 'lib/happymapper.rb', line 60

def has_many(name, type, options={})
  element name, type, {:single => false}.merge(options)
end

- (Object) has_one(name, type, options = {})



56
57
58
# File 'lib/happymapper.rb', line 56

def has_one(name, type, options={})
  element name, type, {:single => true}.merge(options)
end

- (Object) namespace(namespace = nil)

Specify a namespace if a node and all its children are all namespaced elements. This is simpler than passing the :namespace option to each defined element.



67
68
69
70
# File 'lib/happymapper.rb', line 67

def namespace(namespace = nil)
  @namespace = namespace if namespace
  @namespace
end

- (Object) parse(xml, options = {})



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/happymapper.rb', line 84

def parse(xml, options = {})
  if xml.is_a?(XML::Node)
    node = xml
  else
    if xml.is_a?(XML::Document)
      node = xml.root
    else
      node = XML::Parser.string(xml).parse.root
    end

    root = node.name == tag_name
  end

  namespace = @namespace || (node.namespaces && node.namespaces.default)
  namespace = "#{DEFAULT_NS}:#{namespace}" if namespace

  unless xpath = options[:xpath]
    xpath = root ? '/' : './/'
    xpath += "#{DEFAULT_NS}:" if namespace
    xpath += tag_name
  end

  nodes = node.find(xpath, Array(namespace))
  collection = nodes.collect do |n|
    obj = new

    attributes.each do |attr|
      obj.send("#{attr.method_name}=",
      attr.from_xml_node(n, namespace))
    end

    elements.each do |elem|
      obj.send("#{elem.method_name}=",
      elem.from_xml_node(n, namespace))
    end

    obj.send("#{@content}=", n.content) if @content

    obj.class.after_parse_callbacks.each { |callback| callback.call(obj) }

    obj
  end

  # per http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Document.html#M000354
  nodes = nil

  if options[:single] || root
    collection.first
  else
    collection
  end
end

- (Object) register_namespace(namespace, ns)



72
73
74
# File 'lib/happymapper.rb', line 72

def register_namespace(namespace, ns)
  @registered_namespaces.merge!(namespace => ns)
end

- (Object) tag(new_tag_name)



76
77
78
# File 'lib/happymapper.rb', line 76

def tag(new_tag_name)
  @tag_name = new_tag_name.to_s
end

- (Object) tag_name



80
81
82
# File 'lib/happymapper.rb', line 80

def tag_name
  @tag_name ||= to_s.split('::')[-1].downcase
end