@webhippie/semantic-release-rubygem 1.0.0 → 1.0.2

package/lib/common.js

@@ -0,0 +1 @@
+export default versionRegex = /(VERSION\s*=\s*['"])(?:(?!"|').)*(['"])/;

package/lib/prepare.js

@@ -0,0 +1,121 @@
+import path from "node:path";
+import { rename, readFile, writeFile } from "node:fs/promises";
+
+import { execa } from "execa";
+import { versionRegex } from "./common.js";
+
+const writeVersion = async ({ versionFile, nextVersion, logger, cwd }) => {
+  const gemVersion = nextVersion.replace("-", ".");
+  const fullVersionPath = path.resolve(cwd, versionFile);
+  const versionContents = await readFile(fullVersionPath, "utf8");
+  const newContents = versionContents.replace(
+    versionRegex,
+    `$1${gemVersion}$2`,
+  );
+
+  logger.log("Writing version %s to `%s`", nextVersion, versionFile);
+
+  await writeFile(fullVersionPath, newContents, "utf8");
+
+  return { gemVersion };
+};
+
+const bundleInstall = async ({
+  updateGemfileLock,
+  cwd,
+  env,
+  logger,
+  stdout,
+  stderr,
+}) => {
+  const command =
+    typeof updateGemfileLock === "string"
+      ? updateGemfileLock
+      : "bundle install";
+
+  logger.log("Updating lock file with command `%s`", command);
+
+  const installResult = execa.command(command, { cwd, env });
+
+  installResult.stdout.pipe(stdout, { end: false });
+
+  installResult.stderr.pipe(stderr, { end: false });
+
+  await installResult;
+};
+
+const buildGem = async ({
+  gemspec,
+  gemName,
+  version,
+  cwd,
+  env,
+  logger,
+  stdout,
+  stderr,
+}) => {
+  const gemFile = `${gemName}-${version}.gem`;
+
+  logger.log("Building gem `%s`", gemFile);
+
+  const buildResult = execa("gem", ["build", gemspec], { cwd, env });
+
+  buildResult.stdout.pipe(stdout, { end: false });
+
+  buildResult.stderr.pipe(stderr, { end: false });
+
+  await buildResult;
+
+  return gemFile;
+};
+
+export default async function prepare(
+  { updateGemfileLock = false, gemFileDir = false },
+  { nextRelease: { version }, cwd, env, logger, stdout, stderr },
+  { versionFile, gemSpec, gemName },
+) {
+  const { gemVersion } = await writeVersion({
+    versionFile,
+    nextVersion: version,
+    logger,
+    cwd,
+  });
+
+  if (updateGemfileLock) {
+    await bundleInstall({
+      updateGemfileLock,
+      cwd,
+      env,
+      logger,
+      stdout,
+      stderr,
+    });
+  }
+
+  let gemFile = await buildGem({
+    gemSpec,
+    gemName,
+    version: gemVersion,
+    cwd,
+    env,
+    logger,
+    stdout,
+    stderr,
+  });
+
+  if (gemFileDir) {
+    const gemFileSource = path.resolve(cwd, gemFile);
+
+    const gemFileDestination = path.resolve(cwd, gemFileDir.trim(), gemFile);
+
+    if (gemFileSource !== gemFileDestination) {
+      await rename(gemFileSource, gemFileDestination);
+    }
+
+    gemFile = path.join(gemFileDir.trim(), gemFile);
+  }
+
+  return {
+    gemFile,
+  };
+}

package/lib/publish.js

@@ -0,0 +1,36 @@
+import { unlink } from "node:fs/promises";
+import { execa } from "execa";
+
+export default async function publish(
+  { gemHost, gemPublish = true, gemFileDir = false },
+  { cwd, env, logger, nextRelease: { version }, stdout, stderr },
+  { gemFile, gemName, credentialsFile },
+) {
+  if (gemPublish !== false) {
+    logger.log(`Publishing version ${version} to rubygems`);
+
+    const args = ["push", gemFile, "--config-file", credentialsFile];
+
+    if (gemHost) {
+      args.push("--host", gemHost);
+    }
+
+    const pushResult = execa("gem", args, { cwd, env });
+
+    pushResult.stdout.pipe(stdout, { end: false });
+
+    pushResult.stderr.pipe(stderr, { end: false });
+
+    await pushResult;
+
+    logger.log(`Published version ${version} of ${gemName} to rubygems`);
+  } else {
+    logger.log(
+      `Skip publishing to rubygems because gemPublish is ${gemPublish !== false}`,
+    );
+  }
+
+  if (gemFileDir === false) {
+    await unlink(gemFile);
+  }
+}

package/lib/verify.js

@@ -0,0 +1,142 @@
+import path from "node:path";
+import { readFile, writeFile } from "node:fs/promises";
+
+import { execa } from "execa";
+import { glob } from "glob";
+import { versionRegex } from "./common.js";
+
+import SemanticReleaseError from "@semantic-release/error";
+
+const loadGemspec = async ({ cwd }) => {
+  const gemSpecs = await glob("*.gemspec", { cwd });
+
+  if (gemSpecs.length !== 1) {
+    throw new SemanticReleaseError(
+      "Couldn't find a `.gemspec` file.",
+      "ENOGEMSPEC",
+      `A single [.gemspec](https://guides.rubygems.org/specification-reference/) file in the root of your project is required to release a Rubygem.
+
+Please follow the "[Make your own gem guide](https://guides.rubygems.org/make-your-own-gem/)" to create a valid \`.gemspec\` file
+      `,
+    );
+  }
+
+  const [gemSpec] = gemSpecs;
+
+  let gemName = null;
+
+  try {
+    const { stdout } = await execa(
+      "ruby",
+      ["-e", `puts Gem::Specification.load('${gemSpec}').name`],
+      { cwd },
+    );
+
+    gemName = stdout;
+  } catch (error) {
+    throw new SemanticReleaseError(
+      `Error loading \`${gemSpec}\``,
+      "EINVALIDGEMSPEC",
+      `A valid [.gemspec](https://guides.rubygems.org/specification-reference/) is required to release a Rubygem.
+
+Please follow the "[Make your own gem guide](https://guides.rubygems.org/make-your-own-gem/)" to create a valid \`.gemspec\` file
+      `,
+    );
+  }
+
+  if (gemName === "") {
+    throw new SemanticReleaseError(
+      `Missing \`name\` attribute in \`${gemSpec}\``,
+      "ENOGEMNAME",
+      `The [name](https://guides.rubygems.org/specification-reference/#name) attribute is required in your \`.gemspec\` file in order to publish a Rubygem.
+
+Please make sure to add a valid \`name\` for your gem in your \`.gemspec\`.
+      `,
+    );
+  }
+
+  return {
+    name: gemName,
+    gemSpec,
+  };
+};
+
+const verifyVersionFile = async ({ cwd, versionGlob }) => {
+  const versionFiles = await glob(versionGlob, { cwd });
+
+  if (versionFiles.length !== 1) {
+    throw new SemanticReleaseError(
+      "Couldn't find a `version.lib` file.",
+      "ENOVERSIONFILE",
+      `A \`version.rb\` file in the \`lib/*\` dir of your project is required to release a Ruby gem.
+
+Please create a \`version.rb\` file with a defined \`VERSION\` constant in your \`lib\` dir (or subdir).
+      `,
+    );
+  }
+
+  const [versionFile] = versionFiles;
+
+  const fullVersionPath = path.resolve(cwd, versionFile);
+
+  const versionContents = await readFile(fullVersionPath, "utf8");
+
+  if (!versionRegex.test(versionContents)) {
+    throw new SemanticReleaseError(
+      `Couldn't find a valid version constant defined in \`${versionFile}\`.`,
+      "EINVALIDVERSIONFILE",
+      `Your \`version.rb\` file must define a \`VERSION\` constant.
+
+Please define your gem's version a string constant named \`VERSION\` inside your \`version.rb\` file.
+      `,
+    );
+  }
+
+  return versionFile;
+};
+
+const verifyApiKey = async ({ env, credentialsFile }) => {
+  if (!env.GEM_HOST_API_KEY) {
+    throw new SemanticReleaseError(
+      "No rubygems API key specified.",
+      "ENOGEMAPIKEY",
+      `A rubygems API key must be created and set in the \`GEM_HOST_API_KEY\` environment variable on you CI environment.
+
+You can retrieve an API key either from your \`~/.gem/credentials\` file or in your profile in [RubyGems.org](http://rubygems.org/).
+      `,
+    );
+  }
+
+  await writeFile(
+    credentialsFile,
+    `---\n:rubygems_api_key: ${env.GEM_HOST_API_KEY}`,
+    "utf8",
+  );
+};
+
+export default async function verify(
+  { versionGlob = "lib/**/version.rb" },
+  { env, cwd },
+  { credentialsFile },
+) {
+  const { name, gemSpec } = await loadGemspec({
+    cwd,
+  });
+
+  const versionFile = await verifyVersionFile({
+    cwd,
+    versionGlob,
+  });
+
+  await verifyApiKey({
+    env,
+    cwd,
+    credentialsFile,
+  });
+
+  return {
+    gemName: name,
+    gemSpec,
+    versionFile,
+  };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webhippie/semantic-release-rubygem",
   "description": "semantic-release plugin to publish a gem to Rubygems",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "author": "Thomas Boerger (https://twitter.com/@tboerger)",
   "ava": {