picoruby-cloudflare-template 0.1.0.rc2 → 0.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c224b29b75ac222a183233c6af8022623d9530324e9028a76a1056278f07437b
-  data.tar.gz: a5199135545e2927b66465fb436e846260e3303587140f498c82d341f0f9ce0d
+  metadata.gz: d1e94aeb373291700f0509904e30eb78d209a4515eab57d8f2b062e51a73b1d3
+  data.tar.gz: d5c5a48c99963645d76396dac918e0a361fb76d1f27b8b05f4d025b9736b901a
 SHA512:
-  metadata.gz: db0e353a8dc1e2a0fddd8c8d82bd12ee605416d4b3bde95a0b536991bd4b33a9843a5d99364f865e4afc679b57fa2282cc5b1ec3d2fcce7e578b694a05e30cef
-  data.tar.gz: fafcf2e5bb8a86065991b0dc388ab9521729ae2a692f458734e824a66ac9a3748c46ab8ff28f6fbb83c87c7eed4caa85c3548c3ba35c5f8337717caac10c1918
+  metadata.gz: ee3311b2386d5c2b10dddafdf80f93c07a5b53ab600867c7bf97a06f9f6de5aa57f61653a3cf584b92c88acb9eb85b0d118fa7a804cf63113f2d03d6d29be2d6
+  data.tar.gz: 6eee502c73767aba791d4f05c2d7eff0e882943e615418084b65ae2d2966ce1e3f865cea1c4bed1ce57c365a12939227857fa985356ff00dd47d69cc1f5be792

data/README.ja.md

@@ -53,7 +53,7 @@ PicoRubyはsubmodule初期化済みのチェックアウトを指定します。
 src/index.js、package.json、wrangler.jsonc、.gitignore、README.mdを生成します。
 生成先が存在する場合は空ディレクトリでも上書きしません。Gemfile.lockとpackage-lock.jsonはアプリ側でコミットしてください。
 
-`--bindings` を付けると、KV・Queue・Accessのユーザー情報取得例をapp.rbとwrangler.jsoncへ追加します。
+`--bindings` を付けると、KV・Queue・Durable Object・Accessのユーザー情報取得例をapp.rbとwrangler.jsoncへ追加します。
 `/access` の例には `CF_ACCESS_TEAM` と `CF_Authorization` Cookieが必要です。
 同時に生成する `.picoruby-cloudflare-template.json` は、この2つの管理対象例のハッシュを記録します。
 今後対応bindingが増えた版では、`picoruby-cloudflare bindings PROJECT` を実行すると例を再生成できます。
@@ -91,7 +91,7 @@ Sinatra等のフレームワークはアプリ側で追加します。ABI固有
 revision属性のデフォルトはこのgemに組み込まれた値です。`nil` を代入するとデフォルトに戻ります。
 取得先の選択で `PICORUBY_WORKER_WASM_GEM_DIR` / `MRUBY_RACK_GEM_DIR` は参照せず、`worker:` / `rack:` 引数も受け取りません。
 
-既定のWorker取得先は `67aaa676d8247beaf19cbbeaeecb78115e490529` に固定しています。
+既定のWorker取得先は `5590e3ff32714ebcec35c53e1fad63156540e425` に固定しています。
 Rackは `30802024e263a0dde1f3a8467e648a70625adfd4` に固定しています。
 再現可能な依存関係が必要な場合は、Worker revisionをタグまたはcommit SHAで上書きしてください。
 gem公開前には、新規チェックアウトから両方の固定取得先を取得できることを確認します。
@@ -112,6 +112,7 @@ generated/worker/
     index.js              # createWorker({ app, bindingTypes })
     runtime.js
     host-bridge.js
+    durable-object.js
     picoruby-worker.js
     picoruby-worker.wasm
   tools/                  # binding registry生成スクリプト
@@ -119,10 +120,11 @@ generated/worker/
 
 Ruby/C・HAL・共通JS bridgeは実行時ライブラリが、このgemはテンプレート・CrossBuild DSL・export処理・薄いcreateWorkerエントリを所有します。
 共通JSとregistry生成スクリプトは、Wasmをビルドした**同じmrbgemチェックアウト**からコピーします。
