Update copyright, indent cabal consistently

CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on
 and this project adheres to
 [Haskell Package Versioning Policy](https://pvp.haskell.org/).
 
+## [Unreleased]
+### Removed
+- Deprecated `Language.GraphQL.Class.gql` (moved to `Language.GraphQL.TH`).
+
+### Added
+- `String` instances from `ToGraphQL` and `FromGraphQL`.
+
+## [1.0.6.0] - 2024-12-06
+### Added
+- `Language.GraphQL.Class.gql` is moved to `Language.GraphQL.TH` where it was
+  before in `graphql`.
+
 ## [1.0.5.0] - 2024-11-21
 ### Added
 - Add `ToGraphQL` and `FromGraphQL` instances for `Value` and `HashMap`.
@@ -41,6 +53,8 @@ and this project adheres to
 - JSON serialization.
 - Test helpers.
 
+[Unreleased]: https://git.caraus.tech/OSS/graphql-spice/compare/v1.0.6.0...master
+[1.0.6.0]: https://git.caraus.tech/OSS/graphql-spice/compare/v1.0.5.0...v1.0.6.0
 [1.0.5.0]: https://git.caraus.tech/OSS/graphql-spice/compare/v1.0.4.0...v1.0.5.0
 [1.0.4.0]: https://git.caraus.tech/OSS/graphql-spice/compare/v1.0.3.0...v1.0.4.0
 [1.0.3.0]: https://git.caraus.tech/OSS/graphql-spice/compare/v1.0.2.0...v1.0.3.0

graphql-spice.cabal

@@ -1,7 +1,7 @@
-cabal-version:      3.0
+cabal-version: 3.0
 
 name:               graphql-spice
-version:            1.0.5.0
+version:            1.0.6.0
 synopsis:           GraphQL with batteries
 description:        Various extensions and convenience functions for the core
                     graphql package.
@@ -10,44 +10,45 @@ homepage:           https://git.caraus.tech/OSS/graphql-spice
 bug-reports:        https://git.caraus.tech/OSS/graphql-spice/issues
 author:             Eugen Wissner <belka@caraus.de>
 maintainer:         belka@caraus.de
-copyright:          (c) 2021-2024 Eugen Wissner
+copyright:          (c) 2021-2025 Eugen Wissner
 license:            MPL-2.0
 license-files:      LICENSE
 build-type:         Simple
 extra-source-files: CHANGELOG.md
 tested-with:
-  GHC == 9.8.2
+  GHC == 9.10.1
 
 source-repository head
   type: git
   location: https://git.caraus.tech/OSS/graphql-spice.git
 
 library
-    exposed-modules:
+  exposed-modules:
-      Language.GraphQL.Class
+    Language.GraphQL.Class
-      Language.GraphQL.JSON
+    Language.GraphQL.JSON
-      Language.GraphQL.Resolver
+    Language.GraphQL.Resolver
-      Test.Hspec.GraphQL
+    Language.GraphQL.TH
-    other-modules:
+    Test.Hspec.GraphQL
-    hs-source-dirs:   src
+  other-modules:
-    ghc-options: -Wall
+  hs-source-dirs: src
-    build-depends:
+  ghc-options: -Wall
-      aeson >= 2.0.3 && < 2.3,
+  build-depends:
-      base >= 4.7 && < 5,
+    aeson >= 2.0.3 && < 2.3,
-      conduit ^>= 1.3.4,
+    base >= 4.7 && < 5,
-      containers >= 0.6 && < 0.8,
+    conduit ^>= 1.3.4,
-      exceptions ^>= 0.10.4,
+    containers >= 0.6 && < 0.8,
-      hspec-expectations >= 0.8.2 && < 0.9,
+    exceptions ^>= 0.10.4,
-      graphql >= 1.3.0 && < 1.5.0,
+    hspec-expectations >= 0.8.2 && < 0.9,
-      megaparsec >= 9.0 && < 10,
+    graphql ^>= 1.5.0,
-      scientific ^>= 0.3.7,
+    megaparsec >= 9.0 && < 10,
-      template-haskell >= 2.16 && < 3,
+    scientific ^>= 0.3.7,
-      text >= 1.2 && < 3,
+    template-haskell >= 2.16 && < 3,
-      time >= 1.12.2 && < 1.15,
+    text >= 1.2 && < 3,
-      transformers >= 0.5.6 && < 0.7,
+    time >= 1.12.2 && < 1.15,
-      vector >= 0.12 && < 0.14,
+    transformers >= 0.5.6 && < 0.7,
-      unordered-containers ^>= 0.2.16
+    vector >= 0.12 && < 0.14,
-    default-language: Haskell2010
+    unordered-containers ^>= 0.2.16
+  default-language: Haskell2010
 
 test-suite graphql-test
   type: exitcode-stdio-1.0
@@ -58,6 +59,7 @@ test-suite graphql-test
     Language.GraphQL.DirectiveSpec
     Language.GraphQL.FragmentSpec
     Language.GraphQL.RootOperationSpec
+    Language.GraphQL.THSpec
   hs-source-dirs:
     tests
   ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall

src/Language/GraphQL/Class.hs

@@ -14,7 +14,6 @@ module Language.GraphQL.Class
     , ToGraphQL(..)
     , deriveFromGraphQL
     , deriveToGraphQL
-    , gql
     ) where
 
 import Data.Int (Int8, Int16, Int32, Int64)
