threadded_enumerator 0.0.0 → 0.0.1

data/Gemfile

@@ -8,6 +8,7 @@ gem "tsafe"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "wref"
   gem "rspec", "~> 2.8.0"
   gem "rdoc", "~> 3.12"
   gem "bundler", ">= 1.0.0"

data/Gemfile.lock

@@ -22,6 +22,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
     tsafe (0.0.1)
+    wref (0.0.4)
 
 PLATFORMS
   ruby
@@ -33,3 +34,4 @@ DEPENDENCIES
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
   tsafe
+  wref

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/threadded_enumerator.rb

@@ -1,21 +1,93 @@
 require "tsafe"
+require "timeout"
 
 class Threadded_enumerator
+  @@threads = Tsafe::MonHash.new
+  
+  #Kills waiting threads when 'Threadded_enumerator'-objects are garbage-collected. This makes ensures being executed, objects GC'ed and so on.
+  def self.finalizer(id)
+    begin
+      Timeout.timeout(3) do
+        thread = @@threads[id]
+        
+        #The thread is not always started, if the loop is never called... The thread might not exist for this reason.
+        return nil if !thread
+        
+        #Remove reference.
+        @@threads.delete(id)
+        
+        #Thread is already dead - ignore.
+        return nil if !thread.alive?
+        
+        #Kill thread to release references to objects within and make it execute any ensures within.
+        thread.kill
+        
+        #Check that the thread is actually killed by joining - else the timeout would have no effect, since 'kill' doesnt block. If the thread is never killed, this will be properly be a memory leak scenario, which we report in stderr!
+        thread.join
+        
+        #This will make all sleeps and thread-stops be ignored. Commented out until further... Maybe this is good?
+        #thread.run while thread.alive?
+      end
+    rescue Timeout::Error
+      $stderr.puts "Couldnt kill thread #{id} for 'Threadded_enumerator' - possible memory leak detected!"
+    rescue Exception => e
+      $stderr.puts "Error while killing 'Threadded_enumerator'-thread."
+      $stderr.puts e.inspect
+      $stderr.puts e.backtrace
+      raise e
+    end
+  end
+  
+  #Starts a thread which fills the yielder. Its done by this method to allowed GC'ing of 'Threadded_enumerator'-objects.
+  def self.block_runner(args)
+    @@threads[args[:id]] = Thread.new do
+      args[:yielder].thread = Thread.current
+      
+      begin
+        if args[:block]
+          args[:block].call(args[:yielder])
+          args[:yielder].done = true
+        elsif enum = args[:enum]
+          begin
+            loop do
+              args[:yielder] << enum.next
+            end
+          rescue StopIteration
+            #ignore.
+          end
+        else
+          raise "Dont know what to do?"
+        end
+      rescue => e
+        $stderr.puts e.inspect
+        $stderr.puts e.backtrace
+      ensure
+        args[:yielder].done = true
+      end
+    end
+  end
+  
   def initialize(args = {}, &block)
     @args = {
-      :cache => 1,
-      :block => block
+      :cache => 0,
+      :block => block,
+      :id => self.__id__
     }.merge(args)
     
     @debug = @args[:debug]
     @yielder = Threadded_enumerator::Yielder.new(@args)
+    
+    #We use this to kill the block-thread, execute any ensures and release references to any objects within.
+    ObjectSpace.define_finalizer(self, Threadded_enumerator.method(:finalizer))
   end
   
+  #Returns the next result.
   def next
     block_start if !@block_started
     return @yielder.get_result
   end
   
+  #Loops over each result and yields it or returns an enumerator if no block is given.
   def each(&block)
     enum = Enumerator.new do |yielder|
       begin
@@ -42,57 +114,42 @@ class Threadded_enumerator
   
   private
   
+  #Starts the thread that spawns the results.
   def block_start
     @block_started = true
     
-    Thread.new do
-      @yielder.thread = Thread.current
-      
-      begin
-        if @args[:block]
-          @args[:block].call(@yielder)
-          @yielder.done = true
-        elsif enum = @args[:enum]
-          begin
-            loop do
-              @yielder << enum.next
-            end
-          rescue StopIteration
-            #ignore.
-          end
-        else
-          raise "Dont know what to do?"
-        end
-      rescue => e
-        $stderr.puts e.inspect
-        $stderr.puts e.backtrace
-      ensure
-        @yielder.done = true
-      end
-    end
+    #It has to be done this way in order to allowed the GC'ing of the object. Else the thread would contain an alive reference to self.
+    Threadded_enumerator.block_runner(:id => self.__id__, :block => @args[:block], :enum => @args[:enum], :yielder => @yielder)
   end
 end
 
 class Threadded_enumerator::Yielder
-  attr_accessor :done, :thread
+  attr_accessor :args, :done, :thread
   
   def initialize(args)
     @args = args
     @done = false
     @debug = @args[:debug]
     @results = Tsafe::MonArray.new
