frivol 0.2.0 → 0.3.0

data/test/fake_redis.rb

@@ -1,3 +1,5 @@
+FAKE_REDIS = true
+
 class Redis
   def initialize(config)
     @storage = {}
@@ -21,45 +23,68 @@ class Redis
     @storage.delete key
     @expires.delete key
   end
-  
+
   def incr(key)
     # puts "incr #{key}"
+    @storage[key] ||= 0
     @storage[key] += 1
   end
-  
+
+  def incrby(key, amount)
+    # puts "incr #{key}"
+    @storage[key] ||= 0
+    @storage[key] += amount
+  end
+
+  def decr(key)
+    # puts "decr #{key}"
+    @storage[key] ||= 0
+    @storage[key] -= 1
+  end
+
+  def decrby(key, amount)
+    # puts "decr #{key}"
+    @storage[key] ||= 0
+    @storage[key] -= amount
+  end
+
   def expire(key, time)
     begin
-      t = Integer(time) 
-    rescue 
+      t = Integer(time)
+    rescue
       raise RuntimeError.new("-ERR value is not an integer")
     end
     @expires[key] = Time.now + t
   end
-  
+
   def exists(key)
     @storage.key? key
   end
-  
+
   def ttl(key)
     # puts "ttl #{key}"
     return -1 if @expires[key].nil? || @expires[key] < Time.now
     (@expires[key] - Time.now).to_i
   end
-  
+
   def multi(&block)
     yield(self)
   end
-  
+
   def flushdb
     @storage = {}
   end
-  
+
   # Help with debugging
   def inspect
-    @storage.keys.sort.map do |key| 
+    @storage.keys.sort.map do |key|
       result = "\n#{key} => #{@storage[key].inspect}"
       result << "\n\texpires at #{@expires[key]}" if @expires.key?(key)
       result
     end
   end
-end
+
+  def method_missing(meth, *args, &block)
+    puts "Missing method: #{meth} called with #{args.inspect}"
+  end
+end

data/test/helper.rb

@@ -1,30 +1,35 @@
 require 'rubygems'
 require 'test/unit'
-require 'shoulda'
-require 'mocha'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 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
+  end
+
+  def teardown
+    # puts Frivol::Config.redis.inspect
+    Frivol::Config.redis.flushdb
+  end
+
   def fake_redis
     require 'fake_redis'
   end
+
+  def ruby_one_eight?
+    @ruby_one_eight || `ruby -v`.include?('1.8')
+  end
 end
 
 class TestClass
   include Frivol
-  
+
   def id
     1
   end
-  
-  def save
-    store :value => "value"
-  end
-  
-  def load
-    retrieve :value => "default"
-  end
 end

data/test/test_buckets.rb

@@ -0,0 +1,53 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestBuckets < Test::Unit::TestCase
+  def test_be_able_to_create_and_use_buckets
+    t = Class.new(TestClass) { storage_bucket :blue }.new
+
+    assert t.respond_to?(:store_blue)
+    assert t.respond_to?(:retrieve_blue)
+  end
+
+  def test_store_different_values_in_different_buckets
+    t = Class.new(TestClass) { storage_bucket :blue }.new
+
+    t.store :value => 'value'
+    t.store_blue :value => 'blue value'
+
+    assert_equal "value", t.retrieve(:value => 'default')
+    assert_equal "blue value", t.retrieve_blue(:value => 'default')
+  end
+
+  def test_be_able_to_delete_storage_for_a_bucket
+    t = Class.new(TestClass) { storage_bucket :silver }.new
+    t.store_silver :value => 'value'
+    assert_equal "value", t.retrieve_silver(:value => 'default')
+    t.delete_silver
+    assert_equal "default", t.retrieve_silver(:value => 'default')
+  end
+
+  def test_have_different_expiry_times_for_different_buckets
+    klass = Class.new(TestClass) do
+      storage_bucket :blue, :expires_in => 1
+      storage_expires_in 2
+    end
+
+    assert_equal 1, klass.storage_expiry(:blue)
+    assert_equal 2, klass.storage_expiry
+  end
+
+  def test_expire_data_in_buckets
+    klass = Class.new(TestClass) do
+      storage_bucket :blue, :expires_in => -1
+      storage_expires_in 1
+    end
+
+    t = klass.new
+    t.store :value => 'value'
+    t.store_blue :value => 'value'
+
+    t = klass.new # get a new instance so @frivol_data is empty
+    assert_equal "value", t.retrieve(:value => 'default')
+    assert_equal "blue default", t.retrieve_blue(:value => 'blue default')
+  end
+end

