klenod-runtime 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 739914ba526e13992821c30f81881def0ffd3381ad655a26b6004b5a7fb61c9c
-  data.tar.gz: 7f32c13692b4ae7bf103ac27fb82752c85a89cf300c99f5a7fcc49acffa65a7c
+  metadata.gz: c27ef979d9823153396b640d84a1d4e892f4e66c5c88f8afad0f6fc02a8ae17e
+  data.tar.gz: 6b4be228b1052f59104eff4ac30750661c689422978b5e0484ec95c95da9febc
 SHA512:
-  metadata.gz: 9e06c336456aa5b4d5f9f75b0385a91f1b28b5c58598d160a28bd50eeb929d7d83b97b5eda50ece404a6ddcfddf6dfa65f64e1446bdcf556ec31e28e4e393128
-  data.tar.gz: d99f919df953bb5b3c818971839d6117d2b99c17713999551da67fd3222c47c8b866afb0ad52c4c1302911dfbb50540836e9216314c67ce1130e7694c41ab13d
+  metadata.gz: daab02d1ecd9845a8e6faba1bddca6db086226ba200e4420349a9fd35ca65283b0c7408ec32b8b66ef016901dd45679a14c4f9aece51dff406b573d0275113ca
+  data.tar.gz: 92f1cf562e098530ec0a7689b32e86ab70f4c0d58af380a97d6fa2a1e965b3ac7851e23b0fdebe29de6a25224b586d711d7cccd0cbbbe8d70e857ce15c5900d8

data/lib/klenod/runtime/asset_url.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Klenod
+  module Runtime
+    module AssetUrl
+      DEFAULT_BASE = "/assets/"
+      LEGACY_OUTPUT_PREFIX = "/assets/"
+
+      module_function
+
+      def normalize(base)
+        value = base.to_s
+        value = DEFAULT_BASE if value.empty?
+        uri = URI.parse(value)
+
+        if uri.scheme
+          unless %w[http https].include?(uri.scheme) && uri.host && !uri.query && !uri.fragment
+            raise ArgumentError, "asset base must be an absolute HTTP(S) URL without a query or fragment: #{base.inspect}"
+          end
+        elsif !value.start_with?("/") || uri.query || uri.fragment
+          raise ArgumentError, "asset base must be an absolute path or HTTP(S) URL: #{base.inspect}"
+        end
+
+        value.end_with?("/") ? value : "#{value}/"
+      rescue URI::InvalidURIError
+        raise ArgumentError, "asset base must be an absolute path or HTTP(S) URL: #{base.inspect}"
+      end
+
+      def join(base, output_path)
+        path = output_path.to_s
+        unless path.start_with?("/") && !path.start_with?("//")
+          raise ArgumentError, "asset output path must be root-relative: #{output_path.inspect}"
+        end
+
+        "#{normalize(base)}#{path.delete_prefix("/")}"
+      end
+
+      def legacy_join(base, output_path)
+        join(base, output_path.delete_prefix(LEGACY_OUTPUT_PREFIX).prepend("/"))
+      end
+
+      def path_prefix(base)
+        normalized = normalize(base)
+        normalized if normalized.start_with?("/")
+      end
+    end
+  end
+end

data/lib/klenod/runtime/bundle.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "asset_url"
+
 module Klenod
   module Runtime
     ModuleSpec =
@@ -9,11 +11,22 @@ module Klenod
     DefaultImport = Data.define(:name)
 
     AssetSpec =
-      Data.define(:logical_name, :content_hash, :output_path, :content_type, :metadata)
+      Data.define(:logical_name, :content_hash, :output_path, :content_type, :metadata, :url) do
+        def initialize(logical_name = nil, content_hash = nil, output_path = nil, content_type = nil, metadata = nil, url = nil, **keywords)
+          logical_name = keywords.fetch(:logical_name, logical_name)
+          content_hash = keywords.fetch(:content_hash, content_hash)
+          output_path = keywords.fetch(:output_path, output_path)
+          content_type = keywords.fetch(:content_type, content_type)
+          metadata = keywords.fetch(:metadata, metadata)
+          url = keywords.fetch(:url, url)
+          url ||= output_path
+          super(logical_name:, content_hash:, output_path:, content_type:, metadata:, url:)
+        end
+      end
     AssetReference = Data.define(:index, :asset)
 
     class Bundle
-      attr_reader :entrypoints, :modules, :assets, :source_root
+      attr_reader :entrypoints, :modules, :assets, :source_root, :base
 
       def self.load(source, source_root: nil)
         BundleFormat.load(source, source_root: source_root)
@@ -23,11 +36,12 @@ module Klenod
         load(path, source_root: source_root)
       end
 
-      def initialize(entrypoints, modules, assets, source_root: nil)
+      def initialize(entrypoints, modules, assets, source_root: nil, base: AssetUrl::DEFAULT_BASE)
         @entrypoints = entrypoints
         @modules = modules
-        @assets = assets
         @source_root = source_root
+        @base = AssetUrl.normalize(base)
+        @assets = bind_asset_urls(assets)
         @mods = {}
       end
 
