RubyGems - ruact - Versions diffs - 0.0.11 → 0.0.13 - Mend

ruact 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (137) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +147 -48
data/CONTRIBUTING.md +233 -0
data/README.md +18 -8
data/RELEASING.md +125 -139
data/lib/generators/ruact/install/install_generator.rb +305 -126
data/lib/generators/ruact/install/templates/AGENTS.md.tt +14 -13
data/lib/generators/ruact/install/templates/initializer.rb.tt +29 -7
data/lib/generators/ruact/install/templates/tsconfig.json.tt +3 -0
data/lib/generators/ruact/layout/layout_generator.rb +52 -0
data/lib/generators/ruact/scaffold/templates/controller.rb.tt +5 -3
data/lib/ruact/configuration.rb +65 -13
data/lib/ruact/controller/document_rendering.rb +72 -16
data/lib/ruact/controller/page_rendering.rb +134 -0
data/lib/ruact/controller/pages.rb +116 -0
data/lib/ruact/controller.rb +78 -11
data/lib/ruact/doctor.rb +233 -25
data/lib/ruact/layout_source.rb +29 -7
data/lib/ruact/navigation_boundary.rb +240 -0
data/lib/ruact/packaging.rb +68 -0
data/lib/ruact/railtie.rb +30 -0
data/lib/ruact/server.rb +10 -1
data/lib/ruact/version.rb +1 -1
data/lib/ruact/view_helper.rb +158 -1
data/lib/ruact/views/layouts/ruact.html.erb +32 -0
data/lib/ruact.rb +29 -0
data/vendor/javascript/vite-plugin-ruact/flight-client.test.mjs +321 -0
data/vendor/javascript/vite-plugin-ruact/package-lock.json +11 -0
data/vendor/javascript/vite-plugin-ruact/package.json +1 -0
data/vendor/javascript/vite-plugin-ruact/ruact-router.test.mjs +433 -0
data/vendor/javascript/vite-plugin-ruact/runtime/flight-client.js +14 -3
data/vendor/javascript/vite-plugin-ruact/runtime/ruact-router.js +170 -7
metadata +12 -107
data/.codecov.yml +0 -31
data/.github/workflows/ci.yml +0 -284
data/.github/workflows/server-functions-bench.yml +0 -54
data/.rubocop.yml +0 -107
data/.rubocop_todo.yml +0 -63
data/Rakefile +0 -10
data/bench/server_functions_dispatch_bench.rb +0 -276
data/bench/server_functions_dispatch_bench.results.md +0 -150
data/docs/internal/README.md +0 -9
data/docs/internal/decisions/server-functions-api.md +0 -2236
data/spec/benchmarks/baseline.json +0 -12
data/spec/benchmarks/render_pipeline_benchmark_spec.rb +0 -109
data/spec/fixtures/flight/README.md +0 -136
data/spec/fixtures/flight/array.txt +0 -1
data/spec/fixtures/flight/as_json_object.txt +0 -2
data/spec/fixtures/flight/bigint.txt +0 -1
data/spec/fixtures/flight/boolean_false.txt +0 -1
data/spec/fixtures/flight/boolean_true.txt +0 -1
data/spec/fixtures/flight/client_component_with_props.txt +0 -2
data/spec/fixtures/flight/client_reference.txt +0 -2
data/spec/fixtures/flight/hash.txt +0 -1
data/spec/fixtures/flight/infinity.txt +0 -1
data/spec/fixtures/flight/nan.txt +0 -1
data/spec/fixtures/flight/negative_infinity.txt +0 -1
data/spec/fixtures/flight/nil.txt +0 -1
data/spec/fixtures/flight/number_float.txt +0 -1
data/spec/fixtures/flight/number_integer.txt +0 -1
data/spec/fixtures/flight/react_element_no_props.txt +0 -1
data/spec/fixtures/flight/redirect_row.txt +0 -1
data/spec/fixtures/flight/serializable_object.txt +0 -2
data/spec/fixtures/flight/string_basic.txt +0 -1
data/spec/fixtures/flight/string_dollar_escape.txt +0 -1
data/spec/fixtures/flight/undefined.txt +0 -1
data/spec/fixtures/readme/children-error.html.erb +0 -3
data/spec/fixtures/readme/children-error.txt +0 -1
data/spec/fixtures/story_7_9_views/controller_request_spec_support/demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/errors_demo/new.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/exploding_layout_demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/ghost_layout_demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/layout_demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/rootless_layout_demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/controller_request_spec_support/unwired_layout_demo/show.html.erb +0 -3
data/spec/fixtures/story_7_9_views/layouts/bare_host.html.erb +0 -16
data/spec/fixtures/story_7_9_views/layouts/exploding_host.html.erb +0 -24
data/spec/fixtures/story_7_9_views/layouts/rootless_host.html.erb +0 -15
data/spec/fixtures/story_7_9_views/layouts/ruact_host.html.erb +0 -17
data/spec/readme_demo_message_spec.rb +0 -67
data/spec/readme_spec.rb +0 -282
data/spec/ruact/client_manifest_spec.rb +0 -270
data/spec/ruact/component_contract_spec.rb +0 -119
data/spec/ruact/configuration_spec.rb +0 -518
data/spec/ruact/controller_request_spec.rb +0 -671
data/spec/ruact/controller_spec.rb +0 -343
data/spec/ruact/doctor_spec.rb +0 -769
data/spec/ruact/erb_preprocessor_hook_spec.rb +0 -55
data/spec/ruact/erb_preprocessor_spec.rb +0 -361
data/spec/ruact/errors_spec.rb +0 -93
data/spec/ruact/flight/renderer_spec.rb +0 -133
data/spec/ruact/flight/serializer_spec.rb +0 -494
data/spec/ruact/html_converter_spec.rb +0 -375
data/spec/ruact/install_generator_spec.rb +0 -1549
data/spec/ruact/layout_source_spec.rb +0 -108
data/spec/ruact/manifest_resolver_spec.rb +0 -174
data/spec/ruact/query_request_spec.rb +0 -706
data/spec/ruact/query_spec.rb +0 -105
data/spec/ruact/railtie_spec.rb +0 -155
data/spec/ruact/render_context_spec.rb +0 -58
data/spec/ruact/render_pipeline_concurrency_spec.rb +0 -78
data/spec/ruact/render_pipeline_spec.rb +0 -928
data/spec/ruact/scaffold_generator_spec.rb +0 -1849
data/spec/ruact/serializable_spec.rb +0 -179
data/spec/ruact/server_bucket_request_spec.rb +0 -785
data/spec/ruact/server_function_name_spec.rb +0 -53
data/spec/ruact/server_functions/backtrace_cleaner_spec.rb +0 -63
data/spec/ruact/server_functions/bucket_two_payload_spec.rb +0 -200
data/spec/ruact/server_functions/codegen_spec.rb +0 -397
data/spec/ruact/server_functions/error_payload_spec.rb +0 -222
data/spec/ruact/server_functions/error_suggestion_spec.rb +0 -79
data/spec/ruact/server_functions/introspection_spec.rb +0 -135
data/spec/ruact/server_functions/name_bridge_spec.rb +0 -212
data/spec/ruact/server_functions/query_context_spec.rb +0 -72
data/spec/ruact/server_functions/query_source_spec.rb +0 -193
data/spec/ruact/server_functions/railtie_integration_spec.rb +0 -215
data/spec/ruact/server_functions/rake_spec.rb +0 -86
data/spec/ruact/server_functions/route_source_spec.rb +0 -202
data/spec/ruact/server_functions/snapshot_spec.rb +0 -96
data/spec/ruact/server_functions/snapshot_writer_spec.rb +0 -71
data/spec/ruact/server_rescue_request_spec.rb +0 -416
data/spec/ruact/server_spec.rb +0 -179
data/spec/ruact/server_upload_request_spec.rb +0 -311
data/spec/ruact/signed_references_spec.rb +0 -164
data/spec/ruact/string_distance_spec.rb +0 -38
data/spec/ruact/tasks_json_introspection_spec.rb +0 -141
data/spec/ruact/testing/have_ruact_component_spec.rb +0 -170
data/spec/ruact/testing/no_production_load_spec.rb +0 -41
data/spec/ruact/validation_errors_spec.rb +0 -116
data/spec/ruact/view_helper_spec.rb +0 -131
data/spec/spec_helper.rb +0 -77
data/spec/support/fixtures/pixel.png +0 -0
data/spec/support/flight_wire_parser.rb +0 -21
data/spec/support/flight_wire_parser_spec.rb +0 -93
data/spec/support/matchers/flight_fixture_matcher.rb +0 -130
data/spec/support/matchers/flight_fixture_matcher_spec.rb +0 -250
data/spec/support/rails_stub.rb +0 -115

