json-pointy (empty) → 0.1.0.1
raw patch · 8 files changed
+374/−0 lines, 8 filesdep +aesondep +attoparsecdep +basesetup-changed
Dependencies added: aeson, attoparsec, base, bytestring, containers, directory, doctest, filepath, hashable, http-types, json-pointy, microlens, mtl, tasty, tasty-discover, tasty-hunit, template-haskell, text, th-lift-instances, unordered-containers, uri-bytestring, vector
Files
- CHANGELOG.md +7/−0
- LICENSE +12/−0
- README.md +12/−0
- Setup.hs +2/−0
- json-pointy.cabal +80/−0
- src/Data/Aeson/Pointer.hs +255/−0
- tests/doctests.hs +5/−0
- tests/tests.hs +1/−0
+ CHANGELOG.md view
@@ -0,0 +1,7 @@+# 0.1.0.1++Fix cabal file issues.++# 0.1.0.0++Initial release.
+ LICENSE view
@@ -0,0 +1,12 @@+Copyright (c) 2016, Ian Duncan+All rights reserved.++Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:++1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.++2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.++3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.++THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ README.md view
@@ -0,0 +1,12 @@+# json-pointer++[](https://hackage.haskell.org/package/json-pointer)+[](https://hackage.haskell.org/package/json-pointer)++## Change Log++See [CHANGELOG](blob/master/CHANGELOG.md)++## License++See [LICENSE](blob/master/LICENSE)
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ json-pointy.cabal view
@@ -0,0 +1,80 @@+name: json-pointy+version: 0.1.0.1+license: BSD3+license-file: LICENSE+stability: experimental+author: Ian Duncan+maintainer: Ian Duncan <ian@iankduncan.com>+homepage: https://github.com/iand675/json-utils/+bug-reports: https://github.com/iand675/json-utils/issues+category: Development+copyright: Copyright (C) 2019 Ian Duncan+tested-with: GHC == 8.6.4+synopsis: JSON Pointer (RFC 6901) parsing, access, and modification+description: See README.md+cabal-version: >= 1.8+build-type: Simple++extra-source-files:+ CHANGELOG.md+ README.md++source-repository head+ type: git+ location: https://github.com/iand675/json-utils.git++library+ build-depends:+ base >= 4.5 && < 5,+ text >= 0.11 && < 1.3,+ bytestring >= 0.9.1.10 && < 0.11,+ unordered-containers >= 0.2.4 && < 0.3,+ vector >= 0.5 && < 1,+ aeson,+ attoparsec,+ microlens,+ template-haskell >= 2.14,+ th-lift-instances,+ uri-bytestring,+ http-types+ exposed-modules:+ Data.Aeson.Pointer+ ghc-options: -Wall -fwarn-tabs -O2 -fdicts-cheap -funbox-strict-fields -fmax-simplifier-iterations=10+ hs-source-dirs: src++test-suite tests+ type: exitcode-stdio-1.0+ main-is: tests.hs+ ghc-options: -Wall -threaded+ hs-source-dirs: tests+ build-depends:+ base,+ text,+ bytestring,+ containers,+ hashable,+ unordered-containers,+ vector,+ mtl,+ tasty,+ tasty-hunit,+ tasty-discover++test-suite doctests+ type: exitcode-stdio-1.0+ main-is: doctests.hs+ ghc-options: -Wall -threaded+ hs-source-dirs: tests+ build-depends:+ base,+ text,+ bytestring,+ containers,+ hashable,+ unordered-containers,+ vector,+ mtl,+ doctest,+ filepath,+ directory,+ json-pointy
+ src/Data/Aeson/Pointer.hs view
@@ -0,0 +1,255 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-|+Module : Data.Aeson.Pointer+Description: RFC 6901 pointers parsing and traversing+Copyright : (c) 2019 Ian Duncan+License : BSD3++Parsing, rendering, and traversing of <https://tools.ietf.org/html/rfc6901 RFC 6901 JSON pointers>+-}+{-# LANGUAGE DeriveLift #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE QuasiQuotes #-}+module Data.Aeson.Pointer+ ( -- $setup+ -- $usage+ JsonPointer+ , mkJsonPointer+ , pointerSegments+ , jsonPtr+ , parsePointer+ , parseURIFragment+ , renderPointer+ -- ** Simple pointer access+ , valueAt+ , overValueAt+ -- ** Traversing JSON Documents+ , pointerTraversal+ , segmentTraversal+ -- ** Segments+ , PointerSegment+ , unsafeTextSegment+ , unsafeTextOrNumberSegment+ , segmentText+ , segmentNumber+ -- ** Parsers+ , pointerParser+ , pointerSegmentParser+ ) where+import Control.Applicative+import Lens.Micro (Traversal', (&), (^?), (%~), _Just, to)+import Data.Aeson+import Data.Attoparsec.Text+import Data.Char (ord)+import qualified Data.HashMap.Strict as H+import Data.List (foldl')+import Data.Maybe (fromMaybe)+import qualified Data.Text as T+import qualified Data.Text.Encoding as T+import qualified Data.Vector as V+import Instances.TH.Lift ()+import Text.Read (readMaybe)+import Language.Haskell.TH.Syntax+import Language.Haskell.TH.Quote+import URI.ByteString++-- $setup+-- >>> import URI.ByteString.QQ+-- >>> :set -XOverloadedStrings+-- >>> :set -XQuasiQuotes+-- >>> :{+-- let sampleDoc = object+-- [ "foo" .= ["bar" :: T.Text, "baz"]+-- , "" .= (0 :: Int)+-- , "a/b" .= (1 :: Int)+-- , "c%d" .= (2 :: Int)+-- , "e^f" .= (3 :: Int)+-- , "g|h" .= (4 :: Int)+-- , "i\\j" .= (5 :: Int)+-- , "k\"l" .= (6 :: Int)+-- , " " .= (7 :: Int)+-- , "m~n" .= (8 :: Int)+-- ]+-- :}++-- $usage+--+-- >>> let samplePointerText = "/data/foo" :: T.Text+-- >>> :{+-- let extractPointerValue = case parsePointer samplePointerText of+-- Left err -> Nothing+-- Right ptr ->+-- (object ["data" .= object ["foo" .= 5.2]]) ^? pointerTraversal ptr+-- in extractPointerValue+-- :}+-- Just (Number 5.2)+--+--+-- >>> sampleDoc ^? pointerTraversal [jsonPtr||]+-- Just (Object (fromList [("c%d",Number 2.0),("m~n",Number 8.0),("e^f",Number 3.0),("",Number 0.0),(" ",Number 7.0),("foo",Array [String "bar",String "baz"]),("a/b",Number 1.0),("i\\j",Number 5.0),("k\"l",Number 6.0),("g|h",Number 4.0)]))+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/foo|]+-- Just (Array [String "bar",String "baz"])+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/foo/0|]+-- Just (String "bar")+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/foo/4|]+-- Nothing+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/|]+-- Just (Number 0.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/a~1b|]+-- Just (Number 1.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/c%d|]+-- Just (Number 2.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/e^f|]+-- Just (Number 3.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/g|h|]+-- Just (Number 4.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/i\j|]+-- Just (Number 5.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/k"l|]+-- Just (Number 6.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/ |]+-- Just (Number 7.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/m~0n|]+-- Just (Number 8.0)+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/woo|]+-- Nothing+-- >>> sampleDoc ^? pointerTraversal [jsonPtr|/m~0n/woo|]+-- Nothing+-- >>> parseURIFragment [relativeRef|#/c%25d|]+-- Right (JsonPointer {pointerSegments = [TextSegment "c%d"]})++++newtype JsonPointer = JsonPointer { pointerSegments :: [PointerSegment] }+ deriving (Show, Eq, Lift, Monoid, Semigroup)++instance ToJSON JsonPointer where+ toJSON = String . renderPointer++instance FromJSON JsonPointer where+ parseJSON (String str) = case parsePointer str of+ Left err -> fail err+ Right x -> return x+ parseJSON _ = fail "JSON pointer must be a string"++data PointerSegment = TextSegment T.Text+ | TextOrNumberSegment T.Text Int+ deriving (Show, Eq, Lift)++mkJsonPointer :: [PointerSegment] -> JsonPointer+mkJsonPointer = JsonPointer++-- | Construct a 'PointerSegment' from a 'T.Text' value. The value __must__ not be an Integer.+unsafeTextSegment :: T.Text -> PointerSegment+unsafeTextSegment = TextSegment++-- | Construct a 'PointerSegment' from an 'Int' value. The value __must__ be greater than or equal to zero.+unsafeTextOrNumberSegment :: Int -> PointerSegment+unsafeTextOrNumberSegment n = TextOrNumberSegment (T.pack $ show n) n++-- | Retrieve the text value of a pointer segment.+segmentText :: PointerSegment -> T.Text+segmentText (TextSegment t) = t+segmentText (TextOrNumberSegment t _) = t++-- | Retrieve the numeric value of a pointer segment, if the segment can be interpreted as a number.+segmentNumber :: PointerSegment -> Maybe Int+segmentNumber (TextSegment _) = Nothing+segmentNumber (TextOrNumberSegment _ n) = Just n++-- | Render a 'JsonPointer' back into its RFC 6901 machine-readable format:+--+-- >>> renderPointer [jsonPtr|/~1/~0/woo|]+-- "/~1/~0/woo"+renderPointer :: JsonPointer -> T.Text+renderPointer (JsonPointer ss) = T.concat $ map renderSegment ss++-- | Render an individual 'PointerSegment'. Not generally useful, but may be+-- helpful for pretty-printing or other more niche situations.+--+-- >>> renderSegment $ unsafeTextOrNumberSegment 0+-- "/0"+renderSegment :: PointerSegment -> T.Text+renderSegment p = T.cons '/' $ T.replace "/" "~1" $ T.replace "~" "~0" t+ where+ t = case p of+ TextOrNumberSegment s _ -> s+ TextSegment s -> s++pointerParser :: Parser JsonPointer+pointerParser = JsonPointer <$> (many (char '/' *> pointerSegmentParser) <* endOfInput)++escapedCharParser :: Parser Char+escapedCharParser = (char '~' *> ((char '0' *> pure '~') <|> (char '1' *> pure '/'))) <|> charRanges+ where+ charRanges = satisfy (matchesCharRange . ord)+ matchesCharRange x = (x >= 0x00 && x <= 0x2E) ||+ (x >= 0x30 && x <= 0x7D) ||+ (x >= 0x7F && x <= 0x10FFFF)++pointerSegmentParser :: Parser PointerSegment+pointerSegmentParser = mkSegment <$> many escapedCharParser+ where+ mkSegment :: String -> PointerSegment+ mkSegment "0" = TextOrNumberSegment "0" 0+ mkSegment s@(c:_) = let+ packed = T.pack s+ cNum = ord c in if cNum >= 0x31 && cNum <= 0x39+ then case readMaybe s of+ Nothing -> TextSegment packed+ Just x -> TextOrNumberSegment packed x+ else TextSegment packed+ mkSegment s = TextSegment $ T.pack s++-- | Parse a pointer from 'T.Text' into a 'JsonPointer'+parsePointer :: T.Text -> Either String JsonPointer+parsePointer = parseOnly pointerParser+{-# INLINE parsePointer #-}++parseURIFragment :: URIRef a -> Either String JsonPointer+parseURIFragment u = parseOnly pointerParser p+ where+ p =+ fromMaybe ""+ (u ^? fragmentL . _Just . to (T.decodeUtf8 . urlDecode True))+{-# INLINE parseURIFragment #-}++pointerTraversal :: JsonPointer -> Traversal' Value Value+pointerTraversal (JsonPointer ps) = foldl' (\f s -> f . segmentTraversal s) id ps+{-# INLINE pointerTraversal #-}++segmentTraversal :: PointerSegment -> Traversal' Value Value+segmentTraversal (TextSegment t) f miss@(Object o) = case H.lookup t o of+ Nothing -> pure miss+ Just cv -> f cv+segmentTraversal (TextOrNumberSegment t _) f miss@(Object o) = case H.lookup t o of+ Nothing -> pure miss+ Just cv -> f cv+segmentTraversal (TextOrNumberSegment _ i) f miss@(Array a) = case a V.!? i of+ Nothing -> pure miss+ Just cv -> f cv+segmentTraversal _ _ miss = pure miss+{-# INLINE segmentTraversal #-}++valueAt :: JsonPointer -> Value -> Maybe Value+valueAt p v = v ^? pointerTraversal p+{-# INLINE valueAt #-}++overValueAt :: JsonPointer -> Value -> (Value -> Value) -> Value+overValueAt p v f = v & pointerTraversal p %~ f+{-# INLINE overValueAt #-}++-- | Parse a JSON Pointer at compile time and embed as an expression.+--+-- >>> [jsonPtr|/foo/0|]+-- JsonPointer {pointerSegments = [TextSegment "foo",TextOrNumberSegment "0" 0]}+jsonPtr :: QuasiQuoter+jsonPtr = QuasiQuoter+ { quoteExp = \str -> case parsePointer $ T.pack str of+ Left err -> fail err+ Right ok -> lift ok+ , quotePat = error "Patterns not supported by jsonPtr quasiquoter"+ , quoteType = error "Types not supported by jsonPtr quasiquoter"+ , quoteDec = error "Declarations not supported by jsonPtr quasiquoter"+ }
+ tests/doctests.hs view
@@ -0,0 +1,5 @@+module Main where+import Test.DocTest++main :: IO ()+main = doctest ["-isrc", "src/Data/Aeson/Pointer.hs"]
+ tests/tests.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF tasty-discover #-}