xmlbf-xeno (empty) → 0.1

raw patch · 7 files changed

+432/−0 lines, 7 filesdep +QuickCheckdep +basedep +bytestringsetup-changed

Dependencies added: QuickCheck, base, bytestring, html-entities, quickcheck-instances, tasty, tasty-hunit, tasty-quickcheck, text, unordered-containers, xeno, xmlbf, xmlbf-xeno

Files

• ChangeLog.md +3/−0
• LICENSE +202/−0
• README.md +3/−0
• Setup.hs +4/−0
• lib/Xmlbf/Xeno.hs +71/−0
• test/Test.hs +103/−0
• xmlbf-xeno.cabal +46/−0

@@ -0,0 +1,3 @@+# 0.1++* First version.

@@ -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.

@@ -0,0 +1,3 @@+# xmlbf-xeno++`xeno` backend support for `xmlbf`.

@@ -0,0 +1,4 @@+#! /usr/bin/env nix-shell+#! nix-shell ./default.nix -i runghc+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,71 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}++module Xmlbf.Xeno+ ( element+ , nodes+ ) where++import qualified Data.Bifunctor as Bif+import qualified Data.ByteString as B+import qualified Data.HashMap.Strict as HM+import Data.Monoid ((<>))+import qualified Data.Text as T+import qualified Data.Text.Lazy as TL+import qualified Data.Text.Lazy.Builder as TB+import qualified Data.Text.Encoding as T+import Data.Traversable (for)+import qualified HTMLEntities.Decoder+import qualified Xeno.DOM as Xeno+import qualified Xmlbf++--------------------------------------------------------------------------------+-- Xeno support++-- | Convert a 'Xeno.Node' from "Xeno.DOM" into an 'Element' from "Xmlbf".+element+  :: Xeno.Node -- ^ A 'Xeno.Node' from "Xeno.DOM".+  -> Either String Xmlbf.Node -- ^ A 'Xmlbf.Node' from "Xmlbf".+element x = do+  n <- decodeUtf8 (Xeno.name x)+  as <- for (Xeno.attributes x) $ \(k,v) -> do+     (,) <$> decodeUtf8 k <*> unescapeXmlUtf8 v+  cs <- for (Xeno.contents x) $ \case+     Xeno.Element n1 -> element n1+     Xeno.Text bs -> Xmlbf.Text <$> unescapeXmlUtf8 bs+     Xeno.CData bs -> Xmlbf.Text <$> decodeUtf8 bs+  Xmlbf.element n (HM.fromList as) cs++-- | Parses a given UTF8-encoded raw XML fragment into @a@, using the @xeno@+-- Haskell library, so all of @xeno@'s parsing quirks apply.+--+-- You can provide the output of this function as input to "Xmlbf"'s+-- 'Xmlbf.runParser'.+--+-- The given XML can contain more zero or more text or element nodes.+--+-- Surrounding whitespace is not stripped.+nodes+  :: B.ByteString                 -- ^ Raw XML fragment.+  -> Either String [Xmlbf.Node]   -- ^ 'Xmlbf.Node's from "Xmlbf"+nodes = \bs -> case Xeno.parse ("<x>" <> bs <> "</x>") of+  Left e -> Left ("Malformed XML: " ++ show e)+  Right n -> element n >>= \(Xmlbf.Element "x" _ cs) -> pure cs++--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-- Miscellaneous++decodeUtf8 :: B.ByteString -> Either String T.Text+{-# INLINE decodeUtf8 #-}+decodeUtf8 bs = Bif.first show (T.decodeUtf8' bs)++unescapeXmlText :: T.Text -> T.Text+{-# INLINE unescapeXmlText #-}+unescapeXmlText = \t ->+  TL.toStrict (TB.toLazyText (HTMLEntities.Decoder.htmlEncodedText t))++unescapeXmlUtf8 :: B.ByteString -> Either String T.Text+{-# INLINE unescapeXmlUtf8 #-}+unescapeXmlUtf8 bs = fmap unescapeXmlText (decodeUtf8 bs)+

