ruby-jing 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1085cc25a09ba6773d7b0dfb4e6f8049054aaadccff23342b7a69861a64584
-  data.tar.gz: a033dc727afee925c526ec476f68a25b7e491efb6f5e799a755484e6c2d996d4
+  metadata.gz: 41284b05a5ee61d28bbf52115ad2c910ee85791edf63880786ac413f9d190b71
+  data.tar.gz: e373a5ca42a69b3f6bd7a663155239904cc0f2fd8fd2033ebd19f8586ac2490a
 SHA512:
-  metadata.gz: 1186148de2672e4ea4924cc7065878d3ce7a1d94732517bfb7159a613ffeb12bbec509b7bddf50c84ad2121ecf885e5a365edd09d2222562e89bcc8d0c872bbe
-  data.tar.gz: 9211e3e156bf374b48f32814c058a80d63df45ab6261e1726296b2ef319b037d4f045c199596e2b1efd95298a7c84da03c693a8138335b68fa417dee548025f6
+  metadata.gz: 858919ea520690526014c81aeba7f77308933dbd4afcc52fe2a1e40d8a5f1d8f1267b2dd133c5617cdd60cec8f7934595d03fab0ac087c6fdadbb9203a91cddb
+  data.tar.gz: 94c9479f1a222b58b81d150806c3d937913436cdb4c2c35d29892ce06be0d7f405400ff8284cbddc9c1caa443ac38e76ab3f0706a65e435863b3b8d98efa57d7

data/lib/jing.rb

@@ -1,7 +1,8 @@
+require "open3"
 require "optout"
 
 class Jing
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
   DEFAULT_JAR = File.join(File.dirname(__FILE__), "jing-20091111.jar")
 
   Error = Class.new(StandardError)
@@ -32,6 +33,7 @@ class Jing
   # === Options
   #
   # [:java (String)] Name and/or location of the java executable. Defaults to <code>"java"</code>.
+  # [:java_opts (String)] JVM options passed to +java+, e.g. +"-Dfile.encoding=UTF-8"+. Use this to set +"-D"+ system properties (e.g. +jdk.xml.maxGeneralEntitySizeLimit+) instead of the +JAVA_TOOL_OPTIONS+/_JAVA_OPTIONS+ environment variables, which make the JVM print a +Picked up ...+ banner to stderr on every launch.
   # [:jar (String)] Path to the Jing JAR file. Defaults to the bundled JAR.
   # [:compact (Boolean)] Set to +true+ if the schema uses the RELAX NG compact syntax. Defaults to false, will be set to +true+ is the schema has a +.rnc+ extension.
   # [:encoding (String)] Encoding of the XML document.
@@ -53,7 +55,8 @@ class Jing
     # Optout quirk: true will *include* the switch, which means we *don't* want to check
     @options[:id_check] = !@options[:id_check] if @options.include?(:id_check)
     if @options[:encoding]
-      @options[:java_opts] = "-Dfile.encoding=#{@options[:encoding]}"
+      file_encoding = "-Dfile.encoding=#{@options[:encoding]}"
+      @options[:java_opts] = [@options[:java_opts], file_encoding].compact.join(" ")
     end
   end
 
@@ -87,8 +90,8 @@ class Jing
   def validate(xml)
     @options[:xmlfile] = xml
 
-    out = execute(@options)
-    return [] if $?.success? and out.empty?
+    out, status = execute(@options)
+    return [] if status.success? and out.empty?
 
     parse_output(out)
   end
@@ -116,9 +119,16 @@ class Jing
   end
 
   private
+  # Spawn java directly in argv form instead of shelling out via backticks.
+  # A shell-form spawn needs /bin/sh, which is not always reachable from the
+  # calling process (restricted containers, TruffleRuby processes with a
+  # virtual filesystem mounted at /, ...); direct exec needs no shell. It
+  # also removes the shell-injection surface of interpolating paths into a
+  # command string. Behavior is unchanged: stderr is merged into the
+  # captured output and the exit status is returned alongside it.
   def execute(options)
