29993c2...master · typeable/xml-lens

git.iko.soy/typeable/xml-lens

on master help sign in

.github/workflows/haskell.ymlnew file+37

since splitsnapshots

unifiedsplit

@@ -0,0 +1,37 @@

1+name: Haskell CI

3+on: [push, pull_request]

5+jobs:

6+ build:

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

3+* Supported GHC 9

5+## 0.3 (2021/01)

7+* Deprecated `el`

8+* Removed `./` and `entire`

10+

README.md+8−4

@@ -9,16 +9,16 @@ Example

9```haskell

10> doc <- Text.XML.readFile def "examples/books.xml"

12−> 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

13["Learn You a Haskell for Great Good!","Programming in Haskell","Real World Haskell"]

15−> lengthOf ?? doc $ root . el "books" ./ el "book"

15+> lengthOf ?? doc $ root . named "books" ... named "book"

167

18−> doc ^? root . el "books" ./ attributeIs "category" "Joke" ./ el "title" . text

18+> doc ^? root . named "books" ... attributeIs "category" "Joke" ... named "title" . text

19Just "Functional Ikamusume"

21−> 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```

24```xml

@@ -43,4 +43,8 @@ Just "Functional Ikamusume"

43…

44```

46+Tips

47+----

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+57−32

@@ -3,26 +3,29 @@

3-----------------------------------------------------------------------------

4-- |

5-- Module : Text.XML.Lens

7-- License : BSD-style (see the file LICENSE)

8--

9-- Maintainer : Fumiaki Kinoshita <fumiexcel@gmail.com>

10−-- Stability : experimental

10+-- Stability : provisional

11-- Portability : non-portable

12−-- Useful traversals inspired by XPath

12+--

13----------------------------------------------------------------------------

