simple_cache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 lfborjas
+
+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/README.rdoc

@@ -0,0 +1,32 @@
+= simple_cache
+
+Simple cache store. For now, only a memory based solution exists.
+
+Based on ActiveRecord::Cache
+
+It works like a hash, but stores the last access to a key to expire it after a given time. Also
+accepts a  `max_size` for limiting the cache growth. 
+
+= Usage
+
+    store = SimpleCache::MemoryCache.new :timeout => 10 #seconds
+    store[:foo] = "bar"
+    puts store[:foo] #=> "bar"
+    sleep 10
+    puts store[:foo] #=> nil
+
+== Contributing to simple_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 lfborjas. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple_cache"
+  gem.homepage = "http://github.com/lfborjas/simple_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{General purpose cache}
+  gem.description = %Q{Pure ruby caching solution, inspired by ActiveRecord::Cache}
+  gem.email = "luisfelipe@lfborjas.com"
+  gem.authors = ["lfborjas"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/simple_cache.rb

@@ -0,0 +1,97 @@
+=begin
+Code taken mostly from ActiveRecord::Cache
+Copyright (c) 2005-2011 David Heinemeier Hansson
+
+ 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.
+
+=end
+require 'digest/md5'
+module SimpleCache
+    #TODO: add a super-class and implement FileSystemCache
+    class MemoryCache
+        
+        attr_reader :cache_size 
+
+        def initialize(options = {})
+            @cache = {}
+            @cache_size = 0
+            @key_access = {}
+            @max_size = options[:max_size] || 32 * 1024 #32 megabytes
+            @timeout  = options[:timeout]  || 60*30 #30 minutes
+        end
+        
+        def encode(key)
+            Digest::MD5.hexdigest key
+        end
+        
+        def delete(key)
+            entry = @cache.delete key
+            @key_access.delete key
+            @cache_size -= entry.size
+        end
+
+        def [](key)
+            key = encode(key)
+            entry = @cache[key]
+            if entry
+                @key_access[key] = Time.now.to_f
+            else
+                @key_access.delete key
+            end
+            entry
+        end
+        
+        def []=(key, value)
+           key = encode(key)
+           old_entry = @cache[key]
+           @cache_size -= old_entry.size if old_entry
+           @key_access[key] = Time.now.to_f
+           @cache[key] = value
+           @cache_size += value.size
+           prune if @cache_size > @max_size
+        end
+
+        def has_key?(key)
+            !!@cache[encode(key)]
+        end
+
+        def prune
+            #first, the obvious cleanup
+            @cache.keys.each do |key|
+                delete(key) if stale? key
+            end
+
+            #now, try to leave it a 3/4 of it's capacity
+            target_size = 0.75 * @max_size
+
+            #delete the older entries
+            sorted_keys = @key_access.keys.sort{|a,b| @key_access[a].to_f <=> @key_access[b].to_f}
+            sorted_keys.each do |key|
+                return if @cache_size <= target_size
+                delete key
+            end
+        end
+
+        def stale?(key)
+            (Time.now.to_f - @key_access[key]) > @timeout.to_f
+        end
+
+    end
+end

data/spec/simple_cache_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SimpleCache" do
+
+  before :each do
+      @timeout = 5 #seconds
+      @max_size= 16 #bytes
+      @store = SimpleCache::MemoryCache.new :timeout => @timeout, :max_size=> @max_size
+  end
+
+  it "should store a value" do
+      @store["foo"] = "bar"
+      @store.has_key?("foo").should == true
+      @store.cache_size.should == "bar".size
+  end
+
+  it "should retrieve a value" do
+    @store["foo"] = "bar"
+    @store["foo"].should == "bar"
+  end
+
+  it "should assert the presence of keys" do
+      @store["foo"] = "bar"
+      @store.has_key?("foo").should == true
+  end
+
+  it "should prune the cache based on size" do
+    @store["first"]  = "z"*4
+    @store["second"] = "y"*4
+    @store["third"]  = "x"*4
+    @store["fourth"] = "b"*4
+    @store["fifth"] =  "a"*4
+
+    @store.cache_size.should == 12
+
+    %w{fifth fourth third}.each do |key|
+        @store.has_key?(key).should == true
+    end
+
+    %w{first second}.each do |key|
+        @store.has_key?(key).should == false
+    end
+
+  end
+  
+  it "should prune the cache based on time" do 
+    @store["first"]  = "z"*4
+    @store["second"] = "y"*4
+    @store["third"]  = "n"*4
+
+    sleep @timeout+2
+
+    @store["third"] = "x"*4
+    @store["fourth"] = "a"*5
+
+    @store.cache_size.should == 9
+
+    %w{fourth third}.each do |key|
+        @store.has_key?(key).should == true
+    end
+    
+    %w{first second}.each do |key|
+        @store.has_key?(key).should == false
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'simple_cache'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: simple_cache
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- lfborjas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  requirement: *id004
+  type: :development
+description: Pure ruby caching solution, inspired by ActiveRecord::Cache
+email: luisfelipe@lfborjas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple_cache.rb
+- spec/simple_cache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/lfborjas/simple_cache
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: General purpose cache
+test_files: 
+- spec/simple_cache_spec.rb
+- spec/spec_helper.rb