Module: Seabright::ViewCaching::ClassMethods

Defined in:
lib/redis_object/ext/view_caching.rb

Instance Method Summary collapse

Instance Method Details

#cache_invalidation_hooks ⇒ Object 



199
200
201
 
# File 'lib/redis_object/ext/view_caching.rb', line 199

def cache_invalidation_hooks
	@cache_invalidation_hooks ||= []
end

#cache_named_views! ⇒ Object 



245
246
247
248
249
 
# File 'lib/redis_object/ext/view_caching.rb', line 245

def cache_named_views!
	named_views.each do |name,view|
		cache_view name
	end
end

#cache_view(name, opts = true) ⇒ Object Also known as: cache_named_view 



35
36
37
38
39
 
# File 'lib/redis_object/ext/view_caching.rb', line 35

def cache_view(name,opts=true)
	cached_views[name.to_sym] = opts
	intercept_views_for_caching!
	set_up_invalidation!
end

#cached_views ⇒ Object 



241
242
243
 
# File 'lib/redis_object/ext/view_caching.rb', line 241

def cached_views
	@cached_view ||= {}
end

#downstream_invalidations ⇒ Object 



225
226
227
 
# File 'lib/redis_object/ext/view_caching.rb', line 225

def downstream_invalidations
	@downstream_invalidations ||= []
end

#intercept_views_for_caching! ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/redis_object/ext/view_caching.rb', line 42

def intercept_views_for_caching!
	return if @cached_views_intercepted
	self.class_eval do
		
		alias_method :uncached_view_as_hash, :view_as_hash unless method_defined?(:uncached_view_as_hash)
		def view_as_hash(name)
			return uncached_view_as_hash(name) unless self.class.view_should_be_cached?(name)
			if v = view_from_cache(name)
				puts "  Got view from cache: #{name}" if DEBUG
				Yajl::Parser.parse(v)
			else
				puts "  View cache miss: #{name}" if DEBUG
				cache_view_content(name)[0]
			end
		end
		
		alias_method :uncached_view_as_json, :view_as_json unless method_defined?(:uncached_view_as_json)
		def view_as_json(name)
			return uncached_view_as_json(name) unless self.class.view_should_be_cached?(name)
			if v = view_from_cache(name)
				puts "  Got view from cache: #{name}" if DEBUG
				v
			else
				puts "  View cache miss: #{name}" if DEBUG
				cache_view_content(name)[1]
			end
		end
		
		def cache_view_content(name,content=nil)
			content ||= uncached_view_as_hash(name)
			json = Yajl::Encoder.encode(content)
			store.hset(cached_view_key,name,json)
			[content,json]
		end
		
		def view_from_cache(name)
			if v = store.hget(cached_view_key,name)
				v
			else
				nil
			end
		end
		
		def view_is_cached?(name)
			store.hexists(cached_view_key, name)
		end
		
		def cached_view_key
			"#{hkey}::ViewCache"
		end
		
		def regenerate_cached_views(*names)
			names.each do |name|
				cache_view_content name
			end
		end
		
		def regenerate_cached_views!
			regenerate_cached_views(*self.class.cached_views.map {|name,opts| name })
		end
		
	end
	@cached_views_intercepted = true
end

#invalidate_caches_from_upstream_updates! ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/redis_object/ext/view_caching.rb', line 185

def invalidate_caches_from_upstream_updates!
	self.class_eval do
		
		def invalidated_by(obj,chain)
			invalidate_cached_views!
		end
		
	end
end

#invalidate_downstream(*args) ⇒ Object

def invalidate_everything_upstream! @invalidate_everything_upstream = true end

def invalidate_everything_upstream? @invalidate_everything_upstream end



220
221
222
223
 
# File 'lib/redis_object/ext/view_caching.rb', line 220

def invalidate_downstream(*args)
	@downstream_invalidations = (@downstream_invalidations || []) + args
	set_up_invalidation!
end

#invalidate_upstream(*args) ⇒ Object 



