quack_concurrency 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ced3c77423c57792ac57dc44069cb0351e7748c
-  data.tar.gz: ad10b488d8f181de7eb70a8360fba3469053edc4
+  metadata.gz: 1e1b4dcf29faab53b77b05eb8017b8b73c339829
+  data.tar.gz: 85e7852afdcad9dba9fab2b264104844ebd54ad9
 SHA512:
-  metadata.gz: 8c8a971447fec19075e50479653285b5c7a65348a01f9107fa27b3d2b530ee3210b1334ef4c5f26190739532a83442ba2f38fc6945b2d509b5c80cce7a9e5b87
-  data.tar.gz: 23c46a5b6c6d6f3ecfe71e8c7edf28e8068eec4883a1bb5817e85f60be878fbe75dcefc1e6f6019182b2d1244e78f8b7db3113df5162f6381f320902c662ddd0
+  metadata.gz: b934eb948f2cb2a9a7565db507d83130e14363b3ab2e816f590f06ef8d9ccdeff8c3f6e655e4dcf9878f77f1311fcb0ff95ee092cdd881c26ea6e66840cb7c1c
+  data.tar.gz: 27891264874dd9a5083dcb7e9ac10a18665eeb7d538b10caa6471e69bda84c3c93996b3f9d49e4b602f70fe94593a41edb001c77e46b38deb6dad77ec75dee84

data/lib/quack_concurrency.rb

@@ -1,10 +1,11 @@
 require 'thread'
 
-require_relative "quack_concurrency/condition_variable.rb"
-require_relative "quack_concurrency/future.rb"
-require_relative "quack_concurrency/reentrant_mutex.rb"
-require_relative "quack_concurrency/semaphore.rb"
-require_relative "quack_concurrency/waiter.rb"
+require 'quack_concurrency/future'
+require 'quack_concurrency/queue'
+require 'quack_concurrency/reentrant_mutex'
+require 'quack_concurrency/semaphore'
+require 'quack_concurrency/waiter'
+
 
 module QuackConcurrency
 end

data/lib/quack_concurrency/future.rb

@@ -1,17 +1,14 @@
-# Author: Rob Fors
-# Revision Date: 20180102
-
 module QuackConcurrency
   class Future
-    
+  
     class Canceled < StandardError
     end
     
     def initialize(duck_types: {})
+      condition_variable_class = duck_types[:condition_variable] || ConditionVariable
       mutex_class = duck_types[:mutex] || Mutex
-      condition_variable_class = duck_types[:condition_variable] || ::ConditionVariable
-      @mutex = mutex_class.new
       @condition_variable = condition_variable_class.new
+      @mutex = mutex_class.new
       @value = nil
       @value_set = false
       @complete = false

data/lib/quack_concurrency/queue.rb

@@ -0,0 +1,72 @@
+module QuackConcurrency
+  class Queue
+  
+    def initialize(duck_types: {})
+      condition_variable_class = duck_types[:condition_variable] || ConditionVariable
+      mutex_class = duck_types[:mutex] || Mutex
+      @condition_variable = condition_variable_class.new
+      @mutex = mutex_class.new
+      @queue = []
+      @waiting_count = 0
+      @closed = false
+    end
+    
+    def clear
+      @mutex.synchronize { @queue = [] }
+      self
+    end
+    
+    def close
+      @mutex.synchronize do
+        return if closed?
+        @closed = true
+        @condition_variable.broadcast
+      end
+      self
+    end
+    
+    def closed?
+      @closed
+    end
+    
+    def empty?
+      @queue.empty?
+    end
+    
+    def length
+      @queue.length
+    end
+    alias_method :size, :length
+    
+    def num_waiting
+      @waiting_count
+    end
+    
+    def pop
+      @mutex.synchronize do
+        if @waiting_count >= length
+          return if closed?
+          @waiting_count += 1
+          @condition_variable.wait(@mutex)
+          @waiting_count -= 1
+          return if closed?
+        end
+        @queue.shift
+      end
+    end
+    alias_method :deq, :pop
+    alias_method :shift, :pop
+    
+    def push(item = nil)
+      @mutex.synchronize do
+        raise ClosedQueueError if closed?
+        @queue.push(item)
+        @condition_variable.signal
+      end
+      self
+    end
+    alias_method :<<, :push
+    alias_method :enq, :push
+    
+  end
+end

