[go: up one dir, main page]
Skip to content

Commit

Permalink
update ReadMe.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chenyungui committed Jun 17, 2019
1 parent 15616c8 commit 18e6422
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 57 deletions.
53 changes: 22 additions & 31 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ SwiftyXML use most swifty way to deal with XML data.

## Features

- [x] Infinity subscription
- [x] Keychain subscription
- [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
Expand Down Expand Up @@ -50,32 +50,29 @@ Sample XML:
With SwiftyXML all you have to do is:

```swift
let xml = XML(data: xmlFileData)
let color0 = xml["product"]["catalog_item"]["size"]["color_swatch"][1].string //"Burgundy"
let description0 = xml["product"]["catalog_item"]["size"][1]["@description"].string //"Large"

// or use key chain subscript
let color1 = xml["#product.catalog_item.size.color_swatch.1"].string //"Burgundy"
let description1 = xml["#product.catalog_item.size.1.@description"].string //"Large"
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"
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 {
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"
print(xml.product.catalog_item.wrong_size.wrong_color.1.error) //.product.0.catalog_item.0: no such children named: "wrong_size"
}
```

Expand All @@ -94,15 +91,15 @@ platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
pod 'SwiftyXML', '~> 2.0.0'
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" ~> 2.0.0
github "chenyunguiMilook/SwiftyXML" ~> 3.0.0
```
#### Manually
1. Download and drop ```XML.swift``` into your project.
Expand All @@ -118,7 +115,7 @@ let package = Package(
name: "PROJECT_NAME",
targets: [],
dependencies: [
.Package(url: "https://github.com/chenyunguiMilook/SwiftyXML.git", majorVersion: 2, minor: 0)
.Package(url: "https://github.com/chenyunguiMilook/SwiftyXML.git", majorVersion: 3, minor: 0)
]
)
```
Expand All @@ -132,22 +129,15 @@ import SwiftyXML
```swift
let xml = XML(data: xmlFileData)
```
#### Access XML use key chain

```swift
// attribute key chain, #: means start key chain subscript, @: means start attribute subscript
xml["#product.catalog_item.size.color_swatch.@image"].stringValue
xml["#product.@description"].stringValue
```

#### Access XML and print out the error

```swift
if let color1 = xml["product"]["catalog_item"]["wrong_size"]["wrong_color"][1].xml {
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"
print(xml.product.catalog_item.wrong_size.wrong_color.1.error)
}
```

Expand All @@ -156,7 +146,8 @@ if let color1 = xml["product"]["catalog_item"]["wrong_size"]["wrong_color"][1].x
```swift
// catch the error
do {
let color = try xml["product"]["catalog_item"]["wrong_size"]["wrong_color"][1].getXML()
let color = try xml.product.catalog_item.wrong_size.wrong_color.1.getXML()
print(color)
} catch {
print(error)
}
Expand All @@ -166,9 +157,9 @@ do {

```swift
// handle xml list
for catalog in xml["product"]["catalog_item"] {
for size in catalog["size"] {
print(size["@description"].stringValue)
for catalog in xml.product.catalog_item {
for size in catalog.size {
print(size.$description.stringValue)
}
}
```
Expand All @@ -180,7 +171,7 @@ public enum Color : String {
case Red, Navy, Burgundy
}

if let c: Color = xml["product"]["catalog_item"]["size"]["color_swatch"].enum() {
if let c: Color = xml.product.catalog_item.size.color_swatch.enum() {
print(c)
}
```
Expand Down
49 changes: 23 additions & 26 deletions SwiftyXML_iOS.playground/Pages/SubscriptTest.xcplaygroundpage/Contents.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,33 @@ import SwiftyXML
let xmlContent = """
<?xml version="1.0"?>
<catalog>
<product description="Cardigan Sweater" product_image="cardigan.jpg">
<catalog_item gender="Men's">
<item_number>QWZ5671</item_number>
<price>39.95</price>
<size description="Medium">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
<size description="Large">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
</catalog_item>
<catalog_item gender="Women's">
<item_number>RRX9856</item_number>
<price>42.50</price>
<size description="Small">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="navy_cardigan.jpg">Navy</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
</catalog_item>
</product>
<product description="Cardigan Sweater" product_image="cardigan.jpg">
<catalog_item gender="Men's">
<item_number>QWZ5671</item_number>
<price>39.95</price>
<size description="Medium">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
<size description="Large">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
</catalog_item>
<catalog_item gender="Women's">
<item_number>RRX9856</item_number>
<price>42.50</price>
<size description="Small">
<color_swatch image="red_cardigan.jpg">Red</color_swatch>
<color_swatch image="navy_cardigan.jpg">Navy</color_swatch>
<color_swatch image="burgundy_cardigan.jpg">Burgundy</color_swatch>
</size>
</catalog_item>
</product>
</catalog>
"""

let xml = XML(string: xmlContent)
print(xml.toXMLString())


let color0 = xml.product.catalog_item.size.color_swatch.1.string
let description0 = xml.product.catalog_item.size.1.$description.string

Expand Down

0 comments on commit 18e6422

Please sign in to comment.