203
204
205
206
 
# File 'lib/redis_object/ext/view_caching.rb', line 203

def invalidate_upstream(*args)
	@upstream_invalidations = (@upstream_invalidations || []) + args
	set_up_invalidation!
end

#on_cache_invalidation(&block) ⇒ Object 



195
196
197
 
# File 'lib/redis_object/ext/view_caching.rb', line 195

def on_cache_invalidation(&block)
	cache_invalidation_hooks << block
end

#set_up_invalidation! ⇒ Object 



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/redis_object/ext/view_caching.rb', line 107

def set_up_invalidation!
	return if @invalidation_set_up
	self.class_eval do
		
		def invalidate_cached_views(*names)
			puts "Invalidating cached views: #{names.join(", ")}" if Debug.verbose?
			run_script(:CachedViewInvalidator, [cached_view_key], names, CachedViewInvalidator)
			self.class.cache_invalidation_hooks do |hook|
				hook.call(names)
			end
		end
		alias_method :invalidate_cached_view, :invalidate_cached_views
		
		def invalidate_cached_views!
			invalidate_cached_views(*self.class.cached_views.map {|name,opts| name })
		end
		
		def invalidate_downstream!
			return unless self.class.downstream_invalidations && (self.class.downstream_invalidations.size > 0)
			puts "Invalidating downstream: #{self.class.downstream_invalidations.inspect}" if Debug.verbose?
			self.class.downstream_invalidations.each do |col|
				if has_collection?(col) && (colctn = get_collection(col))
					colctn.each do |obj|
						obj.invalidated_by_other(self,invalidation_chain + [self.hkey])
					end
				end
			end
		end
		
		def invalidate_upstream!
			return unless self.class.upstream_invalidations && (self.class.upstream_invalidations.size > 0)
			puts "Invalidating upstream: #{self.class.upstream_invalidations.inspect}" if Debug.verbose?
			backreferences.each do |obj|
				next unless self.class.upstream_invalidations.include?(obj.class.name.split("::").last.to_sym) #|| self.class.invalidate_everything_upstream?
				obj.invalidated_by_other(self,invalidation_chain + [self.hkey]) if obj.respond_to?(:invalidated_by_other)
			end
		end
		
		def invalidated_by_update!(*args)
			Thread.new do
				invalidate_cached_views!
				invalidate_up_and_down!
			end
		end
		
		def invalidated_by_reference!(*args)
			invalidated_by_update!
		end
		
		def invalidation_chain
			@invalidation_chain ||= []
		end
		
		def invalidate_up_and_down!
			unless invalidation_chain.include?(self)
				invalidate_downstream!
				invalidate_upstream!
			end
		end
		
		def invalidated_by_other(obj,chain)
			unless chain.include?(self.hkey)
				puts "#{self.class.name}:#{self.id}'s view caches were invalidated by upstream object: #{obj.class.name}:#{obj.id} (chain:#{chain.inspect})" if Debug.verbose?
				@invalidation_chain = chain
				[:invalidated_by,"invalidated_by_#{obj.class.name.underscore}".to_sym].each do |meth_sym|
					send(meth_sym,obj,chain) if respond_to?(meth_sym)
				end
				invalidate_up_and_down!
			end
		end
		
		trigger_on_update :invalidated_by_update!
		trigger_on_reference :invalidated_by_reference!
		
	end
	@invalidation_set_up = true
end

#upstream_invalidations ⇒ Object 



208
209
210
 
# File 'lib/redis_object/ext/view_caching.rb', line 208

def upstream_invalidations
	@upstream_invalidations ||= []
end

#view_should_be_cached?(name) ⇒ Boolean

def invalidate_everything_downstream! @invalidate_everything_downstream = true end

def invalidate_everything_downstream? @invalidate_everything_downstream end

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/redis_object/ext/view_caching.rb', line 237

def view_should_be_cached?(name)
	!!cached_views[name.to_sym]
end