cachely 0.0.2 → 0.0.3

data/README.md

@@ -10,7 +10,7 @@ Transparent method level caching using redis. Event machine optional.
 			cachely :foo
 			
 			def foo
-				sleep(10)
+				sleep(10) #Simulate blocking with a 10s sleep. Could be an ARModel.all command? An API call?
 				return rand(500) #Holy moly, what a HUGE, LONG CALL! Returns a different value every time.
 			end
 		
@@ -56,7 +56,7 @@ use
 
 		cachely :foo, time_to_expiry: 3.minutes
 		
-If you have a class method of the same name as an instance variable,
+If you have a class method of the same name as an instance method,
 
 		cachely :foo
 		
@@ -69,7 +69,10 @@ keyed locations, of course. To specify instance or class method, do
 Cachely is able to figure out whether or not to use the cache by looking at the arguments you pass in.
 Generally, if your arguments are the same, and the object you're calling the method on is the same(Cachely uses 
 the to_json method on the object you call the method on to determine this), then it assumes the result
-will be the same and uses the cached result. 
+will be the same and uses the cached result.
+
+Cachely expects that any objects you return or pass in to methods as arguments have to_json methods. Without
+this, it won't work. 
 
 CAVEAT: 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,

data/lib/cachely/mechanics.rb

@@ -86,12 +86,11 @@ module Cachely
     # Converts method name and arguments into a coherent key. Creates a hash and to_jsons it
     # And that becomes the redis key. Spiffy, I know.
     #
-    # @method [String,Symbol] The method name
+    # @method [Object, Symbol, Args] The context, method name symbol, and args.
     # @return [String] The proper redis key to be used in storage.
