ff0b8b9 · typeable/yaml

git.iko.soy/typeable/yaml

Data.Yaml.Pretty: provide key-sorting function with path to parent object

With this change comparator in Config can sort keys differently depending on where parent object is located, e.g following code would sort keys in object located in `.foo.bar.[3]` position different than any other. ``` import Data.Yaml.Pretty (Pos(..), defConfig) myComparator :: [Pos] -> Text -> Text -> Ordering myComparator ps x y = if ps == [PosKey "foo", PosKey "bar", PosIndex 3] then compare x y else compare (T.reverse x) (T.reverse y) myConfig :: Config myConfig = setConfComparePos myComparator ``` It must be noted that this is not backward-compatible change: while API of existing `setConfCompare` function is preserved, and new `setConfComparePos` is introduced, signature of `getConfCompare` function can't be preserved, and it returns function with one more argument than before.

commitff0b8b92fde603f1aded7dadde83f726086d5e8d authorDmitry Bogatov <serenity@kaction.cc> dateSat 21 Jan 2023, 21:25 (4 years ago) parenta4635f1

1 file changed+21−14

compare with master

unifiedsplit

yaml/src/Data/Yaml/Pretty.hs+21−14

yaml/src/Data/Yaml/Pretty.hs+21−14

@@ -7,6 +7,7 @@ module Data.Yaml.Pretty

77 , Config

88 , getConfCompare

99 , setConfCompare

10+ , setConfComparePos

1011 , getConfDropNull

1112 , setConfDropNull

1213 , defConfig

@@ -50,7 +51,7 @@ type Key = Text

5051-- |

5152-- @since 0.8.13

5253data Config = Config

53− { confCompare :: Text -> Text -> Ordering -- ^ Function used to sort keys in objects

54+ { confCompare :: JSONPath -> Text -> Text -> Ordering -- ^ Function used to sort keys in objects

5455 , confDropNull :: Bool -- ^ Drop null values from objects

5556 }

5657

@@ -62,14 +63,20 @@ defConfig = Config mempty False

6263

6364-- |

6465-- @since 0.8.13

65−getConfCompare :: Config -> Text -> Text -> Ordering

66+getConfCompare :: Config -> JSONPath -> Text -> Text -> Ordering

6667getConfCompare = confCompare

6768

6869-- | Sets ordering for object keys

6970--

7071-- @since 0.8.13

7172setConfCompare :: (Text -> Text -> Ordering) -> Config -> Config

72−setConfCompare cmp c = c { confCompare = cmp }

73+setConfCompare cmp c = c { confCompare = \_ps -> cmp }

74+

75+-- | Set ordering for object keys that depends on location of object in the document.

76+--

77+-- @since 0.11.9

78+setConfComparePos :: (JSONPath -> Text -> Text -> Ordering) -> Config -> Config

79+setConfComparePos cmp c = c { confCompare = cmp }

7380

7481-- |

7582-- @since 0.8.24

@@ -83,17 +90,17 @@ setConfDropNull :: Bool -> Config -> Config

8390setConfDropNull m c = c { confDropNull = m }

8491

8592pretty :: Config -> Value -> YamlBuilder

86−pretty cfg = go

87− where go (Object o) = let sort = sortBy (confCompare cfg `on` fst)

88− select

89− | confDropNull cfg = HM.filter (/= Null)

90− | otherwise = id

91− in mapping (sort $ fmap (first toText) $ HM.toList $ HM.map go $ select o)

92− go (Array a) = array (go <$> V.toList a)

93− go Null = null

94− go (String s) = string s

95− go (Number n) = scientific n

96− go (Bool b) = bool b

93+pretty cfg = go []

94+ where go ps (Object o) = let sort = sortBy (confCompare cfg (reverse ps) `on` fst)

95+ select

96+ | confDropNull cfg = HM.filter (/= Null)

97+ | otherwise = id

98+ in mapping (sort $ fmap (first toText) $ HM.toList $ HM.mapWithKey (\k -> go (Key (toText k): ps)) $ select o)

99+ go ps (Array a) = array $ zipWith (\ix -> go (Index ix: ps)) [0..] (V.toList a)

100+ go _ Null = null

101+ go _ (String s) = string s

102+ go _ (Number n) = scientific n

103+ go _ (Bool b) = bool b

97104

98105-- | Configurable 'encode'.

99106--