frivol 0.3.1 → 0.4.0

data/test/fake_redis.rb

@@ -5,18 +5,19 @@ class Redis
     @storage = {}
     @expires = Hash.new(nil)
     @version = config[:version] || "2.2.0"
+    @results = []
   end
 
-  def [](key)
-    # puts "retrieve #{key} => #{@storage[key]} (#{(!@expires[key].nil? && @expires[key] < Time.now) ? 'expired' : 'alive'})"
-    return nil if !@expires[key].nil? && @expires[key] < Time.now
-    @storage[key]
+  def get(key)
+    result = expired?(key) ? nil : @storage[key]
+    @results << result
+    result
   end
 
-  def []=(key, value)
-    # puts "store #{key} => #{value}"
+  def set(key, value)
     @storage[key] = value
     @expires.delete key
+    @results << 'OK'
   end
 
   def info(key)
@@ -24,33 +25,38 @@ class Redis
   end
 
   def del(key)
-    # puts "del #{key}"
     @storage.delete key
     @expires.delete key
+    @results << 1
+    1
   end
 
   def incr(key)
-    # puts "incr #{key}"
     @storage[key] ||= 0
-    @storage[key] += 1
+    result = @storage[key] += 1
+    @results << result
+    result
   end
 
   def incrby(key, amount)
-    # puts "incr #{key}"
     @storage[key] ||= 0
-    @storage[key] += amount
+    result = @storage[key] += amount
+    @results << result
+    result
   end
 
   def decr(key)
-    # puts "decr #{key}"
     @storage[key] ||= 0
-    @storage[key] -= 1
+    result = @storage[key] -= 1
+    @results << result
+    result
   end
 
   def decrby(key, amount)
-    # puts "decr #{key}"
     @storage[key] ||= 0
-    @storage[key] -= amount
+    result = @storage[key] -= amount
+    @results << result
+    result
   end
 
   def expire(key, time)
@@ -60,24 +66,38 @@ class Redis
       raise RuntimeError.new("-ERR value is not an integer")
     end
     @expires[key] = Time.now + t
+    @results << 1
+    1
   end
 
   def exists(key)
-    @storage.key? key
+    result = @storage.key?(key) && !expired?(key)
+    @results << result
+    result
   end
 
   def ttl(key)
-    # puts "ttl #{key}"
-    return -1 if @expires[key].nil? || @expires[key] < Time.now
-    (@expires[key] - Time.now).to_i
+    result = if expired?(key)
+      -2
+    elsif @expires[key].nil?
+      -1
+    else
+      (@expires[key] - Time.now).to_i
+    end
+    @results << result
+    result
   end
 
   def multi(&block)
+    @results = []
     yield(self)
+    @results
   end
 
   def flushdb
     @storage = {}
+    @results << 'OK'
+    'OK'
   end
 
   # Help with debugging
@@ -92,4 +112,9 @@ class Redis
   def method_missing(meth, *args, &block)
     puts "Missing method: #{meth} called with #{args.inspect}"
   end
+
+private
+  def expired?(key)
+    !@expires[key].nil? && @expires[key] < Time.now
+  end
 end

data/test/helper.rb

@@ -7,14 +7,110 @@ require 'frivol'
 
 class Test::Unit::TestCase
   def setup
