beni 0.0.0 → 0.1.0

data/lib/beni.rb

@@ -4,5 +4,13 @@ require_relative "beni/version"
 
 module Beni
   class Error < StandardError; end
-  # Your code goes here...
 end
+
+require_relative "beni/vendor"
+require_relative "beni/builder"
+require_relative "beni/build_config"
+require_relative "beni/target"
+require_relative "beni/toolchain_definition"
+require_relative "beni/selected_toolchain"
+require_relative "beni/configuration"
+require_relative "beni/dsl"

data/sig/beni/build_config.rbs

@@ -0,0 +1,9 @@
+module Beni
+  module BuildConfig
+    def self?.generate: (String dest, mruby_dir: String, version: String) -> String
+
+    def self?.staged_default_config: (String mruby_dir, String version) -> String
+
+    def self?.staged_version: (String mruby_dir) -> String?
+  end
+end

data/sig/beni/builder.rbs

@@ -0,0 +1,39 @@
+module Beni
+  class Builder
+    DEFAULT_TARGETS: Array[String]
+
+    attr_reader vendor_dir: String
+    attr_reader build_config: String?
+    attr_reader targets: Array[String]
+
+    def initialize: (vendor_dir: String, ?build_config: String?, ?targets: Array[String]) -> void
+
+    def mruby_dir: () -> String
+
+    def libmruby_path: (String target) -> String
+
+    def libmruby_paths: () -> Array[String]
+
+    def built?: () -> bool
+
+    def ensure_built: () -> void
+
+    def build: () -> void
+
+    def clean: () -> void
+
+    private
+
+    def artifact_paths: () -> Array[String]
+
+    def run_mruby_rake: (Hash[String, String] env, Array[String] cmd) -> void
+
+    def env: () -> Hash[String, String]
+
+    def check_build_config!: () -> void
+
+    def flags_mak_paths: () -> Array[String]
+
+    def verify_artifacts!: () -> void
+  end
+end

data/sig/beni/configuration.rbs

@@ -0,0 +1,10 @@
+module Beni
+  class Configuration
+    attr_reader vendor_dir: String
+    attr_reader build_config: String?
+    attr_reader targets: Array[String]
+    attr_reader toolchains: Array[SelectedToolchain]
+
+    def initialize: (vendor_dir: String, build_config: String?, targets: Array[String], toolchains: Array[SelectedToolchain]) -> void
+  end
+end

data/sig/beni/dsl/context.rbs

@@ -0,0 +1,39 @@
+module Beni
+  module DSL
+    class Context
+      @settings: Hash[Symbol, String]
+      @targets: Hash[String, Target]
+      @definitions: Hash[String, ToolchainDefinition]
+
+      def initialize: () -> void
+
+      def version: (String value) -> void
+
+      def build_config: (String path) -> void
+
+      def vendor_dir: (String path) -> void
+
+      def target: (Symbol | String name) ?{ () [self: TargetContext] -> void } -> void
+
+      def toolchain: (String name) ?{ () [self: DefinitionContext] -> void } -> void
+
+      def configuration: () -> Configuration
+
+      private
+
+      def declare_scalar: (Symbol key, String value) -> void
+
+      def resolved_vendor_dir: () -> String
+
+      def resolved_build_config: () -> String?
+
+      def resolved_targets: () -> Array[String]
+
+      def selected_names: () -> Array[String]
+
+      def selected_toolchain: (String name) -> SelectedToolchain
+
+      def mruby_version: () -> String
+    end
+  end
+end

data/sig/beni/dsl/definition_context.rbs

@@ -0,0 +1,19 @@
+module Beni
+  module DSL
+    class DefinitionContext
+      @name: String
+      @version: String?
+      @sha256: String?
+
+      def self.collect: (String name) { () [self: DefinitionContext] -> void } -> ToolchainDefinition
+
+      def initialize: (String name) -> void
+
+      def version: (String value) -> void
+
+      def sha256: (String value) -> void
+
+      def to_definition: () -> ToolchainDefinition
+    end
+  end
+end

data/sig/beni/dsl/target_context.rbs

@@ -0,0 +1,15 @@
+module Beni
+  module DSL
+    class TargetContext
+      @references: Array[String]
+
+      def self.collect: () { () [self: TargetContext] -> void } -> Array[String]
+
+      attr_reader references: Array[String]
+
+      def initialize: () -> void
+
+      def toolchain: (String name) ?{ () -> void } -> void
+    end
+  end
+end

