DKExtensions.swift

//
//  DKExtensions.swift
//  Kevin Delord
//
//  Created by kevin delord on 24/09/14.
//  Copyright (c) 2015 Kevin Delord. All rights reserved.
//

import Foundation
import CoreTelephony
import StoreKit

// MARK: - Debug

struct DKLogSettings {

    static var ShouldShowDetailedLogs   : Bool  = false
    static var DetailedLogFormat		= ">>> :line :className.:function --> :obj"
    static var DetailedLogDateFormat	= "yyyy-MM-dd HH:mm:ss.SSS"
	static private var dateFormatter	: NSDateFormatter {
		let formatter = NSDateFormatter()
		formatter.dateFormat = DKLogSettings.DetailedLogDateFormat
		return formatter
	}
}

func DKLog(verbose: Bool, _ obj: AnyObject = "", file: String = #file, function: String = #function, line: Int = #line) {
	#if DEBUG
        if (verbose == true) {
			if (DKLogSettings.ShouldShowDetailedLogs == true),
				let className = NSURL(string: file)?.lastPathComponent?.componentsSeparatedByString(".").first {

					var logStatement = DKLogSettings.DetailedLogFormat.stringByReplacingOccurrencesOfString(":line", withString: "\(line)")
					logStatement = logStatement.stringByReplacingOccurrencesOfString(":className", withString: className)
					logStatement = logStatement.stringByReplacingOccurrencesOfString(":function", withString: function)
					logStatement = logStatement.stringByReplacingOccurrencesOfString(":obj", withString: "\(obj)")

					if (logStatement.containsString(":date")) {
						let replacement = DKLogSettings.dateFormatter.stringFromDate(NSDate())
						logStatement = logStatement.stringByReplacingOccurrencesOfString(":date", withString: "\(replacement)")
					}

					print(logStatement)
			} else {
				print(obj)
			}
        }
	#endif
}

// MARK: - Classes

class PopToRootViewControllerSegue : UIStoryboardSegue {

    override func perform() {
        self.sourceViewController.navigationController?.popToRootViewControllerAnimated(true)
    }
}

class PopViewControllerSegue : UIStoryboardSegue {

    override func perform() {
        self.sourceViewController.navigationController?.popViewControllerAnimated(true)
    }
}

extension SKProduct {

    @available(*, deprecated=0.9, renamed="localizedPrice")
    func localisedPrice() -> String? {
        return self.localizedPrice()
    }

    func localizedPrice() -> String? {
        let numberFormatter = NSNumberFormatter()
        numberFormatter.formatterBehavior = NSNumberFormatterBehavior.BehaviorDefault
        numberFormatter.numberStyle = .CurrencyStyle
        numberFormatter.locale = self.priceLocale
        return numberFormatter.stringFromNumber(self.price)
    }
}

// MARK: - Additions

func += <KeyType, ValueType> (inout left: Dictionary<KeyType, ValueType>, right: Dictionary<KeyType, ValueType>) {
    for (k, v) in right {
        left.updateValue(v, forKey: k)
    }
}

func + <K, V>(left: Dictionary<K, V>, right: Dictionary<K, V>) -> Dictionary<K, V> {

    var map = Dictionary<K, V>()
    for (k, v) in left {
        map[k] = v
    }
    for (k, v) in right {
        map[k] = v
    }
    return map
}

// MARK: - Extensions

extension RawRepresentable where RawValue == Int {
	static var allCases: [Self] {
		// Create array to store all found cases
		var cases = [Self]()
		// Use 0 as start index
		var index = 0
		// Try to create a case for every following integer index until no case is created. If no one is created,
		while let _case = self.init(rawValue: index) {
			cases.append(_case)
			index += 1
		}
		return cases
	}
}

extension NSError {

    func log() {
        print("Error: \(self) \(self.userInfo)")
    }
}

extension UIView {

    func roundRect(radius radius: CGFloat) {
        self.layer.cornerRadius = radius
        self.layer.masksToBounds = true
    }

