cache_back 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +22 -0
- data/LICENSE +20 -0
- data/README.rdoc +17 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/lib/cache_back/cache.rb +20 -0
- data/lib/cache_back/configuration_mixin.rb +40 -0
- data/lib/cache_back/middleware.rb +13 -0
- data/lib/cache_back/read_mixin.rb +22 -0
- data/lib/cache_back/write_mixin.rb +27 -0
- data/lib/cache_back.rb +16 -0
- data/test/helper.rb +10 -0
- data/test/test_cache_back.rb +7 -0
- metadata +79 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Mick Staugaard
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
= cache_back
|
2
|
+
|
3
|
+
Description goes here.
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
|
13
|
+
* Send me a pull request. Bonus points for topic branches.
|
14
|
+
|
15
|
+
== Copyright
|
16
|
+
|
17
|
+
Copyright (c) 2009 Mick Staugaard. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "cache_back"
|
8
|
+
gem.summary = %Q{A write back caching layer on active record}
|
9
|
+
gem.description = %Q{A rewrite of cache money}
|
10
|
+
gem.email = "mick@staugaard.com"
|
11
|
+
gem.homepage = "http://github.com/staugaard/cache_back"
|
12
|
+
gem.authors = ["Mick Staugaard"]
|
13
|
+
gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'rake/testtask'
|
22
|
+
Rake::TestTask.new(:test) do |test|
|
23
|
+
test.libs << 'lib' << 'test'
|
24
|
+
test.pattern = 'test/**/test_*.rb'
|
25
|
+
test.verbose = true
|
26
|
+
end
|
27
|
+
|
28
|
+
begin
|
29
|
+
require 'rcov/rcovtask'
|
30
|
+
Rcov::RcovTask.new do |test|
|
31
|
+
test.libs << 'test'
|
32
|
+
test.pattern = 'test/**/test_*.rb'
|
33
|
+
test.verbose = true
|
34
|
+
end
|
35
|
+
rescue LoadError
|
36
|
+
task :rcov do
|
37
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
task :test => :check_dependencies
|
42
|
+
|
43
|
+
task :default => :test
|
44
|
+
|
45
|
+
require 'rake/rdoctask'
|
46
|
+
Rake::RDocTask.new do |rdoc|
|
47
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
48
|
+
|
49
|
+
rdoc.rdoc_dir = 'rdoc'
|
50
|
+
rdoc.title = "cache_back #{version}"
|
51
|
+
rdoc.rdoc_files.include('README*')
|
52
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
53
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.2.0
|
@@ -0,0 +1,20 @@
|
|
1
|
+
module CacheBack
|
2
|
+
class Cache
|
3
|
+
def initialize
|
4
|
+
reset!
|
5
|
+
end
|
6
|
+
|
7
|
+
def read(*args)
|
8
|
+
@local_cache[args[0]] ||= Rails.cache.read(*args)
|
9
|
+
end
|
10
|
+
|
11
|
+
def write(*args)
|
12
|
+
@local_cache[args[0]] = args[1]
|
13
|
+
Rails.cache.write(*args)
|
14
|
+
end
|
15
|
+
|
16
|
+
def reset!
|
17
|
+
@local_cache = {}
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
require 'activesupport'
|
2
|
+
|
3
|
+
module CacheBack
|
4
|
+
autoload :ReadMixin, 'cache_back/read_mixin'
|
5
|
+
autoload :WriteMixin, 'cache_back/write_mixin'
|
6
|
+
|
7
|
+
module ConfigurationMixin
|
8
|
+
def cache_back_version(version)
|
9
|
+
@cache_back_version = version.to_s
|
10
|
+
end
|
11
|
+
|
12
|
+
def inherited_cache_back_version
|
13
|
+
if self == ActiveRecord::Base
|
14
|
+
@cache_back_version
|
15
|
+
else
|
16
|
+
@cache_back_version ||= superclass.inherited_cache_back_version
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def inherited_cache_back_options
|
21
|
+
if self == ActiveRecord::Base
|
22
|
+
@cache_back_option
|
23
|
+
else
|
24
|
+
@cache_back_option ||= superclass.inherited_cache_back_options
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def cache_back_key_for(id)
|
29
|
+
"cache_back/#{name}/version_#{inherited_cache_back_version}/#{id}"
|
30
|
+
end
|
31
|
+
|
32
|
+
def has_cache_back(options = {})
|
33
|
+
@cache_back_version = options.delete(:version) || '1'
|
34
|
+
@cache_back_option = options
|
35
|
+
|
36
|
+
include WriteMixin unless instance_methods.include?('store_in_cache_back')
|
37
|
+
extend ReadMixin unless method_defined?(:find_one_with_cache_back!)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
module CacheBack
|
2
|
+
module ReadMixin
|
3
|
+
|
4
|
+
def self.extended(model_class)
|
5
|
+
class << model_class
|
6
|
+
alias_method_chain :find_one, :cache_back
|
7
|
+
end
|
8
|
+
end
|
9
|
+
|
10
|
+
def find_one_with_cache_back(id, options)
|
11
|
+
record = CacheBack.cache.read(cache_back_key_for(id))
|
12
|
+
|
13
|
+
unless record
|
14
|
+
record = find_one_without_cache_back(id, options)
|
15
|
+
record.store_in_cache_back if record
|
16
|
+
end
|
17
|
+
|
18
|
+
record
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
module CacheBack
|
2
|
+
module WriteMixin
|
3
|
+
def shallow_clone
|
4
|
+
clone = self.class.new
|
5
|
+
clone.instance_variable_set("@attributes", instance_variable_get(:@attributes))
|
6
|
+
clone.instance_variable_set("@new_record", new_record?)
|
7
|
+
clone
|
8
|
+
end
|
9
|
+
|
10
|
+
def cache_back_key
|
11
|
+
@cache_back_key ||= new_record? ? nil : self.class.cache_back_key_for(id)
|
12
|
+
end
|
13
|
+
|
14
|
+
def store_in_cache_back
|
15
|
+
CacheBack.cache.write(cache_back_key, shallow_clone, self.class.inherited_cache_back_options) if cache_back_key
|
16
|
+
end
|
17
|
+
|
18
|
+
def remove_from_cache_back
|
19
|
+
CacheBack.cache.delete(cache_back_key) if cache_back_key
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.included(model_class)
|
23
|
+
model_class.after_save :store_in_cache_back
|
24
|
+
model_class.after_destroy :remove_from_cache_back
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
data/lib/cache_back.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'activerecord'
|
3
|
+
|
4
|
+
require 'cache_back/configuration_mixin'
|
5
|
+
require 'cache_back/cache'
|
6
|
+
|
7
|
+
module CacheBack
|
8
|
+
module_function
|
9
|
+
|
10
|
+
def cache
|
11
|
+
Thread.current["cache_back_cache"] ||= Cache.new
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
ActiveRecord::Base.extend(CacheBack::ConfigurationMixin)
|
16
|
+
ActionController::Dispatcher.middleware.use(CacheBack::Middleware)
|
data/test/helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: cache_back
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Mick Staugaard
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2009-11-26 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: thoughtbot-shoulda
|
17
|
+
type: :development
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: "0"
|
24
|
+
version:
|
25
|
+
description: A rewrite of cache money
|
26
|
+
email: mick@staugaard.com
|
27
|
+
executables: []
|
28
|
+
|
29
|
+
extensions: []
|
30
|
+
|
31
|
+
extra_rdoc_files:
|
32
|
+
- LICENSE
|
33
|
+
- README.rdoc
|
34
|
+
files:
|
35
|
+
- .document
|
36
|
+
- .gitignore
|
37
|
+
- LICENSE
|
38
|
+
- README.rdoc
|
39
|
+
- Rakefile
|
40
|
+
- VERSION
|
41
|
+
- lib/cache_back.rb
|
42
|
+
- lib/cache_back/cache.rb
|
43
|
+
- lib/cache_back/configuration_mixin.rb
|
44
|
+
- lib/cache_back/middleware.rb
|
45
|
+
- lib/cache_back/read_mixin.rb
|
46
|
+
- lib/cache_back/write_mixin.rb
|
47
|
+
- test/helper.rb
|
48
|
+
- test/test_cache_back.rb
|
49
|
+
has_rdoc: true
|
50
|
+
homepage: http://github.com/staugaard/cache_back
|
51
|
+
licenses: []
|
52
|
+
|
53
|
+
post_install_message:
|
54
|
+
rdoc_options:
|
55
|
+
- --charset=UTF-8
|
56
|
+
require_paths:
|
57
|
+
- lib
|
58
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: "0"
|
63
|
+
version:
|
64
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: "0"
|
69
|
+
version:
|
70
|
+
requirements: []
|
71
|
+
|
72
|
+
rubyforge_project:
|
73
|
+
rubygems_version: 1.3.5
|
74
|
+
signing_key:
|
75
|
+
specification_version: 3
|
76
|
+
summary: A write back caching layer on active record
|
77
|
+
test_files:
|
78
|
+
- test/helper.rb
|
79
|
+
- test/test_cache_back.rb
|