pwork 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2731486c2af84b607e31651780ca3b57511e1496
-  data.tar.gz: ddbe9066147e3a962302493eecc992541a221290
+SHA256:
+  metadata.gz: 249a3ee4b5ad1dd558bcdae10f0309404ec9841693c1f22714904cc8c70f43fb
+  data.tar.gz: 260de7aa9d02fad3f92faf0b00c70bb61689e8a03db64a9bac491c6566b900b3
 SHA512:
-  metadata.gz: 75958149fd8a60da17ff86b7e1d2a9750944d1f4a5e5bc0177a416f6ab7c4795f46350cd694395414813112859684cd456c57fb8e0613e9e33e8f7d2149a7a38
-  data.tar.gz: 25fc545ed0139c580d5f5f8fcf6fd80b87cd17688603882984421729480feeb1b332e482cda1c01f1b69911599e8f301a1e3b693d2e0e6d2d37ff2057a20fd17
+  metadata.gz: 9da793781dfdfa26129d40240783b5c0b7a923ac6ee42297c9632e02308ad5fa5fee4fecb0b5a8ffc887d5df9f76dafe72739cf6ca4eacdae2637af27930024d
+  data.tar.gz: 0833eacb1192ca4fce94848b952aa151f0c92767e077c85573f15c4acc544133c974c6522e8900b82d85c94be170115e9e6dc5e062b8c888147b4016be10fa78

data/lib/pwork.rb

@@ -1,4 +1,3 @@
-require 'pwork/version'
 require_relative 'pwork/helpers/thread'
 
 require_relative 'pwork/array'
@@ -8,4 +7,6 @@ if RUBY_PLATFORM =~ /java/
   require_relative 'pwork/jruby/thread_pool'
 else
   require_relative 'pwork/mri/thread_pool'
-end
+end
+
+require_relative 'pwork/async'

data/lib/pwork/async.rb

@@ -0,0 +1,65 @@
+require_relative 'async/task'
+require_relative 'async/exceptions'
+require_relative 'async/manager'
+
+module PWork
+  module Async
+    def async(options = nil, &block)
+      if block_given?
+        PWork::Async.add_task(options, &block)
+      else
+        raise PWork::Async::Exceptions::InvalidOptionsError.new(
+          'Unknown async option.'
+        ) unless options == :wait
+        PWork::Async.wait_for_tasks
+      end
+    end
+
+    def self.manager
+      @manager ||= PWork::Async::Manager.new
+    end
+
+    def self.add_task(options, &block)
+      manager.start unless manager.running
+
+      options = {} if options == nil
+      task = PWork::Async::Task.new.tap do |e|
+        e.block = block
+      end
+
+      unless options[:wait] == false
+        tasks << task
+      end
+
+      manager.add_task(task)
+
+      task.id
+    end
+
+    def self.tasks
+      Thread.current[:pwork_async_tasks] ||= []
+    end
+
+    def self.wait_for_tasks
+      until tasks.detect { |t| t.state == :pending || t.state == :active }.nil?
+        sleep(async_wait_sleep_iteration)
+      end
+      handle_errors
+      ensure
+        Thread.current[:pwork_async_tasks] = []
+    end
+
+    def self.handle_errors
+      error_messages = []
+      tasks.select { |t| t.state == :error }.each do |t|
+        error_messages << "Error: #{t.error.message}, #{t.error.backtrace}"
+      end
+      raise PWork::Async::Exceptions::TaskError.new("1 or more async errors occurred. #{error_messages.join(' | ')}") if error_messages.length > 0
+      true
+    end
+
+    def self.async_wait_sleep_iteration
+      Integer(ENV.fetch('PWORK_ASYNC_WAIT_SLEEP_ITERATION', 0.01))
+    end
+  end
+end

data/lib/pwork/async/exceptions.rb

@@ -0,0 +1,2 @@
+require_relative 'exceptions/invalid_options'
+require_relative 'exceptions/task_error'