    /**
     Add a subview to the current object if the given one is not nil.

     - parameter view: Optional UIView object. Will not be added if nil.
     */
    func addSubview(safe view: UIView?) {
        if let _view = view {
            self.addSubview(_view)
        }
    }

    /**
     Moves the specified subview so that it appears on top of its siblings.

     - parameter view: Optional UIView object. Nothing happens if nil.
     */
    func bringSubviewToFront(safe view: UIView?) {
        if let _view = view {
            self.bringSubviewToFront(_view)
        }
    }

    /**
     Moves the specified subview so that it appears behind its siblings.

     - parameter view: Optional UIView object. Nothing happens if nil.
     */
    func sendSubviewToBack(safe view: UIView?) {
        if let _view = view {
            self.sendSubviewToBack(_view)
        }
    }
	/**
	Creates gradient view of given size with given colors
	This function already exist in the DKHelper, but does not work in Swift.
	The start point has to be -1.0 instead of 0.0 in Obj-C.

	- parameter rect:        The rect for the new gradient view.
	- parameter topColor:    The top color.
	- parameter bottomColor: the bottom color.

	- returns: gradient view
	*/
    class func gradientLayer(rect: CGRect, topColor: UIColor, bottomColor: UIColor) -> UIView {

        let gradientLayerView = UIView(frame: rect)
        let gradient = CAGradientLayer()
        gradient.frame = gradientLayerView.bounds
        gradient.colors = [topColor.CGColor, bottomColor.CGColor]
		gradient.startPoint = CGPoint(x: 0, y: -1.0)
		gradient.endPoint = CGPoint(x: 0, y: 1.0)
        gradientLayerView.layer.insertSublayer(gradient, atIndex: 0)
        return gradientLayerView
    }

}

@available(iOS, obsoleted=8.0, message="use UIAlertController instead.")
extension UIAlertView {

	@available(iOS, renamed="UIAlertController.showErrorPopup", message="use UIAlertController instead.")
	class func showErrorPopup(error: NSError?) {
		// Log error
		error?.log()
		// Find a valid message to display
		var msg : String? = nil
		if let errorMessage : String = error?.userInfo["error"] as? String {
			msg = errorMessage
		} else if let errorMessage = error?.localizedFailureReason {
			msg = errorMessage
		} else if let errorMessage = error?.localizedDescription where (errorMessage.characters.count > 0) {
			msg = errorMessage
		}
		// Show a popup
		if let _msg = msg {
			self.showErrorMessage(_msg)
		}
	}

	@available(iOS, renamed="UIAlertController.showErrorMessage", message="use UIAlertController instead.")
	class func showErrorMessage(message: String) {
		self.showInfoMessage("Error", message: message)
	}

	@available(iOS, renamed="UIAlertController.showInfoMessage", message="use UIAlertController instead.")
	class func showInfoMessage(title: String, message: String) {
		UIAlertView(title: title, message: message, delegate: nil, cancelButtonTitle: nil, otherButtonTitles: "OK").show()
	}
}

@available(iOS 8.0, *)
extension UIAlertController {
	class func showErrorPopup(error: NSError?, presentingViewController: UIViewController? = UIApplication.sharedApplication().windows.first?.rootViewController) {
		// Log error
		error?.log()
		// Find a valid message to display
		var msg : String? = nil
		if let errorMessage : String = error?.userInfo["error"] as? String {
			msg = errorMessage
		} else if let errorMessage = error?.localizedFailureReason {
			msg = errorMessage
		} else if let errorMessage = error?.localizedDescription where (errorMessage.characters.isEmpty == false) {
			msg = errorMessage
		}
		// Show a popup
		if let _msg = msg {
			self.showErrorMessage(_msg, presentingViewController: presentingViewController)
		}
	}

	class func showErrorMessage(message: String, presentingViewController: UIViewController? = UIApplication.sharedApplication().windows.first?.rootViewController) {
		self.showInfoMessage("Error", message: message, presentingViewController: presentingViewController)
	}

