Add and configure RSpec.

Author: lucasallan

Gemfile

@@ -9,7 +9,7 @@ end
 
 group :testing do
   gem 'test-unit', '~> 3.0.9'
-  #gem 'rspec', '~> 3.0.0'
+  gem 'rspec', '~> 3.1.0'
   #gem 'simplecov', '~> 0.8.2', :require => false
   gem 'coveralls', '~> 0.7.3', :require => false
 end

Rakefile

@@ -3,20 +3,22 @@ require 'rake/testtask'
 require 'rubygems/package_task'
 require File.expand_path('../lib/ref', __FILE__)
 
-desc 'Default: run unit tests.'
-task :default => :test
+begin
+  require 'rspec'
+  require 'rspec/core/rake_task'
 
-desc 'RVM likes to call it tests'
-task :tests => :test
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = '--color --backtrace --format documentation'
+  end
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.warning = true
-  t.verbose = true
+  task :default => :spec
+rescue LoadError
+  puts 'Error loading Rspec rake tasks, probably building the gem...'
 end
 
 
+spec = eval(File.read(File.expand_path('../ref.gemspec', __FILE__)))
+
 GEM_NAME       = 'ref'
 EXTENSION_NAME = 'extension'
 JAVA_EXT_NAME  = 'ref_ext'

spec/ref/mock_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Ref::Mock do
+
+  context 'gc with argument' do
+    specify do
+      Ref::Mock.use do
+        obj_1 = Object.new
+        obj_2 = Object.new
+
+        ref_1 = Ref::WeakReference.new(obj_1)
+        ref_2 = Ref::WeakReference.new(obj_2)
+
+        Ref::Mock.gc(obj_1)
+
+        expect(ref_1.object).to be_nil
+        expect(ref_2.object).to equal(obj_2)
+      end
+    end
+  end
+
+  context 'gc with no argument' do
+    specify do
+      Ref::Mock.use do
+        obj_1 = Object.new
+        obj_2 = Object.new
+
+        ref_1 = Ref::WeakReference.new(obj_1)
+        ref_2 = Ref::WeakReference.new(obj_2)
+
+        Ref::Mock.gc
+
+        expect(ref_1.object).to be_nil
+        expect(ref_2.object).to be_nil
+      end
+    end
+  end
+
+end

spec/ref/reference_queue_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Ref::ReferenceQueue do
+
+  let(:queue) { Ref::ReferenceQueue.new }
+  let(:obj_1) { Object.new }
+  let(:obj_2) { Object.new }
+  let(:ref_1) { Ref::WeakReference.new(obj_1) }
+  let(:ref_2) { Ref::WeakReference.new(obj_2) }
+
+  describe '#push' do
+    context 'when the queue is empty' do
+      it { expect(queue.size).to be(0) }
+      it { expect(queue).to be_empty }
+    end
+
+    context 'when the queue is not empty' do
+      before do
+        queue.push(ref_1)
+        queue.push(ref_2)
+      end
+
+      it { expect(queue.size).to be(2) }
+      it { expect(queue).to_not be_empty }
+    end
+  end
+
+  describe '#shift' do
+    context 'when the queue is not empty' do
+      before do
+        queue.push(ref_1)
+        queue.push(ref_2)
+      end
+      it { expect(queue.shift).to be(ref_1) }
+    end
+
+    context 'when the queue is empty' do
+      it { expect(queue.shift).to be_nil }
+    end
+  end
+
+  describe '#pop' do
+    context 'when the queue is not empty' do
+      before do
+        queue.push(ref_1)
+        queue.push(ref_2)
+      end
+
+      it { expect(queue.pop).to be(ref_2) }
+    end
+    context 'when the queue is empty' do
+      it { expect(queue.pop).to be_nil }
+    end
+  end
+
+  describe 'references are added immediately if the_object has been collected' do
+    specify do
+      Ref::Mock.use do
+        ref = Ref::WeakReference.new(obj_1)
+        Ref::Mock.gc(obj_1)
+        queue.monitor(ref)
+
+        expect(ref).to equal(queue.shift)
+      end
+    end
+  end
+end

spec/ref/soft_value_map_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Ref::SoftValueMap do
+  it_behaves_like 'a reference key map' do
+    let(:map_class)       { Ref::SoftValueMap }
+    let(:reference_class) { Ref::SoftReference }
+  end
+end

spec/ref/strong_reference_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Ref::StrongReference do
+  let(:obj) { Object.new }
+  let(:ref) { Ref::StrongReference.new(obj) }
+
+  context '#object' do
+    it { expect(obj).to equal(ref.object) }
+    it { expect(obj.object_id).to equal(ref.referenced_object_id) }
+  end
+
+  context '#inspect' do
+    it { expect(ref.inspect).to_not be_empty }
+  end
+end

