{-# LANGUAGE CPP                #-}
{-# LANGUAGE DeriveAnyClass     #-}
{-# LANGUAGE DeriveGeneric      #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE OverloadedStrings  #-}
{-# LANGUAGE Rank2Types         #-}

-- |
-- Module    : Data.Versions
-- Copyright : (c) Colin Woodbury, 2015 - 2022
-- License   : BSD3
-- Maintainer: Colin Woodbury <colin@fosskers.ca>
--
-- A library for parsing and comparing software version numbers.
--
-- We like to give version numbers to our software in a myriad of different
-- ways. Some ways follow strict guidelines for incrementing and comparison.
-- Some follow conventional wisdom and are generally self-consistent. Some are
-- just plain asinine. This library provides a means of parsing and comparing
-- /any/ style of versioning, be it a nice Semantic Version like this:
--
-- > 1.2.3-r1+git123
--
-- ...or a monstrosity like this:
--
-- > 2:10.2+0.0093r3+1-1
--
-- Please switch to <http://semver.org Semantic Versioning> if you aren't
-- currently using it. It provides consistency in version incrementing and has
-- the best constraints on comparisons.
--
-- __This library implements version @2.0.0@ of the SemVer spec.__
--
-- == Using the Parsers
-- In general, `versioning` is the function you want. It attempts to parse a
-- given `Text` using the three individual parsers, `semver`, `version` and
-- `mess`. If one fails, it tries the next. If you know you only want to parse
-- one specific version type, use that parser directly (e.g. `semver`).

module Data.Versions
  ( -- * Types
    Versioning(..), isIdeal, isGeneral, isComplex
  , SemVer(..)
  , PVP(..)
  , Version(..)
  , Mess(..), messMajor, messMinor, messPatch, messPatchChunk
  , MChunk(..)
  , VUnit(..), digits, str
  , VChunk
  , VSep(..)
    -- * Parsing Versions
  , ParsingError
  , versioning, semver, pvp, version, mess
    -- ** Megaparsec Parsers
    -- | For when you'd like to mix version parsing into some larger parser.
  , versioning', semver', pvp', version', mess'
    -- * Pretty Printing
  , prettyV, prettySemVer, prettyPVP, prettyVer, prettyMess, errorBundlePretty
    -- * Lenses
  , Lens'
  , Traversal'
  , Semantic(..)
    -- ** Traversing Text
    -- | When traversing `Text`, leveraging its `Semantic` instance will
    -- likely benefit you more than using these Traversals directly.
  , _Versioning, _SemVer, _Version, _Mess
    -- ** Versioning Traversals
  , _Ideal, _General, _Complex
    -- ** (General) Version Lenses
  , epoch
    -- ** Misc. Lenses / Traversals
  , _Digits, _Str
  ) where

import qualified Control.Applicative.Combinators.NonEmpty as PC
import           Control.DeepSeq
import           Control.Monad (void)
import           Data.Bool (bool)
import           Data.Char (isAlpha, isAlphaNum)
import           Data.Foldable (fold)
import           Data.Hashable (Hashable)
import           Data.List (intersperse)
import           Data.List.NonEmpty (NonEmpty(..))
import qualified Data.List.NonEmpty as NEL
import           Data.Maybe (fromMaybe)
import           Data.Text (Text)
import qualified Data.Text as T
import           Data.Void (Void)
import           GHC.Generics (Generic)
import           Text.Megaparsec hiding (chunk)
import           Text.Megaparsec.Char
import qualified Text.Megaparsec.Char.Lexer as L

#if !MIN_VERSION_base(4,11,0)
import           Data.Semigroup
#endif

---

-- | A top-level Versioning type. Acts as a wrapper for the more specific types.
-- This allows each subtype to have its own parser, and for said parsers to be
-- composed. This is useful for specifying custom behaviour for when a certain
-- parser fails.
data Versioning = Ideal SemVer | General Version | Complex Mess
  deriving (Versioning -> Versioning -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Versioning -> Versioning -> Bool
$c/= :: Versioning -> Versioning -> Bool
== :: Versioning -> Versioning -> Bool
$c== :: Versioning -> Versioning -> Bool
Eq, Int -> Versioning -> ShowS
[Versioning] -> ShowS
Versioning -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Versioning] -> ShowS
$cshowList :: [Versioning] -> ShowS
show :: Versioning -> String
$cshow :: Versioning -> String
showsPrec :: Int -> Versioning -> ShowS
$cshowsPrec :: Int -> Versioning -> ShowS
Show, forall x. Rep Versioning x -> Versioning
forall x. Versioning -> Rep Versioning x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Versioning x -> Versioning
$cfrom :: forall x. Versioning -> Rep Versioning x
Generic, Versioning -> ()
forall a. (a -> ()) -> NFData a
rnf :: Versioning -> ()
$crnf :: Versioning -> ()
NFData, Eq Versioning
Int -> Versioning -> Int
Versioning -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: Versioning -> Int
$chash :: Versioning -> Int
hashWithSalt :: Int -> Versioning -> Int
$chashWithSalt :: Int -> Versioning -> Int
Hashable)

-- | Short-hand for detecting a `SemVer`.
isIdeal :: Versioning -> Bool
isIdeal :: Versioning -> Bool
isIdeal (Ideal SemVer
_) = Bool
True
isIdeal Versioning
_         = Bool
False

-- | Short-hand for detecting a `Version`.
isGeneral :: Versioning -> Bool
isGeneral :: Versioning -> Bool
isGeneral (General Version
_) = Bool
True
isGeneral Versioning
_           = Bool
False

-- | Short-hand for detecting a `Mess`.
isComplex :: Versioning -> Bool
isComplex :: Versioning -> Bool
isComplex (Complex Mess
_) = Bool
True
isComplex Versioning
_           = Bool
False

-- | Comparison of @Ideal@s is always well defined.
--
-- If comparison of @General@s is well-defined, then comparison of @Ideal@ and
-- @General@ is well-defined, as there exists a perfect mapping from @Ideal@ to
-- @General@.
--
-- If comparison of @Complex@es is well-defined, then comparison of @General@
-- and @Complex@ is well defined for the same reason. This implies comparison of
-- @Ideal@ and @Complex@ is also well-defined.
instance Ord Versioning where
  compare :: Versioning -> Versioning -> Ordering
compare (Ideal SemVer
s)     (Ideal SemVer
s')   = forall a. Ord a => a -> a -> Ordering
compare SemVer
s SemVer
s'
  compare (General Version
v)   (General Version
v') = forall a. Ord a => a -> a -> Ordering
compare Version
v Version
v'
  compare (Complex Mess
m)   (Complex Mess
m') = forall a. Ord a => a -> a -> Ordering
compare Mess
m Mess
m'
  compare (Ideal SemVer
s)     (General Version
v)  = forall a. Ord a => a -> a -> Ordering
compare (SemVer -> Version
vFromS SemVer
s) Version
v
  compare (General Version
v)   (Ideal SemVer
s)    = Ordering -> Ordering
opposite forall a b. (a -> b) -> a -> b
$ forall a. Ord a => a -> a -> Ordering
compare (SemVer -> Version
vFromS SemVer
s) Version
v
  compare (General Version
v)   (Complex Mess
m)  = forall a. Ord a => a -> a -> Ordering
compare (Version -> Mess
mFromV Version
v) Mess
m
  compare (Complex Mess
m)   (General Version
v)  = Ordering -> Ordering
opposite forall a b. (a -> b) -> a -> b
$ forall a. Ord a => a -> a -> Ordering
compare (Version -> Mess
mFromV Version
v) Mess
m
  compare (Ideal SemVer
s)     (Complex Mess
m)  = SemVer -> Mess -> Ordering
semverAndMess SemVer
s Mess
m
  compare (Complex Mess
m) (Ideal SemVer
s)      = Ordering -> Ordering
opposite forall a b. (a -> b) -> a -> b
$ SemVer -> Mess -> Ordering
semverAndMess SemVer
s Mess
m

-- | Convert a `SemVer` to a `Version`.
vFromS :: SemVer -> Version
vFromS :: SemVer -> Version
vFromS (SemVer Word
ma Word
mi Word
pa [VChunk]
re Maybe Text
me) =
  Version
  { _vEpoch :: Maybe Word
_vEpoch = forall a. Maybe a
Nothing
  , _vChunks :: NonEmpty VChunk
_vChunks = (Word -> VUnit
Digits Word
ma forall a. a -> [a] -> NonEmpty a
:| []) forall a. a -> [a] -> NonEmpty a
:| [Word -> VUnit
Digits Word
mi forall a. a -> [a] -> NonEmpty a
:| [], Word -> VUnit
Digits Word
pa forall a. a -> [a] -> NonEmpty a
:| []]
  , _vMeta :: Maybe Text
_vMeta = Maybe Text
me
  , _vRel :: [VChunk]
_vRel = [VChunk]
re }

-- | Convert a `Version` to a `Mess`.
mFromV :: Version -> Mess
mFromV :: Version -> Mess
mFromV (Version Maybe Word
e NonEmpty VChunk
v [VChunk]
r Maybe Text
m) = forall b a. b -> (a -> b) -> Maybe a -> b
maybe Mess
affix (\Word
a -> NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (Word -> Text -> MChunk
MDigit Word
a (forall a. Show a => a -> Text
showt Word
a) forall a. a -> [a] -> NonEmpty a
:| []) forall a b. (a -> b) -> a -> b
$ forall a. a -> Maybe a
Just (VSep
VColon, Mess
affix)) Maybe Word
e
  where
    affix :: Mess
    affix :: Mess
affix = NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (forall (t :: * -> *). Functor t => t VChunk -> t MChunk
chunksAsM NonEmpty VChunk
v) Maybe (VSep, Mess)
m'

    m' :: Maybe (VSep, Mess)
    m' :: Maybe (VSep, Mess)
m' = case Maybe Text
m of
      Maybe Text
Nothing  -> Maybe (VSep, Mess)
r'
      Just Text
m'' -> forall a. a -> Maybe a
Just (VSep
VPlus, NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (Text -> MChunk
MPlain Text
m'' forall a. a -> [a] -> NonEmpty a
:| []) Maybe (VSep, Mess)
r')

    r' :: Maybe (VSep, Mess)
    r' :: Maybe (VSep, Mess)
r' = case forall a. [a] -> Maybe (NonEmpty a)
NEL.nonEmpty [VChunk]
r of
      Maybe (NonEmpty VChunk)
Nothing  -> forall a. Maybe a
Nothing
      Just NonEmpty VChunk
r'' -> forall a. a -> Maybe a
Just (VSep
VHyphen, NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (forall (t :: * -> *). Functor t => t VChunk -> t MChunk
chunksAsM NonEmpty VChunk
r'') forall a. Maybe a
Nothing)


-- | Special logic for when semver-like values can be extracted from a `Mess`.
-- This avoids having to "downcast" the `SemVer` into a `Mess` before comparing,
-- and in some cases can offer better comparison results.
semverAndMess :: SemVer -> Mess -> Ordering
semverAndMess :: SemVer -> Mess -> Ordering
semverAndMess s :: SemVer
s@(SemVer Word
ma Word
mi Word
pa [VChunk]
_ Maybe Text
_) Mess
m = case forall a. Ord a => a -> a -> Ordering
compare Word
ma forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mess -> Maybe Word
messMajor Mess
m of
  Maybe Ordering
Nothing -> Ordering
fallback
  Just Ordering
LT -> Ordering
LT
  Just Ordering
GT -> Ordering
GT
  Just Ordering
EQ -> case forall a. Ord a => a -> a -> Ordering
compare Word
mi forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mess -> Maybe Word
messMinor Mess
m of
    Maybe Ordering
Nothing -> Ordering
fallback
    Just Ordering
LT -> Ordering
LT
    Just Ordering
GT -> Ordering
GT
    Just Ordering
EQ -> case forall a. Ord a => a -> a -> Ordering
compare Word
pa forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mess -> Maybe Word
messPatch Mess
m of
      Just Ordering
LT -> Ordering
LT
      Just Ordering
GT -> Ordering
GT
      -- If they've been equal up to this point, the `Mess`
      -- will by definition have more to it, meaning that
      -- it's more likely to be newer, despite its poor shape.
      Just Ordering
EQ -> Ordering
fallback
      Maybe Ordering
Nothing -> case Mess -> Maybe VChunk
messPatchChunk Mess
m of
        Maybe VChunk
Nothing             -> Ordering
fallback
        Just (Digits Word
pa':|[VUnit]
_) -> case forall a. Ord a => a -> a -> Ordering
compare Word
pa Word
pa' of
          Ordering
LT -> Ordering
LT
          Ordering
GT -> Ordering
GT
          Ordering
EQ -> Ordering
GT  -- This follows semver's rule!
        Just VChunk
_ -> Ordering
fallback
  where
    fallback :: Ordering
    fallback :: Ordering
fallback = forall a. Ord a => a -> a -> Ordering
compare (Version -> Versioning
General forall a b. (a -> b) -> a -> b
$ SemVer -> Version
vFromS SemVer
s) (Mess -> Versioning
Complex Mess
m)

instance Semantic Versioning where
  major :: Traversal' Versioning Word
major Word -> f Word
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
major Word -> f Word
f SemVer
v
  major Word -> f Word
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
major Word -> f Word
f Version
v
  major Word -> f Word
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
major Word -> f Word
f Mess
v
  {-# INLINE major #-}

  minor :: Traversal' Versioning Word
minor Word -> f Word
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
minor Word -> f Word
f SemVer
v
  minor Word -> f Word
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
minor Word -> f Word
f Version
v
  minor Word -> f Word
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
minor Word -> f Word
f Mess
v
  {-# INLINE minor #-}

  patch :: Traversal' Versioning Word
patch Word -> f Word
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
patch Word -> f Word
f SemVer
v
  patch Word -> f Word
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
patch Word -> f Word
f Version
v
  patch Word -> f Word
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v Word
patch Word -> f Word
f Mess
v
  {-# INLINE patch #-}

  release :: Traversal' Versioning [VChunk]
release [VChunk] -> f [VChunk]
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v [VChunk]
release [VChunk] -> f [VChunk]
f SemVer
v
  release [VChunk] -> f [VChunk]
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v [VChunk]
release [VChunk] -> f [VChunk]
f Version
v
  release [VChunk] -> f [VChunk]
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v [VChunk]
release [VChunk] -> f [VChunk]
f Mess
v
  {-# INLINE release #-}

  meta :: Traversal' Versioning (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f SemVer
v
  meta Maybe Text -> f (Maybe Text)
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f Version
v
  meta Maybe Text -> f (Maybe Text)
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f Mess
v
  {-# INLINE meta #-}

  semantic :: Traversal' Versioning SemVer
semantic SemVer -> f SemVer
f (Ideal SemVer
v)   = SemVer -> Versioning
Ideal   forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v SemVer
semantic SemVer -> f SemVer
f SemVer
v
  semantic SemVer -> f SemVer
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v SemVer
semantic SemVer -> f SemVer
f Version
v
  semantic SemVer -> f SemVer
f (Complex Mess
v) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. Semantic v => Traversal' v SemVer
semantic SemVer -> f SemVer
f Mess
v
  {-# INLINE semantic #-}

-- | Traverse some Text for its inner versioning.
--
-- @
-- λ "1.2.3" & _Versioning . _Ideal . patch %~ (+ 1)  -- or just: "1.2.3" & patch %~ (+ 1)
-- "1.2.4"
-- @
_Versioning :: Traversal' Text Versioning
_Versioning :: Traversal' Text Versioning
_Versioning Versioning -> f Versioning
f Text
t = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (forall a b. a -> b -> a
const (forall (f :: * -> *) a. Applicative f => a -> f a
pure Text
t)) (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Versioning -> Text
prettyV forall b c a. (b -> c) -> (a -> b) -> a -> c
. Versioning -> f Versioning
f) forall a b. (a -> b) -> a -> b
$ Text -> Either ParsingError Versioning
versioning Text
t
{-# INLINE _Versioning #-}

-- | Traverse some Text for its inner SemVer.
_SemVer :: Traversal' Text SemVer
_SemVer :: Traversal' Text SemVer
_SemVer SemVer -> f SemVer
f Text
t = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (forall a b. a -> b -> a
const (forall (f :: * -> *) a. Applicative f => a -> f a
pure Text
t)) (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap SemVer -> Text
prettySemVer forall b c a. (b -> c) -> (a -> b) -> a -> c
. SemVer -> f SemVer
f) forall a b. (a -> b) -> a -> b
$ Text -> Either ParsingError SemVer
semver Text
t
{-# INLINE _SemVer #-}

-- | Traverse some Text for its inner Version.
_Version :: Traversal' Text Version
_Version :: Traversal' Text Version
_Version Version -> f Version
f Text
t = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (forall a b. a -> b -> a
const (forall (f :: * -> *) a. Applicative f => a -> f a
pure Text
t)) (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Version -> Text
prettyVer forall b c a. (b -> c) -> (a -> b) -> a -> c
. Version -> f Version
f) forall a b. (a -> b) -> a -> b
$ Text -> Either ParsingError Version
version Text
t
{-# INLINE _Version #-}

-- | Traverse some Text for its inner Mess.
_Mess :: Traversal' Text Mess
_Mess :: Traversal' Text Mess
_Mess Mess -> f Mess
f Text
t = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (forall a b. a -> b -> a
const (forall (f :: * -> *) a. Applicative f => a -> f a
pure Text
t)) (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Mess -> Text
prettyMess forall b c a. (b -> c) -> (a -> b) -> a -> c
. Mess -> f Mess
f) forall a b. (a -> b) -> a -> b
$ Text -> Either ParsingError Mess
mess Text
t
{-# INLINE _Mess #-}

-- | Possibly extract a `SemVer` from a `Versioning`.
_Ideal :: Traversal' Versioning SemVer
_Ideal :: Traversal' Versioning SemVer
_Ideal SemVer -> f SemVer
f (Ideal SemVer
s) = SemVer -> Versioning
Ideal forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> SemVer -> f SemVer
f SemVer
s
_Ideal SemVer -> f SemVer
_ Versioning
v         = forall (f :: * -> *) a. Applicative f => a -> f a
pure Versioning
v
{-# INLINE _Ideal #-}

-- | Possibly extract a `Version` from a `Versioning`.
_General :: Traversal' Versioning Version
_General :: Traversal' Versioning Version
_General Version -> f Version
f (General Version
v) = Version -> Versioning
General forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Version -> f Version
f Version
v
_General Version -> f Version
_ Versioning
v           = forall (f :: * -> *) a. Applicative f => a -> f a
pure Versioning
v
{-# INLINE _General #-}

-- | Possibly extract a `Mess` from a `Versioning`.
_Complex :: Traversal' Versioning Mess
_Complex :: Traversal' Versioning Mess
_Complex Mess -> f Mess
f (Complex Mess
m) = Mess -> Versioning
Complex forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mess -> f Mess
f Mess
m
_Complex Mess -> f Mess
_ Versioning
v           = forall (f :: * -> *) a. Applicative f => a -> f a
pure Versioning
v
{-# INLINE _Complex #-}

-- | Simple Lenses compatible with both lens and microlens.
type Lens' s a = forall f. Functor f => (a -> f a) -> s -> f s

-- | Simple Traversals compatible with both lens and microlens.
type Traversal' s a = forall f. Applicative f => (a -> f a) -> s -> f s

-- | Version types which sanely and safely yield `SemVer`-like information about
-- themselves. For instances other than `SemVer` itself however, these optics
-- may /not/ yield anything, depending on the actual value being traversed.
-- Hence, the optics here are all `Traversal'`s.
--
-- Consider the `Version` @1.2.3.4.5@. We can imagine wanting to increment the
-- minor number:
--
-- @
-- λ "1.2.3.4.5" & minor %~ (+ 1)
-- "1.3.3.4.5"
-- @
--
-- But of course something like this would fail:
--
-- @
-- λ "1.e.3.4.5" & minor %~ (+ 1)
-- "1.e.3.4.5"
-- @
--
-- However!
--
-- @
-- λ "1.e.3.4.5" & major %~ (+ 1)
-- "2.e.3.4.5"
-- @
class Semantic v where
  -- | @MAJOR.minor.patch-prerel+meta@
  major    :: Traversal' v Word
  -- | @major.MINOR.patch-prerel+meta@
  minor    :: Traversal' v Word
  -- | @major.minor.PATCH-prerel+meta@
  patch    :: Traversal' v Word
  -- | @major.minor.patch-PREREL+meta@
  release  :: Traversal' v [VChunk]
  -- | @major.minor.patch-prerel+META@
  meta     :: Traversal' v (Maybe Text)
  -- | A Natural Transformation into an proper `SemVer`.
  semantic :: Traversal' v SemVer

instance Semantic Text where
  major :: Traversal' Text Word
major    = Traversal' Text Versioning
_Versioning forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall v. Semantic v => Traversal' v Word
major
  minor :: Traversal' Text Word
minor    = Traversal' Text Versioning
_Versioning forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall v. Semantic v => Traversal' v Word
minor
  patch :: Traversal' Text Word
patch    = Traversal' Text Versioning
_Versioning forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall v. Semantic v => Traversal' v Word
patch
  release :: Traversal' Text [VChunk]
release  = Traversal' Text Versioning
_Versioning forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall v. Semantic v => Traversal' v [VChunk]
release
  meta :: Traversal' Text (Maybe Text)
meta     = Traversal' Text Versioning
_Versioning forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall v. Semantic v => Traversal' v (Maybe Text)
meta
  semantic :: Traversal' Text SemVer
semantic = Traversal' Text SemVer
_SemVer

--------------------------------------------------------------------------------
-- (Ideal) SemVer

-- | An (Ideal) version number that conforms to Semantic Versioning.
-- This is a /prescriptive/ parser, meaning it follows the SemVer standard.
--
-- Legal semvers are of the form: MAJOR.MINOR.PATCH-PREREL+META
--
-- Example: @1.2.3-r1+commithash@
--
-- Extra Rules:
--
-- 1. Pre-release versions have /lower/ precedence than normal versions.
--
-- 2. Build metadata does not affect version precedence.
--
-- 3. PREREL and META strings may only contain ASCII alphanumerics and hyphens.
--
-- For more information, see http://semver.org
data SemVer = SemVer
  { SemVer -> Word
_svMajor  :: !Word
  , SemVer -> Word
_svMinor  :: !Word
  , SemVer -> Word
_svPatch  :: !Word
  , SemVer -> [VChunk]
_svPreRel :: ![VChunk]
  , SemVer -> Maybe Text
_svMeta   :: !(Maybe Text) }
  deriving stock (Int -> SemVer -> ShowS
[SemVer] -> ShowS
SemVer -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SemVer] -> ShowS
$cshowList :: [SemVer] -> ShowS
show :: SemVer -> String
$cshow :: SemVer -> String
showsPrec :: Int -> SemVer -> ShowS
$cshowsPrec :: Int -> SemVer -> ShowS
Show, forall x. Rep SemVer x -> SemVer
forall x. SemVer -> Rep SemVer x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SemVer x -> SemVer
$cfrom :: forall x. SemVer -> Rep SemVer x
Generic)
  deriving anyclass (SemVer -> ()
forall a. (a -> ()) -> NFData a
rnf :: SemVer -> ()
$crnf :: SemVer -> ()
NFData, Eq SemVer
Int -> SemVer -> Int
SemVer -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: SemVer -> Int
$chash :: SemVer -> Int
hashWithSalt :: Int -> SemVer -> Int
$chashWithSalt :: Int -> SemVer -> Int
Hashable)

-- | Two SemVers are equal if all fields except metadata are equal.
instance Eq SemVer where
  (SemVer Word
ma Word
mi Word
pa [VChunk]
pr Maybe Text
_) == :: SemVer -> SemVer -> Bool
== (SemVer Word
ma' Word
mi' Word
pa' [VChunk]
pr' Maybe Text
_) =
    (Word
ma,Word
mi,Word
pa,[VChunk]
pr) forall a. Eq a => a -> a -> Bool
== (Word
ma',Word
mi',Word
pa',[VChunk]
pr')

-- | Build metadata does not affect version precedence.
instance Ord SemVer where
  compare :: SemVer -> SemVer -> Ordering
compare (SemVer Word
ma Word
mi Word
pa [VChunk]
pr Maybe Text
_) (SemVer Word
ma' Word
mi' Word
pa' [VChunk]
pr' Maybe Text
_) =
    case forall a. Ord a => a -> a -> Ordering
compare (Word
ma,Word
mi,Word
pa) (Word
ma',Word
mi',Word
pa') of
     Ordering
LT -> Ordering
LT
     Ordering
GT -> Ordering
GT
     Ordering
EQ -> case ([VChunk]
pr,[VChunk]
pr') of
            ([],[]) -> Ordering
EQ
            ([],[VChunk]
_)  -> Ordering
GT
            ([VChunk]
_,[])  -> Ordering
LT
            ([VChunk], [VChunk])
_       -> forall a. Ord a => a -> a -> Ordering
compare [VChunk]
pr [VChunk]
pr'

instance Semigroup SemVer where
  SemVer Word
mj Word
mn Word
pa [VChunk]
p Maybe Text
m <> :: SemVer -> SemVer -> SemVer
<> SemVer Word
mj' Word
mn' Word
pa' [VChunk]
p' Maybe Text
m' =
    Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer (Word
mj forall a. Num a => a -> a -> a
+ Word
mj') (Word
mn forall a. Num a => a -> a -> a
+ Word
mn') (Word
pa forall a. Num a => a -> a -> a
+ Word
pa') ([VChunk]
p forall a. [a] -> [a] -> [a]
++ [VChunk]
p') (Maybe Text
m forall a. Semigroup a => a -> a -> a
<> Maybe Text
m')

instance Monoid SemVer where
  mempty :: SemVer
mempty = Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
0 Word
0 Word
0 [] forall a. Maybe a
Nothing

#if !MIN_VERSION_base(4,11,0)
  mappend = (<>)
#endif

instance Semantic SemVer where
  major :: Traversal' SemVer Word
major Word -> f Word
f SemVer
sv = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\Word
ma -> SemVer
sv { _svMajor :: Word
_svMajor = Word
ma }) (Word -> f Word
f forall a b. (a -> b) -> a -> b
$ SemVer -> Word
_svMajor SemVer
sv)
  {-# INLINE major #-}

  minor :: Traversal' SemVer Word
minor Word -> f Word
f SemVer
sv = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\Word
mi -> SemVer
sv { _svMinor :: Word
_svMinor = Word
mi }) (Word -> f Word
f forall a b. (a -> b) -> a -> b
$ SemVer -> Word
_svMinor SemVer
sv)
  {-# INLINE minor #-}

  patch :: Traversal' SemVer Word
patch Word -> f Word
f SemVer
sv = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\Word
pa -> SemVer
sv { _svPatch :: Word
_svPatch = Word
pa }) (Word -> f Word
f forall a b. (a -> b) -> a -> b
$ SemVer -> Word
_svPatch SemVer
sv)
  {-# INLINE patch #-}

  release :: Traversal' SemVer [VChunk]
release [VChunk] -> f [VChunk]
f SemVer
sv = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\[VChunk]
pa -> SemVer
sv { _svPreRel :: [VChunk]
_svPreRel = [VChunk]
pa }) ([VChunk] -> f [VChunk]
f forall a b. (a -> b) -> a -> b
$ SemVer -> [VChunk]
_svPreRel SemVer
sv)
  {-# INLINE release #-}

  meta :: Traversal' SemVer (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f SemVer
sv = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\Maybe Text
pa -> SemVer
sv { _svMeta :: Maybe Text
_svMeta = Maybe Text
pa }) (Maybe Text -> f (Maybe Text)
f forall a b. (a -> b) -> a -> b
$ SemVer -> Maybe Text
_svMeta SemVer
sv)
  {-# INLINE meta #-}

  semantic :: Traversal' SemVer SemVer
semantic = forall a b. (a -> b) -> a -> b
($)
  {-# INLINE semantic #-}

-- | A single unit of a Version. May be digits or a string of characters. Groups
-- of these are called `VChunk`s, and are the identifiers separated by periods
-- in the source.
data VUnit = Digits Word | Str Text
  deriving stock (VUnit -> VUnit -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: VUnit -> VUnit -> Bool
$c/= :: VUnit -> VUnit -> Bool
== :: VUnit -> VUnit -> Bool
$c== :: VUnit -> VUnit -> Bool
Eq, Int -> VUnit -> ShowS
[VUnit] -> ShowS
VUnit -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [VUnit] -> ShowS
$cshowList :: [VUnit] -> ShowS
show :: VUnit -> String
$cshow :: VUnit -> String
showsPrec :: Int -> VUnit -> ShowS
$cshowsPrec :: Int -> VUnit -> ShowS
Show, ReadPrec [VUnit]
ReadPrec VUnit
Int -> ReadS VUnit
ReadS [VUnit]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [VUnit]
$creadListPrec :: ReadPrec [VUnit]
readPrec :: ReadPrec VUnit
$creadPrec :: ReadPrec VUnit
readList :: ReadS [VUnit]
$creadList :: ReadS [VUnit]
readsPrec :: Int -> ReadS VUnit
$creadsPrec :: Int -> ReadS VUnit
Read, Eq VUnit
VUnit -> VUnit -> Bool
VUnit -> VUnit -> Ordering
VUnit -> VUnit -> VUnit
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: VUnit -> VUnit -> VUnit
$cmin :: VUnit -> VUnit -> VUnit
max :: VUnit -> VUnit -> VUnit
$cmax :: VUnit -> VUnit -> VUnit
>= :: VUnit -> VUnit -> Bool
$c>= :: VUnit -> VUnit -> Bool
> :: VUnit -> VUnit -> Bool
$c> :: VUnit -> VUnit -> Bool
<= :: VUnit -> VUnit -> Bool
$c<= :: VUnit -> VUnit -> Bool
< :: VUnit -> VUnit -> Bool
$c< :: VUnit -> VUnit -> Bool
compare :: VUnit -> VUnit -> Ordering
$ccompare :: VUnit -> VUnit -> Ordering
Ord, forall x. Rep VUnit x -> VUnit
forall x. VUnit -> Rep VUnit x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep VUnit x -> VUnit
$cfrom :: forall x. VUnit -> Rep VUnit x
Generic)
  deriving anyclass (VUnit -> ()
forall a. (a -> ()) -> NFData a
rnf :: VUnit -> ()
$crnf :: VUnit -> ()
NFData, Eq VUnit
Int -> VUnit -> Int
VUnit -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: VUnit -> Int
$chash :: VUnit -> Int
hashWithSalt :: Int -> VUnit -> Int
$chashWithSalt :: Int -> VUnit -> Int
Hashable)

instance Semigroup VUnit where
  Digits Word
n <> :: VUnit -> VUnit -> VUnit
<> Digits Word
m = Word -> VUnit
Digits forall a b. (a -> b) -> a -> b
$ Word
n forall a. Num a => a -> a -> a
+ Word
m
  Str Text
t    <> Str Text
s    = Text -> VUnit
Str forall a b. (a -> b) -> a -> b
$ Text
t forall a. Semigroup a => a -> a -> a
<> Text
s
  Digits Word
n <> VUnit
_        = Word -> VUnit
Digits Word
n
  VUnit
_        <> Digits Word
n = Word -> VUnit
Digits Word
n

instance Monoid VUnit where
  mempty :: VUnit
mempty = Text -> VUnit
Str Text
""

#if !MIN_VERSION_base(4,11,0)
  mappend = (<>)
#endif

-- | Smart constructor for a `VUnit` made of digits.
digits :: Word -> VUnit
digits :: Word -> VUnit
digits = Word -> VUnit
Digits

-- | Smart constructor for a `VUnit` made of letters.
str :: Text -> Maybe VUnit
str :: Text -> Maybe VUnit
str Text
t = forall a. a -> a -> Bool -> a
bool forall a. Maybe a
Nothing (forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Text -> VUnit
Str Text
t) forall a b. (a -> b) -> a -> b
$ (Char -> Bool) -> Text -> Bool
T.all Char -> Bool
isAlpha Text
t

-- | Possibly traverse the inner digit value of a `VUnit`.
_Digits :: Traversal' VUnit Word
_Digits :: Traversal' VUnit Word
_Digits Word -> f Word
f (Digits Word
i) = Word -> VUnit
Digits forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
i
_Digits Word -> f Word
_ VUnit
v          = forall (f :: * -> *) a. Applicative f => a -> f a
pure VUnit
v
{-# INLINE _Digits #-}

-- | Possibly traverse the inner text of a `VUnit`.
_Str :: Traversal' VUnit Text
_Str :: Traversal' VUnit Text
_Str Text -> f Text
f (Str Text
t) = Text -> VUnit
Str forall b c a. (b -> c) -> (a -> b) -> a -> c
. (\Text
t' -> forall a. a -> a -> Bool -> a
bool Text
t Text
t' ((Char -> Bool) -> Text -> Bool
T.all Char -> Bool
isAlpha Text
t')) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Text -> f Text
f Text
t
_Str Text -> f Text
_ VUnit
v       = forall (f :: * -> *) a. Applicative f => a -> f a
pure VUnit
v
{-# INLINE _Str #-}

-- | A logical unit of a version number. Can consist of multiple letters
-- and numbers.
type VChunk = NonEmpty VUnit

--------------------------------------------------------------------------------
-- (Haskell) PVP

-- | A PVP version number specific to the Haskell ecosystem. Like SemVer this is
-- a prescriptive scheme, and follows <https://pvp.haskell.org/ the PVP spec>.
--
-- Legal PVP values are of the form: MAJOR(.MAJOR.MINOR)
--
-- Example: @1.2.3@
--
-- Extra Rules:
--
-- 1. Each component must be a number.
--
-- 2. Only the first MAJOR component is actually necessary. Otherwise, there can
--    be any number of components. @1.2.3.4.5.6.7@ is legal.
--
-- 3. Unlike SemVer there are two MAJOR components, and both indicate a breaking
--    change. The spec otherwise designates no special meaning to components
--    past the MINOR position.
newtype PVP = PVP { PVP -> NonEmpty Word
_pComponents :: NonEmpty Word }
  deriving stock (PVP -> PVP -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PVP -> PVP -> Bool
$c/= :: PVP -> PVP -> Bool
== :: PVP -> PVP -> Bool
$c== :: PVP -> PVP -> Bool
Eq, Eq PVP
PVP -> PVP -> Bool
PVP -> PVP -> Ordering
PVP -> PVP -> PVP
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: PVP -> PVP -> PVP
$cmin :: PVP -> PVP -> PVP
max :: PVP -> PVP -> PVP
$cmax :: PVP -> PVP -> PVP
>= :: PVP -> PVP -> Bool
$c>= :: PVP -> PVP -> Bool
> :: PVP -> PVP -> Bool
$c> :: PVP -> PVP -> Bool
<= :: PVP -> PVP -> Bool
$c<= :: PVP -> PVP -> Bool
< :: PVP -> PVP -> Bool
$c< :: PVP -> PVP -> Bool
compare :: PVP -> PVP -> Ordering
$ccompare :: PVP -> PVP -> Ordering
Ord, Int -> PVP -> ShowS
[PVP] -> ShowS
PVP -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PVP] -> ShowS
$cshowList :: [PVP] -> ShowS
show :: PVP -> String
$cshow :: PVP -> String
showsPrec :: Int -> PVP -> ShowS
$cshowsPrec :: Int -> PVP -> ShowS
Show, forall x. Rep PVP x -> PVP
forall x. PVP -> Rep PVP x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PVP x -> PVP
$cfrom :: forall x. PVP -> Rep PVP x
Generic)
  deriving anyclass (PVP -> ()
forall a. (a -> ()) -> NFData a
rnf :: PVP -> ()
$crnf :: PVP -> ()
NFData, Eq PVP
Int -> PVP -> Int
PVP -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: PVP -> Int
$chash :: PVP -> Int
hashWithSalt :: Int -> PVP -> Int
$chashWithSalt :: Int -> PVP -> Int
Hashable)

instance Semigroup PVP where
  PVP (Word
m :| [Word]
r) <> :: PVP -> PVP -> PVP
<> PVP (Word
m' :| [Word]
r') = NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ (Word
m forall a. Num a => a -> a -> a
+ Word
m') forall a. a -> [a] -> NonEmpty a
:| forall {a}. Num a => [a] -> [a] -> [a]
f [Word]
r [Word]
r'
    where
      f :: [a] -> [a] -> [a]
f [a]
a []          = [a]
a
      f [] [a]
b          = [a]
b
      f (a
a:[a]
as) (a
b:[a]
bs) = (a
a forall a. Num a => a -> a -> a
+ a
b) forall a. a -> [a] -> [a]
: [a] -> [a] -> [a]
f [a]
as [a]
bs

instance Monoid PVP where
  mempty :: PVP
mempty = NonEmpty Word -> PVP
PVP (Word
0 forall a. a -> [a] -> NonEmpty a
:| [])

#if !MIN_VERSION_base(4,11,0)
  mappend = (<>)
#endif

instance Semantic PVP where
  major :: Traversal' PVP Word
major Word -> f Word
f (PVP (Word
m :| [Word]
rs)) = (\Word
ma -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
ma forall a. a -> [a] -> NonEmpty a
:| [Word]
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
m
  {-# INLINE major #-}

  minor :: Traversal' PVP Word
minor Word -> f Word
f (PVP (Word
m :| Word
mi : [Word]
rs)) = (\Word
mi' -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> NonEmpty a
:| Word
mi' forall a. a -> [a] -> [a]
: [Word]
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
mi
  minor Word -> f Word
f (PVP (Word
m :| []))      = (\Word
mi' -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> NonEmpty a
:| [Word
mi']) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
0
  {-# INLINE minor #-}

  patch :: Traversal' PVP Word
patch Word -> f Word
f (PVP (Word
m :| Word
mi : Word
pa : [Word]
rs)) = (\Word
pa' -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> NonEmpty a
:| Word
mi forall a. a -> [a] -> [a]
: Word
pa' forall a. a -> [a] -> [a]
: [Word]
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
pa
  patch Word -> f Word
f (PVP (Word
m :| [Word
mi]))         = (\Word
pa' -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> NonEmpty a
:| Word
mi forall a. a -> [a] -> [a]
: [Word
pa']) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
0
  patch Word -> f Word
f (PVP (Word
m :| []))           = (\Word
pa' -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> NonEmpty a
:| Word
0 forall a. a -> [a] -> [a]
: [Word
pa']) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
0
  {-# INLINE patch #-}

  release :: Traversal' PVP [VChunk]
release [VChunk] -> f [VChunk]
f PVP
p = PVP
p forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ [VChunk] -> f [VChunk]
f []
  {-# INLINE release #-}

  meta :: Traversal' PVP (Maybe Text)
meta Maybe Text -> f (Maybe Text)
f PVP
p = PVP
p forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ Maybe Text -> f (Maybe Text)
f forall a. Maybe a
Nothing
  {-# INLINE meta #-}

  semantic :: Traversal' PVP SemVer
semantic SemVer -> f SemVer
f (PVP (Word
m :| [Word]
rs)) = (\(SemVer Word
ma Word
mi Word
pa [VChunk]
_ Maybe Text
_) -> NonEmpty Word -> PVP
PVP forall a b. (a -> b) -> a -> b
$ Word
ma forall a. a -> [a] -> NonEmpty a
:| [Word
mi, Word
pa]) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> SemVer -> f SemVer
f SemVer
s
    where
      s :: SemVer
s = case [Word]
rs of
        Word
mi : Word
pa : [Word]
_ -> Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
m Word
mi Word
pa [] forall a. Maybe a
Nothing
        Word
mi : [Word]
_      -> Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
m Word
mi Word
0  [] forall a. Maybe a
Nothing
        []          -> Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
m Word
0 Word
0   [] forall a. Maybe a
Nothing
  {-# INLINE semantic #-}

--------------------------------------------------------------------------------
-- (General) Version

-- | A (General) Version.
-- Not quite as ideal as a `SemVer`, but has some internal consistancy
-- from version to version.
--
-- Generally conforms to the @a.b.c-p@ pattern, and may optionally have an
-- /epoch/ and /metadata/. Epochs are prefixes marked by a colon, like in
-- @1:2.3.4@. Metadata is prefixed by @+@, and like SemVer must appear after
-- the "prerelease" (the @-p@).
--
-- Examples of @Version@ that are not @SemVer@: 0.25-2, 8.u51-1, 20150826-1,
-- 1:2.3.4
data Version = Version
  { Version -> Maybe Word
_vEpoch  :: !(Maybe Word)
  , Version -> NonEmpty VChunk
_vChunks :: !(NonEmpty VChunk)
  , Version -> [VChunk]
_vRel    :: ![VChunk]
  , Version -> Maybe Text
_vMeta   :: !(Maybe Text) }
  deriving stock (Version -> Version -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Version -> Version -> Bool
$c/= :: Version -> Version -> Bool
== :: Version -> Version -> Bool
$c== :: Version -> Version -> Bool
Eq, Int -> Version -> ShowS
[Version] -> ShowS
Version -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Version] -> ShowS
$cshowList :: [Version] -> ShowS
show :: Version -> String
$cshow :: Version -> String
showsPrec :: Int -> Version -> ShowS
$cshowsPrec :: Int -> Version -> ShowS
Show, forall x. Rep Version x -> Version
forall x. Version -> Rep Version x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Version x -> Version
$cfrom :: forall x. Version -> Rep Version x
Generic)
  deriving anyclass (Version -> ()
forall a. (a -> ()) -> NFData a
rnf :: Version -> ()
$crnf :: Version -> ()
NFData, Eq Version
Int -> Version -> Int
Version -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: Version -> Int
$chash :: Version -> Int
hashWithSalt :: Int -> Version -> Int
$chashWithSalt :: Int -> Version -> Int
Hashable)

instance Semigroup Version where
  Version Maybe Word
e NonEmpty VChunk
c [VChunk]
m Maybe Text
r <> :: Version -> Version -> Version
<> Version Maybe Word
e' NonEmpty VChunk
c' [VChunk]
m' Maybe Text
r' = Maybe Word -> NonEmpty VChunk -> [VChunk] -> Maybe Text -> Version
Version (forall a. Num a => a -> a -> a
(+) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe Word
e forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Maybe Word
e') (NonEmpty VChunk
c forall a. Semigroup a => a -> a -> a
<> NonEmpty VChunk
c') ([VChunk]
m forall a. Semigroup a => a -> a -> a
<> [VChunk]
m') (Maybe Text
r forall a. Semigroup a => a -> a -> a
<> Maybe Text
r')

-- | Customized. As in SemVer, metadata is ignored for the purpose of
-- comparison.
instance Ord Version where
  -- | For the purposes of Versions with epochs, `Nothing` is the same as `Just 0`,
  -- so we need to compare their actual version numbers.
  compare :: Version -> Version -> Ordering
compare (Version Maybe Word
ae NonEmpty VChunk
as [VChunk]
rs Maybe Text
_) (Version Maybe Word
be NonEmpty VChunk
bs [VChunk]
rs' Maybe Text
_) = case forall a. Ord a => a -> a -> Ordering
compare (forall a. a -> Maybe a -> a
fromMaybe Word
0 Maybe Word
ae) (forall a. a -> Maybe a -> a
fromMaybe Word
0 Maybe Word
be) of
    Ordering
EQ  -> case [VChunk] -> [VChunk] -> Ordering
g (forall a. NonEmpty a -> [a]
NEL.toList NonEmpty VChunk
as) (forall a. NonEmpty a -> [a]
NEL.toList NonEmpty VChunk
bs) of
      -- If the two Versions were otherwise equal and recursed down this far,
      -- we need to compare them by their "release" values.
      Ordering
EQ  -> [VChunk] -> [VChunk] -> Ordering
g [VChunk]
rs [VChunk]
rs'
      Ordering
ord -> Ordering
ord
    Ordering
ord -> Ordering
ord
    where
      g :: [VChunk] -> [VChunk] -> Ordering
      g :: [VChunk] -> [VChunk] -> Ordering
g [] [] = Ordering
EQ

      -- | If all chunks up until this point were equal, but one side continues
      -- on with "lettered" sections, these are considered to be indicating a
      -- beta\/prerelease, and thus are /less/ than the side who already ran out
      -- of chunks.
      g [] ((Str Text
_ :| [VUnit]
_):[VChunk]
_) = Ordering
GT
      g ((Str Text
_ :| [VUnit]
_):[VChunk]
_) [] = Ordering
LT

      -- | If one side has run out of chunks to compare but the other hasn't,
      -- the other must be newer.
      g [VChunk]
_ []  = Ordering
GT
      g [] [VChunk]
_  = Ordering
LT

      -- | The usual case.
      g (VChunk
x:[VChunk]
xs) (VChunk
y:[VChunk]
ys) = case [VUnit] -> [VUnit] -> Ordering
f (forall a. NonEmpty a -> [a]
NEL.toList VChunk
x) (forall a. NonEmpty a -> [a]
NEL.toList VChunk
y) of
        Ordering
EQ  -> [VChunk] -> [VChunk] -> Ordering
g [VChunk]
xs [VChunk]
ys
        Ordering
res -> Ordering
res

      f :: [VUnit] -> [VUnit] -> Ordering
      f :: [VUnit] -> [VUnit] -> Ordering
f [] [] = Ordering
EQ

      -- | Opposite of the above. If we've recursed this far and one side
      -- has fewer chunks, it must be the "greater" version. A Chunk break
      -- only occurs in a switch from digits to letters and vice versa, so
      -- anything "extra" must be an @rc@ marking or similar. Consider @1.1@
      -- compared to @1.1rc1@.
      f [] [VUnit]
_  = Ordering
GT
      f [VUnit]
_ []  = Ordering
LT

      -- | The usual case.
      f (Digits Word
n:[VUnit]
ns) (Digits Word
m:[VUnit]
ms) | Word
n forall a. Ord a => a -> a -> Bool
> Word
m = Ordering
GT
                                    | Word
n forall a. Ord a => a -> a -> Bool
< Word
m = Ordering
LT
                                    | Bool
otherwise = [VUnit] -> [VUnit] -> Ordering
f [VUnit]
ns [VUnit]
ms
      f (Str Text
n:[VUnit]
ns) (Str Text
m:[VUnit]
ms) | Text
n forall a. Ord a => a -> a -> Bool
> Text
m = Ordering
GT
                              | Text
n forall a. Ord a => a -> a -> Bool
< Text
m = Ordering
LT
                              | Bool
otherwise = [VUnit] -> [VUnit] -> Ordering
f [VUnit]
ns [VUnit]
ms

      -- | An arbitrary decision to prioritize digits over letters.
      f (Digits Word
_ :[VUnit]
_) (Str Text
_ :[VUnit]
_) = Ordering
GT
      f (Str Text
_ :[VUnit]
_ ) (Digits Word
_ :[VUnit]
_) = Ordering
LT

instance Semantic Version where
  major :: Traversal' Version Word
major Word -> f Word
f (Version Maybe Word
e ((Digits Word
n :| []) :| [VChunk]
cs) [VChunk]
me Maybe Text
rs) =
    (\Word
n' -> Maybe Word -> NonEmpty VChunk -> [VChunk] -> Maybe Text -> Version
Version Maybe Word
e ((Word -> VUnit
Digits Word
n' forall a. a -> [a] -> NonEmpty a
:| []) forall a. a -> [a] -> NonEmpty a
:| [VChunk]
cs) [VChunk]
me Maybe Text
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  major Word -> f Word
_ Version
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Version
v
  {-# INLINE major #-}

  minor :: Traversal' Version Word
minor Word -> f Word
f (Version Maybe Word
e (VChunk
c :| (Digits Word
n :| []) : [VChunk]
cs) [VChunk]
me Maybe Text
rs) =
    (\Word
n' -> Maybe Word -> NonEmpty VChunk -> [VChunk] -> Maybe Text -> Version
Version Maybe Word
e (VChunk
c forall a. a -> [a] -> NonEmpty a
:| (Word -> VUnit
Digits Word
n' forall a. a -> [a] -> NonEmpty a
:| []) forall a. a -> [a] -> [a]
: [VChunk]
cs) [VChunk]
me Maybe Text
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  minor Word -> f Word
_ Version
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Version
v
  {-# INLINE minor #-}

  patch :: Traversal' Version Word
patch Word -> f Word
f (Version Maybe Word
e (VChunk
c :| VChunk
d : (Digits Word
n :| []) : [VChunk]
cs) [VChunk]
me Maybe Text
rs) =
    (\Word
n' -> Maybe Word -> NonEmpty VChunk -> [VChunk] -> Maybe Text -> Version
Version Maybe Word
e (VChunk
c forall a. a -> [a] -> NonEmpty a
:| VChunk
d forall a. a -> [a] -> [a]
: (Word -> VUnit
Digits Word
n' forall a. a -> [a] -> NonEmpty a
:| []) forall a. a -> [a] -> [a]
: [VChunk]
cs) [VChunk]
me Maybe Text
rs) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  patch Word -> f Word
_ Version
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Version
v
  {-# INLINE patch #-}

  -- | This will always succeed.
  release :: Traversal' Version [VChunk]
release [VChunk] -> f [VChunk]
f Version
v = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\[VChunk]
vr -> Version
v { _vRel :: [VChunk]
_vRel = [VChunk]
vr }) ([VChunk] -> f [VChunk]
f forall a b. (a -> b) -> a -> b
$ Version -> [VChunk]
_vRel Version
v)
  {-# INLINE release #-}

  -- | This will always fail.
  meta :: Traversal' Version (Maybe Text)
meta Maybe Text -> f (Maybe Text)
_ Version
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Version
v
  {-# INLINE meta #-}

  semantic :: Traversal' Version SemVer
semantic SemVer -> f SemVer
f (Version Maybe Word
_ ((Digits Word
a:|[]) :| (Digits Word
b:|[]) : (Digits Word
c:|[]) : [VChunk]
_) [VChunk]
rs Maybe Text
me) =
    SemVer -> Version
vFromS forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> SemVer -> f SemVer
f (Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
a Word
b Word
c [VChunk]
rs Maybe Text
me)
  semantic SemVer -> f SemVer
_ Version
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Version
v
  {-# INLINE semantic #-}

-- | A `Version`'s inner epoch `Word`.
epoch :: Lens' Version (Maybe Word)
epoch :: Lens' Version (Maybe Word)
epoch Maybe Word -> f (Maybe Word)
f Version
v = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\Maybe Word
ve -> Version
v { _vEpoch :: Maybe Word
_vEpoch = Maybe Word
ve }) (Maybe Word -> f (Maybe Word)
f forall a b. (a -> b) -> a -> b
$ Version -> Maybe Word
_vEpoch Version
v)
{-# INLINE epoch #-}

--------------------------------------------------------------------------------
-- (Complex) Mess

-- | Possible values of a section of a `Mess`. A numeric value is extracted if
-- it could be, alongside the original text it came from. This preserves both
-- `Ord` and pretty-print behaviour for versions like @1.003.0@.
data MChunk
  = MDigit Word Text
  -- ^ A nice numeric value.
  | MRev Word Text
  -- ^ A numeric value preceeded by an @r@, indicating a revision.
  | MPlain Text
  -- ^ Anything else.
  deriving stock (MChunk -> MChunk -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MChunk -> MChunk -> Bool
$c/= :: MChunk -> MChunk -> Bool
== :: MChunk -> MChunk -> Bool
$c== :: MChunk -> MChunk -> Bool
Eq, Int -> MChunk -> ShowS
[MChunk] -> ShowS
MChunk -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MChunk] -> ShowS
$cshowList :: [MChunk] -> ShowS
show :: MChunk -> String
$cshow :: MChunk -> String
showsPrec :: Int -> MChunk -> ShowS
$cshowsPrec :: Int -> MChunk -> ShowS
Show, forall x. Rep MChunk x -> MChunk
forall x. MChunk -> Rep MChunk x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MChunk x -> MChunk
$cfrom :: forall x. MChunk -> Rep MChunk x
Generic)
  deriving anyclass (MChunk -> ()
forall a. (a -> ()) -> NFData a
rnf :: MChunk -> ()
$crnf :: MChunk -> ()
NFData, Eq MChunk
Int -> MChunk -> Int
MChunk -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: MChunk -> Int
$chash :: MChunk -> Int
hashWithSalt :: Int -> MChunk -> Int
$chashWithSalt :: Int -> MChunk -> Int
Hashable)

instance Ord MChunk where
  compare :: MChunk -> MChunk -> Ordering
compare (MDigit Word
a Text
_) (MDigit Word
b Text
_) = forall a. Ord a => a -> a -> Ordering
compare Word
a Word
b
  compare (MRev Word
a Text
_) (MRev Word
b Text
_)     = forall a. Ord a => a -> a -> Ordering
compare Word
a Word
b
  compare (MPlain Text
a) (MPlain Text
b)     = forall a. Ord a => a -> a -> Ordering
compare Text
a Text
b
  compare MChunk
a MChunk
b                       = forall a. Ord a => a -> a -> Ordering
compare (MChunk -> Text
mchunkText MChunk
a) (MChunk -> Text
mchunkText MChunk
b)

-- | A total extraction of the `Text` from an `MChunk`.
mchunkText :: MChunk -> Text
mchunkText :: MChunk -> Text
mchunkText (MDigit Word
_ Text
t) = Text
t
mchunkText (MRev Word
_ Text
t)   = Text
t
mchunkText (MPlain Text
t)   = Text
t

-- | A (Complex) Mess. This is a /descriptive/ parser, based on examples of
-- stupidly crafted version numbers used in the wild.
--
-- Groups of letters/numbers, separated by a period, can be further separated by
-- the symbols @_-+:@
--
-- Some `Mess` values have a shape that is tantalizingly close to a `SemVer`.
-- Example: @1.6.0a+2014+m872b87e73dfb-1@. For values like these, we can extract
-- the semver-compatible values out with `messMajor`, etc.
--
-- Not guaranteed to have well-defined ordering (@Ord@) behaviour, but so far
-- internal tests show consistency. `messMajor`, etc., are used internally where
-- appropriate to enhance accuracy.
data Mess = Mess !(NonEmpty MChunk) !(Maybe (VSep, Mess))
  deriving stock (Mess -> Mess -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Mess -> Mess -> Bool
$c/= :: Mess -> Mess -> Bool
== :: Mess -> Mess -> Bool
$c== :: Mess -> Mess -> Bool
Eq, Int -> Mess -> ShowS
[Mess] -> ShowS
Mess -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Mess] -> ShowS
$cshowList :: [Mess] -> ShowS
show :: Mess -> String
$cshow :: Mess -> String
showsPrec :: Int -> Mess -> ShowS
$cshowsPrec :: Int -> Mess -> ShowS
Show, forall x. Rep Mess x -> Mess
forall x. Mess -> Rep Mess x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Mess x -> Mess
$cfrom :: forall x. Mess -> Rep Mess x
Generic)
  deriving anyclass (Mess -> ()
forall a. (a -> ()) -> NFData a
rnf :: Mess -> ()
$crnf :: Mess -> ()
NFData, Eq Mess
Int -> Mess -> Int
Mess -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: Mess -> Int
$chash :: Mess -> Int
hashWithSalt :: Int -> Mess -> Int
$chashWithSalt :: Int -> Mess -> Int
Hashable)

-- | Try to extract the "major" version number from `Mess`, as if it were a
-- `SemVer`.
messMajor :: Mess -> Maybe Word
messMajor :: Mess -> Maybe Word
messMajor (Mess (MDigit Word
i Text
_ :| [MChunk]
_) Maybe (VSep, Mess)
_) = forall a. a -> Maybe a
Just Word
i
messMajor Mess
_                          = forall a. Maybe a
Nothing

-- | Try to extract the "minor" version number from `Mess`, as if it were a
-- `SemVer`.
messMinor :: Mess -> Maybe Word
messMinor :: Mess -> Maybe Word
messMinor (Mess (MChunk
_ :| MDigit Word
i Text
_ : [MChunk]
_) Maybe (VSep, Mess)
_) = forall a. a -> Maybe a
Just Word
i
messMinor Mess
_                              = forall a. Maybe a
Nothing

-- | Try to extract the "patch" version number from `Mess`, as if it were a
-- `SemVer`.
messPatch :: Mess -> Maybe Word
messPatch :: Mess -> Maybe Word
messPatch (Mess (MChunk
_ :| MChunk
_ : MDigit Word
i Text
_ : [MChunk]
_) Maybe (VSep, Mess)
_) = forall a. a -> Maybe a
Just Word
i
messPatch Mess
_                                  = forall a. Maybe a
Nothing

-- | Okay, fine, say `messPatch` couldn't find a nice value. But some `Mess`es
-- have a "proper" patch-plus-release-candidate value in their patch position,
-- which is parsable as a `VChunk`.
--
-- Example: @1.6.0a+2014+m872b87e73dfb-1@ We should be able to extract @0a@ safely.
messPatchChunk :: Mess -> Maybe VChunk
messPatchChunk :: Mess -> Maybe VChunk
messPatchChunk (Mess (MChunk
_ :| MChunk
_ : MPlain Text
p : [MChunk]
_) Maybe (VSep, Mess)
_) = forall a b. Either a b -> Maybe b
hush forall a b. (a -> b) -> a -> b
$ forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse (Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith Parsec Void Text VUnit
unit) String
"Chunk" Text
p
messPatchChunk Mess
_                                = forall a. Maybe a
Nothing

instance Ord Mess where
  compare :: Mess -> Mess -> Ordering
compare (Mess NonEmpty MChunk
t1 Maybe (VSep, Mess)
m1) (Mess NonEmpty MChunk
t2 Maybe (VSep, Mess)
m2) = case forall a. Ord a => a -> a -> Ordering
compare NonEmpty MChunk
t1 NonEmpty MChunk
t2 of
    Ordering
EQ  -> case (Maybe (VSep, Mess)
m1, Maybe (VSep, Mess)
m2) of
      (Just (VSep
_, Mess
v1), Just (VSep
_, Mess
v2)) -> forall a. Ord a => a -> a -> Ordering
compare Mess
v1 Mess
v2
      (Just (VSep
_, Mess
_), Maybe (VSep, Mess)
Nothing)       -> Ordering
GT
      (Maybe (VSep, Mess)
Nothing, Just (VSep
_, Mess
_))       -> Ordering
LT
      (Maybe (VSep, Mess)
Nothing, Maybe (VSep, Mess)
Nothing)           -> Ordering
EQ
    Ordering
res -> Ordering
res

instance Semantic Mess where
  major :: Traversal' Mess Word
major Word -> f Word
f (Mess (MDigit Word
n Text
_ :| [MChunk]
ts) Maybe (VSep, Mess)
m) = (\Word
n' -> NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (Word -> Text -> MChunk
MDigit Word
n' (forall a. Show a => a -> Text
showt Word
n') forall a. a -> [a] -> NonEmpty a
:| [MChunk]
ts) Maybe (VSep, Mess)
m) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  major Word -> f Word
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE major #-}

  minor :: Traversal' Mess Word
minor Word -> f Word
f (Mess (MChunk
t0 :| MDigit Word
n Text
_ : [MChunk]
ts) Maybe (VSep, Mess)
m) = (\Word
n' -> NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (MChunk
t0 forall a. a -> [a] -> NonEmpty a
:| Word -> Text -> MChunk
MDigit Word
n' (forall a. Show a => a -> Text
showt Word
n') forall a. a -> [a] -> [a]
: [MChunk]
ts) Maybe (VSep, Mess)
m) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  minor Word -> f Word
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE minor #-}

  patch :: Traversal' Mess Word
patch Word -> f Word
f (Mess (MChunk
t0 :| MChunk
t1 : MDigit Word
n Text
_ : [MChunk]
ts) Maybe (VSep, Mess)
m) = (\Word
n' -> NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess (MChunk
t0 forall a. a -> [a] -> NonEmpty a
:| MChunk
t1 forall a. a -> [a] -> [a]
: Word -> Text -> MChunk
MDigit Word
n' (forall a. Show a => a -> Text
showt Word
n') forall a. a -> [a] -> [a]
: [MChunk]
ts) Maybe (VSep, Mess)
m) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Word -> f Word
f Word
n
  patch Word -> f Word
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE patch #-}

  -- | This will always fail.
  release :: Traversal' Mess [VChunk]
release [VChunk] -> f [VChunk]
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE release #-}

  -- | This will always fail.
  meta :: Traversal' Mess (Maybe Text)
meta Maybe Text -> f (Maybe Text)
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE meta #-}

  -- | Good luck.
  semantic :: Traversal' Mess SemVer
semantic SemVer -> f SemVer
f (Mess (MDigit Word
t0 Text
_ :| MDigit Word
t1 Text
_ : MDigit Word
t2 Text
_ : [MChunk]
_) Maybe (VSep, Mess)
_) =
    Version -> Mess
mFromV forall b c a. (b -> c) -> (a -> b) -> a -> c
. SemVer -> Version
vFromS forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> SemVer -> f SemVer
f (Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer Word
t0 Word
t1 Word
t2 [] forall a. Maybe a
Nothing)
  semantic SemVer -> f SemVer
_ Mess
v = forall (f :: * -> *) a. Applicative f => a -> f a
pure Mess
v
  {-# INLINE semantic #-}

-- | Developers use a number of symbols to seperate groups of digits/letters in
-- their version numbers. These are:
--
-- * A colon (:). Often denotes an "epoch".
-- * A hyphen (-).
-- * A plus (+). Stop using this outside of metadata if you are. Example: @10.2+0.93+1-1@
-- * An underscore (_). Stop using this if you are.
data VSep = VColon | VHyphen | VPlus | VUnder
  deriving stock (VSep -> VSep -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: VSep -> VSep -> Bool
$c/= :: VSep -> VSep -> Bool
== :: VSep -> VSep -> Bool
$c== :: VSep -> VSep -> Bool
Eq, Int -> VSep -> ShowS
[VSep] -> ShowS
VSep -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [VSep] -> ShowS
$cshowList :: [VSep] -> ShowS
show :: VSep -> String
$cshow :: VSep -> String
showsPrec :: Int -> VSep -> ShowS
$cshowsPrec :: Int -> VSep -> ShowS
Show, forall x. Rep VSep x -> VSep
forall x. VSep -> Rep VSep x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep VSep x -> VSep
$cfrom :: forall x. VSep -> Rep VSep x
Generic)
  deriving anyclass (VSep -> ()
forall a. (a -> ()) -> NFData a
rnf :: VSep -> ()
$crnf :: VSep -> ()
NFData, Eq VSep
Int -> VSep -> Int
VSep -> Int
forall a. Eq a -> (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: VSep -> Int
$chash :: VSep -> Int
hashWithSalt :: Int -> VSep -> Int
$chashWithSalt :: Int -> VSep -> Int
Hashable)

--------------------------------------------------------------------------------
-- Parsing

-- | A synonym for the more verbose 'megaparsec' error type.
type ParsingError = ParseErrorBundle Text Void

-- | Parse a piece of `Text` into either an (Ideal) `SemVer`, a (General)
-- `Version`, or a (Complex) `Mess`.
versioning :: Text -> Either ParsingError Versioning
versioning :: Text -> Either ParsingError Versioning
versioning = forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse Parsec Void Text Versioning
versioning' String
"versioning"

-- | Parse a `Versioning`. Assumes the version number is the last token in
-- the string.
versioning' :: Parsec Void Text Versioning
versioning' :: Parsec Void Text Versioning
versioning' = forall (f :: * -> *) (m :: * -> *) a.
(Foldable f, Alternative m) =>
f (m a) -> m a
choice [ forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap SemVer -> Versioning
Ideal Parsec Void Text SemVer
semver''    forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof)
                     , forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Version -> Versioning
General Parsec Void Text Version
version'' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof)
                     , forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Mess -> Versioning
Complex Parsec Void Text Mess
mess''         forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof ]

-- | Parse a (Ideal) Semantic Version.
semver :: Text -> Either ParsingError SemVer
semver :: Text -> Either ParsingError SemVer
semver = forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse (Parsec Void Text SemVer
semver'' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof) String
"Semantic Version"

-- | Internal megaparsec parser of `semver`.
semver' :: Parsec Void Text SemVer
semver' :: Parsec Void Text SemVer
semver' = forall e s (m :: * -> *) a. MonadParsec e s m => m () -> m a -> m a
L.lexeme forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m ()
space Parsec Void Text SemVer
semver''

semver'' :: Parsec Void Text SemVer
semver'' :: Parsec Void Text SemVer
semver'' = Word -> Word -> Word -> [VChunk] -> Maybe Text -> SemVer
SemVer forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parsec Void Text Word
majorP forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text Word
minorP forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text Word
patchP forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text [VChunk]
preRel forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional Parsec Void Text Text
metaData

-- | Parse a group of digits, which can't be lead by a 0, unless it is 0.
digitsP :: Parsec Void Text Word
digitsP :: Parsec Void Text Word
digitsP = forall a. Read a => String -> a
read forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ((Text -> String
T.unpack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall e s (m :: * -> *).
MonadParsec e s m =>
Tokens s -> m (Tokens s)
string Tokens Text
"0") forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
digitChar)

majorP :: Parsec Void Text Word
majorP :: Parsec Void Text Word
majorP = Parsec Void Text Word
digitsP forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.'

minorP :: Parsec Void Text Word
minorP :: Parsec Void Text Word
minorP = Parsec Void Text Word
majorP

patchP :: Parsec Void Text Word
patchP :: Parsec Void Text Word
patchP = Parsec Void Text Word
digitsP

preRel :: Parsec Void Text [VChunk]
preRel :: Parsec Void Text [VChunk]
preRel = (forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'-' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f b
*> Parsec Void Text [VChunk]
chunks) forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall (f :: * -> *) a. Applicative f => a -> f a
pure []

metaData :: Parsec Void Text Text
metaData :: Parsec Void Text Text
metaData = do
  forall (f :: * -> *) a. Functor f => f a -> f ()
void forall a b. (a -> b) -> a -> b
$ forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'+'
  forall (t :: * -> *) m. (Foldable t, Monoid m) => t m -> m
fold forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. a -> NonEmpty a -> NonEmpty a
NEL.intersperse Text
"." forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parsec Void Text Text
section forall (m :: * -> *) a sep.
Alternative m =>
m a -> m sep -> m (NonEmpty a)
`PC.sepBy1` forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.'
  where
    section :: Parsec Void Text Text
    section :: Parsec Void Text Text
section = forall e s (m :: * -> *).
MonadParsec e s m =>
Maybe String -> (Token s -> Bool) -> m (Tokens s)
takeWhile1P (forall a. a -> Maybe a
Just String
"Metadata char") (\Token Text
c -> Char -> Bool
isAlphaNum Token Text
c Bool -> Bool -> Bool
|| Token Text
c forall a. Eq a => a -> a -> Bool
== Char
'-')

chunksNE :: Parsec Void Text (NonEmpty VChunk)
chunksNE :: Parsec Void Text (NonEmpty VChunk)
chunksNE = Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith Parsec Void Text VUnit
unit'  forall (m :: * -> *) a sep.
Alternative m =>
m a -> m sep -> m (NonEmpty a)
`PC.sepBy1` forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.'

chunks :: Parsec Void Text [VChunk]
chunks :: Parsec Void Text [VChunk]
chunks = Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith Parsec Void Text VUnit
unit forall (m :: * -> *) a sep. MonadPlus m => m a -> m sep -> m [a]
`sepBy` forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.'

-- | Handling @0@ is a bit tricky. We can't allow runs of zeros in a chunk,
-- since a version like @1.000.1@ would parse as @1.0.1@.
chunkWith :: Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith :: Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith Parsec Void Text VUnit
u = forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try Parsec Void Text VChunk
zeroWithLetters forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Parsec Void Text VChunk
oneZero forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall (m :: * -> *) a. Alternative m => m a -> m (NonEmpty a)
PC.some Parsec Void Text VUnit
u
  where
    oneZero :: Parsec Void Text (NonEmpty VUnit)
    oneZero :: Parsec Void Text VChunk
oneZero = (Word -> VUnit
Digits Word
0 forall a. a -> [a] -> NonEmpty a
:| []) forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'0'

    zeroWithLetters :: Parsec Void Text (NonEmpty VUnit)
    zeroWithLetters :: Parsec Void Text VChunk
zeroWithLetters = do
      VUnit
z <- Word -> VUnit
Digits Word
0 forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'0'
      VChunk
s <- forall (m :: * -> *) a. Alternative m => m a -> m (NonEmpty a)
PC.some Parsec Void Text VUnit
sunit
      Maybe VChunk
c <- forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Parsec Void Text VUnit -> Parsec Void Text VChunk
chunkWith Parsec Void Text VUnit
u)
      case Maybe VChunk
c of
        Maybe VChunk
Nothing -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ forall a. a -> NonEmpty a -> NonEmpty a
NEL.cons VUnit
z VChunk
s
        Just VChunk
c' -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ forall a. a -> NonEmpty a -> NonEmpty a
NEL.cons VUnit
z VChunk
s forall a. Semigroup a => a -> a -> a
<> VChunk
c'

unit :: Parsec Void Text VUnit
unit :: Parsec Void Text VUnit
unit = Parsec Void Text VUnit
iunit forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Parsec Void Text VUnit
sunit

unit' :: Parsec Void Text VUnit
unit' :: Parsec Void Text VUnit
unit' = Parsec Void Text VUnit
iunit forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Parsec Void Text VUnit
sunit'

iunit :: Parsec Void Text VUnit
iunit :: Parsec Void Text VUnit
iunit = Word -> VUnit
Digits forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ((Word
0 forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'0') forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> (forall a. Read a => String -> a
read forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
digitChar))

sunit :: Parsec Void Text VUnit
sunit :: Parsec Void Text VUnit
sunit = Text -> VUnit
Str forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some (forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
letterChar forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'-')

-- | Same as `sunit`, but don't allow hyphens. Intended for the main body of
-- `Version`.
sunit' :: Parsec Void Text VUnit
sunit' :: Parsec Void Text VUnit
sunit' = Text -> VUnit
Str forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
letterChar

-- | Parse a (Haskell) `PVP`, as defined above.
pvp :: Text -> Either ParsingError PVP
pvp :: Text -> Either ParsingError PVP
pvp = forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse (ParsecT Void Text Identity PVP
pvp' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof) String
"PVP"

-- | Internal megaparsec parser of `pvp`.
pvp' :: Parsec Void Text PVP
pvp' :: ParsecT Void Text Identity PVP
pvp' = forall e s (m :: * -> *) a. MonadParsec e s m => m () -> m a -> m a
L.lexeme forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m ()
space (NonEmpty Word -> PVP
PVP forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. [a] -> NonEmpty a
NEL.fromList forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall e s (m :: * -> *) a.
(MonadParsec e s m, Token s ~ Char, Num a) =>
m a
L.decimal forall (m :: * -> *) a sep. MonadPlus m => m a -> m sep -> m [a]
`sepBy` forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.')

-- | Parse a (General) `Version`, as defined above.
version :: Text -> Either ParsingError Version
version :: Text -> Either ParsingError Version
version = forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse (Parsec Void Text Version
version'' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof) String
"Version"

-- | Internal megaparsec parser of `version`.
version' :: Parsec Void Text Version
version' :: Parsec Void Text Version
version' = forall e s (m :: * -> *) a. MonadParsec e s m => m () -> m a -> m a
L.lexeme forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m ()
space Parsec Void Text Version
version''

version'' :: Parsec Void Text Version
version'' :: Parsec Void Text Version
version'' = Maybe Word -> NonEmpty VChunk -> [VChunk] -> Maybe Text -> Version
Version forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try Parsec Void Text Word
epochP) forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text (NonEmpty VChunk)
chunksNE forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text [VChunk]
preRel forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional Parsec Void Text Text
metaData

epochP :: Parsec Void Text Word
epochP :: Parsec Void Text Word
epochP = forall a. Read a => String -> a
read forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
digitChar forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
':')

-- | Parse a (Complex) `Mess`, as defined above.
mess :: Text -> Either ParsingError Mess
mess :: Text -> Either ParsingError Mess
mess = forall e s a.
Parsec e s a -> String -> s -> Either (ParseErrorBundle s e) a
parse (Parsec Void Text Mess
mess'' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* forall e s (m :: * -> *). MonadParsec e s m => m ()
eof) String
"Mess"

-- | Internal megaparsec parser of `mess`.
mess' :: Parsec Void Text Mess
mess' :: Parsec Void Text Mess
mess' = forall e s (m :: * -> *) a. MonadParsec e s m => m () -> m a -> m a
L.lexeme forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m ()
space Parsec Void Text Mess
mess''

mess'' :: Parsec Void Text Mess
mess'' :: Parsec Void Text Mess
mess'' = NonEmpty MChunk -> Maybe (VSep, Mess) -> Mess
Mess forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parsec Void Text (NonEmpty MChunk)
mchunks forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional ((,) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parsec Void Text VSep
sep forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parsec Void Text Mess
mess')

mchunks :: Parsec Void Text (NonEmpty MChunk)
mchunks :: Parsec Void Text (NonEmpty MChunk)
mchunks = Parsec Void Text MChunk
mchunk forall (m :: * -> *) a sep.
Alternative m =>
m a -> m sep -> m (NonEmpty a)
`PC.sepBy1` forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'.'

mchunk :: Parsec Void Text MChunk
mchunk :: Parsec Void Text MChunk
mchunk = forall (f :: * -> *) (m :: * -> *) a.
(Foldable f, Alternative m) =>
f (m a) -> m a
choice [ forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try forall a b. (a -> b) -> a -> b
$ (\(Text
t, Word
i) -> Word -> Text -> MChunk
MDigit Word
i Text
t) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall e s (m :: * -> *) a.
MonadParsec e s m =>
m a -> m (Tokens s, a)
match (forall e s (m :: * -> *) a.
(MonadParsec e s m, Token s ~ Char, Num a) =>
m a
L.decimal forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* ParsecT Void Text Identity ()
next)
                , forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
try forall a b. (a -> b) -> a -> b
$ (\(Text
t, Word
i) -> Word -> Text -> MChunk
MRev Word
i Text
t) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall e s (m :: * -> *) a.
MonadParsec e s m =>
m a -> m (Tokens s, a)
match (forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'r' forall (f :: * -> *) a b. Applicative f => f a -> f b -> f b
*> forall e s (m :: * -> *) a.
(MonadParsec e s m, Token s ~ Char, Num a) =>
m a
L.decimal forall (f :: * -> *) a b. Applicative f => f a -> f b -> f a
<* ParsecT Void Text Identity ()
next)
                , Text -> MChunk
MPlain forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *) a. MonadPlus m => m a -> m [a]
some (forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
letterChar forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
m (Token s)
digitChar) ]
  where
    next :: Parsec Void Text ()
    next :: ParsecT Void Text Identity ()
next = forall e s (m :: * -> *) a. MonadParsec e s m => m a -> m a
lookAhead (forall (f :: * -> *) a. Functor f => f a -> f ()
void (forall e s (m :: * -> *).
MonadParsec e s m =>
Token s -> m (Token s)
single Char
'.') forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall (f :: * -> *) a. Functor f => f a -> f ()
void Parsec Void Text VSep
sep forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall e s (m :: * -> *). MonadParsec e s m => m ()
eof)

sep :: Parsec Void Text VSep
sep :: Parsec Void Text VSep
sep = forall (f :: * -> *) (m :: * -> *) a.
(Foldable f, Alternative m) =>
f (m a) -> m a
choice [ VSep
VColon  forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
':'
             , VSep
VHyphen forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'-'
             , VSep
VPlus   forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'+'
             , VSep
VUnder  forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall e s (m :: * -> *).
(MonadParsec e s m, Token s ~ Char) =>
Token s -> m (Token s)
char Char
'_' ]

sepCh :: VSep -> Char
sepCh :: VSep -> Char
sepCh VSep
VColon  = Char
':'
sepCh VSep
VHyphen = Char
'-'
sepCh VSep
VPlus   = Char
'+'
sepCh VSep
VUnder  = Char
'_'

-- | Convert any parsed Versioning type to its textual representation.
prettyV :: Versioning -> Text
prettyV :: Versioning -> Text
prettyV (Ideal SemVer
sv)  = SemVer -> Text
prettySemVer SemVer
sv
prettyV (General Version
v) = Version -> Text
prettyVer Version
v
prettyV (Complex Mess
m) = Mess -> Text
prettyMess Mess
m

-- | Convert a `SemVer` back to its textual representation.
prettySemVer :: SemVer -> Text
prettySemVer :: SemVer -> Text
prettySemVer (SemVer Word
ma Word
mi Word
pa [VChunk]
pr Maybe Text
me) = forall a. Monoid a => [a] -> a
mconcat forall a b. (a -> b) -> a -> b
$ [Text]
ver forall a. Semigroup a => a -> a -> a
<> [Text]
pr' forall a. Semigroup a => a -> a -> a
<> [Text]
me'
  where
    ver :: [Text]
ver = forall a. a -> [a] -> [a]
intersperse Text
"." [ forall a. Show a => a -> Text
showt Word
ma, forall a. Show a => a -> Text
showt Word
mi, forall a. Show a => a -> Text
showt Word
pa ]
    pr' :: [Text]
pr' = forall (f :: * -> *) b a.
Foldable f =>
f b -> (f a -> f b) -> f a -> f b
foldable [] (Text
"-" forall a. a -> [a] -> [a]
:) forall a b. (a -> b) -> a -> b
$ forall a. a -> [a] -> [a]
intersperse Text
"." (forall (t :: * -> *). Functor t => t VChunk -> t Text
chunksAsT [VChunk]
pr)
    me' :: [Text]
me' = forall b a. b -> (a -> b) -> Maybe a -> b
maybe [] (\Text
m -> [Text
"+",Text
m]) Maybe Text
me

-- | Convert a `PVP` back to its textual representation.
prettyPVP :: PVP -> Text
prettyPVP :: PVP -> Text
prettyPVP (PVP (Word
m :| [Word]
rs)) = Text -> [Text] -> Text
T.intercalate Text
"." forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map forall a. Show a => a -> Text
showt forall a b. (a -> b) -> a -> b
$ Word
m forall a. a -> [a] -> [a]
: [Word]
rs

-- | Convert a `Version` back to its textual representation.
prettyVer :: Version -> Text
prettyVer :: Version -> Text
prettyVer (Version Maybe Word
ep NonEmpty VChunk
cs [VChunk]
pr Maybe Text
me) = Text
ep' forall a. Semigroup a => a -> a -> a
<> forall a. Monoid a => [a] -> a
mconcat ([Text]
ver forall a. Semigroup a => a -> a -> a
<> [Text]
pr' forall a. Semigroup a => a -> a -> a
<> [Text]
me')
  where
    ver :: [Text]
ver = forall a. a -> [a] -> [a]
intersperse Text
"." forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *). Functor t => t VChunk -> t Text
chunksAsT forall a b. (a -> b) -> a -> b
$ forall a. NonEmpty a -> [a]
NEL.toList NonEmpty VChunk
cs
    me' :: [Text]
me' = forall b a. b -> (a -> b) -> Maybe a -> b
maybe [] (\Text
m -> [Text
"+",Text
m]) Maybe Text
me
    pr' :: [Text]
pr' = forall (f :: * -> *) b a.
Foldable f =>
f b -> (f a -> f b) -> f a -> f b
foldable [] (Text
"-" forall a. a -> [a] -> [a]
:) forall a b. (a -> b) -> a -> b
$ forall a. a -> [a] -> [a]
intersperse Text
"." (forall (t :: * -> *). Functor t => t VChunk -> t Text
chunksAsT [VChunk]
pr)
    ep' :: Text
ep' = forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" (\Word
e -> forall a. Show a => a -> Text
showt Word
e forall a. Semigroup a => a -> a -> a
<> Text
":") Maybe Word
ep

-- | Convert a `Mess` back to its textual representation.
prettyMess :: Mess -> Text
prettyMess :: Mess -> Text
prettyMess (Mess NonEmpty MChunk
t Maybe (VSep, Mess)
m) = case Maybe (VSep, Mess)
m of
  Maybe (VSep, Mess)
Nothing     -> Text
t'
  Just (VSep
s, Mess
v) -> Text -> Char -> Text
T.snoc Text
t' (VSep -> Char
sepCh VSep
s) forall a. Semigroup a => a -> a -> a
<> Mess -> Text
prettyMess Mess
v
  where
    t' :: Text
    t' :: Text
t' = forall (t :: * -> *) m. (Foldable t, Monoid m) => t m -> m
fold forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. a -> NonEmpty a -> NonEmpty a
NEL.intersperse Text
"." forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> NonEmpty a -> NonEmpty b
NEL.map MChunk -> Text
mchunkText NonEmpty MChunk
t

chunksAsT :: Functor t => t VChunk -> t Text
chunksAsT :: forall (t :: * -> *). Functor t => t VChunk -> t Text
chunksAsT = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (forall (t :: * -> *) m a.
(Foldable t, Monoid m) =>
(a -> m) -> t a -> m
foldMap VUnit -> Text
f)
  where
    f :: VUnit -> Text
    f :: VUnit -> Text
f (Digits Word
i) = forall a. Show a => a -> Text
showt Word
i
    f (Str Text
s)    = Text
s

chunksAsM :: Functor t => t VChunk -> t MChunk
chunksAsM :: forall (t :: * -> *). Functor t => t VChunk -> t MChunk
chunksAsM = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap VChunk -> MChunk
f
  where
    f :: VChunk -> MChunk
    f :: VChunk -> MChunk
f (Digits Word
i :| [])        = Word -> Text -> MChunk
MDigit Word
i forall a b. (a -> b) -> a -> b
$ forall a. Show a => a -> Text
showt Word
i
    f (Str Text
"r" :| [Digits Word
i]) = Word -> Text -> MChunk
MRev Word
i forall b c a. (b -> c) -> (a -> b) -> a -> c
. Char -> Text -> Text
T.cons Char
'r' forall a b. (a -> b) -> a -> b
$ forall a. Show a => a -> Text
showt Word
i
    f VChunk
vc                      = Text -> MChunk
MPlain forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Text] -> Text
T.concat forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *). Functor t => t VChunk -> t Text
chunksAsT [VChunk
vc]

-- | Analogous to `maybe` and `either`. If a given Foldable is empty,
-- a default value is returned. Else, a function is applied to that Foldable.
foldable :: Foldable f => f b -> (f a -> f b) -> f a -> f b
foldable :: forall (f :: * -> *) b a.
Foldable f =>
f b -> (f a -> f b) -> f a -> f b
foldable f b
d f a -> f b
g f a
f | forall (t :: * -> *) a. Foldable t => t a -> Bool
null f a
f    = f b
d
               | Bool
otherwise = f a -> f b
g f a
f

-- | Flip an Ordering.
opposite :: Ordering -> Ordering
opposite :: Ordering -> Ordering
opposite Ordering
EQ = Ordering
EQ
opposite Ordering
LT = Ordering
GT
opposite Ordering
GT = Ordering
LT

-- Yes, `text-show` exists, but this reduces external dependencies.
showt :: Show a => a -> Text
showt :: forall a. Show a => a -> Text
showt = String -> Text
T.pack forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Show a => a -> String
show

hush :: Either a b -> Maybe b
hush :: forall a b. Either a b -> Maybe b
hush (Left a
_)  = forall a. Maybe a
Nothing
hush (Right b
b) = forall a. a -> Maybe a
Just b
b