git.iko.soy/typeable/xml-lens
on master help sign in
swap
57ddeff37 ahead, 0 behind
.github/workflows/haskell.ymlnew file+37
since splitsnapshots
unifiedsplit
@@ -0,0 +1,37 @@
1+name: Haskell CI
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+
8+ runs-on: ubuntu-latest
9+ strategy:
10+ matrix:
11+ ghc: [ '8.8.4', '8.10.7', '9.0.1', '9.2.2' ]
12+ steps:
13+ - uses: actions/checkout@v3
14+ - uses: haskell/actions/setup@v1
15+ with:
16+ ghc-version: ${{ matrix.ghc }}
17+ cabal-version: '3.4'
18+
19+ - name: cabal Cache
20+ uses: actions/cache@v1
21+ env:
22+ cache-name: cache-cabal
23+ with:
24+ path: ~/.cabal
25+ key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
26+ restore-keys: |
27+ ${{ runner.os }}-build-${{ env.cache-name }}-
28+ ${{ runner.os }}-build-
29+ ${{ runner.os }}-
30+ - name: Install dependencies
31+ run: |
32+ cabal update
33+ cabal build --only-dependencies --enable-tests --enable-benchmarks all
34+ - name: Build
35+ run: cabal build --enable-tests --enable-benchmarks all
36+ - name: Run tests
37+ run: cabal test --enable-tests --enable-benchmarks all
.gitignore+1
@@ -1,3 +1,4 @@
1+dist-newstyle
1#################
2#################
2## Eclipse
3## Eclipse
3#################
4#################
CHANGELOG.mdnew file+10
@@ -0,0 +1,10 @@
1+## 0.3.1
2+
3+* Supported GHC 9
4+
5+## 0.3 (2021/01)
6+
7+* Deprecated `el`
8+* Removed `./` and `entire`
9+
10+
README.md+14−8
@@ -6,18 +6,20 @@ Lenses and traversals for [xml-conduit](http://hackage.haskell.org/package/xml-c
6Example
6Example
7========
7========
8
8
9+```haskell
9− > doc <- Text.XML.readFile def "examples/books.xml"
10+> doc <- Text.XML.readFile def "examples/books.xml"
10
11
11− > doc ^.. root . el "books" ./ el "book" . attributeIs "category" "Textbooks" ./ el "title" . text
12+> doc ^.. root . named "books" ... named "book" . attributeIs "category" "Textbooks" ... named "title" . text
12− ["Learn You a Haskell for Great Good!","Programming in Haskell","Real World Haskell"]
13+["Learn You a Haskell for Great Good!","Programming in Haskell","Real World Haskell"]
13
14
14− > lengthOf ?? doc $ root . el "books" ./ el "book"
15+> lengthOf ?? doc $ root . named "books" ... named "book"
15− 7
16+7
16
17
17− > doc ^? root . el "books" ./ attributeIs "category" "Joke" ./ el "title" . text
18+> doc ^? root . named "books" ... attributeIs "category" "Joke" ... named "title" . text
18− Just "Functional Ikamusume"
19+Just "Functional Ikamusume"
19
20
20− > doc & root . el "books" ./ el "book" ./ el "pages" . text <>~ " pages" & renderLBS def & BL.putStrLn
21+> doc & root . named "books" ... named "book" ... named "pages" . text <>~ " pages" & renderLBS def & BL.putStrLn
22+```
21
23
22```xml
24```xml
23<?xml version="1.0" encoding="ISO-8859-1"?>
25<?xml version="1.0" encoding="ISO-8859-1"?>
@@ -41,4 +43,8 @@ Example
41…
43…
42```
44```
43
45
46+Tips
47+----
44
48
49+* Use [cosmos](http://hackage.haskell.org/package/lens-4.19.2/docs/Control-Lens-Plated.html) to traverse over all children
50+* You can do or-composition of traversals with [failing](http://hackage.haskell.org/package/lens-4.19.2/docs/Control-Lens-Traversal.html#v:failing)
Text/XML/Lens.hs+72−36
@@ -1,25 +1,31 @@
1{-# LANGUAGE Rank2Types, FlexibleContexts #-}
1{-# LANGUAGE Rank2Types, FlexibleContexts #-}
2+{-# OPTIONS_GHC -fno-warn-orphans #-}
2-----------------------------------------------------------------------------
3-----------------------------------------------------------------------------
3-- |
4-- |
4-- Module : Text.XML.Lens
5-- Module : Text.XML.Lens
5−-- Copyright : (C) 2013 Fumiaki Kinoshita
6+-- Copyright : (C) 2015 Fumiaki Kinoshita
6-- License : BSD-style (see the file LICENSE)
7-- License : BSD-style (see the file LICENSE)
7--
8--
8-- Maintainer : Fumiaki Kinoshita <fumiexcel@gmail.com>
9-- Maintainer : Fumiaki Kinoshita <fumiexcel@gmail.com>
9−-- Stability : experimental
10+-- Stability : provisional
10-- Portability : non-portable
11-- Portability : non-portable
11−-- Useful traversals inspired by XPath
12+--
12----------------------------------------------------------------------------
13----------------------------------------------------------------------------
13module Text.XML.Lens (
14module Text.XML.Lens (
14 -- * Lenses, traversals for 'Element'
15 -- * Lenses, traversals for 'Element'
16+ Element(..)
15− (./)
17+ , (...)
16 -- ** Names
18 -- ** Names
17 , name
19 , name
20+ , localName
18 , el
21 , el
19 , ell
22 , ell
23+ , named
20 -- ** Attributes
24 -- ** Attributes
21 , attributeIs
25 , attributeIs
22 , attributeSatisfies
26 , attributeSatisfies
27+ , attributeSatisfies'
28+ , withoutAttribute
23 , attr
29 , attr
24 , attribute
30 , attribute
25 , attrs
31 , attrs
@@ -27,68 +33,75 @@ module Text.XML.Lens (
27 , text
33 , text
28 , comment
34 , comment
29 -- ** Children
35 -- ** Children
30− , entire
31 , nodes
36 , nodes
32 -- * Prisms for 'Node'
37 -- * Prisms for 'Node'
38+ , Node(..)
33 , _Element
39 , _Element
34 , _Content
40 , _Content
35 , AsInstruction(..)
41 , AsInstruction(..)
36 , AsComment(..)
42 , AsComment(..)
37 -- * Lenses for 'Document'
43 -- * Lenses for 'Document'
44+ , Document(..)
38 , root
45 , root
39 , prologue
46 , prologue
40 , epilogue
47 , epilogue
41 , doctype
48 , doctype
42 -- * Lenses for 'Name'
49 -- * Lenses for 'Name'
50+ , Name(..)
43 , _nameLocalName
51 , _nameLocalName
44 , _nameNamespace
52 , _nameNamespace
45 , _namePrefix
53 , _namePrefix
46 -- * Lenses for 'Instruction'
54 -- * Lenses for 'Instruction'
55+ , Instruction(..)
47 , _instructionTarget
56 , _instructionTarget
48 , _instructionData
57 , _instructionData
49− -- * Reexports
50− , module Control.Lens
51− , module Text.XML
52 ) where
58 ) where
53import Text.XML
59import Text.XML
54import Control.Lens
60import Control.Lens
55import Data.Text (Text)
61import Data.Text (Text)
56import Data.Map (Map)
62import Data.Map (Map)
57−import Control.Applicative
63+import qualified Data.CaseInsensitive as CI
58−
64+import Data.Maybe (isNothing)
59−infixr 9 ./
60
65
61prologue :: Lens' Document Prologue
66prologue :: Lens' Document Prologue
62prologue f doc = fmap (\p -> doc { documentPrologue = p} ) $ f $ documentPrologue doc
67prologue f doc = fmap (\p -> doc { documentPrologue = p} ) $ f $ documentPrologue doc
68+{-# INLINE prologue #-}
63
69
64-- | The root element of the document.
70-- | The root element of the document.
65root :: Lens' Document Element
71root :: Lens' Document Element
66root f doc = fmap (\p -> doc { documentRoot = p} ) $ f $ documentRoot doc
72root f doc = fmap (\p -> doc { documentRoot = p} ) $ f $ documentRoot doc
73+{-# INLINE root #-}
67
74
68epilogue :: Lens' Document [Miscellaneous]
75epilogue :: Lens' Document [Miscellaneous]
69epilogue f doc = fmap (\p -> doc { documentEpilogue = p} ) $ f $ documentEpilogue doc
76epilogue f doc = fmap (\p -> doc { documentEpilogue = p} ) $ f $ documentEpilogue doc
77+{-# INLINE epilogue #-}
70
78
71doctype :: Lens' Prologue (Maybe Doctype)
79doctype :: Lens' Prologue (Maybe Doctype)
72doctype f doc = fmap (\p -> doc { prologueDoctype = p} ) $ f $ prologueDoctype doc
80doctype f doc = fmap (\p -> doc { prologueDoctype = p} ) $ f $ prologueDoctype doc
81+{-# INLINE doctype #-}
73
82
74class AsInstruction t where
83class AsInstruction t where
75 _Instruction :: Prism' t Instruction
84 _Instruction :: Prism' t Instruction
76
85
77_instructionTarget :: Lens' Instruction Text
86_instructionTarget :: Lens' Instruction Text
78_instructionTarget f (Instruction t d) = f t <&> \t' -> Instruction t' d
87_instructionTarget f (Instruction t d) = f t <&> \t' -> Instruction t' d
88+{-# INLINE _instructionTarget #-}
79
89
80_instructionData :: Lens' Instruction Text
90_instructionData :: Lens' Instruction Text
81_instructionData f (Instruction t d) = f d <&> \d' -> Instruction t d'
91_instructionData f (Instruction t d) = f d <&> \d' -> Instruction t d'
92+{-# INLINE _instructionData #-}
82
93
83instance AsInstruction Node where
94instance AsInstruction Node where
84 _Instruction = prism' NodeInstruction $ \s -> case s of
95 _Instruction = prism' NodeInstruction $ \s -> case s of
85 NodeInstruction e -> Just e
96 NodeInstruction e -> Just e
86 _ -> Nothing
97 _ -> Nothing
98+ {-# INLINE _Instruction #-}
87
99
88instance AsInstruction Miscellaneous where
100instance AsInstruction Miscellaneous where
89 _Instruction = prism' MiscInstruction $ \s -> case s of
101 _Instruction = prism' MiscInstruction $ \s -> case s of
90 MiscInstruction e -> Just e
102 MiscInstruction e -> Just e
91 _ -> Nothing
103 _ -> Nothing
104+ {-# INLINE _Instruction #-}
92
105
93class AsComment t where
106class AsComment t where
94 _Comment :: Prism' t Text
107 _Comment :: Prism' t Text
@@ -97,84 +110,107 @@ instance AsComment Node where
97 _Comment = prism' NodeComment $ \s -> case s of
110 _Comment = prism' NodeComment $ \s -> case s of
98 NodeComment e -> Just e
111 NodeComment e -> Just e
99 _ -> Nothing
112 _ -> Nothing
113+ {-# INLINE _Comment #-}
100
114
101instance AsComment Miscellaneous where
115instance AsComment Miscellaneous where
102 _Comment = prism' MiscComment $ \s -> case s of
116 _Comment = prism' MiscComment $ \s -> case s of
103 MiscComment e -> Just e
117 MiscComment e -> Just e
104 _ -> Nothing
118 _ -> Nothing
119+ {-# INLINE _Comment #-}
105
120
106_nameLocalName :: Lens' Name Text
121_nameLocalName :: Lens' Name Text
107−_nameLocalName f n = fmap (\x -> n { nameLocalName = x }) $ f $ nameLocalName n
122+_nameLocalName f n = f (nameLocalName n) <&> \x -> n { nameLocalName = x }
123+{-# INLINE _nameLocalName #-}
108
124
109_nameNamespace :: Lens' Name (Maybe Text)
125_nameNamespace :: Lens' Name (Maybe Text)
110−_nameNamespace f n = fmap (\x -> n { nameNamespace = x }) $ f $ nameNamespace n
126+_nameNamespace f n = f (nameNamespace n) <&> \x -> n { nameNamespace = x }
127+{-# INLINE _nameNamespace #-}
111
128
112_namePrefix :: Lens' Name (Maybe Text)
129_namePrefix :: Lens' Name (Maybe Text)
113−_namePrefix f n = fmap (\x -> n { namePrefix = x }) $ f $ namePrefix n
130+_namePrefix f n = f (namePrefix n) <&> \x -> n { namePrefix = x }
131+{-# INLINE _namePrefix #-}
114
132
115_Element :: Prism' Node Element
133_Element :: Prism' Node Element
116_Element = prism' NodeElement $ \s -> case s of
134_Element = prism' NodeElement $ \s -> case s of
117 NodeElement e -> Just e
135 NodeElement e -> Just e
118 _ -> Nothing
136 _ -> Nothing
137+{-# INLINE _Element #-}
119
138
120_Content :: Prism' Node Text
139_Content :: Prism' Node Text
121_Content = prism' NodeContent $ \s -> case s of
140_Content = prism' NodeContent $ \s -> case s of
122 NodeContent e -> Just e
141 NodeContent e -> Just e
123 _ -> Nothing
142 _ -> Nothing
143+{-# INLINE _Content #-}
124
144
125name :: Lens' Element Name
145name :: Lens' Element Name
126−name f e = fmap (\x -> e { elementName = x }) $ f $ elementName e
146+name f e = f (elementName e) <&> \x -> e { elementName = x }
147+{-# INLINE name #-}
148+
149+localName :: Lens' Element Text
150+localName = name . _nameLocalName
151+{-# INLINE localName #-}
127
152
128attrs :: Lens' Element (Map Name Text)
153attrs :: Lens' Element (Map Name Text)
129attrs f e = fmap (\x -> e { elementAttributes = x }) $ f $ elementAttributes e
154attrs f e = fmap (\x -> e { elementAttributes = x }) $ f $ elementAttributes e
155+{-# INLINE attrs #-}
130
156
131nodes :: Lens' Element [Node]
157nodes :: Lens' Element [Node]
132nodes f e = fmap (\x -> e { elementNodes = x }) $ f $ elementNodes e
158nodes f e = fmap (\x -> e { elementNodes = x }) $ f $ elementNodes e
159+{-# INLINE nodes #-}
133
160
134−attr :: Name -> IndexedTraversal' Name Element Text
161+attr :: Name -> Traversal' Element Text
135attr n = attrs . ix n
162attr n = attrs . ix n
163+{-# INLINE attr #-}
136
164
137−attribute :: Name -> IndexedLens' Name Element (Maybe Text)
165+attribute :: Name -> Lens' Element (Maybe Text)
138attribute n = attrs . at n
166attribute n = attrs . at n
167+{-# INLINE attribute #-}
139
168
140−-- | Traverse itself with its all children.
169+-- | Traverse elements which has the specified *local* name (case-insensitive).
141−entire :: Traversal' Element Element
170+named :: CI.CI Text -> Traversal' Element Element
142−entire f e@(Element _ _ ns) = com <$> f e <*> traverse (_Element (entire f)) ns where
171+named n f s
143− com (Element n a _) = Element n a
172+ | CI.mk (nameLocalName (elementName s)) == n = f s
173+ | otherwise = pure s
174+{-# INLINE named #-}
175+
176+-- | Old name for 'named'
177+ell :: Text -> Traversal' Element Element
178+ell n = named $ CI.mk n
144
179
145-- | Traverse elements which has the specified name.
180-- | Traverse elements which has the specified name.
146el :: Name -> Traversal' Element Element
181el :: Name -> Traversal' Element Element
147el n f s
182el n f s
148 | elementName s == n = f s
183 | elementName s == n = f s
149 | otherwise = pure s
184 | otherwise = pure s
150−
185+{-# DEPRECATED el "Use named instead" #-}
151−-- | Traverse elements which has the specified *local* name.
152−ell :: Text -> Traversal' Element Element
153−ell n f s
154− | nameLocalName (elementName s) == n = f s
155− | otherwise = pure s
156
186
157attributeSatisfies :: Name -> (Text -> Bool) -> Traversal' Element Element
187attributeSatisfies :: Name -> (Text -> Bool) -> Traversal' Element Element
158−attributeSatisfies n p = filtered (maybe False p . preview (attrs . ix n))
188+attributeSatisfies n p = attributeSatisfies' n (maybe False p)
189+{-# INLINE attributeSatisfies #-}
190+
191+attributeSatisfies' :: Name -> (Maybe Text -> Bool) -> Traversal' Element Element
192+attributeSatisfies' n p = filtered (p . preview (attrs . ix n))
193+{-# INLINE attributeSatisfies' #-}
194+
195+withoutAttribute :: Name -> Traversal' Element Element
196+withoutAttribute n = attributeSatisfies' n isNothing
197+{-# INLINE withoutAttribute #-}
159
198
160attributeIs :: Name -> Text -> Traversal' Element Element
199attributeIs :: Name -> Text -> Traversal' Element Element
161attributeIs n v = attributeSatisfies n (==v)
200attributeIs n v = attributeSatisfies n (==v)
201+{-# INLINE attributeIs #-}
162
202
163-- | Traverse all contents of the element.
203-- | Traverse all contents of the element.
164text :: Traversal' Element Text
204text :: Traversal' Element Text
165text = nodes . traverse . _Content
205text = nodes . traverse . _Content
206+{-# INLINE text #-}
166
207
167-- | Traverse all comments of the element.
208-- | Traverse all comments of the element.
168comment :: Traversal' Element Text
209comment :: Traversal' Element Text
169comment = nodes . traverse . _Comment
210comment = nodes . traverse . _Comment
211+{-# INLINE comment #-}
170
212
213+-- | 'plate' traverses over its sub-elements.
171instance Plated Element where
214instance Plated Element where
172 plate = nodes . traverse . _Element
215 plate = nodes . traverse . _Element
173−
174−-- | Combine two 'Traversal's just like XPath's slash.
175−--
176−-- @
177−-- l ./ m ≡ l . 'plate' . m
178−-- @
179−(./) :: Plated a => Traversal s t a a -> Traversal a a u v -> Traversal s t u v
180−l ./ m = l . plate . m
216+ {-# INLINE plate #-}
cabal.projectnew file+1
@@ -0,0 +1 @@
1+packages: ./
stack.yamlnew file+4
@@ -0,0 +1,4 @@
1+resolver: lts-21.3
2+
3+packages:
4+- .
xml-lens.cabal+17−8
@@ -1,16 +1,20 @@
1+cabal-version: 2.4
1name: xml-lens
2name: xml-lens
2−version: 0.1.3
3+version: 0.3.1
3−synopsis: Lenses, traversals, prisms for xml-conduit
4+synopsis: Lenses, traversals, and prisms for xml-conduit
4−description: Lens-based DOM selector
5+description: This package provides DOM selectors based on lenses and prisms. See README.md for examples
5homepage: https://github.com/fumieval/xml-lens
6homepage: https://github.com/fumieval/xml-lens
7+bug-reports: https://github.com/fumieval/xml-lens/issues
6−license: BSD3
8+license: BSD-3-Clause
7license-file: LICENSE
9license-file: LICENSE
8author: Fumiaki Kinoshita
10author: Fumiaki Kinoshita
9maintainer: Fumiaki Kinoshita <fumiexcel@gmail.com>
11maintainer: Fumiaki Kinoshita <fumiexcel@gmail.com>
10−copyright: Copyright (C) 2013 Fumiaki Kinoshita
12+copyright: Copyright (C) 2021 Fumiaki Kinoshita
11−category: Control
13+category: XML
12build-type: Simple
14build-type: Simple
13−cabal-version: >=1.10
15+extra-source-files:
16+ README.md
17+ CHANGELOG.md
14
18
15source-repository head
19source-repository head
16 type: git
20 type: git
@@ -20,4 +24,9 @@ library
20 default-language: Haskell2010
24 default-language: Haskell2010
21 ghc-options: -Wall
25 ghc-options: -Wall
22 exposed-modules: Text.XML.Lens
26 exposed-modules: Text.XML.Lens
23− build-depends: base ==4.*, lens >= 3.8 && < 4.2, containers >= 0.4.0 && < 0.6, text == 0.11.*, xml-conduit >= 1.1 && < 1.3
27+ build-depends: base ==4.*
28+ , lens >= 4.0 && < 5.4
29+ , containers >= 0.4.0 && < 0.7
30+ , text >= 0.7 && < 1.3 || >= 2 && < 2.2
31+ , xml-conduit >= 1.1 && < 1.10
32+ , case-insensitive