+    @waiting_for_result = 0
   end
   
+  #Adds a new result to the yielder.
   def <<(res)
     @results << res
+    @waiting_for_result -= 1
     
-    while @results.length >= @args[:cache]
+    while @results.length >= @args[:cache] and @waiting_for_result <= 0
       print "Stopping thread - too many results (#{@results}).\n" if @debug
       Thread.stop
     end
   end
   
+  #Returns the next result.
   def get_result
+    #Increase count to control cache.
+    @waiting_for_result += 1
+    
     #Wait for results-thread to be spawned before continuing.
     Thread.pass while !@thread
     

data/spec/threadded_enumerator_spec.rb

@@ -61,4 +61,92 @@ describe "ThreaddedEnumerator" do
       print "i: #{i}\n" if debug
     end
   end
+  
+  it "should not cache unless told to" do
+    $count = 0
+    debug = false
+    
+    tenum = Threadded_enumerator.new do |yielder|
+      0.upto(100) do |i|
+        STDOUT.print "Te: #{i}\n" if debug
+        $count = i
+        yielder << i
+      end
+    end
+    
+    0.upto(5) do
+      i = tenum.next
+      STDOUT.print "i: #{i}\n" if debug
+    end
+    
+    raise "Expected count to be 5 but it wasnt: #{$count}" if $count != 5
+  end
+  
+  it "should cache when told to" do
+    $count = 0
+    debug = false
+    
+    tenum = Threadded_enumerator.new(:cache => 10) do |yielder|
+      0.upto(100) do |i|
+        STDOUT.print "Te: #{i}\n" if debug
+        $count = i
+        yielder << i
+      end
+    end
+    
+    0.upto(5) do
+      i = tenum.next
+      STDOUT.print "i: #{i}\n" if debug
+    end
+    
+    raise "Expected count to be 5 but it wasnt: #{$count}" if $count <= 5
+  end
+  
+  it "should execute ensures and GC" do
+    require "wref"
+    $ensured = false #Used to check if ensures within 'Threadded_enumerator' are executed later.
+    debug = false
+    
+    tenum = Threadded_enumerator.new(:cache => 1) do |yielder|
+      begin
+        someobj = "Kasper"
+        $someobj_wref = Wref.new(someobj) #Used to check GC for objects within 'Threadded_enumerator' later.
+        
+        0.upto(100) do |i|
+          STDOUT.print "Ensure: #{i} (#{yielder.args[:id]})\n" if debug
+          yielder << i
+        end
+      ensure
+        STDOUT.print "Ensured!\n" if debug
+        $ensured = true #Used to check if ensures within 'Threadded_enumerator' are executed later.
+      end
+    end
+    
+    $tenum_wref = Wref.new(tenum)
+    
+    0.upto(5) do
+      tenum.next
+    end
+    
+    raise "Expected ensure to be false but it wasnt: #{$ensured}" if $ensured != false
+    
+    #Needs to create an object of same class in Ruby 1.9.2.
+    tenum = Threadded_enumerator.new(:cache => 1) do |yielder|
+      
+    end
+  end
+  
+  it "should execute ensures and GC (still)" do
+    someobj = "Johan" #Or else 'someobj' wont be GC'ed for some reason.
+    
+    #Trigger GC-runs to collect everything (sleep and second GC makes it collect all!).
+    GC.start
+    sleep 0.001
+    GC.start
+    
+    tenum = $tenum_wref.alive?
+    raise "Expected threadded enumerator to be GCed, but it wasnt." if tenum
+    raise "Expected ensured to be true but it wasnt: #{$ensured}" if !$ensured
+    raise "Expected 'someobj' to be GCed, but it wasnt." if $someobj_wref.alive?
+  end
 end

data/threadded_enumerator.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{threadded_enumerator}
-  s.version = "0.0.0"
+  s.version = "0.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kasper Johansen"]
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<tsafe>, [">= 0"])
+      s.add_development_dependency(%q<wref>, [">= 0"])
       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"])
@@ -48,6 +49,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<tsafe>, [">= 0"])
+      s.add_dependency(%q<wref>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
@@ -56,6 +58,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<tsafe>, [">= 0"])
+    s.add_dependency(%q<wref>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])

metadata

@@ -2,7 +2,7 @@
 name: threadded_enumerator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Kasper Johansen
@@ -25,8 +25,19 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: wref
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -34,10 +45,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rdoc
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,10 +56,10 @@ dependencies:
         version: "3.12"
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,10 +67,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,10 +78,10 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -78,7 +89,7 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 description: Enumerator using thread to avoid fiber-bugs.
 email: k@spernj.org
 executables: []
@@ -115,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2474286237917417948
+      hash: 2306409188715448666
       segments: 
       - 0
       version: "0"