local_cache 1.0.0 → 1.2.0

data/README.markdown

@@ -0,0 +1,26 @@
+LocalCache
+==========
+
+A local in memory cache, similar to Rails' built in MemoryStore, but adds more advanced features
+like cache size limit and object expiration / ttl.
+
+Usage
+------
+
+### For Rails
+
+In environment.rb:
+
+    require 'local_cache'
+
+    config.cache_store = LocalCache.new
+
+See rdoc for initialization options such as max size and default ttl.
+
+### For regular usage
+
+    cache = LocalCache.new
+    cache.write("key", value)
+    val = cache.read("key")
+
+

data/lib/local_cache.rb

@@ -1,71 +1,114 @@
-require 'active_support'
-
-module ActiveSupport
-  module Cache
-    class LocalCache < Store
-	  VERSION = '1.0.0'
-      
-	  def initialize(size=1000)
-        puts 'Creating new LocalCache'
-        @size = size
-        # we initialize an empty hash
-        @cache = {}
-        @cache_list = []
-      end
-
-      def get(key)
-        # if the API URL exists as a key in cache, we just return it
-        # we also make sure the data is fresh
-        if @cache.has_key? key
-          expires = @cache[key][0]
-          if expires - Time.now > 0
-#            puts 'returning from cache ' + @cache[key][1].inspect
-            return @cache[key][1]
-          else
-#            puts 'expired=' + key + ' at ' + expires.to_s + ' and now=' + Time.now.to_s
-            delete(key)
-          end
-        else
-#          puts 'cache does not contain ' + key
-        end
-        return nil
-      end
-
-      def put(key, val, seconds_to_store)
-        seconds_to_store = seconds_to_store || 9999999
-#        puts 'seconds=' + seconds_to_store.to_s
-        @cache[key] = [Time.now+seconds_to_store, val]
-        @cache_list << key
-        while @cache.size > @size && @cache_list.size > 0
-          to_remove = @cache_list.pop
-          @cache.delete(to_remove) unless to_remove.nil?
-        end
-      end
-
-      def read(name, options = nil)
-#        puts 'read from localcache'
-        super
-        ret = get(name)
-#        puts 'ret.frozen=' + ret.frozen?.to_s
-        return ret
-      end
-
-      def write(name, value, options = nil)
-        super
-        put(name, value, options.nil? ? nil : options[:expires_in])
-#        puts 'write.frozen=' + value.frozen?.to_s
-      end
-
-      def delete(name, options = nil)
-        super
-        @cache.delete(name)
-      end
-
-      def delete_matched(matcher, options = nil)
-        super
-        raise "delete_matched not supported by LocalCache"
-      end
-
-    end
-  end
-end
+require 'active_support'
+
+
+class LocalCache < ActiveSupport::Cache::Store
+
+    # Initialize a new LocalCache.
+    #
+    # Options:
+    #     :size => 1000 - max number of objects to store
+    #     :ttl => 60 - default ttl (can be overridden on any PUT/WRITE)
+    def initialize(options={})
+        puts 'Creating new LocalCache'
+        @size = options[:size] || 1000
+        @default_expires_in = options[:ttl] || 60
+        # we initialize an empty hash
+        @cache = {}
+        # and a list for pushing objects out
+        @cache_list = []
+    end
+
+    def get(key)
+        # if the API URL exists as a key in cache, we just return it
+        # we also make sure the data is fresh
+        #puts 'looking in cache for: ' + key.to_s
+        if @cache.has_key? key
+            expires = @cache[key][0]
+            #puts 'checking expired=' + key + ' at ' + expires.to_s + ' and now=' + Time.now.to_s
+            if expires - Time.now > 0
+#            puts 'returning from cache ' + @cache[key][1].inspect
+                # todo: implement LRU ordering
+                return @cache[key][1]
+            else
+                #puts 'expired'
+                delete(key)
+            end
+        else
+#          puts 'cache does not contain ' + key
+        end
+        return nil
+    end
+
+    def get_multi(keys, raw=false)
+        ret = {}
+        keys.each do |k|
+            val = get(k)
+            ret[k] = val unless val.nil?
+        end
+        ret
+    end
+
+    def get_i(key)
+        val = get(key)
+        return nil if val.nil?
+        return val.to_i
+    end
+
+    def exist?(key)
+        return !get(key).nil?
+    end
+
+    def increment(key, val=1)
+        ret = get(key)
+        if ret.is_a?(Fixnum)
+            ret += val
+        else
+            ret = val
+            put(key, ret)
+        end
+    end
+
+    def put(key, val, seconds_to_store=999999, raw=false)
+        seconds_to_store = seconds_to_store || @default_expires_in
+        #puts 'seconds=' + seconds_to_store.to_s
+        @cache[key] = [Time.now+seconds_to_store, val]
+        @cache_list << key
+        while @cache.size > @size && @cache_list.size > 0
+            to_remove = @cache_list.pop
+            @cache.delete(to_remove) unless to_remove.nil?
+        end
+    end
+
+    def read(name, options = nil)
+#        puts 'read from localcache'
+        super
+        ret = get(name)
+#        puts 'ret.frozen=' + ret.frozen?.to_s
+        return ret
+    end
+
+    def write(name, value, options = nil)
+        super
+        put(name, value, options.nil? ? nil : options[:expires_in])
+#        puts 'write.frozen=' + value.frozen?.to_s
+    end
+
+    def delete(name, options = nil)
+        super
+        @cache.delete(name)
+    end
+
+    def delete_matched(matcher, options = nil)
+        super
+        raise "delete_matched not supported by LocalCache"
+    end
+
+end
+
+# Backwards compatibility
+module ActiveSupport
+    module Cache
+        class LocalCache < ::LocalCache
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: local_cache
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Travis Reeder
@@ -9,53 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-23 00:00:00 -07:00
+date: 2009-10-21 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.12.2
-    version: 
-description: |-
-  A local in memory cache with max size and expiration.
-  
-  Can be used as a Rails cache too. In environment.rb:
-  
-  require 'local_cache'
-  ActionController::Base.cache_store = :local_cache
-  Activerecordtosdb.cache_store = ActionController::Base.cache_store
-email: 
-- travis@crankapps.com
-executables: 
-- local_cache
+dependencies: []
+
+description: Similar to Rails' built in MemoryStore, but adds size limit and expiration.
+email: travis@appoxy.com
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- README.markdown
 files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- bin/local_cache
 - lib/local_cache.rb
