add mac osx bundle

Author: Largo

README.md

@@ -11,9 +11,10 @@ distribution. It bundles your script, the Ruby interpreter, gems, and native
 libraries into a single self-contained artifact that runs without requiring
 Ruby to be installed on the target machine.
 
-OCRAN supports three output formats, all cross-platform:
+OCRAN supports four output formats, all cross-platform:
 
 * **Self-extracting executable** — bundles everything into a single binary that unpacks and runs transparently, with no Ruby installation required. Produces a `.exe` on Windows, and a native executable on Linux and macOS.
+* **macOS app bundle** (`--macosx-bundle`) — wraps the executable in a `.app` bundle for Finder integration, Dock icons, and code signing.
 * **Directory** (`--output-dir`) — copies all files into a folder with a ready-to-run launch script (`.sh` on Linux/macOS, `.bat` on Windows).
 * **Zip archive** (`--output-zip`) — same as directory output, packed into a `.zip`.
 
@@ -38,6 +39,7 @@ bundled Ruby on Linux, macOS, or Windows.
 ## Features
 
 * **Windows/Linux/macOS executable** — self-extracting, self-running executable (primary output)
+* **macOS app bundle** — `.app` bundle with `Info.plist` for Finder/Dock/code-signing (`--macosx-bundle`)
 * **Directory output** — portable directory with a launch script (`--output-dir`)
 * **Zip archive output** — portable zip with a launch script (`--output-zip`)
 * LZMA compression (optional, default on, for `.exe` only)
@@ -86,6 +88,19 @@ DLLs) into `script.exe`.
 Copies all files into `myapp/` and writes a `script.sh` (or `script.bat` on
 Windows) launch script.
 
+### Building a macOS app bundle:
+
+    ocran --macosx-bundle script.rb
+
+Produces `script.app/` — a standard macOS `.app` bundle containing the
+self-extracting executable at `Contents/MacOS/script` and an `Info.plist`.
+Open it with `open script.app` or double-click it in Finder.
+
+    ocran --macosx-bundle --output MyApp --bundle-id com.example.myapp --icon icon.icns script.rb
+
+Custom name, bundle identifier and icon (must be `.icns` format). The icon is
+placed at `Contents/Resources/AppIcon.icns` and referenced in `Info.plist`.
+
 ### Building a zip archive:
 
     ocran --output-zip myapp.zip script.rb
@@ -142,6 +157,8 @@ Fine-tuning flags:
 * `--output <file>`: Name the generated executable. Defaults to `./<scriptname>.exe` on Windows and `./<scriptname>` on Linux/macOS.
 * `--output-dir <dir>`: Output all files to a directory with a launch script instead of building an executable. Works on Linux, macOS, and Windows.
 * `--output-zip <file>`: Output a zip archive containing all files and a launch script. Requires `zip` (Linux/macOS) or PowerShell (Windows).
+* `--macosx-bundle`: Build a macOS `.app` bundle. Use `--output` to set the bundle name (default: `<scriptname>.app`). (macOS)
+* `--bundle-id <id>`: Set the `CFBundleIdentifier` in `Info.plist` (default: `com.example.<appname>`). Used with `--macosx-bundle`.
 * `--no-lzma`: Disable LZMA compression (faster build, larger executable).
 * `--innosetup <file>`: Use an Inno Setup script (`.iss`) to create a Windows installer.
 
@@ -312,6 +329,35 @@ Four modes:
 If files are missing from the output, try `--gem-all=gemname` first, then
 `--gem-full=gemname`. Use `--gem-full` to include everything for all gems.
 
+### Code-signing a macOS app bundle
+
+After building with `--macosx-bundle`, sign the bundle with your Developer ID:
+
+    codesign --deep --force --verify --verbose \
+      --sign "Developer ID Application: Your Name (TEAMID)" \
+      MyApp.app
+
+Verify the signature:
+
+    codesign --verify --deep --strict --verbose=2 MyApp.app
+    spctl --assess --type execute --verbose MyApp.app
+
+For distribution outside the Mac App Store, notarize with Apple:
+
+    # Submit for notarization (requires app-specific password or API key)
+    xcrun notarytool submit MyApp.app \
+      --apple-id you@example.com \
+      --team-id TEAMID \
+      --password APP_SPECIFIC_PASSWORD \
+      --wait
+
+    # Staple the notarization ticket so it works offline
+    xcrun stapler staple MyApp.app
+
+Requirements:
+* Xcode Command Line Tools (`xcode-select --install`)
+* An Apple Developer account with a "Developer ID Application" certificate in Keychain
+
 ### Creating a Windows installer
 
 To make your application start faster or keep files between runs, use

