update release-please to be able to update ruby versions correctly (#203)

* chore: pin nodejs to compatible version

* feat: add ruby version updater

Author: ms-jpq

.tool-versions

@@ -0,0 +1 @@
+nodejs 18.20.2

__snapshots__/ruby-readme.ts.js

@@ -0,0 +1,50 @@
+exports['Ruby README.md updateContent updates ruby version in README.md - 0.6.0-alpha.1 1'] = `
+## Install
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.alpha.1"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.alpha.1"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.alpha.1"
+\`\`\`
+
+`
+
+exports['Ruby README.md updateContent updates ruby version in README.md - 0.6.0-beta.2 1'] = `
+## Install
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.beta.2"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.beta.2"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 0.6.0.pre.beta.2"
+\`\`\`
+
+`
+
+exports['Ruby README.md updateContent updates ruby version in README.md - 2.1.0 1'] = `
+## Install
+
+\`\`\`ruby
+gem "sink", "~> 2.1.0"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 2.1.0"
+\`\`\`
+
+\`\`\`ruby
+gem "sink", "~> 2.1.0"
+\`\`\`
+
+`

src/manifest.ts

@@ -81,13 +81,20 @@ type ExtraTomlFile = {
   jsonpath: string;
   glob?: boolean;
 };
+type ExtraRubyReadMeFile = {
+  type: 'ruby-readme';
+  path: string;
+  jsonpath: string;
+  glob?: boolean;
+};
 export type ExtraFile =
   | string
   | ExtraJsonFile
   | ExtraYamlFile
   | ExtraXmlFile
   | ExtraPomFile
-  | ExtraTomlFile;
+  | ExtraTomlFile
+  | ExtraRubyReadMeFile;
 /**
  * These are configurations provided to each strategy per-path.
  */

src/strategies/base.ts

@@ -42,6 +42,7 @@ import {Generic} from '../updaters/generic';
 import {GenericJson} from '../updaters/generic-json';
 import {GenericXml} from '../updaters/generic-xml';
 import {PomXml} from '../updaters/java/pom-xml';
+import {RubyReadMeUpdater} from '../updaters/ruby/readme';
 import {GenericYaml} from '../updaters/generic-yaml';
 import {GenericToml} from '../updaters/generic-toml';
 import {FileNotFoundError} from '../errors';
@@ -553,6 +554,13 @@ If you instead want to use the version number \`${newVersion}\` generated from c
                 updater: new PomXml(version),
               });
               break;
+            case 'ruby-readme':
+              extraFileUpdates.push({
+                path: this.addPath(path),
+                createIfMissing: false,
+                updater: new RubyReadMeUpdater({version}),
+              });
+              break;
             default:
               throw new Error(
                 `unsupported extraFile type: ${

src/updaters/ruby/readme.ts

@@ -0,0 +1,24 @@
+import {DefaultUpdater} from '../default';
+import {RUBY_VERSION_REGEX, stringifyRubyVersion} from './common';
+
+const RUBY_VERSION_LINE_REGEX = new RegExp(
+  `(^gem "[^"]+"\\s*,\\s*"[^\\d]+)(${RUBY_VERSION_REGEX.source})(.)\\s*$`,
+  'gm'
+);
+
+/**
+ * Updates a versions.rb file which is expected to have a version string.
+ */
+export class RubyReadMeUpdater extends DefaultUpdater {
+  /**
+   * Given initial file contents, return updated contents.
+   * @param {string} content The initial content
+   * @returns {string} The updated content
+   */
+  updateContent(content: string): string {
+    return content.replace(
+      RUBY_VERSION_LINE_REGEX,
+      `$1${stringifyRubyVersion(this.version)}"`
+    );
+  }
+}

test/updaters/fixtures/README-ruby-version.md

@@ -0,0 +1,13 @@
+## Install
+
+```ruby
+gem "sink", "~> 0.2.0.pre.alpha"
+```
+
+```ruby
+gem "sink", "~> 0.2.0.pre.beta"
+```
+
+```ruby
+gem "sink", "~> 0.2.0"
+```

test/updaters/ruby-readme.ts

@@ -0,0 +1,28 @@
+import {readFileSync} from 'fs';
+import {describe, it} from 'mocha';
+import {resolve} from 'path';
+import {RubyReadMeUpdater} from '../../src/updaters/ruby/readme';
+import {Version} from '../../src/version';
+import snapshot = require('snap-shot-it');
+
+const fixturesPath = './test/updaters/fixtures';
+
+describe('Ruby README.md', () => {
+  describe('updateContent', () => {
+    const versions = ['2.1.0', '0.6.0-alpha.1', '0.6.0-beta.2'];
+
+    for (const ver of versions) {
+      it(`updates ruby version in README.md - ${ver}`, async () => {
+        const oldContent = readFileSync(
+          resolve(fixturesPath, './README-ruby-version.md'),
+          'utf8'
+        ).replace(/\r\n/g, '\n');
+        const version = new RubyReadMeUpdater({
+          version: Version.parse(ver),
+        });
+        const newContent = version.updateContent(oldContent);
+        snapshot(newContent);
+      });
+    }
+  });
+});