threadsafe-lru 0.0.2

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
+/.rbx

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>threadsafe-lru</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.dltk.core.scriptbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.dltk.ruby.core.nature</nature>
+	</natures>
+</projectDescription>

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dragan Milic
+
+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,52 @@
+# ThreadSafeLru
+
+Thread safe LRU Cache implementation in Ruby compatible with Java's Memory Model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'threadsafe-lru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install threadsafe-lru
+
+## Usage
+
+	# initialize cache with maximum size of 200
+	cache_size=200
+	fib_cache=ThreadSafeLru::LruCache.new 200
+
+	# fetch fibonacci of 42 from cache. only first execution will perform computation (evaluate block)	
+	fib_200 =fib_cache.get(42) {|key| fib(key)}
+	
+	# drop key 42 from the cache
+	fib_cache.drop(42)
+	
+	# clear cache by dropping all cached values
+	fib_cache.clear()	
+
+## Thread safety
+
+	There are two level of locking within the cache.
+	* Cache lock makes sure that cache structure can be accessed only by one thread at the time.
+	* Value lock makes sure that only one thread produces a value for given key at the time. 
+	All other threads interested in obtaining the value for the key are waiting for the first thread to finish
+	
+## Testing
+	
+	ThreadSafeLru has been tested with MRI 1.9.3, Jruby 1.6.2, Jruby 1.7.0.preview1 and Jruby 1.7.0.preview2  
+			
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery {"rspec2"}

data/lib/threadsafe-lru.rb

@@ -0,0 +1,5 @@
+require 'threadsafe-lru/ThreadSafeLruCache'
+
+module ThreadSafeLru
+  
+end

data/lib/threadsafe-lru/DoubleLinkedList.rb

@@ -0,0 +1,6 @@
+module ThreadSafeLru 
+  class DoubleLinkedList
+    
+    
+  end
+end

data/lib/threadsafe-lru/ThreadSafeLruCache.rb

@@ -0,0 +1,81 @@
+require 'thread'
+
+module ThreadSafeLru
+  class LruCache
+    def initialize size, &block
+      @size=size
+      @cached_values={}
+      @factory_block=block
+      @recently_used=[]
+      @lock=Mutex.new
+    end
+
+    def size
+      @recently_used.size
+    end
+
+    
+    def drop key
+      @lock.synchronize do
+        @cached_values.delete key
+        @recently_used.delete key
+      end
+    end
+      
+    
+    def clear
+      @lock.synchronize do
+        @cached_values.clear
+        @recently_used.clear
+      end
+    end
+    
+    def get key, &block
+      node=nil
+      @lock.synchronize do
+        node=get_node(key)
+      end
+      node.get_value(block ? block : @factory_block)
+    end
+
+    private
+
+    def get_node key
+      if @cached_values.has_key?(key)
+        @recently_used.delete(key)
+        @recently_used << key
+      else
+        while (@recently_used.size >= @size) do
+          dropped=@recently_used.shift
+          @cached_values.delete(dropped)
+        end
+        node=Node.new key
+        @cached_values[key]=node
+        @recently_used << key
+      end
+
+      @cached_values[key]
+    end
+
+  end
+
+  class Node
+    def initialize key
+      @key=key
+      @produced=false
+      @value=nil
+      @lock=Mutex.new
+    end
+
+    def get_value block
+      @lock.synchronize do
+        unless (@produced)
+          @value=block.call @key
+          @produced=true
+        end
+        @value
+      end
+    end
+  end
+
+end

data/lib/threadsafe-lru/version.rb

@@ -0,0 +1,3 @@
+module ThreadSafeLru 
+    VERSION = "0.0.2" 
+end

data/spec/threadsafe-lru/ThreadSafeLruCache_spec.rb

