@freestyle-sh/with-ruby 0.1.0

package/README.md

@@ -0,0 +1,64 @@
+# @freestyle-sh/with-ruby
+
+Ruby runtime via [RVM](https://rvm.io) for [Freestyle](https://freestyle.sh) VMs.
+
+## Installation
+
+```bash
+npm install @freestyle-sh/with-ruby freestyle-sandboxes
+```
+
+## Usage
+
+```typescript
+import { freestyle } from "freestyle-sandboxes";
+import { VmRuby } from "@freestyle-sh/with-ruby";
+
+const { vm } = await freestyle.vms.create({
+  with: {
+    ruby: new VmRuby(),
+  },
+});
+
+const res = await vm.ruby.runCode(
+  "require 'json'; puts JSON.generate({ hello: 'world' })"
+);
+
+console.log(res);
+// { result: { hello: 'world' }, stdout: '{"hello":"world"}\n', statusCode: 0 }
+```
+
+## Options
+
+```typescript
+new VmRuby({
+  version: "3.3.6", // Optional: specific Ruby version (default: "3.4.8")
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `version` | `string` | `"3.4.8"` | Ruby version to install via RVM. |
+
+## API
+
+### `vm.ruby.runCode(code: string)`
+
+Executes Ruby code in the RVM-managed Ruby runtime.
+
+**Returns:** `Promise<RunCodeResponse>`
+
+```typescript
+type RunCodeResponse<Result> = {
+  result: Result;      // Parsed JSON from stdout (if valid JSON)
+  stdout?: string;     // Raw stdout output
+  stderr?: string;     // Raw stderr output
+  statusCode?: number; // Exit code
+};
+```
+
+## Documentation
+
+- [Freestyle Documentation](https://docs.freestyle.sh)
+- [Ruby Documentation](https://www.ruby-lang.org/en/documentation/)
+- [RVM Documentation](https://rvm.io)

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { VmWith, VmWithInstance, CreateVmOptions } from 'freestyle-sandboxes';
+import { VmRunCodeInstance, JSONValue, RunCodeResponse, VmRunCode } from '@freestyle-sh/with-type-run-code';
+
+type RubyOptions = {
+    version?: string;
+};
+type RubyResolvedOptions = {
+    version: string;
+};
+declare class VmRuby extends VmWith<RubyRuntimeInstance> implements VmRunCode<VmRunCodeInstance> {
+    options: RubyResolvedOptions;
+    constructor(options?: RubyOptions);
+    configure(existingConfig: CreateVmOptions): CreateVmOptions | Promise<CreateVmOptions>;
+    createInstance(): RubyRuntimeInstance;
+    installServiceName(): string;
+}
+declare class RubyRuntimeInstance extends VmWithInstance implements VmRunCodeInstance {
+    builder: VmRuby;
+    constructor(builder: VmRuby);
+    runCode<Result extends JSONValue = any>(code: string): Promise<RunCodeResponse<Result>>;
+}
+
+export { VmRuby };

package/dist/index.js

@@ -0,0 +1,76 @@
+import { VmWith, VmTemplate, VmWithInstance } from 'freestyle-sandboxes';
+
+class VmRuby extends VmWith {
+  options;
+  constructor(options) {
+    super();
+    this.options = {
+      version: options?.version ?? "3.4.8"
+    };
+  }
+  configure(existingConfig) {
+    const installScript = `#!/bin/bash
+set -e
+curl -sSL https://get.rvm.io | bash -s -- head
+source /etc/profile.d/rvm.sh
+rvm install ${this.options.version}
+rvm use ${this.options.version} --default
+ruby --version
+`;
+    const rubyConfig = {
+      template: new VmTemplate({
+        aptDeps: ["curl", "gnupg2", "ca-certificates"],
+        additionalFiles: {
+          "/opt/install-ruby.sh": {
+            content: installScript
+          }
+        },
+        systemd: {
+          services: [
+            {
+              name: "install-ruby",
+              mode: "oneshot",
+              deleteAfterSuccess: true,
+              exec: ["bash /opt/install-ruby.sh"],
+              timeoutSec: 300
+            }
+          ]
+        }
+      })
+    };
+    return this.compose(existingConfig, rubyConfig);
+  }
+  createInstance() {
+    return new RubyRuntimeInstance(this);
+  }
+  installServiceName() {
+    return "install-ruby.service";
+  }
+}
+class RubyRuntimeInstance extends VmWithInstance {
+  builder;
+  constructor(builder) {
+    super();
+    this.builder = builder;
+  }
+  async runCode(code) {
+    const result = await this.vm.exec({
+      command: `/usr/local/rvm/rubies/ruby-${this.builder.options.version}/bin/ruby -e "${code.replace(/"/g, '\\"')}"`
+    });
+    let parsedResult = void 0;
+    if (result.stdout) {
+      try {
+        parsedResult = JSON.parse(result.stdout);
+      } catch (e) {
+      }
+    }
+    return {
+      result: parsedResult,
+      stdout: result.stdout ?? void 0,
+      stderr: result.stderr ?? void 0,
+      statusCode: result.statusCode ?? -1
+    };
+  }
+}
+
+export { VmRuby };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@freestyle-sh/with-ruby",
+  "version": "0.1.0",
+  "private": false,
+  "dependencies": {
+    "freestyle-sandboxes": "^0.1.2",
+    "@freestyle-sh/with-type-run-code": "^0.1.0"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "source": "./src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll"
+  }
+}