data/test/test_condition.rb

@@ -0,0 +1,43 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestCondition < Test::Unit::TestCase
+  def test_stores_if_CONDITION_method_evaluates_to_truthy
+    klass = Class.new(TestClass) do
+      storage_bucket :stars, :condition => :something_truthy
+
+      def something_truthy(*args)
+        'Wax museum'
+      end
+    end
+    t = klass.new
+
+    t.store_stars :value => 88
+    assert_equal 88, t.retrieve_stars(:value => 0)
+  end
+
+  def test_stores_with_positive_CONDITION_proc
+    t = Class.new(TestClass) { storage_bucket :stars, :condition => Proc.new{true} }.new
+    t.store_stars :value => 77
+    assert_equal 77, t.retrieve_stars(:value => 0)
+  end
+
+  def test_stores_positive_CONDITION_proc_which_takes_an_instance
+    klass = Class.new(TestClass) do
+      storage_bucket :stars, :condition => Proc.new{ |instance, frivol_method, *args| instance.something_truthy }
+
+      def something_truthy(*args)
+        'Wax museum'
+      end
+    end
+    t = klass.new
+
+    t.store_stars :value => 66
+    assert_equal 66, t.retrieve_stars(:value => 0)
+  end
+
+  def test_does_not_store_with_negative_CONDITION
+    t = Class.new(TestClass) { storage_bucket :stars, :condition => Proc.new{false} }.new
+    t.store_stars :value => 55
+    assert_equal 0, t.retrieve_stars(:value => 0)
+  end
+end

data/test/test_condition_with_counters.rb

@@ -0,0 +1,90 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestConditionCounters < Test::Unit::TestCase
+  def test_increments_a_counter_with_no_conditions
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true }.new
+    t.increment_stars
+    assert_equal 1, t.retrieve_stars(0)
+  end
+
+  def test_increments_a_counter_if_condition_evaluates_to_true
+    klass = Class.new(TestClass) do
+      storage_bucket :stars, :counter => true, :condition => :something_truthy
+
+      def something_truthy(frivol_method, *args)
+        'Wax museum'
+      end
+    end
+    t = klass.new
+
+    t.increment_stars
+    assert_equal 1, t.retrieve_stars(0)
+  end
+
+  def test_increments_a_counter_with_positive_condition
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => Proc.new{true} }.new
+    t.increment_stars
+    assert_equal 1, t.retrieve_stars(0)
+  end
+
+  def test_increments_a_counter_when_condition_is_a_proc
+    klass = Class.new(TestClass) do
+      storage_bucket :stars, :counter => true, :condition => Proc.new{ |instance, frivol_method, *args| instance.something_truthy }
+
+      def something_truthy
+        'Wax museum'
+      end
+    end
+    t = klass.new
+
+    t.increment_stars
+    assert_equal 1, t.retrieve_stars(0)
+  end
+
+  def test_does_not_increment_a_counter_with_negative_condition
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => Proc.new{false} }.new
+    t.increment_stars
+    assert_equal 0, t.retrieve_stars(0)
+  end
+
+  def test_does_not_increment_a_counter_when_condition_is_false
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => false }.new
+    t.increment_stars
+    assert_equal 0, t.retrieve_stars(0)
+  end
+
+  def test_increment_by_does_not_increment_with_condition_is_false
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => false }.new
+    t.increment_stars_by(20)
+    assert_equal 0, t.retrieve_stars(0)
+  end
+
+  def test_store_does_not_set_the_value_if_condition_is_negative
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => Proc.new{ false } }.new
+    t.store_stars(20)
+    assert_equal 0, t.retrieve_stars(0)
+  end
+
+  def test_decrement_only_happens_if_condition_is_positive
+    condition_proc = proc do |instance, method_name, *args|
+      method_name != 'increment_stars'
+    end
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => condition_proc }.new
+    t.store_stars(20)
+    t.increment_stars
+    t.decrement_stars
+    assert_equal 19, t.retrieve_stars(0)
+  end
+
+    def test_decrement_by_only_happens_if_condition_is_positive
+    condition_proc = proc do |instance, method_name, *args|
+      method_name != 'increment_stars'
+    end
+
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => condition_proc }.new
+    t.store_stars(20)
+    t.increment_stars
+    t.decrement_stars_by 10
+    assert_equal 10, t.retrieve_stars(0)
+  end
+end

data/test/test_counters.rb

