process-group 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 98b4baed52fa9d14e546993096a2e68ca5e2550e
-  data.tar.gz: 630111d7484ecdc7e850c48afc3c437767f3695b
+SHA256:
+  metadata.gz: e0688415bdb9f59086dc3dbdedb5f7ad1ff15c70ef7c01c9f46c31c8a1ca4f52
+  data.tar.gz: 532594d9090ce8b46cb050fd68e651626f90c7370e51e848fbac53cef164aa91
 SHA512:
-  metadata.gz: 57f6dcf3d08a2b85315633c630cca1ace63bfcf678db80882125c1c72773e4377e85503677a58f6d0dfd7917404d3e9085da8de7f09d4c250838f33192fcee2a
-  data.tar.gz: 29f4993f4ded486db893cad0855a6c4af59d4f89ded8f638d99459d4188917c4b9156135f97b98c968e147cb8d31bfb5c7ec1026e37e505a825a78db115fd508
+  metadata.gz: c1cf05b44ba660304634e6597415e3134cc108857114bdd5f46d7b4d31afcce4ebfc8a5cda70c308619ae0680f56f3bc53b93c83f8e605a64a56d866c6ac7048
+  data.tar.gz: 668f5a5a3fbf2e05ec1d540e841f277df3709f987ff72918137cc96066ee145bc4eee997281748b8f377d5ddce27b67b9946769bc5feaac07360d00ef082f738

data/.gitignore

@@ -1,17 +1,12 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1,2 +1,4 @@
---color 
---format documentation 
+--format documentation
+--backtrace
+--warnings
+--require spec_helper

data/.travis.yml

@@ -1,16 +1,14 @@
 language: ruby
-sudo: false
-rvm:
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - ruby-head
-  - rbx-2
-env: COVERAGE=true
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: "ruby-head"
-    - rvm: "rbx-2"
+dist: xenial
+cache: bundler
 
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      os: osx
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls

data/Gemfile

@@ -4,6 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-	gem 'simplecov'
-	gem 'coveralls', require: false
+	gem 'irb'
 end

data/README.md

@@ -2,11 +2,17 @@
 
 `Process::Group` allows for multiple fibers to run system processes concurrently with minimal overhead.
 
