diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,374 @@ +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. + diff --git a/hasql-auto.cabal b/hasql-auto.cabal new file mode 100644 --- /dev/null +++ b/hasql-auto.cabal @@ -0,0 +1,78 @@ +cabal-version: 2.4 +name: hasql-auto +version: 0.1.0.0 +license: MPL-2.0 +copyright: 2026 Michael Ledger +maintainer: Michael Ledger +author: Michael Ledger +category: Web +homepage: https://gitlab.com/combobulate.systems/hasql-auto +synopsis: Automatically derived encoders and decoders for Hasql +description: + . + Write less boilerplate when decoding or encoding things out of or into Hasql. + . + This package provides a superset of functionality of + [hasql-implicits](https://hackage.haskell.org/package/hasql-implicits) and + [hasql-generic](https://hackage.haskell.org/package/hasql-generic), by adding + its own utility functions, types, and instances. + . + "Hasql.Auto.Decoders" is substantively derived from [hasql-implicits](https://hackage.haskell.org/package/hasql-implicits). + +extra-source-files: + LICENSE + +common shared + default-extensions: + AllowAmbiguousTypes + BangPatterns + BlockArguments + DataKinds + DerivingStrategies + DerivingVia + DuplicateRecordFields + ExplicitForAll + GADTs + ImportQualifiedPost + LambdaCase + MultiWayIf + NoStarIsType + OverloadedRecordDot + OverloadedStrings + PartialTypeSignatures + PatternSynonyms + PolyKinds + RequiredTypeArguments + ScopedTypeVariables + StrictData + TemplateHaskell + TemplateHaskellQuotes + TypeFamilies + UndecidableInstances + ViewPatterns + + build-depends: + aeson ^>=2.2, + base >=4 && <5, + bytestring, + generics-sop, + hasql >=1.9 && <1.10, + iproute ^>=1.7, + postgresql-binary >=0.14, + scientific ^>=0.3, + text, + time, + uuid, + vector, + + default-language: GHC2021 + +library + import: shared + -- cabal-gild: discover lib + exposed-modules: + Hasql.Auto.Decoders + Hasql.Auto.Encoders + Hasql.Auto.Types + + hs-source-dirs: lib diff --git a/lib/Hasql/Auto/Decoders.hs b/lib/Hasql/Auto/Decoders.hs new file mode 100644 --- /dev/null +++ b/lib/Hasql/Auto/Decoders.hs @@ -0,0 +1,303 @@ +-- | Obtain row decoders automatically via either constructors or @ generics-sop @ +module Hasql.Auto.Decoders ( + -- * Rows + defaultRowFor, + defaultRowForProductType, + defaultColumn, + + -- * Composites + defaultCompositeFor, + defaultCompositeForProductType, + defaultCompositeField, + + -- * Value decoding + defaultNullableOrNotValue, + DefaultValue (..), + + -- * Types + LiftDefaultRow, + DefaultRowFor, + DefaultCompositeFor, + DefaultNullableOrNotValue, +) +where + +import Data.Aeson (FromJSON (..)) +import Data.Aeson qualified as JSON +import Data.ByteString (ByteString) +import Data.Functor ((<&>)) +import Data.Int (Int16, Int32, Int64) +import Data.Proxy (Proxy (..)) +import Data.Scientific (Scientific) +import Data.String (fromString) +import Data.Text (Text) +import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime) +import Data.Vector (Vector) +import Generics.SOP qualified as SOP +import Hasql.Auto.Types +import Hasql.Decoders qualified as D +import PostgreSQL.Binary.Range (Multirange, Range (..)) + +-------------------------------------------------------------------------------- +-- Rows +-------------------------------------------------------------------------------- + +-- | Create a 'D.Row' decoder for a given constructor function. Each argument of +-- the constructor function corresponds to a column to be decoded in the row, +-- whose decoder is provided by 'DefaultNullableOrNotValue', which determines +-- the use of 'D.nullable' or 'D.nonNullable', and is an abstraction over +-- the user-extensible 'DefaultValue' typeclass. +{-# INLINE defaultRowFor #-} +defaultRowFor + :: forall a f + . (DefaultRowFor a f) + => f + -> D.Row a +defaultRowFor f = liftDefaultRow @(GetConstructorShape f) (pure f) + +-- | Create a 'D.Row' decoder for any product type with a 'SOP.Generic' instance +{-# INLINE defaultRowForProductType #-} +defaultRowForProductType :: (SOP.IsProductType a xs, SOP.All DefaultNullableOrNotValue xs) => D.Row a +defaultRowForProductType = + SOP.productTypeTo + <$> SOP.hsequence (SOP.hcpure (Proxy :: Proxy DefaultNullableOrNotValue) defaultColumn) + +type DefaultRowFor a f = LiftDefaultRow (GetConstructorShape f) a f + +class LiftDefaultRow (shape :: ConstructorShape) a f where + liftDefaultRow :: D.Row f -> D.Row a + +instance + ( DefaultNullableOrNotValue x + , LiftDefaultRow next r' r + ) + => LiftDefaultRow (AddColumn next) r' (x -> r) + where + {-# INLINE liftDefaultRow #-} + liftDefaultRow r = liftDefaultRow @next (r <*> defaultColumn) + +instance (r ~ r') => LiftDefaultRow DecoderDone r r' where + {-# INLINE liftDefaultRow #-} + liftDefaultRow r = r + +defaultColumn :: (DefaultNullableOrNotValue a) => D.Row a +defaultColumn = D.column defaultNullableOrNotValue + +-------------------------------------------------------------------------------- +-- Composite s +-------------------------------------------------------------------------------- + +type DefaultCompositeFor a f = LiftDefaultComposite (GetConstructorShape f) a f + +-- | Create a 'D.Composite' decoder for a given constructor function, a la +-- 'defaultRowFor'. +{-# INLINE defaultCompositeFor #-} +defaultCompositeFor + :: forall a f + . (DefaultCompositeFor a f) + => f + -> D.Composite a +defaultCompositeFor f = + liftDefaultComposite @(GetConstructorShape f) (pure f) + +-- | Create a 'D.Composite' decoder for any product type with a 'SOP.Generic' instance +{-# INLINE defaultCompositeForProductType #-} +defaultCompositeForProductType :: (SOP.IsProductType a xs, SOP.All DefaultNullableOrNotValue xs) => D.Composite a +defaultCompositeForProductType = + SOP.productTypeTo + <$> SOP.hsequence (SOP.hcpure (Proxy :: Proxy DefaultNullableOrNotValue) defaultCompositeField) + +class LiftDefaultComposite (shape :: ConstructorShape) a f where + liftDefaultComposite :: D.Composite f -> D.Composite a + +instance + ( DefaultNullableOrNotValue x + , LiftDefaultComposite next r' r + ) + => LiftDefaultComposite (AddColumn next) r' (x -> r) + where + {-# INLINE liftDefaultComposite #-} + liftDefaultComposite r = liftDefaultComposite @next (r <*> defaultCompositeField) + +instance (r ~ r') => LiftDefaultComposite DecoderDone r r' where + {-# INLINE liftDefaultComposite #-} + liftDefaultComposite r = r + +defaultCompositeField :: (DefaultNullableOrNotValue a) => D.Composite a +defaultCompositeField = D.field defaultNullableOrNotValue + +-------------------------------------------------------------------------------- +-- Value s +-------------------------------------------------------------------------------- + +defaultNullableOrNotValue + :: forall a + . (DefaultNullableOrNotValue a) + => D.NullableOrNot D.Value a +defaultNullableOrNotValue = defaultNullableOrNotValue_ + +class DefaultValue a where + defaultValue :: D.Value a + +class DefaultNullableOrNotValue a where + defaultNullableOrNotValue_ :: D.NullableOrNot D.Value a + +-- | When both instances match, this instance takes precedence +instance {-# OVERLAPPING #-} (DefaultValue a) => DefaultNullableOrNotValue (Maybe a) where + defaultNullableOrNotValue_ = D.nullable defaultValue + +instance (DefaultValue a) => DefaultNullableOrNotValue a where + defaultNullableOrNotValue_ = D.nonNullable defaultValue + +-------------------------------------------------------------------------------- +-- Instances for PostgreSQL types + +instance DefaultValue Bool where + {-# INLINE defaultValue #-} + defaultValue = D.bool + +instance DefaultValue Int16 where + {-# INLINE defaultValue #-} + defaultValue = D.int2 + +instance DefaultValue Int32 where + {-# INLINE defaultValue #-} + defaultValue = D.int4 + +instance DefaultValue Int64 where + {-# INLINE defaultValue #-} + defaultValue = D.int8 + +instance DefaultValue Float where + {-# INLINE defaultValue #-} + defaultValue = D.float4 + +instance DefaultValue Double where + {-# INLINE defaultValue #-} + defaultValue = D.float8 + +instance DefaultValue Scientific where + {-# INLINE defaultValue #-} + defaultValue = D.numeric + +instance DefaultValue Char where + {-# INLINE defaultValue #-} + defaultValue = D.char + +instance DefaultValue Text where + {-# INLINE defaultValue #-} + defaultValue = D.text + +instance DefaultValue ByteString where + {-# INLINE defaultValue #-} + defaultValue = D.bytea + +instance DefaultValue Day where + {-# INLINE defaultValue #-} + defaultValue = D.date + +instance DefaultValue LocalTime where + {-# INLINE defaultValue #-} + defaultValue = D.timestamp + +instance DefaultValue UTCTime where + {-# INLINE defaultValue #-} + defaultValue = D.timestamptz + +instance DefaultValue TimeOfDay where + {-# INLINE defaultValue #-} + defaultValue = D.time + +instance DefaultValue (TimeOfDay, TimeZone) where + {-# INLINE defaultValue #-} + defaultValue = D.timetz + +instance DefaultValue DiffTime where + {-# INLINE defaultValue #-} + defaultValue = D.interval + +instance DefaultValue JSON.Value where + {-# INLINE defaultValue #-} + defaultValue = D.jsonb + +instance (DefaultValue a, DefaultNullableOrNotValue a) => DefaultValue (Vector a) where + {-# INLINE defaultValue #-} + defaultValue = D.vectorArray defaultNullableOrNotValue + +instance (DefaultValue a, DefaultNullableOrNotValue a) => DefaultValue [a] where + {-# INLINE defaultValue #-} + defaultValue = D.listArray defaultNullableOrNotValue + +instance DefaultValue (Range Int32) where + {-# INLINE defaultValue #-} + defaultValue = D.int4range + +instance DefaultValue (Range Int64) where + {-# INLINE defaultValue #-} + defaultValue = D.int8range + +instance DefaultValue (Range Scientific) where + {-# INLINE defaultValue #-} + defaultValue = D.numrange + +instance DefaultValue (Range LocalTime) where + {-# INLINE defaultValue #-} + defaultValue = D.tsrange + +instance DefaultValue (Range UTCTime) where + {-# INLINE defaultValue #-} + defaultValue = D.tstzrange + +instance DefaultValue (Range Day) where + {-# INLINE defaultValue #-} + defaultValue = D.daterange + +instance DefaultValue (Multirange Int32) where + {-# INLINE defaultValue #-} + defaultValue = D.int4multirange + +instance DefaultValue (Multirange Int64) where + {-# INLINE defaultValue #-} + defaultValue = D.int8multirange + +instance DefaultValue (Multirange Scientific) where + {-# INLINE defaultValue #-} + defaultValue = D.nummultirange + +instance DefaultValue (Multirange LocalTime) where + {-# INLINE defaultValue #-} + defaultValue = D.tsmultirange + +instance DefaultValue (Multirange UTCTime) where + {-# INLINE defaultValue #-} + defaultValue = D.tstzmultirange + +instance DefaultValue (Multirange Day) where + {-# INLINE defaultValue #-} + defaultValue = D.datemultirange + +-------------------------------------------------------------------------------- +-- Extra helper types + +instance (FromJSON a) => DefaultValue (ViaJSONB a) where + {-# INLINE defaultValue #-} + defaultValue = + ViaJSONB + <$> D.jsonbBytes (JSON.eitherDecodeStrict <&> either (Left . fromString) Right) + +instance (FromJSON a) => DefaultValue (ViaJSON a) where + {-# INLINE defaultValue #-} + defaultValue = + ViaJSON + <$> D.jsonBytes (JSON.eitherDecodeStrict <&> either (Left . fromString) Right) + +-------------------------------------------------------------------------------- +-- Helper types + +data ConstructorShape + = DecoderDone + | AddColumn ConstructorShape + +type family GetConstructorShape a where + GetConstructorShape (a -> b) = AddColumn (GetConstructorShape b) + GetConstructorShape _ = DecoderDone diff --git a/lib/Hasql/Auto/Encoders.hs b/lib/Hasql/Auto/Encoders.hs new file mode 100644 --- /dev/null +++ b/lib/Hasql/Auto/Encoders.hs @@ -0,0 +1,187 @@ +-- | This module is sourced from and almost identical to that in the +-- [hasql-implicits](https://hackage.haskell.org/hasql-implicits) package. Its +-- purpose is that you don't have to depend on both 'hasql-auto', and to provide +-- the 'defaultParams' and 'defaultParamsSOP' functions. Those two functions are +-- similar to definitions found in +-- [hasql-generic](https://hackage.haskell.org/package/hasql-generic-0.1.0.5/docs/Hasql-Generic-HasParams.html), +-- with slightly different implementations. This package does not need types to +-- have an instance of a 'HasParams'-esque class, but it does require them to be +-- product types and have a 'Generics.SOP.Generic' instance. +-- +-- == hasql-implicits credit, providing 'DefaultParamEncoder' and most of its instances +-- +-- Copyright (c) 2019, Nikita Volkov +-- +-- 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 to use, +-- copy, modify, merge, publish, distribute, sublicense, and/or sell +-- 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 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. +module Hasql.Auto.Encoders ( + defaultParams, + defaultParamsNP, + defaultParam, + DefaultParamEncoder (..), + DefaultScalarParamEncoder (..), +) where + +import Data.Aeson (ToJSON) +import Data.Aeson qualified as JSON +import Data.ByteString (ByteString) +import Data.Foldable qualified as F +import Data.Functor.Contravariant (Contravariant (contramap)) +import Data.IP (IPRange) +import Data.Int (Int16, Int32, Int64) +import Data.Proxy (Proxy (..)) +import Data.Scientific (Scientific) +import Data.Text (Text) +import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime) +import Data.UUID (UUID) +import Data.Vector (Vector) +import GHC.TypeError (Unsatisfiable) +import GHC.TypeLits (ErrorMessage (Text)) +import Generics.SOP (All, Code (..), I (..), K (..), NP (..), SListI, unI) +import Generics.SOP qualified as SOP +import Hasql.Auto.Types +import Hasql.Encoders (NullableOrNot, Params, Value, array, dimension, element, nonNullable, nullable) +import Hasql.Encoders qualified as E + +{-# INLINE defaultParams #-} +defaultParams :: (SOP.IsProductType a xs, All DefaultParamEncoder xs) => Params a +defaultParams = contramap SOP.productTypeFrom defaultParamsNP + +{-# INLINE defaultParamsNP #-} +defaultParamsNP :: (All DefaultParamEncoder xs) => Params (NP I xs) +defaultParamsNP = + SOP.hcfoldMap + (Proxy :: Proxy DefaultParamEncoder) + (\(SOP.Fn getter) -> contramap (unI . getter . K) (E.param defaultParam)) + SOP.projections + +-------------------------------------------------------------------------------- + +class (DefaultParamEncoderImpl (IsScalar a) a) => DefaultParamEncoder a +instance (DefaultParamEncoderImpl (IsScalar a) a) => DefaultParamEncoder a + +-- | Provides a default implementation of parameter encoder. +defaultParam :: forall a. (DefaultParamEncoder a) => NullableOrNot Value a +defaultParam = defaultParamImpl @(IsScalar a) @a + +-- | Provides a default implementation of parameter encoder. +-- +-- Don't implement instances to this typeclass. +class DefaultParamEncoderImpl isScalar a where + -- | Default parameter encoder with nullability specified. + defaultParamImpl :: NullableOrNot Value a + +type family IsScalar a where + IsScalar (Maybe a) = 'False + IsScalar (Vector a) = 'False + IsScalar [a] = 'False + IsScalar _ = 'True + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'True a where + defaultParamImpl = nonNullable defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False [a] where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False [Maybe a] where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False [[a]] where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False [[Maybe a]] where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Vector a) where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Vector (Maybe a)) where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Vector (Vector a)) where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Vector (Vector (Maybe a))) where + defaultParamImpl = (nonNullable . array . dimension F.foldl' . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe a) where + defaultParamImpl = nullable defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe [a]) where + defaultParamImpl = (nullable . array . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe [Maybe a]) where + defaultParamImpl = (nullable . array . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe [[a]]) where + defaultParamImpl = (nullable . array . dimension F.foldl' . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe [[Maybe a]]) where + defaultParamImpl = (nullable . array . dimension F.foldl' . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe (Vector a)) where + defaultParamImpl = (nullable . array . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe (Vector (Maybe a))) where + defaultParamImpl = (nullable . array . dimension F.foldl' . element . nullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe (Vector (Vector a))) where + defaultParamImpl = (nullable . array . dimension F.foldl' . dimension F.foldl' . element . nonNullable) defaultScalarParam + +instance (DefaultScalarParamEncoder a) => DefaultParamEncoderImpl 'False (Maybe (Vector (Vector (Maybe a)))) where + defaultParamImpl = (nullable . array . dimension F.foldl' . dimension F.foldl' . element . nullable) defaultScalarParam + +-------------------------------------------------------------------------------- + +class DefaultScalarParamEncoder a where + defaultScalarParam :: Value a + +instance DefaultScalarParamEncoder Char where defaultScalarParam = E.char +instance DefaultScalarParamEncoder Double where defaultScalarParam = E.float8 +instance DefaultScalarParamEncoder Float where defaultScalarParam = E.float4 +instance DefaultScalarParamEncoder Int16 where defaultScalarParam = E.int2 +instance DefaultScalarParamEncoder Int32 where defaultScalarParam = E.int4 +instance DefaultScalarParamEncoder Int64 where defaultScalarParam = E.int8 +instance DefaultScalarParamEncoder ByteString where defaultScalarParam = E.bytea +instance DefaultScalarParamEncoder Scientific where defaultScalarParam = E.numeric +instance DefaultScalarParamEncoder Text where defaultScalarParam = E.text +instance DefaultScalarParamEncoder UTCTime where defaultScalarParam = E.timestamptz +instance DefaultScalarParamEncoder JSON.Value where defaultScalarParam = E.jsonb +instance (JSON.ToJSON a) => DefaultScalarParamEncoder (ViaJSONB a) where defaultScalarParam = encodeViaJSONB +instance (JSON.ToJSON a) => DefaultScalarParamEncoder (ViaJSON a) where defaultScalarParam = encodeViaJSON +instance DefaultScalarParamEncoder UUID where defaultScalarParam = E.uuid +instance DefaultScalarParamEncoder Day where defaultScalarParam = E.date +instance DefaultScalarParamEncoder DiffTime where defaultScalarParam = E.interval +instance DefaultScalarParamEncoder TimeOfDay where defaultScalarParam = E.time +instance DefaultScalarParamEncoder LocalTime where defaultScalarParam = E.timestamp +instance DefaultScalarParamEncoder (TimeOfDay, TimeZone) where defaultScalarParam = E.timetz +instance DefaultScalarParamEncoder IPRange where defaultScalarParam = E.inet +instance DefaultScalarParamEncoder Bool where defaultScalarParam = E.bool + +encodeViaJSONB :: (ToJSON a) => Value (ViaJSONB a) +encodeViaJSONB = contramap toBS E.jsonbLazyBytes + where + toBS (ViaJSONB a) = JSON.encode a + +encodeViaJSON :: (ToJSON a) => Value (ViaJSON a) +encodeViaJSON = contramap toBS E.jsonLazyBytes + where + toBS (ViaJSON a) = JSON.encode a diff --git a/lib/Hasql/Auto/Types.hs b/lib/Hasql/Auto/Types.hs new file mode 100644 --- /dev/null +++ b/lib/Hasql/Auto/Types.hs @@ -0,0 +1,7 @@ +module Hasql.Auto.Types where + +-- | Decode or encode the type via @ jsonb @ first +newtype ViaJSONB a = ViaJSONB {unViaJSONB :: a} + +-- | Decode or encode the type via @ json @ first +newtype ViaJSON a = ViaJSON {unViaJSON :: a}