Merge pull request #32 from fizruk/cdepillabout-add-form-url-encoded

Forms
fizruk · Aug 31, 2016 · 56c53a4 · 56c53a4
2 parents 035ed1f + f59b5c9
commit 56c53a4
Show file tree

Hide file tree

Showing 14 changed files with 1,063 additions and 148 deletions.
diff --git a/.ghci b/.ghci
@@ -0,0 +1 @@
+:set -itest -isrc -optP-include -optP .stack-work/dist/x86_64-osx/Cabal-1.24.0.0/build/autogen/cabal_macros.h -optP-I -optPinclude
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 /tarballs/
 *.swp
 .stack-work/
+src/highlight.js
+src/style.css
diff --git a/http-api-data.cabal b/http-api-data.cabal
@@ -9,9 +9,10 @@ description:     Please see README.md
 homepage:        http://github.com/fizruk/http-api-data
 category:        Web
 stability:       unstable
-cabal-version:   >= 1.8
+cabal-version:   >= 1.10
 build-type:      Custom
 extra-source-files:
+  include/overlapping-compat.h
   test/*.hs
   CHANGELOG.md
   README.md
@@ -22,28 +23,43 @@ flag use-text-show
 
 library
     hs-source-dirs: src/
+    include-dirs:   include/
     build-depends:   base               >= 4.6    && < 4.10
-                   , text               >= 0.5
                    , bytestring
+                   , containers
+                   , hashable
+                   , text               >= 0.5
                    , time
                    , time-locale-compat >=0.1.1.0 && <0.2
+                   , unordered-containers
+                   , uri-bytestring
     if flag(use-text-show)
       cpp-options: -DUSE_TEXT_SHOW
       build-depends: text-show        >= 2
     exposed-modules:
       Web.HttpApiData
-      Web.HttpApiData.Internal
+      Web.FormUrlEncoded
+      Web.Internal.FormUrlEncoded
+      Web.Internal.HttpApiData
     ghc-options:     -Wall
+    default-language: Haskell2010
 
 test-suite spec
     type:          exitcode-stdio-1.0
     main-is:       Spec.hs
-    hs-source-dirs: test/
+    other-modules:
+      Web.Internal.FormUrlEncodedSpec
+      Web.Internal.HttpApiDataSpec
+      Web.Internal.TestInstances
+    hs-source-dirs: test
     ghc-options:   -Wall
+    default-language: Haskell2010
     build-depends:   HUnit
                    , hspec >= 1.3
                    , base >= 4 && < 5
+                   , bytestring
                    , QuickCheck
+                   , unordered-containers
                    , http-api-data
                    , text
                    , time

diff --git a/include/overlapping-compat.h b/include/overlapping-compat.h
@@ -0,0 +1,8 @@
+#if __GLASGOW_HASKELL__ >= 710
+#define OVERLAPPABLE_ {-# OVERLAPPABLE #-}
+#define OVERLAPPING_  {-# OVERLAPPING #-}
+#else
+{-# LANGUAGE OverlappingInstances #-}
+#define OVERLAPPABLE_
+#define OVERLAPPING_
+#endif
diff --git a/src/Web/FormUrlEncoded.hs b/src/Web/FormUrlEncoded.hs
@@ -0,0 +1,41 @@
+-- |
+-- Convert Haskell values to and from @application/xxx-form-urlencoded@ format.
+module Web.FormUrlEncoded (
+  -- * Classes
+  ToForm (..),
+  FromForm (..),
+
+  -- ** Keys for 'Form' entries
+  ToFormKey(..),
+  FromFormKey(..),
+
+  -- * Encoding and decoding @'Form'@s
+  urlEncodeAsForm,
+  urlDecodeAsForm,
+
+  urlEncodeForm,
+  urlDecodeForm,
+
+  -- * 'Generic's
+  genericToForm,
+  genericFromForm,
+
+  -- ** Encoding options
+  FormOptions(..),
+  defaultFormOptions,
+
+  -- * Helpers
+  toEntriesByKey,
+  fromEntriesByKey,
+
+  lookupAll,
+  lookupMaybe,
+  lookupUnique,
+
+  parseAll,
+  parseMaybe,
+  parseUnique,
+) where
+
+import Web.Internal.FormUrlEncoded
+
diff --git a/src/Web/HttpApiData.hs b/src/Web/HttpApiData.hs
@@ -40,7 +40,7 @@ module Web.HttpApiData (
   readTextData,
 ) where
 
-import Web.HttpApiData.Internal
+import Web.Internal.HttpApiData
 
 -- $setup
 --
@@ -69,7 +69,7 @@ import Web.HttpApiData.Internal
 -- "45.2"
 -- >>> parseQueryParam "452" :: Either Text Int
 -- Right 452
--- >>> toQueryParams [1..5]
+-- >>> toQueryParams [1..5] :: [Text]
 -- ["1","2","3","4","5"]
 -- >>> parseQueryParams ["127", "255"] :: Either Text [Int8]
 -- Left "out of bounds: `255' (should be between -128 and 127)"