lib/ocran/direction.rb

@@ -551,6 +551,63 @@ def build_zip(path)
       say "Finished building #{path} (#{File.size(path)} bytes)"
     end
 
+    def build_macosx_bundle(bundle_path)
+      require_relative "stub_builder"
+      require "fileutils"
+
+      bundle_path  = Pathname(bundle_path)
+      app_name     = bundle_path.basename.sub_ext("").to_s
+      contents_dir = bundle_path / "Contents"
+      macos_dir    = contents_dir / "MacOS"
+      resources_dir = contents_dir / "Resources"
+
+      FileUtils.mkdir_p(macos_dir.to_s)
+
+      executable_path = macos_dir / app_name
+      say "Building app bundle #{bundle_path}"
+
+      StubBuilder.new(executable_path,
+                      chdir_before: @option.chdir_before?,
+                      debug_extract: @option.enable_debug_extract?,
+                      debug_mode: @option.enable_debug_mode?,
+                      enable_compression: @option.enable_compression?,
+                      gui_mode: false,
+                      icon_path: nil,
+                      &to_proc) => builder
+
+      if @option.icon_filename
+        FileUtils.mkdir_p(resources_dir.to_s)
+        icon_dest = resources_dir / "AppIcon#{@option.icon_filename.extname}"
+        FileUtils.cp(@option.icon_filename.to_s, icon_dest.to_s)
+      end
+
+      bundle_id  = @option.bundle_identifier || "com.example.#{app_name}"
+      icon_entry = @option.icon_filename ? "    <key>CFBundleIconFile</key>\n    <string>AppIcon</string>\n" : ""
+
+      File.write(contents_dir / "Info.plist", <<~PLIST)
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>CFBundleName</key>
+          <string>#{app_name}</string>
+          <key>CFBundleDisplayName</key>
+          <string>#{app_name}</string>
+          <key>CFBundleIdentifier</key>
+          <string>#{bundle_id}</string>
+          <key>CFBundleVersion</key>
+          <string>1.0</string>
+          <key>CFBundlePackageType</key>
+          <string>APPL</string>
+          <key>CFBundleExecutable</key>
+          <string>#{app_name}</string>
+        #{icon_entry}</dict>
+        </plist>
+      PLIST
+
+      say "Finished building #{bundle_path} (#{builder.data_size} bytes decompressed)"
+    end
+
     def build_stab_exe
       require_relative "stub_builder"
 

lib/ocran/option.rb

@@ -12,6 +12,9 @@ def initialize
         :add_all_encoding? => true,
         :argv => [],
         :auto_detect_dlls? => true,
+        :bundle_identifier => nil,
+        :macosx_bundle => nil,
+        :macosx_bundle? => false,
         :chdir_before? => false,
         :enable_compression? => true,
         :enable_debug_extract? => false,
@@ -87,6 +90,8 @@ def usage
 --output <file>    Name the exe to generate. Defaults to ./<scriptname>.exe.
 --output-dir <dir> Output all files to a directory with a launch script instead of an exe.
 --output-zip <file> Output a zip archive containing all files and a launch script.
+--macosx-bundle    Build a macOS .app bundle. Use --output to name it (default: <scriptname>.app).
+--bundle-id <id>   Bundle identifier for the macOS app bundle (default: com.example.<appname>).
 --no-lzma          Disable LZMA compression of the executable.
 --innosetup <file> Use given Inno Setup script (.iss) to create an installer.
 
@@ -120,6 +125,10 @@ def parse(argv)
         when "--output-zip"
           path = argv.shift
           @options[:output_zip] = Pathname.new(path).expand_path if path
