Add children method for enumerating elements.

This method can be distinguished from the all method because the all
method enumerates all elements *at the currently indexed level*. The
children method enumerates all *child* elements at the currently indexed
level.

Resolves issue #7.

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.6.0 (January 30, 2015)
+
+* Added `children` property to allow for enumerating all child elements.
+
 ## v0.5.5 (January 25, 2015)
 
 * Added OSX target, should allow SWXMLHash to work in OSX as well as iOS.

README.md

@@ -93,7 +93,7 @@ Alternatively, you can look up an element with specific attributes. The below wi
 xml["root"]["catalog"]["book"].withAttr("id", "123")["author"].element?.text
 ```
 
-### Returning All Elements
+### Returning All Elements At Current Level
 
 Given:
 
@@ -125,6 +125,35 @@ for elem in xml["root"]["catalog"]["book"] {
 }
 ```
 
+### Returning All Child Elements At Current Level
+
+Given:
+
+```xml
+<root>
+  <catalog>
+    <book>
+      <genre>Fiction</genre>
+      <title>Book</title>
+      <date>1/1/2015</date>
+    </book>
+  </catalog>
+</root>
+```
+
+The below will `NSLog` "root", "catalog", "book", "genre", "title", and "date" (note the `children` method).
+
+```swift
+func enumerate(indexer: XMLIndexer) {
+  for child in indexer.children {
+    NSLog(child.element!.name)
+    enumerate(child)
+  }
+}
+
+enumerate(xml)
+```
+
 ### Error Handling
 
 ```swift

SWXMLHash.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name        = 'SWXMLHash'
-  s.version     = '0.5.5'
+  s.version     = '0.6.0'
   s.summary     = 'Simple XML parsing in Swift'
   s.homepage    = 'https://github.com/drmohundro/SWXMLHash'
   s.license     = { :type => 'MIT' }
@@ -9,6 +9,6 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.osx.deployment_target = '10.9'
   s.ios.deployment_target = '8.0'
-	s.source      = { :git => 'https://github.com/drmohundro/SWXMLHash.git', :tag => '0.5.5' }
+  s.source      = { :git => 'https://github.com/drmohundro/SWXMLHash.git', :tag => '0.6.0' }
   s.source_files = 'Source/*.swift'
 end

SWXMLHashPlayground.playground/section-1.swift

@@ -25,3 +25,24 @@ let count = xml["root"].all.count
 
 // "Apples"
 xml["root"]["h:table"]["h:tr"]["h:td"][0].element!.text!
+
+
+// enumerate all child elements (procedurally)
+func enumerate(indexer: XMLIndexer, level: Int) {
+    for child in indexer.children {
+        var name = child.element!.name
+        NSLog("\(level) \(name)")
+
+        enumerate(child, level + 1)
+    }
+}
+
+enumerate(xml, 0)
+
+
+// enumerate all child elements (functionally)
+func reduceName(names: String, elem: XMLIndexer) -> String {
+    return names + elem.element!.name + elem.children.reduce(", ", combine: reduceName)
+}
+
+xml.children.reduce("elements: ", combine: reduceName)

Source/SWXMLHash.swift

@@ -123,7 +123,7 @@ public enum XMLIndexer : SequenceType {
         }
     }
 
-    /// The underlying array of XMLElements at the currently indexed level of XML.
+    /// All elements at the currently indexed level
     public var all: [XMLIndexer] {
         get {
             switch self {
@@ -140,6 +140,20 @@ public enum XMLIndexer : SequenceType {
             }
         }
     }
+
+    /// All child elements from the currently indexed level
+    public var children: [XMLIndexer] {
+        get {
+            var list = [XMLIndexer]()
+            for elem in all.map({ $0.element! }) {
+                for keyVal in elem.children.values {
+                    for elem in keyVal {
+                        list.append(XMLIndexer(elem))
+                    }
+                }
+            }
+            return list
+        }
     }
 
     /**

Tests/SWXMLHashSpecs.swift

@@ -53,7 +53,7 @@ class SWXMLHashTests: QuickSpec {
             }
 
             it("should be able to iterate element groups") {
-                expect(", ".join(xml["root"]["catalog"]["book"].all.map { elem in elem["genre"].element!.text! })).to(equal("Computer, Fantasy, Fantasy"))
+                expect(", ".join(xml["root"]["catalog"]["book"].all.map { $0["genre"].element!.text! })).to(equal("Computer, Fantasy, Fantasy"))
             }
 
             it("should be able to iterate element groups even if only one element is found") {
@@ -82,6 +82,10 @@ class SWXMLHashTests: QuickSpec {
 
                 expect(parsed["niotemplate"]["other"].element?.text).to(equal("this\n  has\n  white\n  space"))
             }
+
+            it("should be able to enumerate children") {
+                expect(", ".join(xml["root"]["catalog"]["book"][0].children.map{ $0.element!.name })).to(equal("author, title, genre, price, publish_date, description"))
+            }
         }
 
         describe("white space parsing") {
@@ -131,4 +135,4 @@ class SWXMLHashTests: QuickSpec {
             }
         }
     }
-}
+}