ocran 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bda746979fe3d0906ec129a11cc4b6d2bc7233f8d11eea4e3f4fb8f2aac9f8a4
-  data.tar.gz: dfa8ef139ec3ea69e984de479d90cfb00268d29abba79b609dbe7915d0002fe6
+  metadata.gz: ff520e4a8036bbcec4c8a1e56c96c89297cf43a88dd868d77ae5f4aadac7865c
+  data.tar.gz: 7735500efac55f60da13cf8c854bb6f80967b091b8baad310889073c7b8093eb
 SHA512:
-  metadata.gz: 60aab3f5becf047750ff2efcd5b9c05ecce6493d1e9f77f576dfc94f0864110ee881b91456404367b99912967e2c4cef596558c75cfcfa66aeb48a4308b63e91
-  data.tar.gz: cde421042a8d660dfb16d7fae20c7217d63cdaf5f701777115da1a2535af311580a6a9483609229d5faf326718d76edd1856b207a20f3df52b7b9f20565494af
+  metadata.gz: 7f360b8ea6dd7f87887a9afaa31e1053d0208588f91e24f6ccb224e6e17afe5ca4f2c7558b99907caaea540097b62c14aa3e2fd0cd89ada4615b54da316c883f
+  data.tar.gz: 5586f5255f2d966c12a23bbe934d1743b0b2f12158307dee2c94dbaa7b3731a08c31f019a378740280da2895d6a216c750da47b84f5fe30143bfc3d5d755bafe

data/CHANGELOG.txt

@@ -1,3 +1,11 @@
+=== 1.4.2
+- Auto-bundle OpenSSL and all its transitive dependencies (openssl.rb, digest.so, etc.) when net/http is loaded but no HTTPS request was made during the dependency scan. OpenSSL is now required inside the OCRAN build process so every file it pulls in appears in the bundled executable.
+- Add companion DLL scan on windows: when a native extension (.so) within the Ruby installation is loaded, all DLLs in the same directory are proactively included. This ensures libssl-3-x64.dll, libcrypto-3-x64.dll, libwinpthread-1.dll, and libyaml-0-2.dll are bundled even when no HTTPS connection is made during the build scan.
+- Add `return if defined?(Ocran)` guards to test fixtures that have runtime-only side effects (file writes, Dir.chdir, file existence checks, network requests) to prevent them from running during the dependency scan, so we can check if the dependencies are included correctly.
+
+=== 1.4.1
+- Fix kernel_require.rb packed at wrong path when rubygems-update is installed (e.g. via asdf on Linux/macOS). kernel_require.rb is now located relative to the actually-loaded rubygems.rb from $LOADED_FEATURES, falling back to rubylibdir for standard Ruby installations.
+
 === 1.4.0
 - Add Linux support: build and run self-extracting ELF executables on Linux. The stub compiles and runs natively on Linux using POSIX APIs.
 - Add macOS support: build and run self-extracting Mach-O executables on macOS.

data/README.md

@@ -115,10 +115,11 @@ Same as `--output-dir`, but packages the result into a zip file. Requires
 ### Options:
 
     ocran --help
+    ocran -h
 
 #### General options:
 
-* `--help`: Display available command-line options.
+* `--help`, `-h`: Display available command-line options.
 * `--quiet`: Suppress all output during the build process.
 * `--verbose`: Provide detailed output during the build process.
 * `--version`: Display the OCRAN version number and exit.
@@ -222,6 +223,23 @@ On Windows, run the batch file:
 * OCRAN-built executables correctly handle multibyte paths (e.g. Japanese, emoji) on Windows 10 1903+.
 * When using the executable from the console, run `chcp 65001` first to switch to UTF-8 on windows.
 
+## Limitations
+
+### No cross-platform building
+
+OCRAN is not a cross-compiler. The executable or directory it produces bundles
+the Ruby interpreter from the machine where OCRAN is run, so you must **run
+OCRAN on the same platform (and architecture) as the intended target**:
+
+* To produce a Windows `.exe`, run OCRAN on Windows.
+* To produce a Linux binary, run OCRAN on Linux.
+* To produce a macOS app bundle, run OCRAN on macOS.
+
+There is no support for building a Windows `.exe` from a Linux or macOS host,
+or vice versa. If you need builds for multiple platforms, run OCRAN in CI on
+each target platform separately (e.g., a Windows runner for `.exe` builds and
+a Linux runner for Linux builds).
+
 ## Requirements
 
 * Ruby 3.2+

data/lib/ocran/direction.rb