data/sig/beni/dsl.rbs

@@ -0,0 +1,5 @@
+module Beni
+  module DSL
+    def self?.assert_known_toolchain!: (String name) -> void
+  end
+end

data/sig/beni/selected_toolchain.rbs

@@ -0,0 +1,9 @@
+module Beni
+  class SelectedToolchain
+    attr_reader name: String
+    attr_reader version: String
+    attr_reader sha256: String?
+
+    def initialize: (name: String, version: String, sha256: String?) -> void
+  end
+end

data/sig/beni/target.rbs

@@ -0,0 +1,8 @@
+module Beni
+  class Target
+    attr_reader name: String
+    attr_reader references: Array[String]
+
+    def initialize: (name: String, references: Array[String]) -> void
+  end
+end

data/sig/beni/tasks.rbs

@@ -0,0 +1,36 @@
+module Beni
+  class Tasks < Rake::TaskLib
+    @builder: Builder?
+    @vendor_toolchains: Array[Vendor::Toolchain]?
+
+    attr_reader configuration: Configuration
+
+    def initialize: () ?{ () [self: DSL::Context] -> void } -> void
+
+    private
+
+    def builder: () -> Builder
+
+    def vendor_toolchains: () -> Array[Vendor::Toolchain]
+
+    def define: () -> void
+
+    def define_vendor_namespace: () -> void
+
+    def define_vendor_setup_task: () -> void
+
+    def wasi_sdk_selected?: () -> bool
+
+    def define_vendor_clean_tasks: () -> void
+
+    def define_toolchain_tasks: (Vendor::Toolchain toolchain) -> void
+
+    def define_build_task: () -> void
+
+    def define_clean_task: () -> void
+
+    def define_config_task: () -> void
+
+    def mruby_version: () -> String
+  end
+end

data/sig/beni/toolchain_definition.rbs

@@ -0,0 +1,9 @@
+module Beni
+  class ToolchainDefinition
+    attr_reader name: String
+    attr_reader version: String
+    attr_reader sha256: String
+
+    def initialize: (name: String, version: String, sha256: String) -> void
+  end
+end

data/sig/beni/vendor/checksum.rbs

@@ -0,0 +1,22 @@
+module Beni
+  module Vendor
+    class Checksum
+      @path: String
+      @expected_sha: String?
+
+      def initialize: (String path, String? expected_sha) -> void
+
+      def verify_or_pin: () -> String
+
+      private
+
+      def expected?: () -> bool
+
+      def sha256: () -> String
+
+      def verify_against_expected: (String actual, String sidecar) -> void
+
+      def verify_or_pin_sidecar: (String actual, String sidecar) -> void
+    end
+  end
+end

data/sig/beni/vendor/downloader.rbs

@@ -0,0 +1,26 @@
+module Beni
+  module Vendor
+    class Downloader
+      MAX_RETRIES: Integer
+
+      TRANSIENT_ERRORS: Array[singleton(StandardError)]
+
+      @url: String
+      @dest: String
+
+      def initialize: (String url, String dest) -> void
+
+      def download: () -> void
+
+      private
+
+      def fetch: (String tmp) -> void
+
+      def with_retry: [T] () { () -> T } -> T
+
+      def permanent?: (StandardError error) -> bool
+
+      def warn_and_sleep: (StandardError error, Integer attempt) -> void
+    end
+  end
+end

data/sig/beni/vendor/tarball.rbs

@@ -0,0 +1,24 @@
+module Beni
+  module Vendor
+    class Tarball
+      VERSION_MARKER: String
+
+      @tarball: String
+      @top_level_dir: String
+      @final_dir: String
+      @version: String
+
+      def initialize: (tarball: String, top_level_dir: String, final_dir: String, version: String) -> void
+
+      def prepare: () -> void
+
+      private
+
+      def installed_version: () -> String?
+
+      def extract_to_staging: (String staging) -> void
+
+      def promote: (String staging) -> void
+    end
+  end
+end

data/sig/beni/vendor/toolchain.rbs

@@ -0,0 +1,33 @@
+module Beni
+  module Vendor
+    class Toolchain
+      attr_reader name: String
+      attr_reader version_label: String
+      attr_reader base_url: String
+      attr_reader tarball_name: String
+      attr_reader top_level_dir: String
+      attr_reader vendor_dir: String
+      attr_reader expected_sha256: String?
+
+      def initialize: (name: String, version_label: String, base_url: String, tarball_name: String, top_level_dir: String, vendor_dir: String, expected_sha256: String?) -> void
+
+      def task_name: () -> Symbol
+
+      def url: () -> String
+
+      def final_dir: () -> String
+
+      def tarball_path: () -> String
+
+      def fetch: () -> String
+
+      def verify: () -> String
+
+      def install: () -> void
+
+      private
+
+      def downloader: () -> Downloader
+    end
+  end
+end

