conferer-aeson (empty) → 1.0.0.0
raw patch · 9 files changed
+770/−0 lines, 9 filesdep +aesondep +aeson-qqdep +basesetup-changed
Dependencies added: aeson, aeson-qq, base, bytestring, conferer, conferer-aeson, directory, hspec, text, unordered-containers, vector
Files
- CHANGELOG.md +16/−0
- LICENSE +373/−0
- README.md +1/−0
- Setup.hs +2/−0
- conferer-aeson.cabal +74/−0
- src/Conferer/FromConfig/Aeson.hs +26/−0
- src/Conferer/Source/Aeson.hs +147/−0
- test/Conferer/Source/AesonSpec.hs +130/−0
- test/Spec.hs +1/−0
+ CHANGELOG.md view
@@ -0,0 +1,16 @@+# Changelog+All notable changes to this project will be documented in this file.++The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),+and this project adheres to [PVP](https://pvp.haskell.org/).++## [Unreleased]++Nothing++## [v1.0.0.0] 2020-12-29++First release++[Unreleased]: https://github.com/ludat/conferer/compare/conferer-aeson_v1.0.0.0...HEAD+[v1.0.0.0]: https://github.com/ludat/conferer/compare/v0.0.0.0...conferer-aeson_v1.0.0.0
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,1 @@+# conferer-source-json
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ conferer-aeson.cabal view
@@ -0,0 +1,74 @@+cabal-version: 1.18++-- This file has been generated from package.yaml by hpack version 0.33.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: 2543e03c19711f47aefac06d11874917b5f28a3c1d272d42fbb5d4016968c1cd++name: conferer-aeson+version: 1.0.0.0+synopsis: conferer's source for reading json files++description: Library to abstract the parsing of many haskell config values from different config sources+category: Configuration+homepage: https://conferer.ludat.io+author: Lucas David Traverso+maintainer: lucas6246@gmail.com+copyright: (c) 2020 Lucas David Traverso+license: MPL-2.0+license-file: LICENSE+build-type: Simple+extra-doc-files:+ README.md+ CHANGELOG.md+ LICENSE++library+ exposed-modules:+ Conferer.FromConfig.Aeson+ Conferer.Source.Aeson+ other-modules:+ Paths_conferer_aeson+ hs-source-dirs:+ src+ default-extensions: OverloadedStrings LambdaCase QuasiQuotes ScopedTypeVariables RecordWildCards StrictData+ ghc-options: -Wall -Wredundant-constraints -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns+ build-depends:+ aeson >=0.10 && <2.0+ , base >=4.3 && <5+ , bytestring >=0.10 && <0.11+ , conferer >=1.0.0.0 && <2.0.0.0+ , directory >=1.2 && <2.0+ , text >=1.1 && <1.3+ , unordered-containers+ , vector+ if impl(ghc >= 8.4.1)+ ghc-options: -Wpartial-fields+ default-language: Haskell2010++test-suite specs+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ Conferer.Source.AesonSpec+ Paths_conferer_aeson+ hs-source-dirs:+ test+ default-extensions: OverloadedStrings LambdaCase QuasiQuotes ScopedTypeVariables RecordWildCards StrictData+ ghc-options: -Wall -Wredundant-constraints -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns+ build-depends:+ aeson >=0.10 && <2.0+ , aeson-qq+ , base >=4.3 && <5+ , bytestring >=0.10 && <0.11+ , conferer+ , conferer-aeson+ , directory >=1.2 && <2.0+ , hspec+ , text >=1.1 && <1.3+ , unordered-containers+ , vector+ if impl(ghc >= 8.4.1)+ ghc-options: -Wpartial-fields+ default-language: Haskell2010
+ src/Conferer/FromConfig/Aeson.hs view
@@ -0,0 +1,26 @@+-- |+-- Copyright: (c) 2019 Lucas David Traverso+-- License: MPL-2.0+-- Maintainer: Lucas David Traverso <lucas6246@gmail.com>+-- Stability: stable+-- Portability: portable+--+-- Source for json config files using Aeson+{-# LANGUAGE TypeApplications #-}+{-# OPTIONS_GHC -fno-warn-orphans #-}+module Conferer.FromConfig.Aeson where++import Data.Aeson++import Conferer.FromConfig+import Data.Text (Text)+import qualified Data.Text.Encoding as Text++instance FromConfig Value where+ fetchFromConfig key config = do+ rawAeson <- fetchFromConfig @Text key config+ case eitherDecodeStrict' @Value $ Text.encodeUtf8 rawAeson of+ Right value -> + return value+ Left _ -> + throwConfigParsingError @Value key rawAeson
+ src/Conferer/Source/Aeson.hs view
@@ -0,0 +1,147 @@+-- |+-- Copyright: (c) 2019 Lucas David Traverso+-- License: MPL-2.0+-- Maintainer: Lucas David Traverso <lucas6246@gmail.com>+-- Stability: stable+-- Portability: portable+--+-- Source for json config files using Aeson+{-# LANGUAGE RecordWildCards #-}+module Conferer.Source.Aeson where++import Data.Aeson+import Control.Applicative+import qualified Data.HashMap.Strict as HashMap+import Data.Text (Text)+import qualified Data.Text as Text+import qualified Data.Text.Encoding as Text+import Data.Vector ((!?))+import qualified Data.Vector as Vector+import Text.Read (readMaybe)+import qualified Data.ByteString as B+import qualified Data.ByteString.Lazy as L+import Data.List (intersperse)+import System.Directory (doesFileExist)++import Conferer.Source.Files+import qualified Conferer.Source.Null as Null+import Conferer.Source++-- | 'Source' that read a config file as json and uses that value in a way that+-- makes sense for Conferer but doesn't respect json perfectly.+data JsonSource = JsonSource+ { value :: Value+ } deriving (Show, Eq)++instance IsSource JsonSource where+ getKeyInSource JsonSource {..} key = do+ return $ valueToText =<< traverseJSON key value+ getSubkeysInSource JsonSource {..} key = do+ return $ fmap (key /.) $ maybe [] listKeysInJSON $ traverseJSON key value++-- | Create a 'SourceCreator' which uses files with @config/{env}.json@+-- template and then uses 'fromFilePath'+fromConfig :: Key -> SourceCreator+fromConfig key config = do+ fileToParse <- getFilePathFromEnv key "json" config+ fromFilePath fileToParse++-- | Create a 'Source' from a filepath+--+-- If the file is not present it will behave as if it had no keys.+--+-- If the file doesn't have valid json it will throw an error.+fromFilePath :: FilePath -> IO Source+fromFilePath fileToParse = do+ fileExists <- doesFileExist fileToParse+ if fileExists+ then do+ value <- decodeStrict' <$> B.readFile fileToParse+ case value of+ Nothing ->+ error $ "Failed to decode json file '" ++ fileToParse ++ "'"+ Just v -> do+ return $ fromValue v+ else do+ return $ Null.empty++-- | Create a 'Source' from a json value, never fails.+fromValue :: Value -> Source+fromValue value =+ Source JsonSource {..}++-- | Traverse a 'Value' using a 'Key' to get a 'Value'.+--+-- This function can nest objects and arrays when keys are nested+--+-- @+-- 'traverseJSON' "a.b" {a: {b: 12}} == Just "12"+-- 'traverseJSON' "a.b" {a: {b: false}} == Just "false"+-- 'traverseJSON' "a" {a: {b: false}} == Nothing+-- 'traverseJSON' "1" [false, true] == Just "true"+-- 'traverseJSON' "0.a" [{a: "hi"}] == Just "hi"+-- 'traverseJSON' "0" [] == Nothing+-- @+traverseJSON :: Key -> Value -> Maybe Value+traverseJSON key value =+ case (unconsKey key, value) of+ (Nothing, v) ->+ Just v+ (Just ("keys", ""), Object o) ->+ HashMap.lookup "keys" o+ <|> pure (+ String $+ mconcat $+ intersperse "," $+ HashMap.keys o)+ (Just (c, ks), Object o) ->+ HashMap.lookup c o >>= traverseJSON ks+ (Just ("keys", ""), Array vs) ->+ Just $+ String $+ mconcat $+ intersperse "," $+ fmap (Text.pack . show)+ [0..length vs - 1]+ (Just (c, ks), Array vs) -> do+ n :: Int <- readMaybe $ Text.unpack c+ v <- vs !? n+ traverseJSON ks v+ (Just _, _) ->+ Nothing++-- | Get the list of available keys inside a json value+listKeysInJSON :: Value -> [Key]+listKeysInJSON = go ""+ where+ go :: Key -> Value -> [Key]+ go key value =+ case (unconsKey key, value) of+ (_, Object o) -> do+ (k, v) <- HashMap.toList o+ go (key /. fromText k) v+ (_, Array as) -> do+ (index :: Integer, v) <- zip [0..] $ Vector.toList as+ go (key /. mkKey (show index)) v+ (Nothing, _) -> []+ (_, _) -> [key]++-- | Turn json 'Value' into 'Text' to return that key+valueToText :: Value -> Maybe Text+valueToText (String t) = Just t+valueToText (Object _o) = Nothing+valueToText (Array _as) = Nothing+valueToText (Number n) = Just $ Text.decodeUtf8 $ L.toStrict $ encode $ Number n+valueToText (Bool b) = Just $ boolToString b+valueToText (Null) = Nothing++-- | Turn a 'GHC.Types.Bool' into a 'Text'+boolToString :: Bool -> Text+boolToString True = "true"+boolToString False = "false"++-- | Because we use an old version of aeson+resultToMaybe :: Result a -> Maybe a+resultToMaybe (Error _) = Nothing+resultToMaybe (Success a) = Just a+
+ test/Conferer/Source/AesonSpec.hs view
@@ -0,0 +1,130 @@+module Conferer.Source.AesonSpec where++import Data.Aeson.QQ+import Test.Hspec++import Conferer.Source+import Conferer.Source.Aeson++spec :: Spec+spec = do+ describe "json source" $ do+ let mk = return . fromValue+ describe "#getKeyInSource" $ do+ it "getting an existing path returns the right value" $ do+ c <- mk [aesonQQ| {"postgres": {"url": "some url", "ssl": true}} |]+ res <- getKeyInSource c "postgres.url"+ res `shouldBe` Just "some url"++ it "getting an non existing path returns nothing" $ do+ c <- mk [aesonQQ| {"postgres": {"url": "some url", "ssl": true}} |]+ res <- getKeyInSource c "some.path"+ res `shouldBe` Nothing++ it "getting an non existing path returns nothing" $ do+ c <- mk [aesonQQ| {"postgres": {"url": "some url", "ssl": true}} |]+ res <- getKeyInSource c "some.path"+ res `shouldBe` Nothing++ describe "with an array" $ do+ it "getting a path with number gets the right value" $ do+ c <- mk [aesonQQ| {"key": ["value"]} |]+ res <- getKeyInSource c "key.0"+ res `shouldBe` Just "value"+ describe "magic 'keys' key" $ do+ context "with an empy array" $ do+ it "the magic 'keys' key is \"\"" $ do+ c <- mk [aesonQQ| {"key": []} |]+ res <- getKeyInSource c "key.keys"+ res `shouldBe` Just ""+ context "with a non empty array" $ do+ it "the magic 'keys' key is a comma separated list of all \+ \indexes present on the array" $ do+ c <- mk [aesonQQ| {"key": [true, true, true]}|]+ res <- getKeyInSource c "key.keys"+ res `shouldBe` Just "0,1,2"++ describe "with an object" $ do+ it "getting an existing path returns nothing" $ do+ c <- mk [aesonQQ| {"key": { "path": "value"}}|]+ res <- getKeyInSource c "key"+ res `shouldBe` Nothing+ describe "magic 'keys' key" $ do+ context "with an empy object" $ do+ it "the magic 'keys' key is \"\"" $ do+ c <- mk [aesonQQ| {"key": {}}|]+ res <- getKeyInSource c "key.keys"+ res `shouldBe` Just ""+ context "with a non empty object" $ do+ it "the magic 'keys' key is a comma separated list of all \+ \keys present in the object" $ do+ c <- mk [aesonQQ| {"key": {a: true, b: true, c: true}}|]+ res <- getKeyInSource c "key.keys"+ res `shouldBe` Just "a,b,c"+ context "with an object that has a 'keys' key present" $ do+ it "return its value instead of doing the metamagic" $ do+ c <- mk [aesonQQ| {"key": {keys: "something", c: true}}|]+ res <- getKeyInSource c "key.keys"+ res `shouldBe` Just "something"++ describe "with an int" $ do+ it "getting an existing path returns the right value" $ do+ c <- mk [aesonQQ| {"key": 1} |]+ res <- getKeyInSource c "key"+ res `shouldBe` Just "1"++ describe "with a float" $ do+ it "getting an existing path returns the right value" $ do+ c <- mk [aesonQQ| {"key": 1.2} |]+ res <- getKeyInSource c "key"+ res `shouldBe` Just "1.2"++ describe "with a boolean" $ do+ it "getting an existing path returns the right value" $ do+ c <- mk [aesonQQ| {"key": false} |]+ res <- getKeyInSource c "key"+ res `shouldBe` Just "false"+++ context "#getSubkeysInSource" $ do+ describe "listing keys in non existant path" $ do+ it "gets no keys" $ do+ c <- mk [aesonQQ|{}|]+ res <- getSubkeysInSource c "a"+ res `shouldBe` []+ describe "listing keys with an empty object" $ do+ it "gets only the 'keys' magic key" $ do+ c <- mk [aesonQQ|{}|]+ res <- getSubkeysInSource c ""+ res `shouldBe` []+ describe "gettings a existing subkey directly" $ do+ it "gets no keys" $ do+ c <- mk [aesonQQ|{"key": 7}|]+ res <- getSubkeysInSource c "key"+ res `shouldBe` []+ describe "getting the subkeys for an object" $ do+ it "gets the keys" $ do+ c <- mk [aesonQQ|{"key": 7}|]+ res <- getSubkeysInSource c ""+ res `shouldBe` ["key"]+ describe "gettings the keys from a list and an object" $ do+ it "gets the keys as index numbers" $ do+ c <- mk [aesonQQ|{"a": ["a"]}|]+ res <- getSubkeysInSource c ""+ res `shouldBe` ["a.0"]+ describe "getting the keys from subkeys" $ do+ it "gets no keys" $ do+ c <- mk [aesonQQ|{"a": ["a"]}|]+ res <- getSubkeysInSource c "a"+ res `shouldBe` ["a.0"]+ describe "gettings the keys from nested objects" $ do+ it "gets those keys and all intermediate magic 'keys' keys" $ do+ c <- mk [aesonQQ|{"a": {"a": 7}}|]+ res <- getSubkeysInSource c ""+ res `shouldBe` ["a.a"]+ describe "gettings the keys from list" $ do+ it "returns the present indexes" $ do+ c <- mk [aesonQQ|[true, true, true]|]+ res <- getSubkeysInSource c ""+ res `shouldBe` ["0", "1", "2"]+
+ test/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}