dispatch_queue_rb 1.0.0

data/lib/dispatch_queue_rb/mixins/dispatch_sync_impl.rb

@@ -0,0 +1,42 @@
+# =============================================================================
+#
+# MODULE      : lib/dispatch_queue_rb/mixins/dispatch_sync_impl.rb
+# PROJECT     : DispatchQueue
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module DispatchQueue
+  module DispatchSyncImpl
+
+    def dispatch_sync( group:nil, &task )
+      mutex, condition = ConditionVariablePool.acquire()
+      result = nil
+      mutex.synchronize do
+        dispatch_async( group:group ) do
+          result = task.call()
+          mutex.synchronize { condition.signal() }
+        end
+        condition.wait( mutex )
+      end
+      ConditionVariablePool.release( mutex, condition )
+      result
+    end
+
+    def dispatch_barrier_sync( group:nil, &task )
+      mutex, condition = ConditionVariablePool.acquire()
+      result = nil
+      mutex.synchronize do
+        dispatch_barrier_async( group:group ) do
+          result = task.call()
+          mutex.synchronize { condition.signal() }
+        end
+        condition.wait( mutex )
+      end
+      ConditionVariablePool.release( mutex, condition )
+      result
+    end
+
+  end # class DispatchSyncImpl
+end # module DispatchQueue

data/lib/dispatch_queue_rb/serial_queue.rb

@@ -0,0 +1,77 @@
+# =============================================================================
+#
+# MODULE      : lib/dispatch_queue_rb/serial_queue.rb
+# PROJECT     : DispatchQueue
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module DispatchQueue
+  class SerialQueue
+
+    def initialize( parent_queue: nil )
+      @mutex = Mutex.new
+      @condition = ConditionVariable.new
+      @task_list = []
+      @active = false
+      @parent_queue = parent_queue || Dispatch.default_queue
+    end
+
+    def dispatch_async( group:nil, &task )
+      group.enter() if group
+      continuation = Continuation.new( target_queue:@parent_queue, group:group ) do
+        _run_task( task )
+      end
+
+      continuation.run() if _try_activate_or_enqueue( continuation )
+      self
+    end
+
+    alias_method :dispatch_barrier_async, :dispatch_async
+
+    include DispatchSyncImpl
+    include DispatchAfterImpl
+
+
+
+  private
+    def _try_activate_or_enqueue( continuation )
+      @mutex.synchronize do
+        if (!@active)
+          @active = true
+          return true
+        else
+          @task_list << continuation
+          return false
+        end
+      end
+    end
+
+    def _run_task( task )
+      previous_queue = Thread.current[:current_queue]
+      Thread.current[:current_queue] = self
+
+      begin
+        task.call()
+      ensure
+        Thread.current[:current_queue] = previous_queue
+        _dispatch_next_task()
+      end
+    end
+
+    def _dispatch_next_task()
+      continuation = _suspend_or_next_task()
+      continuation.run() if continuation
+    end
+
+    def _suspend_or_next_task()
+      @mutex.synchronize do
+        return @task_list.shift if !@task_list.empty?
+        @active = false
+        return nil
+      end
+    end
+
+  end # class SerialQueue
+end # module DispatchQueue

data/lib/dispatch_queue_rb/version.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : lib/dispatch_queue_rb/version.rb
+# PROJECT     : DispatchQueueRb
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module DispatchQueue
+  VERSION = '1.0.0'
+end

data/rakefile.rb

