engine-hacks 0.2.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95e4571cc6ce855e88da5f20d9ffcbbb075eb338843240cbc0de0b853064bacf
+  data.tar.gz: d37295c1c30e192554bbec47cde9484ad9440475b46f5033d4355e778e7f406a
+SHA512:
+  metadata.gz: 3441f2db1981c5ef615e57b9ca1e856b09fd6d126b979a507a235232f76aec9b195b055b79aae1a6758362ab67e5ad5bb72ba8a01268f2a4730fea6e6733090d
+  data.tar.gz: 415660b5d73eeadcee378092e9f8902bf6cfaa35d7b13c9da36e48aa858d18a67dfcca906ececf29a98e681282a91c6150d55ecd689cc5fd9905832c712d052a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in process-wrapper-mid.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rake-compiler", "~> 1.2"

data/README.md

@@ -0,0 +1,29 @@
+# EngineHacks Library
+
+Ruby Engine-specific extensions to enable SubSpawn.
+
+## Installation
+
+For most users, install one the other SubSpawn gems directly instead.
+
+Otherwise, install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add engine-hacks
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install engine-hacks
+
+## Usage
+
+For most users, use one of the other SubSpawn API's directly. 
+
+```rb
+require 'engine-hacks'
+```
+
+An RBS file exists for this gem.
+
+## Development
+
+See parent SubSpawn readme

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new "engine_hacks" do |ext|
+	ext.lib_dir = "lib/engine-hacks"
+end
+
+
+task default: :build

data/engine-hacks.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/engine-hacks/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "engine-hacks"
+  spec.version = EngineHacks::VERSION
+  spec.authors = ["Patrick Plenefisch"]
+  spec.email = ["simonpatp@gmail.com"]
+
+  spec.summary = "Engine-specific hacks to enable implement spawn in Ruby"
+  spec.description = "A SubSpawn subproject to provide c/java extensions to modify non-ruby-modifiable classes necessary to implementing SubSpawn, or any other spawn/popen API in pure Ruby"
+  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.require_paths = ["lib"]
+
+  if RUBY_PLATFORM =~ /java/
+    spec.platform = "java"
+  else
+    spec.platform = Gem::Platform::RUBY
+    spec.extensions = ["ext/engine_hacks/extconf.rb"]
+  end
+
+  # 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 options
+  spec.licenses = ["Ruby", "EPL-2.0", "LGPL-2.1-or-later"]
+end

data/ext/engine_hacks/engine_hacks.c

@@ -0,0 +1,64 @@
+#include "ruby/ruby.h"
+#include "ruby/io.h"
+#include "ruby/intern.h"
+
+// global to store the thread local name to read for $? and $CHILD_STATUS
+static VALUE status_holder;
+
+
+// $? accessor. returns `Thread.current[status_holder[0]]`
+static VALUE
+get_CHILD_STATUS(ID _x, VALUE *_y)
+{
+	return rb_thread_local_aref(rb_thread_current(), SYM2ID(RARRAY_AREF(status_holder, 0)));
+}
+
+// overwrites old $? definition to our defintion, and save the new status thread local name
+static VALUE
+install_status(VALUE self, VALUE new_status)
+{
+	rb_define_virtual_variable("$?", get_CHILD_STATUS, 0);
+	rb_define_virtual_variable("$CHILD_STATUS", get_CHILD_STATUS, 0);
+
+	// reset, and save the new state
+	rb_ary_clear(status_holder);
+	new_status = rb_to_symbol(new_status);
+	rb_ary_push(status_holder, new_status);
+
+	// return the name, converted
+	return new_status;
+}
+
+static VALUE
+join_pipes(VALUE self, VALUE reader, VALUE writer)
+{
+	rb_io_set_write_io(reader, writer);
+
+	// ensure flags are correct
+	RFILE(writer)->fptr->mode |= FMODE_SYNC|FMODE_DUPLEX;
+	RFILE(reader)->fptr->mode |= FMODE_SYNC|FMODE_DUPLEX;
+	RFILE(writer)->fptr->mode &= ~FMODE_READABLE;
+	RFILE(reader)->fptr->mode &= ~FMODE_WRITABLE;
+
+	// not functional, but what IO.popen does as API
+	rb_ivar_set(reader, rb_intern("@tied_io_for_writing"), writer);
+	return reader;
+
+	// TODO: we may need to worry that MRI io.c sets pipe_finalize?
+}
+
+void Init_engine_hacks(void)
+{
+	VALUE EngineHacks = rb_define_module("EngineHacks");
+	VALUE EngineHacksMRI = rb_define_module_under(EngineHacks, "MRI");
+
+	// hold the status in an array, so we can mark the array, and avoid fiddling with making
+	// our own marking stuff for the GC. if we don't mark as gc, SEGV
+	status_holder = rb_ary_new();
+	rb_global_variable(&status_holder);
+
+	// Exposed methods. Unsafe, do not call these directly, use the cruby.rb wrapper functions only!
+	rb_define_singleton_method(EngineHacksMRI, "install_status!", install_status, 1);
+	rb_define_singleton_method(EngineHacksMRI, "join_io", join_pipes, 2);
+
+}

