klenod-runtime 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec22e411f49459149641d8ea8b1aaa0a55e619c4c45e4d34a189b0ff0f4fcb9b
-  data.tar.gz: d800fd32dc4db55d8595fb0227f62de71860c8da8048c2fa7dd8dae2ef38efce
+  metadata.gz: d9f47b3f5b7633bc5266d7d84b085d0712911addf1c3801257016bca575592de
+  data.tar.gz: 104d04cde8bc7140f8dfb719008b76ceb2355d262823067fda91253b773cded4
 SHA512:
-  metadata.gz: ae054ac59be068695833d60a5115f16d222dc0861ecdca5f71b3b0a7568ab2ba89c4f016b9d80535867239102ca4fcea8c059290a9e48117f00c50193300a76a
-  data.tar.gz: 60a7dff20e4563100af20037ccdfee2f940e407c512e1c7c409e5b0c37d9955e19e0b3989a5e4ce2290e9859c639d6b2198166f3215b793a756e6c654620158d
+  metadata.gz: ff96f298c6cb62fd3a6d9ddc6be0da629fe2286a8904ec6d26a37aa8b27dcf74dd20bc54c63221b5bcb8cc23b3dea9cba7278fb16b4a9b2577a34e44a07f7e96
+  data.tar.gz: 1776d55bbb39e6286da64179dd8ac313f996c809381b278cf23039dd7ea80187689e7c1d0f372bcb26c77a371f5fa7ad51ab71228057b691a0db9b06490a7574

data/README.md

@@ -21,6 +21,12 @@ bundle = Klenod::Runtime.load_bundle("dist/klenod.bundle")
 exports = bundle.exports("pages/server")
 ```
 
+Pass `namespace:` a named module when instances of bundled classes must be marshaled. The default anonymous namespace gives those classes names that Ruby cannot resolve:
+
+```ruby
+bundle = Klenod::Runtime.load_bundle("dist/klenod.bundle", namespace: MyApp::Modules)
+```
+
 Production servers can explicitly preload bundled modules:
 
 ```ruby

data/lib/klenod/runtime/bundle.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
+require "digest"
+
 require_relative "asset_url"
 
 module Klenod
   module Runtime
+    # `transformed_hash` is the SHA256 hex digest of `source`, the transformed
+    # module source. It is computed when omitted, e.g. for older bundles.
     ModuleSpec =
-      Data.define(:id, :source_path, :source, :imports, :source_map, :version, :constant_name)
+      Data.define(:id, :source_path, :source, :imports, :source_map, :version, :constant_name, :transformed_hash) do
+        def initialize(transformed_hash: nil, **fields)
+          transformed_hash ||= Digest::SHA256.hexdigest(fields.fetch(:source))
+          super
+        end
+      end
 
     ImportSpec = Data.define(:target_id, :value, :eager)
     DefaultImport = Data.define(:name)
@@ -28,12 +37,12 @@ module Klenod
     class Bundle
       attr_reader :entrypoints, :modules, :assets, :source_root, :base, :asset_origin, :namespace
 
-      def self.load(source, source_root: nil)
-        BundleFormat.load(source, source_root: source_root)
+      def self.load(source, source_root: nil, namespace: Module.new)
+        BundleFormat.load(source, source_root: source_root, namespace: namespace)
       end
 
-      def self.load_file(path, source_root: nil)
-        load(path, source_root: source_root)
+      def self.load_file(path, source_root: nil, namespace: Module.new)
+        load(path, source_root: source_root, namespace: namespace)
       end
 
       def initialize(entrypoints, modules, assets, source_root: nil, base: AssetUrl::DEFAULT_BASE, namespace: Module.new)
@@ -147,16 +156,24 @@ module Klenod
         @mods = {}
       end
 
+      def namespace=(namespace)
+        @namespace = namespace
+        @mods = {}
+      end
+
+      # A named namespace is dumped by reference, so the loading process must
+      # define the same constant. Anonymous namespaces cannot be dumped and are
+      # replaced with a fresh anonymous module.
       def marshal_dump
-        [@entrypoints, @modules, @assets, @source_root, @base]
+        [@entrypoints, @modules, @assets, @source_root, @base, (@namespace if @namespace.name)]
       end
 
       def marshal_load(data)
-        @entrypoints, @modules, assets, @source_root, base = data
+        @entrypoints, @modules, assets, @source_root, base, namespace = data
         @base = AssetUrl.normalize(base)
         @asset_origin = AssetUrl.origin(@base)
         @assets = bind_asset_urls(assets)
-        @namespace = Module.new
+        @namespace = namespace || Module.new
         @mods = {}
       end
 

data/lib/klenod/runtime/bundle_format.rb

