cachedis 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cachedis (0.0.1)
+    cachedis (0.0.2)
       redis
 
 GEM

data/README.md

@@ -8,24 +8,13 @@ Cachedis caches your expensive queries to a Redis instance so the next time you
 
 ## Documentation
 
-You can specify two types of options via constants:
-
-* `CACHEDIS_DEFAULT_OPTIONS`
-    - Passed directly to [redis-rb][rr]
-    - Options like host options, port options, etc.
-* `CACHEDIS_DEFAULT_QUERY_OPTIONS`
-    - Default options for the `cachedis` queries
-    - For instance if you always want queries to expire in an hour:
-        - `CACHEDIS_DEFAULT_QUERY_OPTIONS = { :expire => 60 * 60 * 60}`
-    - Overridden by options passed to `cachedis` directly
-
 `cachedis` takes two arguments in addition to a block which should return whatever you want `cachedis` to cache:
 
     key, options = {}
 
 The key is the name of the key under which the objects are saved as in Redis. Options are send directly to the Redis instance in along. For instance the option could be expiring the key at a certain time:
 
-    include CachedisInterface
+    include Cachedis::Interface
 
     # expire in an hour using Redis' EXPIRE command
     cachedis 'users:all:with_avatars', :expire => 60 * 60 * 60 do
@@ -37,6 +26,15 @@ The key is the name of the key under which the objects are saved as in Redis. Op
       # insert expensive query here
     end
 
+### Configuration
+
+If you want to configure the server(s) or port(s) for `cachedis` to use, you should override the default `Cachedis::Interface#cachedis` method. Whatever you pass to `#new` is passed directly to the instance of the Redis object from the [redis-rb][rr] library:
+
+    def cachedis(name, options = {}, &block)
+      @cachedis ||= Cachedis.new(:host => "10.0.1.1", :port => 6380)
+      @cachedis.cachedis(name, options, &block)
+    end
+
 ## Installation and dependencies
 
 Dependencies: [redis-rb][rr]