-現在の取得場所は `spike/src/` と `spike/scripts/` です。別コピーの実装をこのgemで管理しません。
+取得元は `templates/runtime/` と `templates/tools/` です。Workerリポジトリのspikeはビルド時に `spike/src/` と `spike/scripts/` へコピーします。
 レイアウト変更時はexporterと設定済みWorker refを一緒に更新します。
 
 `createWorker` はリクエストごとにVMを生成・破棄し、異なるリクエストのenvを共有しません。
+生成runtimeはWrangler向けに `PicoRubyDurableObject` もexportします。
 低レベルの `createRuntime` / `dispatch` / `closeRuntime` も再exportします。
 明示的にVMを再利用した場合、同じVMへのdispatchは実行時ライブラリが直列化します。
 出力はWranglerでバンドルする前提です。Node.jsがそのまま `.wasm` / `.bin` importできるという意味ではありません。
@@ -134,7 +136,7 @@ registryは環境変更を反映するため毎回検証・生成します。元
 
 ## bindings・環境・Wrangler
 
-wrangler.jsoncの `kv_namespaces` / `queues.producers` から型registryを生成します。
+wrangler.jsoncの `kv_namespaces`・`queues.producers`・`durable_objects.bindings` から型registryを生成します。
 JSONCのコメント・末尾カンマに対応し、不正な設定・重複名・存在しない環境はビルドエラーにします。
 varsの値やsecretはビルド成果物へ埋め込みません。
 
@@ -143,9 +145,15 @@ kv = Cloudflare::KV.from_env(env, "CACHE_KV")
 kv.put("key", "value", ttl: 60)
 value = env["cloudflare.env"].CACHE_KV.get("key")
 Cloudflare::Queue.from_env(env, "EVENTS").send("created")
+objects = Cloudflare::DurableObject.from_env(env, "OBJECTS")
+objects.put("counter", { "value" => 1 })
+counter = objects.get("counter")
 token = ENV["API_TOKEN"]
 ```
 
+Durable Objectの `put` は `Cloudflare::DurableObject::POJO`、単純なHash/Array、
+または `to_pojo` に反応するオブジェクトを受け取ります。`get` はJSON objectなら `POJO`、
+JSON arrayなら内部のobjectをPOJO化したArrayを返します。
 Queueは現行APIに合わせてUTF-8文字列送信のみです。secretは.dev.varsまたは `wrangler secret put` で管理し、Gitへ追加しないでください。
 
 AccessにはRackミドルウェア `Rack::Cloudflare::Access`（`Cloudflare::Access` の別名）を使います。
@@ -175,8 +183,8 @@ JWT署名・アプリケーションのaudienceをローカル検証する機能
 通信・レスポンスの異常なら502を返し、後続アプリを呼びません。
 生成例では `/access` だけにミドルウェアを適用し、他のサンプル経路は公開のままです。
 
-Access対応はWorkerの `67aaa676d8247beaf19cbbeaeecb78115e490529` とmruby-rackの
-`30802024e263a0dde1f3a8467e648a70625adfd4` に反映済みで、このテンプレートは標準でそれらを使用します。
+Workerの `5590e3ff32714ebcec35c53e1fad63156540e425` はAccess・Durable Objectに対応しています。
+mruby-rackの `30802024e263a0dde1f3a8467e648a70625adfd4` はAccessミドルウェアに対応し、このテンプレートは両方を標準で使用します。
 ローカルmrbgem checkoutの指定は不要です。
 
 `npm run dev` / `npm run deploy` ではWranglerのcustom buildがRakeを実行します。

data/README.md

@@ -53,7 +53,7 @@ After this release candidate is published, install it with `gem install picoruby
 src/index.js, package.json, wrangler.jsonc, .gitignore, and README.md.
 An existing destination is never overwritten, even if it is an empty directory. Commit Gemfile.lock and package-lock.json in your application repository.
 
-Pass `--bindings` to include KV, Queue and Access identity examples in app.rb and wrangler.jsonc.
+Pass `--bindings` to include KV, Queue, Durable Object and Access identity examples in app.rb and wrangler.jsonc.
 The `/access` example requires `CF_ACCESS_TEAM` and a `CF_Authorization` cookie.
 The generated `.picoruby-cloudflare-template.json` records hashes of those two managed examples.
 Run `picoruby-cloudflare bindings PROJECT` with a future template version to refresh them as supported bindings expand.
