Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yahoojapan/swiftyxmlparser
Simple XML Parser implemented in Swift
https://github.com/yahoojapan/swiftyxmlparser
carthage cocoapods ios swift xml-parser
Last synced: 2 days ago
JSON representation
Simple XML Parser implemented in Swift
- Host: GitHub
- URL: https://github.com/yahoojapan/swiftyxmlparser
- Owner: yahoojapan
- License: mit
- Created: 2016-04-27T05:53:44.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T23:35:59.000Z (about 2 years ago)
- Last Synced: 2024-10-23T12:33:38.966Z (4 months ago)
- Topics: carthage, cocoapods, ios, swift, xml-parser
- Language: Swift
- Homepage:
- Size: 290 KB
- Stars: 577
- Watchers: 17
- Forks: 89
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/SwiftyXMLParser)
[](http://cocoapods.org/pods/SwiftyXMLParser)
Simple XML Parser implemented in Swift
# What's this?
This is a XML parser inspired by [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) and [SWXMLHash](https://github.com/drmohundro/SWXMLHash).
[NSXMLParser](https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSXMLParser_Class/) in Foundation framework is a kind of "SAX" parser. It has enough performance but is a little inconvenient. So we have implemented "DOM" parser wrapping it.
# Feature
- [x] access XML Document with "subscript".
- [x] access XML Document as Sequence.
- [x] easy debugging XML pathes.
# Requirement
+ iOS 9.0+
+ tvOS 9.0+
+ macOS 10.10+
+ Swift 5.0
# Installation
### Carthage
#### 1. create Cartfile
```ruby:Cartfile
github "https://github.com/yahoojapan/SwiftyXMLParser"
```
#### 2. install
```
> carthage update
```
### CocoaPods
#### 1. create Podfile
```ruby:Podfile
platform :ios, '9.0'
use_frameworks!
pod "SwiftyXMLParser", :git => 'https://github.com/yahoojapan/SwiftyXMLParser.git'
```
#### 2. install
```
> pod install
```
# Example
```swift
import SwiftyXMLParser
let str = """
Item1
Item2
"""
// parse xml document
let xml = try! XML.parse(str)
// access xml element
let accessor = xml["ResultSet"]
// access XML Text
if let text = xml["ResultSet", "Result", "Hit", 0, "Name"].text {
print(text)
}
if let text = xml.ResultSet.Result.Hit[0].Name.text {
print(text)
}
// access XML Attribute
if let index = xml["ResultSet", "Result", "Hit", 0].attributes["index"] {
print(index)
}
// enumerate child Elements in the parent Element
for hit in xml["ResultSet", "Result", "Hit"] {
print(hit)
}
// check if the XML path is wrong
if case .failure(let error) = xml["ResultSet", "Result", "TypoKey"] {
print(error)
}
```
# Usage
### 1. Parse XML
+ from String
```swift
let str = """
Item1
Item2
"""
xml = try! XML.parse(str) // -> XML.Accessor
```
+ from NSData
```swift
let str = """
Item1
Item2
"""
let string = String(decoding: data, as: UTF8.self)
xml = XML.parse(data) // -> XML.Accessor
```
+ with invalid character
```swift
let srt = "@ß123\u{1c}"
let xml = XML.parse(str.data(using: .utf8))
if case .failure(XMLError.interruptedParseError) = xml {
print("invalid character")
}
```
For more, see https://developer.apple.com/documentation/foundation/xmlparser/errorcode
### 2. Access child Elements
```swift
let element = xml.ResultSet // -> XML.Accessor
```
### 3. Access grandchild Elements
+ with String
```swift
let element = xml["ResultSet"]["Result"] // -> Item1Item2
```
+ with Array
```swift
let path = ["ResultSet", "Result"]
let element = xml[path] // -> Item1Item2
```
+ with Variadic
```swift
let element = xml["ResultSet", "Result"] // -> Item1Item2
```
+ with @dynamicMemberLookup
```swift
let element = xml.ResultSet.Result // -> Item1Item2
```
### 4. Access specific grandchild Element
```swift
let element = xml.ResultSet.Result.Hit[1] // -> Item2
```
### 5. Access attribute in Element
```swift
if let attributeValue = xml.ResultSet.Result.Hit[1].attributes?["index"] {
print(attributeValue) // -> 2
}
```
### 6. Access text in Element
+ with optional binding
```swift
if let text = xml.ResultSet.Result.Hit[1].Name.text {
print(text) // -> Item2
}
```
+ with custom operation
```swift
struct Entity {
var name = ""
}
let entity = Entity()
entity.name ?= xml.ResultSet.Result.Hit[1].Name.text // assign if it has text
```
+ convert Int and assign
```swift
struct Entity {
var name: Int = 0
}
let entity = Entity()
entity.name ?= xml.ResultSet.Result.Hit[1].Name.int // assign if it has Int
```
and there are other syntax sugers, bool, url and double.
+ assign text into Array
```swift
struct Entity {
var names = [String]()
}
let entity = Entity()
entity.names ?<< xml.ResultSet.Result.Hit[1].Name.text // assign if it has text
```
### 7. Access CDATA
```swift
let str = """
"""
// parse xml document
let xml = try! XML.parse(str)
if let cdata = xml.Data.value.element?.CDATA,
let cdataStr = String(data: cdata, encoding: .utf8) {
print(cdataStr) // -> "2018-07-08"
}
```
### 7. Count child Elements
```swift
let numberOfHits = xml.ResultSet.Result.Hit.all?.count
```
### 8. Check error
```swift
print(xml.ResultSet.Result.TypoKey) // -> "TypoKey not found."
```
### 9. Access as SequenceType
+ for-in
```swift
for element in xml.ResultSet.Result.Hit {
print(element.text)
}
```
+ map
```swift
xml.ResultSet.Result.Hit.map { $0.Name.text }
```
### 10. Generate XML document
```swift
print(Converter(xml.ResultSet).makeDocument())
```
## Work with Alamofire
SwiftyXMLParser goes well with [Alamofire](https://github.com/Alamofire/Alamofire). You can parse the response easily.
```swift
import Alamofire
import SwiftyXMLParser
Alamofire.request(.GET, "https://itunes.apple.com/us/rss/topgrossingapplications/limit=10/xml")
.responseData { response in
if let data = response.data {
let xml = XML.parse(data)
print(xml.feed.entry[0].title.text) // outputs the top title of iTunes app raning.
}
}
```
In addition, there is the extension of Alamofire to combine with SwiftyXMLParser.
* [Alamofire-SwiftyXMLParser](https://github.com/kazuhiro4949/Alamofire-SwiftyXMLParser)
# Migration Guide
[Current master branch](https://github.com/yahoojapan/SwiftyXMLParser/tree/master) is supporting Xcode10.
If you wanna use this library with legacy swift version, read [release notes](https://github.com/yahoojapan/SwiftyXMLParser/releases) and install the last compatible version.
# License
This software is released under the MIT License, see LICENSE.