@@ -0,0 +1,110 @@
+# =============================================================================
+#
+# MODULE      : rakefile.rb
+# PROJECT     : DispatchQueueRb
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: [:test, :build]
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = false
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definitions to help formating 'rake watch' results
+# ----------------------------------------------------------------------------
+
+TERM_WIDTH = `tput cols`.to_i || 80
+
+def tty_red(str);           "\e[31m#{str}\e[0m" end
+def tty_green(str);         "\e[32m#{str}\e[0m" end
+def tty_blink(str);         "\e[5m#{str}\e[25m" end
+def tty_reverse_color(str); "\e[7m#{str}\e[27m" end
+
+def print_separator( success = true )
+  if success
+    puts tty_green( "-" * TERM_WIDTH )
+  else
+    puts tty_reverse_color(tty_red( "-" * TERM_WIDTH ))
+  end
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definition of watch task, that monitors the project folder for any relevant
+# file change and runs the unit test of the project.
+# ----------------------------------------------------------------------------
+
+begin
+  require 'watch'
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :watch do
+    Watch.new( '**/*.rb' ) do
+      success = system "clear && rake test"
+      print_separator( success )
+    end
+  end
+
+rescue LoadError
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :watch do
+    puts
+    puts "'rake watch' requires the watch gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install watch"
+    puts " or "
+    puts "    sudo gem install watch"
+    puts
+    fail
+  end
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definition of add_class[class_name] task, that uses folder_template to add
+# a new class to a ruvy project
+# ----------------------------------------------------------------------------
+
+PROJECT_CONTEXT = {
+  project_name:       "dispatch_queue_rb",
+  project_namespace:  "DispatchQueue",
+  copyright_owner:    "Marc-Antoine Argenton",
+  copyright_year:     "2016",
+}
+
+begin
+  require 'folder_template'
+
+  task :add_class, :class_name do |t, args|
+    context = PROJECT_CONTEXT.merge( name:args[:class_name])
+    FolderTemplate::SetupFolderCmd.run( '.', 'rubyclass', context )
+  end
+rescue LoadError
+  task :add_class, :class_name do |t, args|
+    puts
+    puts "'rake add_class[class_name]' task requires the folder_template gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install folder_template"
+    puts " or "
+    puts "    sudo gem install folder_template"
+    puts
+    fail
+  end
+end

data/test/_test_env.rb

@@ -0,0 +1,52 @@
+# =============================================================================
+#
+# MODULE      : test/_test_env.rb
+# PROJECT     : DispatchQueueRb
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'fileutils'
+require 'pp'
+require 'rr'
+require 'timeout'
+
+require 'lib/dispatch_queue_rb.rb'
+
+# Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+# Minitest.backtrace_filter
+# Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new( color:true ), Minitest::Reporters::JUnitReporter.new]
+
+
+Thread.abort_on_exception = true
+
+module Minitest::Assertions
+  def assert_must_timeout( timeout_delay = 0.001 )
+    success = false
+    begin
+      timeout( timeout_delay ) do
+        yield
+      end
+    rescue Timeout::Error => e
+      success = true
+    end
+
+    assert success, "Expected operation to not complete within #{timeout_delay}s, but did"
+  end
+
+  def assert_wont_timeout( timeout_delay = 0.001 )
+    success = true
+    begin
+      timeout( timeout_delay ) do
+        yield
+      end
+    rescue Timeout::Error => e
+      success = false
+    end
+
+    assert success, "Expected operation to complete within #{timeout_delay}s, but did not"
+  end
+end

data/test/test_concurrent_queue.rb