+        when "--macosx-bundle"
+          @options[:macosx_bundle?] = true
+        when "--bundle-id"
+          @options[:bundle_identifier] = argv.shift
         when "--dll"
           path = argv.shift
           @options[:extra_dlls] << path if path
@@ -210,6 +219,11 @@ def parse(argv)
           executable.basename.sub_ext(ext).expand_path
         end
 
+      if @options[:macosx_bundle?]
+        bundle_base = output_override || script.basename
+        @options[:macosx_bundle] = Pathname(bundle_base).sub_ext(".app").expand_path
+      end
+
       @options[:use_inno_setup?] = !!inno_setup_script
 
       @options[:verbose?] &&= !quiet?
@@ -233,6 +247,10 @@ def parse(argv)
       if output_dir && output_zip
         raise "--output-dir and --output-zip cannot be used together"
       end
+
+      if macosx_bundle && (output_dir || output_zip || inno_setup_script)
+        raise "--macosx-bundle cannot be combined with --output-dir, --output-zip, or --innosetup"
+      end
     end
 
     def add_all_core? = @options[__method__]
@@ -241,6 +259,10 @@ def add_all_encoding? = @options[__method__]
 
     def argv = @options[__method__]
 
+    def bundle_identifier = @options[__method__]
+
+    def macosx_bundle = @options[__method__]
+
     def auto_detect_dlls? = @options[__method__]
 
     def chdir_before? = @options[__method__]

lib/ocran/runner.rb

@@ -99,6 +99,8 @@ def build
         else
           raise "Inno Setup is only supported on Windows"
         end
+      elsif @option.macosx_bundle
+        direction.build_macosx_bundle(@option.macosx_bundle)
       elsif @option.output_dir
         direction.build_output_dir(@option.output_dir)
       elsif @option.output_zip

test/test_ocra.rb

@@ -1132,4 +1132,52 @@ def test_openssl_https_cacert
       end
     end
   end
+
+  # Tests that --macosx-bundle produces a valid .app bundle structure and
+  # that the executable inside it runs correctly.
+  def test_macosx_bundle
+    skip "macOS app bundle test is macOS-only" unless RUBY_PLATFORM.include?("darwin")
+    with_fixture 'helloworld' do
+      assert system("ruby", ocran, "helloworld.rb", "--macosx-bundle", *DefaultArgs)
+
+      bundle = "helloworld.app"
+      assert Dir.exist?(bundle), "Expected #{bundle} directory to exist"
+      assert File.exist?(File.join(bundle, "Contents", "Info.plist")), "Expected Info.plist"
+
+      exe = File.join(bundle, "Contents", "MacOS", "helloworld")
+      assert File.exist?(exe), "Expected executable at Contents/MacOS/helloworld"
+      assert File.executable?(exe), "Expected Contents/MacOS/helloworld to be executable"
+
+      pristine_env exe do
+        assert system(exe)
+      end
+    end
+  end
+
+  # Tests --macosx-bundle with a custom name, bundle-id, and icon.
+  def test_macosx_bundle_custom
+    skip "macOS app bundle test is macOS-only" unless RUBY_PLATFORM.include?("darwin")
+    with_fixture 'helloworld' do
+      # Create a minimal placeholder .icns file (not a real icon, just tests the copy)
+      File.write("test.icns", "placeholder")
+
+      assert system("ruby", ocran, "helloworld.rb",
+                    "--macosx-bundle",
+                    "--output", "MyApp",
+                    "--bundle-id", "com.example.myapp",
+                    "--icon", "test.icns",
+                    *DefaultArgs)
+
+      bundle = "MyApp.app"
+      assert Dir.exist?(bundle)
+
+      plist = File.read(File.join(bundle, "Contents", "Info.plist"))
+      assert plist.include?("com.example.myapp"), "Expected bundle identifier in Info.plist"
+      assert plist.include?("MyApp"), "Expected app name in Info.plist"
+      assert plist.include?("CFBundleIconFile"), "Expected icon entry in Info.plist"
+
+      assert File.exist?(File.join(bundle, "Contents", "Resources", "AppIcon.icns"))
+      assert File.exist?(File.join(bundle, "Contents", "MacOS", "MyApp"))
+    end
+  end
 end