queue_ding 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6bafcce8d888e90a2e18c0511bdc3e7cdd67b0b
-  data.tar.gz: 7b540a6f5300c9f11ece815865cffe02b730a57d
+  metadata.gz: 0f1c6406efd9e78c4821822dc95d0375f197ab13
+  data.tar.gz: 28ef2796ec8115cc2e78e926828e39298ab53d1d
 SHA512:
-  metadata.gz: a6ea0aa085a40ac46e546f9401f8af5d1a3dd9019acc7b1e5533cf3bbb0e221ad87d491b0e64ea3230a0288e1ca31749262042a0f94f6ea1382086c9ce63910b
-  data.tar.gz: 19a8bc9e79b6370fb43dbbcc73bce935814729ab5c49e2271cdba59e1de15d3f40b11fe7a47b047ece245a15e96b59033bdb3bb004f1314bb446350febb330fb
+  metadata.gz: e9e7bb7e88433ee1240d6c559b8bb0adeb82ef9bac21f26afd81d88342e20a8836ff7078c8cd14b6da8229b79bb2be7fbbec30db5dc1784a6853949dcd3e25af
+  data.tar.gz: c8e7717f0b41820038ffca2c25af3467cd7eddeab2b8ff350c3442e35b4e67707e4fe3670c705e94efe97e4508a6251725e0f4bbbf5049ecf3c34d4db4f00c3d

data/.semver

@@ -1,5 +1,5 @@
 ---
 :major: 0
-:minor: 0
-:patch: 2
+:minor: 1
+:patch: 0
 :special: ''

data/Gemfile.lock

@@ -15,14 +15,14 @@ GEM
       multipart-post (>= 1.2, < 3)
     ffi (1.9.3)
     formatador (0.2.5)
-    git (1.2.7)
-    github_api (0.11.3)
+    git (1.2.8)
+    github_api (0.12.0)
       addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
+      descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
+      hashie (>= 3.2)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6.3)
       oauth2
     guard (2.6.1)
       formatador (>= 0.2.4)
@@ -55,7 +55,7 @@ GEM
     multi_json (1.10.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.2.1)
+    nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
@@ -79,9 +79,9 @@ GEM
       rspec-expectations (~> 2.99.0)
       rspec-mocks (~> 2.99.0)
     rspec-core (2.99.1)
-    rspec-expectations (2.99.1)
+    rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.1)
+    rspec-mocks (2.99.2)
     semver (1.0.1)
     simplecov (0.9.0)
       docile (~> 1.1.0)

data/README.rdoc

@@ -8,6 +8,24 @@ Because this is derived directly from the Array class, it has all the
 expected Array functionality, with the appropriate wrappers for thread
 safety.
 
+== New Funtionality
+=== v0.1.0
+Automatic tee support added, so that multiple listening threads will
+get the same data. There is currenly no way to turn this feature
+off. If this is a problem for you, let me know and I'll add a switch
+sooner.
+
+You may not want this behavior if you are using queue_ding to distrubute
+work among listening threads, but you will want this if you need to ensure
+multile listeners receive the smae data, as in the case with with my
+dyamic interfaces for browser-based Dashboards.
+
+== Known Issues
+=== v0.1.0
+With the new Automatic Tee Feature, there is currently no cleanup
+for dead threads. This could potentially lead to a memory leak situation
+for long running tasks. This problem will be addressed in the next release.
+
 == Gem Version
 {<img src="https://badge.fury.io/rb/queue_ding.png" alt="Gem Version" />}[http://badge.fury.io/rb/queue_ding]
 
@@ -38,7 +56,13 @@ This is taken from the rspec tests.
     tout.join
 
 
-== Future Proposals
+== Changelog
+
+v0.1.0 2014-08-03
+ Added tee capability so that you can tee queue to multiple threads
+ automatically. There are no settings for this. It just works. For some,
+ this behavior may be undesirable, so an option will be added at a later
+ date.
 
 == Copyright
 

data/lib/queue_ding/queue_ding.rb

@@ -12,6 +12,7 @@ be relaxed.
 
 require 'aquarium'
 require 'thread'
+require 'set'
 
 module QueueDing
 
@@ -22,10 +23,13 @@ module QueueDing
   class QDing < Array
     include Aquarium::DSL
 
-    attr_accessor :semaphore, :resource
+    # These accessors are ONLY used internally, and are
+    # subject to change.
+    attr_accessor :semaphore, :resource, :listener_threads
 
     def initialize
       super
+      @listener_threads = Set.new
       @semaphore = Mutex.new
       @resource = ConditionVariable.new
     end
@@ -34,6 +38,7 @@ module QueueDing
     alias_method :dequeue, :shift
     alias_method :enqueue, :push
     alias_method :enqueue, :push
+
     # enqueue, and others that need protection for multithreading
     around calls_to: [:<<,
                       :enqueue,
@@ -54,15 +59,30 @@ module QueueDing
     ] do |join_point, q, *args|
       result = nil
       q.semaphore.synchronize {
-        while q.empty?
+        q.listener_threads << (curth = Thread.current)
+        curth[:localq] ||= []
+
+        while q.empty? and curth[:localq].empty?
           q.resource.wait(q.semaphore)
         end
-        result = join_point.proceed
+        # At this point, at least one of the queues have something.
+        # What we do here is that if we have something in the main
+        # queue? We distribute that to the other waiting threads.
+        # Those threads will check their own localq to see if they have
+        # an entry, etc.
+        result = unless curth[:localq].empty?
+                   curth[:localq].shift
+                 else
+                   r = join_point.proceed
+                   q.listener_threads.reject{|t|
+                     t == curth
+                   }.each{ |t|
+                     t[:localq] << r
+                   }
+                   r
+                 end
       }
       result
     end
   end
-
 end
-
-

data/queue_ding.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: queue_ding 0.0.2 ruby lib
+# stub: queue_ding 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "queue_ding"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Fred Mitchell"]
-  s.date = "2014-07-20"
+  s.date = "2014-08-03"
   s.description = "\n  This roughly mirrors the functionaly of Queue in allowing you to\n  queue messages to one or more threads, and will block if the queue\n  is empty, waking up when there is another message available.\n  "
   s.email = "lordalveric@yahoo.com"
   s.extra_rdoc_files = [

data/spec/queue_ding_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'thread'
 
-CNT = 100000
+CNT = 10000
 CNTI = CNT
 CNTO = CNT
 
@@ -48,4 +48,20 @@ describe QueueDing::QDing do
     tout.join
     expect(@queue.empty?).to be_truthy
   end
+
+  it "handles teeing" do
+    tg = ThreadGroup.new
+    tg.add Thread.new {
+      sleep 5
+      (0..CNT).each{|i| @queue << i }
+    }
+
+    20.times do
+      tg.add Thread.new {
+        (0..CNT).each{|i| expect(i).to eq @queue.next }
+      }
+    end
+
+    tg.list.each {|t| t.join }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue_ding
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Fred Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aquarium