lru_redux 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e9a008051600ae0ef7295fcbd1826f9577e9651
+  data.tar.gz: 92cfb4d20f44bf999b1bfd113dc517ed902af2d3
+SHA512:
+  metadata.gz: 7687af703aec4575050e5bff2f2e4d0f7d50137e427f3b1ef734de963b39ef291950afe023b448a7d9a27f175b38efacbccdd4d149d153b24e745b3af2e66004
+  data.tar.gz: ef7357e9b3c1940ccc6552c261e906094bb1065bfc38eccae83db8386d564f0bb425ae0a91b834c77b7fec2e5dca58ef6ca1edfa05ce02139e58579433e2843e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'minitest', :focus_on_failed => true do
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^lib/lru_redux/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Saffron
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+# LruRedux
+
+An efficient thread safe lru cache.
+
+Lru Redux uses a Hash/Double link list backed storage to keep track of nodes in a cache based on last usage.
+
+This provides a correct and well specified LRU cache, that is very efficient. Additionally you can optionally use a thread safe wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lru_redux'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lru_redux
+
+## Usage
+
+```ruby
+require 'lru_redux'
+# non thread safe
+cache = LruRedux::Cache(100)
+cache[:a] = "1"
+cache.to_a
+# [[:a,"1"]]
+cache.delete(:a)
+cache.each {|k,v| p "#{k} #{v}"}
+# nothing
+
+# for thread safe
+cache = LruRedux::ThreadSafeCache(100)
+
+```
+
+## Benchmarks
+
+see: benchmark directory
+
+```
+sam@ubuntu:~/Source/lru_redux/bench$ ruby ./bench.rb
+Rehearsal ---------------------------------------------------------
+thread safe lru        27.940000   0.020000  27.960000 ( 28.000938)
+lru gem                 2.300000   0.000000   2.300000 (  2.305732)
+lru_cache gem           1.960000   0.010000   1.970000 (  1.975683)
+lru_redux gem           1.710000   0.000000   1.710000 (  1.704134)
+lru_redux thread safe   2.830000   0.000000   2.830000 (  2.837608)
+----------------------------------------------- total: 36.770000sec
+
+                            user     system      total        real
+thread safe lru        27.740000   0.000000  27.740000 ( 27.756163)
+lru gem                 2.250000   0.000000   2.250000 (  2.252772)
+lru_cache gem           1.960000   0.000000   1.960000 (  1.963679)
+lru_redux gem           1.710000   0.000000   1.710000 (  1.712147)
+lru_redux thread safe   2.750000   0.000000   2.750000 (  2.752526)
+
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end

data/bench/bench.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require "lru"
+require "benchmark"
+require "lru_cache"
+require "threadsafe-lru"
+$LOAD_PATH.unshift File.expand_path '../lib'
+require File.expand_path('../../lib/lru_redux', __FILE__)
+
+lru = Cache::LRU.new(max_elements: 1_000)
+lru_cache = LRUCache.new(1_000)
+
+lru_redux = LruRedux::Cache.new(1_000)
+lru_redux_thread_safe = LruRedux::ThreadSafeCache.new(1_000)
+thread_safe_lru = ThreadSafeLru::LruCache.new(1_000)
+
+bm = Benchmark.bmbm do |bm|
+
+  bm.report "thread safe lru" do
+    1_000_000.times do
+      thread_safe_lru.get(rand(2_000)){ :value }
+    end
+  end
+
+  [
+    [lru, "lru gem"],
+    [lru_cache, "lru_cache gem"],
+    [lru_redux, "lru_redux gem"],
+    [lru_redux_thread_safe, "lru_redux thread safe"]
+  ].each do |cache, name|
+    bm.report name do
+      1_000_000.times do
+        cache[rand(2_000)] ||= :value
+      end
+    end
+  end
+end

data/lib/lru_redux/cache.rb

@@ -0,0 +1,128 @@
+class LruRedux::Cache
+
+  # for high efficiency nodes in double linked list are stored in arrays
+  # [prev,key,val,next]
+
+  def initialize(size)
+    @size = size
+    @data = {}
+    @head = nil
+    @tail = nil
+  end
+
+  def [](key)
+    node = @data[key]
+    if node
+      move_to_head(node)
+      node.value
+    end
+  end
+
+  def []=(key,val)
+    node = @data[key]
+    if node
+      move_to_head(node)
+      node.value = val
+    else
+      pop_tail
+      @data[key] = add_to_head(key,val)
+    end
+    val
+  end
+
+  def each
+    if n = @head
+      while n
+        yield [n.key, n.value]
+        n = n.prev
+      end
+    end
+  end
+
+  # used further up the chain, non thread safe each
+  alias_method :each_unsafe, :each
+
+  def to_a
+    a = []
+    self.each_unsafe do |k,v|
+      a << [k,v]
+    end
+    a
+  end
+
+  def delete(k)
+    node = @data[k]
+    if node
+      @data.delete(k)
+      prev = node.prev
+      nex = node.next
+
+      prev.next = nex if prev
+      nex.prev = prev if nex
+    end
+  end
+
+  def count
+    @data.count
+  end
+
+  # for cache validation only, ensures all is sound
+  def valid?
+    expected = {}
+    self.each_unsafe do |k,v|
+      expected[k] = v
+    end
+    expected == @data
+  end
+
+  protected
+
+  def add_to_head(key,val)
+    if @head.nil?
+      @tail = @head = Node.new(key,val,nil,nil)
+    else
+      node = Node.new(key,val,@head,nil)
+      @head = @head.next = node
+    end
+  end
+
+  def move_to_head(node)
+    return unless @head && node != @head
+
+    prev = node.prev
+    nex = node.next
+
+    if prev
+      prev.next = nex
+    else
+      @tail = nex
+    end
+
+    if nex
+      nex.prev = prev
+    end
+
+    @head.next = node
+    node.prev = @head
+    @head = node
+  end
+
+  def pop_tail
+    if @data.length == @size
+      @data.delete(@tail.key)
+      @tail = @tail.next
+      @tail.prev = nil
+    end
+  end
+
+
+  class Node
+    attr_accessor :key, :value, :next, :prev
+    def initialize(key,value,prev,nex)
+      self.key = key
+      self.value = value
+      self.prev = prev
+      self.next = nex
+    end
+  end
+end

data/lib/lru_redux/thread_safe_cache.rb

@@ -0,0 +1,20 @@
+require 'thread'
+class LruRedux::ThreadSafeCache < LruRedux::Cache
+  def initialize(size)
+    @lock = Mutex.new
+    super(size)
+  end
+
+  def self.synchronize(*methods)
+    methods.each do |method|
+      define_method method do |*args, &blk|
+      @lock.synchronize do
+          super(*args,&blk)
+        end
+      end
+    end
+  end
+
+  synchronize :[], :[]=, :each, :to_a, :delete, :count, :valid?
+
+end

data/lib/lru_redux/version.rb

@@ -0,0 +1,3 @@
+module LruRedux
+  VERSION = "0.0.1"
+end

data/lib/lru_redux.rb

@@ -0,0 +1,4 @@
+module LruRedux; end
+require "lru_redux/version"
+require "lru_redux/cache"
+require "lru_redux/thread_safe_cache"

data/lru_redux.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lru_redux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lru_redux"
+  spec.version       = LruRedux::VERSION
+  spec.authors       = ["Sam Saffron"]
+  spec.email         = ["sam.saffron@gmail.com"]
+  spec.description   = %q{An efficient implementation of an lru cache}
+  spec.summary       = %q{An efficient implementation of an lru cache}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "rb-inotify"
+end

data/test/cache_test.rb

@@ -0,0 +1,50 @@
+require 'lru_redux'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+class CacheTest < MiniTest::Unit::TestCase
+  def setup
+    @c = LruRedux::Cache.new(3)
+  end
+
+  def test_drops_old
+    @c[:a] = 1
+    @c[:b] = 2
+    @c[:c] = 3
+    @c[:d] = 4
+
+    assert_equal [[:d,4],[:c,3],[:b,2]], @c.to_a
+    assert_nil @c[:a]
+  end
+
+  def test_pushes_lru_to_back
+    @c[:a] = 1
+    @c[:b] = 2
+    @c[:c] = 3
+
+    @c[:a]
+    @c[:d] = 4
+
+    assert_equal [[:d,4],[:a,1],[:c,3]], @c.to_a
+    assert_nil @c[:b]
+  end
+
+
+  def test_delete
+    @c[:a] = 1
+    @c[:b] = 2
+    @c[:c] = 3
+
+    @c.delete(:b)
+    assert_equal [[:c,3],[:a,1]], @c.to_a
+    assert_nil @c[:b]
+  end
+
+  def test_update
+    @c[:a] = 1
+    @c[:b] = 2
+    @c[:c] = 3
+    @c[:a] = 99
+    assert_equal [[:a,99],[:c,3],[:b,2]], @c.to_a
+  end
+end

data/test/thread_safe_cache_test.rb

@@ -0,0 +1,22 @@
+require 'lru_redux'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+class ThreadSafeCacheTest < MiniTest::Unit::TestCase
+  def test_additions
+    cache = LruRedux::ThreadSafeCache.new(1000)
+    threads = []
+    4.times do |t|
+      threads << Thread.new do
+        250.times do |i|
+          cache[i] = "#{t} #{i}"
+        end
+      end
+    end
+
+    threads.each{|t| t.join}
+    assert_equal cache.count,250
+    assert true, cache.valid?
+
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: lru_redux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Saffron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An efficient implementation of an lru cache
+email:
+- sam.saffron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bench/bench.rb
+- lib/lru_redux.rb
+- lib/lru_redux/cache.rb
+- lib/lru_redux/thread_safe_cache.rb
+- lib/lru_redux/version.rb
+- lru_redux.gemspec
+- test/cache_test.rb
+- test/thread_safe_cache_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: An efficient implementation of an lru cache
+test_files:
+- test/cache_test.rb
+- test/thread_safe_cache_test.rb