Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chenyunguiMilook/SwiftyXML
The most swifty way to deal with XML data in swift 5.
https://github.com/chenyunguiMilook/SwiftyXML
carthage cocoapod swifty xml xml-data xml-parser
Last synced: 3 months ago
JSON representation
The most swifty way to deal with XML data in swift 5.
- Host: GitHub
- URL: https://github.com/chenyunguiMilook/SwiftyXML
- Owner: chenyunguiMilook
- License: mit
- Created: 2016-10-02T07:21:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-17T09:39:45.000Z (about 4 years ago)
- Last Synced: 2024-07-19T00:59:54.244Z (4 months ago)
- Topics: carthage, cocoapod, swifty, xml, xml-data, xml-parser
- Language: Swift
- Homepage:
- Size: 108 KB
- Stars: 101
- Watchers: 10
- Forks: 27
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - SwiftyXML - The most swifty way to deal with XML data in swift 4. (Parsing / XML & HTML)
- awesome-swift - SwiftyXML - The most swifty way to deal with XML. (Libs / Data Management)
- awesome-swift - SwiftyXML - The most swifty way to deal with XML. (Libs / Data Management)
- fucking-awesome-swift - SwiftyXML - The most swifty way to deal with XML. (Libs / Data Management)
- awesome-ios-star - SwiftyXML - The most swifty way to deal with XML data in swift 4. (Parsing / XML & HTML)
- awesome-swift - SwiftyXML - The most swifty way to deal with XML data in swift 5. ` 📝 8 months ago` (Data Management [🔝](#readme))
README
[](https://github.com/Carthage/Carthage)
# SwiftyXML
SwiftyXML use most swifty way to deal with XML data.
## Features
- [x] Infinity subscript
- [x] dynamicMemberLookup Support (use $ started string to subscript attribute)
- [x] Optional | Non-optional value access
- [x] Directly access Enum type value (enums extends from RawRepresentable)
- [x] Directly for loop in XML children nodes
- [x] Accurate error throwing
- [x] XML construct, formatting
- [x] Single source file
Sample XML:
```xml
QWZ5671
39.95
Red
Burgundy
Red
Burgundy
RRX9856
42.50
Red
Navy
Burgundy
```
With SwiftyXML all you have to do is:
```swift
let xml = XML(string: xmlContent)
let color0 = xml.product.catalog_item.size.color_swatch.1.string //"Burgundy"
// notice that, we use "$" prefix for subscript attribute
let description0 = xml.product.catalog_item.size.1.$description.string //"Large"
```
This is same as below, SwiftyXML will auto pick the first element as default:
```swift
let xml = XML(data: xmlFileData)
let color = xml.product.0.catalog_item.0.size.0.color_swatch.1.string //return "Burgundy"
```
What about if you input some wrong keys:
```swift
let xml = XML(data: xmlFileData)
// print the error
if let color1 = xml.product.catalog_item.wrong_size.wrong_color.1.xml {
// do stuff ~
print(color1)
} else {
print(xml.product.catalog_item.wrong_size.wrong_color.1.error) //.product.0.catalog_item.0: no such children named: "wrong_size"
}
```
## Requirements
- iOS 8.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+
- Xcode 8
## Installation
#### CocoaPods
You can use [CocoaPods](http://cocoapods.org/) to install `SwiftyXML` by adding it to your `Podfile`:
```ruby
platform :ios, '8.0'
use_frameworks!
target 'MyApp' do
pod 'SwiftyXML', '~> 3.0.0'
end
```
#### Carthage
Create a `Cartfile` that lists the framework and run `carthage update`. Follow the [instructions](https://github.com/Carthage/Carthage#if-youre-building-for-ios) to add `$(SRCROOT)/Carthage/Build/iOS/SwiftyXML.framework` to an iOS project.
```
github "chenyunguiMilook/SwiftyXML" ~> 3.0.0
```
#### Manually
1. Download and drop ```XML.swift``` into your project.
2. Congratulations!
#### Swift Package Manager
You can use [The Swift Package Manager](https://swift.org/package-manager) to install `SwiftyXML` by adding the proper description to your `Package.swift` file:
```swift
.package(url: "https://github.com/chenyunguiMilook/SwiftyXML.git", from: "3.0.2")
```
## Usage
#### Initialization
```swift
import SwiftyXML
```
```swift
let xml = XML(data: xmlFileData)
```
#### Access XML and print out the error
```swift
if let color1 = xml.product.catalog_item.wrong_size.wrong_color.1.xml {
// do stuff ~
print(color1)
} else {
print(xml.product.catalog_item.wrong_size.wrong_color.1.error)
}
```
#### Catch the error
```swift
// catch the error
do {
let color = try xml.product.catalog_item.wrong_size.wrong_color.1.getXML()
print(color)
} catch {
print(error)
}
```
#### Access XML List
```swift
// handle xml list
for catalog in xml.product.catalog_item {
for size in catalog.size {
print(size.$description.stringValue)
}
}
```
#### Read Enums
```Swift
// read enum value, Notice: enum need implements RawRepresentable
public enum Color : String {
case Red, Navy, Burgundy
}
if let c: Color = xml.product.catalog_item.size.color_swatch.enum() {
print(c)
}
```
#### Construct XML
```swift
let store = XML(name: "store")
.addAttribute(name: "description", value: "Ball Store")
.addChildren([
// attributes can be added in the initializer
XML(name: "product", attributes: [
"name": "football",
"weight": 0.453
])
])
// attributes can be added to an existing object
let product2 = XML(name: "product")
product2.addAttribute(name: "name", value: "basketball")
product2.addAttribute(name: "weight", value: 0.654)
// children can be added to an existing object
store.addChild(product2)
print(store.toXMLString())
```
```xml
// store xml output
```