reflex-packager 0.2.0 → 0.3.0

data/lib/reflex/packager/stores/itchio.rb

@@ -0,0 +1,53 @@
+require 'shellwords'
+
+
+module Reflex
+
+
+  module Packager
+
+
+    module Stores
+
+
+      # itch.io, which the app is uploaded to by butler, the command line tool
+      # of it, logged in by `butler login`, or by the API key in
+      # BUTLER_API_KEY, as on CI.
+      #
+      class Itchio
+
+        def initialize(project)
+          @project = project
+        end
+
+        # The project as user/game.
+        #
+        attr_reader :project
+
+        # Uploads +path+, a zip or a directory, into the channel of the
+        # project, which tells the platform by its name, as macos or windows,
+        # telling the version to show.
+        #
+        def upload(path, channel:, version:)
+          raise Error, "nothing to upload: '#{path}'" unless File.exist? path
+
+          cmd = ['butler', 'push', path, "#{project}:#{channel}", '--userversion', version]
+          puts "==> #{cmd.shelljoin}"
+          case system(*cmd)
+          when nil
+            raise Error, 'butler not found, see https://itch.io/docs/butler/installing.html'
+          when false
+            raise Error, "failed to upload: #{cmd.shelljoin}"
+          end
+        end
+
+      end# Itchio
+
+
+    end# Stores
+
+
+  end# Packager
+
+
+end# Reflex

data/lib/reflex/packager/templates/macos/AppStore.entitlements.erb

@@ -0,0 +1,8 @@
+<?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>com.apple.security.app-sandbox</key>
+	<true/>
+</dict>
+</plist>

data/lib/reflex/packager/templates/macos/AppStoreExportOptions.plist.erb

@@ -0,0 +1,14 @@
+<?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>method</key>
+	<string>app-store-connect</string>
+	<key>signingStyle</key>
+	<string>automatic</string>
+	<key>teamID</key>
+	<string><%= config.macos.codesign_team_id %></string>
+	<key>destination</key>
+	<string>export</string>
+</dict>
+</plist>

data/lib/reflex/packager/templates/macos/ExportOptions.plist.erb

@@ -0,0 +1,20 @@
+<?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>method</key>
+	<string>developer-id</string>
+	<key>signingStyle</key>
+<%- if cloud_signing? -%>
+	<string>automatic</string>
+<%- else -%>
+	<string>manual</string>
+	<key>signingCertificate</key>
+	<string><%= codesign_identity.encode xml: :text %></string>
+<%- end -%>
+	<key>teamID</key>
+	<string><%= config.macos.codesign_team_id %></string>
+	<key>destination</key>
+	<string><%= notarize.include?(:submit) ? 'upload' : 'export' %></string>
+</dict>
+</plist>

data/lib/reflex/packager/templates/macos/InfoPlist.strings.erb

@@ -0,0 +1,5 @@
+"CFBundleName"             = <%= name.to_json %>;
+"CFBundleDisplayName"      = <%= name.to_json %>;
+<%- if copyright -%>
+"NSHumanReadableCopyright" = <%= copyright.to_json %>;
+<%- end -%>

data/lib/reflex/packager/templates/macos/boot.rb.erb

