Merge pull request #7 from igorkulman/code-cleanup

Code cleanup

Author: igorkulman

.swiftlint.yml

@@ -0,0 +1,84 @@
+included:
+    - LocalizationEditor
+
+disabled_rules:  
+    - line_length    
+    - force_try
+    - force_cast
+
+analyzer_rules:
+    - unused_import
+    - unused_private_declaration
+
+number_separator:
+    minimum_length: 7
+
+opt_in_rules:
+    - anyobject_protocol    
+    - closure_end_indentation
+    - closure_spacing
+    - collection_alignment
+    - contains_over_first_not_nil    
+    - empty_string
+    - empty_xctest_method
+    - explicit_init    
+    - fallthrough
+    - fatal_error_message        
+    - first_where
+    - identical_operands
+    - joined_default_parameter
+    - let_var_whitespace
+    - literal_expression_end_indentation
+    - lower_acl_than_parent
+    - nimble_operator
+    - number_separator
+    - object_literal
+    - operator_usage_whitespace
+    - overridden_super_call
+    - pattern_matching_keywords
+    - private_action
+    - private_outlet
+    - prohibited_interface_builder
+    - prohibited_super_call
+    - quick_discouraged_call
+    - quick_discouraged_focused_test
+    - quick_discouraged_pending_test
+    - redundant_nil_coalescing
+    - redundant_type_annotation
+    - single_test_class
+    - sorted_first_last
+    - sorted_imports
+    - static_operator    
+    - unneeded_parentheses_in_closure_argument    
+    - vertical_parameter_alignment_on_call
+    - yoda_condition    
+
+function_parameter_count:
+    warning: 8
+    error: 10
+
+large_tuple:
+    warning: 3
+custom_rules:
+    double_space: # from https://github.com/IBM-Swift/Package-Builder
+      include: "*.swift"
+      name: "Double space"
+      regex: '([a-z,A-Z] \s+)'
+      message: "Double space between keywords"
+      match_kinds: keyword
+      severity: warning
+    comments_space: # from https://github.com/brandenr/swiftlintconfig
+      name: "Space After Comment"
+      regex: '(^ *//\w+)'
+      message: "There should be a space after //"
+      severity: warning
+    empty_line_after_guard: # from https://github.com/brandenr/swiftlintconfig
+      name: "Empty Line After Guard"
+      regex: '(^ *guard[ a-zA-Z0-9=?.\(\),><!]*\{[ a-zA-Z0-9=?.\(\),><!]*\}\n *(?!(?:return|guard))\S+)'
+      message: "There should be an empty line after a guard"
+      severity: warning
+    unnecessary_type: # from https://github.com/brandenr/swiftlintconfig
+      name: "Unnecessary Type"
+      regex: '[ a-zA-Z0-9]*(?:let|var) [ a-zA-Z0-9]*: ([a-zA-Z0-9]*)[ ]*= \1'
+      message: "Type Definition Not Needed"
+      severity: warning

LocalizationEditor.xcodeproj/project.pbxproj

