Merge pull request #231 in G/truffleruby from pitr-ch/patching to master

* commit '74ba6cdb7e12d4a196584cc8250fe10f1f154efc': Simpler and more robust patching
oracle · Jul 25, 2018 · 8827d24 · 8827d24
2 parents d164b01 + 74ba6cd
commit 8827d24
Show file tree

Hide file tree

Showing 27 changed files with 171 additions and 227 deletions.
diff --git a/doc/contributor/workarounds.md b/doc/contributor/workarounds.md
@@ -1,17 +1,23 @@
-# Patching system
-
-The patching system is loaded in `post-boot.rb` and is able to patch stdlib and
-installed gems.  The code implementing the patching itself can be found in
-`lib/truffle/truffle/patching.rb`. It can be disabled by passing the
-`-Xpatching=false` option.
-
-The patching system works for gems as follows.  When a gem *g* is activated,
-there is a directory `g` in `lib/patches`, and the directory is listed in
-`lib/truffle/truffle/patching.rb`, the directory is inserted into `$LOAD_PATH`
-before the original load-paths of the *g* gem. As a result the patching files
-are loaded first before the original files in the gem. The patching file is
-responsible for loading the original file (if desirable), which can be done with
-`Truffle::Patching.require_original __FILE__`.
+# Ruby files patching system
+
+When `require 'some/patch'` (has to be a relative path) is called 
+and an original file exists on `$LOAD_PATH`
+and there is a patch file `some/patch.rb` in a special directory `lib/patches` 
+then the TruffleRuby will first evaluate (not require) the file 
+`lib/patches/some/patch.rb` instead. 
+
+To require the original file call `require 'some/patch'` in the 
+`lib/patches/some/patch.rb` file. It will require the original ruby 
+file found on `$LOAD_PATH` ( stdlib file or a gem file).
+
+When requiring the original file is not desired just omit the 
+`require 'some/patch'` in the patch file. The patch file will be evaluated
+only once.  
+
+The evaluated patch files are not visible in `$LOAD_PATH` nor `$LOADED_FEATURES`.
+
+Patching can be disabled by passing the `-Xpatching=false` option. 
+`-X.log=CONFIG` can be used to see paths of loaded patch files.
 
 # C file preprocessing
 

diff --git a/lib/patches/bundler/bundler.rb → lib/patches/bundler.rb b/lib/patches/bundler/bundler.rb → lib/patches/bundler.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'bundler'
 
 unless Bundler::VERSION =~ /^1\.16\./
   raise "unsupported bundler version #{Bundler::VERSION}, please use 1.16.x"

diff --git a/lib/patches/bundler/bundler/runtime.rb b/lib/patches/bundler/bundler/runtime.rb
diff --git a/lib/patches/bundler/bundler/cli/exec.rb → lib/patches/bundler/cli/exec.rb b/lib/patches/bundler/bundler/cli/exec.rb → lib/patches/bundler/cli/exec.rb
@@ -22,7 +22,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'bundler/cli/exec'
 
 module Bundler
   class CLI::Exec

diff --git a/lib/patches/bundler/bundler/current_ruby.rb → lib/patches/bundler/current_ruby.rb b/lib/patches/bundler/bundler/current_ruby.rb → lib/patches/bundler/current_ruby.rb
@@ -22,7 +22,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'bundler/current_ruby'
 
 module Bundler
   class CurrentRuby

diff --git a/lib/patches/bundler/bundler/dependency.rb → lib/patches/bundler/dependency.rb b/lib/patches/bundler/bundler/dependency.rb → lib/patches/bundler/dependency.rb
@@ -22,7 +22,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'bundler/dependency'
 
 class Bundler::Dependency
 

diff --git a/lib/patches/bundler/bundler/deprecate.rb → lib/patches/bundler/deprecate.rb b/lib/patches/bundler/bundler/deprecate.rb → lib/patches/bundler/deprecate.rb
diff --git a/lib/patches/bundler/bundler/ruby_version.rb → lib/patches/bundler/ruby_version.rb b/lib/patches/bundler/bundler/ruby_version.rb → lib/patches/bundler/ruby_version.rb
@@ -22,7 +22,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'bundler/ruby_version'
 
 module Bundler
   class RubyVersion

diff --git a/...atches/bundler/bundler/source/rubygems.rb → lib/patches/bundler/source/rubygems.rb b/...atches/bundler/bundler/source/rubygems.rb → lib/patches/bundler/source/rubygems.rb
@@ -24,7 +24,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'bundler/source/rubygems'
 
 # TruffleRuby: do not skips gems with extensions not built
 

diff --git a/...hes/launchy/launchy/detect/ruby_engine.rb → lib/patches/launchy/detect/ruby_engine.rb b/...hes/launchy/launchy/detect/ruby_engine.rb → lib/patches/launchy/detect/ruby_engine.rb
@@ -12,7 +12,7 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'launchy/detect/ruby_engine'
 
 module Launchy::Detect
   class RubyEngine

