@backstage/plugin-scaffolder-backend-module-rails 0.5.1-next.0 → 0.5.1-next.2

package/dist/index.cjs.js

@@ -2,718 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var errors = require('@backstage/errors');
-var fs = require('fs-extra');
-var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
-var path = require('path');
-var commandExists = require('command-exists');
-var stream = require('stream');
-var yaml = require('yaml');
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha = require('@backstage/plugin-scaffolder-node/alpha');
-var integration = require('@backstage/integration');
+var index = require('./actions/fetch/rails/index.cjs.js');
+var module$1 = require('./module.cjs.js');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var path__default = /*#__PURE__*/_interopDefaultCompat(path);
-var commandExists__default = /*#__PURE__*/_interopDefaultCompat(commandExists);
-var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 
-var Webpacker = /* @__PURE__ */ ((Webpacker2) => {
-  Webpacker2["react"] = "react";
-  Webpacker2["vue"] = "vue";
-  Webpacker2["angular"] = "angular";
-  Webpacker2["elm"] = "elm";
-  Webpacker2["stimulus"] = "stimulus";
-  return Webpacker2;
-})(Webpacker || {});
-var Database = /* @__PURE__ */ ((Database2) => {
-  Database2["mysql"] = "mysql";
-  Database2["postgresql"] = "postgresql";
-  Database2["sqlite3"] = "sqlite3";
-  Database2["oracle"] = "oracle";
-  Database2["sqlserver"] = "sqlserver";
-  Database2["jdbcmysql"] = "jdbcmysql";
-  Database2["jdbcsqlite3"] = "jdbcsqlite3";
-  Database2["jdbcpostgresql"] = "jdbcpostgresql";
-  Database2["jdbc"] = "jdbc";
-  return Database2;
-})(Database || {});
-var RailsVersion = /* @__PURE__ */ ((RailsVersion2) => {
-  RailsVersion2["dev"] = "dev";
-  RailsVersion2["edge"] = "edge";
-  RailsVersion2["master"] = "master";
-  RailsVersion2["fromImage"] = "fromImage";
-  return RailsVersion2;
-})(RailsVersion || {});
-const railsArgumentResolver = (projectRoot, options, executionOnContainer = false) => {
-  const argumentsToRun = [];
-  if (options?.minimal) {
-    argumentsToRun.push("--minimal");
-  }
-  if (options?.api) {
-    argumentsToRun.push("--api");
-  }
-  if (options?.skipBundle) {
-    argumentsToRun.push("--skip-bundle");
-  }
-  if (options?.skipWebpackInstall) {
-    argumentsToRun.push("--skip-webpack-install");
-  }
-  if (options?.skipActiveRecord) {
-    argumentsToRun.push("--skip-active-record");
-  }
-  if (options?.skipTest) {
-    argumentsToRun.push("--skip-test");
-  }
-  if (options?.skipActionCable) {
-    argumentsToRun.push("--skip-action-cable");
-  }
-  if (options?.skipActionMailer) {
-    argumentsToRun.push("--skip-action-mailer");
-  }
-  if (options?.skipActionMailbox) {
-    argumentsToRun.push("--skip-action-mailbox");
-  }
-  if (options?.skipActiveStorage) {
-    argumentsToRun.push("--skip-active-storage");
-  }
-  if (options?.skipActionText) {
-    argumentsToRun.push("--skip-action-text");
-  }
-  if (options?.force) {
-    argumentsToRun.push("--force");
-  }
-  if (options?.webpacker && Object.values(Webpacker).includes(options?.webpacker)) {
-    argumentsToRun.push("--webpack");
-    argumentsToRun.push(options.webpacker);
-  }
-  if (options?.database && Object.values(Database).includes(options?.database)) {
-    argumentsToRun.push("--database");
-    argumentsToRun.push(options.database);
-  }
-  if (options?.railsVersion !== "fromImage" /* fromImage */ && Object.values(RailsVersion).includes(options?.railsVersion)) {
-    argumentsToRun.push(`--${options.railsVersion}`);
-  }
-  if (options?.template) {
-    argumentsToRun.push("--template");
-    argumentsToRun.push(
-      options.template.replace(
-        `.${path.sep}`,
-        `${projectRoot}${executionOnContainer ? "/" : path.sep}`
-      )
-    );
-  }
-  return argumentsToRun;
-};
-
-class RailsNewRunner {
-  containerRunner;
-  constructor({ containerRunner }) {
-    this.containerRunner = containerRunner;
-  }
-  async run({
-    workspacePath,
-    values,
-    logStream
-  }) {
-    const intermediateDir = path__default.default.join(workspacePath, "intermediate");
-    await fs__default.default.ensureDir(intermediateDir);
-    const resultDir = path__default.default.join(workspacePath, "result");
-    const { name, imageName, railsArguments } = values;
-    const mountDirs = {
-      [workspacePath]: "/input",
-      [intermediateDir]: "/output"
-    };
-    const baseCommand = "rails";
-    const baseArguments = ["new"];
-    const commandExistsToRun = await commandExists__default.default(baseCommand);
-    if (commandExistsToRun) {
-      const arrayExtraArguments = railsArgumentResolver(
-        workspacePath,
-        railsArguments
-      );
-      await pluginScaffolderNode.executeShellCommand({
-        command: baseCommand,
-        args: [
-          ...baseArguments,
-          `${intermediateDir}${path__default.default.sep}${name}`,
-          ...arrayExtraArguments
-        ],
-        logStream
-      });
-    } else {
-      if (!imageName) {
-        throw new Error("No imageName provided");
-      }
-      if (!this.containerRunner) {
-        throw new Error(
-          "Command is not available and no container runner provided"
-        );
-      }
-      const arrayExtraArguments = railsArgumentResolver(
-        "/input",
-        railsArguments,
-        true
-      );
-      await this.containerRunner.runContainer({
-        imageName,
-        command: baseCommand,
-        args: [...baseArguments, `/output/${name}`, ...arrayExtraArguments],
-        mountDirs,
-        workingDir: "/input",
-        // Set the home directory inside the container as something that applications can
-        // write to, otherwise they will just fail trying to write to /
-        envVars: { HOME: "/tmp" },
-        logStream
-      });
-    }
-    const [generated] = await fs__default.default.readdir(intermediateDir);
-    if (generated === void 0) {
-      throw new Error(`No data generated by ${baseCommand}`);
-    }
-    await fs__default.default.move(path__default.default.join(intermediateDir, generated), resultDir);
-  }
-}
-
-const examples = [
-  {
-    description: "Fetch and template a minimal Rails app",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: true,
-                skipBundle: true,
-                skipWebpackInstall: true,
-                skipTest: true,
-                skipActionCable: true,
-                skipActionMailer: true,
-                skipActionMailbox: true,
-                skipActiveStorage: true,
-                skipActionText: true,
-                skipActiveRecord: true,
-                force: true,
-                api: true,
-                webpacker: "react",
-                database: "postgresql",
-                railsVersion: "dev"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with custom options",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            targetPath: "custom-path",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: false,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: false,
-                api: false,
-                webpacker: "vue",
-                database: "mysql",
-                railsVersion: "edge"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with Docker image",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: true,
-                skipBundle: true,
-                skipWebpackInstall: true,
-                skipTest: true,
-                skipActionCable: true,
-                skipActionMailer: true,
-                skipActionMailbox: true,
-                skipActiveStorage: true,
-                skipActionText: true,
-                skipActiveRecord: true,
-                force: true,
-                api: true,
-                webpacker: "react",
-                database: "postgresql",
-                railsVersion: "dev"
-              },
-              imageName: "custom/rails-image"
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with different database and action mailer settings",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: true,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: true,
-                api: true,
-                webpacker: "angular",
-                database: "sqlite3",
-                railsVersion: "master"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with full options including action mailer and active storage",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: false,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: false,
-                api: false,
-                webpacker: "stimulus",
-                database: "postgresql",
-                railsVersion: "fromImage"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with API-only stack and custom template path",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: true,
-                skipWebpackInstall: true,
-                skipTest: true,
-                skipActionCable: true,
-                skipActionMailer: true,
-                skipActionMailbox: true,
-                skipActiveStorage: true,
-                skipActionText: true,
-                skipActiveRecord: true,
-                force: true,
-                api: true,
-                webpacker: "elm",
-                database: "mysql",
-                railsVersion: "dev",
-                template: "path/to/custom/template"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with custom Webpack setup",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: false,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: false,
-                api: false,
-                webpacker: "angular",
-                database: "postgresql",
-                railsVersion: "dev"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with specific Rails version and Action Mailer enabled",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: false,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: true,
-                api: true,
-                webpacker: "react",
-                database: "sqlite3",
-                railsVersion: "master"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with specific database and Active Storage enabled",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: false,
-                skipWebpackInstall: false,
-                skipTest: false,
-                skipActionCable: false,
-                skipActionMailer: false,
-                skipActionMailbox: false,
-                skipActiveStorage: false,
-                skipActionText: false,
-                skipActiveRecord: false,
-                force: true,
-                api: true,
-                webpacker: "vue",
-                database: "postgresql",
-                railsVersion: "fromImage"
-              }
-            }
-          }
-        }
-      ]
-    })
-  },
-  {
-    description: "Fetch and template a Rails app with full options including database and skip options",
-    example: yaml__default.default.stringify({
-      steps: [
-        {
-          id: "fetchTemplate",
-          action: "fetch:rails",
-          name: "Fetch and Template Rails App",
-          input: {
-            url: "https://github.com/backstage/backstage",
-            values: {
-              railsArguments: {
-                minimal: false,
-                skipBundle: true,
-                skipWebpackInstall: true,
-                skipTest: true,
-                skipActionCable: true,
-                skipActionMailer: true,
-                skipActionMailbox: true,
-                skipActiveStorage: true,
-                skipActionText: true,
-                skipActiveRecord: true,
-                force: false,
-                api: false,
-                webpacker: "stimulus",
-                database: "sqlite3",
-                railsVersion: "dev"
-              }
-            }
-          }
-        }
-      ]
-    })
-  }
-];
-
-function createFetchRailsAction(options) {
-  const { reader, integrations, containerRunner } = options;
-  return pluginScaffolderNode.createTemplateAction({
-    id: "fetch:rails",
-    description: "Downloads a template from the given `url` into the workspace, and runs a rails new generator on it.",
-    examples,
-    schema: {
-      input: {
-        type: "object",
-        required: ["url"],
-        properties: {
-          url: {
-            title: "Fetch URL",
-            description: "Relative path or absolute URL pointing to the directory tree to fetch",
-            type: "string"
-          },
-          targetPath: {
-            title: "Target Path",
-            description: "Target path within the working directory to download the contents to.",
-            type: "string"
-          },
-          values: {
-            title: "Template Values",
-            description: "Values to pass on to rails for templating",
-            type: "object",
-            properties: {
-              railsArguments: {
-                title: "Arguments to pass to new command",
-                description: "You can provide some arguments to create a custom app",
-                type: "object",
-                properties: {
-                  minimal: {
-                    title: "minimal",
-                    description: "Preconfigure a minimal rails app",
-                    type: "boolean"
-                  },
-                  skipBundle: {
-                    title: "skipBundle",
-                    description: "Don't run bundle install",
-                    type: "boolean"
-                  },
-                  skipWebpackInstall: {
-                    title: "skipWebpackInstall",
-                    description: "Don't run Webpack install",
-                    type: "boolean"
-                  },
-                  skipTest: {
-                    title: "skipTest",
-                    description: "Skip test files",
-                    type: "boolean"
-                  },
-                  skipActionCable: {
-                    title: "skipActionCable",
-                    description: "Skip Action Cable files",
-                    type: "boolean"
-                  },
-                  skipActionMailer: {
-                    title: "skipActionMailer",
-                    description: "Skip Action Mailer files",
-                    type: "boolean"
-                  },
-                  skipActionMailbox: {
-                    title: "skipActionMailbox",
-                    description: "Skip Action Mailbox gem",
-                    type: "boolean"
-                  },
-                  skipActiveStorage: {
-                    title: "skipActiveStorage",
-                    description: "Skip Active Storage files",
-                    type: "boolean"
-                  },
-                  skipActionText: {
-                    title: "skipActionText",
-                    description: "Skip Action Text gem",
-                    type: "boolean"
-                  },
-                  skipActiveRecord: {
-                    title: "skipActiveRecord",
-                    description: "Skip Active Record files",
-                    type: "boolean"
-                  },
-                  force: {
-                    title: "force",
-                    description: "Overwrite files that already exist",
-                    type: "boolean"
-                  },
-                  api: {
-                    title: "api",
-                    description: "Preconfigure smaller stack for API only apps",
-                    type: "boolean"
-                  },
-                  template: {
-                    title: "template",
-                    description: "Path to some application template (can be a filesystem path or URL)",
-                    type: "string"
-                  },
-                  webpacker: {
-                    title: "webpacker",
-                    description: "Preconfigure Webpack with a particular framework (options: react, vue, angular, elm, stimulus)",
-                    type: "string",
-                    enum: ["react", "vue", "angular", "elm", "stimulus"]
-                  },
-                  database: {
-                    title: "database",
-                    description: "Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)",
-                    type: "string",
-                    enum: [
-                      "mysql",
-                      "postgresql",
-                      "sqlite3",
-                      "oracle",
-                      "sqlserver",
-                      "jdbcmysql",
-                      "jdbcsqlite3",
-                      "jdbcpostgresql",
-                      "jdbc"
-                    ]
-                  },
-                  railsVersion: {
-                    title: "Rails version in Gemfile",
-                    description: "Set up the application with Gemfile pointing to a specific version (options: fromImage, dev, edge, master)",
-                    type: "string",
-                    enum: ["dev", "edge", "master", "fromImage"]
-                  }
-                }
-              }
-            }
-          },
-          imageName: {
-            title: "Rails Docker image",
-            description: "Specify a Docker image to run rails new. Used only when a local rails is not found.",
-            type: "string"
-          }
-        }
-      }
-    },
-    async handler(ctx) {
-      ctx.logger.info("Fetching and then templating using rails");
-      const workDir = await ctx.createTemporaryDirectory();
-      const resultDir = path.resolve(workDir, "result");
-      await pluginScaffolderNode.fetchContents({
-        reader,
-        integrations,
-        baseUrl: ctx.templateInfo?.baseUrl,
-        fetchUrl: ctx.input.url,
-        outputPath: workDir
-      });
-      const templateRunner = new RailsNewRunner({ containerRunner });
-      const { imageName } = ctx.input;
-      if (imageName && !options.allowedImageNames?.includes(imageName)) {
-        throw new Error(`Image ${imageName} is not allowed`);
-      }
-      const logStream = new stream.PassThrough();
-      logStream.on("data", (chunk) => {
-        ctx.logger.info(chunk.toString());
-      });
-      await templateRunner.run({
-        workspacePath: workDir,
-        logStream,
-        values: { ...ctx.input.values, imageName }
-      });
-      const targetPath = ctx.input.targetPath ?? "./";
-      const outputPath = path.resolve(ctx.workspacePath, targetPath);
-      if (!outputPath.startsWith(ctx.workspacePath)) {
-        throw new errors.InputError(
-          `Fetch action targetPath may not specify a path outside the working directory`
-        );
-      }
-      await fs__default.default.copy(resultDir, outputPath);
-    }
-  });
-}
-
-const railsModule = backendPluginApi.createBackendModule({
-  pluginId: "scaffolder",
-  moduleId: "rails",
-  register({ registerInit }) {
-    registerInit({
-      deps: {
-        scaffolder: alpha.scaffolderActionsExtensionPoint,
-        config: backendPluginApi.coreServices.rootConfig,
-        reader: backendPluginApi.coreServices.urlReader
-      },
-      async init({ scaffolder, config, reader }) {
-        const integrations = integration.ScmIntegrations.fromConfig(config);
-        scaffolder.addActions(createFetchRailsAction({ integrations, reader }));
-      }
-    });
-  }
-});
-
-exports.createFetchRailsAction = createFetchRailsAction;
-exports.default = railsModule;
+exports.createFetchRailsAction = index.createFetchRailsAction;
+exports.default = module$1.railsModule;
 //# sourceMappingURL=index.cjs.js.map