@@ -0,0 +1,29 @@
+begin
+  Dir.chdir File.join(__dir__, 'app')
+  $LOAD_PATH.unshift Dir.pwd
+<%- if pack? -%>
+  require 'reflex/packager/data_loader'
+  Reflex::Packager::DataLoader.setup Dir.pwd
+
+<%- end -%>
+  load File.join(Dir.pwd, <%= start_script.dump %>)
+rescue SystemExit, SignalException
+  raise
+rescue Exception => e
+  if $stderr.tty?
+    $stderr.puts e.full_message
+  else
+    begin
+      require 'reflex'
+      dirs    = Regexp.union [File.dirname(__FILE__), __dir__].map {"#{_1}/"}
+      message = e.full_message(highlight: false).lines
+        .reject {_1.match? %r{^\s+from (eval|#{Regexp.escape __FILE__}|(#{dirs})reflex\.bundle/Contents/Resources/lib/reflex/packager/data_loader\.rb):}}
+        .join
+        .gsub(dirs, '')
+      Reflex.alert message, title: <%= config.name.dump %>
+    rescue Exception => alert_error
+      $stderr.puts "failed to alert: #{alert_error.message} (#{alert_error.class})"
+    end
+  end
+  raise
+end

data/lib/reflex/packager/templates/macos/compile.rb.erb

@@ -0,0 +1,7 @@
+begin
+  require <%= compiler.dump %>
+  Reflex::Packager::DataCompiler.write <%= app_dir.dump %>, <%= path.dump %>
+rescue Exception => e
+  $stderr.puts e.full_message
+  exit 1
+end

data/lib/reflex/packager/templates/macos/main.mm.erb

@@ -1,6 +1,7 @@
 // -*- mode: objc -*-
 #import <Cocoa/Cocoa.h>
 #import <CRuby.h>
+#include <locale.h>
 
 
 extern "C"
@@ -14,20 +15,22 @@ extern "C"
 int
 main (int argc, const char* argv[])
 {
+	// for non-ASCII paths, before initializing CRuby
+	setlocale(LC_CTYPE, "UTF-8");
+
 	@autoreleasepool
 	{
-		NSString* appDir = [NSBundle.mainBundle.resourcePath stringByAppendingPathComponent:@"app"];
-		[NSFileManager.defaultManager changeCurrentDirectoryPath:appDir];
-
 <%- extensions.each do |ext| -%>
 		[CRuby addExtension:@"<%= ext %>" init:^{Init_<%= ext %>();}];
 <%- end -%>
 
-		for (NSString* lib in @[<%= libraries.map {"@\"#{_1}\""}.join ', ' %>])
+		for (NSString* lib in @[<%= lib_names.reverse.map {"@\"#{_1}\""}.join ', ' %>])
 			[CRuby addLibrary:lib bundle:NSBundle.mainBundle];
 
-		[CRuby evaluate:[NSString stringWithFormat:@"$LOAD_PATH.unshift '%@'", appDir]];
-		[CRuby start:[appDir stringByAppendingPathComponent:@"<%= profile.boot_main || config.main %>"]];
+		NSString* boot = [NSBundle.mainBundle.resourcePath stringByAppendingPathComponent:@"boot.rb"];
+		return [CRuby start:boot rescue:^(CRBValue* exception) {
+			CRBValue* message = [exception call:@"full_message" rescue:^(CRBValue* e) {}];
+			NSLog(@"%@", (message ?: [exception call:@"class"]).toString);
+		}];
 	}
-	return 0;
 }

data/lib/reflex/packager/templates/macos/project.yml.erb

@@ -7,13 +7,28 @@ options:
 settings:
   base:
     PRODUCT_BUNDLE_IDENTIFIER: <%= config.bundle_id %>
-    MARKETING_VERSION: "<%= config.version %>"
+    PRODUCT_NAME: <%= app_name.to_json %>
+    MARKETING_VERSION: <%= config.display_version.to_json %>
+    CURRENT_PROJECT_VERSION: <%= config.build_version.to_json %>
     ARCHS: <%= config.macos.archs.join ' ' %>
     ONLY_ACTIVE_ARCH: NO
-    CODE_SIGN_IDENTITY: <%= config.macos.codesign_identity.inspect %>
+<%- if signing_to_distribute? # Developer ID signs the app exported, not the archive -%>
+    CODE_SIGN_IDENTITY: "-"
+<%- else -%>
+    CODE_SIGN_IDENTITY: <%= codesign_identity.inspect %>
+<%- end -%>
 <%- if config.macos.codesign_team_id -%>
     DEVELOPMENT_TEAM: <%= config.macos.codesign_team_id %>
+    ENABLE_HARDENED_RUNTIME: YES
+<%- end -%>
+    CLANG_CXX_LANGUAGE_STANDARD: c++20
+    CLANG_ENABLE_OBJC_ARC: NO
+<%- unless verbose? -%>
+    GCC_WARN_INHIBIT_ALL_WARNINGS: YES
 <%- end -%>
+    HEADER_SEARCH_PATHS: <%= header_search_paths.to_json %>
+    SYSTEM_HEADER_SEARCH_PATHS: <%= system_header_search_paths.to_json %>
+    OTHER_LDFLAGS: [-lz, -lffi]
 
 targets:
   <%= target %>:
@@ -24,17 +39,59 @@ targets:
       - path: app
         type: folder
         buildPhase: resources
+      - path: boot.rb
+        buildPhase: resources
+<%- Dir.glob('*.bundle', base: File.join(build_dir, 'Bundles')).sort.each do |bundle| -%>
+      - path: Bundles/<%= bundle %>
+        buildPhase: resources
+<%- end -%>
 <%- if config.icon -%>
       - path: AppIcon.icns
         buildPhase: resources
+<%- end -%>
+      - path: <%= File.join(cruby_dir, 'src').to_json %>
+        name: CRuby
+<%- build_infos.each do |lib, info| -%>
+<%-   root  = lib.root -%>
+<%-   flags = info[:defs].map {"-D#{_1}"}.join ' ' -%>
+<%-   unless info[:srcs].empty? -%>
+      - path: <%= root.to_json %>
+        name: <%= lib %>
+        includes: <%= info[:srcs].map {_1.delete_prefix "#{root}/"}.to_json %>
+        compilerFlags: <%= flags.to_json %>
+<%-   end -%>
+<%-   unless info[:vendor_srcs].empty? -%>
+      - path: <%= File.join(root, 'vendor').to_json %>
+        name: <%= lib %>-vendor
+        includes: <%= info[:vendor_srcs].map {_1.delete_prefix "#{root}/vendor/"}.to_json %>
+        compilerFlags: <%= "#{flags} -w".to_json %>
+<%-   end -%>
+<%- end -%>
+    dependencies:
+      - framework: <%= File.join(cruby_dir, 'CRuby', 'CRuby.xcframework').to_json %>
+        embed: false
+<%- frameworks.each do |framework| -%>
+      - sdk: <%= framework %>.framework
 <%- end -%>
     info:
       path: src/Info.plist
       properties:
         CFBundleName: <%= config.name.inspect %>
         CFBundleDisplayName: <%= config.name.inspect %>
-        CFBundleShortVersionString: "<%= config.version %>"
+        CFBundleShortVersionString: <%= config.display_version.to_json %>
+        CFBundleVersion: <%= config.build_version.to_json %>
+<%- if config.copyright -%>
+        NSHumanReadableCopyright: <%= config.copyright.to_json %>
+<%- end -%>
         NSHighResolutionCapable: true
+<%- if config.macos.category -%>
+        LSApplicationCategoryType: <%= config.macos.category %>
+<%- end -%>
+        # no encryption but the system's, not to be asked by App Store Connect
+        ITSAppUsesNonExemptEncryption: false
+<%- if config.localizations.size > 1 -%>
+        LSHasLocalizedDisplayName: true
+<%- end -%>
 <%- if config.icon -%>
         CFBundleIconFile: AppIcon
 <%- end -%>

data/lib/reflex/packager/templates/windows/app.manifest.erb

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
+  <assemblyIdentity type="win32" name="<%= target %>" version="<%= product_version %>"/>
+
+  <!-- the dlls in lib/, a private assembly listed in lib/lib.manifest -->
+  <dependency>
+    <dependentAssembly>
+      <assemblyIdentity type="win32" name="<%= Windows::RUNTIME_DIR %>" version="<%= Windows::RUNTIME_VERSION %>"/>
+    </dependentAssembly>
+  </dependency>
+
+  <!-- Windows 10 and 11 -->
+  <compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
+    <application>
+      <supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}"/>
+    </application>
+  </compatibility>
+
+  <!-- paths and file names in UTF-8 whatever the system locale is -->
+  <application xmlns="urn:schemas-microsoft-com:asm.v3">
+    <windowsSettings>
+      <activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
+    </windowsSettings>
+  </application>
+</assembly>

data/lib/reflex/packager/templates/windows/app.rc.erb

@@ -0,0 +1,38 @@
+// application manifest (RT_MANIFEST)
+1 24 "app.manifest"
+<%- if config.icon -%>
+
+// icon of the executable, and of its windows through this id
+1 ICON "app.ico"
+<%- end -%>
+
+// shown in the properties of the executable, and as the name of the
+// process in the task manager
+1 VERSIONINFO
+FILEVERSION    <%= file_version   .tr '.', ',' %>
+PRODUCTVERSION <%= product_version.tr '.', ',' %>
+FILEOS         0x40004// VOS_NT_WINDOWS32
+FILETYPE       0x1// VFT_APP
+BEGIN
+  BLOCK "StringFileInfo"
+  BEGIN
+<%- config.localizations.each do |lang, values| -%>
+    BLOCK "<%= "%04X04B0" % langid(lang) %>"// <%= lang %>, Unicode
+    BEGIN
+      VALUE "FileDescription",  <%= rc_string values[:name] %>
+      VALUE "FileVersion",      <%= rc_string config.build_version %>
+      VALUE "InternalName",     <%= rc_string target %>
+<%-   if values[:copyright] -%>
+      VALUE "LegalCopyright",   <%= rc_string values[:copyright] %>
+<%-   end -%>
+      VALUE "OriginalFilename", <%= rc_string "#{target}.exe" %>
+      VALUE "ProductName",      <%= rc_string values[:name] %>
+      VALUE "ProductVersion",   <%= rc_string config.display_version %>
+    END
+<%- end -%>
+  END
+  BLOCK "VarFileInfo"
+  BEGIN
+    VALUE "Translation", <%= config.localizations.keys.map {"0x%x, 1200" % langid(_1)}.join ", " %>
+  END
+END

data/lib/reflex/packager/templates/windows/boot.rb.erb

@@ -0,0 +1,32 @@
+%w[<%= load_dirs.join ' ' %>].reverse_each do |dir|
+  $LOAD_PATH.unshift File.join(__dir__, dir, 'lib')
+end
+
+Dir.chdir File.join(__dir__, 'app')
+$LOAD_PATH.unshift Dir.pwd
+
+begin
+<%- if pack? -%>
+  require 'reflex/packager/data_loader'
+  Reflex::Packager::DataLoader.setup Dir.pwd
+
+<%- end -%>
+  load File.join(Dir.pwd, <%= start_script.dump %>)
+<%- unless config.windows.console? -%>
+rescue SystemExit, SignalException
+  raise
+rescue Exception => e
+  begin
+    require 'reflex'
+    dirs    = Regexp.union [File.dirname(__FILE__), __dir__].map {"#{_1}/"}
+    message = e.full_message(highlight: false).lines
+      .reject {_1.match? %r{^\s+from (eval|#{Regexp.escape __FILE__}|(#{dirs})reflex/lib/reflex/packager/data_loader\.rb):}}
+      .join
+      .gsub(dirs, '')
+    Reflex.alert message, title: <%= config.name.dump %>
+  rescue Exception => alert_error
+    $stderr.puts "failed to alert: #{alert_error.message} (#{alert_error.class})"
+  end
+  raise
+<%- end -%>
+end

data/lib/reflex/packager/templates/windows/main.cpp.erb

@@ -0,0 +1,47 @@
+// -*- mode: c++ -*-
+#include <ruby.h>
+#include <windows.h>
+#include <string>
+#include <vector>
+
+
+extern "C"
+{
+	void ruby_init_ext (const char* name, void (*init)(void));
+<%- extensions.each do |ext| -%>
+	void Init_<%= ext %> ();
+<%- end -%>
+}
+
+
+static std::string
+boot_script ()
+{
+	std::wstring path(32768, L'\0');
+	path.resize(GetModuleFileNameW(NULL, &path[0], (DWORD) path.size()));
+	path.erase(path.find_last_of(L"\\/") + 1);
+	path += L"lib\\boot.rb";
+
+	int size = WideCharToMultiByte(CP_UTF8, 0, path.c_str(), -1, NULL, 0, NULL, NULL);
+	std::string utf8(size, '\0');
+	WideCharToMultiByte(CP_UTF8, 0, path.c_str(), -1, &utf8[0], size, NULL, NULL);
+	utf8.resize(size - 1);
+	return utf8;
+}
+
+int
+main (int argc, char** argv)
+{
+	ruby_sysinit(&argc, &argv);
+	RUBY_INIT_STACK;
+	ruby_init();
+
+<%- extensions.each do |ext| -%>
+	ruby_init_ext("<%= ext %>.so", Init_<%= ext %>);
+<%- end -%>
+
+	std::string boot = boot_script();
+	std::vector<char*> args = {argv[0], &boot[0]};
+	args.insert(args.end(), argv + 1, argv + argc);
+	return ruby_run_node(ruby_options((int) args.size(), args.data()));
+}

data/lib/reflex/packager/templates/windows/runtime.manifest.erb

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
+  <assemblyIdentity type="win32" name="<%= Windows::RUNTIME_DIR %>" version="<%= Windows::RUNTIME_VERSION %>"/>
+<%- dlls.each do |dll| -%>
+  <file name="<%= dll %>"/>
+<%- end -%>
+</assembly>