wref 0.0.6 → 0.0.7

data/lib/wref/implementations/id_class_unique.rb

@@ -0,0 +1,50 @@
+class Wref::Implementations::IdClassUnique
+  def initialize(object)
+    @id = object.__id__
+    @class_name = object.class.name.to_sym
+    ObjectSpace.define_finalizer(object, method(:destroy))
+    @unique_id = object.__wref_unique_id__ if object.respond_to?(:__wref_unique_id__)
+  end
+
+  def get!
+    object = get
+    raise ::Wref::Recycled unless object
+    return object
+  end
+
+  def get
+    return nil if !@class_name || !@id
+    object = ObjectSpace._id2ref(@id)
+
+    #Some times this class-name will be nil for some reason - knj
+    object_class_name = object.class.name
+
+    if !object_class_name || @class_name != object_class_name.to_sym || @id != object.__id__
+      destroy
+      return nil
+    end
+
+    if @unique_id
+      destroy
+      return nil if !object.respond_to?(:__wref_unique_id__) || object.__wref_unique_id__ != @unique_id
+    end
+
+    return object
+  end
+
+  def alive?
+    if get
+      return true
+    else
+      return false
+    end
+  end
+
+private
+
+  def destroy(*args)
+    @id = nil
+    @class_name = nil
+    @unique_id = nil
+  end
+end

data/lib/wref/implementations/java_weak_reference.rb

@@ -0,0 +1,26 @@
+class Wref::Implementations::JavaWeakReference
+  def initialize(object)
+    require "java"
+    @weakref = java.lang.ref.WeakReference.new(object)
+  end
+
+  def get
+    return @weakref.get
+  end
+
+  def get!
+    object = @weakref.get
+    raise Wref::Recycled if object == nil
+    return object
+  end
+
+  def alive?
+    object = @weakref.get
+
+    if object == nil
+      return false
+    else
+      return true
+    end
+  end
+end

data/lib/wref/implementations/ref.rb

@@ -0,0 +1,24 @@
+class Wref::Implementations::Ref
+  def initialize(object)
+    require "ref"
+    @ref = ::Ref::WeakReference.new(object)
+  end
+
+  def get
+    @ref.object
+  end
+
+  def get!
+    object = @ref.object
+    raise Wref::Recycled unless object
+    return object
+  end
+
+  def alive?
+    if @ref.object
+      return true
+    else
+      return false
+    end
+  end
+end

data/lib/wref/implementations/weak_ref.rb

@@ -0,0 +1,53 @@
+class Wref::Implementations::WeakRef
+  def initialize(object)
+    require "weakref"
+    @id = object.__id__
+    @class_name = object.class.name.to_sym
+    @weak_ref = ::WeakRef.new(object)
+    ObjectSpace.define_finalizer(object, method(:destroy))
+  end
+
+  def get
+    return nil unless @id
+
+    begin
+      object = @weak_ref.__getobj__
+    rescue WeakRef::RefError
+      destroy
+      return nil
+    end
+
+    object_class_name = object.class.name
+
+    if !object_class_name || @class_name != object_class_name.to_sym || @id != object.__id__
+      destroy
+      return nil
+    end
+
+    return object
+  end
+
+  def get!
+    if object = get
+      return object
+    else
+      raise Wref::Recycled
+    end
+  end
+
+  def alive?
+    if @weak_ref.weakref_alive? && get
+      return true
+    else
+      return false
+    end
+  end
+
+private
+
+  def destroy(*args)
+    @id = nil
+    @class_name = nil
+    @unique_id = nil
+  end
+end

data/lib/wref/implementations/weakling.rb

@@ -0,0 +1,31 @@
+class Wref::Implementations::Weakling
+  def initialize(object)
+    require "weakling"
+    @weak_ref = ::Weakling::WeakRef.new(object)
+  end
+
+  def get
+    begin
+      @weak_ref.get
+    rescue ::WeakRef::RefError, ::Java::JavaLang::NullPointerException
+      return nil
+    end
+  end
+
+  def get!
+    begin
+      @weak_ref.get
+    rescue ::WeakRef::RefError, ::Java::JavaLang::NullPointerException
+      raise Wref::Recycled
+    end
+  end
+
+  def alive?
+    begin
+      @weak_ref.get
+      return true
+    rescue ::WeakRef::RefError, ::Java::JavaLang::NullPointerException
+      return false
+    end
+  end
+end

data/lib/wref/map.rb

