instantcache 0.1.0a1

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/instantcache.rb'}"
+puts "Loading instantcache gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+Proc.new {
+  libdir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  $:.unshift(libdir) unless ($:.include?(libdir))
+}.call
+require 'rubygems'
+require 'stringio'
+require 'test/unit'
+require 'instantcache'

data/test/test_instantcache.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestInstantCache_01 < Test::Unit::TestCase
+
+  TestClass_def = <<-'EOT'
+    class TestClass
+      include InstantCache
+      memcached_accessor(:mca)
+      memcached_reader(:mcr)
+      memcached_counter(:mcc)
+    end
+  EOT
+
+  VARS = %w( mca mcr mcc )
+
+  def setup
+    if (InstantCache.cache_object.nil?)
+      InstantCache.cache_object = MemCache.new('127.0.0.1:11211')
+    end
+    if (self.class.const_defined?(:TestClass))
+      self.class.class_eval('remove_const(:TestClass)')
+    end
+    self.class.class_eval(TestClass_def)
+    @test_objects = []
+  end
+
+  def teardown
+    @test_objects.each do |o|
+      VARS.each do |ivar_s|
+        cell = o.instance_variable_get("@#{ivar_s}".to_sym)
+        cellname = cell.name
+        InstantCache.cache_object.delete(cellname)
+        cell.destroy! unless (cell.destroyed?)
+      end
+    end
+  end
+    
+  def get_object
+    @test_objects << (test_obj = TestClass.new)
+    return test_obj
+  end
+
+  def test_01_new_and_empty
+    test_obj = get_object
+    assert_nil(test_obj.mca)
+    assert_nil(test_obj.mcr)
+    assert_equal(0, test_obj.mcc)
+  end
+
+  def test_02_test_default_names
+    test_obj = get_object
+    assert_nil(test_obj.mca)
+    assert_nil(test_obj.mcr)
+    assert_equal(0, test_obj.mcc)
+    VARS.each do |ivar|
+      expected = '%s:%d:@%s' % [ test_obj.class.name, test_obj.object_id, ivar ]
+      test_val = test_obj.instance_variable_get("@#{ivar}".to_sym).name
+      assert_equal(expected, test_val)
+    end
+  end
+
+end

data/test/test_sharing_complex.rb

