lawspec 0.8.0 → 0.10.0

package/native-examples.mjs

@@ -0,0 +1,81 @@
+import {readFile, readdir, mkdir} from 'node:fs/promises';
+import path from 'node:path';
+import {templates, commands, setup} from './templates.mjs';
+import {safePath, planWrites, applyWrites} from './files.mjs';
+
+async function projectFiles(directory, prefix = '') {
+  const files = {};
+  for (const entry of await readdir(directory, {withFileTypes: true})) {
+    const name = prefix + entry.name;
+    const location = new URL(entry.name + (entry.isDirectory() ? '/' : ''), directory);
+    if (entry.isDirectory()) Object.assign(files, await projectFiles(location, name + '/'));
+    else if (entry.isFile()) files[name] = await readFile(location, 'utf8');
+    else throw new Error(`Unsupported bundled example entry: ${name}`);
+  }
+  return files;
+}
+
+export async function exportNativePayments(options, selected) {
+  const root = await safePath(process.cwd(), options.output || 'native_payments');
+  await mkdir(root, {recursive: true});
+  const law = await readFile(new URL('./examples/specs/payments.lawspec', import.meta.url), 'utf8');
+  const plans = [];
+  const results = [];
+  for (const target of selected) {
+    const directory = await safePath(root, target);
+    await mkdir(directory, {recursive: true});
+    const files = {
+      ...templates(target, {minify: options.minify === true}),
+      ...await projectFiles(new URL(`./examples/native-payments/${target}/`, import.meta.url)),
+      'laws/payments.lawspec': law,
+    };
+    const config = JSON.parse(files['lawspec.json']);
+    config.machineBits = options.machineBits ?? 64;
+    files['lawspec.json'] = JSON.stringify(config, null, options.minify ? undefined : 2) + '\n';
+    files['README.md'] = `# Native payments: ${target}
+
+This project checks application-owned payment types against the shared LawSpec
+model. Money maps to Price, currency variants have application names, and the
+archive preserves distinct present and absent payments.
+
+## Run
+
+Install LawSpec and the native dependencies described below, then run:
+
+\`\`\`sh
+lawspec check
+lawspec generate
+${commands[target]}
+\`\`\`
+
+${setup[target]}
+
+JavaScript and TypeScript projects require \`npm install\` before testing.
+The specification includes exact decimal arithmetic and explicit USD/GBP examples.
+The native price generator deliberately samples only EUR values between 1.00 and
+2.00; examples and deterministic boundaries still check the other cases. Its
+framework's mapping operation preserves the native shrinker.
+
+The application types use native exact decimals where available and LawSpec's
+framework-independent numeric runtime otherwise. Run generation before compiling
+the application so that runtime support is present.
+
+## Change the application
+
+Edit the domain implementation or generator, then run the native tests again.
+For example, change the fee from 0.2 to 0.3: the exact-decimal law must fail.
+Edit \`lawspec.json\` to change native bindings and rerun \`lawspec generate\`.
+
+All exported project files are user-owned. Re-exporting preserves your edits;
+it reports changed bundled versions for review. Compiler-generated files use a
+separate ownership manifest and remain protected against accidental overwrites.
+`;
+    const artifacts = Object.entries(files).map(([path, content]) => ({path, content, ownership: 'user'}));
+    const plan = await planWrites(directory, artifacts, {manifest: '.lawspec/example.json'});
+    plans.push(plan);
+    results.push({target, directory, example: 'payments', files: artifacts.map(({path, ownership}) => ({path, ownership})),
+      changes: plan.changes.length, preservedAdapters: plan.preserved, adapterUpdates: plan.adapterUpdates});
+  }
+  await applyWrites(plans);
+  return results;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lawspec",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "State the law once. Check it everywhere.",
   "license": "MIT",
   "type": "module",
@@ -8,6 +8,6 @@
   "bin": { "lawspec": "bin/lawspec.mjs" },
   "exports": { ".": { "types": "./index.d.ts", "import": "./api.mjs" } },
   "types": "index.d.ts",
-  "files": ["*.mjs", "*.json", "index.d.ts", "bin", "core.wasm", "core_jsffi.js", "README.md", "PRIMITIVES.md", "REFINEMENTS.md", "RUST.md", "LANGUAGE.md", "API-MIGRATION.md", "LICENSE", "starter.lawspec", "examples"],
+  "files": ["*.mjs", "*.json", "index.d.ts", "bin", "core.wasm", "core_jsffi.js", "README.md", "NATIVE-BINDINGS.md", "PRIMITIVES.md", "REFINEMENTS.md", "RUST.md", "JAVA.md", "PYTHON.md", "GO.md", "HASKELL.md", "KOTLIN.md", "WEB.md", "LANGUAGE.md", "API-MIGRATION.md", "RELEASE-0.9.md", "RELEASE-0.10.md", "LICENSE", "starter.lawspec", "examples"],
   "scripts": { "test": "node --test test/*.test.mjs" }
 }