-[![Build Status](https://secure.travis-ci.org/ioquatix/process-group.svg)](http://travis-ci.org/ioquatix/process-group)
-[![Code Climate](https://codeclimate.com/github/ioquatix/process-group.svg)](https://codeclimate.com/github/ioquatix/process-group)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/process-group/badge.svg)](https://coveralls.io/r/ioquatix/process-group)
+```ruby
+Process::Group.wait do |group|
+	group.run("ls", "-lah") {|status| puts status.inspect}
+	group.run("echo", "Hello World") {|status| puts status.inspect}
+end
+```
+
+[![Build Status](https://secure.travis-ci.org/socketry/process-group.svg)](http://travis-ci.org/socketry/process-group)
+[![Coverage Status](https://coveralls.io/repos/socketry/process-group/badge.svg)](https://coveralls.io/r/socketry/process-group)
 [![Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/process-group)
-[![Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/ioquatix/process-group)
+[![Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/socketry/process-group)
 
 ## Installation
 
@@ -46,17 +52,19 @@ The `group.wait` call is an explicit synchronization point, and if it completes
 
 Items within a single fiber will execute sequentially. Processes (e.g. via `Group#spawn`) will run concurrently in multiple fibers.
 
-	Process::Group.wait do |group|
-		# Explicity manage concurrency in this fiber:
-		Fiber.new do
-			# These processes will be run sequentially:
-			group.spawn("sleep 1")
-			group.spawn("sleep 1")
-		end.resume
-	
-		# Implicitly run this task concurrently as the above fiber:
-		group.run("sleep 2")
-	end
+```ruby
+Process::Group.wait do |group|
+	# Explicity manage concurrency in this fiber:
+	Fiber.new do
+		# These processes will be run sequentially:
+		group.spawn("sleep 1")
+		group.spawn("sleep 1")
+	end.resume
+
+	# Implicitly run this task concurrently as the above fiber:
+	group.run("sleep 2")
+end
+```
 
 `Group#spawn` is theoretically identical to `Process#spawn` except the processes are run concurrently if possible.
 
@@ -64,61 +72,69 @@ Items within a single fiber will execute sequentially. Processes (e.g. via `Grou
 
 The recommended approach to use process group is to call `Process::Group.wait` with a block which invokes tasks. This block is wrapped in appropriate `rescue Interrupt` and `ensure` blocks which guarantee that the process group is cleaned up:
 
-	Process::Group.wait do |group|
-		group.run("sleep 10")
-	end
+```ruby
+Process::Group.wait do |group|
+	group.run("sleep 10")
+end
+```
 
 It is also possible to invoke this machinery and reuse the process group simply by instantiating the group and calling wait explicitly:
 
-	group = Process::Group.new
-	
-	group.wait do
-		group.run("sleep 10")
-	end
+```ruby
+group = Process::Group.new
+
+group.wait do
+	group.run("sleep 10")
+end
+```
 
 It is also possible to queue tasks for execution outside the wait block. But by design, it's only possible to execute tasks within the wait block. Tasks added outside a wait block will be queued up for execution when `#wait` is invoked:
 
-	group = Process::Group.new
-	
-	group.run("sleep 10")
-	
-	# Run command here:
-	group.wait
+```ruby
+group = Process::Group.new
+
+group.run("sleep 10")
+
+# Run command here:
+group.wait
+```
 
 ### Specify Options
 
 You can specify options to `Group#run` and `Group#spawn` just like `Process::spawn`:
 
-	Process::Group.wait do |group|
-		env = {'FOO' => 'BAR'}
-		
-		# Arguments are essentially the same as Process::spawn.
-		group.run(env, "sleep 1", chdir: "/tmp")
-	end
+```ruby
+Process::Group.wait do |group|
+	env = {'FOO' => 'BAR'}
+	
+	# Arguments are essentially the same as Process::spawn.
+	group.run(env, "sleep 1", chdir: "/tmp")
+end
+```
 
 ### Process Limit
 
 The process group can be used as a way to spawn multiple processes, but sometimes you'd like to limit the number of parallel processes to something relating to the number of processors in the system. By default, there is no limit on the number of processes running concurrently.
 
-	# 'facter' gem - found a bit slow to initialise, but most widely supported.
-	require 'facter'
-	group = Process::Group.new(limit: Facter.processorcount)
-
-	# 'system' gem - found very fast, less wide support (but nothing really important).
-	require 'system'
-	group = Process::Group.new(limit: System::CPU.count)
+```ruby
+# limit based on the number of processors:
+require 'etc'
+group = Process::Group.new(limit: Etc.nprocessors)
 
-	# hardcoded - set to n (8 < n < 32) and let the OS scheduler worry about it.
-	group = Process::Group.new(limit: 32)
+# hardcoded - set to n (8 < n < 32) and let the OS scheduler worry about it:
+group = Process::Group.new(limit: 32)
 
-	# unlimited - default.
-	group = Process::Group.new
+# unlimited - default:
+group = Process::Group.new
+```
 
 ### Kill Group
 
 It is possible to send a signal (kill) to the entire process group:
 
-	group.kill(:TERM)
+```ruby
+group.kill(:TERM)
+```
 
 If there are no running processes, this is a no-op (rather than an error). [Proper handling of SIGINT/SIGQUIT](http://www.cons.org/cracauer/sigint.html) explains how to use signals correctly.
 
@@ -130,43 +146,45 @@ If there are no running processes, this is a no-op (rather than an error). [Prop
 
 You can run a process group with a time limit by using a separate child process:
 
-	group = Process::Group.new
+```ruby
+group = Process::Group.new
+
+class Timeout < StandardError
+end
+
+Fiber.new do
+	# Wait for 2 seconds, let other processes run:
+	group.fork { sleep 2 }
 	
-	class Timeout < StandardError
-	end
+	# If no other processes are running, we are done:
+	Fiber.yield unless group.running?
 	
-	Fiber.new do
-		# Wait for 2 seconds, let other processes run:
-		group.fork { sleep 2 }
-		
-		# If no other processes are running, we are done:
-		Fiber.yield unless group.running?
-		
-		# Send SIGINT to currently running processes:
-		group.kill(:INT)
-		
-		# Wait for 2 seconds, let other processes run:
-		group.fork { sleep 2 }
-		
-		# If no other processes are running, we are done:
-		Fiber.yield unless group.running?
-		
-		# Send SIGTERM to currently running processes:
-		group.kill(:TERM)
-		
-		# Raise an Timeout exception which is based back out:
-		raise Timeout
-	end.resume
+	# Send SIGINT to currently running processes:
+	group.kill(:INT)
 	
-	# Run some other long task:
-	group.run("sleep 10")
+	# Wait for 2 seconds, let other processes run:
+	group.fork { sleep 2 }
 	
-	# Wait for fiber to complete:
-	begin
-		group.wait
-	rescue Timeout
-		puts "Process group was terminated forcefully."
-	end
+	# If no other processes are running, we are done:
+	Fiber.yield unless group.running?
+	
+	# Send SIGTERM to currently running processes:
+	group.kill(:TERM)
+	
+	# Raise an Timeout exception which is based back out:
+	raise Timeout
+end.resume
+
+# Run some other long task:
+group.run("sleep 10")
+
+# Wait for fiber to complete:
+begin
+	group.wait
+rescue Timeout
+	puts "Process group was terminated forcefully."
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,8 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
-end
+RSpec::Core::RakeTask.new(:test)
 
-task :default => :spec
+task :default => :test

data/lib/process/group.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'fiber'
+require 'process/terminal'
 
 module Process
 	# A group of tasks which can be run asynchrnously using fibers. Someone must call Group#wait to ensure that all fibers eventually resume.
@@ -29,70 +30,88 @@ module Process
 			group.wait(&block)
 		end
 		
-		# Executes a command using Process.spawn with the given arguments and options.
 		class Command
-			def initialize(arguments, options, fiber = Fiber.current)
-				@arguments = arguments
+			def initialize(foreground: false, **options)
 				@options = options
-			
-				@fiber = fiber
+				@foreground = foreground
+				
+				@fiber = Fiber.current
+				@pid = nil
 			end
-		
-			attr :arguments
+			
 			attr :options
-		
-			def run(options = {})
-				@pid = Process.spawn(*@arguments, @options.merge(options))
-				
-				return @pid
+			
+			attr :pid
+			
+			def foreground?
+				@foreground
 			end
-		
+			
 			def resume(*arguments)
 				@fiber.resume(*arguments)
 			end
 		end
 		
-		# Runs a given block using a forked process.
-		class Fork
-			def initialize(block, options, fiber = Fiber.current)
-				@options = options
+		# Executes a command using Process.spawn with the given arguments and options.
+		class Spawn < Command
+			def initialize(arguments, **options)
+				@arguments = arguments
+				
+				super(**options)
+			end
+			
+			attr :arguments
+			
+			def call(**options)
+				options = @options.merge(options)
 				
-				raise ArgumentError.new("Fork requires a block!") unless @block = block
+				@pid = Process.spawn(*@arguments, **options)
+			end
+		end
+		
+		# Runs a given block using a forked process.
+		class Fork < Command
+			def initialize(block, **options)
+				@block = block
 				
-				@fiber = fiber
+				super(**options)
 			end
 			
-			def run(options = {})
+			def call(**options)
+				options = @options.merge(options)
+				
 				@pid = Process.fork(&@block)
 				
 				if options[:pgroup] == true
 					# Establishes the child process as a process group leader:
 					Process.setpgid(@pid, 0)
-				else
+				elsif pgroup = options[:pgroup]
 					# Set this process as part of the existing process group:
-					Process.setpgid(@pid, options[:pgroup])
+					Process.setpgid(@pid, pgroup)
 				end
 				
 				return @pid
 			end
-		
+			
 			def resume(*arguments)
 				@fiber.resume(*arguments)
 			end
 		end
 		
 		# Create a new process group. Can specify `limit:` which limits the maximum number of concurrent processes.
-		def initialize(limit: nil)
+		def initialize(limit: nil, terminal: Terminal::Device.open)
 			raise ArgumentError.new("Limit must be nil (unlimited) or > 0") unless limit == nil or limit > 0
 			
 			@pid = Process.pid
 			
+			@terminal = terminal
+			
 			@queue = []
 			@limit = limit
-		
+			
 			@running = {}
 			@fiber = nil
-		
+			
 			@pgid = nil
 			
 			# Whether we can actively schedule tasks or not:
@@ -130,14 +149,20 @@ module Process
 			end.resume
 		end
 		
+		def async
+			Fiber.new do
+				yield self
+			end.resume
+		end
+		
 		# Run a specific command as a child process.
 		def spawn(*arguments, **options)
-			append! Command.new(arguments, options)
+			append! Spawn.new(arguments, **options)
 		end
 		
 		# Fork a block as a child process.
 		def fork(**options, &block)
-			append! Fork.new(block, options)
+			append! Fork.new(block, **options)
 		end
 		
 		# Whether or not #spawn, #fork or #run can be scheduled immediately.
@@ -202,7 +227,7 @@ module Process
 		end
 		
 		def to_s
-			"#<#{self.class} running=#{@running.size} queued=#{@queue.count} limit=#{@limit} pgid=#{@pgid}>"
+			"#<#{self.class} running=#{@running.size} queued=#{@queue.size} limit=#{@limit} pgid=#{@pgid}>"
 		end
 		
 		private
@@ -236,14 +261,18 @@ module Process
 		def schedule!
 			while available? and @queue.size > 0
 				process = @queue.shift
-			
+				
 				if @running.size == 0
-					pid = process.run(:pgroup => true)
+					pid = process.call(:pgroup => true)
 					
 					# The process group id is the pid of the first process:
 					@pgid = pid
 				else
-					pid = process.run(:pgroup => @pgid)
+					pid = process.call(:pgroup => @pgid)
+				end
+				
+				if @terminal and process.foreground?
+					@terminal.foreground = pid
 				end
 				
 				@running[pid] = process

data/lib/process/group/version.rb

@@ -20,6 +20,6 @@
 
 module Process
 	class Group
-		VERSION = "1.1.0"
+		VERSION = "1.2.0"
 	end
 end

data/process-group.gemspec

@@ -1,7 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'process/group/version'
+
+require_relative 'lib/process/group/version'
 
 Gem::Specification.new do |spec|
 	spec.name          = "process-group"
@@ -19,10 +17,13 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
-
+	
 	spec.required_ruby_version = '>= 2.0'
-
-	spec.add_development_dependency "bundler", "~> 1.3"
+	
+	spec.add_dependency "process-terminal"
+	
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec", "~> 3.4.0"
 	spec.add_development_dependency "rake"
 end

data/spec/process/group/foreground_spec.rb

@@ -0,0 +1,34 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'process/group'
+
+RSpec.describe Process::Group do
+	it "can run a process in the foreground" do
+		output, input = IO.pipe
+		
+		subject.wait do
+			subject.run("irb", foreground: true, in: output)
+			
+			input.puts("exit")
+			input.close
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 "bundler/setup"
+require 'covered/rspec'
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	# Disable RSpec exposing methods globally on `Module` and `main`
+	config.disable_monkey_patching!
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: process-group
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: process-terminal
+  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: 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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +91,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -72,6 +99,7 @@ files:
 - lib/process/group.rb
 - lib/process/group/version.rb
 - process-group.gemspec
+- spec/process/group/foreground_spec.rb
 - spec/process/group/fork_spec.rb
 - spec/process/group/interrupt_spec.rb
 - spec/process/group/io_spec.rb
@@ -79,6 +107,7 @@ files:
 - spec/process/group/process_spec.rb
 - spec/process/group/spawn_spec.rb
 - spec/process/group/wait_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ioquatix/process-group
 licenses:
 - MIT
@@ -98,12 +127,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Run processes concurrently in separate fibers with predictable behaviour.
 test_files:
+- spec/process/group/foreground_spec.rb
 - spec/process/group/fork_spec.rb
 - spec/process/group/interrupt_spec.rb
 - spec/process/group/io_spec.rb
@@ -111,3 +140,4 @@ test_files:
 - spec/process/group/process_spec.rb
 - spec/process/group/spawn_spec.rb
 - spec/process/group/wait_spec.rb
+- spec/spec_helper.rb

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end