linnet-aeson (empty) → 0.1.0.1

raw patch · 12 files changed

+446/−0 lines, 12 filesdep +QuickCheckdep +aesondep +basesetup-changed

Dependencies added: QuickCheck, aeson, base, bytestring, hspec, linnet, linnet-aeson, quickcheck-classes, quickcheck-instances, text

Files

• LICENSE +201/−0
• README.md +12/−0
• Setup.hs +2/−0
• linnet-aeson.cabal +61/−0
• src/Linnet/Aeson.hs +31/−0
• test/DecodeJsonLaws.hs +29/−0
• test/DecodeSpec.hs +25/−0
• test/EncodeJsonLaws.hs +23/−0
• test/EncodeSpec.hs +25/−0
• test/Foo.hs +24/−0
• test/Spec.hs +1/−0
• test/Util.hs +12/−0

@@ -0,0 +1,201 @@+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright 2019 Sergey Kolbasov++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

@@ -0,0 +1,12 @@+# Linnet Aeson++This package adds support of JSON requests & responses in Linnet library+using [aeson](http://hackage.haskell.org/package/aeson).++Add following import to put orphan instances of `Encode` and `Decode` in scope:+```haskell+import Linnet.Aeson+```++Each type that has `FromJSON` and `ToJSON` instances automatically gets corresponding+instances of `Decode ApplicationJson` and `Encode ApplicationJson`.

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,61 @@+cabal-version: 1.12+name: linnet-aeson+version: 0.1.0.1+license: Apache+license-file: LICENSE+copyright: 2019 Sergey Kolbasov+maintainer: whoisliar@gmail.com+author: Sergey Kolbasov+homepage: https://github.com/haskell-linnet/linnet-aeson#readme+bug-reports: https://github.com/haskell-linnet/linnet-aeson/issues+synopsis: Aeson JSON support for Linnet+description:+    Please see the documentation at <http://linnet.io>+category: linnet+build-type: Simple+extra-source-files:+    README.md+    LICENSE++source-repository head+    type: git+    location: https://github.com/haskell-linnet/linnet-aeson++library+    exposed-modules:+        Linnet.Aeson+    hs-source-dirs: src+    other-modules:+        Paths_linnet_aeson+    default-language: Haskell2010+    build-depends:+        aeson >=1.4.4.0,+        base >=4.7 && <5,+        bytestring >=0.10.8.2,+        linnet >=0.1.0.1++test-suite linnet-aeson-test+    type: exitcode-stdio-1.0+    main-is: Spec.hs+    hs-source-dirs: test+    other-modules:+        DecodeJsonLaws+        DecodeSpec+        EncodeJsonLaws+        EncodeSpec+        Foo+        Util+        Paths_linnet_aeson+    default-language: Haskell2010+    ghc-options: -threaded -rtsopts -with-rtsopts=-N+    build-depends:+        QuickCheck >=2.13.2,+        aeson >=1.4.4.0,+        base >=4.7 && <5,+        bytestring >=0.10.8.2,+        hspec >=2.7.1,+        linnet >=0.1.0.1,+        linnet-aeson -any,+        quickcheck-classes >=0.6.1.0,+        quickcheck-instances >=0.3.22,+        text >=1.2.3.1

