Class: Neo4j::ActiveNode::HasN::AssociationProxy

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Enumerable
Defined in:
lib/neo4j/active_node/has_n.rb

Overview

Return this object from associations It uses a QueryProxy to get results But also caches results and can have results cached on it

Constant Summary collapse

QUERY_PROXY_METHODS =
[:<<, :delete, :create, :pluck, :where, :where_not, :rel_where, :rel_order, :order, :skip, :limit]
CACHED_RESULT_METHODS =
[]

Instance Method Summary collapse

Constructor Details

#initialize(query_proxy, deferred_objects = [], result_cache_proc = nil) ⇒ AssociationProxy

Returns a new instance of AssociationProxy.


11
12
13
14
15
16
17
18
19
20
21
# File 'lib/neo4j/active_node/has_n.rb', line 11

def initialize(query_proxy, deferred_objects = [], result_cache_proc = nil)
  @query_proxy = query_proxy
  @deferred_objects = deferred_objects

  @result_cache_proc = result_cache_proc

  # Represents the thing which can be enumerated
  # default to @query_proxy, but will be set to
  # @cached_result if that is set
  @enumerable = @query_proxy
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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


150
151
152
153
154
155
156
157
158
# File 'lib/neo4j/active_node/has_n.rb', line 150

def method_missing(method_name, *args, &block)
  target = target_for_missing_method(method_name)
  super if target.nil?

  cache_query_proxy_result if !cached? && !target.is_a?(Neo4j::ActiveNode::Query::QueryProxy)
  clear_cache_result if target.is_a?(Neo4j::ActiveNode::Query::QueryProxy)

  target.public_send(method_name, *args, &block)
end

Instance Method Details

#+(other) ⇒ Object


64
65
66
# File 'lib/neo4j/active_node/has_n.rb', line 64

def +(other)
  self.to_a + other
end

#==(other) ⇒ Object


60
61
62
# File 'lib/neo4j/active_node/has_n.rb', line 60

def ==(other)
  self.to_a == other.to_a
end

#add_to_cache(object, rel = nil) ⇒ Object


104
105
106
107
# File 'lib/neo4j/active_node/has_n.rb', line 104

def add_to_cache(object, rel = nil)
  @cached_rels << rel if rel
  (@cached_result ||= []) << object
end

#cache_query_proxy_resultObject


113
114
115
# File 'lib/neo4j/active_node/has_n.rb', line 113

def cache_query_proxy_result
  (result_cache_proc_cache || @query_proxy).to_a.tap { |result| cache_result(result) }
end

#cache_result(result) ⇒ Object


94
95
96
97
# File 'lib/neo4j/active_node/has_n.rb', line 94

def cache_result(result)
  @cached_result = result
  @enumerable = (@cached_result || @query_proxy)
end

#cached?Boolean

Returns:


125
126
127
# File 'lib/neo4j/active_node/has_n.rb', line 125

def cached?
  !!@cached_result
end

#clear_cache_resultObject


121
122
123
# File 'lib/neo4j/active_node/has_n.rb', line 121

def clear_cache_result
  cache_result(nil)
end

#each(&block) ⇒ Object


37
38
39
# File 'lib/neo4j/active_node/has_n.rb', line 37

def each(&block)
  result_nodes.each(&block)
end

#each_rel(&block) ⇒ Object


41
42
43
# File 'lib/neo4j/active_node/has_n.rb', line 41

def each_rel(&block)
  rels.each(&block)
end

#empty?(*args) ⇒ Boolean

Returns:


56
57
58
# File 'lib/neo4j/active_node/has_n.rb', line 56

def empty?(*args)
  @deferred_objects.empty? && @enumerable.empty?(*args)
end

#init_cacheObject


99
100
101
102
# File 'lib/neo4j/active_node/has_n.rb', line 99

def init_cache
  @cached_rels ||= []
  @cached_result ||= []
end

#inspectObject

States: Default


25
26
27
28
# File 'lib/neo4j/active_node/has_n.rb', line 25

def inspect
  formatted_nodes = ::Neo4j::ActiveNode::NodeListFormatter.new(result_nodes)
  "#<AssociationProxy #{@query_proxy.context} #{formatted_nodes.inspect}>"
end

#lengthObject


48
49
50
# File 'lib/neo4j/active_node/has_n.rb', line 48

def length
  @deferred_objects.length + @enumerable.length
end

#relsObject


109
110
111
# File 'lib/neo4j/active_node/has_n.rb', line 109

def rels
  @cached_rels || super
end

#replace_with(*args) ⇒ Object


129
130
131
132
133
134
135
136
# File 'lib/neo4j/active_node/has_n.rb', line 129

def replace_with(*args)
  nodes = @query_proxy.replace_with(*args).to_a
  if @query_proxy.start_object.try(:new_record?)
    @cached_result = nil
  else
    cache_result(nodes)
  end
end

#resultObject


68
69
70
# File 'lib/neo4j/active_node/has_n.rb', line 68

def result
  (@deferred_objects || []) + result_without_deferred
end

#result_cache_proc_cacheObject


117
118
119
# File 'lib/neo4j/active_node/has_n.rb', line 117

def result_cache_proc_cache
  @result_cache_proc_cache ||= @result_cache_proc.call if @result_cache_proc
end

#result_idsObject


88
89
90
91
92
# File 'lib/neo4j/active_node/has_n.rb', line 88

def result_ids
  result.map do |object|
    object.is_a?(Neo4j::ActiveNode) ? object.id : object
  end
end

#result_nodesObject


78
79
80
81
82
# File 'lib/neo4j/active_node/has_n.rb', line 78

def result_nodes
  return result_objects if !@query_proxy.model

  map_results_as_nodes(result_objects)
end

#result_objectsObject


84
85
86
# File 'lib/neo4j/active_node/has_n.rb', line 84

def result_objects
  @deferred_objects + result_without_deferred
end

#result_without_deferredObject


72
73
74
75
76
# File 'lib/neo4j/active_node/has_n.rb', line 72

def result_without_deferred
  cache_query_proxy_result if !@cached_result

  @cached_result
end

#serializable_hash(options = {}) ⇒ Object


160
161
162
# File 'lib/neo4j/active_node/has_n.rb', line 160

def serializable_hash(options = {})
  to_a.map { |record| record.serializable_hash(options) }
end

#sizeObject


52
53
54
# File 'lib/neo4j/active_node/has_n.rb', line 52

def size
  @deferred_objects.size + @enumerable.size
end