data/vendor/javascript/vite-plugin-ruact/flight-client.test.mjs ADDED Viewed

@@ -0,0 +1,321 @@
+// Story 17.0a (issue #62) — the Flight client must not collapse arrays.
+//
+// `flight-client.js` was the only runtime module in this package without a unit
+// test, and the defect this file pins is what that gap allowed: `_buildTree`
+// applied a single-element unwrap (`items.length === 1 ? items[0] : items`) to
+// EVERY array it walked. `_buildTree` is a generic value walker with no
+// positional information, so it could not tell a `children` array from a data
+// array sitting in a prop — a list prop holding exactly one row arrived at the
+// client component as the row itself.
+//
+// What this file covers:
+//
+//   1. Data props — 0 / 1 / 2 elements, at top level and nested, arrive with
+//      their arity intact. The n=1 cases are the regression; n=0 and n=2 are
+//      guards that the fix does not over-correct in the other direction.
+//   2. Children — 0 / 1 / 2, asserting the REBUILT content (type, key, nested
+//      children), not just arity, so a rebuild returning nulls cannot pass.
+//      Children keep their arity too: the server collapses a lone TAG-NESTED
+//      child before the wire (`html_converter.rb:188`, Suspense at `:202`), but
+//      an explicit `children={[...]}` prop reaches the client as an array and
+//      now stays one. See the contract note on that describe block.
+//   3. The gem-produced fixture — the same assertion driven by wire bytes the
+//      Ruby serializer wrote, not by a literal typed here.
+//
+// Isolation: `flight-client.js` keeps `pendingChunks` and `lazyCache` as
+// module-level Maps that survive between tests in one process. `lazyCache` is
+// memoized by rowId, so two cases reusing an id would leak into each other.
+// `clearPendingChunks()` in `beforeEach` is what keeps this file order-
+// independent. Vitest is not configured to shuffle, so nothing here depends on
+// that guard today — it is insurance against a case that reuses a row id, and
+// against shuffling being turned on later.
+import { describe, it, expect, beforeEach } from "vitest";
+import fs from "node:fs";
+import path from "node:path";
+import {
+  buildTree,
+  createFromFlightPayload,
+  clearPendingChunks,
+} from "./runtime/flight-client.js";
+// A stand-in client component. Never rendered — these tests assert the props
+// the client BUILDS, which is the contract the component then consumes.
+const TaskList = () => null;
+const PostList = () => null; // the fixture's component — see the last describe
+const MODULE_REGISTRY = {
+  "/TaskList.jsx": { TaskList },
+  "/PostList.jsx": { PostList },
+};
+const EMPTY_ROWS = new Map();
+/** Wire payload: one import row + a root element carrying `props`. */
+function payloadWithProps(props) {
+  return [
+    '1:I["/TaskList.jsx","TaskList"]',
+    `0:["$","$L1",null,${JSON.stringify(props)}]`,
+    "",
+  ].join("\n");
+}
+beforeEach(() => {
+  clearPendingChunks();
+});
+describe("Story 17.0a — data props keep their arity", () => {
+  it("a prop holding ONE item arrives as a one-element array", () => {
+    const tree = createFromFlightPayload(
+      payloadWithProps({ tasks: [{ id: 6, title: "Buy coffee" }] }),
+      MODULE_REGISTRY,
+    );
+    expect(Array.isArray(tree.props.tasks)).toBe(true);
+    expect(tree.props.tasks).toEqual([{ id: 6, title: "Buy coffee" }]);
+  });
+  it("a prop holding TWO items is unchanged", () => {
+    const tree = createFromFlightPayload(
+      payloadWithProps({ tasks: [{ id: 6 }, { id: 7 }] }),
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.tasks).toEqual([{ id: 6 }, { id: 7 }]);
+  });
+  it("a prop holding an EMPTY array stays an empty array", () => {
+    const tree = createFromFlightPayload(
+      payloadWithProps({ tasks: [] }),
+      MODULE_REGISTRY,
+    );
+    expect(Array.isArray(tree.props.tasks)).toBe(true);
+    expect(tree.props.tasks).toEqual([]);
+  });
+  it("a one-element array NESTED inside an object prop keeps its arity", () => {
+    const tree = createFromFlightPayload(
+      payloadWithProps({ page: { rows: [{ id: 6 }], total: 1 } }),
+      MODULE_REGISTRY,
+    );
+    expect(Array.isArray(tree.props.page.rows)).toBe(true);
+    expect(tree.props.page.rows).toEqual([{ id: 6 }]);
+  });
+  it("a one-element array of PRIMITIVES keeps its arity", () => {
+    const tree = createFromFlightPayload(
+      payloadWithProps({ tags: ["$$ruby"] }),
+      MODULE_REGISTRY,
+    );
+    // Decoded, not merely carried: "$$ruby" on the wire is "$ruby" in the prop.
+    expect(tree.props.tags).toEqual(["$ruby"]);
+  });
+  it("the scaffold's own prop shape survives (issue #62 reproduction)", () => {
+    // `<PostList posts={rows} />` with exactly one record. The generated
+    // scaffold gates its table on `sortedRows.length > 0`, so an object here
+    // renders neither the table nor the empty state — a blank list, no error.
+    // The throw needs a specific sequence, because the sort controls live
+    // inside the table that did not render: search (which works, since results
+    // arrive as JSON), sort, then clear the search — that puts the object back
+    // through `[...rows]`.
+    const tree = createFromFlightPayload(
+      payloadWithProps({ posts: [{ id: 1, title: "First post" }] }),
+      MODULE_REGISTRY,
+    );
+    // The component itself, not just its props — a rebuild that resolved the
+    // `$L` reference to a plain "div" would keep every prop assertion green
+    // while never running PostList at all.
+    expect(tree.type).toBe(TaskList);
+    const { posts } = tree.props;
+    expect(Array.isArray(posts)).toBe(true);
+    expect(posts).toHaveLength(1);
+    expect(() => [...posts]).not.toThrow();
+  });
+  it("an array INSIDE an array keeps both dimensions", () => {
+    // `.flat()` in the walker would collapse this and still satisfy every
+    // one-dimensional assertion above.
+    const tree = createFromFlightPayload(
+      payloadWithProps({ grid: [[1, 2], [3]] }),
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.grid).toEqual([[1, 2], [3]]);
+  });
+  it("a ONE-element outer array wrapping an array keeps both levels", () => {
+    // Distinct from the grid case above, whose outer array has two members: a
+    // collapse conditioned on `length === 1 && Array.isArray(items[0])` would
+    // pass that one and corrupt this one.
+    const tree = createFromFlightPayload(
+      payloadWithProps({ matrix: [[1, 2]] }),
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.matrix).toEqual([[1, 2]]);
+  });
+  it("an `undefined` MEMBER is kept — Flight distinguishes it from absence", () => {
+    // `$undefined` is a wire sentinel (project-context §7), so `[undefined]` is
+    // a one-member array, not an empty one. A `.filter(v => v !== undefined)`
+    // in the walker would silently make it empty.
+    const tree = createFromFlightPayload(
+      payloadWithProps({ slots: ["$undefined"] }),
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.slots).toHaveLength(1);
+    expect(tree.props.slots[0]).toBeUndefined();
+  });
+  it("falsy items survive — they are values, not absences", () => {
+    // `.filter(Boolean)` in the walker would drop these and still satisfy
+    // every length assertion that uses truthy items.
+    const tree = createFromFlightPayload(
+      payloadWithProps({ flags: [false, 0, null, "", 1] }),
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.flags).toEqual([false, 0, null, "", 1]);
+  });
+});
+describe("Story 17.0a — children keep their arity too (contract, decided 2026-09-09)", () => {
+  // Decision: arity is preserved for `children` as well as for data props.
+  //
+  // The server collapses a lone child produced by TAG NESTING before the wire
+  // (`html_converter.rb:188`, Suspense at `:202`), so that path is unaffected.
+  // But `children` passed as an EXPLICIT PROP on a self-closing tag —
+  // `<Label children={["hi"]} />` — reaches the wire as an array, and Story
+  // 15.2's loud error does not cover it (`erb_preprocessor.rb:174` exempts
+  // self-closing tags). Before this story the client collapsed that to `"hi"`.
+  // It no longer does: you passed an array, you get an array.
+  //
+  // Taken deliberately while the library has no external adopters — the only
+  // moment where making the contract consistent costs nothing.
+  it("a single child NESTED IN A TAG arrives collapsed, because the server collapsed it", () => {
+    const tree = buildTree(
+      ["$", "div", null, { children: ["$", "em", null, { children: "hi" }] }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    // Not an array: the server sent the element itself, and it rebuilds as one.
+    expect(Array.isArray(tree.props.children)).toBe(false);
+    expect(tree.props.children.type).toBe("em");
+    expect(tree.props.children.props.children).toBe("hi");
+  });
+  it("a single TEXT child nested in a tag arrives as the string", () => {
+    const tree = buildTree(
+      ["$", "div", null, { children: "hi" }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.children).toBe("hi");
+  });
+  it("multiple children arrive as an array, each one rebuilt", () => {
+    const tree = buildTree(
+      ["$", "ul", null, {
+        children: [
+          ["$", "li", "a", { children: "one" }],
+          ["$", "li", "b", { children: "two" }],
+        ],
+      }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    const kids = tree.props.children;
+    expect(Array.isArray(kids)).toBe(true);
+    expect(kids).toHaveLength(2);
+    // Content, not just arity — a rebuild that returned nulls would pass a
+    // length check and fail this one.
+    expect(kids.map((k) => k.type)).toEqual(["li", "li"]);
+    expect(kids.map((k) => k.key)).toEqual(["a", "b"]);
+    expect(kids.map((k) => k.props.children)).toEqual(["one", "two"]);
+  });
+  it("an EXPLICIT one-element children prop stays a one-element array", () => {
+    // The contract change. `<Label children={["hi"]} />` — verified against the
+    // Ruby pipeline to reach the wire as `{"children":["hi"]}`.
+    const tree = buildTree(
+      ["$", "span", null, { children: ["hi"] }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    expect(tree.props.children).toEqual(["hi"]);
+  });
+  it("a one-element children array of ELEMENTS stays an array, rebuilt", () => {
+    const tree = buildTree(
+      ["$", "ul", null, { children: [["$", "li", "only", { children: "just one" }]] }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    const kids = tree.props.children;
+    expect(Array.isArray(kids)).toBe(true);
+    expect(kids).toHaveLength(1);
+    expect(kids[0].type).toBe("li");
+    expect(kids[0].key).toBe("only");
+    expect(kids[0].props.children).toBe("just one");
+  });
+  it("an EMPTY children array stays an empty array", () => {
+    // AC3's n=0 for children. Distinct from "no children prop at all" below:
+    // this one is present and empty, and must not become visible content.
+    const tree = buildTree(
+      ["$", "ul", null, { children: [] }],
+      EMPTY_ROWS,
+      MODULE_REGISTRY,
+    );
+    expect(Array.isArray(tree.props.children)).toBe(true);
+    expect(tree.props.children).toHaveLength(0);
+  });
+  it("an element with no children prop has none after rebuilding", () => {
+    const tree = buildTree(["$", "br", null, {}], EMPTY_ROWS, MODULE_REGISTRY);
+    expect("children" in tree.props).toBe(false);
+  });
+});
+describe("Story 17.0a — the contract, driven by a gem-produced fixture", () => {
+  // The bytes were written by the Ruby serializer, not typed here.
+  //
+  // The two sides guarantee DIFFERENT things, and neither reddens for the
+  // other: `spec/ruact/flight/serializer_spec.rb` ("single-element array prop
+  // survives the wire (Story 17.0a)") asserts that what the serializer emits
+  // still equals this file, so a server-side change reddens THERE; this test
+  // asserts that these bytes rebuild into a one-element array, so a client-side
+  // change reddens HERE. What the pair buys is that the client is exercised
+  // against real server output rather than a literal someone typed — the
+  // Story 5.2 pattern. It does not buy simultaneous failure.
+  const FIXTURE = path.join(
+    import.meta.dirname,
+    "../../../spec/fixtures/flight/single_element_array_prop.txt",
+  );
+  it("the fixture the gem wrote rebuilds as a one-element array", () => {
+    const payload = fs.readFileSync(FIXTURE, "utf8");
+    const tree = createFromFlightPayload(payload, MODULE_REGISTRY);
+    expect(tree.type).toBe(PostList);
+    expect(Array.isArray(tree.props.posts)).toBe(true);
+    // The title is "$$5 plan" ON THE WIRE (§7 prepends one "$"). Asserting the
+    // DECODED value means a walker that preserved arity but stopped rebuilding
+    // scalar members would fail here rather than pass.
+    expect(tree.props.posts).toEqual([{ id: 1, title: "$5 plan" }]);
+  });
+});

data/vendor/javascript/vite-plugin-ruact/package-lock.json CHANGED Viewed

@@ -9,6 +9,7 @@
       "version": "0.0.0-bundled",
       "license": "MIT",
       "devDependencies": {
+        "react": "^19.2.8",
         "typescript": "^5.5.0",
         "vitest": "^2.0.0"
       }
@@ -1133,6 +1134,16 @@
         "node": "^10 || ^12 || >=14"
       }
     },
+    "node_modules/react": {
+      "version": "19.2.8",
+      "resolved": "https://registry.npmjs.org/react/-/react-19.2.8.tgz",
+      "integrity": "sha512-PWaYA1L/q9u2u7xYQi+Y3L3Yfnie7XyLeaJICV1MGD6LprsBxcAqGjYyr0eY3p+QdsA+x/Irkt4Qif8D63+Sbw==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/rollup": {
       "version": "4.60.3",
       "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.3.tgz",

data/vendor/javascript/vite-plugin-ruact/package.json CHANGED Viewed

@@ -9,6 +9,7 @@
     "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.scaffold.json && tsc --noEmit -p tsconfig.scaffold-agnostic.json"
   },
   "devDependencies": {
+    "react": "^19.2.8",
     "typescript": "^5.5.0",
     "vitest": "^2.0.0"
   },