-    cmd = @@option_builder.shell(options)
-    `#{cmd} 2>&1`
+    argv = @@option_builder.argv(options)
+    Open3.capture2e(*argv)
   rescue SystemCallError => e
     raise ExecutionError, "jing execution failed: #{e}"
   rescue Optout::OptionError => e
@@ -136,8 +146,9 @@ class Jing
           :column  => $3.to_i,
           :message => $4
         }
-      when /Picked up _JAVA_OPTIONS: /
-        # ignore diagnostic message
+      when /Picked up [A-Z_][A-Z0-9_]*: /
+        # ignore JVM diagnostic banner printed for env vars like
+        # _JAVA_OPTIONS, JAVA_TOOL_OPTIONS and JDK_JAVA_OPTIONS
       else # There must have been a problem that was not schema related
         raise ExecutionError, output
       end

data/test/test_jing.rb

@@ -12,7 +12,7 @@ class TestJing < MiniTest::Unit::TestCase
 
   def test_default_jar_file_used
     cmd = fakeshell { Jing.new(RNG_SCHEMA).validate(VALID_XML) }
-    assert_match /\A'java'\s+ -jar\s+ '#{Jing::DEFAULT_JAR}' \s+/x, cmd
+    assert_match /\Ajava\s+ -jar\s+ #{Regexp.escape(Jing::DEFAULT_JAR)} \s+/x, cmd
   end
 
   def test_jar_file_must_exist
@@ -24,13 +24,13 @@ class TestJing < MiniTest::Unit::TestCase
   def test_jar_option
     jar = Tempfile.new "jar"
     cmd = fakeshell { Jing.new(RNG_SCHEMA, :jar => jar.path).validate(VALID_XML) }
-    assert_match /\A'java'\s+ -jar\s+ '#{jar.path}' \s+/x, cmd
+    assert_match /\Ajava\s+ -jar\s+ #{Regexp.escape(jar.path)} \s+/x, cmd
   end
 
   def test_java_option
     java = "/usr/alt/java"
     cmd = fakeshell { Jing.new(RNG_SCHEMA, :java => java).validate(VALID_XML) }
-    assert_match /\A'#{java}'\s+/, cmd
+    assert_match /\A#{Regexp.escape(java)}\s+/, cmd
   end
 
   def test_java_must_exist
@@ -43,12 +43,12 @@ class TestJing < MiniTest::Unit::TestCase
   def test_encoding_option
     enc = "iso-8859-1"
     cmd = fakeshell { Jing.new(RNG_SCHEMA, :encoding => enc).validate(VALID_XML) }
-    assert_match /\A'java'\s+ '-Dfile.encoding=#{enc}'\s+ -jar\s+ '#{Jing::DEFAULT_JAR}'\s+ -e\s+ '#{enc}'/x, cmd
+    assert_match /\Ajava\s+ -Dfile\.encoding=#{enc}\s+ -jar\s+ #{Regexp.escape(Jing::DEFAULT_JAR)}\s+ -e\s+ #{enc}/x, cmd
   end
 
   def test_id_check_option
     cmd = fakeshell { Jing.new(RNG_SCHEMA, :id_check => false).validate(VALID_XML) }
-    assert_match /\A'java'\s -jar\s+ '#{Jing::DEFAULT_JAR}'\s+ -i/x, cmd
+    assert_match /\Ajava\s -jar\s+ #{Regexp.escape(Jing::DEFAULT_JAR)}\s+ -i/x, cmd
 
     cmd = fakeshell { Jing.new(RNG_SCHEMA, :id_check => true).validate(VALID_XML) }
     refute_match /\b-i\b/x, cmd
@@ -59,7 +59,7 @@ class TestJing < MiniTest::Unit::TestCase
 
   def test_compact_option
     cmd = fakeshell { Jing.new(RNC_SCHEMA, :compact => true).validate(VALID_XML) }