@@ -0,0 +1,175 @@
+#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 = {})
+    require "monitor"
+
+    @map = {}
+    @mutex = Monitor.new
+    @impl = args[:impl]
+  end
+
+  #Sets a new object in the map with a given ID.
+  def set(id, obj)
+    wref = Wref.new(obj, impl: @impl)
+
+    @mutex.synchronize do
+      @map[id] = wref
+    end
+
+    return nil
+  end
+
+  #Returns an object by ID or raises a RefError.
+  #===Examples
+  # begin
+  #   obj = map.get!(1)
+  #   print "Object still exists in memory."
+  # rescue Wref::Recycled
+  #   print "Object has been garbage-collected."
+  # end
+  def get!(id)
+    wref = nil
+    @mutex.synchronize do
+      raise Wref::Recycled unless @map.key?(id)
+      wref = @map[id]
+    end
+
+    if object = wref.get
+      return object
+    else
+      delete(id)
+      raise Wref::Recycled
+    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 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
+        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 unless @map.key?(key)
+    end
+
+    begin
+      @map[key].get
+      return true
+    rescue Wref::Recycled
+      return false
+    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
+      if @map.key?(key) && get(key)
+        return true
+      else
+        return false
+      end
+    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
+    clean
+    return length
+  end
+
+  #Deletes a key in the hash.
+  def delete(key)
+    @mutex.synchronize do
+      wref = @map[key]
+      object = @map.delete(key)
+
+      if object
+        return object.get
+      else
+        return nil
+      end
+    end
+  end
+
+  #Iterates over every valid object in the weak map.
+  #===Examples
+  # map.each do |obj|
+  #   puts "Object alive: #{obj}"
+  # end
+  def each(&block)
+    enum = Enumerator.new do |yielder|
+      ids = nil
+      @mutex.synchronize do
+        ids = @map.keys
+      end
+
+      ids.each do |id|
+        if obj = get(id)
+          yielder << [id, obj]
+        end
+      end
+    end
+
+    if block
+      enum.each(&block)
+    else
+      return enum
+    end
+  end
+
+  #Make it hash-compatible.
+  alias has_key? key?
+  alias [] get
+  alias []= set
+end

data/shippable.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - ruby-head
+  - ruby-2.1-head
+  - ruby-2.0-head
+  - ruby-1.9.3-head
+  - ruby-1.9.2-head
+  - jruby-head
+script:
+  - CODECLIMATE_REPO_TOKEN=23d002ad9b86687a067e6bbc81320cd979ffad756d1be69ca4e24c1038ee19a6 bundle exec rspec
+notifications:
+  email: false

data/spec/implementations/id_class_unique_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Wref::Implementations::IdClassUnique do
+  it_should_behave_like "wref" unless RUBY_ENGINE == "jruby"
+  it_should_behave_like "map" unless RUBY_ENGINE == "jruby"
+end

data/spec/implementations/java_weak_reference_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Wref::Implementations::JavaWeakReference do
+  it_should_behave_like "wref" if RUBY_ENGINE == "jruby"
+  it_should_behave_like "map" if RUBY_ENGINE == "jruby"
+end

data/spec/implementations/ref_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Wref::Implementations::Ref do
+  it_should_behave_like "wref"
+  it_should_behave_like "map"
+end

data/spec/implementations/weak_ref_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Wref::Implementations::WeakRef do
+  it_should_behave_like "wref"
+  it_should_behave_like "map"
+end

data/spec/implementations/weakling_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Wref::Implementations::Weakling do
+  it_should_behave_like "wref" if RUBY_ENGINE == "jruby"
+  it_should_behave_like "map" if RUBY_ENGINE == "jruby"
+end

data/spec/spec_helper.rb

@@ -1,12 +1,19 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'wref'
+require "rspec"
+require "wref"
+require "weakling" if RUBY_ENGINE == "jruby"
+require "ref"
 
 # 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|
-  
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 end

data/spec/support/garbage_collector_helper.rb

@@ -0,0 +1,33 @@
+module GarbageCollectorHelper
+  def force_garbage_collect
+    GC.enable
+
+    sleep 0.01
+
+    if RUBY_ENGINE == "jruby"
+      java.lang.System.gc
+    else
+      if RUBY_VERSION.start_with?("2")
+        GC.start(full_mark: true, immediate_sweep: true)
+      else
+        GC.start
+      end
+    end
+
+    sleep 0.01
+
+    GC.disable
+  end
+
+  def force_garbage_collection
+    force_garbage_collect
+
+    10000.times do
+      some_str = User.new("User #{Digest::MD5.hexdigest(Time.now.to_f.to_s)}")
+      weak_ref = described_class.new(some_str)
+      some_str = nil
+    end
+
+    force_garbage_collect
+  end
+end