@@ -47,7 +46,6 @@ import Language.Haskell.TH
     , Dec(..)
     , Exp(..)
     , Info(..)
-    , Lit(..)
     , Quote(..)
     , Name
     , Q
@@ -75,7 +73,6 @@ import Language.Haskell.TH
     , litP
     , wildP
     )
-import Language.Haskell.TH.Quote (QuasiQuoter(..))
 import Data.Foldable (Foldable(..))
 import qualified Data.HashMap.Strict as HashMap
 import qualified Language.GraphQL.Type as Type
@@ -110,6 +107,10 @@ instance ToGraphQL Text
   where
     toGraphQL = Type.String
 
+instance ToGraphQL String
+  where
+    toGraphQL = Type.String . Text.pack
+
 instance ToGraphQL Int
   where
     toGraphQL = Type.Int . fromIntegral
@@ -222,6 +223,11 @@ instance FromGraphQL Text
     fromGraphQL (Type.String value) = Just value
     fromGraphQL _ = Nothing
 
+instance FromGraphQL String
+  where
+    fromGraphQL (Type.String value) = Just $ Text.unpack value
+    fromGraphQL _ = Nothing
+
 instance FromGraphQL Int
   where
     fromGraphQL = fromGraphQLToIntegral
@@ -459,39 +465,3 @@ deriveToGraphQL typeName = do
         [ litE (stringL $ nameBase name')
         , [|toGraphQL $(varE alias)|]
         ]
-
-stripIndentation :: String -> String
-stripIndentation code = reverse
-    $ dropWhile isLineBreak
-    $ reverse
-    $ unlines
-    $ indent spaces <$> lines' withoutLeadingNewlines
-  where
-    indent 0 xs = xs
-    indent count (' ' : xs) = indent (count - 1) xs
-    indent _ xs = xs
-    withoutLeadingNewlines = dropWhile isLineBreak code
-    spaces = length $ takeWhile (== ' ') withoutLeadingNewlines
-    lines' "" = []
-    lines' string =
-        let (line, rest) = break isLineBreak string
-            reminder =
-                case rest of
-                    [] -> []
-                    '\r' : '\n' : strippedString -> lines' strippedString
-                    _ : strippedString -> lines' strippedString
-         in line : reminder
-    isLineBreak = flip any ['\n', '\r'] . (==)
-
--- | Removes leading and trailing newlines. Indentation of the first line is
--- removed from each line of the string.
-gql :: QuasiQuoter
-gql = QuasiQuoter
-    { quoteExp = pure . LitE . StringL . stripIndentation
-    , quotePat = const
-        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a pattern)"
-    , quoteType = const
-        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a type)"
-    , quoteDec = const
-        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a declaration)"
-    }

src/Language/GraphQL/TH.hs

@@ -0,0 +1,49 @@
+{- 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 https://mozilla.org/MPL/2.0/. -}
+
+module Language.GraphQL.TH
+    ( gql
+    ) where
+
+import Language.Haskell.TH
+    ( Exp(..)
+    , Lit(..)
+    )
+import Language.Haskell.TH.Quote (QuasiQuoter(..))
+
+stripIndentation :: String -> String
+stripIndentation code = reverse
+    $ dropWhile isLineBreak
+    $ reverse
+    $ unlines
+    $ indent spaces <$> lines' withoutLeadingNewlines
+  where
+    indent 0 xs = xs
+    indent count (' ' : xs) = indent (count - 1) xs
+    indent _ xs = xs
+    withoutLeadingNewlines = dropWhile isLineBreak code
+    spaces = length $ takeWhile (== ' ') withoutLeadingNewlines
+    lines' "" = []
+    lines' string =
+        let (line, rest) = break isLineBreak string
+            reminder =
+                case rest of
+                    [] -> []
+                    '\r' : '\n' : strippedString -> lines' strippedString
+                    _ : strippedString -> lines' strippedString
+         in line : reminder
+    isLineBreak = flip any ['\n', '\r'] . (==)
+
+-- | Removes leading and trailing newlines. Indentation of the first line is
+-- removed from each line of the string.
+gql :: QuasiQuoter
+gql = QuasiQuoter
+    { quoteExp = pure . LitE . StringL . stripIndentation
+    , quotePat = const
+        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a pattern)"
+    , quoteType = const
+        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a type)"
+    , quoteDec = const
+        $ fail "Illegal gql QuasiQuote (allowed as expression only, used as a declaration)"
+    }