data/ext/engine_hacks/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile "engine_hacks/engine_hacks"

data/lib/engine-hacks/cruby.rb

@@ -0,0 +1,27 @@
+require 'engine_hacks/engine_hacks'
+require 'English'
+
+# TODO: this doesn't actually work
+#alias $BUILTIN_CHILD_STATUS $?
+
+module EngineHacks
+
+	def self.use_child_status symbol
+		@symbol = symbol.to_sym
+		MRI.install_status! symbol
+	end
+
+	def self.child_status= value
+		if defined? @symbol
+			Thread.current[@symbol] = value
+		else
+			nil # not installed yet
+		end
+	end
+	
+	def self.duplex_io(read, write)
+		raise ArgumentError.new("Read argument must be IO") unless read.is_a? IO
+		raise ArgumentError.new("Write argument must be IO") unless write.is_a? IO
+		MRI.join_io(read, write)
+	end
+end

data/lib/engine-hacks/jruby.rb

@@ -0,0 +1,28 @@
+
+module EngineHacks
+
+	def self.use_child_status symbol
+		# No-op on JRuby
+		nil
+	end
+
+	def self.child_status= status
+		require 'jruby'
+		JRuby.runtime.current_context.last_exit_status = status
+	end
+
+	def self.duplex_io(read, write)
+		raise ArgumentError.new("Read argument must be IO") unless read.is_a? IO
+		raise ArgumentError.new("Write argument must be IO") unless write.is_a? IO
+		require 'jruby'
+		readf = JRuby.ref(read).open_file
+		writef = JRuby.ref(read).open_file
+		raise ArgumentError.new("Read argument must be JRuby IO") if readf.nil?
+		raise ArgumentError.new("Write argument must be JRuby IO") if writef.nil?
+		readf.tied_io_for_writing = write
+		modes = writef.class
+		readf.mode = (readf.mode & ~modes::WRITABLE) | modes::SYNC | modes::DUPLEX
+		writef.mode = (writef.mode & ~modes::READABLE) | modes::SYNC | modes::DUPLEX
+		return read
+	end
+end

data/lib/engine-hacks/version.rb

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

data/lib/engine-hacks.rb

@@ -0,0 +1,8 @@
+require 'engine-hacks/version'
+if defined? JRUBY_VERSION # or: RUBY_PLATFORM =~ /java/
+	# JRuby
+	require 'engine-hacks/jruby'
+else
+	# MRI or TruffleRuby
+	require 'engine-hacks/cruby'
+end

data/sig/engine-hacks.rbs

@@ -0,0 +1,15 @@
+module EngineHacks
+	# Makes $? use the thread-local variable named
+	# Returns nil if thread-local hack not necessary, the 
+	# Symbol otherwise
+	def self.use_child_status: (String | Symbol) -> ?Symbol
+	                         
+	# Sets $? to the given object. returns nil if use_child_status hasn't
+	# been called yet
+	def self.child_status=: (Object) -> ?Object
+	                      
+	# Returns an IO that may be either of the input arguments or a new
+	# IO that is a duplex IO where .read calls read.read, and .write calls
+	# write.write, etc. 
+	def self.duplex_io: (IO read, IO write) -> IO
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: engine-hacks
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre1
+platform: ruby
+authors:
+- Patrick Plenefisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-01 00:00:00.000000000 Z
+dependencies: []
+description: A SubSpawn subproject to provide c/java extensions to modify non-ruby-modifiable
+  classes necessary to implementing SubSpawn, or any other spawn/popen API in pure
+  Ruby
+email:
+- simonpatp@gmail.com
+executables: []
+extensions:
+- ext/engine_hacks/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- engine-hacks.gemspec
+- ext/engine_hacks/engine_hacks.c
+- ext/engine_hacks/extconf.rb
+- lib/engine-hacks.rb
+- lib/engine-hacks/cruby.rb
+- lib/engine-hacks/jruby.rb
+- lib/engine-hacks/version.rb
+- sig/engine-hacks.rbs
+homepage: https://github.com/byteit101/subspawn
+licenses:
+- Ruby
+- EPL-2.0
+- LGPL-2.1-or-later
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Engine-specific hacks to enable implement spawn in Ruby
+test_files: []