redis_cache 0.0.1

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.
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "http://rubygems.org"
2
+ gem "redis"
3
+ gem "activesupport"
4
+
5
+
6
+
7
+
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2010 Matthew Jording
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.
@@ -0,0 +1,17 @@
1
+ = redis_cache
2
+
3
+ simple activesupport cache implementation in redis.
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) 2010 Matthew Jording. See LICENSE for details.
@@ -0,0 +1,45 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "redis_cache"
8
+ gem.summary = %Q{redis activesupport cache}
9
+ gem.description = %Q{simple activesupport cache implementation in redis}
10
+ gem.email = "mjording@opengotham.com"
11
+ gem.homepage = "http://github.com/opengotham/redis_cache"
12
+ gem.authors = ["Matthew Jording"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
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 'spec/rake/spectask'
22
+ Spec::Rake::SpecTask.new(:spec) do |spec|
23
+ spec.libs << 'lib' << 'spec'
24
+ spec.spec_files = FileList['spec/**/*_spec.rb']
25
+ end
26
+
27
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
28
+ spec.libs << 'lib' << 'spec'
29
+ spec.pattern = 'spec/**/*_spec.rb'
30
+ spec.rcov = true
31
+ end
32
+
33
+ task :spec => :check_dependencies
34
+
35
+ task :default => :spec
36
+
37
+ require 'rake/rdoctask'
38
+ Rake::RDocTask.new do |rdoc|
39
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
40
+
41
+ rdoc.rdoc_dir = 'rdoc'
42
+ rdoc.title = "redis_cache #{version}"
43
+ rdoc.rdoc_files.include('README*')
44
+ rdoc.rdoc_files.include('lib/**/*.rb')
45
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,125 @@
1
+ require 'redis'
2
+ require 'activesupport'
3
+ module ActiveSupport
4
+ module Cache
5
+ # A cache store implementation which stores data in Redis:
6
+ #
7
+ # This is currently the most popular cache store for production websites.
8
+ #
9
+ # Special features:
10
+ # - Clustering and load balancing. One can specify multiple redis servers,
11
+ # and RedisStore will load balance between all available servers. If a
12
+ # server goes down, then RedisStore will ignore it until it goes back
13
+ # online.
14
+ # - Time-based expiry support. See #write and the +:expires_in+ option.
15
+ # - Per-request in memory cache for all communication with the Redis server(s).
16
+ class RedisCache < Store
17
+
18
+ def self.build_redis_cache(*addresses)
19
+ addresses = addresses.flatten
20
+ options = addresses.extract_options!
21
+ addresses = ["localhost"] if addresses.empty?
22
+
23
+ #Redis.connect(address, options)
24
+ end
25
+
26
+ # Creates a new RedisCache object, with the given redis server
27
+ # addresses. Each address is either a host name, or a host-with-port string
28
+ # in the form of "redis://host_name:port". For example:
29
+ #
30
+ # ActiveSupport::Cache::RedisCache.new("localhost", "server-downstairs.localnetwork:8229")
31
+ #
32
+ # If no addresses are specified, then MemCacheStore will connect to
33
+ # localhost port 11211 (the default memcached port).
34
+ #
35
+ # Instead of addresses one can pass in a MemCache-like object. For example:
36
+ #
37
+ # require 'redis' # gem install redis;
38
+ # ActiveSupport::Cache::RedisCache.new(Redis.connect(:url => "redis://localhost:6380/1"))
39
+ def initialize(*addresses)
40
+ if addresses.empty?
41
+ @data = Redis.connect
42
+ elsif addresses.size == 1
43
+ @data = Redis.connect :url => "redis://#{addresses.first}"
44
+ else
45
+ @data = self.class.build_redis_cache(*addresses)
46
+ end
47
+
48
+ extend Strategy::LocalCache
49
+ end
50
+
51
+ # Reads multiple keys from the cache.
52
+ def read_multi(*keys)
53
+ @data.mget(*keys).map{|a| Marshal.load(a) }
54
+ end
55
+
56
+ def read(key, options = nil) # :nodoc:
57
+ super
58
+ result = @data.get(key)
59
+ result = Marshal.load result if unmarshal?(result, options)
60
+ end
61
+
62
+ # Writes a value to the cache.
63
+ #
64
+ # Possible options:
65
+ # - +:unless_exist+ - set to true if you don't want to update the cache
66
+ # if the key is already set.
67
+ # - +:expires_in+ - the number of seconds that this value may stay in
68
+ # the cache. See ActiveSupport::Cache::Store#write for an example.
69
+ def write(key, value, options = nil)
70
+ super
71
+ val = raw?(options) ? value : Marshal.dump(value)
72
+ @data.set(key, val)
73
+ end
74
+
75
+ def delete(key, options = nil) # :nodoc:
76
+ super
77
+ response = @data.del(key)
78
+ end
79
+
80
+ def exist?(key, options = nil) # :nodoc:
81
+ @data.exists(key)
82
+ end
83
+
84
+ def increment(key, amount = 1) # :nodoc:
85
+ log("incrementing", key, amount)
86
+ @data.incr(key, amount)
87
+ end
88
+
89
+ def decrement(key, amount = 1) # :nodoc:
90
+ log("decrement", key, amount)
91
+ @data.decr(key, amount)
92
+ end
93
+
94
+ def delete_matched(matcher, options = nil) # :nodoc:
95
+ super
96
+ t = @data.keys(matcher)
97
+ @data.del(*t)
98
+ @data.keys(matcher).empty?
99
+ end
100
+
101
+ def clear
102
+ @data.flush_all
103
+ end
104
+
105
+ def stats
106
+ @data.stats
107
+ end
108
+ private
109
+ def unmarshal?(result, options)
110
+ result && result.size > 0 && !raw?(options)
111
+ end
112
+
113
+ def raw?(options)
114
+ options && options[:raw]
115
+ end
116
+
117
+ def expires_in(options)
118
+ if options
119
+ # Rack::Session Merb Rails/Sinatra
120
+ options[:expire_after] || options[:expires_in] || options[:expire_in]
121
+ end
122
+ end
123
+ end
124
+ end
125
+ end
@@ -0,0 +1,21 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "RedisCache" do
4
+ before(:each) do
5
+ @rcache = ActiveSupport::Cache::RedisCache.new
6
+ @rabbit = OpenStruct.new :name => "bunny"
7
+ @white_rabbit = OpenStruct.new :color => "white"
8
+ @rcache.write "rabbit", @rabbit
9
+ @rcache.delete "counter"
10
+ @rcache.delete "rub-a-dub"
11
+
12
+ end
13
+ it "should read the data" do
14
+ @rcache.read("rabbit").should === @rabbit
15
+ end
16
+
17
+ it "should write the data" do
18
+ @rcache.write "rabbit", @white_rabbit
19
+ @rcache.read("rabbit").should === @white_rabbit
20
+ end
21
+ end
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,13 @@
1
+
2
+ require 'rubygems'
3
+ require 'redis'
4
+ require 'activesupport'
5
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
6
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
7
+ require 'redis_cache'
8
+ require 'spec'
9
+ require 'spec/autorun'
10
+
11
+ Spec::Runner.configure do |config|
12
+
13
+ end
metadata ADDED
@@ -0,0 +1,87 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: redis_cache
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 0
8
+ - 1
9
+ version: 0.0.1
10
+ platform: ruby
11
+ authors:
12
+ - Matthew Jording
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-05-06 00:00:00 -04:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: rspec
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 1
29
+ - 2
30
+ - 9
31
+ version: 1.2.9
32
+ type: :development
33
+ version_requirements: *id001
34
+ description: simple activesupport cache implementation in redis
35
+ email: mjording@opengotham.com
36
+ executables: []
37
+
38
+ extensions: []
39
+
40
+ extra_rdoc_files:
41
+ - LICENSE
42
+ - README.rdoc
43
+ files:
44
+ - .document
45
+ - .gitignore
46
+ - Gemfile
47
+ - LICENSE
48
+ - README.rdoc
49
+ - Rakefile
50
+ - VERSION
51
+ - lib/redis_cache.rb
52
+ - spec/redis_cache_spec.rb
53
+ - spec/spec.opts
54
+ - spec/spec_helper.rb
55
+ has_rdoc: true
56
+ homepage: http://github.com/opengotham/redis_cache
57
+ licenses: []
58
+
59
+ post_install_message:
60
+ rdoc_options:
61
+ - --charset=UTF-8
62
+ require_paths:
63
+ - lib
64
+ required_ruby_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ segments:
69
+ - 0
70
+ version: "0"
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ segments:
76
+ - 0
77
+ version: "0"
78
+ requirements: []
79
+
80
+ rubyforge_project:
81
+ rubygems_version: 1.3.6
82
+ signing_key:
83
+ specification_version: 3
84
+ summary: redis activesupport cache
85
+ test_files:
86
+ - spec/redis_cache_spec.rb
87
+ - spec/spec_helper.rb