data/lib/quack_concurrency/reentrant_mutex.rb

@@ -1,16 +1,14 @@
-# Author: Rob Fors
-# Revision Date: 20180102
-
 # based off https://en.wikipedia.org/wiki/Reentrant_mutex
 
 module QuackConcurrency
   class ReentrantMutex
   
     def initialize(duck_types: {})
+      condition_variable_class = duck_types[:condition_variable] || ConditionVariable
+      @kernel_module = duck_types[:kernel] || Kernel
       mutex_class = duck_types[:mutex] || Mutex
-      condition_variable_class = duck_types[:condition_variable] || ::ConditionVariable
-      @mutex = mutex_class.new
       @condition_variable = condition_variable_class.new
+      @mutex = mutex_class.new
       @owner = nil
       @lock_depth = 0
     end
@@ -36,6 +34,16 @@ module QuackConcurrency
       @owner == caller
     end
     
+    def sleep(timeout = nil)
+      unlock
+      if timeout
+        @kernel_module.sleep(timeout)
+      else
+        @kernel_module.sleep
+      end
+      lock
+    end
+    
     def synchronize
       lock
       start_depth = @lock_depth
@@ -44,7 +52,7 @@ module QuackConcurrency
       result
     ensure
       unless @lock_depth == start_depth && @owner == start_owner
-        raise 'Could not unlock mutex as its state has been modified.'
+        raise 'could not unlock mutex as its state has been modified'
       end
       unlock
     end
@@ -63,8 +71,8 @@ module QuackConcurrency
     
     def unlock
       @mutex.synchronize do
-        raise "Not locked." if @lock_depth == 0
-        raise "Not the owner." unless @owner == Thread.current
+        raise "not locked" if @lock_depth == 0
+        raise "not the owner" unless @owner == caller
         @lock_depth -= 1
         if @lock_depth == 0
           @owner = nil

data/lib/quack_concurrency/semaphore.rb

@@ -1,17 +1,15 @@
-# Author: Rob Fors
-# Revision Date: 20180102
-
 module QuackConcurrency
   class Semaphore
   
     attr_reader :permit_count
     
     def initialize(permit_count = 1, duck_types: {})
-      raise 'Error: permit_count invalid' if permit_count < 1
+      condition_variable_class = duck_types[:condition_variable] || ConditionVariable
+      raise 'permit_count invalid' if permit_count < 1
       @permit_count = permit_count
       @permits_used = 0
+      @condition_variable = condition_variable_class.new
       @mutex = ReentrantMutex.new(duck_types: duck_types)
-      @condition_variable = ConditionVariable.new
     end
     
     def acquire
@@ -26,7 +24,7 @@ module QuackConcurrency
       @mutex.synchronize do
         remove_permits = @permit_count - new_permit_count
         if remove_permits.positive? && remove_permits > permits_available
-          raise 'Error: can not remove enough permits right not'
+          raise 'can not remove enough permits right not'
         end
         set_permit_count!(new_permit_count)
       end
@@ -34,7 +32,7 @@ module QuackConcurrency
     end
     
     def set_permit_count!(new_permit_count)
-      raise 'Error: permit_count invalid' if new_permit_count < 1
+      raise "'permit_count' invalid" if new_permit_count < 1
       @mutex.synchronize do
         new_permits = new_permit_count - @permit_count
         if new_permits.positive?
@@ -49,7 +47,7 @@ module QuackConcurrency
     
     def release
       @mutex.synchronize do
