redis-store 0.3.9 → 1.0.0.beta1

data/spec/config/slave.conf

@@ -1,24 +1,56 @@
 # Redis configuration file example
 
+# Note on units: when memory size is needed, it is possible to specifiy
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
 # By default Redis does not run as a daemon. Use 'yes' if you need it.
 # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
 daemonize no
 
-# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
-# You can specify a custom pid file location here.
+# When running daemonized, Redis writes a pid file in /var/run/redis.pid by
+# default. You can specify a custom pid file location here.
 pidfile /var/run/redis.pid
 
 # Accept connections on the specified port, default is 6379
 port 6381
 
 # If you want you can bind a single interface, if the bind option is not
-# specified all the interfaces will listen for connections.
+# specified all the interfaces will listen for incoming connections.
 #
 # bind 127.0.0.1
 
 # Close the connection after a client is idle for N seconds (0 to disable)
 timeout 300
 
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################ SNAPSHOTTING  #################################
+#
 # Save the DB on disk:
 #
 #   save <seconds> <changes>
@@ -30,42 +62,47 @@ timeout 300
 #   after 900 sec (15 min) if at least 1 key changed
 #   after 300 sec (5 min) if at least 10 keys changed
 #   after 60 sec if at least 10000 keys changed
+#
+#   Note: you can disable saving at all commenting all the "save" lines.
+
 save 900 1
 save 300 10
 save 60 10000
 
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
 # The filename where to dump the DB
 dbfilename slave-dump.rdb
 
-# For default save/load DB in/from the working directory
-# Note that you must specify a directory not a file name.
+# The working directory.
+#
+# The DB will be written inside this directory, with the filename specified
+# above using the 'dbfilename' configuration directive.
+# 
+# Also the Append Only File will be created inside this directory.
+# 
+# Note that you must specify a directory here, not a file name.
 dir ./
 
-# Set server verbosity to 'debug'
-# it can be one of:
-# debug (a lot of information, useful for development/testing)
-# notice (moderately verbose, what you want in production probably)
-# warning (only very important / critical messages are logged)
-loglevel debug
-
-# Specify the log file name. Also 'stdout' can be used to force
-# the demon to log on the standard output. Note that if you use standard
-# output for logging but daemonize, logs will be sent to /dev/null
-logfile stdout
-
-# Set the number of databases. The default database is DB 0, you can select
-# a different one on a per-connection basis using SELECT <dbid> where
-# dbid is a number between 0 and 'databases'-1
-databases 16
-
 ################################# REPLICATION #################################
 
 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
 # another Redis server. Note that the configuration is local to the slave
 # so for example it is possible to configure the slave to save the DB with a
 # different interval, or to listen to another port, and so on.
+#
+slaveof 127.0.0.1 6380
 
-slaveof localhost 6380
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+# masterauth <master-password>
 
 ################################## SECURITY ###################################
 
@@ -75,17 +112,21 @@ slaveof localhost 6380
 #
 # This should stay commented out for backward compatibility and because most
 # people do not need auth (e.g. they run their own servers).
-
+# 
+# Warning: since Redis is pretty fast an outside user can try up to
+# 150k passwords per second against a good box. This means that you should
+# use a very strong password otherwise it will be very easy to break.
+#
 # requirepass foobared
 
 ################################### LIMITS ####################################
 
 # Set the max number of connected clients at the same time. By default there
 # is no limit, and it's up to the number of file descriptors the Redis process
-# is able to open. The special value '0' means no limts.
+# is able to open. The special value '0' means no limits.
 # Once the limit is reached Redis will close all the new connections sending
 # an error 'max number of clients reached'.
-
+#
 # maxclients 128
 
 # Don't use more memory than the specified amount of bytes.
@@ -104,7 +145,7 @@ slaveof localhost 6380
 # it is going to use too much memory in the long run, and you'll have the time
 # to upgrade. With maxmemory after the limit is reached you'll start to get
 # errors for write operations, and this may even lead to DB inconsistency.
-
+#
 # maxmemory <bytes>
 
 ############################## APPEND ONLY MODE ###############################
@@ -114,7 +155,7 @@ slaveof localhost 6380
 # happens this is the preferred way to run Redis. If instead you care a lot
 # about your data and don't want to that a single record can get lost you should
 # enable the append only mode: when this mode is enabled Redis will append
-# every write operation received in the file appendonly.log. This file will
+# every write operation received in the file appendonly.aof. This file will
 # be read on startup in order to rebuild the full dataset in memory.
 #
 # Note that you can have both the async dumps and the append only file if you
@@ -122,12 +163,16 @@ slaveof localhost 6380
 # Still if append only mode is enabled Redis will load the data from the
 # log file at startup ignoring the dump.rdb file.
 #
-# The name of the append only file is "appendonly.log"
+# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
+# log file in background when it gets too big.
+
+appendonly no
 
