Версия

Функции для парсинга и сопоставления версий с требованиями.

Версия — это строка в определённом формате или Version, сгенерированная после парсинга через Version.parse/1.

Version парсинг и требования следуют схеме SemVer 2.0.

Версии

Вкратце, версия представлена тремя числами:

MAJOR.MINOR.PATCH

Предварительные версии поддерживаются добавлением -[0-9A-Za-z-\.]:

"1.0.0-alpha.3"

Информация о сборке может быть добавлена добавлением +[0-9A-Za-z-\.]:

"1.0.0-alpha.3+20130417140000"

Структура

Версия представлена структурой Version, и поля названы согласно SemVer: :major, :minor, :patch, :pre, и :build.

Требования

Требования позволяют указать, какие версии заданной зависимости вы готовы использовать. Требования поддерживают общие операторы, такие как >=, <=, >, ==, и аналогичные, работающие так, как ожидается:

# Only version 2.0.0
"== 2.0.0"

# Anything later than 2.0.0
"> 2.0.0"

Требования также поддерживают and и or для сложных условий:

# 2.0.0 and later until 2.1.0
">= 2.0.0 and < 2.1.0"

Поскольку пример выше является распространённым требованием, он может быть выражен как:

"~> 2.0.0"

~> никогда не будет включать предварительные версии своего верхнего предела. Также может быть использован для установки верхнего предела только для основной части версии. См. таблицу ниже для ~> требований и их соответствующего перевода.

Когда allow_pre: false установлено, требование не будет соответствовать предварительной версии, если операнд не является предварительной версией. По умолчанию предварительные версии всегда разрешены, но обратите внимание, что в Hex :allow_pre установлено в false. См. таблицу ниже для примеров.

Обзор

Типы

build()

major()

matchable()

minor()

patch()

pre()

requirement()

t()

version()

Функции

compare(version1, version2)

Сравнивает две версии

compile_requirement(req)

Компилирует требование в его внутреннее представление с помощью :ets.match_spec_compile/1 для более быстрого сопоставления

match?(version, requirement, opts \\ [])

Проверяет, соответствует ли заданная версия спецификации

parse!(string)

Парсит строку версии в Version

parse(string)

Парсит строку версии в структуру Version

parse_requirement(string)

Парсит строку требования версии в структуру Version.Requirement

Типы

build()

build() :: String.t() | nil

major()

major() :: String.t() | non_neg_integer()

matchable()

matchable() ::
  {major :: major(), minor :: minor(), patch :: patch(), pre :: pre(),
   build_parts :: [String.t()]}

minor()

minor() :: non_neg_integer() | nil

patch()

patch() :: non_neg_integer() | nil

pre()

pre() :: [String.t() | non_neg_integer()]

requirement()

requirement() :: String.t() | Version.Requirement.t()

t()

t() :: %Version{
  build: build(),
  major: major(),
  minor: minor(),
  patch: patch(),
  pre: pre()
}

version()

version() :: String.t() | t()

Функции

compare(version1, version2)

compare(version(), version()) :: :gt | :eq | :lt

Сравнивает две версии.

Возвращает :gt если первая версия больше второй, и :lt в обратном случае. Если версии равны, возвращается :eq.

Предварительные релизы строго меньше соответствующих релизов.

Разделы патчей сравниваются лексикографически, если они алфавитно-цифровые, и численно в противном случае.

Разделы сборки игнорируются: если две версии различаются только разделом сборки, они считаются равными.

Возникает исключение Version.InvalidVersionError, если какая-либо из двух заданных версий не может быть обработана. Если передана уже обработанная версия, данная функция не вызовет исключения.

Примеры

iex> Version.compare("2.0.1-alpha1", "2.0.0")
:gt

iex> Version.compare("1.0.0-beta", "1.0.0-rc1")
:lt

iex> Version.compare("1.0.0-10", "1.0.0-2")
:gt

iex> Version.compare("2.0.1+build0", "2.0.1")
:eq

iex> Version.compare("invalid", "2.0.1")
** (Version.InvalidVersionError) invalid version: "invalid"

compile_requirement(req)

compile_requirement(Version.Requirement.t()) :: Version.Requirement.t()

Компилирует требование к его внутренней форме с использованием :ets.match_spec_compile/1 для более быстрого сопоставления.

Внутренняя форма неявная и не может быть преобразована во внешнюю форму и обратно без потери свойств (что означает, что она не может быть отправлена ​​процессу на другом узле и оставаться допустимым скомпилированным match_spec, и ее нельзя хранить на диске).

match?(version, requirement, opts \\ [])

match?(version(), requirement(), keyword()) :: boolean()

Проверяет, соответствует ли данная версия спецификации.

Возвращает true если version удовлетворяет requirement, в противном случае false. Возникает исключение Version.InvalidRequirementError, если requirement не может быть обработано, или исключение Version.InvalidVersionError, если version не может быть обработано. Если переданы уже обработанные версия и требование, данная функция не вызовет исключения.

Параметры

• :allow_pre (логическое значение) - когда false, предварительные версии не будут соответствовать, если операнд не является предварительной версией. Примеры см. в таблице выше. По умолчанию true.

Примеры

iex> Version.match?("2.0.0", "> 1.0.0")
true

iex> Version.match?("2.0.0", "== 1.0.0")
false

iex> Version.match?("foo", "== 1.0.0")
** (Version.InvalidVersionError) invalid version: "foo"

iex> Version.match?("2.0.0", "== == 1.0.0")
** (Version.InvalidRequirementError) invalid requirement: "== == 1.0.0"

parse!(string)

parse!(String.t()) :: t() | no_return()

Парсит строку версии в Version.

Если string является некорректной версией, возникает InvalidVersionError.

Примеры

iex> Version.parse!("2.0.1-alpha1")
#Version<2.0.1-alpha1>

iex> Version.parse!("2.0-alpha1")
** (Version.InvalidVersionError) invalid version: "2.0-alpha1"

parse(string)

parse(String.t()) :: {:ok, t()} | :error

Парсит строку версии в структуру Version.

Примеры

iex> {:ok, version} = Version.parse("2.0.1-alpha1")
iex> version
#Version<2.0.1-alpha1>

iex> Version.parse("2.0-alpha1")
:error

parse_requirement(string)

parse_requirement(String.t()) :: {:ok, Version.Requirement.t()} | :error

Парсит строку требования версии в структуру Version.Requirement.

Примеры

iex> {:ok, requirement} = Version.parse_requirement("== 2.0.1")
iex> requirement
#Version.Requirement<== 2.0.1>

iex> Version.parse_requirement("== == 2.0.1")
:error