cachely 0.0.4 → 0.0.5

data/README.md

@@ -79,11 +79,33 @@ the method name, and it's arguments. To expire a cached result by this signature
 
     Cachely::Mechanics.expire(object, method, *args)
 
-CAVEAT: Do NOT use Cachely for functions that depend on time of day or random numbers, as these are inherently uncachable. 
+Want to wipe all keys?
+
+    Cachely::Mechanics.flush_all_keys
+
+And done.
+
+## Caveats
+
+CAVEAT 1: Do NOT use Cachely for functions that depend on time of day or random numbers, as these are inherently uncachable. 
 If you check the tests out, you'll see random number functions are used exhaustively to test the caching ability of cachely,
 because we know the function wasn't called if the second call yields the same number.
 
 If you do not understand the implications of the caveat, do not use cachely. You're not ready yet. 
+
+CAVEAT 2: Do NOT use Cachely on a method that you pass arguments with circular references to themselves, ie 
+
+    hash = {}
+    hash[:hash] = hash
+    hash.to_json #will throw an error, to_json is used exhaustively by cachely to handle caching properly.
+
+This also includes method results - if you ever return a result that has circular references, don't use cachely. If the object or class you're calling the method on
+has circular references to itself, don't use cachely then, either.
+
+One exception is ActiveRecord objects, which have already been fixed in this regard. There are three tests in conversion_tests.rb that fail still that deal with this
+caveat. I'll be fixing them in the future and we'll be one caveat shorter.
+
+  
 ## Installation
 
 Add this line to your application's Gemfile:

data/db/migrate/001_create_dummy_model.rb

@@ -3,6 +3,7 @@ class CreateDummyModel < ActiveRecord::Migration
 		create_table :dummy_models do |t|
       t.string :attr_1
       t.string :attr_2
+      t.integer :dummy_model_id
 			t.timestamps
 		end
 	end

data/lib/cachely/mechanics.rb

@@ -189,6 +189,7 @@ module Cachely
     # @p The object to convert
     # @return [String] The redis coded string.
     def self.map_param_to_s(p)
+
       if(p.is_a?(Hash)) 
         return map_hash_to_s(p)
       elsif(p.is_a?(Array))
@@ -214,10 +215,17 @@ module Cachely
           #don't want { "dummy_model" = > {:attributes => 1}}
           #want {:attributes => 1}
           translated = "instance|#{p.class.to_s}|#{JSON.parse(p.to_json)[p.class.to_s.underscore].to_json}"
-        else 
-          translated = (p.to_s.match(/^#</) ? "instance|#{p.class}" : "class|#{p.to_s}") + "|"+ p.to_json
+        else
+          my_json = nil
+          begin
+            my_json = p.to_json #active record classes have circ references, we catch them below.
+          rescue ActiveSupport::JSON::Encoding::CircularReferenceError => e
+            my_json = "{}"
+          end
+
+          translated = (p.to_s.match(/^#</) ? "instance|#{p.class}" : "class|#{p.to_s}") + "|"+ my_json
         end
-        
+
         return translated
       end
     end

data/lib/cachely/version.rb

@@ -1,3 +1,3 @@
 module Cachely
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/models/dummy_model.rb

@@ -1,5 +1,7 @@
 class DummyModel < ActiveRecord::Base
-  attr_accessible :attr_1, :attr_2
+  attr_accessible :attr_1, :attr_2, :dummy_model_id
+  
+  belongs_to :dummy_model, :foreign_key => :dummy_model_id
   
   def instance_fixnum
     rand(500)

data/test/unit/base_test.rb

@@ -5,7 +5,9 @@ require 'yaml'
 base_dir = File.expand_path(File.join(File.dirname(__FILE__), "../.."))
 require base_dir + "/lib/cachely.rb"
 require_relative '../models/dummy_model.rb'
+require_relative '../models/dummy_model_two.rb'
 require_relative '../models/dummy_class.rb'
+require_relative '../models/dummy_class_2.rb'
 
 class BaseTest < ActiveSupport::TestCase
   def setup

data/test/unit/conversions_test.rb

@@ -37,6 +37,56 @@ class ConversionsTest < BaseTest
     assert_equal(d.random_no, reformed.random_no)
   end
 
+  test "orm class" do
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(DummyModel)
+    end
+  end
+
+  test "orm obj referencing itself" do
+    d = DummyModel.create!(:attr_1 => rand(500), :attr_2 => rand(500))
+
+    d.dummy_model = d
+    d.save!
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(d)
+    end
+  end
+
+  test "orm obj referencing another orm" do
+    d = DummyModel.create!(:attr_1 => rand(500), :attr_2 => rand(500))    
+    d2 = DummyModel.create!(:attr_1 => rand(500), :attr_2 => rand(500))
+
+    d.dummy_model = d2
+    d.save!
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(d)
+    end
+  end
+
+  test "to_json obj referencing itself" do
+    d = DummyClass2.new
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(d)
+    end
+  end
+
+  test "array obj referencing itself" do
+    arr=[]
+    arr<<arr
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(arr)
+    end
+  end
+
+  test "hash obj referencing itself" do
+    hash = {}
+    hash[:hash] = hash
+    assert_nothing_raised(Exception) do
+      Cachely::Mechanics.map_param_to_s(hash)
+    end
+  end
+
   test "class conversion" do
     str = Cachely::Mechanics.map_param_to_s(DummyClass)
     reformed = Cachely::Mechanics.map_s_to_param(str)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cachely
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &9945220 !ruby/object:Gem::Requirement
+  requirement: &21983920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *9945220
+  version_requirements: *21983920
 - !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &9958720 !ruby/object:Gem::Requirement
+  requirement: &21982820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *9958720
+  version_requirements: *21982820
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &9954440 !ruby/object:Gem::Requirement
+  requirement: &21997700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9954440
+  version_requirements: *21997700
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &9960660 !ruby/object:Gem::Requirement
+  requirement: &21996800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9960660
+  version_requirements: *21996800
 description: Transparently cache the results of methods using redis.
 email:
 - jordanmprince@gmail.com