bson-mapping (empty) → 0.1
raw patch · 4 files changed
+344/−0 lines, 4 filesdep +basedep +bsondep +template-haskellsetup-changed
Dependencies added: base, bson, template-haskell, th-lift
Files
- LICENSE +202/−0
- Setup.hs +2/−0
- bson-mapping.cabal +33/−0
- src/Data/Bson/Mapping.hs +107/−0
+ LICENSE view
@@ -0,0 +1,202 @@+ 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 [yyyy] [name of copyright owner]++ 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.+
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ bson-mapping.cabal view
@@ -0,0 +1,33 @@+Name: bson-mapping+Version: 0.1+License: OtherLicense+License-File: LICENSE+Author: Francesco Mazzoli <f@mazzo.li>+Maintainer: Francesco Mazzoli <f@mazzo.li>+homepage: +Stability: experimental+Category: Data+Synopsis: Mapping between BSON and algebraic data types.+Description: This module defines a Bson class to convert data types to Bson and to convert Bson documents back to datatypes, along with template haskell functions to easily derive the instance.+Tested-With: GHC==7.0.2+Build-Type: Simple+Cabal-Version: >= 1.6++source-repository head+ type: git+ location: git://github.com/rostayob/bson-mapping.git++Library+ Build-Depends: base >= 4 && < 5,+ template-haskell >= 2.5,+ th-lift >= 0.5.3,+ bson >= 0.1.3++ hs-source-dirs: src++ Exposed-modules:+ Data.Bson.Mapping++ Extensions: TemplateHaskell++ ghc-options: -Wall
+ src/Data/Bson/Mapping.hs view
@@ -0,0 +1,107 @@+{-# Language TemplateHaskell #-}++{- |++This module aims to make mapping between algebraic data types and bson+documents easy.++The rules: the data type must have one constructor, and named+fields. All the fields must be instances of 'Val'.++You can also generate documents with 'selectFields', which takes a+list of functions names that of type a -> b and returns a function+of type a -> Document.++Example:++> {-# Language TemplateHaskell #-}+>+> import Data.Bson.Mapping+> import Data.Time.Clock+>+> data Post = Post { time :: UTCTime+> , author :: String+> , content :: String +> , votes :: Int+> }+> deriving (Show, Read, Eq, Ord)+> $(deriveBson ''Post)+>+> main :: IO ()+> main = do+> now <- getCurrentTime+> let post = Post now "francesco" "lorem ipsum" 5+> (fromBson (toBson post) :: IO Post) >>= print+> print $ toBson post+> print $ $(selectFields ['time, 'content]) post++-}++module Data.Bson.Mapping (+ Bson (..)+ , deriveBson + , selectFields+ ) where++import qualified Data.Bson as B+import Language.Haskell.TH+import Language.Haskell.TH.Lift ()++class Bson a where+ toBson :: a -> B.Document+ fromBson :: Monad m => B.Document -> m a+++deriveBson :: Name -> Q [Dec]+deriveBson type' = do+ (cx, con, keys) <- bsonType+ (constr, fields) <- parseCon con+ let context = [ classP ''B.Val [varT key] | key <- keys ] ++ map return cx+ i <- instanceD (sequence context) (mkType ''Bson [mkType type' (map varT keys)])+ [ funD 'toBson [clause [] (normalB $ selectFields fields) []]+ , deriveFromBson fields constr+ ]+ return [i]++ where++ bsonType = do+ info <- reify type'+ case info of+ TyConI (DataD cx _ keys [con] _) -> return (cx, con, map conv keys)+ TyConI (NewtypeD cx _ keys con _) -> return (cx, con, map conv keys)+ _ -> inputError+ + parseCon con = do+ case con of+ RecC name fields -> return (name, map (\(n, _, _) -> n) fields)+ _ -> inputError+ + mkType con = foldl appT (conT con)+ + conv (PlainTV nm) = nm+ conv (KindedTV nm _) = nm+ + inputError = error "deriveBson: Invalid type provided. The type must be a data with a single constructor or a newtype. The constructor must have named fields."+ + deriveFromBson fields constr = do+ doc <- newName "doc"+ (fields', stmts) <- genStmts fields doc+ let ci = noBindS $ [| return $(recConE constr fields') |]+ funD 'fromBson [clause [varP doc] (normalB $ doE (stmts ++ [ci])) []]+ + genStmts [] _ = return ([], [])+ genStmts (f : fs) doc = do+ fvar <- newName "f"+ let stmt = bindS (varP fvar) $ [| B.lookup (B.u (nameBase f)) $(varE doc) |]+ (fields, stmts) <- genStmts fs doc+ return $ (return (f, VarE fvar) : fields, stmt : stmts)+ +selectFields :: [Name] -> Q Exp+selectFields ns = do+ d <- newName "d"+ e <- gf d ns+ lamE [varP d] (return e)+ where+ gf _ [] = [| [] |]+ gf d (n : ns') = [| (B.u (nameBase n) B.=: $(varE n) $(varE d)) : $(gf d ns') |]