-        raise 'No pemit to release.' if @permits_used == 0
+        raise 'no pemit to release' if @permits_used == 0
         @permits_used -= 1
         @condition_variable.signal if permit_available?
       end

data/lib/quack_concurrency/waiter.rb

@@ -1,12 +1,8 @@
-# Author: Rob Fors
-# Revision Date: 20180102
-
 module QuackConcurrency
   class Waiter
   
     def initialize(duck_types: {})
-      queue_class = duck_types[:queue] || Queue
-      @queue = queue_class.new
+      @queue = Queue.new(duck_types: duck_types)
     end
     
     def resume(value = nil)

data/spec/queue_spec.rb

@@ -0,0 +1,51 @@
+require 'quack_concurrency'
+
+RSpec.describe QuackConcurrency::Queue do
+  
+  describe "pop" do
+  
+    context "when called when queue empty" do
+      it "should wait" do
+        $test = []
+        queue = QuackConcurrency::Queue.new
+        thread = Thread.new do
+          queue.pop
+          $test << 1
+          sleep 1
+          queue.push
+        end
+        sleep 1
+        queue.push
+        queue.pop
+        $test << 2
+        thread.join
+        expect($test).to eql [1, 2]
+      end
+    end
+    
+    context "when called when queue not empty" do
+      it "should immediately return" do
+        $test = []
+        queue = QuackConcurrency::Queue.new
+        queue.push
+        thread = Thread.new do
+          queue.pop
+          $test << 1
+        end
+        sleep 1
+        $test << 2
+        thread.join
+        expect($test).to eql [1, 2]
+      end
+    end
+    
+    context "when called" do
+      it "should return value of the push" do
+        queue = QuackConcurrency::Queue.new
+        queue.push 1
+        expect(queue.pop).to eql 1
+      end
+    end
+    
+  end
+end

data/spec/reentrant_mutex_spec.rb

@@ -0,0 +1,71 @@
+require 'quack_concurrency'
+
+RSpec.describe QuackConcurrency::ReentrantMutex do
+  
+  describe "lock" do
+  
+    context "when called for first time" do
+      it "should not raise error" do
+        mutex = QuackConcurrency::ReentrantMutex.new
+        expect { mutex.lock }.not_to raise_error
+      end
+    end
+    
+    context "when called the second time" do
+      it "should not raise error" do
+        mutex = QuackConcurrency::ReentrantMutex.new
+        mutex.lock
+        expect { mutex.lock }.not_to raise_error
+      end
+    end
+    
+    context "when called on non owning thread" do
+      it "should wait" do
+        $test = []
+        mutex = QuackConcurrency::ReentrantMutex.new
+        thread = Thread.new do
+          sleep 1
+          mutex.lock
+          $test << 2
+        end
+        mutex.lock
+        sleep 2
+        $test << 1
+        mutex.unlock
+        thread.join
+        expect($test).to eql [1, 2]
+      end
+    end
+    
+  end
+  
+  describe "unlock" do
+  
+    context "when called after one lock" do
+      it "should not raise error" do
+        mutex = QuackConcurrency::ReentrantMutex.new
+        mutex.lock
+        expect { mutex.unlock }.not_to raise_error
+      end
+    end
+    
+    context "when called after two locks" do
+      it "should not raise error" do
+        mutex = QuackConcurrency::ReentrantMutex.new
+        mutex.lock
+        mutex.lock
+        expect { mutex.unlock }.not_to raise_error
+      end
+    end
+    
+    context "when called twice after only one lock" do
+      it "should raise error" do
+        mutex = QuackConcurrency::ReentrantMutex.new
+        mutex.lock
+        mutex.unlock
+        expect { mutex.unlock }.to raise_error(RuntimeError)
+      end
+    end
+    
+  end
+end

data/spec/semaphore_spec.rb