@@ -0,0 +1,125 @@
+require 'threadsafe-lru/ThreadSafeLruCache'
+require 'thread'
+
+module ThreadSafeLru
+  describe LruCache do
+
+    subject {LruCache.new(3){|key| "value: #{key}"}}
+
+    describe :get do
+      it "should cache single value" do
+        subject.get(:one){1}.should == 1
+        subject.get(:one){2}.should == 1
+      end
+
+      it "should drop least used value" do
+        subject.get(:one){1}.should == 1
+        subject.get(:two){2}.should == 2
+        subject.get(:three){3}.should == 3
+        subject.get(:four){4}.should == 4
+
+        subject.get(:one){99}.should == 99
+        subject.get(:three){99}.should == 3
+        subject.get(:four){99}.should == 4
+        subject.get(:two){99}.should == 99
+      end
+
+      it "should not corrupt state in highly concurrent situation" do
+
+        cache=subject
+
+        threads=(1..100).map do
+          Thread.new do
+            (0..2000).each do
+              random=rand(2000)
+              cache.get(random) {random}.should == random
+            end
+          end
+        end
+        
+        threads.each {|thread| thread.join}
+
+      end
+
+      it "should make second thread wait for the first requesting thread to value" do
+
+        (1..100).each do
+
+          q1=Queue.new
+          q2=Queue.new
+
+          cache=subject
+
+          t1=Thread.new do
+            cache.get(:one) {
+              q1.pop
+              q2 << 1
+              "thread1"
+            }
+          end
+
+          t2=Thread.new do
+            q2.pop
+            cache.get(:one) {
+              "thread2"
+            }
+          end
+
+          q1<<1
+
+          t1.join
+          t2.join
+
+          cache.get(:one).should == "thread1"
+
+          cache.clear
+
+        end
+      end
+
+    end
+
+    describe :clear do
+      it "should drop all cached values" do
+        subject.get(:one){1}.should == 1
+        subject.get(:one){2}.should == 1
+        subject.clear
+        subject.get(:one){2}.should == 2
+      end
+    end
+
+    describe :drop do
+
+      before do
+        subject.get(:one){"one"}
+        subject.get(:two){"two"}
+      end
+
+      context "when there is a cached value" do
+
+        it "should drop that cached value" do
+          subject.get(:one).should == "one"
+          subject.get(:two).should == "two"
+
+          subject.drop(:one)
+
+          subject.get(:one){"newone"}.should == "newone"
+          subject.get(:two).should == "two"
+        end
+
+      end
+
+      context "when value is not cached" do
+        it "should not drop anything" do
+          subject.drop(:three)
+          subject.get(:one){"newone"}.should == "one"
+          subject.get(:two){"newtwo"}.should == "two"
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/threadsafe-lru.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/threadsafe-lru/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dragan Milic"]
+  gem.email         = ["dragan@netice9.com"]
+  gem.description   = %q{Thread safe implemenation of in-memory LRU cache compatible with Java Memory Model}
+  gem.summary       = %q{Thread safe in memory LRU cache}
+  gem.homepage      = "https://github.com/draganm/threadsafe-lru"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "threadsafe-lru"
+  gem.require_paths = ["lib"]
+  gem.version       = ThreadSafeLru::VERSION
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'autotest'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: threadsafe-lru
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.2
+platform: ruby
+authors:
+- Dragan Milic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: autotest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: Thread safe implemenation of in-memory LRU cache compatible with Java Memory Model
+email:
+- dragan@netice9.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .project
+- LICENSE
+- README.md
+- autotest/discover.rb
+- lib/threadsafe-lru.rb
+- lib/threadsafe-lru/DoubleLinkedList.rb
+- lib/threadsafe-lru/ThreadSafeLruCache.rb
+- lib/threadsafe-lru/version.rb
+- spec/threadsafe-lru/ThreadSafeLruCache_spec.rb
+- threadsafe-lru.gemspec
+homepage: https://github.com/draganm/threadsafe-lru
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Thread safe in memory LRU cache
+test_files:
+- spec/threadsafe-lru/ThreadSafeLruCache_spec.rb
+...