master..ec44391 · typeable/xml-lens

git.iko.soy/typeable/xml-lens

on ec44391 help sign in

.github/workflows/haskell.ymldeleted−37

since splitsnapshots

unifiedsplit

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

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,4 +1,3 @@

1−dist-newstyle

2#################

1#################

3## Eclipse

2## Eclipse

4#################

3#################

CHANGELOG.mddeleted−10

@@ -1,10 +0,0 @@

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+4−8

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

9```haskell

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

12−> doc ^.. root . named "books" ... named "book" . attributeIs "category" "Textbooks" ... named "title" . text

12+> doc ^.. root . el "books" ./ el "book" . attributeIs "category" "Textbooks" ./ el "title" . text

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

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

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

167

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

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

19Just "Functional Ikamusume"

21−> doc & root . named "books" ... named "book" ... named "pages" . text <>~ " pages" & renderLBS def & BL.putStrLn

21+> doc & root . el "books" ./ el "book" ./ el "pages" . text <>~ " pages" & renderLBS def & BL.putStrLn

22```

24```xml

@@ -43,8 +43,4 @@ 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+29−50

@@ -3,18 +3,18 @@

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 : provisional

10+-- Stability : experimental

11-- Portability : non-portable

12−--

12+-- Useful traversals inspired by XPath

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

14module Text.XML.Lens (

15 -- * Lenses, traversals for 'Element'

16 Element(..)

17− , (...)

17+ , (./)

18 -- ** Names

19 , name

20 , localName

@@ -24,8 +24,6 @@ module Text.XML.Lens (

24 -- ** Attributes

25 , attributeIs

26 , attributeSatisfies

27− , attributeSatisfies'

28− , withoutAttribute

29 , attr

27 , attr

30 , attribute

28 , attribute

31 , attrs

29 , attrs

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

33 , text

31 , text

34 , comment

32 , comment

35 -- ** Children

33 -- ** Children

34+ , entire

36 , nodes

35 , nodes

37 -- * Prisms for 'Node'

36 -- * Prisms for 'Node'

38 , Node(..)

37 , Node(..)

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

55 , Instruction(..)

54 , Instruction(..)

56 , _instructionTarget

55 , _instructionTarget

57 , _instructionData

56 , _instructionData

57+ -- * Reexport

58+ , module Control.Lens

58 ) where

59 ) where

59import Text.XML

60import Text.XML

60import Control.Lens

61import Control.Lens

61import Data.Text (Text)

62import Data.Text (Text)

62import Data.Map (Map)

63import Data.Map (Map)

63−import qualified Data.CaseInsensitive as CI

64+import Control.Applicative

64−import Data.Maybe (isNothing)

65+

66+infixr 9 ./

66prologue :: Lens' Document Prologue

68prologue :: Lens' Document Prologue

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

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

68−{-# INLINE prologue #-}

70-- | The root element of the document.

71-- | The root element of the document.

71root :: Lens' Document Element

72root :: Lens' Document Element

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

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

73−{-# INLINE root #-}

75epilogue :: Lens' Document [Miscellaneous]

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

77−{-# INLINE epilogue #-}

79doctype :: Lens' Prologue (Maybe Doctype)

78doctype :: Lens' Prologue (Maybe Doctype)

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

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

81−{-# INLINE doctype #-}

83class AsInstruction t where

81class AsInstruction t where

84 _Instruction :: Prism' t Instruction

82 _Instruction :: Prism' t Instruction

86_instructionTarget :: Lens' Instruction Text

84_instructionTarget :: Lens' Instruction Text

87_instructionTarget f (Instruction t d) = f t <&> \t' -> Instruction t' d

85_instructionTarget f (Instruction t d) = f t <&> \t' -> Instruction t' d

88−{-# INLINE _instructionTarget #-}

90_instructionData :: Lens' Instruction Text

87_instructionData :: Lens' Instruction Text

91_instructionData f (Instruction t d) = f d <&> \d' -> Instruction t d'

88_instructionData f (Instruction t d) = f d <&> \d' -> Instruction t d'

92−{-# INLINE _instructionData #-}

94instance AsInstruction Node where

90instance AsInstruction Node where

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

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

96 NodeInstruction e -> Just e

92 NodeInstruction e -> Just e

97 _ -> Nothing

93 _ -> Nothing

98− {-# INLINE _Instruction #-}

100instance AsInstruction Miscellaneous where

95instance AsInstruction Miscellaneous where

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

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

102 MiscInstruction e -> Just e

97 MiscInstruction e -> Just e

103 _ -> Nothing

98 _ -> Nothing

104− {-# INLINE _Instruction #-}

105

106class AsComment t where

100class AsComment t where

107 _Comment :: Prism' t Text

101 _Comment :: Prism' t Text

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

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

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

111 NodeComment e -> Just e

105 NodeComment e -> Just e

112 _ -> Nothing

106 _ -> Nothing

113− {-# INLINE _Comment #-}

114

107

115instance AsComment Miscellaneous where

108instance AsComment Miscellaneous where

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

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

117 MiscComment e -> Just e

110 MiscComment e -> Just e

118 _ -> Nothing

111 _ -> Nothing

119− {-# INLINE _Comment #-}

120

112

121_nameLocalName :: Lens' Name Text

113_nameLocalName :: Lens' Name Text

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

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

123−{-# INLINE _nameLocalName #-}

124

115

125_nameNamespace :: Lens' Name (Maybe Text)

116_nameNamespace :: Lens' Name (Maybe Text)

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

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

127−{-# INLINE _nameNamespace #-}

128

118

129_namePrefix :: Lens' Name (Maybe Text)

119_namePrefix :: Lens' Name (Maybe Text)

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

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

131−{-# INLINE _namePrefix #-}

132

121

133_Element :: Prism' Node Element

122_Element :: Prism' Node Element

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

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

135 NodeElement e -> Just e

124 NodeElement e -> Just e

136 _ -> Nothing

125 _ -> Nothing

137−{-# INLINE _Element #-}

138

126

139_Content :: Prism' Node Text

127_Content :: Prism' Node Text

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

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

141 NodeContent e -> Just e

129 NodeContent e -> Just e

142 _ -> Nothing

130 _ -> Nothing

143−{-# INLINE _Content #-}

144

131

145name :: Lens' Element Name

132name :: Lens' Element Name

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

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

147−{-# INLINE name #-}

148

134

149localName :: Lens' Element Text

135localName :: Lens' Element Text

150localName = name . _nameLocalName

136localName = name . _nameLocalName

@@ -152,65 +138,58 @@ localName = name . _nameLocalName

152

138

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

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

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

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

155−{-# INLINE attrs #-}

156

141

157nodes :: Lens' Element [Node]

142nodes :: Lens' Element [Node]

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

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

159−{-# INLINE nodes #-}

160

144

161attr :: Name -> Traversal' Element Text

145attr :: Name -> Traversal' Element Text

162attr n = attrs . ix n

146attr n = attrs . ix n

163−{-# INLINE attr #-}

164

147

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

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

166attribute n = attrs . at n

149attribute n = attrs . at n

167−{-# INLINE attribute #-}

168

150

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

152+entire :: Traversal' Element Element

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

154+ com (Element n a _) = Element n a

155+

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

156+-- | Traverse elements which has the specified *local* name.

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

157+named :: Text -> Traversal' Element Element

171named n f s

158named n f s

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

159+ | nameLocalName (elementName s) == n = f s

173 | otherwise = pure s

160 | otherwise = pure s

174−{-# INLINE named #-}

175

161

176−-- | Old name for 'named'

177ell :: Text -> Traversal' Element Element

162ell :: Text -> Traversal' Element Element

178−ell n = named $ CI.mk n

163+ell = named

179

164

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

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

181el :: Name -> Traversal' Element Element

166el :: Name -> Traversal' Element Element

182el n f s

167el n f s

183 | elementName s == n = f s

168 | elementName s == n = f s

184 | otherwise = pure s

169 | otherwise = pure s

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

186

170

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

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

188−attributeSatisfies n p = attributeSatisfies' n (maybe False p)

172+attributeSatisfies n p = filtered (maybe False p . preview (attrs . ix n))

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

198

173

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

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

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

175attributeIs n v = attributeSatisfies n (==v)

201−{-# INLINE attributeIs #-}

202

176

203-- | Traverse all contents of the element.

177-- | Traverse all contents of the element.

204text :: Traversal' Element Text

178text :: Traversal' Element Text

205text = nodes . traverse . _Content

179text = nodes . traverse . _Content

206−{-# INLINE text #-}

207

180

208-- | Traverse all comments of the element.

181-- | Traverse all comments of the element.

209comment :: Traversal' Element Text

182comment :: Traversal' Element Text

210comment = nodes . traverse . _Comment

183comment = nodes . traverse . _Comment

211−{-# INLINE comment #-}

212

184

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

214instance Plated Element where

185instance Plated Element where

215 plate = nodes . traverse . _Element

186 plate = nodes . traverse . _Element

187+

188+-- | Combine two 'Traversal's just like XPath's slash.

189+--

190+-- @

191+-- l ./ m ≡ l . 'plate' . m

192+-- @

193+(./) :: Plated a => Traversal s t a a -> Traversal a a u v -> Traversal s t u v

194+l ./ m = l . plate . m

216− {-# INLINE plate #-}

195+{-# INLINE (./) #-}

cabal.projectdeleted−1

@@ -1 +0,0 @@

1−packages: ./

stack.yamldeleted−4

@@ -1,4 +0,0 @@

1−resolver: lts-21.3

2−

3−packages:

4−- .

xml-lens.cabal+8−17

@@ -1,20 +1,16 @@

1−cabal-version: 2.4

2name: xml-lens

1name: xml-lens

3−version: 0.3.1

2+version: 0.1.6

4−synopsis: Lenses, traversals, and prisms for xml-conduit

3+synopsis: Lenses, traversals, prisms for xml-conduit

5−description: This package provides DOM selectors based on lenses and prisms. See README.md for examples

4+description: Lens-based DOM selector

6homepage: https://github.com/fumieval/xml-lens

5homepage: https://github.com/fumieval/xml-lens

7−bug-reports: https://github.com/fumieval/xml-lens/issues

8−license: BSD-3-Clause

6+license: BSD3

9license-file: LICENSE

7license-file: LICENSE

10author: Fumiaki Kinoshita

8author: Fumiaki Kinoshita

11maintainer: Fumiaki Kinoshita <fumiexcel@gmail.com>

9maintainer: Fumiaki Kinoshita <fumiexcel@gmail.com>

13−category: XML

11+category: Control

14build-type: Simple

12build-type: Simple

15−extra-source-files:

13+cabal-version: >=1.10

16− README.md

17− CHANGELOG.md

19source-repository head

15source-repository head

20 type: git

16 type: git

@@ -24,9 +20,4 @@ library

24 default-language: Haskell2010

20 default-language: Haskell2010

25 ghc-options: -Wall

21 ghc-options: -Wall

26 exposed-modules: Text.XML.Lens

22 exposed-modules: Text.XML.Lens

27− build-depends: base ==4.*

23+ build-depends: base ==4.*, lens >= 4.0 && < 4.4, containers >= 0.4.0 && < 0.7, text >= 0.7 && <2, xml-conduit >= 1.1 && < 1.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