-#appendonly no
+# The name of the append only file (default: "appendonly.aof")
+# appendfilename appendonly.aof
 
 # The fsync() call tells the Operating System to actually write data on disk
-# instead to wait for more data in the output buffer. Some OS will really flush
+# instead to wait for more data in the output buffer. Some OS will really flush 
 # data on disk, some other OS will just try to do it ASAP.
 #
 # Redis supports three different modes:
@@ -136,16 +181,92 @@ slaveof localhost 6380
 # always: fsync after every write to the append only log . Slow, Safest.
 # everysec: fsync only if one second passed since the last fsync. Compromise.
 #
-# The default is "always" that's the safer of the options. It's up to you to
-# understand if you can relax this to "everysec" that will fsync every second
-# or to "no" that will let the operating system flush the output buffer when
-# it want, for better performances (but if you can live with the idea of
-# some data loss consider the default persistence mode that's snapshotting).
+# The default is "everysec" that's usually the right compromise between
+# speed and data safety. It's up to you to understand if you can relax this to
+# "no" that will will let the operating system flush the output buffer when
+# it wants, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting),
+# or on the contrary, use "always" that's very slow but a bit safer than
+# everysec.
+#
+# If unsure, use "everysec".
 
-#appendfsync always
-# appendfsync everysec
+# appendfsync always
+appendfsync everysec
 # appendfsync no
 
+################################ VIRTUAL MEMORY ###############################
+
+# Virtual Memory allows Redis to work with datasets bigger than the actual
+# amount of RAM needed to hold the whole dataset in memory.
+# In order to do so very used keys are taken in memory while the other keys
+# are swapped into a swap file, similarly to what operating systems do
+# with memory pages.
+#
+# To enable VM just set 'vm-enabled' to yes, and set the following three
+# VM parameters accordingly to your needs.
+
+vm-enabled no
+# vm-enabled yes
+
+# This is the path of the Redis swap file. As you can guess, swap files
+# can't be shared by different Redis instances, so make sure to use a swap
+# file for every redis process you are running. Redis will complain if the
+# swap file is already in use.
+#
+# The best kind of storage for the Redis swap file (that's accessed at random) 
+# is a Solid State Disk (SSD).
+#
+# *** WARNING *** if you are using a shared hosting the default of putting
+# the swap file under /tmp is not secure. Create a dir with access granted
+# only to Redis user and configure Redis to create the swap file there.
+vm-swap-file /tmp/redis.swap
+
+# vm-max-memory configures the VM to use at max the specified amount of
+# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
+# is, if there is still enough contiguous space in the swap file.
+#
+# With vm-max-memory 0 the system will swap everything it can. Not a good
+# default, just specify the max amount of RAM you can in bytes, but it's
+# better to leave some margin. For instance specify an amount of RAM
+# that's more or less between 60 and 80% of your free RAM.
+vm-max-memory 0
+
+# Redis swap files is split into pages. An object can be saved using multiple
+# contiguous pages, but pages can't be shared between different objects.
+# So if your page is too big, small objects swapped out on disk will waste
+# a lot of space. If you page is too small, there is less space in the swap
+# file (assuming you configured the same number of total swap file pages).
+#
+# If you use a lot of small objects, use a page size of 64 or 32 bytes.
+# If you use a lot of big objects, use a bigger page size.
+# If unsure, use the default :)
+vm-page-size 32
+
+# Number of total memory pages in the swap file.
+# Given that the page table (a bitmap of free/used pages) is taken in memory,
+# every 8 pages on disk will consume 1 byte of RAM.
+#
+# The total swap size is vm-page-size * vm-pages
+#
+# With the default of 32-bytes memory pages and 134217728 pages Redis will
+# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
+#
+# It's better to use the smallest acceptable value for your application,
+# but the default is large in order to work in most conditions.
+vm-pages 134217728
+
+# Max number of VM I/O threads running at the same time.
+# This threads are used to read/write data from/to swap file, since they
+# also encode and decode objects from disk to memory or the reverse, a bigger
+# number of threads can help with big objects even if they can't help with
+# I/O itself as the physical device may not be able to couple with many
+# reads/writes operations at the same time.
+#
+# The special value of 0 turn off threaded I/O and enables the blocking
+# Virtual Memory implementation.
+vm-max-threads 4
+
 ############################### ADVANCED CONFIG ###############################
 
 # Glue small output buffers together in order to send small replies in a
@@ -153,19 +274,39 @@ slaveof localhost 6380
 # in terms of number of queries per second. Use 'yes' if unsure.
 glueoutputbuf yes
 
