Migrate to SafeCollection

Author: devxoul

.travis.yml

@@ -3,13 +3,13 @@ language: objective-c
 sudo: required
 env:
   global:
-    - PROJECT="SafeIndex.xcodeproj"
-    - SCHEME="SafeIndex-Package"
+    - PROJECT="SafeCollection.xcodeproj"
+    - SCHEME="SafeCollection-Package"
     - IOS_SDK="iphonesimulator11.0"
     - MACOS_SDK="macosx10.13"
     - TVOS_SDK="appletvsimulator11.0"
     - WATCHOS_SDK="watchsimulator4.0"
-    - FRAMEWORK="SafeIndex"
+    - FRAMEWORK="SafeCollection"
   matrix:
     - SDK="$IOS_SDK"      TEST=1  DESTINATION="platform=iOS Simulator,name=iPhone 8,OS=11.0"
     - SDK="$MACOS_SDK"    TEST=1  DESTINATION="arch=x86_64"
@@ -46,5 +46,5 @@ script:
 
 after_success:
   - if [ $TEST == 1 ]; then
-      bash <(curl -s https://codecov.io/bash) -X xcodeplist -J 'SafeIndex';
+      bash <(curl -s https://codecov.io/bash) -X xcodeplist -J 'SafeCollection';
     fi

Package.swift

@@ -3,12 +3,12 @@
 import PackageDescription
 
 let package = Package(
-  name: "SafeIndex",
+  name: "SafeCollection",
   products: [
-    .library(name: "SafeIndex", targets: ["SafeIndex"]),
+    .library(name: "SafeCollection", targets: ["SafeCollection"]),
   ],
   targets: [
-    .target(name: "SafeIndex"),
-    .testTarget(name: "SafeIndexTests", dependencies: ["SafeIndex"]),
+    .target(name: "SafeCollection"),
+    .testTarget(name: "SafeCollectionTests", dependencies: ["SafeCollection"]),
   ]
 )

README.md

@@ -1,41 +1,37 @@
-SafeIndex
-=========
+# SafeCollection
 
 ![Swift](https://img.shields.io/badge/Swift-4.0-orange.svg)
-[![Build Status](https://travis-ci.org/devxoul/SafeIndex.svg)](https://travis-ci.org/devxoul/SafeIndex)
-[![CocoaPods](http://img.shields.io/cocoapods/v/SafeIndex.svg)](https://cocoapods.org/pods/SafeIndex)
+[![Build Status](https://travis-ci.org/devxoul/SafeCollection.svg)](https://travis-ci.org/devxoul/SafeCollection)
+[![CocoaPods](http://img.shields.io/cocoapods/v/SafeCollection.svg)](https://cocoapods.org/pods/SafeCollection)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 
-Optional Index for Swift.
+SafeCollection provides a safer way to deal with subscripts.
 
 
-At a Glance
------------
+## At a Glance
 
 ```swift
 let arr = ["A", "B", "C"]
 
 arr[0]    // "A"
 arr[100]  // fatal error: Array index out of range 😟
 
-arr[safe: 0]   // Optional("A")
-arr[safe: 100] // nil 😄
+arr.safe[0]   // Optional("A")
+arr.safe[100] // nil 😄
 ```
 
-
-Installation
-------------
+## Installation
 
 - **For iOS 8+ projects** with [CocoaPods](https://cocoapods.org):
 
     ```ruby
-    pod 'SafeIndex'
+    pod 'SafeCollection'
     ```
 
 - **For iOS 8+ projects** with [Carthage](https://github.com/Carthage/Carthage):
 
     ```
-    github "devxoul/SafeIndex"
+    github "devxoul/SafeCollection"
     ```
 
 - **Using [Swift Package Manager](https://swift.org/package-manager)**:
@@ -46,13 +42,11 @@ Installation
     let package = Package(
       name: "MyAwesomeApp",
       dependencies: [
-        .package(url: "https://github.com/devxoul/SafeIndex", "1.0.0"),
+        .package(url: "https://github.com/devxoul/SafeCollection", "1.0.0"),
       ]
     )
     ```
 
+## License
 
-License
--------
-
-SafeIndex is under MIT license. See the [LICENSE](LICENSE) file for more info.
+SafeCollection is under MIT license. See the [LICENSE](LICENSE) file for more info.

SafeIndex.podspec SafeCollection.podspecSafeIndex.podspec renamed to SafeCollection.podspec

@@ -1,11 +1,11 @@
 Pod::Spec.new do |s|
-  s.name             = "SafeIndex"
+  s.name             = "SafeCollection"
   s.version          = "2.0.0"
-  s.summary          = "Optional Index for Swift"
-  s.homepage         = "https://github.com/devxoul/SafeIndex"
+  s.summary          = "Safe Collection for Swift"
+  s.homepage         = "https://github.com/devxoul/SafeCollection"
   s.license          = { :type => "MIT", :file => "LICENSE" }
   s.author           = { "Suyeol Jeon" => "devxoul@gmail.com" }
-  s.source           = { :git => "https://github.com/devxoul/SafeIndex.git",
+  s.source           = { :git => "https://github.com/devxoul/SafeCollection.git",
                          :tag => s.version.to_s }
   s.source_files     = "Sources/**/*.swift"
   s.requires_arc     = true

Sources/SafeCollection/SafeCollection.swift

@@ -0,0 +1,75 @@
+public struct SafeCollection<C>: Collection where C: Collection {
+  public typealias Index = C.Index
+  public typealias Element = Optional<C.Element>
+
+  private var collection: C
+
+  init(_ collection: C) {
+    self.collection = collection
+  }
+
+  public subscript(position: Index) -> Element {
+    guard self.collection.indices.contains(position) else { return nil }
+    return self.collection[position]
+  }
+
+  public var startIndex: Index {
+    return self.collection.startIndex
+  }
+
+  public var endIndex: Index {
+    return self.collection.endIndex
+  }
+
+  public func index(after i: Index) -> Index {
+    return self.collection.index(after: i)
+  }
+}
+
+public struct SafeMutableCollection<C>: MutableCollection where C: MutableCollection {
+  public typealias Index = C.Index
+  public typealias Element = Optional<C.Element>
+
+  fileprivate var collection: C
+
+  init(_ collection: C) {
+    self.collection = collection
+  }
+
+  public subscript(position: Index) -> Element {
+    get {
+      guard self.collection.indices.contains(position) else { return nil }
+      return self.collection[position]
+    }
+    set {
+      guard let value = newValue else { return }
+      guard self.collection.indices.contains(position) else { return }
+      self.collection[position] = value
+    }
+  }
+
+  public var startIndex: Index {
+    return self.collection.startIndex
+  }
+
+  public var endIndex: Index {
+    return self.collection.endIndex
+  }
+
+  public func index(after i: Index) -> Index {
+    return self.collection.index(after: i)
+  }
+}
+
+public extension Collection {
+  public var safe: SafeCollection<Self> {
+    return .init(self)
+  }
+}
+
+public extension MutableCollection {
+  public var safe: SafeMutableCollection<Self> {
+    get { return .init(self) }
+    set { self = newValue.collection }
+  }
+}

Sources/SafeIndex/SafeIndex.swift

@@ -0,0 +1,20 @@
+import XCTest
+import SafeCollection
+
+class SafeCollectionTests: XCTestCase {
+  func testSafeCollection() {
+    let arr = ["A", "B", "C"]
+    XCTAssertEqual(arr.safe[0], "A")
+    XCTAssertEqual(arr.safe[1], "B")
+    XCTAssertEqual(arr.safe[2], "C")
+    XCTAssertNil(arr.safe[3])
+
+    var mutableArr = ["A", "B", "C"]
+    XCTAssertEqual(mutableArr.safe[0], "A")
+    XCTAssertEqual(mutableArr.safe[1], "B")
+    XCTAssertEqual(mutableArr.safe[2], "C")
+    XCTAssertNil(mutableArr.safe[3])
+    mutableArr.safe[2] = "D"
+    XCTAssertEqual(mutableArr.safe[2], "D")
+  }
+}