async-runner 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33d2179d3e676bc4c06d3ded55a6828259b930ccda50633c2e3989540f94d8ed
+  data.tar.gz: c20f7a18ac21ccc6241925cecf7442d208d571daae6e9c168983c053f0216647
+SHA512:
+  metadata.gz: 60afb068a72c4b93b57b304216f90e9cc5a3d1eeea68b44c1d4b45e5d4a62526fce109cdbe78c43b31425d28bb27ff5ea6b5915063ba7bd890d4507bd9b1ad70
+  data.tar.gz: 03dc4440efc32f65a92ac956f0368722452bbc8114e4b4a4a3410a04fc74184ccb036fb777bf9146f8f60ebb589d1b8d838238409de57a2a6f8bf012647821f2

data/exe/async-runner

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+# Copyright, 2022, by Anton Sozontov.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../lib/async/runner'
+
+begin
+  Async::Runner::Command.call
+rescue Interrupt
+  # Ignore.
+rescue => error
+  Console.logger.error(Async::Runner::Command) {error}
+  exit! 1
+end

data/lib/async/runner/command.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Copyright, 2022, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2022, by Anton Sozontov.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'samovar'
+require 'async/container'
+
+module Async
+  module Runner
+    class Command < Samovar::Command
+      MAX_FIBERS = 1000
+
+      self.description = "Scalable multi-thread multi-process container"
+
+      # The command line options.
+      # @attribute [Samovar::Options]
+      options do
+        option '--verbose | --quiet', "Verbosity of output for debugging.", key: :logging
+        option '-h/--help', "Print out help information."
+        option '-v/--version', "Print out the application version."
+        option '--restart', "Restart containers if they fail"
+
+        option '--forked | --threaded | --hybrid', "Select a specific parallelism model.", key: :container, default: :forked
+
+        option '-n/--count <count>', "Number of instances to start.", default: Async::Container.processor_count, type: Integer
+
+        option '--forks <count>', "Number of forks (hybrid only).", type: Integer
+        option '--threads <count>', "Number of threads (hybrid only).", type: Integer
+        option '-j/--jobs <count>', "Maximum number of async, parallel jobs.", type: Integer, default: MAX_FIBERS
+      end
+
+      one :file, "File to run in containers", required: true
+
+      # Whether verbose logging is enabled.
+      # @returns [Boolean]
+      def verbose?
+        @options[:logging] == :verbose
+      end
+
+      # Whether quiet logging was enabled.
+      # @returns [Boolean]
+      def quiet?
+        @options[:logging] == :quiet
+      end
+
+      # Prepare the environment and invoke the sub-command.
+      def call
+        if @options[:version]
+          puts "#{self.name} v#{Async::Runner::VERSION}"
+        elsif @options[:help]
+          self.print_usage
+        else
+          run
+        end
+      end
+
+      # The container class to use.
+      def container_class
+        case @options[:container]
+        when :threaded
+          return Async::Container::Threaded
+        when :forked
+          return Async::Container::Forked
+        when :hybrid
+          return Async::Container::Hybrid
+        end
+      end
+
+      def container_options
+        if @options[:container] == :hybrid
+          options.slice(:count, :forks, :threads, :name, :restart, :key)
+        else
+          options.slice(:count, :name, :restart, :key)
+        end
+      end
+
+      def job_class
+        Async::Runner::Job
+      end
+
+      private
+
+      def run
+        Async::Runner::Controller.run(self)
+      end
+    end
+  end
+end

data/lib/async/runner/controller.rb

@@ -0,0 +1,34 @@
+module Async
+	module Runner
+		class Controller < Async::Container::Controller
+			def self.run(command)
+				new(command).run
+			end
+
+			def initialize(command)
+				@command = command
+				super()
+			end
+
+			def create_container
+				@command.container_class.new
+			end
+
+			def create_job
+				@command.job_class.new(@command.file, **@command.options)
+			end
+
+			def setup(container)
+				@job = create_job
+				@job.setup
+
+				container.run name: @command.file, **@command.container_options do |instance|
+					instance.ready!
+					Sync do
+						@job.execute
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/runner/job.rb

@@ -0,0 +1,70 @@
+module Async
+	module Runner
+		class Job
+			include Console
+
+			attr_reader :block, :options
+
+			def initialize(file, **options)
+				path = File.realpath(file)
+				@options = options
+				@barrier = Async::Barrier.new
+				@semaphore = Async::Semaphore.new(options[:jobs], parent: @barrier)
+				instance_eval File.read(path), path
+			end
+
+			def before(container=nil, options=nil, &block)
+				if block_given?
+					@before_block = block
+				else
+					@before_block&.call(container, options)
+				end
+			end
+
+			def job
+				self
+			end
+
+			def run(&block)
+				@block = block
+			end
+
+			def execute
+				@block.call(job)
+				@barrier.wait
+			end
+
+			def limit(limit)
+				@semaphore = Async::Semaphore.new(limit, parent: @barrier)
+			end
+
+			def progress(total:)
+				@progress = logger.progress("jobs", total)
+			end
+
+			def async(&block)
+				@semaphore.async do
+					block.call
+					@progress&.increment
+				end
+			end
+
+			def setup(&block)
+				if block_given?
+					@setup_block = block
+				else
+					@setup_block&.call job
+				end
+			end
+
+			def intro
+				type = options[:container].to_s.capitalize
+				Console.logger.info "=> Starting #{type} async containers"
+			end
+
+			def self.to_s
+				"Runner"
+			end
+		end
+	end
+end

data/lib/async/runner/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Async
+  module Runner
+    VERSION = "0.1.2"
+  end
+end

data/lib/async/runner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'async'
+require 'async/container'
+require 'async/barrier'
+require 'async/semaphore'
+require 'async/queue'
+require 'console'
+require_relative "runner/version"
+require_relative "runner/job"
+require_relative "runner/controller"
+require_relative "runner/command"
+
+module Async
+  module Runner
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: async-runner
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Anton Sozontov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: samovar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description:
+email:
+executables:
+- async-runner
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/async-runner
+- lib/async/runner.rb
+- lib/async/runner/command.rb
+- lib/async/runner/controller.rb
+- lib/async/runner/job.rb
+- lib/async/runner/version.rb
+homepage: https://github.com/webgago/async-runner
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Abstract runner with container-based parallelism using threads and processes
+  where appropriate.
+test_files: []