git.iko.soy/typeable/aeson
on master help sign in
Merge pull request #729 from robbiemcmichael/format-path

Add formatPath function

commit98bbc5bfed167205975e9fe2efe21f4544cbdb4d authorAdam Bergmark <adam@bergmark.nl> dateWed 16 Oct 2019, 13:49 (7 years ago) parentb23d3510ca4679
3 files changed+29−2
compare with master
unifiedsplit
Data/Aeson/Types.hs+2 Data/Aeson/Types/Internal.hs+13−1 tests/UnitTests.hs+14−1
Data/Aeson/Types.hs+2
@@ -141,6 +141,8 @@ module Data.Aeson.Types
141141 , (<?>)
142142 , JSONPath
143143 , JSONPathElement(..)
144+ , formatPath
145+ , formatRelativePath
144146 ) where
145147
146148import Prelude.Compat
Data/Aeson/Types/Internal.hs+13−1
@@ -49,6 +49,8 @@ module Data.Aeson.Types.Internal
4949 , parserThrowError
5050 , parserCatchError
5151 , formatError
52+ , formatPath
53+ , formatRelativePath
5254 , (<?>)
5355 -- * Constructors and accessors
5456 , object
@@ -458,7 +460,17 @@ parseEither m v = runParser (m v) [] onError Right
458460-- | Annotate an error message with a
459461-- <http://goessner.net/articles/JsonPath/ JSONPath> error location.
460462formatError :: JSONPath -> String -> String
461−formatError path msg = "Error in " ++ format "$" path ++ ": " ++ msg
463+formatError path msg = "Error in " ++ formatPath path ++ ": " ++ msg
464+
465+-- | Format a <http://goessner.net/articles/JsonPath/ JSONPath> as a 'String',
466+-- representing the root object as @$@.
467+formatPath :: JSONPath -> String
468+formatPath path = "$" ++ formatRelativePath path
469+
470+-- | Format a <http://goessner.net/articles/JsonPath/ JSONPath> as a 'String'
471+-- which represents the path relative to some root object.
472+formatRelativePath :: JSONPath -> String
473+formatRelativePath path = format "" path
462474 where
463475 format :: String -> JSONPath -> String
464476 format pfx [] = pfx
tests/UnitTests.hs+14−1
@@ -34,7 +34,8 @@ import Data.Aeson.Parser
3434 , json', jsonLast', jsonAccum', jsonNoDup')
3535import Data.Aeson.Types
3636 ( Options(..), Result(Success), ToJSON(..), Value(Array, Bool, Null, Object)
37− , camelTo, camelTo2, defaultOptions, omitNothingFields, parse)
37+ , camelTo, camelTo2, defaultOptions, formatPath, formatRelativePath
38+ , omitNothingFields, parse)
3839import Data.Attoparsec.ByteString (Parser, parseOnly)
3940import Data.Char (toUpper)
4041import Data.Either.Compat (isLeft, isRight)
@@ -253,6 +254,18 @@ formatErrorExample =
253254 lhs = "Error in $[0].foo.bar['a.b.c']['']['\\'\\\\'].end: error msg"
254255 in assertEqual "formatError example" lhs rhs
255256
257+formatPathExample :: Assertion
258+formatPathExample =
259+ let rhs = formatPath [Key "x", Index 0]
260+ lhs = "$.x[0]"
261+ in assertEqual "formatPath example" lhs rhs
262+
263+formatRelativePathExample :: Assertion
264+formatRelativePathExample =
265+ let rhs = formatPath [Key "x", Index 0]
266+ lhs = ".x[0]"
267+ in assertEqual "formatRelativePath example" lhs rhs
268+
256269------------------------------------------------------------------------------
257270-- Comparison (.:?) and (.:!)
258271------------------------------------------------------------------------------