process-group 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb7a4e8773cff719edfa1b553e7773c34d6a3537
-  data.tar.gz: b746a13f2d670c5a3051c1d076da83b38461d5ee
+  metadata.gz: 28a68aa53cd296412dd77cdca5a9c8b000269439
+  data.tar.gz: 49777327e43bbddda6e17a2b13776227693d115d
 SHA512:
-  metadata.gz: 5d475c34015705d9a7fd8fbca38bff1e1964338e9c210c6dc901da1ce40393d690cccaee4df3201ac4badff5151e9c74ef76f3c51a6f69ee2fc7d10ba7789d68
-  data.tar.gz: 0f9d5c41fb03e194cee54272a87a3d0c3df2f6251587648ef1cc04d3d3a9a8e5e109e0519ae62e02de460d30d92833a5f65655b0c06fe1ce7af485470de9c157
+  metadata.gz: 508765b5658d4fbb032c7f43f36a5a9c26e4fbbfc379295398d3ac08e9da12bab9440cb9002bd052d9eaaba5abbbd9ee970f8a290ceaab144ad682e53e95ebfb
+  data.tar.gz: 0f7d655bd81259b92c757342ff71aee743209e33dbb3c1a71e4b4facd0c4dac5de706a01735c4afd964feb6b52429e8d6b07e706db992408a7da81f599b5a4e9

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation 

data/.travis.yml

@@ -1,7 +1,14 @@
 language: ruby
 sudo: false
 rvm:
-  - "2.0"
-  - "2.1"
-  - "2.2"
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+  - rbx-2
 env: COVERAGE=true
+matrix:
+  allow_failures:
+    - rvm: "rbx-2"
+

data/README.md

@@ -5,6 +5,8 @@
 [![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)
+[![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)
 
 ## Installation
 

data/lib/process/group.rb

@@ -23,6 +23,7 @@ require 'fiber'
 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.
 	class Group
+		# Executes a command using Process.spawn with the given arguments and options.
 		class Command
 			def initialize(arguments, options, fiber = Fiber.current)
 				@arguments = arguments
@@ -45,6 +46,7 @@ module Process
 			end
 		end
 		
+		# Runs a given block using a forked process.
 		class Fork
 			def initialize(block, options, fiber = Fiber.current)
 				@options = options
@@ -73,8 +75,10 @@ module Process
 			end
 		end
 		
-		# Create a new process group. Can specify `options[:limit]` which limits the maximum number of concurrent processes.
+		# Create a new process group. Can specify `limit:` which limits the maximum number of concurrent processes.
 		def initialize(limit: nil)
+			raise ArgumentError.new("Limit must be nil (unlimited) or > 0") unless limit == nil or limit > 0
+			
 			@pid = Process.pid
 			
 			@queue = []
@@ -99,11 +103,12 @@ module Process
 			-@pgid
 		end
 
+		# Are there processes currently running?
 		def running?
 			@running.size > 0
 		end
 
-		# Run a process, arguments have same meaning as Process#spawn.
+		# Run a process in a new fiber, arguments have same meaning as Process#spawn.
 		def run(*arguments)
 			Fiber.new do
 				exit_status = self.spawn(*arguments)
@@ -112,15 +117,17 @@ module Process
 			end.resume
 		end
 		
+		# Run a specific command as a child process.
 		def spawn(*arguments, **options)
 			append! Command.new(arguments, options)
 		end
 		
+		# Fork a block as a child process.
 		def fork(**options, &block)
 			append! Fork.new(block, options)
 		end
 		
-		# Whether not not calling run would be scheduled immediately.
+		# Whether or not #spawn, #fork or #run can be scheduled immediately.
 		def available?
 			if @limit
 				@running.size < @limit
@@ -129,12 +136,12 @@ module Process
 			end
 		end
 		
-		# Whether or not calling run would block the caller.
+		# Whether or not calling #spawn, #fork or #run would block the caller fiber (i.e. call Fiber.yield).
 		def blocking?
 			not available?
 		end
 		
-		# Wait for all processes to finish, naturally would schedule any fibers which are currently blocked.
+		# Wait for all running and queued processes to finish.
 		def wait
 			raise ArgumentError.new("Cannot call Process::Group#wait from child process!") unless @pid == Process.pid
 			
@@ -168,8 +175,8 @@ module Process
 			wait_all
 		end
 		
-		# Send a signal to all processes.
-		def kill(signal)
+		# Send a signal to all currently running processes. No-op unless #running?
+		def kill(signal = :INT)
 			if running?
 				Process.kill(signal, id)
 			end
@@ -177,6 +184,7 @@ module Process
 		
 		private
 		
+		# Append a process to the queue and schedule it for execution if possible.
 		def append!(process)
 			@queue << process
 			

data/lib/process/group/version.rb

@@ -20,6 +20,6 @@
 
 module Process
 	class Group
-		VERSION = "1.0.0"
+		VERSION = "1.0.1"
 	end
 end

data/process-group.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 	Manages a unix process group for running multiple processes, keeps track of multiple processes and leverages fibers to provide predictable behaviour in complicated process-based scripts.
 	EOF
 	spec.summary       = %q{Run processes concurrently in separate fibers with predictable behaviour.}
-	spec.homepage      = ""
+	spec.homepage      = "https://github.com/ioquatix/process-group"
 	spec.license       = "MIT"
 
 	spec.files         = `git ls-files`.split($/)
@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 	spec.required_ruby_version = '>= 2.0'
 
 	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.3.0"
+	spec.add_development_dependency "rspec", "~> 3.4.0"
 	spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process-group
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-22 00:00:00.000000000 Z
+date: 2016-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".simplecov"
 - ".travis.yml"
 - Gemfile
@@ -77,7 +78,7 @@ files:
 - spec/process/group/load_spec.rb
 - spec/process/group/process_spec.rb
 - spec/process/group/spawn_spec.rb
-homepage: ''
+homepage: https://github.com/ioquatix/process-group
 licenses:
 - MIT
 metadata: {}
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Run processes concurrently in separate fibers with predictable behaviour.