@@ -100,12 +100,25 @@ module Ocran
       # Since https://github.com/rubygems/rubygems/commit/cad4cf16cf8fcc637d9da643ef97cf0be2ed63cb
       # rubygems/core_ext/kernel_require.rb is loaded via IO.read+eval rather than require,
       # so it never appears in $LOADED_FEATURES and must be added manually.
-      # Use RbConfig::CONFIG["rubylibdir"] directly so the path is always correct,
-      # regardless of Ruby version or platform path separator conventions.
+      # We check multiple candidate locations because the layout varies by Ruby setup:
+      # - Standard Ruby (including RubyInstaller on Windows): rubygems.rb lives in rubylibdir
+      # - Ruby with rubygems-update (e.g. asdf on Linux/macOS): rubygems.rb lives in site_ruby
+      # kernel_require.rb must be packed alongside the rubygems.rb that was actually loaded,
+      # because rubygems.rb uses require_relative to load it.
       kernel_require_rel = "rubygems/core_ext/kernel_require.rb"
       unless features.any? { |f| f.to_posix.end_with?(kernel_require_rel) }
-        kernel_require_path = Pathname(RbConfig::CONFIG["rubylibdir"]) / kernel_require_rel
-        features.push(kernel_require_path) if kernel_require_path.exist?
+        # Prefer the location alongside the actually-loaded rubygems.rb, fall back to rubylibdir
+        rubygems_feature = features.find { |f| f.to_posix.end_with?("/rubygems.rb") }
+        candidate_dirs = []
+        candidate_dirs << rubygems_feature.dirname if rubygems_feature
+        candidate_dirs << Pathname(RbConfig::CONFIG["rubylibdir"])
+        candidate_dirs.each do |base_dir|
+          kernel_require_path = base_dir / kernel_require_rel
+          if kernel_require_path.exist?
+            features.push(kernel_require_path)
+            break
+          end
+        end
       end
 
       # Convert all relative paths to absolute paths before building.
@@ -131,6 +144,24 @@ module Ocran
       # Store the currently loaded files
       features = normalized_features
 
+      # If net/http was loaded but openssl wasn't (it is only required lazily
+      # at the point of an actual HTTPS connection), require it now inside the
+      # OCRAN build process so that every transitive dependency — openssl.rb,
+      # digest.so, and any other files pulled in by the extension — appears in
+      # $LOADED_FEATURES and gets bundled alongside the application.
+      openssl_so = Pathname(RbConfig::CONFIG["archdir"]) / "openssl.so"
+      if openssl_so.exist? &&
+          features.any? { |f| f.to_posix.end_with?("/net/http.rb") } &&
+          features.none? { |f| f == openssl_so }
+        say "Auto-loading openssl (net/http loaded but openssl not yet required)"
+        before = $LOADED_FEATURES.dup
+        require "openssl"
+        ($LOADED_FEATURES - before).each do |f|
+          path = Pathname(f).cleanpath
+          features << path if path.absolute?
+        end
+      end
+
       say "Building #{@option.output_executable}"
       require_relative "build_helper"
       builder.extend(BuildHelper)
@@ -172,6 +203,22 @@ module Ocran
             builder.copy_to_bin(dll, dll.basename)
           end
         end
+
+        # Proactively include companion DLLs for loaded native extensions.
+        # Native extensions (.so) may depend on DLLs in the same archdir
+        # directory (e.g., libssl-3-x64.dll alongside openssl.so) that are
+        # loaded lazily on first use. Scanning .so directories ensures those
+        # DLLs are bundled even when the extension is required but not
+        # exercised during the OCRAN dependency scan.
+        features.select { |f| f.extname?(".so") && f.subpath?(exec_prefix) }
+                .map(&:dirname).uniq
+                .each do |dir|
+          dir.each_child do |path|
+            next unless path.file? && path.extname?(".dll")
+            say "Adding companion DLL #{path}"
+            builder.duplicate_to_exec_prefix(path)
+          end
+        end
       end
 
       # Windows-only: Add external manifest and builtin DLLs

data/lib/ocran/option.rb

@@ -46,7 +46,7 @@ ocran [options] script.rb
 
 Ocran options:
 
---help             Display this information.
+--help, -h         Display this information.
 --quiet            Suppress output while building executable.
 --verbose          Show extra output while building executable.
 --version          Display version number and exit.
@@ -179,7 +179,7 @@ EOF
         when /\A--(no-)?gem-(\w+)(?:=(.*))?$/
           negate, group, list = $1, $2, $3
           @options[:gem_options] << [negate, group.to_sym, list&.split(",")] if group
-        when "--help", /\A--./
+        when "--help", "-h", /\A--./
           puts usage
           raise SystemExit
         else

data/lib/ocran/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ocran
-  VERSION = "1.4.0"
+  VERSION = "1.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocran
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Andi Idogawa