data/lib/pwork/async/exceptions/invalid_options.rb

@@ -0,0 +1,11 @@
+module PWork
+  module Async
+    module Exceptions
+      class InvalidOptionsError < StandardError
+        def initialize(message)
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/pwork/async/exceptions/task_error.rb

@@ -0,0 +1,11 @@
+module PWork
+  module Async
+    module Exceptions
+      class TaskError < StandardError
+        def initialize(message)
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/pwork/async/manager.rb

@@ -0,0 +1,76 @@
+require 'thread'
+
+module PWork
+  module Async
+    class Manager
+      def initialize
+        @queue = Queue.new
+        @threads = []
+        @running = false
+      end
+
+      # This method is called to determine if this manager is running or not
+      def running
+        @running
+      end
+
+      # This method is called to start the async manager
+      def start
+        @running = true
+        pool_size.times do
+          @threads << Thread.new do
+            until @running == false
+              process_task
+            end
+          end
+        end
+      end
+
+      # This method is called to stop the async manager
+      def stop
+        @running = false
+        @threads = []
+      end
+
+      # This method is called to determine the size of the async thread pool
+      def pool_size
+        Integer(ENV.fetch('PWORK_ASYNC_POOL_SIZE', 10))
+      end
+
+      # This method is called to process an async task from the queue
+      def process_task
+        task = @queue.pop
+        task.state = :active
+        thread_helper.set_thread_vars(task.thread_local_storage)
+        begin
+          task.block.call
+          task.state = :complete
+        rescue => e
+          task.error = e
+          task.state = :error
+        ensure
+          thread_helper.reset_thread_vars
+        end
+      end
+
+      # This method is called to expose the thread helper
+      def thread_helper
+        PWork::Helpers::Threads
+      end
+
+      # This method is called to determine the number of tasks in the queue
+      def queue_count
+        @queue.length
+      end
+
+      # This method is called to add a task to the queue
+      def add_task(task)
+        raise PWork::Async::Exceptions::InvalidOptionsError.new(
+          'A valid async task must be specified.'
+        ) unless task.is_a?(PWork::Async::Task)
+        task.thread_local_storage = PWork::Helpers::Threads.get_thread_vars
+        @queue.push(task)
+      end
+    end
+  end
+end

data/lib/pwork/async/task.rb

@@ -0,0 +1,17 @@
+require 'securerandom'
+module PWork
+  module Async
+    class Task
+      attr_accessor :id
+      attr_accessor :state
+      attr_accessor :thread_local_storage
+      attr_accessor :error
+      attr_accessor :block
+      def initialize
+        self.id = SecureRandom.uuid
+        self.state = :pending
+        self.thread_local_storage = []
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwork
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- vaughanbrittonage
+- vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,7 +69,7 @@ dependencies:
 description: This is a library to facilitate with the execution of work on parallel
   threads.
 email:
-- vaughanbritton@gmail.com
+- vaughan.britton@sage.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -78,12 +78,17 @@ files:
 - bin/setup
 - lib/pwork.rb
 - lib/pwork/array.rb
+- lib/pwork/async.rb
+- lib/pwork/async/exceptions.rb
+- lib/pwork/async/exceptions/invalid_options.rb
+- lib/pwork/async/exceptions/task_error.rb
+- lib/pwork/async/manager.rb
+- lib/pwork/async/task.rb
 - lib/pwork/helpers/thread.rb
 - lib/pwork/jruby/thread_pool.rb
 - lib/pwork/mri/thread_pool.rb
-- lib/pwork/version.rb
 - lib/pwork/worker.rb
-homepage: https://github.com/vaughanbrittonsage/pwork
+homepage: https://github.com/sage/pwork
 licenses:
 - MIT
 metadata: {}
@@ -103,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This is a library to facilitate with the execution of work on parallel threads.

data/lib/pwork/version.rb

@@ -1,3 +0,0 @@
-module PWork
-  VERSION = "1.0.1"
-end