Skip to content

Commit

Permalink
Merge package:pub_semver into the tools monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
mosuem committed Dec 10, 2024
2 parents faf2b86 + 7cb7ee0 commit 8e698ea
Show file tree
Hide file tree
Showing 21 changed files with 4,121 additions and 0 deletions.
14 changes: 14 additions & 0 deletions pkgs/pub_semver/.github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Dependabot configuration file.
version: 2

updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
labels:
- autosubmit
groups:
github-actions:
patterns:
- "*"
64 changes: 64 additions & 0 deletions pkgs/pub_semver/.github/workflows/test-package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Dart CI

on:
# Run on PRs and pushes to the default branch.
push:
branches: [ master ]
pull_request:
branches: [ master ]
schedule:
- cron: "0 0 * * 0"

env:
PUB_ENVIRONMENT: bot.github

jobs:
# Check code formatting and static analysis on a single OS (linux)
# against Dart dev.
analyze:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
sdk: [dev]
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
with:
sdk: ${{ matrix.sdk }}
- id: install
name: Install dependencies
run: dart pub get
- name: Check formatting
run: dart format --output=none --set-exit-if-changed .
if: always() && steps.install.outcome == 'success'
- name: Analyze code
run: dart analyze --fatal-infos
if: always() && steps.install.outcome == 'success'

# Run tests on a matrix consisting of two dimensions:
# 1. OS: ubuntu-latest, (macos-latest, windows-latest)
# 2. release channel: dev
test:
needs: analyze
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
# Add macos-latest and/or windows-latest if relevant for this package.
os: [ubuntu-latest]
sdk: [3.4, dev]
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
with:
sdk: ${{ matrix.sdk }}
- id: install
name: Install dependencies
run: dart pub get
- name: Run VM tests
run: dart test --platform vm
if: always() && steps.install.outcome == 'success'
- name: Run Chrome tests
run: dart test --platform chrome --compiler dart2js,dart2wasm
if: always() && steps.install.outcome == 'success'
3 changes: 3 additions & 0 deletions pkgs/pub_semver/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.dart_tool/
.packages
pubspec.lock
176 changes: 176 additions & 0 deletions pkgs/pub_semver/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
## 2.1.5-wip

- Require Dart `3.4.0`.

## 2.1.4

- Added topics to `pubspec.yaml`.

## 2.1.3