@@ -85,6 +99,17 @@ module Klenod
         @assets.fetch(output_path)
       end
 
+      def asset_url(asset_or_output_path)
+        if asset_or_output_path.respond_to?(:output_path)
+          asset = @assets.fetch(asset_or_output_path.output_path, asset_or_output_path)
+          return asset.url || AssetUrl.join(base, asset.output_path)
+        end
+
+        @assets.fetch(asset_or_output_path).url
+      rescue KeyError
+        AssetUrl.join(base, asset_or_output_path)
+      end
+
       def assets_for(logical_name)
         @assets.values.select { |asset| asset.logical_name == logical_name.to_s }
       end
@@ -121,11 +146,13 @@ module Klenod
       end
 
       def marshal_dump
-        [@entrypoints, @modules, @assets, @source_root]
+        [@entrypoints, @modules, @assets, @source_root, @base]
       end
 
       def marshal_load(data)
-        @entrypoints, @modules, @assets, @source_root = data
+        @entrypoints, @modules, assets, @source_root, base = data
+        @base = AssetUrl.normalize(base)
+        @assets = bind_asset_urls(assets)
         @mods = {}
       end
 
@@ -145,6 +172,18 @@ module Klenod
 
       private
 
+      def bind_asset_urls(assets)
+        assets.to_h do |output_path, asset|
+          legacy_url = asset.url.nil? || (asset.url == asset.output_path && base != AssetUrl::DEFAULT_BASE)
+          url = legacy_output_path?(asset.output_path) ? AssetUrl.legacy_join(base, asset.output_path) : AssetUrl.join(base, asset.output_path)
+          [output_path, legacy_url ? asset.with(url:) : asset]
+        end
+      end
+
+      def legacy_output_path?(output_path)
+        output_path.start_with?(AssetUrl::LEGACY_OUTPUT_PREFIX)
+      end
+
       def assets_for_runtime_module(module_id)
         module_spec = @modules.fetch(module_id)
         logical_names = [module_spec.id, module_spec.source_path].uniq

data/lib/klenod/runtime/bundle_format.rb

@@ -2,6 +2,7 @@
 
 require "json"
 
+require_relative "asset_url"
 require_relative "version"
 require_relative "source_map"
 
@@ -12,7 +13,7 @@ module Klenod
 
     module BundleFormat
       MAGIC = "MODPACK_BUNDLE_V1\n"
-      FORMAT_VERSION = 1
+      FORMAT_VERSION = 3
 
       module_function
 
@@ -39,6 +40,7 @@ module Klenod
           "format_version" => FORMAT_VERSION,
           "runtime_version" => Runtime::VERSION,
           "source_root" => encode_value(bundle.source_root),
+          "base" => bundle.base,
           "entrypoints" => encode_value(bundle.entrypoints),
           "modules" => encode_modules(bundle.modules),
           "assets" => encode_assets(bundle.assets)
@@ -53,7 +55,8 @@ module Klenod
             decode_value(payload.fetch("entrypoints")),
             decode_modules(payload.fetch("modules")),
             decode_assets(payload.fetch("assets")),
-            source_root: decode_value(payload["source_root"])
+            source_root: decode_value(payload["source_root"]),
+            base: payload.key?("base") ? payload.fetch("base") : AssetUrl::DEFAULT_BASE
           )
         bundle.source_root = source_root if source_root
         bundle
@@ -67,7 +70,7 @@ module Klenod
         raise BundleFormatError, "Malformed Klenod bundle payload" unless payload.is_a?(Hash)
 
         version = payload["format_version"]
-        unless version == FORMAT_VERSION
+        unless [1, 2, FORMAT_VERSION].include?(version)
           raise BundleFormatError, "Unsupported Klenod bundle format version: #{version.inspect}"
         end
 
@@ -157,7 +160,8 @@ module Klenod
               "content_hash" => asset.content_hash,
               "output_path" => asset.output_path,
               "content_type" => asset.content_type,
-              "metadata" => encode_value(asset.metadata)
+              "metadata" => encode_value(asset.metadata),
+              "url" => asset.url
             }
           ]
         end
@@ -173,7 +177,8 @@ module Klenod
               asset_payload.fetch("content_hash"),
               asset_payload.fetch("output_path"),
               asset_payload.fetch("content_type"),
-              decode_value(asset_payload.fetch("metadata"))
+              decode_value(asset_payload.fetch("metadata")),
+              asset_payload["url"]
             )
           ]
         end

data/lib/klenod/runtime/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module Runtime
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/klenod/runtime.rb

@@ -4,6 +4,7 @@ require_relative "runtime/version"
 require_relative "runtime/source_map"
 require_relative "runtime/backtrace_rewriter"
 require_relative "runtime/mod"
+require_relative "runtime/asset_url"
 require_relative "runtime/bundle"
 require_relative "runtime/bundle_format"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-runtime
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrés Alin
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/klenod/runtime.rb
+- lib/klenod/runtime/asset_url.rb
 - lib/klenod/runtime/backtrace_rewriter.rb
 - lib/klenod/runtime/bundle.rb
 - lib/klenod/runtime/bundle_format.rb
@@ -37,7 +38,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 4.0.6
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="