Merge pull request #58 from 3sidedcube/feature/designable_migration_tool

Feature/designable migration tool

Author: simonmitchell

IBMigrationTool/IBMigrationTool

@@ -0,0 +1,101 @@
+//
+//  InterfaceBuilderFileMigrator.swift
+//  ThunderBasics
+//
+//  Created by Simon Mitchell on 18/09/2020.
+//  Copyright © 2020 threesidedcube. All rights reserved.
+//
+
+import Foundation
+
+/// A class responsible for migrating an Interface Builder to fix issues
+/// when upgrading to `ThunderBasics` v2.0.0
+final class InterfaceBuilderFileMigrator {
+    
+    static let directlyMappableAttributes: [(String, String)] = [
+        ("color", "borderColor"),
+        ("number", "borderWidth"),
+        ("number", "cornerRadius"),
+        ("color", "shadowColor"),
+        ("number", "shadowOpacity"),
+        ("number", "shadowRadius")
+    ]
+    
+    static let removedCustomClasses: [String] = [
+        "TSCTextView",
+        "TSCView",
+        "TSCImageView"
+    ]
+    
+    /// Represents the current contents of the interface builder file
+    ///
+    /// - Note: This will be changed by calling the `migrate` function to
+    /// represent the fixed version of the file!
+    var string: String
+    
+    convenience init?(filePath: String) {
+        let fileURL = URL(fileURLWithPath: filePath)
+        guard let data = try? Data(contentsOf: fileURL) else {
+            return nil
+        }
+        guard let fileString = String(data: data, encoding: .utf8) else {
+            return nil
+        }
+        self.init(string: fileString)
+    }
+    
+    init(string: String) {
+        self.string = string
+    }
+    
+    /// Performs migration of the current file, storing the result in `string`
+    func migrate() {
+        migrateUserDefinedRuntimeAttributes()
+        migrateRemovedCustomClasses()
+    }
+    
+    private func migrateRemovedCustomClasses() {
+        
+        Self.removedCustomClasses.forEach { (customClass) in
+            
+            // Have to catch all of this in one redux as could appear in either order but if we do one check before the other
+            // we may miss/break other cases!
+            //
+            // check for customModule="ThunderBasics" ... "customClass"=customClass || "customClass"=customClass ... customModule="ThunderBasics"
+            string = string.replacingOccurrences(
+                of: "(customModule=\"ThunderBasics\"([^>]*))?\\s*customClass=\"\(customClass)\"\\s*(([^>]*)customModule=\"ThunderBasics\")?",
+                with: "$2$4", // We will only either have $2 or $4 so we don't need a space between them!
+                options: .regularExpression,
+                range: nil
+            )
+        }
+    }
+    
+    private func migrateUserDefinedRuntimeAttributes() {
+        
+        // These use the same type as `CALayer` equivalents, so can be
+        // mapped simply using the same regex
+        Self.directlyMappableAttributes.forEach { (attribute)  in
+                    
+            string = string.replacingOccurrences(
+                of: "<userDefinedRuntimeAttribute(\\s+)type=\"\(attribute.0)\"(\\s+)keyPath=\"(\(attribute.1))\">",
+                with: "<userDefinedRuntimeAttribute$1type=\"\(attribute.0)\"$2keyPath=\"layer.$3\">",
+                options: .regularExpression,
+                range: nil
+            )
+        }
+        
+        // shadowOffset is a bit more complex because we used `CGPoint` but
+        // `CALayer` uses `CGSize`
+        
+        // Note this regex isn't perfect as it allows for x,y to take the form 1.2.1.3.1.2 e.t.c
+        // however this should be impossible to enter in Interface Builder and it makes replacing it
+        // far simpler so we will leave be for now!
+        string = string.replacingOccurrences(
+            of: "<userDefinedRuntimeAttribute(\\s+)type=\"point\"(\\s+)keyPath=\"shadowOffset\">(\\s+)(<point(\\s)+key=\"value\"(\\s)+x=\"([.\\d]+)\"(\\s+)y=\"([.\\d]+)\"\\/>)",
+            with: "<userDefinedRuntimeAttribute$1type=\"size\"$2keyPath=\"layer.shadowOffset\">$3<size$5key=\"value\"$6width=\"$7\"$8height=\"$9\"\\/>",
+            options: .regularExpression,
+            range: nil
+        )
+    }
+}

IBMigrationTool/InterfaceBuilderFileMigrator.swift

