build: Move source alias and build source computation to CLI

kateinoigakukun · kateinoigakukun · commit 3d126844fc9b · 2024-02-06T07:36:21.000Z
diff --git a/lib/ruby_wasm/cli.rb b/lib/ruby_wasm/cli.rb
@@ -42,7 +42,7 @@ def run(args)
     end
 
     def build(args)
-      # @type var options: Hash[Symbol, untyped]
+      # @type var options: cli_options
       options = {
         save_temps: false,
         optimize: false,
@@ -152,7 +152,8 @@ def pack(args)
     private
 
     def build_config(options)
-      config = { target: options[:target_triplet], src: options[:ruby_version] }
+      # @type var config: Packager::build_config
+      config = { target: options[:target_triplet], src: compute_build_source(options) }
       case options[:profile]
       when "full"
         config[:default_exts] = RubyWasm::Packager::ALL_DEFAULT_EXTS
@@ -170,6 +171,71 @@ def build_config(options)
       config
     end
 
+    def compute_build_source(options)
+      src_name = options[:ruby_version]
+      aliases = self.class.build_source_aliases(root)
+      aliases[src_name] ||
+        raise(
+          "Unknown Ruby source: #{src_name} (available: #{aliases.keys.join(", ")})"
+        )
+    end
+
+    # Retrieves the alias definitions for the Ruby sources.
+    def self.build_source_aliases(root)
+      # @type var sources: Hash[string, RubyWasm::Packager::build_source]
+      sources = {
+        "head" => {
+          type: "github",
+          repo: "ruby/ruby",
+          rev: "master"
+        },
+        "3.3" => {
+          type: "tarball",
+          url: "https://cache.ruby-lang.org/pub/ruby/3.3/ruby-3.3.0.tar.gz"
+        },
+        "3.2" => {
+          type: "tarball",
+          url: "https://cache.ruby-lang.org/pub/ruby/3.2/ruby-3.2.3.tar.gz"
+        }
+      }
+      sources.each do |name, source|
+        source[:name] = name
+        patches = Dir[File.join(root, "patches", name, "*.patch")]
+          .map { |p| File.expand_path(p) }
+        source[:patches] = patches
+      end
+
+      build_manifest = File.join(root, "build_manifest.json")
+      if File.exist?(build_manifest)
+        begin
+          manifest = JSON.parse(File.read(build_manifest))
+          manifest["ruby_revisions"].each do |name, rev|
+            sources[name][:rev] = rev
+          end
+        rescue StandardError => e
+          RubyWasm.logger.warn "Failed to load build_manifest.json: #{e}"
+        end
+      end
+      sources
+    end
+
+    # Retrieves the root directory of the Ruby project.
+    def root
+      __skip__ =
+        @root ||=
+          begin
+            if explicit = ENV["RUBY_WASM_ROOT"]
+              File.expand_path(explicit)
+            elsif defined?(Bundler)
+              Bundler.root
+            else
+              Dir.pwd
+            end
+          rescue Bundler::GemfileNotFound
+            Dir.pwd
+          end
+    end
+
     def derive_packager(options)
       __skip__ =
         if defined?(Bundler) && !options[:disable_gems]
diff --git a/lib/ruby_wasm/packager.rb b/lib/ruby_wasm/packager.rb
@@ -2,9 +2,16 @@
 class RubyWasm::Packager
   # Initializes a new instance of the RubyWasm::Packager class.
   #
+  # @param root [String] The root directory of the Ruby project.
+  #   The root directory (will) contain the following files:
+  #    * patches/{source}/*.patch
+  #    * build_manifest.json
+  #    * rubies
+  #    * build
   # @param config [Hash] The build config used for building Ruby.
   # @param definition [Bundler::Definition] The Bundler definition.
-  def initialize(config = nil, definition = nil)
+  def initialize(root, config = nil, definition = nil)
+    @root = root
     @definition = definition
     @config = config
   end
@@ -60,75 +67,13 @@ def support_dynamic_linking?
     ENV["RUBY_WASM_EXPERIMENTAL_DYNAMIC_LINKING"] == "1"
   end
 
-  # Retrieves the root directory of the Ruby project.
-  # The root directory contains the following stuff:
-  #  * patches/{source}/*.patch
-  #  * build_manifest.json
-  #  * rubies
-  #  * build
-  def root
-    __skip__ =
-      @root ||=
-        begin
-          if explicit = ENV["RUBY_WASM_ROOT"]
-            File.expand_path(explicit)
-          elsif defined?(Bundler)
-            Bundler.root
-          else
-            Dir.pwd
-          end
-        rescue Bundler::GemfileNotFound
-          Dir.pwd
-        end
-  end
-
-  # Retrieves the alias definitions for the Ruby sources.
-  def self.build_source_aliases(root)
-    # @type var sources: Hash[string, RubyWasm::Packager::build_source]
-    sources = {
-      "head" => {
-        type: "github",
-        repo: "ruby/ruby",
-        rev: "master"
-      },
-      "3.3" => {
-        type: "tarball",
-        url: "https://cache.ruby-lang.org/pub/ruby/3.3/ruby-3.3.0.tar.gz"
-      },
-      "3.2" => {
-        type: "tarball",
-        url: "https://cache.ruby-lang.org/pub/ruby/3.2/ruby-3.2.3.tar.gz"
-      }
-    }
-    sources.each do |name, source|
-      source[:name] = name
-      patches = Dir[File.join(root, "patches", name, "*.patch")]
-        .map { |p| File.expand_path(p) }
-      source[:patches] = patches
-    end
-
-    build_manifest = File.join(root, "build_manifest.json")
-    if File.exist?(build_manifest)
-      begin
-        manifest = JSON.parse(File.read(build_manifest))
-        manifest["ruby_revisions"].each do |name, rev|
-          sources[name][:rev] = rev
-        end
-      rescue StandardError => e
-        RubyWasm.logger.warn "Failed to load build_manifest.json: #{e}"
-      end
-    end
-    sources
-  end
-
   ALL_DEFAULT_EXTS =
     "bigdecimal,cgi/escape,continuation,coverage,date,dbm,digest/bubblebabble,digest,digest/md5,digest/rmd160,digest/sha1,digest/sha2,etc,fcntl,fiber,gdbm,json,json/generator,json/parser,nkf,objspace,pathname,psych,racc/cparse,rbconfig/sizeof,ripper,stringio,strscan,monitor,zlib,openssl"
 
   # Retrieves the build options used for building Ruby itself.
   def build_options
     default = {
       target: "wasm32-unknown-wasi",
-      src: "3.3",
       default_exts: ALL_DEFAULT_EXTS
     }
     override = @config || {}
@@ -139,25 +84,14 @@ def build_options
   # Retrieves the resolved build options
   def full_build_options
     options = build_options
-    build_dir = File.join(root, "build")
-    rubies_dir = File.join(root, "rubies")
+    build_dir = File.join(@root, "build")
+    rubies_dir = File.join(@root, "rubies")
     toolchain = RubyWasm::Toolchain.get(options[:target], build_dir)
-    src =
-      if options[:src].is_a?(Hash)
-        options[:src]
-      else
-        src_name = options[:src]
-        aliases = self.class.build_source_aliases(root)
-        aliases[src_name] ||
-          raise(
-            "Unknown Ruby source: #{src_name} (available: #{aliases.keys.join(", ")})"
-          )
-      end
     options.merge(
       toolchain: toolchain,
       build_dir: build_dir,
       rubies_dir: rubies_dir,
-      src: src
+      src: options[:src]
     )
   end
 end
diff --git a/sig/ruby_wasm/cli.rbs b/sig/ruby_wasm/cli.rbs
@@ -1,5 +1,22 @@
 module RubyWasm
   class CLI
+    type cli_options = {
+      print_ruby_cache_key: bool,
+      save_temps: bool,
+      output: String,
+
+      optimize: bool,
+      remake: bool,
+      reconfigure: bool,
+      clean: bool,
+
+      ruby_version: String,
+      target_triplet: String,
+      profile: String,
+      stdlib: bool,
+      disable_gems: bool,
+      format: String,
+    }
     DEFAULT_RUBIES_DIR: string
 
     @stdout: IO
@@ -12,11 +29,14 @@ module RubyWasm
 
     private
 
-    def build_config: (Hash[untyped, untyped] options) -> Hash[untyped, untyped]
+    def build_config: (cli_options options) -> Packager::build_config
+    def compute_build_source: (cli_options options) -> Packager::build_source
+    def self.build_source_aliases: (string root) -> Hash[string, Packager::build_source]
+    def root: () -> string
 
-    def derive_packager: (Hash[untyped, untyped] options) -> Packager
+    def derive_packager: (cli_options options) -> Packager
     def do_print_ruby_cache_key: (Packager) -> void
-    def do_build: (BuildExecutor, string tmpdir, Packager, Hash[untyped, untyped] options) -> void
+    def do_build: (BuildExecutor, string tmpdir, Packager, cli_options options) -> void
 
     def require_extension: () -> void
   end
diff --git a/sig/ruby_wasm/packager.rbs b/sig/ruby_wasm/packager.rbs
@@ -1,9 +1,12 @@
 
 class RubyWasm::Packager
+  type build_source = Hash[Symbol, (string | Array[String])]
+  type build_config = Hash[untyped, untyped]
+
   @definition: untyped
-  @config: Hash[untyped, untyped]
+  @config: build_config
 
-  def initialize: (untyped?, Hash[untyped, untyped]?) -> void
+  def initialize: (build_config?, untyped?) -> void
 
   def package: (RubyWasm::BuildExecutor, string dest_dir, untyped options) -> Array[Integer]
 
@@ -17,9 +20,6 @@ class RubyWasm::Packager
 
   def root: () -> string
 
-  type build_source = Hash[Symbol, (string | Array[String])]
-  def self.build_source_aliases: (string root) -> Hash[string, build_source]
-
   ALL_DEFAULT_EXTS: string
 
   def build_options: () -> Hash[Symbol, untyped]