@@ -21,16 +21,16 @@ module Klenod
         MAGIC + JSON.generate(payload_for(bundle))
       end
 
-      def load(source, source_root: nil)
-        load_bytes(read_source(source), source_root: source_root)
+      def load(source, source_root: nil, namespace: Module.new)
+        load_bytes(read_source(source), source_root: source_root, namespace: namespace)
       end
 
-      def load_bytes(bytes, source_root: nil)
+      def load_bytes(bytes, source_root: nil, namespace: Module.new)
         raise BundleFormatError, "Invalid Klenod bundle header" unless bytes.start_with?(MAGIC)
 
         body = bytes.byteslice(MAGIC.bytesize, bytes.bytesize - MAGIC.bytesize)
         payload = JSON.parse(body)
-        bundle_from_payload(payload, source_root: source_root)
+        bundle_from_payload(payload, source_root: source_root, namespace: namespace)
       rescue JSON::ParserError => error
         raise BundleFormatError, "Invalid Klenod bundle JSON: #{error.message}"
       end
@@ -47,7 +47,7 @@ module Klenod
         }
       end
 
-      def bundle_from_payload(payload, source_root: nil)
+      def bundle_from_payload(payload, source_root: nil, namespace: Module.new)
         validate_payload!(payload)
 
         bundle =
@@ -56,7 +56,8 @@ module Klenod
             decode_modules(payload.fetch("modules")),
             decode_assets(payload.fetch("assets")),
             source_root: decode_value(payload["source_root"]),
-            base: payload.key?("base") ? payload.fetch("base") : AssetUrl::DEFAULT_BASE
+            base: payload.key?("base") ? payload.fetch("base") : AssetUrl::DEFAULT_BASE,
+            namespace: namespace
           )
         bundle.source_root = source_root if source_root
         bundle
@@ -90,7 +91,8 @@ module Klenod
               "imports" => encode_imports(spec.imports),
               "source_map" => encode_source_map(spec.source_map),
               "version" => spec.version,
-              "constant_name" => spec.constant_name
+              "constant_name" => spec.constant_name,
+              "transformed_hash" => spec.transformed_hash
             }
           ]
         end
@@ -108,7 +110,8 @@ module Klenod
               decode_imports(spec_payload.fetch("imports")),
               decode_source_map(spec_payload["source_map"], spec_payload.fetch("source")),
               spec_payload.fetch("version"),
-              spec_payload.fetch("constant_name")
+              spec_payload.fetch("constant_name"),
+              spec_payload["transformed_hash"]
             )
           ]
         end

data/lib/klenod/runtime/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module Runtime
-    VERSION = "0.0.27"
+    VERSION = "0.0.28"
   end
 end

data/lib/klenod/runtime.rb

@@ -12,18 +12,18 @@ module Klenod
   module Runtime
     EXECUTABLE_BUNDLE_MARKER = "\n__END__\n".b.freeze
 
-    def self.load_bundle(source, source_root: nil)
-      Bundle.load(source, source_root: source_root)
+    def self.load_bundle(source, source_root: nil, namespace: Module.new)
+      Bundle.load(source, source_root: source_root, namespace: namespace)
     end
 
-    def self.load_bundle_in_box(source, source_root: nil, box: nil)
+    def self.load_bundle_in_box(source, source_root: nil, box: nil, namespace: Module.new)
       unless defined?(Ruby::Box) && Ruby::Box.enabled?
         raise "Ruby::Box is disabled. Set RUBY_BOX=1 environment variable to use Ruby::Box."
       end
 
       bytes = source.respond_to?(:read) ? source.read : File.binread(source)
       box = prepare_box(box)
-      box::Klenod::Runtime::BundleFormat.load_bytes(bytes, source_root: source_root)
+      box::Klenod::Runtime::BundleFormat.load_bytes(bytes, source_root: source_root, namespace: namespace)
     end
 
     def self.prepare_box(box = nil)
@@ -41,13 +41,13 @@ module Klenod
         box::Klenod.const_defined?(:Runtime, false)
     end
 
-    def self.load_executable_bundle(path, source_root: nil)
+    def self.load_executable_bundle(path, source_root: nil, namespace: Module.new)
       bytes = File.binread(path)
       marker_index = bytes.index(EXECUTABLE_BUNDLE_MARKER)
       raise ArgumentError, "Missing __END__ marker in executable bundle: #{path}" unless marker_index
 
       payload = bytes.byteslice(marker_index + EXECUTABLE_BUNDLE_MARKER.bytesize, bytes.bytesize)
-      BundleFormat.load_bytes(payload, source_root: source_root)
+      BundleFormat.load_bytes(payload, source_root: source_root, namespace: namespace)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-runtime
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Andrés Alin