subspawn 0.1.1 → 0.2.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae4884bb09c6eb0bc3adb178baabd6898ee4b42cf9e8f2e1295d9619f47c7bba
-  data.tar.gz: 47b9ea6752f556e0427008d0c2ba8310801f079820ed01927db264348500a97a
+  metadata.gz: d07057f5bd5fe708a6690914e4c71f391bd1caf008ce6393c3be6a2b70e4c941
+  data.tar.gz: '08af14e9800ce17abee24dd76094625da44b0151b8fbe141b85bcad4e3749653'
 SHA512:
-  metadata.gz: eeb7880f1b0a380f846459698e4961882f4903cc90a506da20b41807ecab1fb8620efb04a05999564075728ef661cf7ec25a47cb1e60001fa28c33a753ee9799
-  data.tar.gz: 4da0e3abb99b47f485a72dcea0263743836ae1578020fe84bc2dad5b71e6302b6a388b5b5cf8093a0ff9d30bc17b7990832cd4d42a6316480d9dd4554b9c2741
+  metadata.gz: c5ccf97896122ce4570ae0536b6fc3b8bdd10c458f1dd5c8cd35641f62516338f1896634940c52871ddaab6519e8aa4b84243f4308d0af1339daa4e05a62f5b6
+  data.tar.gz: d9befadc8ce0b8631012e425617195367e922c7db738a15034c3c183bb96ce8db7e2852a41f2644b6ae114148d7b17ceae6324cfa9d0b032711be54ac18de190

data/.rspec

@@ -3,4 +3,5 @@
 --require spec_helper
 -I ../ffi-binary-libfixposix/lib
 -I ../subspawn-posix/lib
+-I ../subspawn-common/lib
 -I ../ffi-bindings-libfixposix/lib

data/lib/subspawn/fd_parse.rb

@@ -4,10 +4,11 @@ require_relative './pipes'
 
 module SubSpawn::Internal
 	# argument value to int (or :tty)
-	def self.parse_fd(fd, allow_pty=false)
+	def self.parse_fd(fd, allow_pty=false, dests: nil)
 		# fd = if fd.respond_to? :to_path
 		# fd = if fd.respond_to? :to_file
 		# fd = if fd.respond_to? :to_file
+		fd = split_parse(fd, dests) if dests != nil and fd.respond_to? :underlying_write_io
 		case fd
 		when Integer then fd
 		when IO then fd.fileno
@@ -23,6 +24,14 @@ module SubSpawn::Internal
 		end
 	end
 
+	# TODO: does this support [:in, :out, :pty] => bidi as well as :child?
+	# Only on windows, we have "split IO" to fake a bidirectional pipe for PTYs
+	# This picks the right underlying IO
+	def self.split_parse(fd, d)
+		mode = guess_mode(d)
+		fd.send(:"underlying_#{mode}_io")
+	end
+
 	# mode conversion
 	def self.guess_mode(d)
 		read = d.include? 0 # stdin
@@ -38,11 +47,34 @@ module SubSpawn::Internal
 		end
 	end
 
+	def self.modestr_parse(str)
+		str = str.to_str
+		out = 0
+		if str.include? "b"
+			out = IO::BINARY
+			str = str.gsub("b", "")
+		end
+		if str.include? "x"
+			out = IO::EXCL
+			str = str.gsub("b", "")
+		end
+		out | case str
+		when "w" then IO::WRONLY | IO::CREAT | IO::TRUNC
+		when "r" then IO::RDONLY
+		when "r+", "w+" then IO::RDWR | IO::CREAT
+		when "a" then IO::WRONLY | IO::CREAT | IO::APPEND
+		when "a+" then IO::RDWR | IO::APPEND
+		else
+			raise ArgumentError "Unknown File mode"
+		end
+	end
+
 	# make FdSource objects of each redirection
 	def self.parse_fd_opts(fds, &settty)
 		child_lookup = {}
 		fds.map do |dests, src|
 			d = dests.map{|x| parse_fd(x, true)} # TODO: configurable
+			src = src.to_io if src.respond_to? :to_io
 			src = case src
 			when Array
 				case src.first
@@ -54,7 +86,7 @@ module SubSpawn::Internal
 					raise ArgumentError, "Invalid :child FD source specification" unless src.length == 2
 					# {a => c, b => [child, a]} is the same as {[a, b] => c}
 					# so we can transform the former into the latter
