-- SPDX-FileCopyrightText: 2022 Oxhead Alpha
-- SPDX-License-Identifier: LicenseRef-MIT-OA

{-# OPTIONS_HADDOCK not-home #-}

-- | This module defines 'ScenarioBranchName' and required instances to use it
-- with 'ExceptionAnnotation'.
module Test.Cleveland.Internal.Exceptions.ScenarioBranchName
  (ScenarioBranchName(..)
  ) where

import Fmt (Buildable(..), nameF, (+|), (|+))

import Test.Cleveland.Internal.Exceptions.Annotated

-- | When using 'Test.Cleveland.branchout' function for building test scenarios - names
-- of branches we are currently within.
newtype ScenarioBranchName = ScenarioBranchName { ScenarioBranchName -> [Text]
unTestBranch :: [Text] }
  deriving stock (Int -> ScenarioBranchName -> ShowS
[ScenarioBranchName] -> ShowS
ScenarioBranchName -> String
(Int -> ScenarioBranchName -> ShowS)
-> (ScenarioBranchName -> String)
-> ([ScenarioBranchName] -> ShowS)
-> Show ScenarioBranchName
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ScenarioBranchName] -> ShowS
$cshowList :: [ScenarioBranchName] -> ShowS
show :: ScenarioBranchName -> String
$cshow :: ScenarioBranchName -> String
showsPrec :: Int -> ScenarioBranchName -> ShowS
$cshowsPrec :: Int -> ScenarioBranchName -> ShowS
Show, ScenarioBranchName -> ScenarioBranchName -> Bool
(ScenarioBranchName -> ScenarioBranchName -> Bool)
-> (ScenarioBranchName -> ScenarioBranchName -> Bool)
-> Eq ScenarioBranchName
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ScenarioBranchName -> ScenarioBranchName -> Bool
$c/= :: ScenarioBranchName -> ScenarioBranchName -> Bool
== :: ScenarioBranchName -> ScenarioBranchName -> Bool
$c== :: ScenarioBranchName -> ScenarioBranchName -> Bool
Eq)
  deriving newtype NonEmpty ScenarioBranchName -> ScenarioBranchName
ScenarioBranchName -> ScenarioBranchName -> ScenarioBranchName
(ScenarioBranchName -> ScenarioBranchName -> ScenarioBranchName)
-> (NonEmpty ScenarioBranchName -> ScenarioBranchName)
-> (forall b.
    Integral b =>
    b -> ScenarioBranchName -> ScenarioBranchName)
-> Semigroup ScenarioBranchName
forall b.
Integral b =>
b -> ScenarioBranchName -> ScenarioBranchName
forall a.
(a -> a -> a)
-> (NonEmpty a -> a)
-> (forall b. Integral b => b -> a -> a)
-> Semigroup a
stimes :: forall b.
Integral b =>
b -> ScenarioBranchName -> ScenarioBranchName
$cstimes :: forall b.
Integral b =>
b -> ScenarioBranchName -> ScenarioBranchName
sconcat :: NonEmpty ScenarioBranchName -> ScenarioBranchName
$csconcat :: NonEmpty ScenarioBranchName -> ScenarioBranchName
<> :: ScenarioBranchName -> ScenarioBranchName -> ScenarioBranchName
$c<> :: ScenarioBranchName -> ScenarioBranchName -> ScenarioBranchName
Semigroup

instance ExceptionAnnotation ScenarioBranchName where
  displayAnnotation :: ScenarioBranchName -> Builder -> Builder
displayAnnotation ScenarioBranchName
ann = Builder -> Builder -> Builder
nameF (Builder
"In branch '" Builder -> Builder -> Builder
forall b. FromBuilder b => Builder -> Builder -> b
+| ScenarioBranchName
ann ScenarioBranchName -> Builder -> Builder
forall a b. (Buildable a, FromBuilder b) => a -> Builder -> b
|+ Builder
"'")

instance Buildable ScenarioBranchName where
  build :: ScenarioBranchName -> Builder
build = [Builder] -> Builder
forall a. Monoid a => [a] -> a
mconcat ([Builder] -> Builder)
-> (ScenarioBranchName -> [Builder])
-> ScenarioBranchName
-> Builder
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Builder -> [Builder] -> [Builder]
forall a. a -> [a] -> [a]
intersperse Builder
"/" ([Builder] -> [Builder])
-> (ScenarioBranchName -> [Builder])
-> ScenarioBranchName
-> [Builder]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Text -> Builder) -> [Text] -> [Builder]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
map Text -> Builder
forall p. Buildable p => p -> Builder
build ([Text] -> [Builder])
-> (ScenarioBranchName -> [Text])
-> ScenarioBranchName
-> [Builder]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ScenarioBranchName -> [Text]
unTestBranch