ocran 1.4.2-x86_64-linux → 1.4.3-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ae157a9de1441f400873047957620d2c6f41c47371ba0e0a1c4a00be2399fe
-  data.tar.gz: 21dc8dc3b6ef0c91af1d96547c4701b0c16e347e386304cd756f6fd6aeda8985
+  metadata.gz: 395439e25a66520b23294233b659afd5cb48a057c37919881652eabc2fc3e00d
+  data.tar.gz: 0b5d425c967a32fce5c82ebe1e61e1c73925b59c794ef00df3bc2553d3ac43bf
 SHA512:
-  metadata.gz: 4063ae4a93a90dc0f1dd9ee4d96cdddceb3a4c28836830e06e4827386fbd79f9ec646b1007d542c7e1653396541356636fdaeaccef42231835ebd5b59f464dfa
-  data.tar.gz: '00696824bb66b0144751b042bb152eee43c51e929ae05c4e4bae8e706c698cd945db0be3eba37708ca7290e0b8cca3a053883452242c8520c84ed45d5ce7a7eb'
+  metadata.gz: b5d09a2b2e5bcb3af38e1b9978335722518a1638003d1cd2f361426496650fc40214ca4885be04d35f9d494274baef87316ef9ee56078b4d550341925162eb4c
+  data.tar.gz: e68646927cf875767dab3eb4c1ce7a376c07d77a89f8f97fc13f34da3d4fb33400e8faa9e08a1828603a8ca24f673121bac46f070fdc7ec7f938662b2148a0d7

data/CHANGELOG.txt

@@ -1,3 +1,10 @@
+=== 1.4.3
+- Migrate edicon from C to Ruby: replace edicon.exe with a pure-Ruby implementation (ed_icon.rb), fixing incorrect BeginUpdateResource error checking and wrong GroupIconSize calculation. Shortens build times and removes the C binary from the build.
+- Include Gem.default_dir in GEM_PATH on all platforms: previously the exec_prefix gem directory was excluded on Windows, causing native-extension gems (e.g. fxruby/fox16) to fail at runtime with a LoadError even though they were bundled correctly.
+- Add FXRuby (fox16) test: verify that native extension DLLs are bundled correctly so the packaged executable does not raise a LoadError at runtime.
+- CI: start a virtual display (xpra + Xorg dummy driver with GLX) on Linux before running tests so FXRuby's X11 requirement is satisfied.
+- CI: install XQuartz on macOS runners and add it to the portability test job so FXRuby can connect to a display on both test and portability jobs.
+
 === 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.

data/README.md

@@ -1,7 +1,6 @@
 # ocran
 
 home   :: https://github.com/largo/ocran/
-
 issues :: http://github.com/largo/ocran/issues
 
 ## Description
@@ -23,18 +22,19 @@ Ruby 3.2+ compatibility.
 
 ## Recommended usage
 
-The most common use-case is shipping a program to Windows servers or users
-who do not have Ruby installed. By default, each time the `.exe` is opened it
+The most common use-case is shipping a program to users running Windows / Linux / macOS
+who do not have Ruby installed. By default, each time the `.exe` / executable is opened it
 extracts the Ruby interpreter and your code to a temporary directory and runs
 them from there.
 
-Because extraction takes time on each launch, consider using the Inno Setup
+Because extraction takes time on each launch, use `--output-dir` or
+`--output-zip` to produce a portable directory/archive that runs with the
+bundled Ruby on Linux, macOS, or Windows.
+If using Windows you can use  the Inno Setup
 option (`--innosetup`) to produce a proper installer that extracts once to a
 permanent directory.
 
-For cross-platform packaging or CI artifacts, use `--output-dir` or
-`--output-zip` to produce a portable directory/archive that runs with the
-bundled Ruby on Linux, macOS, or Windows.
+You can easily generate binaries for the supported Operating Systems with GitHub Actions.
 
 ## Features
 
@@ -74,12 +74,12 @@ https://github.com/largo/ocran/releases/.
 
 ## Synopsis
 
-### Building a Windows executable:
+### Building an executable:
 
     ocran script.rb
 
 Packages `script.rb`, the Ruby interpreter, and all dependencies (gems and
-DLLs) into `script.exe`.
+DLLs) into `script.exe` or `script` on Linux or macOS.
 
 ### Building a portable directory (Linux / macOS / Windows):
 
@@ -243,7 +243,8 @@ a Linux runner for Linux builds).
 ## Requirements
 
 * Ruby 3.2+