@@ -0,0 +1,103 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE OverloadedLists #-}+{-# LANGUAGE ScopedTypeVariables #-}++module Main where++import Control.Applicative (many)+import qualified Data.ByteString as B+import qualified Data.ByteString.Builder as BB+import qualified Data.ByteString.Lazy as BL+import qualified Data.HashMap.Strict as HM+import qualified Data.Text as T+import qualified Test.Tasty as Tasty+import qualified Test.Tasty.Runners as Tasty+import Test.Tasty.QuickCheck ((===))+import qualified Test.Tasty.QuickCheck as QC+import qualified Test.Tasty.HUnit as HU+import           Test.Tasty.HUnit ((@?=))+import qualified Test.QuickCheck.Instances ()++import qualified Xmlbf as X+import qualified Xmlbf.Xeno as Xx++--------------------------------------------------------------------------------++main :: IO ()+main = Tasty.defaultMainWithIngredients+  [ Tasty.consoleTestReporter+  , Tasty.listingTests+  ] tt_main++--------------------------------------------------------------------------------++-- | Like 'X.element' but it crashes if the result is a 'Left'.+el :: T.Text -> [(T.Text, T.Text)] -> [X.Node] -> X.Node+el t as cs = case X.element t (HM.fromList as) cs of+  Right x -> x+  Left s -> error ("el: Left " ++ show s ++ "\"")+++tt_main :: Tasty.TestTree+tt_main =+  -- All of the testcases suffixed "-BAD" below are actually undesired results+  -- provided by xeno. They are kept here as an acknowledgement of this+  -- known behavior.++  Tasty.testGroup "main"+  [ HU.testCase "1" $ do+     Xx.nodes "" @?= Right []++  , HU.testCase "2" $ do+     Xx.nodes " " @?= Right [X.Text " "]++  , HU.testCase "3" $ do+     Xx.nodes "<foo/>" @?= Right [el "foo" [] []]++  , HU.testCase "4" $ do+     Xx.nodes "<foo></foo>" @?= Right [el "foo" [] []]++  , HU.testCase "5" $ do+     Xx.nodes " <foo></foo>" @?= Right [X.Text " ", el "foo" [] []]++  , HU.testCase "6" $ do+     Xx.nodes " <foo/>  " @?= Right [X.Text " ", el "foo" [] [], "  "]++  , HU.testCase "7" $ do+     Xx.nodes "<foo a=\"\"/>" @?= Right [el "foo" [("a", "")] []]++  , HU.testCase "8" $ do+     Xx.nodes "<foo a=\"b\"></foo>" @?= Right [el "foo" [("a", "b")] []]++  , HU.testCase "9" $ do+     Xx.nodes "<foo a=\"b\" c=\"\"/>" @?= Right [el "foo" [("a", "b"), ("c", "")] []]++  , HU.testCase "10" $ do+     Xx.nodes "<foo a=\"b\" c=\"d\"/>" @?= Right [el "foo" [("a", "b"), ("c", "d")] []]++  , HU.testCase "11" $ do+     Xx.nodes "<foo a=\"b\">bar</foo>" @?= Right [el "foo" [("a", "b")] ["bar"]]++  , HU.testCase "12" $ do+     Xx.nodes "<foo a=\"b\"><bar/></foo>" @?= Right [el "foo" [("a", "b")] [el "bar" [] []]]++  , HU.testCase "13-BAD" $ do+     -- This should return on either a 'Left', or a @'Right' [el "foo" [] []]@.+     -- The reason why it doesn't is because 'Xx.nodes' wraps @"<foo>"@ as+     -- @"<x><foo></x>"@ before parsing, which causes the @x@ element to be+     -- successfully parsed, but not the inner @foo@. This is a problem in Xeno.+     Xx.nodes "<foo>" @?= Right []++  , HU.testCase "14-BAD" $ do+     -- Similar to test case 13-BAD. This is wrong, but it is what Xeno returns.+     Xx.nodes "<foo></bar>" @?= Right [el "foo" [] []]++  , HU.testCase "15" $ do+     Xx.nodes "&lt;foo/&gt;" @?= Right ["<foo/>"]++  , HU.testCase "16" $ do+     Xx.nodes "&amp;lt;" @?= Right ["&lt;"]+  ]++

@@ -0,0 +1,46 @@+name: xmlbf-xeno+version: 0.1+synopsis: xeno backend support for the xmlbf library.+homepage: https://gitlab.com/k0001/xmlbf+license: Apache-2.0+license-file: LICENSE+author: Renzo Carbonara+maintainer: ren§ren*zone+copyright: Copyright 2017 Renzo Carbonara+category: Text+build-type: Simple+extra-source-files: ChangeLog.md README.md+cabal-version: >=1.10++library+  hs-source-dirs: lib+  exposed-modules: Xmlbf.Xeno+  default-language: Haskell2010+  ghc-options: -O2 -Wall+  ghcjs-options: -O3 -Wall+  build-depends:+    base <5,+    bytestring,+    html-entities,+    text,+    unordered-containers,+    xeno,+    xmlbf++test-suite test+  default-language: Haskell2010+  type: exitcode-stdio-1.0+  main-is: Test.hs+  hs-source-dirs: test+  build-depends:+    base,+    bytestring,+    xmlbf,+    xmlbf-xeno,+    QuickCheck,+    quickcheck-instances,+    tasty,+    tasty-hunit,+    tasty-quickcheck,+    text,+    unordered-containers