tests/Language/GraphQL/ClassSpec.hs

@@ -5,6 +5,7 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE TemplateHaskell #-}
+
 module Language.GraphQL.ClassSpec
     ( spec
     ) where
@@ -18,7 +19,6 @@ import Language.GraphQL.Class
     , ToGraphQL(..)
     , deriveFromGraphQL
     , deriveToGraphQL
-    , gql
     )
 import Test.Hspec (Spec, describe, it, shouldBe)
 import qualified Data.HashMap.Strict as HashMap
@@ -161,14 +161,3 @@ spec = do
             let given = Type.Enum "TWO_FIELD_ENUM_2"
                 expected = TWO_FIELD_ENUM_2
              in fromGraphQL given `shouldBe` Just expected
-
-    describe "gql" $
-        it "replaces CRNL with NL" $
-            let expected :: Text
-                expected = "line1\nline2\nline3"
-                actual = [gql|
-                  line1
-                  line2
-                  line3
-                |]
-             in actual `shouldBe` expected

tests/Language/GraphQL/CoerceSpec.hs

@@ -3,6 +3,7 @@
    obtain one at https://mozilla.org/MPL/2.0/. -}
 
 {-# LANGUAGE OverloadedStrings #-}
+
 module Language.GraphQL.CoerceSpec
     ( spec
     ) where

tests/Language/GraphQL/DirectiveSpec.hs

@@ -4,7 +4,6 @@
 
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
-{-# LANGUAGE PackageImports #-}
 
 module Language.GraphQL.DirectiveSpec
     ( spec
@@ -18,7 +17,7 @@ import Language.GraphQL.TH
 import Language.GraphQL.Type
 import qualified Language.GraphQL.Type.Out as Out
 import Test.Hspec (Spec, describe, it)
-import "graphql-spice" Test.Hspec.GraphQL
+import Test.Hspec.GraphQL
 
 experimentalResolver :: Schema IO
 experimentalResolver = schema queryType Nothing Nothing mempty

tests/Language/GraphQL/FragmentSpec.hs

@@ -4,7 +4,6 @@
 
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
-{-# LANGUAGE PackageImports #-}
 
 module Language.GraphQL.FragmentSpec
     ( spec
@@ -20,7 +19,7 @@ import qualified Language.GraphQL.Type.Out as Out
 import Language.GraphQL.TH
 import qualified Language.GraphQL as GraphQL
 import Test.Hspec (Spec, describe, it)
-import "graphql-spice" Test.Hspec.GraphQL
+import Test.Hspec.GraphQL
 
 size :: (Text, Value)
 size = ("size", String "L")

tests/Language/GraphQL/RootOperationSpec.hs

@@ -4,7 +4,6 @@
 
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
-{-# LANGUAGE PackageImports #-}
 
 module Language.GraphQL.RootOperationSpec
     ( spec
@@ -18,7 +17,7 @@ import Test.Hspec (Spec, describe, it)
 import Language.GraphQL.TH
 import Language.GraphQL.Type
 import qualified Language.GraphQL.Type.Out as Out
-import "graphql-spice" Test.Hspec.GraphQL
+import Test.Hspec.GraphQL
 
 hatType :: Out.ObjectType IO
 hatType = Out.ObjectType "Hat" Nothing []

tests/Language/GraphQL/THSpec.hs

@@ -0,0 +1,27 @@
+{- 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 https://mozilla.org/MPL/2.0/. -}
+
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE QuasiQuotes #-}
+
+module Language.GraphQL.THSpec
+    ( spec
+    ) where
+
+import Data.Text (Text)
+import Language.GraphQL.TH (gql)
+import Test.Hspec (Spec, describe, it, shouldBe)
+
+spec :: Spec
+spec = do
+    describe "gql" $
+        it "replaces CRNL with NL" $
+            let expected :: Text
+                expected = "line1\nline2\nline3"
+                actual = [gql|
+                  line1
+                  line2
+                  line3
+                |]
+             in actual `shouldBe` expected