14module Text.XML.Lens (

15 -- * Lenses, traversals for 'Element'

16 Element(..)

17− , (./)

17+ , (...)

18 -- ** Names

19 , name

20 , localName

21 , el

22 , ell

23+ , named

23 -- ** Attributes

24 -- ** Attributes

24 , attributeIs

25 , attributeIs

25 , attributeSatisfies

26 , attributeSatisfies

27+ , attributeSatisfies'

28+ , withoutAttribute

26 , attr

29 , attr

27 , attribute

30 , attribute

28 , attrs

31 , attrs

@@ -30,7 +33,6 @@ module Text.XML.Lens (

30 , text

33 , text

31 , comment

34 , comment

32 -- ** Children

35 -- ** Children

33− , entire

34 , nodes

36 , nodes

35 -- * Prisms for 'Node'

37 -- * Prisms for 'Node'

36 , Node(..)

38 , Node(..)

@@ -53,48 +55,53 @@ module Text.XML.Lens (

53 , Instruction(..)

55 , Instruction(..)

54 , _instructionTarget

56 , _instructionTarget

55 , _instructionData

57 , _instructionData

56− -- * Reexport

57− , module Control.Lens

58 ) where

59import Text.XML

60import Control.Lens

61import Data.Text (Text)

62import Data.Map (Map)

63−import Control.Applicative

63+import qualified Data.CaseInsensitive as CI

64−

64+import Data.Maybe (isNothing)

65−infixr 9 ./

67prologue :: Lens' Document Prologue

66prologue :: Lens' Document Prologue

68prologue f doc = fmap (\p -> doc { documentPrologue = p} ) $ f $ documentPrologue doc

67prologue f doc = fmap (\p -> doc { documentPrologue = p} ) $ f $ documentPrologue doc

68+{-# INLINE prologue #-}

70-- | The root element of the document.

71root :: Lens' Document Element

72root f doc = fmap (\p -> doc { documentRoot = p} ) $ f $ documentRoot doc

73+{-# INLINE root #-}

74epilogue :: Lens' Document [Miscellaneous]

75epilogue :: Lens' Document [Miscellaneous]

75epilogue f doc = fmap (\p -> doc { documentEpilogue = p} ) $ f $ documentEpilogue doc

76epilogue f doc = fmap (\p -> doc { documentEpilogue = p} ) $ f $ documentEpilogue doc

77+{-# INLINE epilogue #-}

77doctype :: Lens' Prologue (Maybe Doctype)

79doctype :: Lens' Prologue (Maybe Doctype)

78doctype f doc = fmap (\p -> doc { prologueDoctype = p} ) $ f $ prologueDoctype doc

80doctype f doc = fmap (\p -> doc { prologueDoctype = p} ) $ f $ prologueDoctype doc

81+{-# INLINE doctype #-}

80class AsInstruction t where

83class AsInstruction t where

81 _Instruction :: Prism' t Instruction

84 _Instruction :: Prism' t Instruction

83_instructionTarget :: Lens' Instruction Text

86_instructionTarget :: Lens' Instruction Text

84_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 #-}

86_instructionData :: Lens' Instruction Text

90_instructionData :: Lens' Instruction Text

87_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 #-}

89instance AsInstruction Node where

94instance AsInstruction Node where

90 _Instruction = prism' NodeInstruction $ \s -> case s of

95 _Instruction = prism' NodeInstruction $ \s -> case s of

91 NodeInstruction e -> Just e

96 NodeInstruction e -> Just e

92 _ -> Nothing

97 _ -> Nothing

98+ {-# INLINE _Instruction #-}

94instance AsInstruction Miscellaneous where

100instance AsInstruction Miscellaneous where

95 _Instruction = prism' MiscInstruction $ \s -> case s of

101 _Instruction = prism' MiscInstruction $ \s -> case s of

96 MiscInstruction e -> Just e

102 MiscInstruction e -> Just e

97 _ -> Nothing

103 _ -> Nothing

104+ {-# INLINE _Instruction #-}

105

99class AsComment t where

106class AsComment t where

100 _Comment :: Prism' t Text

107 _Comment :: Prism' t Text

@@ -103,33 +110,41 @@ instance AsComment Node where

103 _Comment = prism' NodeComment $ \s -> case s of

110 _Comment = prism' NodeComment $ \s -> case s of

104 NodeComment e -> Just e

111 NodeComment e -> Just e

105 _ -> Nothing

112 _ -> Nothing

113+ {-# INLINE _Comment #-}

106

114

107instance AsComment Miscellaneous where

115instance AsComment Miscellaneous where

108 _Comment = prism' MiscComment $ \s -> case s of

116 _Comment = prism' MiscComment $ \s -> case s of

109 MiscComment e -> Just e

117 MiscComment e -> Just e

110 _ -> Nothing

118 _ -> Nothing

119+ {-# INLINE _Comment #-}

111

120

112_nameLocalName :: Lens' Name Text

121_nameLocalName :: Lens' Name Text

113_nameLocalName f n = f (nameLocalName n) <&> \x -> n { nameLocalName = x }

122_nameLocalName f n = f (nameLocalName n) <&> \x -> n { nameLocalName = x }

123+{-# INLINE _nameLocalName #-}

114

124

115_nameNamespace :: Lens' Name (Maybe Text)

125_nameNamespace :: Lens' Name (Maybe Text)

116_nameNamespace f n = f (nameNamespace n) <&> \x -> n { nameNamespace = x }

126_nameNamespace f n = f (nameNamespace n) <&> \x -> n { nameNamespace = x }

127+{-# INLINE _nameNamespace #-}

117

128

118_namePrefix :: Lens' Name (Maybe Text)

129_namePrefix :: Lens' Name (Maybe Text)

119_namePrefix f n = f (namePrefix n) <&> \x -> n { namePrefix = x }

130_namePrefix f n = f (namePrefix n) <&> \x -> n { namePrefix = x }

131+{-# INLINE _namePrefix #-}

120

132

121_Element :: Prism' Node Element

133_Element :: Prism' Node Element

122_Element = prism' NodeElement $ \s -> case s of

134_Element = prism' NodeElement $ \s -> case s of

123 NodeElement e -> Just e

135 NodeElement e -> Just e

124 _ -> Nothing

136 _ -> Nothing

137+{-# INLINE _Element #-}

125

138

126_Content :: Prism' Node Text

139_Content :: Prism' Node Text

127_Content = prism' NodeContent $ \s -> case s of

140_Content = prism' NodeContent $ \s -> case s of

128 NodeContent e -> Just e

141 NodeContent e -> Just e

129 _ -> Nothing

142 _ -> Nothing

143+{-# INLINE _Content #-}

130

144

131name :: Lens' Element Name

145name :: Lens' Element Name

132name f e = f (elementName e) <&> \x -> e { elementName = x }

146name f e = f (elementName e) <&> \x -> e { elementName = x }

147+{-# INLINE name #-}

133

148

134localName :: Lens' Element Text

149localName :: Lens' Element Text

135localName = name . _nameLocalName

150localName = name . _nameLocalName

@@ -137,55 +152,65 @@ localName = name . _nameLocalName

137

152

138attrs :: Lens' Element (Map Name Text)

153attrs :: Lens' Element (Map Name Text)

139attrs f e = fmap (\x -> e { elementAttributes = x }) $ f $ elementAttributes e

154attrs f e = fmap (\x -> e { elementAttributes = x }) $ f $ elementAttributes e

155+{-# INLINE attrs #-}

140

156

141nodes :: Lens' Element [Node]

157nodes :: Lens' Element [Node]

142nodes f e = fmap (\x -> e { elementNodes = x }) $ f $ elementNodes e

158nodes f e = fmap (\x -> e { elementNodes = x }) $ f $ elementNodes e

159+{-# INLINE nodes #-}

143

160

144−attr :: Name -> IndexedTraversal' Name Element Text

161+attr :: Name -> Traversal' Element Text

145attr n = attrs . ix n

162attr n = attrs . ix n

163+{-# INLINE attr #-}

146

164

147−attribute :: Name -> IndexedLens' Name Element (Maybe Text)

165+attribute :: Name -> Lens' Element (Maybe Text)

148attribute n = attrs . at n

166attribute n = attrs . at n

167+{-# INLINE attribute #-}

168+

169+-- | Traverse elements which has the specified *local* name (case-insensitive).

170+named :: CI.CI Text -> Traversal' Element Element

171+named n f s

172+ | CI.mk (nameLocalName (elementName s)) == n = f s

173+ | otherwise = pure s

174+{-# INLINE named #-}

149

175

150−-- | Traverse itself with its all children.　Rewriting subnodes of each children will break a traversal law.

176+-- | Old name for 'named'

151−entire :: Traversal' Element Element

177+ell :: Text -> Traversal' Element Element

152−entire f e@(Element _ _ ns) = com <$> f e <*> traverse (_Element (entire f)) ns where

178+ell n = named $ CI.mk n

153− com (Element n a _) = Element n a

154

179

155-- | Traverse elements which has the specified name.

180-- | Traverse elements which has the specified name.

156el :: Name -> Traversal' Element Element

181el :: Name -> Traversal' Element Element

157el n f s

182el n f s

158 | elementName s == n = f s

183 | elementName s == n = f s

159 | otherwise = pure s

184 | otherwise = pure s

160−

185+{-# DEPRECATED el "Use named instead" #-}

161−-- | Traverse elements which has the specified *local* name.

162−ell :: Text -> Traversal' Element Element

163−ell n f s

164− | nameLocalName (elementName s) == n = f s

165− | otherwise = pure s

166

186

167attributeSatisfies :: Name -> (Text -> Bool) -> Traversal' Element Element

187attributeSatisfies :: Name -> (Text -> Bool) -> Traversal' Element Element

168−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 #-}

169

198

170attributeIs :: Name -> Text -> Traversal' Element Element

199attributeIs :: Name -> Text -> Traversal' Element Element

171attributeIs n v = attributeSatisfies n (==v)

200attributeIs n v = attributeSatisfies n (==v)

201+{-# INLINE attributeIs #-}

172

202

173-- | Traverse all contents of the element.

203-- | Traverse all contents of the element.

174text :: Traversal' Element Text

204text :: Traversal' Element Text

175text = nodes . traverse . _Content

205text = nodes . traverse . _Content

206+{-# INLINE text #-}

176

207

177-- | Traverse all comments of the element.

208-- | Traverse all comments of the element.

178comment :: Traversal' Element Text

209comment :: Traversal' Element Text

179comment = nodes . traverse . _Comment

210comment = nodes . traverse . _Comment

211+{-# INLINE comment #-}

180

212

213+-- | 'plate' traverses over its sub-elements.

181instance Plated Element where

214instance Plated Element where

182 plate = nodes . traverse . _Element

215 plate = nodes . traverse . _Element

183−

184−-- | Combine two 'Traversal's just like XPath's slash.

185−--

186−-- @

187−-- l ./ m ≡ l . 'plate' . m

188−-- @

189−(./) :: Plated a => Traversal s t a a -> Traversal a a u v -> Traversal s t u v

190−l ./ m = l . plate . m

191−{-# INLINE (./) #-}

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

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

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>

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

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