wref 0.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kasper Johansen
+
+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.rdoc

@@ -0,0 +1,19 @@
+= wref
+
+Description goes here.
+
+== Contributing to wref
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "wref"
+  gem.homepage = "http://github.com/kaspernj/wref"
+  gem.license = "MIT"
+  gem.summary = %Q{Weak references and weak hash for Ruby}
+  gem.description = %Q{Lightweight weak reference and weak hash that works in 1.9 and JRuby.}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wref #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/wref.rb

@@ -0,0 +1,251 @@
+#A simple weak-reference framework with mapping. Only handles the referencing of objects.
+#===Examples
+# user_obj = ob.get(:User, 1)
+# weak_ref = Wref(user_obj)
+# user_obj = nil
+# sleep 0.5
+# GC.start
+#
+# begin
+#   user_obj = weak_ref.get
+#   print "The user still exists in memory and has ID #{user.id}."
+# rescue Wref::Recycled
+#   print "The user has been removed from memory."
+# end
+class Wref
+  #Returns the classname of the object.
+  attr_reader :class_name
+  
+  #Returns the object-ID which is used to look up the ObjectSpace (if not running JRuby).
+  attr_reader :id
+  
+  #Initializes various variables.
+  def initialize(obj)
+    @id = obj.__id__
+    
+    if RUBY_ENGINE == "jruby"
+      require "java"
+      @weakref = java.lang.ref.WeakReference.new(obj)
+    else
+      @class_name = obj.class.name.to_sym
+      
+      if obj.respond_to?("__object_unique_id__")
+        @unique_id = obj.__object_unique_id__
+      end
+    end
+  end
+  
+  #Returns the object that this weak reference holds or raises Wref::Recycled.
+  # begin
+  #   obj = wref.get
+  #   print "Object still exists in memory."
+  # rescue Wref::Recycled
+  #   print "Object has been garbage-collected."
+  # end
+  def get
+    begin
+      raise Wref::Recycled if !@class_name or !@id
+      
+      if RUBY_ENGINE == "jruby"
+        obj = @weakref.get
+        
+        if obj == nil
+          raise Wref::Recycled
+        else
+          return obj
+        end
+      else
+        obj = ObjectSpace._id2ref(@id)
+      end
+      
+      #Some times this class-name will be nil for some reason - knj
+      obj_class_name = obj.class.name
+      
+      if !obj_class_name or @class_name != obj_class_name.to_sym or @id != obj.__id__
+        raise Wref::Recycled
+      end
+      
+      if @unique_id
+        if !obj.respond_to?("__object_unique_id__") or obj.__object_unique_id__ != @unique_id
+          raise Wref::Recycled
+        end
+      end
+      
+      return obj
+    rescue RangeError, TypeError
+      raise Wref::Recycled
+    end
+  end
+  
+  #Returns true if the reference is still alive.
+  # print "The object still exists in memory." if wref.alive?
+  def alive?
+    begin
+      self.get
+      return true
+    rescue Wref::Recycled
+      return false
+    end
+  end
+  
+  #Makes Wref compatible with the normal WeakRef.
+  alias weakref_alive? alive?
+  alias __getobj__ get
+end
+
+#A weak hash-map.
+#===Examples
+# map = Wref_map.new
+# map[1] = obj
+# obj = nil
+# 
+# sleep 0.5
+# 
+# begin
+#   obj = map[1]
+#   print "Object still exists in memory."
+# rescue Wref::Recycled
+#   print "Object has been garbage-collected."
+# end
+#
+# obj = map.get!(1)
+# print "Object still exists in memory." if obj
+class Wref_map
+  def initialize(args = nil)
+    @map = {}
+    @ids = {}
+    @mutex = Mutex.new
+  end
+  
+  #Sets a new object in the map with a given ID.
+  def set(id, obj)
+    wref = Wref.new(obj)
+    
+    @mutex.synchronize do
+      @map[id] = wref
+      @ids[obj.__id__] = id
+    end
+    
+    #JRuby cant handle this atm... Dunno why...
+    if RUBY_ENGINE != "jruby"
+      ObjectSpace.define_finalizer(obj, self.method("delete_by_id"))
+    end
+    
+    return nil
+  end
+  
+  #Returns a object by ID or raises a RefError.
+  #===Examples
+  # begin
+  #   obj = map[1]
+  #   print "Object still exists in memory."
+  # rescue Wref::Recycled
+  #   print "Object has been garbage-collected."
+  # end
+  def get(id)
+    begin
+      @mutex.synchronize do
+        raise Wref::Recycled if !@map.key?(id)
+        return @map[id].get
+      end
+    rescue Wref::Recycled => e
+      self.delete(id)
+      raise e
+    end
+  end
+  
+  #The same as 'get' but returns nil instead of WeakRef-error. This can be used to avoid writing lots of code.
+  #===Examples
+  # obj = map.get!(1)
+  # print "Object still exists in memory." if obj
+  def get!(id)
+    begin
+      return self.get(id)
+    rescue Wref::Recycled
+      return nil
+    end
+  end
+  
+  #Scans the whole map and removes dead references. After the implementation of automatic clean-up by using ObjectSpace.define_finalizer, there should be no reason to call this method.
+  def clean
+    keys = nil
+    @mutex.synchronize do
+      keys = @map.keys
+    end
+    
+    keys.each do |key|
+      begin
+        self.get(key) #this will remove the key if the object no longer exists.
+      rescue Wref::Recycled
+        #ignore.
+      end
+    end
+    
+    return nil
+  end
+  
+  #Returns true if a given key exists and the object it holds is alive.
+  def valid?(key)
+    @mutex.synchronize do
+      return false if !@map.key?(key)
+      
+      begin
+        @map[key].get
+        return true
+      rescue Wref::Recycled
+        return false
+      end
+    end
+  end
+  
+  #Returns true if the given key exists in the hash.
+  #===Examples
+  # print "Key exists but we dont know if the value has been garbage-collected." if map.key?(1)
+  def key?(key)
+    @mutex.synchronize do
+      return @map.key?(key)
+    end
+  end
+  
+  #Returns the length of the hash. This may not be true since invalid objects is also counted.
+  def length
+    @mutex.synchronize do
+      return @map.length
+    end
+  end
+  
+  #Cleans the hash and returns the length. This is slower but more accurate than the ordinary length that just returns the hash-length.
+  def length_valid
+    self.clean
+    
+    @mutex.synchronize do
+      return @map.length
+    end
+  end
+  
+  #Deletes a key in the hash.
+  def delete(key)
+    @mutex.synchronize do
+      wref = @map[key]
+      @ids.delete(wref.id) if wref
+      @map.delete(key)
+    end
+  end
+  
+  #This method is supposed to remove objects when finalizer is called by ObjectSpace.
+  def delete_by_id(object_id)
+    @mutex.synchronize do
+      id = @ids[object_id]
+      @map.delete(id)
+      @ids.delete(object_id)
+    end
+  end
+  
+  #Make it hash-compatible.
+  alias has_key? key?
+  alias [] get
+  alias []= set
+end
+
+#This error is raised when an object in a wref has been garbage-collected.
+class Wref::Recycled < RuntimeError; end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'wref'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/wref_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Wref" do
+  it "should not fail" do
+    str = "Test"
+    ref = Wref.new(str)
+    raise "Should have been alive but wasnt." if !ref.alive?
+    str = nil
+    GC.start
+    raise "Should have been GCed but wasnt." if ref.alive?
+    
+    
+    str = "Test"
+    map = Wref_map.new
+    map[5] = str
+    raise "Should have been valid but wasnt." if !map.valid?(5)
+    str = nil
+    GC.start
+    raise "Should habe been garbage collected but wasnt." if !map.valid?(5)
+  end
+end

data/wref.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wref}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = %q{2012-05-10}
+  s.description = %q{Lightweight weak reference and weak hash that works in 1.9 and JRuby.}
+  s.email = %q{k@spernj.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/wref.rb",
+    "spec/spec_helper.rb",
+    "spec/wref_spec.rb",
+    "wref.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kaspernj/wref}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Weak references and weak hash for Ruby}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: wref
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Kasper Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Lightweight weak reference and weak hash that works in 1.9 and JRuby.
+email: k@spernj.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/wref.rb
+- spec/spec_helper.rb
+- spec/wref_spec.rb
+- wref.gemspec
+has_rdoc: true
+homepage: http://github.com/kaspernj/wref
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4333171512268985658
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Weak references and weak hash for Ruby
+test_files: []
+