Safe Haskell	None

Data.SemVer

Contents

Version
Delimiters

Description

An implementation of the Semantic Versioning specification located at http://semver.org.

A canonical Version type and functions representing behaviour as outlined in the specification are defined alongside additional lenses, common manipulations, and serialisation primitives.

Synopsis

Version

data Identifier Source

A type representing an individual identifier from the release or metadata components of a Version.

The Ord instance implements precedence according to the semantic version specification, with numeric identifiers being of lower precedence than textual identifiers, otherwise lexicographic ordering is used.

Constructors

INum !Int
IText !Text

Instances

Eq Identifier
Ord Identifier
Read Identifier
Show Identifier
Typeable Identifier
IsString Identifier
Generic Identifier
NFData Identifier

data Version Source

A type representing a successfully decoded or constructed semantic version.

The Eq instance represents exhaustive equality with all components considered.
The Ord instance implements the precedence rules from the semantic version specification with metadata (_versionMeta) being ignored.

Constructors

Version
Fields _versionMajor :: !Int The major version component. _versionMinor :: !Int The minor version component. _versionPatch :: !Int The patch level component. _versionRelease :: [Identifier] A (potentially empty) list of release identifiers. _versionMeta :: [Identifier] A (potentially empty) list of metadata.

Instances

Eq Version
Ord Version
Read Version
Show Version
Typeable Version
Generic Version
NFData Version

defaultVersion :: Version Source

A default Version which can be used to signify initial development.

Note: Equivalent to 0.0.0

Lenses

versionMajor :: Functor f => (Int -> f Int) -> Version -> f Version Source

versionMinor :: Functor f => (Int -> f Int) -> Version -> f Version Source

versionPatch :: Functor f => (Int -> f Int) -> Version -> f Version Source

versionRelease :: Functor f => ([Identifier] -> f [Identifier]) -> Version -> f Version Source

versionMeta :: Functor f => ([Identifier] -> f [Identifier]) -> Version -> f Version Source

Incrementing

incrementMajor :: Version -> Version Source

Increment the major component of a Version by 1, resetting the minor and patch components.

Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.
It MAY include minor and patch level changes.
Patch and minor version MUST be reset to 0 when major version is incremented.

incrementMinor :: Version -> Version Source

Increment the minor component of a Version by 1, resetting the patch component.

Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API.
It MUST be incremented if any public API functionality is marked as deprecated.
It MAY be incremented if substantial new functionality or improvements are introduced within the private code.
It MAY include patch level changes.
Patch version MUST be reset to 0 when minor version is incremented.

incrementPatch :: Version -> Version Source

Increment the patch component of a Version by 1.

Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced.
A bug fix is defined as an internal change that fixes incorrect behavior.

Predicates

isDevelopment :: Version -> Bool Source

Check if the Version is considered unstable.

Major version zero (0.y.z) is for initial development.
Anything may change at any time.
The public API should not be considered stable.

isPublic :: Version -> Bool Source

Check if the Version is considered stable.

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

Encoding

toString :: Version -> String Source

Convert a Version to it's readable String representation.

Note: This is optimised for cases where you wish to use a String and as such is faster than the semantically equivalent unpack . toLazyText.

toText :: Version -> Text Source

Convert a Version to a strict Text representation.

Note: Equivalent to toStrict . toLazyText

toLazyText :: Version -> Text Source

Convert a Version to a Text representation.

Note: This uses a lower Builder buffer size optimised for commonly found version formats. If you have particuarly long version numbers using toBuilder and toLazyTextWith to control the buffer size is recommended.

toBuilder :: Version -> Builder Source

Convert a Version to a Builder.

Decoding

fromText :: Text -> Either String Version Source

Parse a Version from Text, returning an attoparsec error message in the Left case on failure.

fromLazyText :: Text -> Either String Version Source

Parse a Version from Text, returning an attoparsec error message in the Left case on failure.

Note: The underlying attoparsec Parser is based on Text and this is equivalent to fromText . toStrict

parser :: Parser Version Source

A greedy attoparsec Parser which requires the entire Text input to match.

Delimiters

data Delimiters Source

A set of delimiters used to encode/decode a Version and specifyc alternative serialisation strategies.

Example: using alpha characters to encode the version as a valid DNS CNAME, such as:

 let Right v = fromText 1.2.3+40
 let alpha   = Delimiters 'm' 'p' 'r' 'd' 'i'

Data.Text.Lazy.Builder.toLazyText (app01-  toDelimitedBuilder alpha v  .dmz.internal)

Would result in the following Text:

 app01-1m2p3d40.dmz.internal

Using the same Delimiters set with delimitedParser would ensure correct decoding behaviour.

Constructors

Delimiters
Fields _delimMinor :: !Char _delimPatch :: !Char _delimRelease :: !Char _delimMeta :: !Char _delimIdent :: !Char

Instances

Eq Delimiters
Ord Delimiters
Read Delimiters
Show Delimiters
Typeable Delimiters
Generic Delimiters
NFData Delimiters

defaultDelimiters :: Delimiters Source

The default set of delimiters used in the semantic version specification.

Example: Given exhaustive version components would result in the following hypothetical version:

 1.2.3-alpha.1+sha.exp.12ab3d9

Lenses

delimMinor :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters Source

delimPatch :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters Source

delimRelease :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters Source

delimMeta :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters Source

delimIdent :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters Source

Encoding

toDelimitedBuilder :: Delimiters -> Version -> Builder Source

Convert a Version to a Builder using the specified Delimiters set.

Decoding

delimitedParser :: Delimiters -> Parser Version Source

A greedy attoparsec Parser using the specified Delimiters set which requires the entire Text input to match.