@@ -91,7 +91,7 @@ A directory takes precedence over its revision, and relative directory paths are
 Revision attributes default to the values bundled in this gem; assigning `nil` restores those defaults.
 Dependency source selection no longer reads `PICORUBY_WORKER_WASM_GEM_DIR` or `MRUBY_RACK_GEM_DIR`, or accepts `worker:` / `rack:` arguments.
 
-The default Worker source is pinned to `67aaa676d8247beaf19cbbeaeecb78115e490529`.
+The default Worker source is pinned to `5590e3ff32714ebcec35c53e1fad63156540e425`.
 Rack is pinned to `30802024e263a0dde1f3a8467e648a70625adfd4`.
 Override the Worker revision with a tag or commit SHA when a reproducible dependency is required.
 Before publishing this gem, verify that a fresh checkout can fetch both pinned sources.
@@ -112,6 +112,7 @@ generated/worker/
     index.js              # createWorker({ app, bindingTypes })
     runtime.js
     host-bridge.js
+    durable-object.js
     picoruby-worker.js
     picoruby-worker.wasm
   tools/                  # Binding registry generation scripts
@@ -119,10 +120,11 @@ generated/worker/
 
 The runtime library owns the Ruby/C code, HAL, and shared JS bridge. This gem owns the templates, CrossBuild DSL, export logic, and thin createWorker entry point.
 Shared JS and registry generation scripts are copied from **the same mrbgem checkout** used to build Wasm.
-Their current locations are `spike/src/` and `spike/scripts/`. This gem does not maintain a separate copy of those implementations.
+Their source locations are `templates/runtime/` and `templates/tools/`. The Worker repository's spike copies them into `spike/src/` and `spike/scripts/` during its build.
 If that layout changes, update the exporter and configured Worker ref together.
 
 `createWorker` creates and closes a VM for each request, without sharing env between requests.
+The generated runtime also exports `PicoRubyDurableObject` for Wrangler.
 The low-level `createRuntime` / `dispatch` / `closeRuntime` functions are also re-exported.
 If you explicitly reuse a VM, the runtime library serializes dispatches to that VM.
 The output is intended to be bundled with Wrangler; it does not make `.wasm` / `.bin` imports directly usable in Node.js.
@@ -134,7 +136,8 @@ However, the tested PicoRuby version rewrites src/version.c on every build, so t
 
 ## Bindings, environments, and Wrangler
 
-The type registry is generated from `kv_namespaces` / `queues.producers` in wrangler.jsonc.
+The type registry is generated from `kv_namespaces`, `queues.producers`, and
+`durable_objects.bindings` in wrangler.jsonc.
 JSONC comments and trailing commas are supported. Invalid configuration, duplicate binding names, and nonexistent environments cause build errors.
 Variable values and secrets are not embedded in build artifacts.
 
@@ -143,9 +146,15 @@ kv = Cloudflare::KV.from_env(env, "CACHE_KV")
 kv.put("key", "value", ttl: 60)
 value = env["cloudflare.env"].CACHE_KV.get("key")
 Cloudflare::Queue.from_env(env, "EVENTS").send("created")
