Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ruby): improve bump/widen strategy for ~> #17091

Merged
merged 3 commits into from
Aug 16, 2022
Merged

feat(ruby): improve bump/widen strategy for ~> #17091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba190b3
feat(ruby): improve bump/widen strategy for `~>`
qnighy Aug 10, 2022
037ac42
Floor lower bound for replace
qnighy Aug 12, 2022
16bc157
Merge branch 'main' into feat/ruby-bump-and-widen
rarkins Aug 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
75 changes: 69 additions & 6 deletions lib/modules/versioning/ruby/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,24 +265,44 @@ describe('modules/versioning/ruby/index', () => {
${"'>= 3.0.5', '< 3.2'"} | ${'replace'} | ${'3.1.5'} | ${'3.2.1'} | ${"'>= 3.0.5', '< 3.3'"}
${"'0.0.10'"} | ${'auto'} | ${'0.0.10'} | ${'0.0.11'} | ${"'0.0.11'"}
${"'0.0.10'"} | ${'replace'} | ${'0.0.10'} | ${'0.0.11'} | ${"'0.0.11'"}
${'>= 3.2, < 5.0'} | ${'bump'} | ${'4.0.2'} | ${'6.0.1'} | ${'>= 6.0.1, < 6.0.2'}
${'~> 5.2, >= 5.2.5'} | ${'bump'} | ${'5.3.0'} | ${'6.0.0'} | ${'~> 6.0'}
${'~> 5.2, >= 5.2.5'} | ${'bump'} | ${'5.3.0'} | ${'6.0.1'} | ${'~> 6.0, >= 6.0.1'}
${'~> 5.2.0, >= 5.2.5'} | ${'bump'} | ${'5.2.5'} | ${'5.3.1'} | ${'~> 5.3.1'}
${'4.2.0'} | ${'bump'} | ${'4.2.0'} | ${'4.2.5.1'} | ${'4.2.5.1'}
${'4.2.5.1'} | ${'bump'} | ${'0.1'} | ${'4.3.0'} | ${'4.3.0'}
${'~> 1'} | ${'bump'} | ${'1.2.0'} | ${'2.0.3'} | ${'~> 2, >= 2.0.3'}
${'= 5.2.2'} | ${'bump'} | ${'5.2.2'} | ${'5.2.2.1'} | ${'= 5.2.2.1'}
${'1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'1.2.3'}
${'v1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'v1.2.3'}
${'= 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'= 1.2.3'}
${'!= 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'>= 1.2.3'}
${'!= 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.2'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.3'} | ${'!= 1.0.3'}
${'> 1.0.3'} | ${'bump'} | ${'1.0.4'} | ${'1.2.3'} | ${'> 1.2.2'}
${'> 1.2.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.3'} | ${'> 1.2.3'}
${'> 1.2.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.3'} | ${'> 1.0.2'}
${'< 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.3'} | ${'< 1.2.3'}
${'< 1.2.2'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2'} | ${'bump'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.3'}
${'< 1'} | ${'bump'} | ${'0.9.0'} | ${'1.2.3'} | ${'< 2'}
${'< 1.2.3'} | ${'bump'} | ${'1.0.0'} | ${'1.2.2'} | ${'< 1.2.3'}
${'>= 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'>= 1.2.3'}
${'>= 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.0.2'} | ${'>= 1.0.2'}
${'<= 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'<= 1.2.3'}
${'~> 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'~> 1.2.0'}
${'~> 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.0.4'} | ${'~> 1.0.0'}
${'~> 4.7, >= 4.7.4'} | ${'bump'} | ${'4.7.5'} | ${'4.7.9'} | ${'~> 4.7.0, >= 4.7.9'}
${'<= 1.0.3'} | ${'bump'} | ${'1.0.0'} | ${'1.0.2'} | ${'<= 1.0.3'}
${'~> 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.2.3'} | ${'~> 1.2.3'}
${'~> 1.0.3'} | ${'bump'} | ${'1.0.3'} | ${'1.0.4'} | ${'~> 1.0.4'}
${'~> 4.7, >= 4.7.4'} | ${'bump'} | ${'4.7.5'} | ${'4.7.9'} | ${'~> 4.7, >= 4.7.9'}
${'~> 4.7, >= 4.7.4'} | ${'bump'} | ${'4.7.5'} | ${'4.8.0'} | ${'~> 4.8'}
${'>= 2.0.0, <= 2.15'} | ${'bump'} | ${'2.15.0'} | ${'2.20.1'} | ${'>= 2.20.1, <= 2.20.1'}
${'~> 5.2.0'} | ${'bump'} | ${'5.2.4.1'} | ${'6.0.2.1'} | ${'~> 6.0.2, >= 6.0.2.1'}
${'~> 4.0, < 5'} | ${'bump'} | ${'4.7.5'} | ${'5.0.0'} | ${'~> 5.0, < 6'}
${'~> 4.0, < 5'} | ${'bump'} | ${'4.7.5'} | ${'5.0.1'} | ${'~> 5.0, >= 5.0.1, < 6'}
${'~> 4.0, < 5'} | ${'bump'} | ${'4.7.5'} | ${'5.1.0'} | ${'~> 5.1, < 6'}
${'>= 3.2, < 5.0'} | ${'replace'} | ${'4.0.2'} | ${'6.0.1'} | ${'>= 3.2, < 6.0.2'}
${'~> 5.2, >= 5.2.5'} | ${'replace'} | ${'5.3.0'} | ${'6.0.0'} | ${'~> 6.0, >= 6.0.0'}
${'~> 5.2, >= 5.2.5'} | ${'replace'} | ${'5.3.0'} | ${'6.0.1'} | ${'~> 6.0, >= 6.0.1'}
${'~> 5.2.0, >= 5.2.5'} | ${'replace'} | ${'5.2.5'} | ${'5.3.1'} | ${'~> 5.3.0, >= 5.3.1'}
${'4.2.0'} | ${'replace'} | ${'4.2.0'} | ${'4.2.5.1'} | ${'4.2.5.1'}
Expand All @@ -293,23 +313,66 @@ describe('modules/versioning/ruby/index', () => {
${'v1.0.3'} | ${'replace'} | ${'1.0.3'} | ${'1.2.3'} | ${'v1.2.3'}
${'= 1.0.3'} | ${'replace'} | ${'1.0.3'} | ${'1.2.3'} | ${'= 1.2.3'}
${'!= 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.2'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.3'} | ${'!= 1.0.3'}
${'> 1.0.3'} | ${'replace'} | ${'1.0.4'} | ${'1.2.3'} | ${'> 1.0.3'}
${'> 1.2.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.3'} | ${'> 1.0.2'}
rarkins marked this conversation as resolved.
Show resolved Hide resolved
${'< 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.3'} | ${'< 1.2.3'}
${'< 1.2.2'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.3'}
${'< 1'} | ${'replace'} | ${'0.9.0'} | ${'1.2.3'} | ${'< 2'}
${'< 1.2.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.2'} | ${'< 1.2.3'}
${'>= 1.0.3'} | ${'replace'} | ${'1.0.3'} | ${'1.2.3'} | ${'>= 1.0.3'}
${'>= 1.0.3'} | ${'replace'} | ${'1.0.3'} | ${'1.0.2'} | ${'>= 1.0.2'}
${'<= 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'<= 1.2.3'}
${'<= 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.2'} | ${'<= 1.0.3'}
${'~> 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.2.3'} | ${'~> 1.2.0'}
${'~> 1.0.3'} | ${'replace'} | ${'1.0.0'} | ${'1.0.4'} | ${'~> 1.0.3'}
${'~> 4.7, >= 4.7.4'} | ${'replace'} | ${'1.0.0'} | ${'4.7.9'} | ${'~> 4.7, >= 4.7.4'}
${'~> 4.7, >= 4.7.4'} | ${'replace'} | ${'4.7.5'} | ${'4.8.0'} | ${'~> 4.7, >= 4.7.4'}
${'>= 2.0.0, <= 2.15'} | ${'replace'} | ${'2.15.0'} | ${'2.20.1'} | ${'>= 2.0.0, <= 2.20.1'}
${'~> 5.2.0'} | ${'replace'} | ${'5.2.4.1'} | ${'6.0.2.1'} | ${'~> 6.0.0'}
${'~> 4.0, < 5'} | ${'replace'} | ${'4.7.5'} | ${'5.0.0'} | ${'~> 5.0, < 6'}
${'~> 4.0, < 5'} | ${'replace'} | ${'4.7.5'} | ${'5.0.1'} | ${'~> 5.0, < 6'}
${'~> 4.0, < 5'} | ${'replace'} | ${'4.7.5'} | ${'5.1.0'} | ${'~> 5.1, < 6'}
${'~> 4.0, < 5'} | ${'replace'} | ${'4.7.5'} | ${'5.1.0'} | ${'~> 5.0, < 6'}
${'>= 3.2, < 5.0'} | ${'widen'} | ${'4.0.2'} | ${'6.0.1'} | ${'>= 3.2, < 6.0.2'}
${'~> 5.2, >= 5.2.5'} | ${'widen'} | ${'5.3.0'} | ${'6.0.0'} | ${'>= 5.2.5, < 7'}
${'~> 5.2, >= 5.2.5'} | ${'widen'} | ${'5.3.0'} | ${'6.0.1'} | ${'>= 5.2.5, < 7'}
${'~> 5.2.0, >= 5.2.5'} | ${'widen'} | ${'5.2.5'} | ${'5.3.1'} | ${'>= 5.2.5, < 5.4'}
${'4.2.0'} | ${'widen'} | ${'4.2.0'} | ${'4.2.5.1'} | ${'4.2.5.1'}
${'4.2.5.1'} | ${'widen'} | ${'0.1'} | ${'4.3.0'} | ${'4.3.0'}
${'~> 1'} | ${'widen'} | ${'1.2.0'} | ${'2.0.3'} | ${'>= 1, < 3'}
${'= 5.2.2'} | ${'widen'} | ${'5.2.2'} | ${'5.2.2.1'} | ${'= 5.2.2.1'}
${'1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.2.3'} | ${'1.2.3'}
${'v1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.2.3'} | ${'v1.2.3'}
${'= 1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.2.3'} | ${'= 1.2.3'}
${'!= 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.2'} | ${'!= 1.0.3'}
${'!= 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.3'} | ${'!= 1.0.3'}
${'> 1.0.3'} | ${'widen'} | ${'1.0.4'} | ${'1.2.3'} | ${'> 1.0.3'}
${'> 1.2.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.3'} | ${'> 1.0.2'}
${'< 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.3'} | ${'< 1.2.3'}
${'< 1.2.2'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.2.4'}
${'< 1.2'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'< 1.3'}
${'< 1'} | ${'widen'} | ${'0.9.0'} | ${'1.2.3'} | ${'< 2'}
${'< 1.2.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.2'} | ${'< 1.2.3'}
${'>= 1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.2.3'} | ${'>= 1.0.3'}
${'>= 1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.0.2'} | ${'>= 1.0.2'}
${'<= 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'<= 1.2.3'}
${'<= 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.2'} | ${'<= 1.0.3'}
${'~> 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.2.3'} | ${'>= 1.0.3, < 1.2.4'}
${'~> 1.0.3'} | ${'widen'} | ${'1.0.0'} | ${'1.0.4'} | ${'~> 1.0.3'}
${'~> 4.7, >= 4.7.4'} | ${'widen'} | ${'1.0.0'} | ${'4.7.9'} | ${'~> 4.7, >= 4.7.4'}
${'~> 4.7, >= 4.7.4'} | ${'widen'} | ${'4.7.5'} | ${'4.8.0'} | ${'~> 4.7, >= 4.7.4'}
${'>= 2.0.0, <= 2.15'} | ${'widen'} | ${'2.15.0'} | ${'2.20.1'} | ${'>= 2.0.0, <= 2.20.1'}
${'~> 5.2.0'} | ${'widen'} | ${'5.2.4.1'} | ${'6.0.2.1'} | ${'>= 5.2.0, < 6.0.3'}
${'~> 4.0, < 5'} | ${'widen'} | ${'4.7.5'} | ${'5.0.0'} | ${'>= 4.0, < 6, < 6'}
${'~> 4.0, < 5'} | ${'widen'} | ${'4.7.5'} | ${'5.0.1'} | ${'>= 4.0, < 6, < 6'}
${'~> 4.0, < 5'} | ${'widen'} | ${'4.7.5'} | ${'5.1.0'} | ${'>= 4.0, < 6, < 6'}
${'< 1.0.3'} | ${'auto'} | ${'1.0.3'} | ${'1.2.4'} | ${'< 1.2.5'}
${'< 1.0.3'} | ${'replace'} | ${'1.0.3'} | ${'1.2.4'} | ${'< 1.2.5'}
${'< 1.0.3'} | ${'widen'} | ${'1.0.3'} | ${'1.2.4'} | ${'< 1.2.5'}
Expand Down
9 changes: 7 additions & 2 deletions lib/modules/versioning/ruby/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { regEx } from '../../../util/regex';
import type { NewValueConfig, VersioningApi } from '../types';
import { isSingleOperator, isValidOperator } from './operator';
import { ltr, parse as parseRange } from './range';
import { bump, pin, replace } from './strategies';
import { bump, pin, replace, widen } from './strategies';
import { parse as parseVersion } from './version';

export const id = 'ruby';
Expand Down Expand Up @@ -127,13 +127,18 @@ const getNewValue = ({
newValue = bump({ range: vtrim(currentValue), to: vtrim(newVersion) });
break;
case 'auto':
case 'widen':
case 'replace':
newValue = replace({
range: vtrim(currentValue),
to: vtrim(newVersion),
});
break;
case 'widen':
newValue = widen({
range: vtrim(currentValue),
to: vtrim(newVersion),
});
break;
// istanbul ignore next
default:
logger.warn(`Unsupported strategy ${rangeStrategy}`);
Expand Down
63 changes: 63 additions & 0 deletions lib/modules/versioning/ruby/range.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { satisfies } from '@renovatebot/ruby-semver';
import { parse as _parse } from '@renovatebot/ruby-semver/dist/ruby/requirement.js';
import { Version, create } from '@renovatebot/ruby-semver/dist/ruby/version.js';
import { logger } from '../../../logger';
Expand All @@ -8,6 +9,14 @@ export interface Range {
version: string;
operator: string;
delimiter: string;
/**
* If the range is `~>` and immediately followed by `>=`,
* the latter range is considered the former's companion
* and assigned here instead of being an independent range.
*
* Example: `'~> 6.2', '>= 6.2.1'`
*/
companion?: Range;
}

const parse = (range: string): Range => {
Expand All @@ -30,6 +39,60 @@ const parse = (range: string): Range => {
};
};

/** Wrapper for {@link satisfies} for {@link Range} record. */
export function satisfiesRange(ver: string, range: Range): boolean {
if (range.companion) {
return (
satisfies(ver, `${range.operator}${range.version}`) &&
satisfiesRange(ver, range.companion)
);
} else {
return satisfies(ver, `${range.operator}${range.version}`);
}
}

/**
* Parses a comma-delimited list of range parts,
* with special treatment for a pair of `~>` and `>=` parts.
*/
export function parseRanges(range: string): Range[] {
const originalRanges = range.split(',').map(parse);
const ranges: Range[] = [];
for (let i = 0; i < originalRanges.length; ) {
if (
i + 1 < originalRanges.length &&
originalRanges[i].operator === PGTE &&
originalRanges[i + 1].operator === GTE
) {
ranges.push({
...originalRanges[i],
companion: originalRanges[i + 1],
});
i += 2;
} else {
ranges.push(originalRanges[i]);
i++;
}
}
return ranges;
}

/**
* Stringifies a list of range parts into a comma-separated string,
* with special treatment for a pair of `~>` and `>=` parts.
*/
export function stringifyRanges(ranges: Range[]): string {
return ranges
.map((r) => {
if (r.companion) {
return `${r.operator}${r.delimiter}${r.version}, ${r.companion.operator}${r.companion.delimiter}${r.companion.version}`;
} else {
return `${r.operator}${r.delimiter}${r.version}`;
}
})
.join(', ');
}

type GemRequirement = [string, Version];

const ltr = (version: string, range: string): boolean => {
Expand Down
58 changes: 34 additions & 24 deletions lib/modules/versioning/ruby/strategies/bump.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,45 @@
import { gte, lte } from '@renovatebot/ruby-semver';
import { logger } from '../../../../logger';
import { EQUAL, GT, GTE, LT, LTE, NOT_EQUAL, PGTE } from '../operator';
import { parse as parseRange } from '../range';
import { decrement, floor, increment } from '../version';
import { gt, gte, lt } from '@renovatebot/ruby-semver';
import { GTE, LT, LTE, NOT_EQUAL, PGTE } from '../operator';
import { Range, parseRanges, stringifyRanges } from '../range';
import { adapt, trimZeroes } from '../version';
import { replacePart } from './replace';

export default ({ range, to }: { range: string; to: string }): string => {
const ranges = range.split(',').map(parseRange);
const results = ranges.map(({ operator, version: ver, delimiter }) => {
const parts = parseRanges(range).map((part): Range => {
const { operator, version: ver } = part;
switch (operator) {
case GT:
return lte(to, ver)
? `${GT}${delimiter}${ver}`
: `${GT}${delimiter}${decrement(to)}`;
// Update upper bound (`<` and `<=`) ranges only if the new version violates them
case LT:
return gte(to, ver)
? `${LT}${delimiter}${increment(ver, to)}`
: `${LT}${delimiter}${ver}`;
case PGTE:
return `${operator}${delimiter}${floor(to)}`;
case GTE:
return gte(to, ver) ? replacePart(part, to) : part;
case LTE:
case EQUAL:
return `${operator}${delimiter}${to}`;
return gt(to, ver) ? replacePart(part, to) : part;
// `~>` ranges.
case PGTE: {
// Try to add / remove extra `>=` constraint.
const trimmed = adapt(to, ver);
if (trimZeroes(trimmed) === trimZeroes(to)) {
// E.g. `'~> 5.2', '>= 5.2.0'`. In this case the latter is redundant.
return { ...part, version: trimmed, companion: undefined };
} else {
// E.g. `'~> 5.2', '>= 5.2.1'`.
return {
...part,
version: trimmed,
companion: { operator: GTE, delimiter: ' ', version: to },
};
}
}
case NOT_EQUAL:
return `${NOT_EQUAL}${delimiter}${ver}`;
// istanbul ignore next
if (lt(ver, to)) {
// The version to exclude is now out of range.
return { ...part, operator: GTE, version: to };
}
return part;
default:
logger.warn(`Unsupported operator '${operator}'`);
return null;
// For `=` and lower bound ranges, always keep it stick to the new version.
return replacePart(part, to);
}
});

return results.join(', ');
return stringifyRanges(parts);
};
3 changes: 2 additions & 1 deletion lib/modules/versioning/ruby/strategies/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import bump from './bump';
import pin from './pin';
import replace from './replace';
import widen from './widen';

export { pin, bump, replace };
export { pin, bump, replace, widen };