-    assert_match /\A'java'\s -jar\s+ '#{Jing::DEFAULT_JAR}'\s+ -c/x, cmd
+    assert_match /\Ajava\s -jar\s+ #{Regexp.escape(Jing::DEFAULT_JAR)}\s+ -c/x, cmd
 
     cmd = fakeshell { Jing.new(RNC_SCHEMA, :compact => false).validate(VALID_XML) }
     refute_match /\b-c\b/, cmd
@@ -67,7 +67,7 @@ class TestJing < MiniTest::Unit::TestCase
 
   def test_compact_option_when_compact_schema_is_used
     cmd = fakeshell { Jing.new(RNC_SCHEMA).validate(VALID_XML) }
-    assert_match /\A'java'\s+ -jar\s+ '#{Jing::DEFAULT_JAR}'\s+ -c/x, cmd
+    assert_match /\Ajava\s+ -jar\s+ #{Regexp.escape(Jing::DEFAULT_JAR)}\s+ -c/x, cmd
   end
 
   def test_relaxng_file_must_exist
@@ -121,28 +121,51 @@ class TestJing < MiniTest::Unit::TestCase
     }
   end
 
+  def test_java_tool_options_env_diagnostic_message
+    output = "Picked up JAVA_TOOL_OPTIONS: -Djdk.xml.maxGeneralEntitySizeLimit=200000"
+    fakeshell(:exit => 0, :output => output) {
+      errors = Jing.new(RNG_SCHEMA).validate(VALID_XML)
+      assert_equal 0, errors.size
+    }
+  end
+
+  def test_jdk_java_options_env_diagnostic_message
+    output = "Picked up JDK_JAVA_OPTIONS: -Dfile.encoding=UTF-8"
+    fakeshell(:exit => 0, :output => output) {
+      errors = Jing.new(RNG_SCHEMA).validate(VALID_XML)
+      assert_equal 0, errors.size
+    }
+  end
+
+  def test_java_opts_and_encoding_are_combined
+    opts = "-Djdk.xml.maxGeneralEntitySizeLimit=200000"
+    cmd = fakeshell { Jing.new(RNG_SCHEMA, :java_opts => opts, :encoding => "iso-8859-1").validate(VALID_XML) }
+    assert_match(/#{opts} -Dfile\.encoding=iso-8859-1\s+-jar/, cmd)
+    assert_match(/-e\s+ iso-8859-1/x, cmd)
+  end
+
   private
   def fakeshell(options = {})
     output = options.delete(:output) || ""
     exit_code = options.delete(:exit) || 0
 
     cmd = nil
-    Object.class_eval do
-      alias_method "real_tick", "`"
-      define_method("`") do |arg|
-        cmd = arg
-        real_tick %{ruby -e"exit #{exit_code}"} # Just to set $?
-        output
+    Open3.singleton_class.class_eval do
+      alias_method "real_capture2e", "capture2e"
+      define_method("capture2e") do |*argv|
+        cmd = argv.join(" ")
+        `ruby -e"exit #{exit_code}"` # Just to set $?
+        [output, $?]
       end
     end
 
     yield
-    cmd.tr %{"}, %{'}  # replace Win quotes with *nix
+    cmd
   ensure
-    Object.class_eval do
-      undef_method "`" #`
-      alias_method "`", "real_tick"
-      undef_method "real_tick"
+    Open3.singleton_class.class_eval do
+      undef_method "capture2e"
+      alias_method "capture2e", "real_capture2e"
+      undef_method "real_capture2e"
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jing
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Skye Shaw
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2026-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optout
@@ -83,8 +82,11 @@ files:
 homepage: http://github.com/sshaw/ruby-jing
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: http://github.com/sshaw/ruby-jing
+  source_code_uri: https://github.com/sshaw/ruby-jing
+  bug_tracker_uri: https://github.com/sshaw/ruby-jing/issues
+  changelog_uri: https://github.com/sshaw/ruby-jing/blob/master/Changes
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RELAX NG schema validation using the Jing CLI
 test_files: