lrucache 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2@lrucache

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in lrucache.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :cli => '-c --format documentation -r ./spec/spec_helper.rb',
+               :version => 2 do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})        { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')    { "spec" }
+end

data/README.md

@@ -0,0 +1,40 @@
+lrucache - A simple LRU-cache based on a hash and a priority queue.
+
+Setup
+=====
+gem install lrucache
+
+Example
+=======
+    require 'lrucache'
+    cache = LRUCache.new(:max_size => 3, :default => 42)
+    cache[1] = 'a'
+    cache[2] = 'b'
+    cache[3] = 'c'
+    puts cache[2] # b
+    puts cache[1] # a
+    puts cache[3] # c
+    puts cache[:does_not_exist] # 42, has no effect on LRU.
+    cache[4] = 'd' # Out of space! Throws out the least-recently used (2 => 'b').
+    puts cache.keys # [1,3,4]
+
+
+TTL (time-to-live)
+==================
+    cache = LRUCache.new(:expires => 1.hour)
+    cache.store("banana", "yellow")
+    cache.store("monkey", "banana", Time.now + 3.days)
+    # or ...
+    cache.store("monkey", "banana", 3.days)
+
+    # Three minutes later ...
+    cache.fetch("banana") # "yellow"
+    cache.fetch("monkey") # "banana"
+
+    # Three hours later ...
+    cache.fetch("banana") # nil
+    cache.fetch("monkey") # "banana"
+    
+    # Three days later ...
+    cache.fetch("banana") # nil
+    cache.fetch("monkey") # nil

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = [
+    '-c',
+    '--format documentation',
+    '-r ./spec/spec_helper.rb'
+  ]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "open coverage report"
+task :coverage do
+  system 'rake spec'
+  system 'open coverage/index.html'
+end
+
+desc "Open development console"
+task :console do
+  puts "Loading development console..."
+  system "irb -I #{File.join('.', 'lib')} -r #{File.join('.', 'lib', 'lrucache')}"
+end

data/lib/lrucache.rb

@@ -0,0 +1,93 @@
+require "lrucache/version"
+require "priority_queue"
+
+# Not thread-safe!
+class LRUCache
+
+  attr_reader :default, :max_size
+
+  def initialize(opts={})
+    @max_size = (opts[:max_size] || 100).to_i
+    @default = opts[:default]
+    @expires = (opts[:expires] || 0).to_f
+    raise "max_size must be greather than zero" unless @max_size > 0
+    @pqueue = PriorityQueue.new
+    @data = {}
+    @counter = 0
+  end
+
+  def clear
+    @data.clear
+    @pqueue.delete_min until @pqueue.empty?
+  end
+
+  def include?(key)
+    datum = @data[key]
+    return false if datum.nil?
+    value, expires = datum
+    if expires.nil? || expires > Time.now # no expiration, or not expired
+      access(key)
+      true
+    else # expired
+      delete(key)
+      false
+    end
+  end
+
+  def store(key, value, expires=nil)
+    expire_lru! unless @data.include?(key) || @data.size < @max_size
+    expiration =
+      if expires.nil?
+        (@expires > 0) ? (Time.now + @expires) : nil
+      elsif expires.is_a?(Time)
+        expires
+      else
+        expires = expires.to_f
+        (expires > 0) ? (Time.now + expires) : nil
+      end
+    @data[key] = [value, expiration]
+    access(key)
+  end
+
+  alias :[]= :store
+
+  def fetch(key)
+    datum = @data[key]
+    return @default if datum.nil?
+    value, expires = datum
+    if expires.nil? || expires > Time.now # no expiration, or not expired
+      access(key)
+      value
+    else # expired
+      delete(key)
+      @default
+    end
+  end
+
+  alias :[] :fetch
+
+  def size
+    @data.size
+  end
+
+  def keys
+    @data.keys
+  end
+
+  def delete(key)
+    @data.delete(key)
+    @pqueue.delete(key)
+  end
+
+  private
+
+  def expire_lru!
+    key, priority = @pqueue.delete_min
+    @data.delete(key) unless priority.nil?
+  end
+
+  def access(key)
+    @pqueue.change_priority(key, @counter += 1)
+  end
+
+end

data/lib/lrucache/version.rb

@@ -0,0 +1,3 @@
+class LRUCache
+  VERSION = "0.0.1"
+end

data/lrucache.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lrucache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lrucache"
+  s.version     = LRUCache::VERSION
+  s.authors     = ["Chris Johnson"]
+  s.email       = ["chris@kindkid.com"]
+  s.homepage    = ""
+  s.summary     = "A simple LRU-cache based on a hash and priority queue"
+  s.description = s.summary
+
+  s.rubyforge_project = "lrucache"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency "PriorityQueue", '~> 0.1.2'
+  
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "simplecov", "~> 0.4.2"
+  s.add_development_dependency("rb-fsevent", "~> 0.4.3") if RUBY_PLATFORM =~ /darwin/i
+  s.add_development_dependency "guard", "~> 0.6.2"
+  s.add_development_dependency "guard-bundler", "~> 0.1.3"
+  s.add_development_dependency "guard-rspec", "~> 0.4.2"
+  s.add_development_dependency "timecop", "~> 0.3.5"
+end

data/spec/lrucache_spec.rb

@@ -0,0 +1,102 @@
+describe LRUCache do
+  it "should never exceed its max_size" do
+    c = LRUCache.new(:max_size => 7)
+    (1..100).each do |i|
+      c[i] = rand(2**16)
+      c.size.should <= 7
+    end
+    c.size.should == 7
+  end
+
+  it "should expire the eldest entries first" do
+    c = LRUCache.new(:max_size => 3)
+    c[1] = 'a'
+    c[2] = 'b'
+    c[3] = 'c'
+    c[2].should == 'b'
+    c[1].should == 'a'
+    c[3].should == 'c'
+    c[4] = 'd' # Out of space! Throws out the least-recently used (2 => 'b').
+    c.keys.sort.should == [1,3,4]
+    c[5] = 'e'
+    c.keys.sort.should == [3,4,5]
+    c[1] = 'a'
+    c.keys.sort.should == [1,4,5]
+  end
+
+  it "should return the default value for expired and non-existent entries" do
+    default = double(:default)
+    c = LRUCache.new(:max_size => 3, :default => default)
+    c[:a].should == default
+    c[:a] = 'a'
+    c[:a].should == 'a'
+    c[:b] = 'b'
+    c[:c] = 'c'
+    c[:d] = 'd'
+    c[:a].should == default
+  end
+
+  it "should honor TTL" do
+    c = LRUCache.new(:expires => 20)
+    now = Time.now
+    Timecop.freeze(now) do
+      c.store(:a, 'a')
+      c.store(:b, 'b', now + 50)
+      c.store(:c, 'c', 50)
+      c[:a].should == 'a'
+      c[:b].should == 'b'
+      c[:c].should == 'c'
+      c.size.should == 3
+    end
+    Timecop.freeze(now + 19) do
+      c[:a].should == 'a'
+      c[:b].should == 'b'
+      c[:c].should == 'c'
+      c.size.should == 3
+    end
+    Timecop.freeze(now + 49) do
+      c[:a].should be_nil
+      c[:b].should == 'b'
+      c[:c].should == 'c'
+      c.size.should == 2
+    end
+    Timecop.freeze(now + 50) do
+      c[:a].should be_nil
+      c[:b].should be_nil
+      c[:c].should be_nil
+      c.size.should == 0
+    end
+    c[:a].should be_nil
+    c[:b].should be_nil
+    c[:c].should be_nil
+    c.size.should == 0
+  end
+
+  it "should have a default max_size of 100" do
+    LRUCache.new.max_size.should == 100
+    LRUCache.new(:max_size => 82).max_size.should == 82
+  end
+
+  it "can be cleared" do
+    c = LRUCache.new
+    (1..100).each {|i| c[i] = rand(2**16)}
+    c.size.should == 100
+    c.clear
+    c.size.should == 0
+    c.keys.should == []
+  end
+
+  describe ".include?(key)" do
+    it "affects the access time of the key" do
+      c = LRUCache.new(:max_size => 3)
+      c[1] = 'a'
+      c[2] = 'b'
+      c[3] = 'c'
+      c.include?(1).should be_true
+      c[4] = 'd'
+      c[5] = 'e'
+      c.include?(1).should be_true
+      c.include?(2).should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  add_group "Models", "lib"
+end
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :test, :development)

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification 
+name: lrucache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: PriorityQueue
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 6
+        - 2
+        version: 0.6.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :development
+  version_requirements: *id008
+description: A simple LRU-cache based on a hash and priority queue
+email: 
+- chris@kindkid.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/lrucache.rb
+- lib/lrucache/version.rb
+- lrucache.gemspec
+- spec/lrucache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+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: lrucache
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple LRU-cache based on a hash and priority queue
+test_files: 
+- spec/lrucache_spec.rb
+- spec/spec_helper.rb