-# Use object sharing. Can save a lot of memory if you have many common
-# string in your dataset, but performs lookups against the shared objects
-# pool so it uses more CPU and can be a bit slower. Usually it's a good
-# idea.
-#
-# When object sharing is enabled (shareobjects yes) you can use
-# shareobjectspoolsize to control the size of the pool used in order to try
-# object sharing. A bigger pool size will lead to better sharing capabilities.
-# In general you want this value to be at least the double of the number of
-# very common strings you have in your dataset.
-#
-# WARNING: object sharing is experimental, don't enable this feature
-# in production before of Redis 1.0-stable. Still please try this feature in
-# your development environment so that we can test it better.
-#shareobjects no
-#shareobjectspoolsize 1024
+# Hashes are encoded in a special way (much more memory efficient) when they
+# have at max a given numer of elements, and the biggest element does not
+# exceed a given threshold. You can configure this limits with the following
+# configuration directives.
+hash-max-zipmap-entries 64
+hash-max-zipmap-value 512
+
+# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
+# order to help rehashing the main Redis hash table (the one mapping top-level
+# keys to values). The hash table implementation redis uses (see dict.c)
+# performs a lazy rehashing: the more operation you run into an hash table
+# that is rhashing, the more rehashing "steps" are performed, so if the
+# server is idle the rehashing is never complete and some more memory is used
+# by the hash table.
+# 
+# The default is to use this millisecond 10 times every second in order to
+# active rehashing the main dictionaries, freeing memory when possible.
+#
+# If unsure:
+# use "activerehashing no" if you have hard latency requirements and it is
+# not a good thing in your environment that Redis can reply form time to time
+# to queries with 2 milliseconds delay.
+#
+# use "activerehashing yes" if you don't have such hard requirements but
+# want to free memory asap when possible.
+activerehashing yes
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here.  This is useful if you
+# have a standard template that goes to all redis server but also need
+# to customize a few per-server settings.  Include files can include
+# other files, so use this wisely.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf

data/spec/rack/cache/entitystore/redis_spec.rb

@@ -23,14 +23,14 @@ module Rack
 
         it "should resolve the connection uri" do
           cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1")).cache
-          cache.should be_kind_of(::Redis::Client)
-          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
+          cache.should be_kind_of(::Redis)
+          cache.id.should == "redis://127.0.0.1:6379/0"
 
           cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1:6380")).cache
-          cache.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 0"
+          cache.id.should == "redis://127.0.0.1:6380/0"
 
           cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1/13")).cache
-          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 13"
+          cache.id.should == "redis://127.0.0.1:6379/13"
         end
 
         # Entity store shared examples ===========================================

data/spec/redis/distributed_marshaled_redis_spec.rb

@@ -17,7 +17,7 @@ describe "Redis::DistributedMarshaled" do
 
   it "should accept connection params" do
     dmr = Redis::DistributedMarshaled.new [ :host => "localhost", :port => "6380", :db => "1" ]
-    dmr.ring.should have(1).node
+    dmr.ring.nodes.size == 1
     mr = dmr.ring.nodes.first
     mr.to_s.should == "Redis Client connected to localhost:6380 against DB 1"
   end

data/spec/redis/marshaled_client_spec.rb

@@ -22,8 +22,14 @@ describe "Redis::MarshaledClient" do
     @store.marshalled_get("rabbit").should === @white_rabbit
   end
 