@@ -0,0 +1,187 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'thread'
+
+class TestInstantCacheComplexSharing < Test::Unit::TestCase
+
+  TestClass_def = <<-'EOT'
+    class TestClass
+      include InstantCache
+      memcached_accessor(:umca)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_reader(:umcr)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_counter(:umcc)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_accessor(InstantCache::PRIVATE, :pmca)
+      memcached_reader(InstantCache::PRIVATE, :pmcr)
+      memcached_counter(InstantCache::PRIVATE, :pmcc)
+      memcached_accessor(InstantCache::SHARED, :smca) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_reader(InstantCache::SHARED, :smcr) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_counter(InstantCache::SHARED, :smcc) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+    end
+  EOT
+
+  VARS = %w( umca umcr umcc pmca pmcr pmcc smca smcr smcc )
+
+  def setup
+    unless (self.class.constants.include?('TestName'))
+      #
+      # Create a closure to make the test class instance available to
+      # the custom-name blocks.
+      #
+      self.class.const_set('TestName',
+                           Proc.new {
+                             self.class.name
+                           })
+    end
+    #
+    # Make the connexion to the memcache cluster.
+    #
+    if (InstantCache.cache_object.nil?)
+      InstantCache.cache_object = MemCache.new('127.0.0.1:11211')
+    end
+    if (self.class.const_defined?(:TestClass))
+      self.class.class_eval('remove_const(:TestClass)')
+    end
+    self.class.class_eval(TestClass_def)
+    @test_objects = []
+  end
+
+  def teardown
+    @test_objects.each do |o|
+      VARS.each do |ivar_s|
+        cell = o.instance_variable_get("@#{ivar_s}".to_sym)
+        cellname = cell.name
+        InstantCache.cache_object.delete(cellname)
+        cell.destroy! unless (cell.destroyed?)
+      end
+    end
+    if (self.class.const_defined?(:TestClass))
+      self.class.class_eval('remove_const(:TestClass)')
+    end
+  end
+
+  def get_object
+    @test_objects << (test_obj = TestClass.new)
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      if (ivar_s =~ %r!cc$!)
+        assert_equal(0, test_obj.send(ivar_sym),
+                     "@#{ivar_s} should be 0")
+      else
+        assert_nil(test_obj.send(ivar_sym),
+                   "@#{ivar_s} should be nil")
+      end
+    end
+    return test_obj
+  end
+
+  def test_01_test_custom_names
+    test_obj = get_object
+    test_obj2 = get_object
+    VARS.each do |ivar_s|
+      #
+      # Skip over the private ones for now, since we're not sure of their
+      # names.
+      #
+      next if (ivar_s[0,1] == 'p')
+      ivar_sym = ivar_s.to_sym
+      expected = '%s-%s' % [ TestName.call, ivar_s ]
+      test_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      test_val = test_var.name
+      assert_equal(expected, test_val,
+                   "test_obj:@#{ivar_s}'s name should be '#{expected}'")
+      test_var2 = test_obj2.instance_variable_get("@#{ivar_s}".to_sym)
+      test_val2 = test_var2.name
+      assert_equal(expected, test_val2,
+                   "test_obj2:@#{ivar_s}'s name should be '#{expected}'")
+      assert_equal(test_val, test_val2,
+                   "@#{ivar_s} should have the same name for both variables")
+      #
+      # Lock the cell for the next test.
+      #
+      assert(test_var.lock,
+             "test_var:@#{ivar_s} should be locked")
+      test_var.destroy!
+      assert_raises(InstantCache::Destroyed,
+                    "test_var:@#{ivar_s} should be destroyed and not let us " +
+                    '.destroy! it again') do
+        test_var.destroy!
+      end
+      assert_raises(InstantCache::Destroyed,
+                    "test_var:@#{ivar_s} should be destroyed and not let us " +
+                    'fetch it') do
+        test_var.get
+      end
+      assert_raises(InstantCache::Destroyed,
+                    "test_var:@#{ivar_s} should be destroyed and not let us " +
+                    '_destroy! it again') do
+        test_obj.send("#{ivar_s}_destroy!".to_sym)
+      end
+    end
+  end
+
+  def test_02_test_that_destroy_unlocks
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      test_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      assert(test_var.lock,
+             "Should be able to lock test_obj:@#{ivar_s} (#{test_var.name}) " +
+             'after destruction in previous test')
+      test_var.destroy!
+    end
+  end
+
+  def test_03_test_locking
+    main_obj = get_object
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      main_var = main_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      test_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      main_lock = main_var.lock
+      test_lock = test_var.lock
+      assert(main_lock,
+             "main_var:@#{ivar_s}.lock should return true")
+      if (main_var.shared? && test_var.shared?)
+        assert(! test_lock,
+               "shared test_var:@#{ivar_s}.lock should return false or nil")
+      else
+        assert(test_lock,
+               "private test_var:@#{ivar_s}.lock should return true")
+      end
+    end
+  end
+
+  def test_04_test_multilocking
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      main_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      main_var.lock
+      threads = []
+      100.times do
+        alt_obj = get_object
+        alt_var = alt_obj.instance_variable_get("@#{ivar_s}".to_sym)
+        assert_not_equal(main_var, alt_var,
+                         "alt_var.#{ivar_s} should not match main_var's")
+        if (ivar_s[0,1] == 'p')
+          assert_not_equal(main_var.name, alt_var.name,
+                           "alt_var.#{ivar_s}'s name should not match main_var's")
+        else
+          assert_equal(main_var.name, alt_var.name,
+                       "alt_var.#{ivar_s}'s name should match main_var's")
+        end
+        attempt_lock = Proc.new { Thread.current[:locked] = alt_var.lock }
+        threads << Thread.new { attempt_lock }
+      end
+      threads.each do |thred|
+        thred.join
+        assert(! thred[:locked],
+               "#{thred.inspect}[:locked] should be false for @#{ivar_s}")
+      end
+    end
+  end
+
+end