data/sig/beni/vendor.rbs

@@ -0,0 +1,20 @@
+module Beni
+  module Vendor
+    type built_in_pair = { version: String, sha256: String | Hash[String, String] }
+
+    BUILT_IN_PAIRS: Hash[String, built_in_pair]
+    DEPENDENCIES: Hash[String, Array[String]]
+    WASI_SDK_PLATFORM: String
+    TOOLCHAIN_FACTORIES: Hash[String, Symbol]
+
+    def self?.wasi_sdk: (vendor_dir: String, ?version: String?, ?sha256: String?) -> Toolchain
+
+    def self?.mruby: (vendor_dir: String, ?version: String?, ?sha256: String?) -> Toolchain
+
+    def self?.base_url_for: (String default) -> String
+
+    def self?.built_in_sha256: (String name, String version) -> String?
+
+    def self?.stage_wasi_toolchain_file: (vendor_dir: String) -> String
+  end
+end

data/sig/beni.rbs

@@ -1,4 +1,6 @@
 module Beni
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
 end

data/sig/patches/open-uri.rbs

@@ -0,0 +1,10 @@
+# Patch: rbs' open-uri stdlib signatures only cover the module function
+# +URI.open+; the instance form +URI::Generic#open+ (mixed in via
+# +OpenURI::OpenRead+ for http/https/ftp URIs at runtime) is missing.
+# Declared here so +Beni::Vendor::Downloader#download+ type-checks.
+module URI
+  class Generic
+    def open: (?String mode) -> (StringIO & OpenURI::Meta)
+            | [T] (?String mode) { (StringIO | Tempfile) -> T } -> T
+  end
+end

metadata

@@ -1,35 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: beni
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Aotokitsuruya
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: 'Reserved: mruby dependency manager that vendors mruby source and builds
-  libmruby.a, under active development. The build chain is being extracted from the
-  kobako project.'
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Vendors a pinned mruby and builds libmruby.a through a Rake task library,
+  with generated build configs for customization. Aims to grow into a full mruby dependency
+  manager.
 email:
 - contact@aotoki.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - lib/beni.rb
+- lib/beni/build_config.rb
+- lib/beni/builder.rb
+- lib/beni/configuration.rb
+- lib/beni/dsl.rb
+- lib/beni/dsl/context.rb
+- lib/beni/dsl/definition_context.rb
+- lib/beni/dsl/target_context.rb
+- lib/beni/selected_toolchain.rb
+- lib/beni/target.rb
+- lib/beni/tasks.rb
+- lib/beni/toolchain_definition.rb
+- lib/beni/vendor.rb
+- lib/beni/vendor/checksum.rb
+- lib/beni/vendor/downloader.rb
+- lib/beni/vendor/tarball.rb
+- lib/beni/vendor/toolchain.rb
+- lib/beni/vendor/toolchains/wasi.rake
 - lib/beni/version.rb
 - sig/beni.rbs
+- sig/beni/build_config.rbs
+- sig/beni/builder.rbs
+- sig/beni/configuration.rbs
+- sig/beni/dsl.rbs
+- sig/beni/dsl/context.rbs
+- sig/beni/dsl/definition_context.rbs
+- sig/beni/dsl/target_context.rbs
+- sig/beni/selected_toolchain.rbs
+- sig/beni/target.rbs
+- sig/beni/tasks.rbs
+- sig/beni/toolchain_definition.rbs
+- sig/beni/vendor.rbs
+- sig/beni/vendor/checksum.rbs
+- sig/beni/vendor/downloader.rbs
+- sig/beni/vendor/tarball.rbs
+- sig/beni/vendor/toolchain.rbs
+- sig/patches/open-uri.rbs
 homepage: https://github.com/elct9620/beni
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/elct9620/beni
-  source_code_uri: https://github.com/elct9620/beni
+  source_code_uri: https://github.com/elct9620/beni/tree/main
+  changelog_uri: https://github.com/elct9620/beni/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -37,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -46,5 +96,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: mruby dependency manager
+summary: mruby vendoring and build toolchain
 test_files: []

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]