-  it "should not unmarshal object on get if raw option is true" do
-    @store.marshalled_get("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+  if RUBY_VERSION.match /1\.9/
+    it "should not unmarshal object on get if raw option is true" do
+      @store.marshalled_get("rabbit", :raw => true).should == "\x04\bU:\x0FOpenStruct{\x06:\tnameI\"\nbunny\x06:\rencoding\"\rUS-ASCII"
+    end
+  else
+    it "should not unmarshal object on get if raw option is true" do
+      @store.marshalled_get("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+    end
   end
 
   it "should not marshal object on set if raw option is true" do

data/spec/redis_store/version_spec.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe RedisStore::VERSION do
+  it "should describe RedisStore version" do
+    RedisStore::VERSION::STRING.should == "1.0.0.beta1"
+  end
+end

data/spec/spec_helper.rb

@@ -15,7 +15,12 @@ require "rack/cache/metastore"
 require "rack/cache/entitystore"
 require "redis-store"
 require "active_support"
-require "action_controller/session/abstract_store"
+begin
+  require "action_controller/session/abstract_store" # Rails 2.3.x
+rescue LoadError
+  require "action_dispatch/middleware/session/abstract_store" # Rails 3.x
+  module Rails; def self.version; "3.0.0.beta4" end end unless defined?(Rails)
+end
 require "cache/rails/redis_store"
 require "rack/session/rails"
 require "cache/sinatra/redis_store"

data/tasks/redis.tasks.rb

@@ -9,7 +9,7 @@ class RedisRunner
   end
 
   def self.redisdir
-    @@redisdir ||= File.expand_path File.join(File.dirname(__FILE__), '..', 'vendor', 'redis')
+    "/tmp/redis/"
   end
 
   def self.redisconfdir
@@ -124,19 +124,17 @@ namespace :redis do
   end
 
   desc 'Install the lastest verison of Redis from Github (requires git, duh)'
-  task :install => [ :about, :download, :make ] do
+  task :install => [:about, :download, :make] do
     %w(redis-benchmark redis-cli redis-server).each do |bin|
-      if File.exist?(path = "#{RedisRunner.redisdir}/src/#{bin}")
-        sh "sudo cp #{path} /usr/bin/"
-      else
-        sh "sudo cp #{RedisRunner.redisdir}/#{bin} /usr/bin/"
-      end
+      sh "sudo cp /tmp/redis/#{bin} /usr/bin/"
     end
 
     puts "Installed redis-benchmark, redis-cli and redis-server to /usr/bin/"
 
-    sh "sudo cp #{RedisRunner.redisdir}/redis.conf /etc/"
-    puts "Installed redis.conf to /etc/ \n You should look at this file!"
+    unless File.exists?('/etc/redis.conf')
+      sh 'sudo cp /tmp/redis/redis.conf /etc/'
+      puts "Installed redis.conf to /etc/ \n You should look at this file!"
+    end
   end
 
   task :make do
@@ -146,18 +144,13 @@ namespace :redis do
 
   desc "Download package"
   task :download do
-    require 'git'
-
-    sh "rm -rf #{RedisRunner.redisdir} && mkdir -p vendor && rm -rf redis"
-    Git.clone("git://github.com/antirez/redis.git", "redis")
-    sh "mv redis vendor"
+    sh 'rm -rf /tmp/redis/' if File.exists?("#{RedisRunner.redisdir}/.svn")
+    sh 'git clone git://github.com/antirez/redis.git /tmp/redis' unless File.exists?(RedisRunner.redisdir)
 
-    commit = case ENV['VERSION']
-      when "1.2.6": "570e43c8285a4e5e3f31"
+    if File.exists?("#{RedisRunner.redisdir}/.git")
+      arguments = ENV['COMMIT'].nil? ? "pull" : "reset --hard #{ENV['COMMIT']}"
+      sh "cd #{RedisRunner.redisdir} && git #{arguments}"
     end
-
-    arguments = commit.nil? ? "pull origin master" : "reset --hard #{commit}"
-    sh "cd #{RedisRunner.redisdir} && git #{arguments}"
   end
 
   desc "Open an IRb session"
@@ -166,19 +159,6 @@ namespace :redis do
     system "bundle exec irb -I lib -I extra -r redis-store.rb"
     RedisRunner.stop
   end
-
-  namespace :cluster do
-    desc "Starts the redis_cluster"
-    task :start do
-      result = RedisClusterRunner.start_detached
-      raise("Could not start redis-server, aborting.") unless result
-    end
-
-    desc "Stops the redis_cluster"
-    task :stop do
-      RedisClusterRunner.stop
-    end
-  end  
 end
 
 namespace :dtach do
@@ -209,12 +189,3 @@ namespace :dtach do
     puts 'Dtach successfully installed to /usr/bin.'
   end
 end
-
-def invoke_with_redis_cluster(task_name)
-  begin
-    Rake::Task["redis:cluster:start"].invoke
-    Rake::Task[task_name].invoke
-  ensure
-    Rake::Task["redis:cluster:stop"].invoke
-  end
-end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: redis-store
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
+  hash: -1848230051
+  prerelease: true
   segments: 
+  - 1
+  - 0
   - 0
-  - 3
-  - 9
-  version: 0.3.9
+  - beta1
+  version: 1.0.0.beta1
 platform: ruby
 authors: 
 - Luca Guidi
@@ -15,10 +16,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-06-09 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
 description: Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks.
 email: guidi.luca@gmail.com
 executables: []
@@ -30,7 +46,6 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -47,7 +62,7 @@ files:
 - lib/redis/distributed_marshaled.rb
 - lib/redis/factory.rb
 - lib/redis/marshaled_client.rb
-- lib/redis/namespace.rb
+- lib/redis_store/version.rb
 - redis-store.gemspec
 - spec/cache/merb/redis_store_spec.rb
 - spec/cache/rails/redis_session_store_spec.rb
@@ -63,6 +78,7 @@ files:
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/factory_spec.rb
 - spec/redis/marshaled_client_spec.rb
+- spec/redis_store/version_spec.rb
 - spec/spec_helper.rb
 - tasks/redis.tasks.rb
 has_rdoc: true
@@ -86,12 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
@@ -110,4 +128,5 @@ test_files:
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/factory_spec.rb
 - spec/redis/marshaled_client_spec.rb
+- spec/redis_store/version_spec.rb
 - spec/spec_helper.rb