@@ -45,12 +43,25 @@ Install: `gem install cachedis`
 
 [Redis](http://redis.io) should be running in the background, start it with `redis-server`.
 
+## Serialization
+
+I experimented and benchmarked with `JSON`, `YAML` and `Marshal` using the drivers in the Ruby standard libary with [this script](https://gist.github.com/858604).
+
+Marshal is about 2x as fast as the other formats. However, it's also the one that is gonna take up the most space, but it's so little that it should not matter.
+
+You can switch serialization driver if you need to by overriding `Cachedis.serializer`. The serializer must respond to `#load` and `#dump`, remember to require it before using it with `cachedis`:
+
+    module Cachedis
+      def self.serializer
+        "YAML"
+      end
+    end
+
 ## Wishlist/To do/To consider
 
 * ActiveRecord integration
     - `Post.all.expensive_operation.cachedis`
 * Make expirement time optional
-* Best serializing?
 * Sexify the API
     - Make it easier to specialize expirement time (e.g. `:expire => 4.hours`), or just let this be for ActiveSupport users only?
 * Rename `Cachedis#cachedis`?

data/benchmarks/serialization.rb

@@ -0,0 +1,75 @@
+require 'benchmark'
+require 'redis'
+require 'yaml'
+require 'json'
+
+N = 10000
+
+Benchmark.bm do |r|
+  @redis = Redis.new
+  @serialize_me = { :lol => 'test', "ohai" => 'llllll', :array => [12,321,231,23, { :hi => 'hej'}]}
+
+  r.report("YAML Save") do
+    puts 'Yaml'
+    puts YAML.dump(@serialize_me).length
+
+    N.times do |n|
+      @redis.set "yaml-#{n}", YAML.dump(@serialize_me)
+    end
+  end
+
+  r.report("YAML Load") do
+    N.times do |n|
+      YAML.load(@redis.get "yaml-#{n}")
+    end
+  end
+
+  r.report("Marshal Save") do 
+    puts 'Marshal'
+    puts Marshal.dump(@serialize_me).length
+
+    N.times do |n|
+      @redis.set "marshal-#{n}", Marshal.dump(@serialize_me)
+    end
+  end
+
+  r.report("Marshal Load") do
+    N.times do |n|
+      Marshal.load(@redis.get "marshal-#{n}")
+    end
+  end
+
+  r.report("JSON Save") do
+    puts 'JSON'
+    puts JSON.dump(@serialize_me).length
+
+    N.times do |n|
+      @redis.set "json-#{n}", JSON.dump(@serialize_me)
+    end
+  end
+
+  r.report("JSON Load") do
+    N.times do |n|
+      JSON.load(@redis.get "json-#{n}")
+    end
+  end
+end
+
+# N = 10000
+#       user     system      total        real
+# YAML Save  1.170000   0.160000   1.330000 (  1.444772)
+# YAML Load  0.560000   0.130000   0.690000 (  0.781064)
+# Marshal Save  0.290000   0.140000   0.430000 (  0.527284)
+# Marshal Load  0.260000   0.160000   0.420000 (  0.507964)
+# JSON Save  0.670000   0.170000   0.840000 (  0.970764)
+# JSON Load  0.310000   0.190000   0.500000 (  0.568105
+#
+# N = 100000
+#       user     system      total        real
+# YAML Save  1.170000   0.160000   1.330000 (  1.444772)
+# YAML Load  0.560000   0.130000   0.690000 (  0.781064)
+# Marshal Save  0.290000   0.140000   0.430000 (  0.527284)
+# Marshal Load  0.260000   0.160000   0.420000 (  0.507964)
+# JSON Save  0.670000   0.170000   0.840000 (  0.970764)
+# JSON Load  0.310000   0.190000   0.500000 (  0.568105
+

data/lib/cachedis.rb

@@ -1,43 +1,45 @@
 require 'redis'
-require 'yaml'
 
-class Cachedis
-  attr_reader :redis_instance
-
-  def initialize(options = {})
-    redis(options)
+module Cachedis
+  def self.serializer
+    "Marshal"
   end
 
-  def cachedis(key, options = {}, &block)
-    result = yield
-    
-    return redis.get key if redis.exists key
+  class Cacher
+    def initialize(options = {})
+      redis(options)
+    end
 
-    result = result.to_yaml
-    redis.set key, result
-    pass_options_to_redis(options)
+    def cachedis(key, options = {}, &block)
+      result = yield
+      
+      serializer = Kernel.const_get(Cachedis.serializer)
+      return serializer.load(redis.get(key)) if redis.exists key
 
-    result
-  end
+      result = serializer.dump(result)
+      redis.set key, result
+      pass_options_to_redis(options)
 
-  def redis(options = {})
-    @redis_instance ||= Redis.new(options)
-  end
+      result
+    end
 
-  private
-  def pass_options_to_redis(options)
-    options.each do |option, argument|
-      arguments = *[argument] if argument.is_a?(Array)
-      redis.send(option, arguments || argument)
+    def redis(options = {})
+      @redis_instance ||= Redis.new(options)
+    end
+
+    private
+    def pass_options_to_redis(options)
+      options.each do |option, argument|
+        arguments = *[argument] if argument.is_a?(Array)
+        redis.send(option, arguments || argument)
+      end
     end
   end
-end
 
-module CachedisInterface
-  def self.cachedis(name, options = {}, &block)
-    cachedis = Cachedis.new((CACHEDIS_DEFAULT_OPTIONS if defined?(CACHEDIS_DEFAULT_OPTIONS))|| {})
-    
-    query_options = ((CACHEDIS_DEFAULT_QUERY_OPTIONS if defined?(CACHEDIS_OPTIONS)) || {}).merge(options)
-    cachedis.cachedis(name, query_options, &block)
+  module Interface
+    def self.cachedis(name, options = {}, &block)
+      cachedis = Cacher.new
+      cachedis.cachedis(name, options, &block)
+    end
   end
 end

data/lib/cachedis/version.rb

@@ -1,3 +1,3 @@
-class Cachedis
-  VERSION = "0.0.2"
+module Cachedis
+  VERSION = "0.0.3"
 end

data/spec/base_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Cachedis do
+describe Cachedis::Cacher do
   include HelperMethods
 
   before do
-    @cachedis = Cachedis.new
+    @cachedis = Cachedis::Cacher.new
   end
 
   describe 'when setting something' do
@@ -20,14 +20,12 @@ describe Cachedis do
 
   describe 'when setting and later retrieving something' do
     it 'retrieves from redis cache' do
-      with_cache('query')
-      @cachedis.redis_instance.should_not_receive(:set)
+      with_cache(Marshal.dump('query'))
+      @cachedis.redis.should_not_receive(:set)
 
-      result = @cachedis.cachedis 'expensive-query' do
-                "query"
-              end
-
-      result.should == "query".to_yaml
+      @cachedis.cachedis 'expensive-query' do
+        "query"
+      end
     end
   end
 
@@ -36,7 +34,7 @@ describe Cachedis do
       it 'sets them in redis' do
         with_no_cache
 
-        @cachedis.redis_instance.should_receive(:expire).exactly(1).times
+        @cachedis.redis.should_receive(:expire).exactly(1).times
 
         @cachedis.cachedis 'name', :expire => 60 * 60 do
         end
@@ -46,7 +44,7 @@ describe Cachedis do
     context 'with an array of arguments' do
       it 'sets them in redis' do
         with_no_cache
-        @cachedis.redis_instance.should_receive(:rename).exactly(1).times
+        @cachedis.redis.should_receive(:rename).exactly(1).times
 
         @cachedis.cachedis 'name', :rename => ['key', 'otherkey'] do
         end

data/spec/interface_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
-describe CachedisInterface do
+describe Cachedis::Interface do
   include HelperMethods
 
   describe 'when setting something' do
     it 'sets without errors' do
-      @mock = mock(Cachedis)
-      Cachedis.should_receive(:new).exactly(1).times.and_return(@mock)
+      @mock = mock(Cachedis::Cacher)
+      Cachedis::Cacher.should_receive(:new).exactly(1).times.and_return(@mock)
       @mock.stub!(:cachedis).and_return(['element', 'element 2'])
       
-      CachedisInterface.cachedis 'expensive-query' do
+      Cachedis::Interface.cachedis 'expensive-query' do
         ['element', 'element 2']
       end
     end

data/spec/spec_helper.rb

@@ -11,6 +11,6 @@ module HelperMethods
 
   def with_cache(cache)
     @cachedis.redis.should_receive(:exists).exactly(1).times.and_return(true)
-    @cachedis.redis.should_receive(:get).exactly(1).times.and_return(cache.to_yaml)
+    @cachedis.redis.should_receive(:get).exactly(1).times.and_return(cache)
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Simon H\xC3\xB8rup Eskildsen"
@@ -72,6 +72,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- benchmarks/serialization.rb
 - cachedis.gemspec
 - lib/cachedis.rb
 - lib/cachedis/version.rb