@freestyle-sh/with-ruby 0.2.0 → 0.2.1

package/README.md

@@ -57,6 +57,33 @@ type RunCodeResponse<Result> = {
 };
 ```
 
+### `vm.ruby.install(options?)`
+
+Installs gems via `gem install` or `bundle install`.
+
+**Returns:** `Promise<InstallResult>`
+
+```typescript
+// Install specific gems
+await vm.ruby.install({ deps: ["nokogiri", "colorize"] });
+
+// Install from Gemfile (bundle install)
+await vm.ruby.install();
+await vm.ruby.install({ directory: "/app" });
+```
+
+```typescript
+type InstallOptions =
+  | { deps: string[] }
+  | { directory?: string; deps?: undefined };
+
+type InstallResult = {
+  success: boolean;
+  stdout?: string;
+  stderr?: string;
+};
+```
+
 ## Documentation
 
 - [Freestyle Documentation](https://docs.freestyle.sh)

package/dist/index.d.ts

@@ -1,6 +1,17 @@
-import { VmWith, VmWithInstance, CreateVmOptions } from 'freestyle-sandboxes';
+import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
 import { VmRunCodeInstance, JSONValue, RunCodeResponse, VmRunCode } from '@freestyle-sh/with-type-run-code';
 
+type InstallResult = {
+    success: boolean;
+    stdout?: string;
+    stderr?: string;
+};
+type InstallOptions = {
+    deps: string[];
+} | {
+    directory?: string;
+    deps?: undefined;
+};
 type RubyOptions = {
     version?: string;
 };
@@ -10,16 +21,18 @@ type RubyResolvedOptions = {
 declare class VmRuby extends VmWith<RubyRuntimeInstance> implements VmRunCode<VmRunCodeInstance> {
     options: RubyResolvedOptions;
     constructor(options?: RubyOptions);
-    configure(existingConfig: CreateVmOptions): CreateVmOptions | Promise<CreateVmOptions>;
+    configureSnapshotSpec(spec: VmSpec): VmSpec;
     createInstance(): RubyRuntimeInstance;
     installServiceName(): string;
 }
 declare class RubyRuntimeInstance extends VmWithInstance implements VmRunCodeInstance {
     builder: VmRuby;
     constructor(builder: VmRuby);
-    runCode<Result extends JSONValue = any>({ code, }: {
+    runCode<Result extends JSONValue = any>(args: string | {
         code: string;
     }): Promise<RunCodeResponse<Result>>;
+    install(options?: InstallOptions): Promise<InstallResult>;
 }
 
 export { VmRuby };
+export type { InstallOptions, InstallResult };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { VmWith, VmTemplate, VmWithInstance } from 'freestyle-sandboxes';
+import { VmWith, VmSpec, VmWithInstance } from 'freestyle-sandboxes';
 
 class VmRuby extends VmWith {
   options;
@@ -8,7 +8,7 @@ class VmRuby extends VmWith {
       version: options?.version ?? "3.4.8"
     };
   }
-  configure(existingConfig) {
+  configureSnapshotSpec(spec) {
     const installScript = `#!/bin/bash
 set -e
 curl -sSL https://get.rvm.io | bash -s -- head
@@ -17,8 +17,9 @@ rvm install ${this.options.version}
 rvm use ${this.options.version} --default
 ruby --version
 `;
-    const rubyConfig = {
-      template: new VmTemplate({
+    return this.composeSpecs(
+      spec,
+      new VmSpec({
         aptDeps: ["curl", "gnupg2", "ca-certificates"],
         additionalFiles: {
           "/opt/install-ruby.sh": {
@@ -37,8 +38,7 @@ ruby --version
           ]
         }
       })
-    };
-    return this.compose(existingConfig, rubyConfig);
+    );
   }
   createInstance() {
     return new RubyRuntimeInstance(this);
@@ -53,9 +53,8 @@ class RubyRuntimeInstance extends VmWithInstance {
     super();
     this.builder = builder;
   }
-  async runCode({
-    code
-  }) {
+  async runCode(args) {
+    const code = typeof args === "string" ? args : args.code;
     const result = await this.vm.exec({
       command: `/usr/local/rvm/rubies/ruby-${this.builder.options.version}/bin/ruby -e "${code.replace(/"/g, '\\"')}"`
     });
@@ -73,6 +72,22 @@ class RubyRuntimeInstance extends VmWithInstance {
       statusCode: result.statusCode ?? -1
     };
   }
+  async install(options) {
+    const gemPath = `/usr/local/rvm/rubies/ruby-${this.builder.options.version}/bin/gem`;
+    let command;
+    if (!options?.deps) {
+      const cdPrefix = options?.directory ? `cd ${options.directory} && ` : "";
+      command = `${cdPrefix}bundle install`;
+    } else {
+      command = `${gemPath} install ${options.deps.join(" ")}`;
+    }
+    const result = await this.vm.exec({ command });
+    return {
+      success: result.statusCode === 0,
+      stdout: result.stdout ?? void 0,
+      stderr: result.stderr ?? void 0
+    };
+  }
 }
 
 export { VmRuby };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@freestyle-sh/with-ruby",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "dependencies": {
-    "freestyle-sandboxes": "^0.1.2",
-    "@freestyle-sh/with-type-run-code": "^0.2.0"
+    "freestyle-sandboxes": "^0.1.8",
+    "@freestyle-sh/with-type-run-code": "^0.2.1"
   },
   "type": "module",
   "main": "./dist/index.js",