-					newfd = parse_fd(src.last)
+					newfd = parse_fd(src.last, dests: d)
 					# TODO: this isn't an error, create a new one
 					raise ArgumentError, "Invalid :child FD source specification" unless child_lookup[newfd]
 					child_lookup[newfd].tap{|child|
@@ -81,7 +113,7 @@ module SubSpawn::Internal
 					settty.call(src.path)
 					d.delete(:tty)
 				end
-				FdSource::Basic.new d, parse_fd(src)
+				FdSource::Basic.new d, parse_fd(src, dests: d)
 			end
 			# save redirected fds so we can sneak a child reference in
 			src.tap{|x| d.each{|c|

data/lib/subspawn/fd_types.rb

@@ -93,16 +93,7 @@ module SubSpawn::Internal
 				@value = file
 				@mode = mode || ::File::RDONLY
 				if @mode.respond_to? :to_str
-					@mode = case @mode.to_str
-					when "w" then IO::WRONLY | IO::CREAT | IO::TRUNC
-					when "r" then IO::RDONLY
-					when "rb" then IO::RDONLY | IO::BINARY
-					when "wb" then IO::WRONLY | IO::BINARY | IO::CREAT | IO::TRUNC
-					when "r+", "w+" then IO::RDWR | IO::CREAT 
-						# TODO: all!
-					else
-						raise ArgumentError "Unknown File mode"
-					end
+					@mode = SubSpawn::Internal.modestr_parse @mode.to_str
 				end
 				@perm = perm || 0o666
 			end

data/lib/subspawn/replace-builtin.rb

@@ -1,4 +1,7 @@
 require 'subspawn'
+require 'engine-hacks'
+
+EngineHacks.use_child_status :subspawn_child_status
 
 module Kernel
 	class << self
@@ -13,6 +16,11 @@ module Kernel
 	def spawn(*args)
 		SubSpawn.spawn_compat(*args)
 	end
+	alias :builtin_backtick :`
+	def `(str)
+		require 'open3'
+		Open3.capture2(str).first
+	end
 end
 
 module Process
@@ -26,5 +34,33 @@ module Process
 		def subspawn(args, opt={})
 			SubSpawn.spawn(args, opt)
 		end
+
+		# don't make a loop if waitpid isn't defined
+		if SubSpawn::Platform.method(:waitpid2)
+			def wait(*args)
+				SubSpawn.wait *args
+			end
+			def waitpid(*args)
+				SubSpawn.waitpid *args
+			end
+			def wait2(*args)
+				SubSpawn.wait2 *args
+			end
+			def waitpid2(*args)
+				SubSpawn.waitpid2 *args
+			end
+			def last_status
+				SubSpawn.last_status
+			end
+			def detach pid
+				SubSpawn.detach(pid)
+			end
+		end
+	end
+end
+
+class IO
+	def self.popen(*args, &block)
+		SubSpawn.popen_compat(*args, &block)
 	end
 end

data/lib/subspawn/replace-pty.rb

@@ -2,6 +2,10 @@ require 'subspawn'
 
 $_ss_overwrite = defined? PTY
 
+if FFI::Platform.windows? && !$_ss_overwrite
+	require 'subspawn/win32/pty'
+end
+
 module PTY
 	unless $_ss_overwrite
 		class ChildExited < RuntimeError

data/lib/subspawn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SubSpawn
-	VERSION = "0.1.1"
+	VERSION = "0.2.0.pre1"
 end

data/lib/subspawn.rb

@@ -5,17 +5,17 @@ if FFI::Platform.unix?
 	require 'subspawn/posix'
 	SubSpawn::Platform = SubSpawn::POSIX
 elsif FFI::Platform.windows?
-	raise "SubSpawn Win32 is not yet implemented"
+	require 'subspawn/win32'
+	SubSpawn::Platform = SubSpawn::Win32
 else
 	raise "Unknown FFI platform"
 end
+require 'subspawn/common'
 
 module SubSpawn
-	# TODO: things to check: set $?
-	def self.spawn_compat(command, *command2)
-		#File.write('/tmp/spawn.trace', [command, *command2].inspect + "\n", mode: 'a+')
+	# Parse and convert the weird Ruby spawn API into something nicer
+	def self.__compat_parser(is_popen, command, command2)
 
-		# return just the pid
 		delta_env = nil
 		# check for env
 		if command.respond_to? :to_hash
@@ -31,6 +31,9 @@ module SubSpawn
 		if command.first.is_a? Array and command.first.length != 2
 			raise ArgumentError, "First argument must be an pair TODO: check this"
 		end
+		popen = if is_popen && command.length > 1
+			command.pop
+		end
 		raise ArgumentError, "Must provide a command to execute" if command.empty?
 		raise ArgumentError, "Must provide options as a hash" unless opt.is_a? Hash
 		if opt.key? :env and delta_env
@@ -53,7 +56,14 @@ module SubSpawn
 		rescue NoMethodError => e # by spec
 			raise TypeError.new(e)
 		end
-		SubSpawn.__spawn_internal(command, opt, copt).first
+		return [popen, command, opt, copt]
+	end
+
+	# Parse and convert the weird Ruby spawn API into something nicer
+	def self.spawn_compat(command, *command2)
+		#File.write('/tmp/spawn.trace', [command, *command2].inspect + "\n", mode: 'a+')
+
+		__spawn_internal(*__compat_parser(false, command, command2)[1..-1]).first
 	end
 	# TODO: accept block mode?
 	def self.spawn(command, opt={})
@@ -107,7 +117,11 @@ module SubSpawn
 					#base.sid!# TODO: yes? no?
 				end
 			when :sid
-				base.sid! if value
+				if base.respond_to? :sid!
+					base.sid! if value
+				else
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'sid'"
+				end
 			when :env
 				if env_opts[:deltas]
 					warn "Provided multiple ENV options"
@@ -127,19 +141,44 @@ module SubSpawn
 				raise TypeError, "pgroup must be boolean or integral" if value.is_a? Symbol
 				base.pgroup = value == true ? 0 : value if value
 			when :signal_mask # TODO: signal_default
-				base.signal_mask(value)
+				if base.respond_to? :signal_mask
+					base.signal_mask(value)
+				else
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'signal_mask'"
+				end
 			when /rlimit_(.*)/ # P.s
+				unless base.respond_to? :rlimit
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'rlimit_*'"
+				else	
+					name = $1
+					keys = [value].flatten
+					base.rlimit(name, *keys)
+				end
+			when /w32_(.*)/ # NEW
 				name = $1
-				keys = [value].flatten
-				base.rlimit(name, *keys)
+				raise ArgumentError, "Unknown win32 argument: #{name}" unless %w{desktop title show_window window_pos window_size console_size window_fill start_flags}.include? name
+				unless base.respond_to? :name
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'w32_#{$1}'"
+				else	
+					base.send(name, *value)
+				end
 			when :rlimit # NEW?
 				raise ArgumentError, "rlimit as a hash must be a hash" unless value.respond_to? :to_h
-				value.to_h.each do |key, values|
-					base.rlimit(key, *[values].flatten)
+
+				unless base.respond_to? :rlimit
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'rlimit_*'"
+				else
+					value.to_h.each do |key, values|
+						base.rlimit(key, *[values].flatten)
+					end
 				end
 			when :umask # P.s
 				raise ArgumentError, "umask must be numeric" unless value.is_a? Integer
-				base.umask = value
+				unless base.respond_to? :umask
+					warn "SubSpawn Platform (#{base.class}) doesn't support 'umask'"
+				else
+					base.umask = value
+				end
 			when :unsetenv_others # P.s
 				env_opts[:only] = !!value
 				env_opts[:set] ||= !!value
@@ -208,12 +247,113 @@ module SubSpawn
 		ensure
 			tty.close unless tty.closed?
 			# MRI waits this way to ensure the process is reaped
-			if Process.waitpid(pid, Process::WNOHANG)
+			if Process.waitpid(pid, Process::WNOHANG).nil?
+				Process.detach(pid)
+			end
+		end
+	end
+
+	def self.popen(command, mode="r", opt={}, &block)
+		#Many modes, and "-" is not supported at this time
+		__popen_internal(command, mode, opt, {}, &block)
+	end
+	def self.popen_compat(command, *command2, &block)
+		#Many modes, and "-" is not supported at this time
+		mode, command, opt, copt = __compat_parser(true, command, command2)
+		mode ||= "r"
+		__popen_internal(command, mode, opt, copt, &block)
+	end
+	#Many modes, and "-" is not supported at this time
+	def self.__popen_internal(command, mode, opt, copt, &block)
+		outputs = {}
+		# parse, but ignore irrelevant bits
+		parsed = Internal.modestr_parse(mode) & (~(IO::TRUNC | IO::CREAT | IO::APPEND | IO::EXCL))
+		looking = if parsed & IO::WRONLY != 0
+			outputs[:in] = :pipe
+			looking = [:in]
+		elsif parsed & IO::RDWR != 0
+			outputs[:out] = :pipe
+			outputs[:in] = :pipe
+			looking = [:out, :in] # read, write, from our POV
+		else # read only
+			outputs[:out] = :pipe
+			looking = [:out]
+		end
+		# do normal spawning. Note: we only chose the internal spawn for popen_compat
+		pid, rawio = __spawn_internal(command, outputs.merge(opt), copt)
+
+		# create a proxy to close the process
+		io_proxy = looking.length == 1 ? SubSpawn::Common::ClosableIO : SubSpawn::Common::BidiMergedIOClosable
+		io = io_proxy.new(*looking.map{|x|rawio[x]}) do
+			# MRI waits this way to ensure the process is reaped
+			Process.waitpid(pid) # TODO: I think there isn't a WNOHANG here
+		end
+
+		# return or call
+		return io unless block_given?
+		begin
+			return yield(io)
+		ensure
+			io.close unless io.closed?
+			# MRI waits this way to ensure the process is reaped
+			if Process.waitpid(pid, Process::WNOHANG).nil?
 				Process.detach(pid)
 			end
 		end
 	end
 
+	# Windows doesn't like mixing and matching who is spawning and who is waiting, so use
+	# subspawn.wait* if you used subspawn.spawn*, while using process.wait* if you used Process.spawn*
+	# though if you replace process, then it's a moot point
+	if SubSpawn::Platform.method_defined? :waitpid2
+		def self.wait(*args)
+			waitpid *args
+		end
+		def self.waitpid(*args)
+			waitpid2(*args)&.first
+		end
+		def self.wait2(*args)
+			waitpid2 *args
+		end
+		def self.waitpid2(*args)
+			SubSpawn::Platform.waitpid2 *args
+		end
+		def self.last_status
+			SubSpawn::Platform.last_status
+		end
+	else
+		def self.wait(*args)
+			Process.wait *args
+		end
+		def self.waitpid(*args)
+			Process.waitpid *args
+		end
+		def self.wait2(*args)
+			Process.wait2 *args
+		end
+		def self.waitpid2(*args)
+			Process.waitpid2 *args
+		end
+		def self.last_status
+			Process.last_status
+		end
+	end
+
+	def self.detach(pid)
+		Thread.new do
+			pid, status = *SubSpawn.waitpid2(pid)
+			# TODO: ensure this loop isn't necessary
+			# while pid.nil?
+			# 	sleep 0.01
+			# 	pid, status = *SubSpawn.waitpid2(pid)
+			# end
+			status
+		end.tap do |thr|
+			thr[:pid] = pid
+			# TODO: does thread.pid need to exist?
+		end
+	end
+
 	COMPLETE_VERSION = {
 		subspawn: SubSpawn::VERSION,
 		platform: SubSpawn::Platform::COMPLETE_VERSION,

data/subspawn.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/subspawn/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "subspawn"
+  spec.version = SubSpawn::VERSION
+  spec.authors = ["Patrick Plenefisch"]
+  spec.email = ["simonpatp@gmail.com"]
+
+  spec.summary = "Advanced native subprocess spawning"
+  spec.description = "Advanced native subprocess spawning on MRI, JRuby, and TruffleRuby"
+  final_github = "https://github.com/byteit101/subspawn"
+  spec.homepage = final_github
+  spec.required_ruby_version = ">= 2.6.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = final_github
+  spec.metadata["changelog_uri"] = final_github
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "subspawn-common", "~> 0.2.0.pre1"
+  spec.add_dependency "subspawn-posix", "~> 0.2.0.pre1"
+  spec.add_dependency "subspawn-win32", "~> 0.2.0.pre1"
+  spec.add_dependency "ffi", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  # You can use Ruby's license, or any of the JRuby tri-license option.
+  spec.licenses = ["Ruby", "EPL-2.0", "LGPL-2.1-or-later"]
+end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: subspawn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.pre1
 platform: ruby
 authors:
 - Patrick Plenefisch
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: subspawn-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.pre1
 - !ruby/object:Gem::Dependency
   name: subspawn-posix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.pre1
+- !ruby/object:Gem::Dependency
+  name: subspawn-win32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.pre1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0.pre1
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +86,7 @@ files:
 - lib/subspawn/replace-pty.rb
 - lib/subspawn/replace.rb
 - lib/subspawn/version.rb
+- subspawn.gemspec
 homepage: https://github.com/byteit101/subspawn
 licenses:
 - Ruby
@@ -67,7 +96,7 @@ metadata:
   homepage_uri: https://github.com/byteit101/subspawn
   source_code_uri: https://github.com/byteit101/subspawn
   changelog_uri: https://github.com/byteit101/subspawn
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Advanced native subprocess spawning
 test_files: []