@@ -0,0 +1,90 @@
+# =============================================================================
+#
+# MODULE      : test/test_concurrent_queue.rb
+# PROJECT     : DispatchQueue
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+module DispatchQueue
+  describe ConcurrentQueue do
+
+    let( :task_count )    { 10 }
+    let( :log )           { [] }
+    let( :lock )          { Mutex.new }
+    let( :logger )        { Proc.new { |e, d| lock.synchronize { log << [e, d] } } }
+    subject               { ConcurrentQueue.new }
+
+    it "can initialize a serial queue" do
+      subject.must_be_instance_of ConcurrentQueue
+    end
+
+    def task( task_id )
+      logger.call( :begin_task, { task_id:task_id, thread:Thread.current } )
+      sleep(0.001)
+      logger.call( :end_task, { task_id:task_id, thread:Thread.current } )
+    end
+
+    describe "dispatch_async" do
+      it "executes tasks concurrently" do
+        (1..task_count).each { |i| subject.dispatch_async { task( i ) } }
+        subject.dispatch_barrier_sync {} # wait for all previous tasks to complete
+
+        running_count = 0
+        parallel_task_count = log.map do |e,d|
+          running_count += 1 if e == :begin_task
+          running_count -= 1 if e == :end_task
+          running_count
+        end
+
+        parallel_task_count.max.must_be :>, 1, parallel_task_count
+      end
+
+      it "preserves ordering arround barrier" do
+        (1..task_count).each { |i| subject.dispatch_async { task( "a#{i}".to_sym ) } }
+        subject.dispatch_barrier_async { task( "b0".to_sym ) }
+        (1..task_count).each { |i| subject.dispatch_async { task( "c#{i}".to_sym ) } }
+        subject.dispatch_barrier_async { task( "d0".to_sym ) }
+
+        subject.dispatch_barrier_sync {} # wait for all previous tasks to complete
+
+        task_id_list = log.select { |e,d| e == :begin_task }.map { |e,d| d[:task_id] }
+        task_chunks = task_id_list.chunk { |e| e.to_s[0] }.map { |c, l| l }
+        task_chunks.count.must_be :==, 4, task_chunks
+      end
+
+      it "resumes execution after synchronous barrier" do
+        (1..task_count).each { |i| subject.dispatch_async { task( "a#{i}".to_sym ) } }
+        subject.dispatch_barrier_sync { task( "b0".to_sym ) }
+        (1..task_count).each { |i| subject.dispatch_async { task( "c#{i}".to_sym ) } }
+        subject.dispatch_barrier_sync { task( "d0".to_sym ) }
+
+        subject.dispatch_barrier_sync {} # wait for all previous tasks to complete
+
+        task_id_list = log.select { |e,d| e == :begin_task }.map { |e,d| d[:task_id] }
+        task_chunks = task_id_list.chunk { |e| e.to_s[0] }.map { |c, l| l }
+        task_chunks.count.must_be :==, 4, task_chunks
+      end
+    end
+
+    describe "with multiple concurrent queues" do
+      let( :subject2 )    { ConcurrentQueue.new }
+
+      it "interleaves barrier tasks from different queues" do
+        (1..task_count).each { |i| subject.dispatch_barrier_async { task( "a#{i}".to_sym ) } }
+        (1..task_count).each { |i| subject2.dispatch_barrier_async { task( "b#{i}".to_sym ) } }
+        subject.dispatch_barrier_sync {} # wait for all previous tasks to complete
+        subject2.dispatch_barrier_sync {} # wait for all previous tasks to complete
+
+        task_id_list = log.select { |e,d| e == :begin_task }.map { |e,d| d[:task_id] }
+        task_chunks = task_id_list.chunk { |e| e.to_s[0] }.map { |c, l| l }
+        task_chunks.count.must_be :>, 3, task_chunks
+      end
+    end
+
+  end
+end

data/test/test_condition_variable_pool.rb

@@ -0,0 +1,41 @@
+# =============================================================================
+#
+# MODULE      : test/test_condition_variable_pool.rb
+# PROJECT     : DispatchQueue
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+module DispatchQueue
+  describe ConditionVariablePool do
+
+    describe "acquire" do
+      it "returns a pair of mutex and condition variable" do
+        mutex, condition = ConditionVariablePool.acquire()
+        mutex.must_be_instance_of Mutex
+        condition.must_be_instance_of ConditionVariable
+      end
+    end
+
+    describe "release" do
+      it "releases mutex and condition variable" do
+        mutex, condition = ConditionVariablePool.acquire()
+        ConditionVariablePool.release( mutex, condition )
+      end
+
+      it "recycles released mutex and condition variable" do
+        mutex, condition = ConditionVariablePool.acquire()
+        ConditionVariablePool.release( mutex, condition )
+        mutex2, condition2 = ConditionVariablePool.acquire()
+
+        mutex2.must_be_same_as mutex
+        condition2.must_be_same_as condition
+      end
+    end
+
+  end
+end

data/test/test_continuation.rb

@@ -0,0 +1,23 @@
+# =============================================================================
+#
+# MODULE      : test/test_continuation.rb
+# PROJECT     : DispatchQueue
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+module DispatchQueue
+  describe Continuation do
+
+    subject { Continuation.new }
+
+    it "passes this one" do
+      subject.must_be_instance_of Continuation
+    end
+
+  end
+end