data/test/test_sharing_simple.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'thread'
+
+class TestInstantCacheSimpleSharing < Test::Unit::TestCase
+
+  TestClass_def = <<-'EOT'
+    class TestClass
+      include InstantCache
+      memcached_accessor(:umca)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_reader(:umcr)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_counter(:umcc)	{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_accessor(InstantCache::PRIVATE, :pmca)
+      memcached_reader(InstantCache::PRIVATE, :pmcr)
+      memcached_counter(InstantCache::PRIVATE, :pmcc)
+      memcached_accessor(InstantCache::SHARED, :smca) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_reader(InstantCache::SHARED, :smcr) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+      memcached_counter(InstantCache::SHARED, :smcc) \
+				{ |ivar| "#{TestName.call}-#{ivar.to_s}" }
+    end
+  EOT
+
+  VARS = %w( umca umcr umcc pmca pmcr pmcc smca smcr smcc )
+
+  def setup
+    unless (self.class.constants.include?('TestName'))
+      #
+      # Create a closure to make the test class instance available to
+      # the custom-name blocks.
+      #
+      self.class.const_set('TestName',
+                           Proc.new {
+                             self.class.name +
+                             '::' +
+                             self.instance_variable_get(:@method_name)
+                           })
+    end
+    #
+    # Make the connexion to the memcache cluster.
+    #
+    if (InstantCache.cache_object.nil?)
+      InstantCache.cache_object = MemCache.new('127.0.0.1:11211')
+    end
+    if (self.class.const_defined?(:TestClass))
+      self.class.class_eval('remove_const(:TestClass)')
+    end
+    self.class.class_eval(TestClass_def)
+    @test_objects = []
+  end
+
+  def teardown
+    @test_objects.each do |o|
+      VARS.each do |ivar_s|
+        cell = o.instance_variable_get("@#{ivar_s}".to_sym)
+        cellname = cell.name
+        InstantCache.cache_object.delete(cellname)
+        cell.destroy! unless (cell.destroyed?)
+      end
+    end
+    unless (self.class.const_defined?(:TestClass))
+      self.class.class_eval(TestClass_def)
+    end
+    cleanup = TestClass.new
+    VARS.each { |ivar_s| cleanup.send("#{ivar_s}_destroy!".to_sym) }
+    self.class.class_eval('remove_const(:TestClass)')
+  end
+
+  def get_object
+    @test_objects << (test_obj = TestClass.new)
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      if (ivar_s =~ %r!cc$!)
+        assert_equal(0, test_obj.send(ivar_sym),
+                     "@#{ivar_s} should be 0")
+      else
+        assert_nil(test_obj.send(ivar_sym),
+                   "@#{ivar_s} should be nil")
+      end
+    end
+    return test_obj
+  end
+
+  def test_01_test_custom_names
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      #
+      # Skip over the private ones for now, since we're not sure of their
+      # names.
+      #
+      next if (ivar_s[0,1] == 'p')
+      ivar_sym = ivar_s.to_sym
+      expected = '%s-%s' % [ TestName.call, ivar_s ]
+      test_val = test_obj.instance_variable_get("@#{ivar_s}".to_sym).name
+      assert_equal(expected, test_val,
+                   "@#{ivar_s}'s name should be '#{expected}'")
+    end
+  end
+
+  def test_02_test_sharedness
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      test_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      expect_shared = (ivar_s =~ %r!^p!) ? false : true
+      assert_equal(expect_shared, test_var.shared?,
+                   "@#{ivar_s}.shared? should be #{expect_shared.inspect}")
+      assert_not_equal(expect_shared, test_var.private?,
+                       "@#{ivar_s}.private? should not be #{expect_shared.inspect}")
+    end
+  end
+
+  def test_03_test_locking
+    main_obj = get_object
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      main_var = main_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      test_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      main_lock = main_var.lock
+      test_lock = test_var.lock
+      assert(main_lock,
+             "main_var:@#{ivar_s}.lock should return true")
+      if (main_var.shared? && test_var.shared?)
+        assert(! test_lock,
+               "shared test_var:@#{ivar_s}.lock should return false or nil")
+      else
+        assert(test_lock,
+               "private test_var:@#{ivar_s}.lock should return true")
+      end
+    end
+  end
+
+  def test_04_test_multilocking
+    test_obj = get_object
+    VARS.each do |ivar_s|
+      ivar_sym = ivar_s.to_sym
+      main_var = test_obj.instance_variable_get("@#{ivar_s}".to_sym)
+      main_var.lock
+      threads = []
+      100.times do
+        alt_obj = get_object
+        alt_var = alt_obj.instance_variable_get("@#{ivar_s}".to_sym)
+        assert_not_equal(main_var, alt_var,
+                         "alt_var.#{ivar_s} should not match main_var's")
+        if (ivar_s[0,1] == 'p')
+          assert_not_equal(main_var.name, alt_var.name,
+                           "alt_var.#{ivar_s}'s name should not match main_var's")
+        else
+          assert_equal(main_var.name, alt_var.name,
+                       "alt_var.#{ivar_s}'s name should match main_var's")
+        end
+        attempt_lock = Proc.new { Thread.current[:locked] = alt_var.lock }
+        threads << Thread.new { attempt_lock }
+      end
+      threads.each do |thred|
+        thred.join
+        assert(! thred[:locked],
+               "#{thred.inspect}[:locked] should be false for @#{ivar_s}")
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: instantcache
+version: !ruby/object:Gem::Version 
+  hash: 415506520
+  prerelease: true
+  segments: 
+  - 0
+  - 1
+  - 0a1
+  version: 0.1.0a1
+platform: ruby
+authors: 
+- Ken Coar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: versionomy
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 1
+        - 8
+        - 5
+        version: 1.8.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id003
+description: |-
+  rubygem-instantcache provides the InstantCache module, a mixin
+  which has accessors that allow you to declare 'instance variables'
+  that are actually stored in a memcached cluster rather than
+  local memory.
+email: 
+- coar@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENCE.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENCE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- instantcache.gemspec
+- lib/instantcache.rb
+- lib/instantcache/exceptions.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_instantcache.rb
+- test/test_sharing_complex.rb
+- test/test_sharing_simple.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/RoUS/rubygem-instantcache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: instantcache
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: rubygem-instantcache provides the InstantCache module, a mixin which has accessors that allow you to declare 'instance variables' that are actually stored in a memcached cluster rather than local memory.
+test_files: 
+- test/test_instantcache.rb
+- test/test_helper.rb
+- test/test_sharing_simple.rb
+- test/test_sharing_complex.rb