	class func showInfoMessage(title: String, message: String, presentingViewController: UIViewController? = UIApplication.sharedApplication().windows.first?.rootViewController) {
		let ac = UIAlertController(title: title, message: message, preferredStyle: .Alert)
		ac.addAction(UIAlertAction(title: "OK", style: .Default, handler: nil))
		presentingViewController?.presentViewController(ac, animated: true, completion: nil)
	}
}

extension String {

	/**
	* Return a dictionary containing the key/values of the received
	*/
	var urlArguments : [String : String] {
		var params = [String : String]()
		for param in self.componentsSeparatedByString("&") {
			let elts = param.componentsSeparatedByString("=")
			if (elts.count == 2),
				let
				key = elts.first,
				value = elts.last {
					params[key] = value
			}
		}
		return params
	}

    func isUserName() -> Bool {
        let regex = "[äÄüÜöÖßA-Z0-9a-z_\\s-]+"
        let predicate = NSPredicate(format: "SELF MATCHES %@", regex)
        return predicate.evaluateWithObject(self)
    }
}

extension Dictionary {

	mutating func removeValuesOfType<T>(type: T.Type) {
		let keysToRemove = Array(self.keys).filter {
            self[$0] is T
        }
		for key in keysToRemove {
			self.removeValueForKey(key)
		}
	}
}

extension Array where Element: Equatable {

	mutating func removeObject(item: Element) {
		if let index = self.indexOf(item) {
			self.removeAtIndex(index)
		}
	}
}

extension Array {

	var shuffled: [Element] {
		var elements = self
		for index in 0..<elements.count {
			let newIndex = Int(arc4random_uniform(UInt32(elements.count-index))) + index
			if (index != newIndex) { // Check if you are not trying to swap an element with itself
				swap(&elements[index], &elements[newIndex])
			}
		}
		return elements
	}

	mutating func shuffle() {
		self = self.shuffled
	}

	func groupOf(num:Int) -> [[Element]] {
		var result = [[Element]]()
		if (num > 0) {
			for i in 0...((count / num) - 1) {
				var tempArray = [Element]()
				for index in 0...(num - 1) {
					tempArray.append(self[index + ( i * num)])
				}
				result.append(tempArray)
			}
		}
		return result
	}

	/*
	* Bounds-checked ("safe") index lookup for Arrays.
	* Example usage:
	* let foo = [0,1,2][safe: 1]	|	foo = (Int?) 1
	* let bar = [0,1,2][safe: 10]	|	bar = (Int?) nil
	*/
	subscript (safe index: Int) -> Element? {
		return ((self.indices ~= index) ? self[index] : nil)
	}

	mutating func append(safe newElement: Element?) {
		if let element = newElement {
			self.append(element)
		}
	}
}

extension UIImagePickerControllerSourceType {

    func nameType() -> String {
        switch self {
        case .PhotoLibrary:
            return "PhotoLibrary"
        case .Camera:
            return "Camera"
        case .SavedPhotosAlbum:
            return "SavedPhotosAlbum"
        }
    }
}

extension UILabel {

    /**
     Calculates if size to fit would expand or shrink the label.

     Will not change the size of the label.

     - returns: true if the label Size is smaller than before
     */
	func textFitsWidth() -> Bool {
		let actualSize = self.frame.size
		self.sizeToFit()
		if (self.frame.size.width > actualSize.width) {
			self.frame.size = actualSize
			return false
		}
		self.frame.size = actualSize
		return true
	}

	/**
	Transforms the given text by replacing all characters with the passed replacement ("●" by default).

	- parameter secureText: Text to secure and to set to the current label
	- parameter replacementText: String to set as secure character (default is "●")
	*/
	func setSecureText(secureText: String?, replacementText: String = "●") {
		if let _secureText = secureText {
			var secureString = ""
			for _ in 0..<_secureText.characters.count {
				secureString += replacementText
			}
			self.text = secureString
		}
	}
}

extension UIDevice {