-- test/test_local_cache.rb
+- README.markdown
 has_rdoc: true
-homepage: http://www.crankapps.com
+homepage: http://github.com/appoxy/local_cache/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,10 +47,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: spacegems
-rubygems_version: 1.3.2
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A local in memory cache with max size and expiration
-test_files: 
-- test/test_local_cache.rb
+summary: Similar to Rails' built in MemoryStore, but adds size limit and expiration.
+test_files: []
+

data/History.txt

@@ -1,6 +0,0 @@
-=== 1.0.0 / 2009-04-23
-
-* 1 major enhancement
-
-  * Birthday!
-

data/Manifest.txt

@@ -1,7 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/local_cache
-lib/local_cache.rb
-test/test_local_cache.rb

data/README.txt

@@ -1,54 +0,0 @@
-= local_cache
-
-http://www.crankapps.com
-
-== DESCRIPTION:
-
-A local in memory cache with max size and expiration.
-
-Can be used as a Rails cache too. In environment.rb:
-
-require 'local_cache'
-ActionController::Base.cache_store = :local_cache
-Activerecordtosdb.cache_store = ActionController::Base.cache_store
-
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* FIX (list of requirements)
-
-== INSTALL:
-
-sudo gem install activesupport
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,12 +0,0 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-require './lib/local_cache.rb'
-
-Hoe.new('local_cache', ActiveSupport::Cache::LocalCache::VERSION) do |p|
-  p.rubyforge_name = 'spacegems' # if different than lowercase project name
-  p.developer('Travis Reeder', 'travis@crankapps.com')
-end
-
-# vim: syntax=Ruby

data/bin/local_cache

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-abort "you need to write me"

data/test/test_local_cache.rb

@@ -1,8 +0,0 @@
-require "test/unit"
-require "local_cache"
-
-class TestLocalCache < Test::Unit::TestCase
-  def test_sanity
-    flunk "write tests or I will kneecap you"
-  end
-end