@@ -189,6 +189,7 @@
 			isa = PBXNativeTarget;
 			buildConfigurationList = F3D9C95220BEC7460081830A /* Build configuration list for PBXNativeTarget "LocalizationEditor" */;
 			buildPhases = (
+				F3BC11A421C40FAC001F396F /* SwiftLint */,
 				F3D9C93E20BEC7460081830A /* Sources */,
 				F3D9C93F20BEC7460081830A /* Frameworks */,
 				F3D9C94020BEC7460081830A /* Resources */,
@@ -253,6 +254,27 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		F3BC11A421C40FAC001F396F /* SwiftLint */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			name = SwiftLint;
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "if which swiftlint >/dev/null; then\nswiftlint\nelse\necho \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n";
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		F3D9C93E20BEC7460081830A /* Sources */ = {
 			isa = PBXSourcesBuildPhase;

LocalizationEditor/AppDelegate.swift

@@ -17,8 +17,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         setupLogging()
     }
 
-    func applicationWillTerminate(_: Notification) {
-    }
+    func applicationWillTerminate(_: Notification) {}
 
     private func setupLogging() {
         var configs = [LogConfiguration]()

LocalizationEditor/Models/Localization.swift

@@ -8,6 +8,9 @@
 
 import Foundation
 
+/**
+Complete localization for a single language. Represents a single strings file for a single language
+ */
 class Localization {
     let language: String
     let translations: [LocalizationString]
@@ -20,6 +23,8 @@ class Localization {
     }
 }
 
+// MARK: Description
+
 extension Localization: CustomStringConvertible {
     var description: String {
         return language.uppercased()

LocalizationEditor/Models/LocalizationGroup.swift

@@ -8,18 +8,23 @@
 
 import Foundation
 
+/**
+Group of localizations, like Localizabe.strings, InfoPlist.strings, etc.
+ */
 class LocalizationGroup {
     let name: String
     let path: String
-    let localizations : [Localization]
-    
+    let localizations: [Localization]
+
     init(name: String, localizations: [Localization], path: String) {
         self.name = name
         self.localizations = localizations
         self.path = path
     }
 }
 
+// MARK: Description
+
 extension LocalizationGroup: CustomStringConvertible {
     var description: String {
         return name

LocalizationEditor/Models/LocalizationString.swift

@@ -8,6 +8,9 @@
 
 import Foundation
 
+/**
+ Class representing single localization string in form of key: "value"; as found in strings files
+ */
 class LocalizationString {
     let key: String
     private(set) var value: String
@@ -17,11 +20,18 @@ class LocalizationString {
         self.value = value
     }
 
+    /**
+     Updates the localization string with a new value
+
+     Parameter value: new value
+     */
     func update(value: String) {
         self.value = value
     }
 }
 
+// MARK: Description
+
 extension LocalizationString: CustomStringConvertible {
     var description: String {
         return "\(key) = \(value)"

LocalizationEditor/Providers/LocalizationProvider.swift

@@ -10,9 +10,54 @@ import CleanroomLogger
 import Files
 import Foundation
 
+/**
+Service for working with the strings files
+ */
 class LocalizationProvider {
+    /**
+     List of folder that should be ignored when searching for localization files
+     */
     private let ignoredDirectories = ["Pods", "Carthage", "build", ".framework"]
-    
+
+    // MARK: Actions
+
+    /**
+     Updates given localization values in given localization file. Basially regenerates the whole localization files changing the given value
+
+     - Parameter localization: localization to update
+     - Parameter string: localization string
+     - Parameter value: new value for the localization string
+     */
+    func updateLocalization(localization: Localization, string: LocalizationString, with value: String) {
+        guard string.value != value else {
+            Log.debug?.message("Same value provided for \(string)")
+            return
+        }
+
+        Log.debug?.message("Updating \(string) with \(value) in \(localization)")
+
+        string.update(value: value)
+
+        let data = localization.translations.map { string in
+            "\"\(string.key)\" = \"\(string.value.replacingOccurrences(of: "\"", with: "\\\""))\";"
+        }.reduce("") { prev, next in
+                "\(prev)\n\(next)"
+        }
+
+        do {
+            try data.write(toFile: localization.path, atomically: false, encoding: .utf8)
+            Log.debug?.message("Localization file for \(localization) updated")
+        } catch {
+            Log.error?.message("Writing localization file for \(localization) failed with \(error)")
+        }
+    }
+
+    /**
+     Finds and constructs localiations for given directory path
+
+     - Parameter url: diretcory URL to start the search
+     - Returns: list of localization groups
+     */
     func getLocalizations(url: URL) -> [LocalizationGroup] {
         Log.debug?.message("Searching \(url) for Localizable.strings")
 
@@ -21,61 +66,45 @@ class LocalizationProvider {
         }
 
         let localizationFiles = Dictionary(grouping: folder.makeFileSequence(recursive: true).filter { file in
-            return file.name.hasSuffix(".strings") && ignoredDirectories.map({file.path.contains("\($0)/")}).filter({$0}).count == 0
-        }, by: {$0.path.components(separatedBy:"/").filter({!$0.hasSuffix(".lproj")}).joined(separator:"/")})
-        
-        Log.debug?.message("Found \(localizationFiles) localization files")
-        
-        return localizationFiles.map({ (path, files) in
+            file.name.hasSuffix(".strings") && ignoredDirectories.map({ file.path.contains("\($0)/") }).filter({ $0 }).count == 0
+        }, by: { $0.path.components(separatedBy: "/").filter({ !$0.hasSuffix(".lproj") }).joined(separator: "/") })
+
+        Log.debug?.message("Found \(localizationFiles.count) localization files")
+
+        return localizationFiles.map({ path, files in
             let name = URL(fileURLWithPath: path).lastPathComponent
             return LocalizationGroup(name: name, localizations: files.map({ file in
                 let parts = file.path.split(separator: "/")
                 let lang = String(parts[parts.count - 2]).replacingOccurrences(of: ".lproj", with: "")
                 return Localization(language: lang, translations: getLocalizationStrings(path: file.path), path: file.path)
             }), path: path)
-        }).sorted(by: {$0.name < $1.name})
+        }).sorted(by: { $0.name < $1.name })
     }
 
+    // MARK: Internal implementation
+
+    /**
+     Reads given strings file and constructs an array of localization strings from it
+
+     - Parameter path: strings file path
+     - Returns: array of localization strings
+     */
     private func getLocalizationStrings(path: String) -> [LocalizationString] {
         guard let dict = NSDictionary(contentsOfFile: path) as? [String: String] else {
             Log.error?.message("Could not parse \(path) as dictionary")
             return []
         }
 
-        var strings: [LocalizationString] = []
+        var localizationStrings: [LocalizationString] = []
         for (key, value) in dict {
-            let s = LocalizationString(key: key, value: value)
-            strings.append(s)
+            let localizationString = LocalizationString(key: key, value: value)
+            localizationStrings.append(localizationString)
         }
 
-        Log.debug?.message("Found \(strings.count) keys for in \(path)")
+        Log.debug?.message("Found \(localizationStrings.count) keys for in \(path)")
 
-        return strings.sorted(by: { (lhs, rhs) -> Bool in
+        return localizationStrings.sorted(by: { lhs, rhs -> Bool in
             lhs.key < rhs.key
         })
     }
-
-    func updateLocalization(localization: Localization, string: LocalizationString, with value: String) {
-        guard string.value != value else {
-            Log.debug?.message("Same value provided for \(string)")
-            return
-        }
-
-        Log.debug?.message("Updating \(string) with \(value) in \(localization)")
-
-        string.update(value: value)
-
-        let data = localization.translations.map { string in
-            "\"\(string.key)\" = \"\(string.value.replacingOccurrences(of: "\"", with: "\\\""))\";"
-        }.reduce("") { prev, next in
-            "\(prev)\n\(next)"
-        }
-
-        do {
-            try data.write(toFile: localization.path, atomically: false, encoding: .utf8)
-            Log.debug?.message("Localization file for \(localization) updated")
-        } catch {
-            Log.error?.message("Writing localization file for \(localization) failed with \(error)")
-        }
-    }
 }