CoreStore/Sources/Migrating/MigrationResult.swift

//
//  MigrationResult.swift
//  CoreStore
//
//  Copyright © 2015 John Rommel Estropia
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in all
//  copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//  SOFTWARE.
//

import Foundation


// MARK: - MigrationResult

/**
 The `MigrationResult` indicates the result of a migration.
 The `MigrationResult` can be treated as a boolean:
 ```
 CoreStore.upgradeSQLiteStoreIfNeeded { transaction in
     // ...
     let result = transaction.commit()
     if result {
         // succeeded
     }
     else {
         // failed
     }
 }
 ```
 or as an `enum`, where the resulting associated object can also be inspected:
 ```
 CoreStore.beginAsynchronous { transaction in
     // ...
     let result = transaction.commit()
     switch result {
     case .Success(let hasChanges):
         // hasChanges indicates if there were changes or not
     case .Failure(let error):
         // error is a CoreStoreError enum value
     }
 }
 ```
 */
public enum MigrationResult {
    
    /**
     `MigrationResult.Success` indicates either the migration succeeded, or there were no migrations needed. The associated value is an array of `MigrationType`s reflecting the migration steps completed.
     */
    case Success([MigrationType])
    
    /**
     `SaveResult.Failure` indicates that the migration failed. The associated object for this value is the a `CoreStoreError` enum value.
     */
    case Failure(CoreStoreError)
    
    
    // MARK: Internal
    
    internal init(_ migrationTypes: [MigrationType]) {
        
        self = .Success(migrationTypes)
    }
    
    internal init(_ error: CoreStoreError) {
        
        self = .Failure(error)
    }
    
    internal init(_ error: ErrorType) {
        
        self = .Failure(CoreStoreError(error))
    }
}


// MARK: - MigrationResult: BooleanType

extension MigrationResult: BooleanType {
    
    public var boolValue: Bool {
        
        switch self {
            
        case .Success: return true
        case .Failure: return false
        }
    }
}