@@ -0,0 +1,27 @@
+require 'quack_concurrency'
+
+RSpec.describe QuackConcurrency::Semaphore do
+  
+  describe "acquire" do
+  
+    context "when no permits are available" do
+      it "should wait" do
+        $test = []
+        semaphore = QuackConcurrency::Semaphore.new(2)
+        thread = Thread.new do
+          sleep 1
+          semaphore.acquire
+          $test << 2
+        end
+        semaphore.acquire
+        semaphore.acquire
+        sleep 2
+        $test << 1
+        semaphore.release
+        thread.join
+        expect($test).to eql [1, 2]
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quack_concurrency
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Fors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies: []
 description: Offers concurrency tools that could also be found in the Concurrent Ruby
   project. However, all these tools will also accept duck types to allow core classes
@@ -21,12 +21,15 @@ files:
 - LICENSE
 - README.md
 - lib/quack_concurrency.rb
-- lib/quack_concurrency/condition_variable.rb
 - lib/quack_concurrency/future.rb
+- lib/quack_concurrency/queue.rb
 - lib/quack_concurrency/reentrant_mutex.rb
 - lib/quack_concurrency/semaphore.rb
 - lib/quack_concurrency/waiter.rb
-- test/test.rb
+- spec/queue_spec.rb
+- spec/reentrant_mutex_spec.rb
+- spec/semaphore_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/robfors/quack_concurrency
 licenses:
 - MIT

data/lib/quack_concurrency/condition_variable.rb

@@ -1,34 +0,0 @@
-# Author: Rob Fors
-# Revision Date: 20180102
-
-module QuackConcurrency
-  class ConditionVariable
-  
-    def initialize(duck_types: {})
-      mutex_class = duck_types[:mutex] || Mutex
-      queue_class = duck_types[:queue] || Queue
-      @mutex = mutex_class.new
-      @queue = queue_class.new
-    end
-    
-    def signal
-      @mutex.synchronize do
-        @queue.push(nil) unless @queue.num_waiting == 0
-      end
-    end
-    
-    def broadcast
-      @mutex.synchronize do
-        @queue.push(nil) until @queue.num_waiting == 0
-      end
-    end
-    
-    def wait(mutex)
-      mutex.unlock
-      @queue.pop
-      mutex.lock
-      nil
-    end
-    
-  end
-end

data/test/test.rb

@@ -1,97 +0,0 @@
-require 'pry'
-
-require_relative "../lib/quack_concurrency.rb"
-
-Thread.abort_on_exception = true
-
-
-
-puts 'test ConditionVariable'
-m = Mutex.new
-c = QuackConcurrency::ConditionVariable.new
-
-t = []
-3.times do
-  t << Thread.new do
-    m.synchronize do
-      c.wait(m)
-      print '.'
-    end
-  end
-end
-
-4.times do
-  sleep 1
-  c.signal
-end
-
-t.each(&:join)
-puts
-
-
-puts 'test ConditionVariable'
-w = QuackConcurrency::Waiter.new
-
-t = []
-3.times do
-  t << Thread.new do
-    w.wait
-    print '.'
-  end
-end
-
-4.times do
-  sleep 1
-  w.resume
-end
-
-t.each(&:join)
-puts
-
-
-puts 'test ReentrantMutex'
-r = QuackConcurrency::ReentrantMutex.new
-
-t = []
-3.times do
-  t << Thread.new do
-    r.lock
-    r.lock
-    r.lock
-      sleep 1
-    r.unlock
-    r.unlock
-    r.unlock
-    begin
-      r.unlock
-    rescue
-    else
-      raise
-    end
-    print '.'
-  end
-end
-
-t.each(&:join)
-puts
-
-
-puts 'test Semaphore'
-s = QuackConcurrency::Semaphore.new(2)
-
-t = []
-4.times do
-  t << Thread.new do
-    s.acquire
-    print '.'
-    sleep 1
-    s.release
-  end
-end
-
-t.each(&:join)
-puts
-
-exit
-binding.pry
-binding.pry