    /**
    To check if the current Device has a SimCard or not, we will read the Carrier informations
	If there are no carrier Informations, there is no sim and this function will return false

	For more informations read Apple Doc's for CTCarrier's mobileCountryCode:
	From this Doc:
    https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/index.html#//apple_ref/occ/instp/CTCarrier/mobileCountryCode

	The value for this property is nil if any of the following apply:
	- There is no SIM card in the device. [...]

     - returns: true if the current device has a SIM card.
     */
    func hasSimCard() -> Bool {
        return (CTTelephonyNetworkInfo().subscriberCellularProvider?.mobileCountryCode != nil)
    }
}

extension NSNumber {

    // Will return a String with the currency for the given Location
    // Can be used to display a Pricetag for an in App Product.
    // Take SKProduct.price for self
    // And SKProduct.priceLocale for locale.
    func stringWithCurrencyForNumber(locale:NSLocale) -> String? {
        let formatter = NSNumberFormatter()
        formatter.locale = locale
        formatter.maximumFractionDigits = 2
        formatter.minimumFractionDigits = 2
        formatter.alwaysShowsDecimalSeparator = true
        formatter.numberStyle = NSNumberFormatterStyle.CurrencyStyle

        return formatter.stringFromNumber(self)
    }
}

extension UIApplication {

	/// Boolean value indicating whether the current application is running on a simulator or not.
	static var isRunningOnSimulator : Bool {
		#if (arch(i386) || arch(x86_64)) && os(iOS)
			return true
		#else
			return false
		#endif
	}
}

extension Int {

	// Will return a random number between the given range:
	// E.g : let randomNumber = randoInt.randomNumber(4...8)
	static func randomNumber(range: Range<Int>) -> Int {
		let min = range.startIndex
		let max = range.endIndex
		return Int(arc4random_uniform(UInt32(max - min))) + min
	}
}

protocol OptionalType {
	associatedtype Wrapped
	@warn_unused_result
	func map<U>(@noescape f: (Wrapped) throws -> U) rethrows -> U?
}

extension Optional: OptionalType { }

extension SequenceType where Generator.Element: OptionalType {
	@warn_unused_result
	func withoutOptionals() -> [Generator.Element.Wrapped] {
		var result: [Generator.Element.Wrapped] = []
		for element in self {
			if let element = element.map({ $0 }) {
				result.append(element)
			}
		}
		return result
	}
}

extension NSURL {

	enum URLConstructionError: ErrorType {
		case UnableToConstruct
	}

	func addPath(path: String) -> NSURL {
		return self.URLByAppendingPathComponent(path)
	}

	func addParameters(parameter: [String: AnyObject]) throws -> NSURL {
		if let urlComponents = NSURLComponents(URL: self, resolvingAgainstBaseURL: false) {

			var queryItems = (urlComponents.queryItems ?? [NSURLQueryItem]())

			for (key, value) in parameter {
				queryItems.append(NSURLQueryItem(name: key, value: "\(value)"))
			}

			urlComponents.queryItems = queryItems

			if let url = urlComponents.URL {
				return url
			}
		}

		throw URLConstructionError.UnableToConstruct
	}

	/**
	Create a new `NSURL` by adding the given fragment.
 
	- parameter fragment	: The fragment as `String` which should be added.
	
	- returns				: The new `NSURL` with the added fragment.
	*/
	func addFragment(fragment: String) throws -> NSURL {
		// Get the `NSURLComponents` of this `NSURL` object
		if let urlComponents = NSURLComponents(URL: self, resolvingAgainstBaseURL: false) {
			// Add the fragment
			urlComponents.fragment = fragment
			// Create the new URL and return it
			if let url = urlComponents.URL {
				return url
			}
		}
		// Throw an error as the `NSURLComponents` couldn't be created
		throw URLConstructionError.UnableToConstruct
	}
}

extension NSObject {

	/**
	Returns a string containing information about all property names, data types and values.
	**/
	var autogeneratedDescription: String {
		let mirror = Mirror(reflecting: self)
		let properties = mirror.children.map() { (label: String?, value: Any) -> String in
			guard let label = label else {
				return "unknown (\(value.dynamicType)) = \(value)"
			}
			return "\(label) (\(value.dynamicType)) = \(value)"
		}
		return properties.joinWithSeparator("\n")
	}
}