@@ -0,0 +1,72 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestCounters < Test::Unit::TestCase
+  def test_be_able_to_create_counter_buckets
+    t = Class.new(TestClass) { storage_bucket :blue, :counter => true }.new
+
+    assert t.respond_to?(:store_blue)
+    assert t.respond_to?(:retrieve_blue)
+    assert t.respond_to?(:increment_blue)
+  end
+
+  def test_store_increment_and_retrieve_integers_in_a_counter
+    t = Class.new(TestClass) { storage_bucket :blue, :counter => true }.new
+    t.store_blue 10
+
+    assert_equal 10, t.retrieve_blue(0)
+    assert_equal 11, t.increment_blue
+    assert_equal 11, t.retrieve_blue(0)
+  end
+
+  def test_increment_by_and_retrieve_integers_in_a_counter
+    t = Class.new(TestClass) do
+      storage_bucket :cats, :counter => true
+
+      def kittens
+        increment_cats_by 5
+      end
+    end.new
+
+    t.store_cats 1
+    assert_equal 1, t.retrieve_cats(0)
+    t.kittens
+    assert_equal 6, t.retrieve_cats(0)
+  end
+
+  def test_store_decrement_and_retrieve_integers_in_a_counter
+    t = Class.new(TestClass) { storage_bucket :red, :counter => true }.new
+
+    assert_equal 0, t.retrieve_red(0)
+    t.store_red(10)
+    assert_equal 10, t.retrieve_red(0)
+    assert_equal 9, t.decrement_red
+    assert_equal 9, t.retrieve_red(0)
+  end
+
+  def test_decrement_by_and_retrieve_integers_in_a_counter
+    t = Class.new(TestClass) do
+      storage_bucket :money, :counter => true
+
+      def shopping
+        decrement_money_by 1000
+      end
+    end.new
+
+    t.store_money 2000
+    assert_equal 2000, t.retrieve_money(0)
+    t.shopping
+    assert_equal 1000, t.retrieve_money(0)
+  end
+
+  def test_set_expiry_on_counters
+    klass = Class.new(TestClass) { storage_bucket :sheep, :counter => true, :expires_in => 1 }
+    klass.new
+    assert_equal 1, klass.storage_expiry(:sheep)
+  end
+
+  def test_expire_a_counter_bucket
+    t = Class.new(TestClass) { storage_bucket :yellow, :counter => true, :expires_in => -1 }.new
+    t.store_yellow 10
+    assert_equal 0, t.retrieve_yellow(0)
+  end
+end

data/test/test_else_with_counters.rb

@@ -0,0 +1,39 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestElseWithCounters < Test::Unit::TestCase
+  def test_given_CONDITION_evaluates_to_true_ELSE_is_not_performed
+    else_proc = Proc.new{raise StandardError.new('You\'ll never catch me!') }
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => Proc.new{true}, :else => else_proc }.new
+
+    assert_nothing_raised do
+      t.increment_stars
+      assert_equal 1, t.retrieve_stars(0)
+    end
+  end
+
+  def test_given_CONDITION_evaluates_to_false_ELSE_is_performed
+    else_proc = Proc.new{ |instance, method_name, *args| raise StandardError.new('You\'ll never catch me!') if method_name == 'increment_stars' }
+    t = Class.new(TestClass) { storage_bucket :stars, :counter => true, :condition => Proc.new{false}, :else => else_proc }.new
+
+    assert_raises StandardError do
+      t.increment_stars
+    end
+
+    assert_equal 0, t.retrieve_stars(0)
+  end
+
+  def test_given_CONDITION_evaluates_to_false_ELSE_calls_a_method_on_the_object
+    klass = Class.new(TestClass) do
+      condition_proc = Proc.new{ |instance, method_name, *args| method_name != 'increment_stars'}
+      storage_bucket :stars, :counter => true, :condition => condition_proc, :else => :set_stars_to_20
+
+      def set_stars_to_20(frivol_method, *args)
+        store_stars 20
+      end
+    end
+    t = klass.new
+
+    t.increment_stars
+    assert_equal 20, t.retrieve_stars(0)
+  end
+end

data/test/test_extensions.rb

@@ -0,0 +1,15 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper.rb"
+
+class TestExtensions < Test::Unit::TestCase
+  require "#{File.join(File.expand_path(File.dirname(__FILE__)), '../lib/frivol/time_extensions')}"
+
+  def test_time
+    time = Time.local(2014, 3, 4, 17, 53, 29)
+
+    t = TestClass.new
+    t.store(:time => time)
+
+    t = TestClass.new
+    assert_equal time, t.retrieve(:time => nil)
+  end
+end