diff --git a/lib/patches/launchy/launchy/detect/runner.rb → lib/patches/launchy/detect/runner.rb b/lib/patches/launchy/launchy/detect/runner.rb → lib/patches/launchy/detect/runner.rb
@@ -12,7 +12,7 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'launchy/detect/runner'
 
 module Launchy::Detect
   class Runner

diff --git a/...s/rake-compiler/rake/baseextensiontask.rb → lib/patches/rake/baseextensiontask.rb b/...s/rake-compiler/rake/baseextensiontask.rb → lib/patches/rake/baseextensiontask.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'rake/baseextensiontask'
 
 module Truffle::Patching::RakeBaseExtensionTaskOverrideBinaryExt
   def binary(platform = nil)

diff --git a/...tches/rake-compiler/rake/extensiontask.rb → lib/patches/rake/extensiontask.rb b/...tches/rake-compiler/rake/extensiontask.rb → lib/patches/rake/extensiontask.rb
@@ -1,16 +1,16 @@
 # Copyright (c) 2008-2011 Luis Lavena.
-# 
+#
 # 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
@@ -19,7 +19,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'rake/extensiontask'
 
 module Truffle::Patching::RakeExtensionTaskOverridePatterns
   def init(name = nil, gem_spec = nil)

diff --git a/lib/patches/rspec-core/rspec/core/source.rb → lib/patches/rspec/core/source.rb b/lib/patches/rspec-core/rspec/core/source.rb → lib/patches/rspec/core/source.rb
@@ -9,10 +9,10 @@
 # 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
@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'rspec/core/source'
 
 module RSpec
   module Core

diff --git a/lib/patches/rspec-support/rspec/support.rb → lib/patches/rspec/support.rb b/lib/patches/rspec-support/rspec/support.rb → lib/patches/rspec/support.rb
@@ -7,10 +7,10 @@
 # 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
@@ -19,7 +19,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-Truffle::Patching.require_original __FILE__
+require 'rspec/support'
 
 module RSpec
   module Support

diff --git a/lib/patches/stdlib/rubygems.rb → lib/patches/rubygems.rb b/lib/patches/stdlib/rubygems.rb → lib/patches/rubygems.rb
@@ -1,5 +1,4 @@
-Truffle::Patching.require_original __FILE__
-Truffle::Patching.install_gem_activation_hook
+require 'rubygems'
 
 # Because did_you_mean was required directly without RubyGems
 if Truffle::Boot.get_option 'did_you_mean'

diff --git a/...es/stdlib/rubygems/basic_specification.rb → lib/patches/rubygems/basic_specification.rb b/...es/stdlib/rubygems/basic_specification.rb → lib/patches/rubygems/basic_specification.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'rubygems/basic_specification'
 
 if ENV['TRUFFLERUBY_CEXT_ENABLED'] == "false"
   module Truffle::Patching::NoWarnIfBuildingCextDisabled

diff --git a/lib/patches/stdlib/rubygems/ext.rb → lib/patches/rubygems/ext.rb b/lib/patches/stdlib/rubygems/ext.rb → lib/patches/rubygems/ext.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'rubygems/ext'
 
 # TruffleRuby: build C extensions conditionally
 

diff --git a/...patches/stdlib/rubygems/remote_fetcher.rb → lib/patches/rubygems/remote_fetcher.rb b/...patches/stdlib/rubygems/remote_fetcher.rb → lib/patches/rubygems/remote_fetcher.rb
@@ -1,5 +1,5 @@
 
-Truffle::Patching.require_original __FILE__
+require 'rubygems/remote_fetcher'
 
 # Hardcode DNS Resolution to rubygems.org for gem install
 

diff --git a/...ubygems/request_set/gem_dependency_api.rb → ...ubygems/request_set/gem_dependency_api.rb b/...ubygems/request_set/gem_dependency_api.rb → ...ubygems/request_set/gem_dependency_api.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'rubygems/request_set/gem_dependency_api'
 
 class Gem::RequestSet::GemDependencyAPI
 

diff --git a/lib/patches/thread_safe/thread_safe.rb → lib/patches/thread_safe.rb b/lib/patches/thread_safe/thread_safe.rb → lib/patches/thread_safe.rb
@@ -1,4 +1,4 @@
-Truffle::Patching.require_original __FILE__
+require 'thread_safe'
 
 # Copyright (c) 2012 thedarkone
 #
@@ -177,4 +177,4 @@ def #{method}(*args)
       RUBY_EVAL
     end
   end
-end
+end
diff --git a/lib/truffle/truffle/patching.rb b/lib/truffle/truffle/patching.rb
diff --git a/src/main/java/org/truffleruby/RubyContext.java b/src/main/java/org/truffleruby/RubyContext.java
@@ -818,7 +818,8 @@ private String searchRubyHome(Options options) throws IOException {
 
     private boolean isRubyHome(File path) {
         return Paths.get(path.toString(), "lib", "truffle").toFile().isDirectory() &&
-                Paths.get(path.toString(), "lib", "ruby").toFile().isDirectory();
+                Paths.get(path.toString(), "lib", "ruby").toFile().isDirectory() &&
+                Paths.get(path.toString(), "lib", "patches").toFile().isDirectory();
     }
 
     public TruffleNFIPlatform getTruffleNFI() {