spec/shared/reference_key_map_shared.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+shared_examples 'a reference key map' do
+
+  let(:value_1)  { 'value 1' }
+  let(:value_2)  { 'value 2' }
+  let(:value_3)  { 'value 3' }
+  let(:key_1)    { Object.new }
+  let(:key_2)    { Object.new }
+  let(:hash)     { map_class.new }
+
+  describe 'keeps entries with strong references' do
+    specify do
+      Ref::Mock.use do
+        hash[key_1] = value_1
+        hash[key_2] = value_2
+        expect(hash[key_1] ).to eq(value_1)
+        expect(hash[key_2] ).to eq(value_2)
+      end
+    end
+  end
+
+  describe 'removes entries that have been garbage collected' do
+    specify do
+      Ref::Mock.use do
+        hash['key 1'] = value_1
+        hash['key 2'] = value_2
+        expect(hash['key 1']).to eq(value_1)
+        expect(hash['key 2']).to eq(value_2)
+        Ref::Mock.gc(value_2)
+        expect(value_1).to eq(value_1)
+        expect(hash['key 2']).to be_nil
+      end
+    end
+  end
+
+  describe 'can clear the map' do
+    specify do
+      hash['key 1'] = value_1
+      hash['key 2'] = value_2
+      hash.clear
+      expect(hash['key 1']).to be_nil
+      expect(hash['key 2']).to be_nil
+    end
+  end
+
+  describe 'can delete entries' do
+    specify do
+      hash['key 1'] = value_1
+      hash['key 2'] = value_2
+      expect(hash.delete('key 3')).to be_nil
+      expect(hash.delete('key 1')).to eq(value_1)
+      expect(hash['key 1']).to be_nil
+    end
+  end
+
+  describe 'can merge in another hash' do
+    specify do
+      hash['key 1'] = value_1
+      hash['key 2'] = value_2
+      hash.merge!("key 3" => value_3)
+      expect(hash['key 1']).to be_nil
+
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  project_name 'ref'
+  add_filter '/coverage/'
+  add_filter '/doc/'
+  add_filter '/pkg/'
+  add_filter '/spec/'
+  add_filter '/tasks/'
+end
+
+require 'ref'
+require 'ref/mock'
+
+# import all the support files
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require File.expand_path(f) }
+Dir[File.join(File.dirname(__FILE__), 'shared/**/*.rb')].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

test/mock.rb

@@ -28,13 +28,13 @@ def use
           end
         end
       end
-      
+
       # Start using mock references.
       def setup
         raise "Ref::Mock already setup" if object_space
-        
+
         @object_space = {}
-        
+
         class << ObjectSpace
           unless method_defined?(:define_finalizer_with_mock_reference)
             def define_finalizer_with_mock_reference(obj, finalizer)
@@ -45,11 +45,11 @@ def define_finalizer_with_mock_reference(obj, finalizer)
               end
             end
           end
-          
+
           alias_method :define_finalizer_without_mock_reference, :define_finalizer
           alias_method :define_finalizer, :define_finalizer_with_mock_reference
         end
-        
+
         class << WeakReference
           unless method_defined?(:new_with_mock_reference)
             def new_with_mock_reference(obj)
@@ -60,11 +60,11 @@ def new_with_mock_reference(obj)
               end
             end
           end
-          
+
           alias_method :new_without_mock_reference, :new
           alias_method :new, :new_with_mock_reference
         end
-        
+
         class << SoftReference
           unless method_defined?(:new_with_mock_reference)
             def new_with_mock_reference(obj)
@@ -75,25 +75,25 @@ def new_with_mock_reference(obj)
               end
             end
           end
-          
+
           alias_method :new_without_mock_reference, :new
           alias_method :new, :new_with_mock_reference
         end
       end
-      
+
       # Stop using mock references.
       def cleanup
         @object_space = nil
         class << ObjectSpace
           alias_method :define_finalizer_with_mock_reference, :define_finalizer
           alias_method :define_finalizer, :define_finalizer_without_mock_reference
         end
-        
+
         class << WeakReference
           alias_method :new_with_mock_reference, :new
           alias_method :new, :new_without_mock_reference
         end
-        
+
         class << SoftReference
           alias_method :new_with_mock_reference, :new
           alias_method :new, :new_without_mock_reference
@@ -121,15 +121,15 @@ def gc(*objects)
         end
       end
     end
-    
+
     module MockReference #:nodoc:
       def initialize(obj)
         @object = obj
         @referenced_object_id = obj.__id__
         raise "Reference::Mock not setup yet" unless Mock.object_space
         Mock.object_space[obj.__id__] ||= []
       end
-    
+
       def object
         if @object && Mock.object_space.include?(@object.__id__)
           @object
@@ -138,13 +138,13 @@ def object
         end
       end
     end
-  
+
     class MockWeakReference < WeakReference #:nodoc:
       include MockReference
     end
-  
+
     class MockSoftReference < SoftReference #:nodoc:
       include MockReference
     end
-  end  
+  end
 end