@@ -0,0 +1,75 @@
+//
+//  main.swift
+//  IBMigrationTool
+//
+//  Created by Simon Mitchell on 17/09/2020.
+//  Copyright © 2020 threesidedcube. All rights reserved.
+//
+
+import Foundation
+
+extension FileManager {
+    
+    /// Recurses the given directory for files with a given extension
+    /// - Parameters:
+    ///   - type: The extension to find files for
+    ///   - directory: The directory to search in
+    /// - Returns: An array of file paths
+    func recursivePathsForResource(_ type: String?, directory: String) -> [String] {
+        
+        var filePaths: [String] = []
+        let fileEnumerator = enumerator(atPath: directory)
+        
+        while let element = fileEnumerator?.nextObject() as? NSString {
+            
+            if type == nil || element.pathExtension == type {
+                filePaths.append(directory + "/" + (element as String))
+            }
+        }
+        
+        return filePaths
+    }
+}
+
+/// Converts all `UIView+Displayable` runtime attributes to use the
+/// `CALayer` equivalents in the file at the given path
+/// - Parameter path: The file path to convert
+func migrateUserDefinedRuntimeAttributesInInterfaceBuilderFile(at path: String) {
+    
+    print("Migrating user defined runtime attributes in \(path)")
+    
+    guard let migrator = InterfaceBuilderFileMigrator(filePath: path) else {
+        print("Failed to read data as string from: \(path)")
+        return
+    }
+    migrator.migrate()
+    
+    // Save file to disk!
+    let newData = migrator.string.data(using: .utf8)
+    do {
+        let fileURL = URL(fileURLWithPath: path)
+        try newData?.write(to: fileURL)
+        print("Wrote migrated file to \(path)")
+    } catch {
+        print("Failed to write migrated file to \(path)")
+    }
+}
+
+print("This tool will make changes to the Interface Builder (.xib/.storyboard) files in the chosen directory. Please make sure you have no changes in your index before continuing")
+print("Please enter the file path to the Project you want to migrate Interface Builder files to ThunderBasics 2.0.0")
+var filePath = readLine(strippingNewline: true)
+while filePath == nil {
+    filePath = readLine(strippingNewline: true)
+}
+
+filePath = filePath?.trimmingCharacters(in: .whitespaces).replacingOccurrences(of: "\\ ", with: " ")
+print("Parsing contents of \(filePath!) for IB Files")
+
+FileManager.default.recursivePathsForResource("xib", directory: filePath!).forEach { (xibPath) in
+    migrateUserDefinedRuntimeAttributesInInterfaceBuilderFile(at: xibPath)
+}
+
+FileManager.default.recursivePathsForResource("storyboard", directory: filePath!).forEach { (storyboardPath) in
+    migrateUserDefinedRuntimeAttributesInInterfaceBuilderFile(at: storyboardPath)
+}
+

IBMigrationTool/main.swift

@@ -0,0 +1,50 @@
+//
+//  IBMigrationToolTests.swift
+//  IBMigrationToolTests
+//
+//  Created by Simon Mitchell on 18/09/2020.
+//  Copyright © 2020 threesidedcube. All rights reserved.
+//
+
+import XCTest
+
+class IBMigrationToolTests: XCTestCase {
+
+    override func setUpWithError() throws {
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+
+    override func tearDownWithError() throws {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+    }
+
+    func testStoryboardFileMigratesCorrectly() {
+        
+        // May not be .storyboard (Can't include iOS storyboard in macOS test target), but the contents are the same!
+        guard let initialPath = Bundle.init(for: IBMigrationToolTests.self).url(forResource: "TestStoryboard", withExtension: "xml") else {
+            XCTFail("Missing TestStoryboard.xml in test target!")
+            return
+        }
+        guard let finalPath = Bundle.init(for: IBMigrationToolTests.self).url(forResource: "TestStoryboard-Migrated", withExtension: "xml") else {
+            XCTFail("Missing TestStoryboard-Migrated in test target!")
+            return
+        }
+        guard let finalString = try? String(contentsOf: finalPath) else {
+            XCTFail("Failed to read TestStoryboard-Migrated as string!")
+            return
+        }
+        let migrator = InterfaceBuilderFileMigrator(filePath: initialPath.path)
+        
+        XCTAssertNotNil(migrator)
+        
+        guard let fileMigrator = migrator else { return }
+        
+        fileMigrator.migrate()
+                
+        // Remove whitespace when comparing because it's irrelevant and seems to cause issues when comparing!
+        XCTAssertEqual(
+            fileMigrator.string.replacingOccurrences(of: "\\s", with: "", options: .regularExpression, range: nil),
+            finalString.replacingOccurrences(of: "\\s", with: "", options: .regularExpression, range: nil)
+        )
+    }
+}

IBMigrationToolTests/IBMigrationToolTests.swift

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>