-    def self.redis_key(obj, method, *args)
+    def self.redis_key(context, method, *args)
       map_param_to_s({
-        :obj => obj.to_s.match(/^#</) ? "instance:#{obj.class}" : obj.to_s,
-        :attributes => obj.to_json, #Best way to identify objects is to just to_json them.
+        :context => context,
         :method => method,
         :args => args
       })
@@ -132,9 +131,10 @@ module Cachely
     # @s The string to convert
     # @return The respawned object
     def self.map_s_to_obj(s)
-      type = s.split(":").first
-      data = s.gsub(/^#{type}:/,'')
-      
+      class_or_instance = s.split("|").first
+      type = s.split("|")[1]
+      data = s.gsub(/^#{class_or_instance}\|#{type}\|/,'')
+
       case type
       when "TrueClass"
         return true
@@ -151,10 +151,12 @@ module Cachely
       when "NilClass"
         return nil
       else
-        obj = Object.const_get(type).new
+        class_or_instance == "instance" ? obj = Object.const_get(type).new : obj = Object.const_get(type)
+
         JSON.parse(data).each do |key, value|
-          obj.send(key+"=",value)
+          obj.send(key+"=",value) if obj.respond_to?(key+"=")
         end
+
         return obj
       end
     end 
@@ -170,24 +172,31 @@ module Cachely
       elsif(p.is_a?(Array))
         return map_array_to_s(p)
       elsif(p.respond_to?("to_json"))
-        #below do extra search if string bc string puts annoying quotes in json like "\"1\""
-        #breaks the parser on the return translation.
         translated = nil
+
         if p.is_a?(String)
-          translated = p
+          translated = "instance|"+p.class.to_s+"|"+p
         elsif p.is_a?(Symbol)
-          translated = p.to_s
+          translated = "instance|"+p.class.to_s+"|"+p.to_s
         elsif p.nil?
-          translated = "nil"
+          translated = "instance|NilClass|nil"
+        elsif p.is_a?(TrueClass)
+          translated = "instance|TrueClass|true"
+        elsif p.is_a?(FalseClass)
+          translated = "instance|FalseClass|false"
+        elsif p.is_a?(Fixnum)
+          translated = "instance|Fixnum|" + p.to_s
+        elsif p.is_a?(Float)
+          translated = "instance|Float|" + p.to_s
         elsif p.is_a?(ActiveRecord::Base)
           #don't want { "dummy_model" = > {:attributes => 1}}
           #want {:attributes => 1}
-          translated = JSON.parse(p.to_json)[p.class.to_s.underscore].to_json
-        else
-          translated = p.to_json
+          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
         end
         
-        return p.class.to_s + ":" + translated
+        return translated
       end
     end
     
@@ -215,4 +224,4 @@ module Cachely
     
 
   end
-end
+end

data/lib/cachely/version.rb

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

data/test/unit/cachely_test.rb

@@ -135,7 +135,7 @@ class CachelyTest < BaseTest
     klazz = DummyClass
     assert_not_equal(obj.class_diff, klazz.class_diff)
   end
-  
+ 
   test "cache expires" do
     obj = DummyClass.new
     old = obj.cache_expiry

data/test/unit/conversions_test.rb

@@ -17,7 +17,6 @@ class ConversionsTest < BaseTest
       :method => :foo,
       :args => [3,4]
     })
-    assert_equal("{\"Symbol:method\":\"Symbol:foo\",\"Symbol:args\":\"[\\\"Fixnum:3\\\",\\\"Fixnum:4\\\"]\"}",str)
     reformed = Cachely::Mechanics.map_s_to_param(str)
     assert_equal(2, reformed.keys.size)
     assert_equal(:foo, reformed[:method])
@@ -37,6 +36,12 @@ class ConversionsTest < BaseTest
     reformed = Cachely::Mechanics.map_s_to_param(str)
     assert_equal(d.random_no, reformed.random_no)
   end
+
+  test "class conversion" do
+    str = Cachely::Mechanics.map_param_to_s(DummyClass)
+    reformed = Cachely::Mechanics.map_s_to_param(str)
+    assert_equal(reformed, DummyClass)
+  end
   
   test "orm conversion" do
     d = DummyModel.create!(:attr_1 => rand(500), :attr_2 => rand(500))
@@ -48,21 +53,21 @@ class ConversionsTest < BaseTest
   end
   
   test "primitives conversion" do
-    assert_equal("TrueClass:true", Cachely::Mechanics.map_param_to_s(true))
-    assert_equal("FalseClass:false", Cachely::Mechanics.map_param_to_s(false))
-    assert_equal("Fixnum:1", Cachely::Mechanics.map_param_to_s(1))
-    assert_equal("Float:1.1", Cachely::Mechanics.map_param_to_s(1.1))
-    assert_equal("String:1", Cachely::Mechanics.map_param_to_s("1"))   
-    assert_equal("NilClass:nil", Cachely::Mechanics.map_param_to_s(nil))    
-    assert_equal("Symbol:shit", Cachely::Mechanics.map_param_to_s(:shit))    
-    assert_equal(true, Cachely::Mechanics.map_s_to_param("TrueClass:true"))
-    assert_equal(false, Cachely::Mechanics.map_s_to_param("FalseClass:false"))
-    assert_equal(1, Cachely::Mechanics.map_s_to_param("Fixnum:1"))
-    assert_equal(1.1, Cachely::Mechanics.map_s_to_param("Float:1.1"))
-    assert_equal("1", Cachely::Mechanics.map_s_to_param("String:1"))
-    assert_equal("1:2", Cachely::Mechanics.map_s_to_param("String:1:2"))
-    assert_equal(:shit, Cachely::Mechanics.map_s_to_param("Symbol:shit"))
-    assert_equal(nil, Cachely::Mechanics.map_s_to_param("NilClass:nil"))
+    assert_equal("instance|TrueClass|true", Cachely::Mechanics.map_param_to_s(true))
+    assert_equal("instance|FalseClass|false", Cachely::Mechanics.map_param_to_s(false))
+    assert_equal("instance|Fixnum|1", Cachely::Mechanics.map_param_to_s(1))
+    assert_equal("instance|Float|1.1", Cachely::Mechanics.map_param_to_s(1.1))
+    assert_equal("instance|String|1", Cachely::Mechanics.map_param_to_s("1"))   
+    assert_equal("instance|NilClass|nil", Cachely::Mechanics.map_param_to_s(nil))    
+    assert_equal("instance|Symbol|shit", Cachely::Mechanics.map_param_to_s(:shit))    
+    assert_equal(true, Cachely::Mechanics.map_s_to_param("instance|TrueClass|true"))
+    assert_equal(false, Cachely::Mechanics.map_s_to_param("instance|FalseClass|false"))
+    assert_equal(1, Cachely::Mechanics.map_s_to_param("instance|Fixnum|1"))
+    assert_equal(1.1, Cachely::Mechanics.map_s_to_param("instance|Float|1.1"))
+    assert_equal("1", Cachely::Mechanics.map_s_to_param("instance|String|1"))
+    assert_equal("1|2", Cachely::Mechanics.map_s_to_param("instance|String|1|2"))
+    assert_equal(:shit, Cachely::Mechanics.map_s_to_param("instance|Symbol|shit"))
+    assert_equal(nil, Cachely::Mechanics.map_s_to_param("instance|NilClass|nil"))
     
   end
-end
+end

metadata

@@ -1,71 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cachely
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Jordan Prince
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: redis
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &16110720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *16110720
+- !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &16121280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *16121280
+- !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &16118820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *16118820
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &16116540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *16116540
 description: Transparently cache the results of methods using redis.
-email: 
+email:
 - jordanmprince@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -84,40 +80,31 @@ files:
 - test/unit/cachely_test.rb
 - test/unit/conversions_test.rb
 - test/unit/mechanics_test.rb
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -39538212363365102
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -39538212363365102
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Transparently cache the results of methods using redis.
-test_files: 
+test_files:
 - test/models/dummy_class.rb
 - test/models/dummy_model.rb
 - test/unit/base_test.rb