+objects = Cloudflare::DurableObject.from_env(env, "OBJECTS")
+objects.put("counter", { "value" => 1 })
+counter = objects.get("counter")
 token = ENV["API_TOKEN"]
 ```
 
+Durable Object `put` accepts a `Cloudflare::DurableObject::POJO`, a simple Hash
+or Array, or an object responding to `to_pojo`; `get` returns a `POJO` for a
+JSON object and an Array containing POJOs for a JSON array.
 Queue sending currently supports UTF-8 strings only, matching the runtime API. Manage secrets through .dev.vars or `wrangler secret put`, and keep them out of Git.
 
 Access uses Rack middleware `Rack::Cloudflare::Access` (an alias of `Cloudflare::Access`):
@@ -175,8 +184,8 @@ The middleware returns 503 for missing/invalid configuration, 401 for a missing/
 or an Access 401/403 response, and 502 for upstream/protocol failures, without calling the application.
 The generated example applies middleware only to `/access`; other example routes remain public.
 
-Access support is included in Worker commit `67aaa676d8247beaf19cbbeaeecb78115e490529` and mruby-rack commit
-`30802024e263a0dde1f3a8467e648a70625adfd4`, which this template uses by default.
+Worker commit `5590e3ff32714ebcec35c53e1fad63156540e425` includes Access and Durable Object support.
+mruby-rack commit `30802024e263a0dde1f3a8467e648a70625adfd4` includes Access middleware support. This template uses both by default.
 No local mrbgem checkout overrides are required.
 
 With `npm run dev` / `npm run deploy`, Wrangler's custom build runs Rake.

data/lib/picoruby/cloudflare/build.rb

@@ -8,7 +8,7 @@ end
 
 module Picoruby::Cloudflare::Template
   module CrossBuild
-    WORKER_REVISION = "67aaa676d8247beaf19cbbeaeecb78115e490529".freeze
+    WORKER_REVISION = "5590e3ff32714ebcec35c53e1fad63156540e425".freeze
     RACK_REVISION = "30802024e263a0dde1f3a8467e648a70625adfd4".freeze
     CORE_GEMS = %w[mruby-array-ext mruby-catch mruby-class-ext mruby-enum-ext
                    mruby-hash-ext mruby-kernel-ext mruby-metaprog mruby-method

data/lib/picoruby/cloudflare/template/exporter.rb

@@ -62,15 +62,15 @@ module Picoruby::Cloudflare::Template
     end
 
     def export(runtime_js, runtime_wasm)
-      %w[runtime.js host-bridge.js].each do |name|
-        write(File.join("runtime", name), File.binread(File.join(@gem_dir, "spike/src", name)))
+      %w[runtime.js host-bridge.js durable-object.js].each do |name|
+        write(File.join("runtime", name), File.binread(File.join(@gem_dir, "templates/runtime", name)))
       end
       write("runtime/picoruby-worker.js", File.binread(runtime_js))
       write("runtime/picoruby-worker.wasm", File.binread(runtime_wasm))
       # Keep parser and runtime from the same mrbgem checkout. Scripts are copied
       # below the project so Node resolves its jsonc-parser dependency there.
       %w[cloudflare-binding-registry.mjs generate-bindings.mjs].each do |name|
-        write(File.join("tools", name), File.binread(File.join(@gem_dir, "spike/scripts", name)))
+        write(File.join("tools", name), File.binread(File.join(@gem_dir, "templates/tools", name)))
       end
       Tempfile.create(["bindings", ".js"], @output) do |temp|
         temp.close
@@ -82,7 +82,7 @@ module Picoruby::Cloudflare::Template
       end
       write("runtime/index.js", File.read(File.join(templates, "runtime/index.js")))
       write("package.json", JSON.pretty_generate({ private: true, type: "module", exports: "./runtime/index.js" }) + "\n")
-      artifacts = %w[app.bin bindings.js package.json runtime/index.js runtime/runtime.js runtime/host-bridge.js runtime/picoruby-worker.js runtime/picoruby-worker.wasm]
+      artifacts = %w[app.bin bindings.js package.json runtime/index.js runtime/runtime.js runtime/host-bridge.js runtime/durable-object.js runtime/picoruby-worker.js runtime/picoruby-worker.wasm]
       write("manifest.json", JSON.pretty_generate({
         format_version: 1, generator_version: VERSION, environment: @environment,
         worker_revision: worker_revision,
@@ -97,7 +97,7 @@ module Picoruby::Cloudflare::Template
     end
 
     def check_assets!
-      %w[spike/src/runtime.js spike/src/host-bridge.js spike/scripts/cloudflare-binding-registry.mjs spike/scripts/generate-bindings.mjs].each do |path|
+      %w[templates/runtime/runtime.js templates/runtime/host-bridge.js templates/runtime/durable-object.js templates/tools/cloudflare-binding-registry.mjs templates/tools/generate-bindings.mjs].each do |path|
         raise Error, "Worker mrbgem is missing export asset #{path}; use the documented runtime revision" unless File.file?(File.join(@gem_dir, path))
       end
     end

data/lib/picoruby/cloudflare/template/generator.rb

@@ -12,7 +12,7 @@ module Picoruby::Cloudflare::Template
     TEMPLATES = File.expand_path("../../../../templates", __dir__)
     BINDINGS_MANIFEST = ".picoruby-cloudflare-template.json"
     BINDINGS_FILES = %w[app.rb wrangler.jsonc].freeze
-    BINDINGS_FEATURES = %w[kv queue access].freeze
+    BINDINGS_FEATURES = %w[kv queue durable_object access].freeze
 
     def initialize(destination, name: nil, gem_path: nil, bindings: false)
       @destination = File.expand_path(destination)

data/lib/picoruby/cloudflare/template/version.rb

@@ -3,7 +3,7 @@
 module Picoruby
   module Cloudflare
     module Template
-      VERSION = "0.1.0.rc2"
+      VERSION = "0.1.0.rc3"
     end
   end
 end

data/templates/project/README.md.erb

@@ -47,9 +47,12 @@ use Wrangler to bundle them, not a plain Node.js import of `src/index.js`.
 Configure bindings in `wrangler.jsonc`; the build regenerates `bindings.js`.
 Ruby can use `env["cloudflare.env"].CACHE_KV` or
 `Cloudflare::KV.from_env(env, "CACHE_KV")`, and similarly `Cloudflare::Queue.from_env`.
+Durable Objects use `Cloudflare::DurableObject.from_env`; `put` accepts POJO,
+Hash, Array, or an object responding to `to_pojo`.
 String/JSON vars and secrets are accessible through Ruby `ENV`.
 
-If this project was generated with `--bindings`, app.rb exposes `/kv`, `/queue` and `/access`
+If this project was generated with `--bindings`, app.rb exposes `/kv`, `/queue`,
+`/durable-object` and `/access`
 examples and `.picoruby-cloudflare-template.json` tracks their generated state.
 Run `picoruby-cloudflare bindings .` with a newer template to refresh unedited
 binding examples. The command refuses to overwrite an edited app.rb or wrangler.jsonc.

data/templates/project/app.rb.erb

@@ -9,6 +9,10 @@ app = lambda do |env|
     when "/queue"
       Cloudflare::Queue.from_env(env, "EVENTS").send("Hello from PicoRuby!")
       "Message sent to Cloudflare Queue!"
+    when "/durable-object"
+      store = Cloudflare::DurableObject.from_env(env, "OBJECTS")
+      store.put("example", { "message" => "Hello from a Durable Object!" })
+      store.get("example")["message"]
     when "/access"
       identity = env["cloudflare.identity"]
       identity.email || "Access identity has no email"

data/templates/project/src/index.js.erb

@@ -2,4 +2,6 @@ import { createWorker } from "../generated/worker/runtime/index.js";
 import app from "../generated/worker/app.bin";
 import { cloudflareBindingTypes } from "../generated/worker/bindings.js";
 
+export { PicoRubyDurableObject } from "../generated/worker/runtime/index.js";
+
 export default createWorker({ app, bindingTypes: cloudflareBindingTypes });

data/templates/project/wrangler.jsonc.erb

@@ -19,6 +19,14 @@
       { "binding": "EVENTS", "queue": "events" }
     ]
   },
+  "durable_objects": {
+    "bindings": [
+      { "name": "OBJECTS", "class_name": "PicoRubyDurableObject" }
+    ]
+  },
+  "migrations": [
+    { "tag": "v1", "new_sqlite_classes": ["PicoRubyDurableObject"] }
+  ],
 <% end -%>
   "vars": {
 <% if @bindings -%>
@@ -28,7 +36,7 @@
     "GREETING": "Hello from PicoRuby on Cloudflare!"
   }
 <% unless @bindings -%>
-  // Add kv_namespaces / queues.producers here, then rebuild.
+  // Add kv_namespaces / queues.producers / durable_objects.bindings here, then rebuild.
 <% end -%>
   // Keep secrets out of this file; use .dev.vars and wrangler secret put.
 }

data/templates/runtime/index.js

@@ -20,3 +20,4 @@ export function createWorker({ app, bindingTypes }) {
 }
 
 export { createCloudflareBindings, createRuntime, dispatch, closeRuntime } from "./runtime.js";
+export { PicoRubyDurableObject } from "./durable-object.js";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picoruby-cloudflare-template
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.0.rc3
 platform: ruby
 authors:
 - Uchio Kondo