-* For building Windows `.exe`: Windows with RubyInstaller DevKit (mingw-w64), or Wine on Linux/macOS
+* For building Windows `.exe`: Windows with [RubyInstaller DevKit](https://rubyinstaller.org/downloads/) (mingw-w64), or Wine on Linux/macOS
+* For building Linux and MacOS binaries: the respective build tools
 * For `--output-dir` / `--output-zip`: any platform with Ruby 3.2+
 * For `--output-zip` on Linux/macOS: the `zip` command must be available
 * For `--output-zip` on Windows: PowerShell (included in Windows 8+)
@@ -526,6 +527,11 @@ file:
       end
     end
 
+## See elsewhere
+
+- [State of Ruby Packagers](https://gist.github.com/YOU54F/3775e66e6090e0371c11601e6b75c305)
+- [Traveling Ruby](https://github.com/trubygems/traveling-ruby)
+
 ## Credits
 
 Lars Christensen and contributors for the OCRA project which this is forked from.

data/lib/ocran/direction.rb

@@ -514,14 +514,15 @@ module Ocran
       builder.set_env_path("GEM_HOME", GEMDIR)
 
       gem_paths = [GEMDIR]
-      # On POSIX, default gems (e.g. error_highlight) are stored under the Ruby
-      # installation's gem dir (Gem.default_dir), not in GEMDIR. Include it in
-      # GEM_PATH so RubyGems can find and activate them in the extracted tree.
-      unless Gem.win_platform?
-        default_gem_dir = Pathname(Gem.default_dir)
-        if default_gem_dir.subpath?(exec_prefix)
-          gem_paths << default_gem_dir.relative_path_from(exec_prefix)
-        end
+      # Gems installed under the Ruby prefix (exec_prefix) have their specs and
+      # extension dirs placed there via duplicate_to_exec_prefix. Include
+      # Gem.default_dir (relative to exec_prefix) in GEM_PATH so RubyGems can
+      # find and activate them at runtime. This is required on both Windows
+      # (e.g. fxruby/fox16 whose fox16_c.so lives in extension_dir under the
+      # Ruby prefix) and POSIX (e.g. error_highlight default gems).
+      default_gem_dir = Pathname(Gem.default_dir)
+      if default_gem_dir.subpath?(exec_prefix)
+        gem_paths << default_gem_dir.relative_path_from(exec_prefix)
       end
       builder.set_env_path("GEM_PATH", *gem_paths)
 

data/lib/ocran/ed_icon.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+require "fiddle/import"
+require "fiddle/types"
+
+module Ocran
+  # Changes the Icon in a PE executable.
+  module EdIcon
+    extend Fiddle::Importer
+    dlload "kernel32.dll"
+
+    include Fiddle::Win32Types
+    typealias "LPVOID", "void*"
+    typealias "LPCWSTR", "char*"
+
+    module Successive
+      include Enumerable
+
+      def each
+        return to_enum(__method__) unless block_given?
+
+        entry = self
+        while true
+          yield(entry)
+          entry = self.class.new(tail)
+        end
+      end
+
+      def tail
+        to_ptr + self.class.size
+      end
+    end
+
+    # Icon file header
+    IconHeader = struct(
+      [
+        "WORD Reserved",
+        "WORD ResourceType",
+        "WORD ImageCount"
+      ]
+    ).include(Successive)
+
+    icon_info = [
+      "BYTE Width",
+      "BYTE Height",
+      "BYTE Colors",
+      "BYTE Reserved",
+      "WORD Planes",
+      "WORD BitsPerPixel",
+      "DWORD ImageSize"
+    ]
+
+    # Icon File directory entry structure
+    IconDirectoryEntry = struct(icon_info + ["DWORD ImageOffset"]).include(Successive)
+
+    # Group Icon Resource directory entry structure
+    IconDirResEntry = struct(icon_info + ["WORD ResourceID"]).include(Successive)
+
+    class IconFile < IconHeader
+      def initialize(icon_filename)
+        @data = File.binread(icon_filename)
+        super(Fiddle::Pointer.to_ptr(@data))
+
+        entries_end = IconHeader.size + self.ImageCount * IconDirectoryEntry.size
+        if entries_end > @data.bytesize
+          raise "Icon file too small for declared ImageCount"
+        end
+
+        entries.each_with_index do |entry, i|
+          if entry.ImageOffset + entry.ImageSize > @data.bytesize
+            raise "Icon entry #{i} exceeds file bounds"
+          end
+        end
+      end
+
+      def entries
+        IconDirectoryEntry.new(self.tail).take(self.ImageCount)
+      end
+    end
+
+    class GroupIcon < IconHeader
+      attr_reader :size
+
+      def initialize(image_count, resource_type)
+        @size = IconHeader.size + image_count * IconDirResEntry.size
+        super(Fiddle.malloc(@size), Fiddle::RUBY_FREE)
+        self.Reserved = 0
+        self.ResourceType = resource_type
+        self.ImageCount = image_count
+      end
+
+      def entries
+        IconDirResEntry.new(self.tail).take(self.ImageCount)
+      end
+    end
+
+    MAKEINTRESOURCE = -> (i) { Fiddle::Pointer.new(i) }
+    RT_ICON = MAKEINTRESOURCE.(3)
+    RT_GROUP_ICON = MAKEINTRESOURCE.(RT_ICON.to_i + 11)
+
+    MAKELANGID = -> (p, s) { s << 10 | p }
+    LANG_NEUTRAL = 0x00
+    SUBLANG_DEFAULT = 0x01
+    LANGID = MAKELANGID.(LANG_NEUTRAL, SUBLANG_DEFAULT)
+
+    extern "DWORD GetLastError()"
+    extern "HANDLE BeginUpdateResourceW(LPCWSTR, BOOL)"
+    extern "BOOL EndUpdateResourceW(HANDLE, BOOL)"
+    extern "BOOL UpdateResourceW(HANDLE, LPCWSTR, LPCWSTR, WORD, LPVOID, DWORD)"
+
+    class << self
+      def update_icon(executable_filename, icon_filename)
+        update_resource(executable_filename) do |handle|
+          icon_file = IconFile.new(icon_filename)
+          icon_entries = icon_file.entries
+
+          # Create the RT_ICON resources
+          icon_entries.each_with_index do |entry, i|
+            if UpdateResourceW(handle, RT_ICON, 101 + i, LANGID, icon_file.to_i + entry.ImageOffset, entry.ImageSize) == 0
+              raise "failed to UpdateResource(#{GetLastError()})"
+            end
+          end
+
+          # Create the RT_GROUP_ICON structure
+          group_icon = GroupIcon.new(icon_file.ImageCount, icon_file.ResourceType)
+          group_icon.entries.zip(icon_entries).each_with_index do |(res, icon), i|
+            res.Width = icon.Width
+            res.Height = icon.Height
+            res.Colors = icon.Colors
+            res.Reserved = icon.Reserved
+            res.Planes = icon.Planes
+            res.BitsPerPixel = icon.BitsPerPixel
+            res.ImageSize = icon.ImageSize
+            res.ResourceID = 101 + i
+          end
+
+          # Save the RT_GROUP_ICON resource
+          if UpdateResourceW(handle, RT_GROUP_ICON, 100, LANGID, group_icon, group_icon.size) == 0
+            raise "Failed to create group icon(#{GetLastError()})"
+          end
+        end
+      end
+
+      def update_resource(executable_filename)
+        handle = BeginUpdateResourceW(executable_filename.encode("UTF-16LE"), 0)
+        if handle == Fiddle::NULL
+          raise "Failed to BeginUpdateResourceW(#{GetLastError()})"
+        end
+
+        yield(handle)
+
+        if EndUpdateResourceW(handle, 0) == 0
+          raise "Failed to EndUpdateResourceW(#{GetLastError()})"
+        end
+      end
+    end
+  end
+end

data/lib/ocran/stub_builder.rb

@@ -27,7 +27,6 @@ module Ocran
     STUB_PATH = File.expand_path(WINDOWS ? "stub.exe" : "stub", base_dir)
     STUBW_PATH = WINDOWS ? File.expand_path("stubw.exe", base_dir) : nil
     LZMA_PATH = WINDOWS ? File.expand_path("lzma.exe", base_dir) : nil
-    EDICON_PATH = WINDOWS ? File.expand_path("edicon.exe", base_dir) : nil
 
     def self.find_posix_lzma_cmd
       if system("which lzma > /dev/null 2>&1")
@@ -122,7 +121,8 @@ module Ocran
 
       # Embed icon resource (Windows only)
       if icon_path && WINDOWS
-        system(EDICON_PATH, stub, icon_path.to_s, exception: true)
+        require_relative "ed_icon"
+        EdIcon.update_icon(stub, icon_path.to_s)
       end
 
       File.open(stub, "ab") do |of|

data/lib/ocran/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocran
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: x86_64-linux
 authors:
 - Andi Idogawa
@@ -64,6 +64,7 @@ files:
 - lib/ocran/command_output.rb
 - lib/ocran/dir_builder.rb
 - lib/ocran/direction.rb
+- lib/ocran/ed_icon.rb
 - lib/ocran/empty_source
 - lib/ocran/file_path_set.rb
 - lib/ocran/gem_spec_queryable.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: OCRAN (One-Click Ruby Application Next) packages Ruby applications for distribution
   on Windows, Linux, and macOS.