hspec-expectations-json 1.0.0.0 → 1.0.0.1
raw patch · 4 files changed
+104/−80 lines, 4 filesdep ~HUnitdep ~aeson-qqdep ~base
Dependency ranges changed: HUnit, aeson-qq, base, hspec
Files
- CHANGELOG.md +11/−1
- LICENSE +7/−5
- README.md +3/−1
- hspec-expectations-json.cabal +83/−73
CHANGELOG.md view
@@ -1,1 +1,11 @@-TODO+## [*Unreleased*](https://github.com/freckle/hspec-expectations-json/compare/v1.0.0.1...master)++None++## [v1.0.0.1](https://github.com/freckle/hspec-expectations-json/compare/v1.0.0.0...v1.0.0.1)++- Relax `base` (GHC) upper bound++## [v1.0.0.0](https://github.com/freckle/hspec-expectations-json/tree/v1.0.0.0)++First tagged release.
LICENSE view
@@ -1,5 +1,7 @@-Copyright (c) 2020 Freckle Engineering <engineering@freckle.com>+The MIT License (MIT) +Copyright (c) 2020 Renaissance Learning Inc+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights@@ -7,13 +9,13 @@ copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in-all copies or substantial portions of the Software.+The above copyright notice and this permission notice shall be included in all+copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN-THE SOFTWARE.+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE+SOFTWARE.
README.md view
@@ -19,8 +19,10 @@ ## Usage -**NOTE**: this is effectively a distillation of the [Haddocks](#TODO), please+**NOTE**: this is effectively a distillation of the [Haddocks][], please view them directly for your installed version, to ensure accurate information.++[haddocks]: http://hackage.haskell.org/package/hspec-expectations-json/docs/Test-Hspec-Expectations-Json.html Four expectations exist with the following behaviors:
hspec-expectations-json.cabal view
@@ -1,83 +1,93 @@-cabal-version: 1.18---- This file has been generated from package.yaml by hpack version 0.31.2.------ see: https://github.com/sol/hpack------ hash: d230360984f4f18d1f942af26155cfa6065ecbc543e330f3f60c37c72ddd6336+cabal-version: 1.18+name: hspec-expectations-json+version: 1.0.0.1+license: MIT+license-file: LICENSE+copyright: 2020 Freckle Education+maintainer: engineering@freckle.com+author: Freckle Engineering+homepage: https://github.com/freckle/hspec-expectations-json#readme+bug-reports: https://github.com/freckle/hspec-expectations-json/issues+synopsis: Hspec expectations for JSON Values+description:+ Hspec expectations for JSON Values+ .+ Comparing JSON `Value`s in Haskell tests comes with some challenges:+ .+ - In API responses, additive changes are typically safe and an important way+ to evolve responses without breaking clients. Therefore, assertions against+ such responses often want to ignore any unexpected keys in `Object`s (at any+ depth), as any clients would.+ .+ - Order often doesn't matter in API responses either, so it should be possible+ to assert equality regardless of `Array` ordering (again, at any depth).+ .+ - When an assertion fails, showing the difference clearly needs to take the+ above into account (i.e. it can't show keys you've ignored, or ordering+ differences you didn't care about), and it has to display things clearly,+ e.g. as a diff.+ .+ This library handles all these things. -name: hspec-expectations-json-version: 1.0.0.0-synopsis: Hspec expectations for JSON Values-description: Hspec expectations for JSON Values- .- Comparing JSON `Value`s in Haskell tests comes with some challenges:- .- - In API responses, additive changes are typically safe and an important way- to evolve responses without breaking clients. Therefore, assertions against- such responses often want to ignore any unexpected keys in `Object`s (at any- depth), as any clients would.- .- - Order often doesn't matter in API responses either, so it should be possible- to assert equality regardless of `Array` ordering (again, at any depth).- .- - When an assertion fails, showing the difference clearly needs to take the- above into account (i.e. it can't show keys you've ignored, or ordering- differences you didn't care about), and it has to display things clearly,- e.g. as a diff.- .- This library handles all these things.-category: Test-homepage: https://github.com/freckle/hspec-expectations-json#readme-bug-reports: https://github.com/freckle/hspec-expectations-json/issues-author: Freckle Engineering-maintainer: engineering@freckle.com-copyright: 2020 Freckle Education-license: MIT-license-file: LICENSE-build-type: Simple+category: Test+build-type: Simple extra-doc-files: CHANGELOG.md README.md source-repository head- type: git- location: https://github.com/freckle/hspec-expectations-json+ type: git+ location: https://github.com/freckle/hspec-expectations-json library- exposed-modules:- Test.Hspec.Expectations.Json- Test.Hspec.Expectations.Json.Internal- other-modules:- Paths_hspec_expectations_json- hs-source-dirs:- library- default-extensions: BangPatterns DataKinds DeriveAnyClass DeriveFoldable DeriveFunctor DeriveGeneric DeriveLift DeriveTraversable DerivingStrategies FlexibleContexts FlexibleInstances GADTs GeneralizedNewtypeDeriving LambdaCase MultiParamTypeClasses NoImplicitPrelude NoMonomorphismRestriction OverloadedStrings RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TypeApplications TypeFamilies- build-depends:- Diff >=0.4.0 && <0.5- , HUnit >=1.6.0.0 && <1.7- , aeson >=1.4.7.1 && <1.5- , aeson-pretty >=0.8.8 && <0.9- , base >=4.11 && <4.14- , scientific >=0.3.6.2 && <0.4- , text >=1.2.4.0 && <1.3- , unordered-containers >=0.2.10.0 && <0.3- , vector >=0.12.1.2 && <0.13- default-language: Haskell2010+ exposed-modules:+ Test.Hspec.Expectations.Json+ Test.Hspec.Expectations.Json.Internal + hs-source-dirs: library+ other-modules: Paths_hspec_expectations_json+ default-language: Haskell2010+ default-extensions:+ BangPatterns DataKinds DeriveAnyClass DeriveFoldable DeriveFunctor+ DeriveGeneric DeriveLift DeriveTraversable DerivingStrategies+ FlexibleContexts FlexibleInstances GADTs GeneralizedNewtypeDeriving+ LambdaCase MultiParamTypeClasses NoImplicitPrelude+ NoMonomorphismRestriction OverloadedStrings RankNTypes+ RecordWildCards ScopedTypeVariables StandaloneDeriving+ TypeApplications TypeFamilies++ build-depends:+ Diff >=0.4.0 && <0.5,+ HUnit >=1.6.1.0 && <1.7,+ aeson >=1.4.7.1 && <1.5,+ aeson-pretty >=0.8.8 && <0.9,+ base >=4.11 && <4.15,+ scientific >=0.3.6.2 && <0.4,+ text >=1.2.4.0 && <1.3,+ unordered-containers >=0.2.10.0 && <0.3,+ vector >=0.12.1.2 && <0.13+ test-suite spec- type: exitcode-stdio-1.0- main-is: Spec.hs- other-modules:- Test.Hspec.Expectations.Json.InternalSpec- Test.Hspec.Expectations.JsonSpec- Paths_hspec_expectations_json- hs-source-dirs:- tests- default-extensions: BangPatterns DataKinds DeriveAnyClass DeriveFoldable DeriveFunctor DeriveGeneric DeriveLift DeriveTraversable DerivingStrategies FlexibleContexts FlexibleInstances GADTs GeneralizedNewtypeDeriving LambdaCase MultiParamTypeClasses NoImplicitPrelude NoMonomorphismRestriction OverloadedStrings RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TypeApplications TypeFamilies- build-depends:- aeson-qq- , base >=4.11 && <4.14- , hspec- , hspec-expectations-json- default-language: Haskell2010+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ hs-source-dirs: tests+ other-modules:+ Test.Hspec.Expectations.Json.InternalSpec+ Test.Hspec.Expectations.JsonSpec+ Paths_hspec_expectations_json++ default-language: Haskell2010+ default-extensions:+ BangPatterns DataKinds DeriveAnyClass DeriveFoldable DeriveFunctor+ DeriveGeneric DeriveLift DeriveTraversable DerivingStrategies+ FlexibleContexts FlexibleInstances GADTs GeneralizedNewtypeDeriving+ LambdaCase MultiParamTypeClasses NoImplicitPrelude+ NoMonomorphismRestriction OverloadedStrings RankNTypes+ RecordWildCards ScopedTypeVariables StandaloneDeriving+ TypeApplications TypeFamilies++ build-depends:+ aeson-qq >=0.8.3 && <0.9,+ base >=4.11 && <4.15,+ hspec >=2.7.4 && <2.8,+ hspec-expectations-json -any