package/templates.mjs

@@ -34,8 +34,97 @@ export const setup = {
   kotlin:
     "Use JDK 25, Gradle 9.3.0, Kotlin plugin 2.3.21, JVM target 25, Kotest 5.9.1 (runner, assertions, property), and useJUnitPlatform(). Run gradle testClasses.",
 };
-const json = (value) => JSON.stringify(value, null, 2) + "\n";
-export function templates(target) {
+// These render known scaffold structure; they never reformat user source.
+const element = (name, value, attributes = {}) => ({ name, value, attributes });
+const xmlEscape = (text) =>
+  String(text)
+    .replaceAll("&", "&")
+    .replaceAll('"', """)
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;");
+function renderXml(node, minify, depth = 0) {
+  const indent = minify ? "" : "  ".repeat(depth);
+  const attributes = Object.entries(node.attributes).map(
+    ([key, value]) => `${key}="${xmlEscape(value)}"`,
+  );
+  const open = `<${node.name}${
+    attributes.length === 0
+      ? ""
+      : minify
+        ? " " + attributes.join(" ")
+        : "\n" + attributes.map((a) => indent + "  " + a).join("\n")
+  }>`;
+  if (!Array.isArray(node.value)) {
+    return `${indent}${open}${xmlEscape(node.value)}</${node.name}>`;
+  }
+  const children = node.value.map((child) =>
+    renderXml(child, minify, depth + 1),
+  );
+  return minify
+    ? `${open}${children.join("")}</${node.name}>`
+    : `${indent}${open}\n${children.join("\n")}\n${indent}</${node.name}>`;
+}
+function mavenProject(minify) {
+  const fields = (values) =>
+    Object.entries(values).map(([name, value]) => element(name, value));
+  const dependency = (groupId, artifactId, version) =>
+    element(
+      "dependency",
+      fields({ groupId, artifactId, version, scope: "test" }),
+    );
+  const plugin = (artifactId, version) =>
+    element(
+      "plugin",
+      fields({ groupId: "org.apache.maven.plugins", artifactId, version }),
+    );
+  return (
+    renderXml(
+      element(
+        "project",
+        [
+          ...fields({
+            modelVersion: "4.0.0",
+            groupId: "example",
+            artifactId: "lawspec-example",
+            version: "0.1.0",
+          }),
+          element(
+            "properties",
+            fields({
+              "maven.compiler.release": "25",
+              "project.build.sourceEncoding": "UTF-8",
+            }),
+          ),
+          element("dependencies", [
+            dependency("org.jetbrains", "jetCheck", "0.3.0"),
+            dependency("org.junit.jupiter", "junit-jupiter", "5.14.0"),
+          ]),
+          element("build", [
+            element("plugins", [
+              plugin("maven-compiler-plugin", "3.14.1"),
+              plugin("maven-surefire-plugin", "3.5.4"),
+            ]),
+          ]),
+        ],
+        {
+          xmlns: "http://maven.apache.org/POM/4.0.0",
+          "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
+          "xsi:schemaLocation":
+            "http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd",
+        },
+      ),
+      minify,
+    ) + "\n"
+  );
+}
+export function templates(target, { minify = false } = {}) {
+  if (typeof minify !== "boolean") throw new Error("minify must be a boolean");
+  const json = (value) =>
+    JSON.stringify(value, null, minify ? undefined : 2) + "\n";
+  const kotlinBlock = (name, statements) =>
+    minify
+      ? `${name} { ${statements.join("; ")} }`
+      : `${name} {\n${statements.map((line) => "    " + line).join("\n")}\n}`;
   if (!targets.includes(target)) throw new Error(`Unknown target: ${target}`);
   const commonPackage = {
     name: "lawspec-example",
@@ -46,7 +135,8 @@ export function templates(target) {
   switch (target) {
     case "rust":
       return {
-        "src/lib.rs": '// Application library. LawSpec maintains the included module declarations.\ninclude!("lawspec_modules.rs");\n',
+        "src/lib.rs":
+          '// Application library. LawSpec maintains the included module declarations.\ninclude!("lawspec_modules.rs");\n',
         "Cargo.toml": `[package]
 name = "lawspec-example"
 version = "0.1.0"
@@ -103,18 +193,7 @@ proptest = "=1.11.0"
       };
     case "java":
       return {
-        "pom.xml": `<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <modelVersion>4.0.0</modelVersion><groupId>example</groupId><artifactId>lawspec-example</artifactId><version>0.1.0</version>
-  <properties><maven.compiler.release>25</maven.compiler.release><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties>
-  <dependencies>
-    <dependency><groupId>org.jetbrains</groupId><artifactId>jetCheck</artifactId><version>0.3.0</version><scope>test</scope></dependency>
-    <dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter</artifactId><version>5.14.0</version><scope>test</scope></dependency>
-  </dependencies>
-  <build><plugins>
-    <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.14.1</version></plugin>
-    <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>3.5.4</version></plugin>
-  </plugins></build>
-</project>\n`,
+        "pom.xml": mavenProject(minify),
       };
     case "go":
       return {
@@ -124,13 +203,24 @@ proptest = "=1.11.0"
     case "haskell":
       return {
         "stack.yaml": "snapshot: lts-24.58\npackages: [.]\n",
-        "package.yaml": `name: lawspec-example\nversion: 0.1.0\ndependencies: [base, text, bytestring]\nlibrary:\n  source-dirs: src\ntests:\n  laws:\n    main: Spec.hs\n    source-dirs: test\n    dependencies: [lawspec-example, hspec, hedgehog, hspec-hedgehog]\n    build-tools: [hspec-discover]\n`,
+        "package.yaml": `name: lawspec-example\nversion: 0.1.0\ndependencies: [base, text, bytestring]\nlibrary:\n  source-dirs: src\ntests:\n  laws:\n    main: Spec.hs\n    source-dirs: test\n    dependencies: [lawspec-example, hspec, hedgehog, hspec-hedgehog, containers, mtl]\n    build-tools: [hspec-discover]\n`,
         "test/Spec.hs": "{-# OPTIONS_GHC -F -pgmF hspec-discover #-}\n",
       };
     case "kotlin":
       return {
         "settings.gradle.kts": 'rootProject.name = "lawspec-example"\n',
-        "build.gradle.kts": `plugins { kotlin("jvm") version "2.3.21" }\nrepositories { mavenCentral() }\nkotlin { jvmToolchain(25) }\ndependencies {\n  testImplementation("io.kotest:kotest-runner-junit5:5.9.1")\n  testImplementation("io.kotest:kotest-assertions-core:5.9.1")\n  testImplementation("io.kotest:kotest-property:5.9.1")\n}\ntasks.test { useJUnitPlatform() }\n`,
+        "build.gradle.kts":
+          [
+            kotlinBlock("plugins", ['kotlin("jvm") version "2.3.21"']),
+            kotlinBlock("repositories", ["mavenCentral()"]),
+            kotlinBlock("kotlin", ["jvmToolchain(25)"]),
+            kotlinBlock("dependencies", [
+              'testImplementation("io.kotest:kotest-runner-junit5:5.9.1")',
+              'testImplementation("io.kotest:kotest-assertions-core:5.9.1")',
+              'testImplementation("io.kotest:kotest-property:5.9.1")',
+            ]),
+            kotlinBlock("tasks.test", ["useJUnitPlatform()"]),
+          ].join(minify ? "\n" : "\n\n") + "\n",
       };
   }
 }