- Add type parameters to the signatures of the `Version.preRelease` and
`Version.build` fields (`List` ==> `List<Object>`).
[#74](https://github.com/dart-lang/pub_semver/pull/74).
- Require Dart 2.17.

## 2.1.2

- Add markdown badges to the readme.

## 2.1.1

- Fixed the version parsing pattern to only accept dots between version
components.

## 2.1.0

- Added `Version.canonicalizedVersion` to help scrub leading zeros and highlight
that `Version.toString()` preserves leading zeros.
- Annotated `Version` with `@sealed` to discourage users from implementing the
interface.

## 2.0.0

- Stable null safety release.
- `Version.primary` now throws `StateError` if the `versions` argument is empty.

## 1.4.4

- Fix a bug of `VersionRange.union` where ranges bounded at infinity would get
combined wrongly.

# 1.4.3

- Update Dart SDK constraint to `>=2.0.0 <3.0.0`.
- Update `package:collection` constraint to `^1.0.0`.

## 1.4.2

* Set max SDK version to `<3.0.0`.

## 1.4.1

* Fix a bug where there upper bound of a version range with a build identifier
could accidentally be rewritten.

## 1.4.0

* Add a `Version.firstPreRelease` getter that returns the first possible
pre-release of a version.

* Add a `Version.isFirstPreRelease` getter that returns whether a version is the
first possible pre-release.

* `new VersionRange()` with an exclusive maximum now replaces the maximum with
its first pre-release version. This matches the existing semantics, where an
exclusive maximum would exclude pre-release versions of that maximum.

Explicitly representing this by changing the maximum version ensures that all
operations behave correctly with respect to the special pre-release semantics.
In particular, it fixes bugs where, for example,
`(>=1.0.0 <2.0.0-dev).union(>=2.0.0-dev <2.0.0)` and
`(>=1.0.0 <3.0.0).difference(^1.0.0)` wouldn't include `2.0.0-dev`.

* Add an `alwaysIncludeMaxPreRelease` parameter to `new VersionRange()`, which
disables the replacement described above and allows users to create ranges
that do include the pre-release versions of an exclusive max version.

## 1.3.7

* Fix more bugs with `VersionRange.intersect()`, `VersionRange.difference()`,
and `VersionRange.union()` involving version ranges with pre-release maximums.

## 1.3.6

* Fix a bug where constraints that only allowed pre-release versions would be
parsed as empty constraints.

## 1.3.5

* Fix a bug where `VersionRange.intersect()` would return incorrect results for
pre-release versions with the same base version number as release versions.

## 1.3.4

* Fix a bug where `VersionRange.allowsAll()`, `VersionRange.allowsAny()`, and
`VersionRange.difference()` would return incorrect results for pre-release
versions with the same base version number as release versions.

## 1.3.3

* Fix a bug where `VersionRange.difference()` with a union constraint that
covered the entire range would crash.

## 1.3.2

* Fix a checked-mode error in `VersionRange.difference()`.

## 1.3.1

* Fix a new strong mode error.

## 1.3.0

* Make the `VersionUnion` class public. This was previously used internally to
implement `new VersionConstraint.unionOf()` and `VersionConstraint.union()`.
Now it's public so you can use it too.

* Added `VersionConstraint.difference()`. This returns a constraint matching all
versions matched by one constraint but not another.

* Make `VersionRange` implement `Comparable<VersionRange>`. Ranges are ordered
first by lower bound, then by upper bound.

## 1.2.4

* Fix all remaining strong mode warnings.

## 1.2.3

* Addressed three strong mode warnings.

## 1.2.2

* Make the package analyze under strong mode and compile with the DDC (Dart Dev
Compiler). Fix two issues with a private subclass of `VersionConstraint`
having different types for overridden methods.

## 1.2.1

* Allow version ranges like `>=1.2.3-dev.1 <1.2.3` to match pre-release versions
of `1.2.3`. Previously, these didn't match, since the pre-release versions had
the same major, minor, and patch numbers as the max; now an exception has been
added if they also have the same major, minor, and patch numbers as the min
*and* the min is also a pre-release version.

## 1.2.0

* Add a `VersionConstraint.union()` method and a `new
VersionConstraint.unionOf()` constructor. These each return a constraint that
matches multiple existing constraints.

* Add a `VersionConstraint.allowsAll()` method, which returns whether one
constraint is a superset of another.

* Add a `VersionConstraint.allowsAny()` method, which returns whether one
constraint overlaps another.

* `Version` now implements `VersionRange`.

## 1.1.0

* Add support for the `^` operator for compatible versions according to pub's
notion of compatibility. `^1.2.3` is equivalent to `>=1.2.3 <2.0.0`; `^0.1.2`
is equivalent to `>=0.1.2 <0.2.0`.

* Add `Version.nextBreaking`, which returns the next version that introduces
breaking changes after a given version.

* Add `new VersionConstraint.compatibleWith()`, which returns a range covering
all versions compatible with a given version.

* Add a custom `VersionRange.hashCode` to make it properly hashable.

## 1.0.0

* Initial release.
27 changes: 27 additions & 0 deletions pkgs/pub_semver/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright 2014, the Dart project authors.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Google LLC nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
107 changes: 107 additions & 0 deletions pkgs/pub_semver/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
[![Dart CI](https://github.com/dart-lang/pub_semver/actions/workflows/test-package.yml/badge.svg)](https://github.com/dart-lang/pub_semver/actions/workflows/test-package.yml)
[![Pub](https://img.shields.io/pub/v/pub_semver.svg)](https://pub.dev/packages/pub_semver)
[![package publisher](https://img.shields.io/pub/publisher/pub_semver.svg)](https://pub.dev/packages/pub_semver/publisher)

Handles version numbers and version constraints in the same way that [pub][]
does.

## Semantics

The semantics here very closely follow the
[Semantic Versioning spec version 2.0.0-rc.1][semver]. It differs from semver
in a few corner cases:

* **Version ordering does take build suffixes into account.** This is unlike
semver 2.0.0 but like earlier versions of semver. Version `1.2.3+1` is
considered a lower number than `1.2.3+2`.

Since a package may have published multiple versions that differ only by
build suffix, pub still has to pick one of them *somehow*. Semver leaves
that issue unresolved, so we just say that build numbers are sorted like
pre-release suffixes.

* **Pre-release versions are excluded from most max ranges.** Let's say a
user is depending on "foo" with constraint `>=1.0.0 <2.0.0` and that "foo"
has published these versions:

* `1.0.0`
* `1.1.0`
* `1.2.0`
* `2.0.0-alpha`
* `2.0.0-beta`
* `2.0.0`
* `2.1.0`

Versions `2.0.0` and `2.1.0` are excluded by the constraint since neither
matches `<2.0.0`. However, since semver specifies that pre-release versions
are lower than the non-prerelease version (i.e. `2.0.0-beta < 2.0.0`, then
the `<2.0.0` constraint does technically allow those.

But that's almost never what the user wants. If their package doesn't work
with foo `2.0.0`, it's certainly not likely to work with experimental,
unstable versions of `2.0.0`'s API, which is what pre-release versions
represent.

To handle that, `<` version ranges don't allow pre-release versions of the
maximum unless the max is itself a pre-release, or the min is a pre-release
of the same version. In other words, a `<2.0.0` constraint will prohibit not
just `2.0.0` but any pre-release of `2.0.0`. However, `<2.0.0-beta` will
exclude `2.0.0-beta` but allow `2.0.0-alpha`. Likewise, `>2.0.0-alpha
<2.0.0` will exclude `2.0.0-alpha` but allow `2.0.0-beta`.

* **Pre-release versions are avoided when possible.** The above case
handles pre-release versions at the top of the range, but what about in
the middle? What if "foo" has these versions:

* `1.0.0`
* `1.2.0-alpha`
* `1.2.0`
* `1.3.0-experimental`

When a number of versions are valid, pub chooses the best one where "best"
usually means "highest numbered". That follows the user's intuition that,
all else being equal, they want the latest and greatest. Here, that would
mean `1.3.0-experimental`. However, most users don't want to use unstable
versions of their dependencies.

We want pre-releases to be explicitly opt-in so that package consumers
don't get unpleasant surprises and so that package maintainers are free to
put out pre-releases and get feedback without dragging all of their users
onto the bleeding edge.

To accommodate that, when pub is choosing a version, it uses *priority*
order which is different from strict comparison ordering. Any stable
version is considered higher priority than any unstable version. The above
versions, in priority order, are:

* `1.2.0-alpha`
* `1.3.0-experimental`
* `1.0.0`
* `1.2.0`

This ensures that users only end up with an unstable version when there are
no alternatives. Usually this means they've picked a constraint that
specifically selects that unstable version -- they've deliberately opted
into it.

* **There is a notion of compatibility between pre-1.0.0 versions.** Semver
deems all pre-1.0.0 versions to be incompatible. This means that the only
way to ensure compatibility when depending on a pre-1.0.0 package is to
pin the dependency to an exact version. Pinned version constraints prevent
automatic patch and pre-release updates. To avoid this situation, pub
defines the "next breaking" version as the version which increments the
major version if it's greater than zero, and the minor version otherwise,
resets subsequent digits to zero, and strips any pre-release or build
suffix. For example, here are some versions along with their next breaking
ones:

`0.0.3` -> `0.1.0`
`0.7.2-alpha` -> `0.8.0`
`1.2.3` -> `2.0.0`

To make use of this, pub defines a "^" operator which yields a version
constraint greater than or equal to a given version, but less than its next
breaking one.

[pub]: https://pub.dev
[semver]: https://semver.org/spec/v2.0.0-rc.1.html
Loading

0 comments on commit 8e698ea

Please sign in to comment.