-    fake_redis # Comment out this line to test against a real live Redis
-    Frivol::Config.redis_config = { :db => 10 } # This will connect to a default Redis setup, otherwise set to { :host => "localhost", :port => 6379 }, for example
-    Frivol::Config.redis.flushdb
+    case ENV['backend']
+    when 'redis'
+      require 'frivol/backend/redis'
+      @backend = Frivol::Backend::Redis.new(:db => 10)
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'redis_distributed'
+      require 'frivol/backend/redis_distributed'
+      @backend = Frivol::Backend::RedisDistributed.new([{:db => 11}, {:db => 12}])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'riak'
+      require 'frivol/backend/riak'
+      I18n.enforce_available_locales = false
+      Riak.disable_list_keys_warnings = true
+      @backend = Frivol::Backend::Riak.new(:nodes => [ { :host => '127.0.0.1' } ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi'
+      require 'frivol/backend/redis'
+      fake_redis
+      require 'frivol/backend/multi'
+      @old_backend = Frivol::Backend::Redis.new(:db => 10)
+      @new_backend = Frivol::Backend::Redis.new(:db => 11)
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_redis_redis'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/multi'
+      @old_backend = Frivol::Backend::Redis.new(:db => 10)
+      @new_backend = Frivol::Backend::Redis.new(:db => 11)
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_redis_redis_distributed'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/redis_distributed'
+      require 'frivol/backend/multi'
+      @old_backend = Frivol::Backend::Redis.new(:db => 10)
+      @new_backend = Frivol::Backend::RedisDistributed.new(["redis://127.0.0.1:6379/11", "redis://127.0.0.1:6379/12"])
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_redis_riak'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/riak'
+      require 'frivol/backend/multi'
+      I18n.enforce_available_locales = false
+      Riak.disable_list_keys_warnings = true
+      @old_backend = Frivol::Backend::Redis.new(:db => 10)
+      @new_backend = Frivol::Backend::Riak.new(:nodes => [ { :host => '127.0.0.1' } ])
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_redis_distributed_riak'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/redis_distributed'
+      require 'frivol/backend/riak'
+      require 'frivol/backend/multi'
+      I18n.enforce_available_locales = false
+      Riak.disable_list_keys_warnings = true
+      @old_backend = Frivol::Backend::RedisDistributed.new(["redis://127.0.0.1:6379/11", "redis://127.0.0.1:6379/12"])
+      @new_backend = Frivol::Backend::Riak.new(:nodes => [ { :host => '127.0.0.1' } ])
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_riak_redis'
+      require 'frivol/backend/riak'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/multi'
+      I18n.enforce_available_locales = false
+      Riak.disable_list_keys_warnings = true
+      @old_backend = Frivol::Backend::Riak.new(:nodes => [ { :host => '127.0.0.1' } ])
+      @new_backend = Frivol::Backend::Redis.new(:db => 10)
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    when 'multi_riak_redis_distributed'
+      require 'frivol/backend/riak'
+      require 'frivol/backend/redis'
+      require 'frivol/backend/redis_distributed'
+      require 'frivol/backend/multi'
+      I18n.enforce_available_locales = false
+      Riak.disable_list_keys_warnings = true
+      @old_backend = Frivol::Backend::Riak.new(:nodes => [ { :host => '127.0.0.1' } ])
+      @new_backend = Frivol::Backend::RedisDistributed.new(["redis://127.0.0.1:6379/11", "redis://127.0.0.1:6379/12"])
+      @backend = Frivol::Backend::Multi.new([ @new_backend, @old_backend ])
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    else
+      require 'frivol/backend/redis'
+      fake_redis
+      @backend = Frivol::Backend::Redis.new(:db => 10)
+      @backend.flushdb
+      Frivol::Config.backend = @backend
+    end
+    # NOTE: Because some backends like Riak are eventually consistent,
+    #   we're changing the id of the test class per test.
+    @test_id = TestClass.incr_id
   end
 
   def teardown
-    # puts Frivol::Config.redis.inspect
-    Frivol::Config.redis.flushdb
+    @backend.flushdb
   end
 
   def fake_redis
@@ -24,12 +120,26 @@ class Test::Unit::TestCase
   def ruby_one_eight?
     @ruby_one_eight || `ruby -v`.include?('1.8')
   end
+
+  def self.multi_test?
+    ENV['backend'].to_s.start_with?('multi')
+  end
+
+  def self.riak_test?
+    ENV['backend'].to_s.include?('riak')
+  end
 end
 
 class TestClass
   include Frivol
 
+  @@id = 1
+
+  def self.incr_id
+    @@id += 1
+  end
+
   def id
-    1
+    @@id
   end
 end

data/test/test_backend.rb

@@ -0,0 +1,33 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestBackends < Test::Unit::TestCase
+  def test_ttl
+    t = TestClass.new
+    assert_nil @backend.ttl(t.storage_key)
+
+    t.store :something => 'somewhere'
+    assert_nil @backend.ttl(t.storage_key)
+
+    t.expire_storage 10
+    assert_in_delta 10, @backend.ttl(t.storage_key), 2
+  end
+
+  def test_exists
+    t = TestClass.new
+    refute @backend.exists(t.storage_key)
+
+    t.store :something => 'somewhere'
+    assert @backend.exists(t.storage_key)
+
+    t.delete_storage
+    refute @backend.exists(t.storage_key)
+  end
+
+  def test_exists_with_expiry
+    t = Class.new(TestClass) { storage_expires_in -1 }.new
+    refute @backend.exists(t.storage_key)
+
+    t.store :something => 'somewhere'
+    refute @backend.exists(t.storage_key)
+  end
+end

data/test/test_counters.rb

@@ -69,4 +69,35 @@ class TestCounters < Test::Unit::TestCase
     t.store_yellow 10
     assert_equal 0, t.retrieve_yellow(0)
   end
+
+  def test_expire_on_a_counter_bucket_using_increment
+    t = Class.new(TestClass) { storage_bucket :fuscia, :counter => true, :expires_in => -1 }.new
+    assert_equal 1, t.increment_fuscia
+    assert_equal 0, t.retrieve_fuscia(0)
+  end
+
+  def test_expire_on_a_counter_bucket_using_increment_by
+    t = Class.new(TestClass) { storage_bucket :magenta, :counter => true, :expires_in => -1 }.new
+    t.increment_magenta_by 10
+    assert_equal 0, t.retrieve_magenta(0)
+  end
+
+  def test_expire_on_a_counter_bucket_using_decrement
+    t = Class.new(TestClass) { storage_bucket :rose, :counter => true, :expires_in => -1 }.new
+    t.decrement_rose
+    assert_equal 0, t.retrieve_rose(0)
+  end
+
+  def test_expire_on_a_counter_bucket_using_decrement_by
+    t = Class.new(TestClass) { storage_bucket :orchid, :counter => true, :expires_in => -1 }.new
+    t.decrement_orchid_by 10
+    assert_equal 0, t.retrieve_orchid(0)
+  end
+
+  def test_delete_a_counter_bucket
+    t = Class.new(TestClass) { storage_bucket :debt, :counter => true }.new
+    t.store_debt 100_000
+    t.delete_debt
+    assert_equal 0, t.retrieve_debt(0)
+  end
 end

data/test/test_frivol.rb

@@ -3,7 +3,7 @@ require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
 class TestFrivol < Test::Unit::TestCase
   def test_have_a_default_storage_key_made_up_of_the_class_name_and_id
     t = TestClass.new
-    assert_equal "TestClass-1", t.storage_key
+    assert_equal "TestClass-#{@test_id}", t.storage_key
   end
 
   def test_store_and_retrieve_data
@@ -12,11 +12,27 @@ class TestFrivol < Test::Unit::TestCase
     assert_equal "value", t.retrieve(:value => 'default')
   end
 
+  def test_retrieve_non_existing
+    t = TestClass.new
+    assert_nothing_raised do
+      assert_nil t.retrieve(:nothing => nil)
+    end
+  end
+
   def test_return_a_default_for_a_value_thats_not_in_storage
     t = TestClass.new
     assert_equal "default", t.retrieve(:value => 'default')
   end
 
+  def test_return_default_when_stored_value_is_emtpy_string
+    t = TestClass.new
+    key = t.storage_key
+    Frivol::Config.backend.set(key, "")
+    assert_nothing_raised do
+      assert_equal "36", t.retrieve( :some_string => "36")
+    end
+  end
+
   def test_save_and_retrieve_multiple_values
     t = TestClass.new
     t.store :val1 => 1, :val2 => 2
@@ -68,7 +84,7 @@ class TestFrivol < Test::Unit::TestCase
     end.new
 
     t.store :value => 'value'
-    assert Frivol::Config.redis["my_storage"]
+    assert @backend.get("my_storage")
   end
 
   def test_retain_Times_as_Times
@@ -87,7 +103,7 @@ class TestFrivol < Test::Unit::TestCase
   end
 
   def test_use_default_expiry_set_on_the_class
-    klass = Class.new(TestClass) { storage_expires_in -1 }
+    klass = Class.new(TestClass) { storage_expires_in -10 }
     t = klass.new
     t.store :value => 'value'
 
@@ -101,10 +117,10 @@ class TestFrivol < Test::Unit::TestCase
     t = Class.new(TestClass) { storage_expires_in 2 }.new
 
     t.store :value => 'value'
-    assert Frivol::Config.redis.ttl(t.storage_key) > 0
+    assert @backend.ttl(t.storage_key) > 0
 
     t.store :value => 'value' # a second time
-    assert Frivol::Config.redis.ttl(t.storage_key) > 0
+    assert @backend.ttl(t.storage_key) > 0
   end
 
   def test_be_able_to_include_in_other_classes_with_storage_expiry
@@ -119,8 +135,8 @@ class TestFrivol < Test::Unit::TestCase
     t = TestClass.new
     t.retrieve :value => 'default'
 
-    redis = Frivol::Config.redis
-    def redis.[](key); raise 'Onoes, loaded again'; end
+    # ensure we're getting the result from the cache and not Redis
+    def @backend.get(key); raise 'Onoes, loaded again'; end
 
     t.retrieve :value => 'default'
   end
@@ -141,8 +157,7 @@ class TestFrivol < Test::Unit::TestCase
     t.clear_gold
 
     # ensure we're getting the result from Redis and not the cache
-    redis = Frivol::Config.redis
-    def redis.[](key)
+    def @backend.get(key, expiry = nil)
       MultiJson.dump(:value => 'this is what we want')
     end
 

data/test/test_frivolize.rb

@@ -33,18 +33,18 @@ class TestFrivolize < Test::Unit::TestCase
       @@count = 0
 
       # Imagine counting dinosuars takes a long time, what with the need to invent a time machine first and all
-      def dinosaur_count
+      def dinosaurus_count
         @@count += 1
       end
-      frivolize :dinosaur_count, { :bucket => :dinosaurs, :expires_in => -1 }
+      frivolize :dinosaurus_count, { :bucket => :dinosauruss, :expires_in => -1 }
     end
 
     t = klass.new
-    assert_equal 1, t.dinosaur_count
-    assert_equal 1, t.dinosaur_count # Still 10 because it's coming from the class cache
+    assert_equal 1, t.dinosaurus_count
+    assert_equal 1, t.dinosaurus_count # Still 1 because it's coming from the class cache
 
     t = klass.new
-    assert_equal 2, t.dinosaur_count
+    assert_equal 2, t.dinosaurus_count
   end
 
   def test_frivolize_methods_with_expiry_as_a_counter
@@ -53,19 +53,19 @@ class TestFrivolize < Test::Unit::TestCase
       @@count = 0
 
       # Imagine counting dinosuars takes a long time, what with the need to invent a time machine first and all
-      def dinosaur_count
+      def dinosaurii_count
         @@count += 1
       end
-      frivolize :dinosaur_count, { :expires_in => -1, :counter => true }
+      frivolize :dinosaurii_count, { :expires_in => -1, :counter => true }
     end
 
     t = klass.new
-    assert t.methods.include?(ruby_one_eight? ? 'store_dinosaur_count' : :store_dinosaur_count) # check that the bucket name is the method name
+    assert t.methods.include?(ruby_one_eight? ? 'store_dinosaurii_count' : :store_dinosaurii_count) # check that the bucket name is the method name
 
-    assert_equal 1, t.dinosaur_count
+    assert_equal 1, t.dinosaurii_count
 
     t = klass.new # a fresh instance after value expired
-    assert_equal 2, t.dinosaur_count
+    assert_equal 2, t.dinosaurii_count
   end
 
   def test_frivolize_with_seed_as_a_counter_for_increment
@@ -73,7 +73,7 @@ class TestFrivolize < Test::Unit::TestCase
       def bak_baks
         88_888
       end
-      frivolize :bak_baks, :counter => true, :seed => Proc.new{ |obj| obj.bak_baks}
+      frivolize :bak_baks, :counter => true, :seed => Proc.new{ |obj| obj.bak_baks }
     end.new
 
     assert_equal 88_888 + 1, t.increment_bak_baks