@@ -0,0 +1,31 @@+{-# LANGUAGE FlexibleInstances     #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE TypeSynonymInstances  #-}++{-|+Module: Linnet Aeson+Description: Aeson JSON support for Linnet+Copyright: (c) Sergey Kolbasov, 2019+License: Apache License 2.0++This package adds support of JSON requests & responses in Linnet library+using <http://hackage.haskell.org/package/aeson aeson>.++See the detailed documentation on <http://linnet.io linnet.io>.++-}+module Linnet.Aeson where++import           Control.Arrow         (left)+import qualified Data.Aeson            as Aeson+import qualified Data.ByteString.Char8 as C8+import           Linnet.ContentTypes   (ApplicationJson)+import           Linnet.Decode+import           Linnet.Encode+import           Linnet.Errors++instance {-# OVERLAPPABLE #-} Aeson.ToJSON a => Encode ApplicationJson a where+  encode = Aeson.encode++instance {-# OVERLAPPABLE #-} Aeson.FromJSON a => Decode ApplicationJson a where+  decode = left (DecodeError . C8.pack) . Aeson.eitherDecode

@@ -0,0 +1,29 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE FlexibleContexts    #-}+{-# LANGUAGE OverloadedStrings   #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications    #-}++module DecodeJsonLaws+  ( decodeJsonLaws+  ) where++import qualified Data.Aeson              as Aeson+import           Data.ByteString.Lazy+import           Linnet                  (ApplicationJson)+import           Linnet.Decode+import           Linnet.Errors           (LinnetError (..))+import           Test.QuickCheck         (Arbitrary, property)+import           Test.QuickCheck.Classes (Laws (..))++decodeJsonLaws ::+     forall a. (Decode ApplicationJson a, Arbitrary a, Show a, Eq a, Aeson.ToJSON a)+  => Laws+decodeJsonLaws = Laws "DecodeJSON" laws+  where+    roundTrip = property $ \(a :: a) -> decode @ApplicationJson (Aeson.encode a) == Right a+    errorHandle =+      property $ \(a :: a) ->+        case decode @ApplicationJson @a ("@" `append` Aeson.encode a) of+          Left (DecodeError err) -> True+    laws = [("roundTrip", roundTrip), ("errorHandle", errorHandle)]

@@ -0,0 +1,25 @@+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications    #-}++module DecodeSpec+  ( spec+  ) where++import           Data.ByteString           (ByteString)+import           Data.Text                 (Text)+import           DecodeJsonLaws+import           Foo+import           Linnet.Aeson+import           Test.Hspec+import           Test.QuickCheck           (property)+import           Test.QuickCheck.Instances+import           Util++spec :: Spec+spec = do+  checkLaws "Int" $ decodeJsonLaws @Int+  checkLaws "Text" $ decodeJsonLaws @Text+  checkLaws "Bool" $ decodeJsonLaws @Bool+  checkLaws "Foo" $ decodeJsonLaws @Foo+  checkLaws "Maybe Foo" $ decodeJsonLaws @(Maybe Foo)+  checkLaws "[Foo]" $ decodeJsonLaws @[Foo]

@@ -0,0 +1,23 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE DataKinds           #-}+{-# LANGUAGE FlexibleContexts    #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications    #-}++module EncodeJsonLaws+  ( encodeJsonLaws+  ) where++import qualified Data.Aeson              as Aeson+import           Linnet.ContentTypes     (ApplicationJson)+import           Linnet.Encode+import           Test.QuickCheck         (Arbitrary, property)+import           Test.QuickCheck.Classes (Laws (..))++encodeJsonLaws ::+     forall a. (Encode ApplicationJson a, Arbitrary a, Show a, Aeson.FromJSON a, Eq a)+  => Laws+encodeJsonLaws = Laws "EncodeJSON" properties+  where+    roundTrip = property $ \(a :: a) -> (Aeson.decode . encode @ApplicationJson) a == Just a+    properties = [("roundTrip", roundTrip)]

@@ -0,0 +1,25 @@+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications    #-}++module EncodeSpec+  ( spec+  ) where++import           Data.ByteString           (ByteString)+import           Data.Text                 (Text)+import           EncodeJsonLaws+import           Foo+import           Linnet.Aeson+import           Test.Hspec+import           Test.QuickCheck           (property)+import           Test.QuickCheck.Instances+import           Util++spec :: Spec+spec = do+  checkLaws "Int" $ encodeJsonLaws @Int+  checkLaws "Text" $ encodeJsonLaws @Text+  checkLaws "Bool" $ encodeJsonLaws @Bool+  checkLaws "Foo" $ encodeJsonLaws @Foo+  checkLaws "Maybe Foo" $ encodeJsonLaws @(Maybe Foo)+  checkLaws "[Foo]" $ encodeJsonLaws @[Foo]

@@ -0,0 +1,24 @@+{-# LANGUAGE DeriveGeneric #-}++module Foo+  ( Foo(..)+  ) where++import           Data.Aeson+import           GHC.Generics              (Generic)+import           Test.QuickCheck.Arbitrary (Arbitrary (..))++data Foo =+  Foo+    { x :: String+    , y :: Int+    , z :: Maybe Bool+    }+  deriving (Generic, Eq, Show)++instance ToJSON Foo++instance FromJSON Foo++instance Arbitrary Foo where+  arbitrary = Foo <$> arbitrary <*> arbitrary <*> arbitrary

@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}

@@ -0,0 +1,12 @@+module Util+  ( checkLaws+  ) where++import           Test.Hspec+import           Test.QuickCheck.Classes (Laws, lawsProperties, lawsTypeclass)++checkLaws :: String -> Laws -> SpecWith ()+checkLaws name laws = describe (lawsTypeclass laws ++ " @" ++ name) properties+  where+    properties :: SpecWith ()+    properties = mapM_ (uncurry it) (lawsProperties laws)