syncache 1.0.0 → 1.2

data/syncache.gemspec

@@ -1,63 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{syncache}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Dmitry Borodaenko", "David Czarnecki"]
-  s.date = %q{2010-05-06}
-  s.description = %q{SynCache::Cache stores cached objects in a Hash that is protected by an advanced two-level locking mechanism. Two-level locking ensures that:
-
-        * Multiple threads can add and fetch objects in parallel without stepping on each other's toes.
-        * While one thread is working on a cache entry, other threads can access the rest of the cache with no waiting on the global lock, no race conditions nor deadlock or livelock situations.
-        * While one thread is performing a long and resource-intensive operation, other threads that request the same data with fetch_or_add() method will be put on hold, and as soon as the first thread completes the operation, the result will be returned to all threads. Without this feature, a steady stream of requests with less time between them than it takes to complete one request can easily bury a server under an avalanche of threads all wasting resources on the same expensive operation.
-
-    When number of cache entries exceeds the size limit, the least recently accessed entries are replaced with new data. This replacement strategy is controlled by the SynCache::CacheEntry class and can be changed by overriding its replacement_index() method.
-
-    Cache entries are automatically invalidated when their ttl (time to live) is exceeded. Entries can be explicitly invalidated by flush() method. The method can use === operator to compare cache keys against flush base (so that base can be e.g. a Regexp), and invalidates all entries when invoked without the base parameter.
-
-    The flush_delay initialization option allows to limit cache's flush rate. When this option is set, SynCache will make sure that at least this many seconds (it can also be a fraction) pass between two flushes. When extra flushes are requested, invalidation of flushed entries is postponed until earliest time when next flush is allowed.
-    }
-  s.email = %q{angdraug@debian.org}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/syncache.rb",
-     "lib/syncache_sync_patch.rb",
-     "syncache.gemspec",
-     "test/helper.rb",
-     "test/test_syncache.rb"
-  ]
-  s.homepage = %q{http://github.com/czarneckid/syncache}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{SynCache is a thread-safe time-limited cache with flexible replacement policy and ability to wrap generation of expensive cache entries in synchronized blocks. SynCache was used in the Samizdat open publishing engine since 2005, and now it's released as a stand-alone module ready for use in other applications.}
-  s.test_files = [
-    "test/helper.rb",
-     "test/test_syncache.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+Gem::Specification.new do |spec|
+  spec.name        = 'syncache'
+  spec.version     = '1.2'
+  spec.author      = 'Dmitry Borodaenko'
+  spec.email       = 'angdraug@debian.org'
+  spec.homepage    = 'https://github.com/angdraug/syncache'
+  spec.summary     = 'Thread-safe time-limited cache with flexible replacement policy'
+  spec.description = <<-EOF
+SynCache stores cached objects in a Hash that is protected by an advanced
+two-level locking mechanism which ensures that:
+
+ * Multiple threads can add and fetch objects in parallel.
+ * While one thread is working on a cache entry, other threads can access
+   the rest of the cache with no waiting on the global lock, no race
+   conditions nor deadlock or livelock situations.
+ * While one thread is performing a long and resource-intensive
+   operation, other threads that request the same data will be put on hold,
+   and as soon as the first thread completes the operation, the result will be
+   returned to all threads.
+    EOF
+  spec.files       = `git ls-files`.split "\n"
+  spec.test_files  = Dir['test/ts_*.rb']
+  spec.executables = spec.files.map{|p| p =~ /^bin\/(.*)/ ? $1 : nil }.compact
+  spec.license     = 'GPL3+'
 end
-

data/test/tc_remote.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+# SynCache tests
+#
+#   Copyright (c) 2002-2011  Dmitry Borodaenko <angdraug@debian.org>
+#
+#   This program is free software.
+#   You can distribute/modify this program under the terms of
+#   the GNU General Public License version 3 or later.
+#
+# vim: et sw=2 sts=2 ts=8 tw=0
+
+require 'test/unit'
+require 'syncache'
+
+include SynCache
+
+class TC_RemoteCache < Test::Unit::TestCase
+
+  def setup
+    @server = ::DRb.start_service(nil, Cache.new(0.1, 5))
+    @cache = RemoteCache.new(@server.uri, 0.1, 0.01)
+  end
+
+  def teardown
+    ::DRb.stop_service
+  end
+
+  def test_flush
+    @cache['t'] = 'test'
+    @cache.flush
+    assert_equal nil, @cache['t']
+  end
+
+  def test_add_fetch
+    @cache['t'] = 'test'
+    assert_equal 'test', @cache['t']
+  end
+
+  def test_fetch_or_add
+    assert_equal nil, @cache['t']
+    @cache.fetch_or_add('t') { 'test' }
+    assert_equal 'test', @cache['t']
+  end
+
+  def test_size
+    1.upto(5) {|i| @cache[i] = i }
+    1.upto(5) do |i|
+      assert_equal i, @cache[i]
+    end
+    6.upto(10) {|i| @cache[i] = i }
+    1.upto(5) do |i|
+      assert_equal nil, @cache[i]
+    end
+  end
+
+  def test_ttl
+    1.upto(5) {|i| @cache[i] = i }
+    1.upto(5) do |i|
+      assert_equal i, @cache[i]
+    end
+    sleep(0.2)
+    1.upto(5) do |i|
+      assert_equal nil, @cache[i]
+    end
+  end
+
+  def test_timeout
+    slow = Thread.new do
+      @cache.fetch_or_add('t') { sleep 0.2; 'slow' }
+    end
+    sleep 0.01
+    @cache.fetch_or_add('t') { 'fast' }
+    assert_equal 'fast', @cache['t']
+    slow.join
+    @cache.delete('t')
+
+    decent = Thread.new do
+      @cache.fetch_or_add('t') { sleep 0.03; 'decent' }
+    end
+    sleep 0.01
+    @cache.fetch_or_add('t') { 'fast' }
+    assert_equal 'decent', @cache['t']
+    decent.join
+  end
+end

data/test/{test_syncache.rb → tc_syncache.rb}

@@ -2,7 +2,7 @@
 #
 # SynCache tests
 #
-#   Copyright (c) 2002-2009  Dmitry Borodaenko <angdraug@debian.org>
+#   Copyright (c) 2002-2011  Dmitry Borodaenko <angdraug@debian.org>
 #
 #   This program is free software.
 #   You can distribute/modify this program under the terms of
@@ -10,16 +10,13 @@
 #
 # vim: et sw=2 sts=2 ts=8 tw=0
 
-require 'helper'
+require 'test/unit'
+require 'syncache'
 
 include SynCache
 
 class TC_Cache < Test::Unit::TestCase
 
-  def test_initialize
-    cache = Cache.new(3, 5)
-  end
-
   def test_flush
     cache = Cache.new(3, 5)
     cache['t'] = 'test'
@@ -40,7 +37,7 @@ class TC_Cache < Test::Unit::TestCase
     assert_equal 'test', cache['t']
   end
 
-  def test_truncate
+  def test_size
     cache = Cache.new(3, 5)
     1.upto(5) {|i| cache[i] = i }
     1.upto(5) do |i|
@@ -52,7 +49,7 @@ class TC_Cache < Test::Unit::TestCase
     end
   end
 
-  def test_timeout
+  def test_ttl
     cache = Cache.new(0.01, 5)
     1.upto(5) {|i| cache[i] = i }
     1.upto(5) do |i|

data/test/ts_syncache.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# SynCache tests
+#
+#   Copyright (c) 2002-2011  Dmitry Borodaenko <angdraug@debian.org>
+#
+#   This program is free software.
+#   You can distribute/modify this program under the terms of
+#   the GNU General Public License version 3 or later.
+#
+# vim: et sw=2 sts=2 ts=8 tw=0
+
+require 'test/unit'
+require 'test/tc_syncache'
+require 'test/tc_remote'

metadata

@@ -1,75 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: syncache
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: '1.2'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Dmitry Borodaenko
-- David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-06 00:00:00 -04:00
-default_executable: 
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies: []
-
-description: "SynCache::Cache stores cached objects in a Hash that is protected by an advanced two-level locking mechanism. Two-level locking ensures that:\n\n        * Multiple threads can add and fetch objects in parallel without stepping on each other's toes.\n        * While one thread is working on a cache entry, other threads can access the rest of the cache with no waiting on the global lock, no race conditions nor deadlock or livelock situations.\n        * While one thread is performing a long and resource-intensive operation, other threads that request the same data with fetch_or_add() method will be put on hold, and as soon as the first thread completes the operation, the result will be returned to all threads. Without this feature, a steady stream of requests with less time between them than it takes to complete one request can easily bury a server under an avalanche of threads all wasting resources on the same expensive operation.\n\n    When number of cache entries exceeds the size limit, the least recently accessed entries are replaced with new data. This replacement strategy is controlled by the SynCache::CacheEntry class and can be changed by overriding its replacement_index() method.\n\n    Cache entries are automatically invalidated when their ttl (time to live) is exceeded. Entries can be explicitly invalidated by flush() method. The method can use === operator to compare cache keys against flush base (so that base can be e.g. a Regexp), and invalidates all entries when invoked without the base parameter.\n\n    The flush_delay initialization option allows to limit cache's flush rate. When this option is set, SynCache will make sure that at least this many seconds (it can also be a fraction) pass between two flushes. When extra flushes are requested, invalidation of flushed entries is postponed until earliest time when next flush is allowed.\n    "
+description: ! "SynCache stores cached objects in a Hash that is protected by an advanced\ntwo-level
+  locking mechanism which ensures that:\n\n * Multiple threads can add and fetch objects
+  in parallel.\n * While one thread is working on a cache entry, other threads can
+  access\n   the rest of the cache with no waiting on the global lock, no race\n   conditions
+  nor deadlock or livelock situations.\n * While one thread is performing a long and
+  resource-intensive\n   operation, other threads that request the same data will
+  be put on hold,\n   and as soon as the first thread completes the operation, the
+  result will be\n   returned to all threads.\n"
 email: angdraug@debian.org
-executables: []
-
+executables:
+- syncache-drb
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
+extra_rdoc_files: []
+files:
+- COPYING
+- ChangeLog.mtn
 - README.rdoc
-files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+- bin/syncache-drb
 - lib/syncache.rb
-- lib/syncache_sync_patch.rb
+- lib/syncache/remote.rb
+- lib/syncache/syncache.rb
+- man/syncache-drb.1
+- setup.rb
 - syncache.gemspec
-- test/helper.rb
-- test/test_syncache.rb
-has_rdoc: true
-homepage: http://github.com/czarneckid/syncache
-licenses: []
-
+- test/tc_remote.rb
+- test/tc_syncache.rb
+- test/ts_syncache.rb
+homepage: https://github.com/angdraug/syncache
+licenses:
+- GPL3+
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: SynCache is a thread-safe time-limited cache with flexible replacement policy and ability to wrap generation of expensive cache entries in synchronized blocks. SynCache was used in the Samizdat open publishing engine since 2005, and now it's released as a stand-alone module ready for use in other applications.
-test_files: 
-- test/helper.rb
-- test/test_syncache.rb
+summary: Thread-safe time-limited cache with flexible replacement policy
+test_files:
+- test/ts_syncache.rb

data/.document

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

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 David Czarnecki
-
-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,63 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "syncache"
-    gem.summary = %Q{SynCache is a thread-safe time-limited cache with flexible replacement policy and ability to wrap generation of expensive cache entries in synchronized blocks. SynCache was used in the Samizdat open publishing engine since 2005, and now it's released as a stand-alone module ready for use in other applications.}
-    gem.description = %Q{SynCache::Cache stores cached objects in a Hash that is protected by an advanced two-level locking mechanism. Two-level locking ensures that:
-
-        * Multiple threads can add and fetch objects in parallel without stepping on each other's toes.
-        * While one thread is working on a cache entry, other threads can access the rest of the cache with no waiting on the global lock, no race conditions nor deadlock or livelock situations.
-        * While one thread is performing a long and resource-intensive operation, other threads that request the same data with fetch_or_add() method will be put on hold, and as soon as the first thread completes the operation, the result will be returned to all threads. Without this feature, a steady stream of requests with less time between them than it takes to complete one request can easily bury a server under an avalanche of threads all wasting resources on the same expensive operation.
-
-    When number of cache entries exceeds the size limit, the least recently accessed entries are replaced with new data. This replacement strategy is controlled by the SynCache::CacheEntry class and can be changed by overriding its replacement_index() method.
-
-    Cache entries are automatically invalidated when their ttl (time to live) is exceeded. Entries can be explicitly invalidated by flush() method. The method can use === operator to compare cache keys against flush base (so that base can be e.g. a Regexp), and invalidates all entries when invoked without the base parameter.
-
-    The flush_delay initialization option allows to limit cache's flush rate. When this option is set, SynCache will make sure that at least this many seconds (it can also be a fraction) pass between two flushes. When extra flushes are requested, invalidation of flushed entries is postponed until earliest time when next flush is allowed.
-    }
-    gem.email = "angdraug@debian.org"
-    gem.homepage = "http://github.com/czarneckid/syncache"
-    gem.authors = ["Dmitry Borodaenko", "David Czarnecki"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "syncache #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-1.0.0

data/lib/syncache_sync_patch.rb

@@ -1,36 +0,0 @@
-# Monkey patch for standard sync.rb (see bug #11680 on RubyForge).
-
-if RUBY_VERSION < "1.8.7" or (RUBY_VERSION == "1.8.7" and RUBY_PATCHLEVEL < 173)
-
-module Sync_m
-  class Err < StandardError
-    def Err.Fail(*opt)
-      Thread.critical = false
-      fail self, sprintf(self::Message, *opt)
-    end
-  end
-
-  def sync_try_lock(mode = EX)
-    return unlock if mode == UN
-
-    Thread.critical = true
-    ret = sync_try_lock_sub(mode)
-    Thread.critical = false
-    ret
-  end
-end
-
-elsif RUBY_VERSION == "1.9.0"
-
-module Sync_m
-  def sync_try_lock(mode = EX)
-    return unlock if mode == UN
-    ret = nil
-    @sync_mutex.synchronize do
-      ret = sync_try_lock_sub(mode)
-    end
-    ret
-  end
-end
-
-end

data/test/helper.rb

@@ -1,9 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'syncache'
-
-class Test::Unit::TestCase
-end