Merge pull request #36 from wordpress-mobile/feature/35-expose-login-text

Add the ability to override text displayed to the user

Author: mindgraffiti

WordPressAuthenticator.xcodeproj/project.pbxproj

@@ -96,6 +96,8 @@
 		B5ED791D207E993E00A8FD8C /* WPAuthenticatorLogging.h in Headers */ = {isa = PBXBuildFile; fileRef = B5ED7918207E993E00A8FD8C /* WPAuthenticatorLogging.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		B5ED791F207E993E00A8FD8C /* CocoaLumberjack.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5ED791A207E993E00A8FD8C /* CocoaLumberjack.swift */; };
 		B5ED7920207E993E00A8FD8C /* WPAuthenticatorLogging.m in Sources */ = {isa = PBXBuildFile; fileRef = B5ED791B207E993E00A8FD8C /* WPAuthenticatorLogging.m */; };
+		CE16177521B6D82200B82A47 /* WordPressAuthenticatorDisplayStrings.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE16177421B6D82200B82A47 /* WordPressAuthenticatorDisplayStrings.swift */; };
+		CE16177821B70C1A00B82A47 /* WordPressAuthenticatorDisplayTextTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE16177721B70C1A00B82A47 /* WordPressAuthenticatorDisplayTextTests.swift */; };
 		CE1B18C920EEC2C200BECC3F /* SocialService.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE1B18C820EEC2C200BECC3F /* SocialService.swift */; };
 		CE1B18CC20EEC32400BECC3F /* WordPressCredentials.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE1B18CB20EEC32400BECC3F /* WordPressCredentials.swift */; };
 		CE1B18CE20EEC3CB00BECC3F /* WordPressAuthenticatorDelegateProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE1B18CD20EEC3CB00BECC3F /* WordPressAuthenticatorDelegateProtocol.swift */; };
@@ -234,6 +236,8 @@
 		B5ED791A207E993E00A8FD8C /* CocoaLumberjack.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CocoaLumberjack.swift; sourceTree = "<group>"; };
 		B5ED791B207E993E00A8FD8C /* WPAuthenticatorLogging.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = WPAuthenticatorLogging.m; sourceTree = "<group>"; };
 		C736FF243DE333FCAB1C2614 /* Pods_WordPressAuthenticator.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_WordPressAuthenticator.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		CE16177421B6D82200B82A47 /* WordPressAuthenticatorDisplayStrings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressAuthenticatorDisplayStrings.swift; sourceTree = "<group>"; };
+		CE16177721B70C1A00B82A47 /* WordPressAuthenticatorDisplayTextTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressAuthenticatorDisplayTextTests.swift; sourceTree = "<group>"; };
 		CE1B18C820EEC2C200BECC3F /* SocialService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SocialService.swift; sourceTree = "<group>"; };
 		CE1B18CB20EEC32400BECC3F /* WordPressCredentials.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressCredentials.swift; sourceTree = "<group>"; };
 		CE1B18CD20EEC3CB00BECC3F /* WordPressAuthenticatorDelegateProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressAuthenticatorDelegateProtocol.swift; sourceTree = "<group>"; };
@@ -291,6 +295,7 @@
 			isa = PBXGroup;
 			children = (
 				B501C03E208FC52500D1E58F /* WordPressAuthenticatorTests.swift */,
+				CE16177721B70C1A00B82A47 /* WordPressAuthenticatorDisplayTextTests.swift */,
 			);
 			path = Authenticator;
 			sourceTree = "<group>";
@@ -401,6 +406,7 @@
 				B56090F6208A533200399AE4 /* WordPressSupportSourceTag.swift */,
 				CE1B18CF20EEC41600BECC3F /* WordPressAuthenticatorConfiguration.swift */,
 				CE1B18D120EEC44400BECC3F /* WordPressAuthenticatorStyles.swift */,
+				CE16177421B6D82200B82A47 /* WordPressAuthenticatorDisplayStrings.swift */,
 			);
 			path = Authenticator;
 			sourceTree = "<group>";
@@ -841,6 +847,7 @@
 				CE1B18D020EEC41600BECC3F /* WordPressAuthenticatorConfiguration.swift in Sources */,
 				CE1B18D220EEC44400BECC3F /* WordPressAuthenticatorStyles.swift in Sources */,
 				B56090F0208A527000399AE4 /* FancyAlertViewController+LoginError.swift in Sources */,
+				CE16177521B6D82200B82A47 /* WordPressAuthenticatorDisplayStrings.swift in Sources */,
 				CE1B18CE20EEC3CB00BECC3F /* WordPressAuthenticatorDelegateProtocol.swift in Sources */,
 				B5609110208A54F800399AE4 /* OnePasswordFacade.swift in Sources */,
 				B5609109208A54F800399AE4 /* SignupService.swift in Sources */,
@@ -879,6 +886,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				B501C045208FC68700D1E58F /* LoginFieldsValidationTests.swift in Sources */,
+				CE16177821B70C1A00B82A47 /* WordPressAuthenticatorDisplayTextTests.swift in Sources */,
 				B501C048208FC79C00D1E58F /* LoginFacadeTests.m in Sources */,
 				B501C046208FC6A700D1E58F /* WordPressAuthenticatorTests.swift in Sources */,
 			);

WordPressAuthenticator/Authenticator/WordPressAuthenticator.swift

@@ -36,6 +36,10 @@ import WordPressUI
     ///
     public let style: WordPressAuthenticatorStyle
 
+    /// Authenticator's Display Texts.
+    ///
+    public let displayStrings: WordPressAuthenticatorDisplayStrings
+
     /// Notification to be posted whenever the signing flow completes.
     ///
     @objc public static let WPSigninDidFinishNotification = "WPSigninDidFinishNotification"
@@ -55,19 +59,24 @@ import WordPressUI
 
     /// Designated Initializer
     ///
-    private init(configuration: WordPressAuthenticatorConfiguration, style: WordPressAuthenticatorStyle) {
+    private init(configuration: WordPressAuthenticatorConfiguration,
+                 style: WordPressAuthenticatorStyle,
+                 displayStrings: WordPressAuthenticatorDisplayStrings) {
         self.configuration = configuration
         self.style = style
+        self.displayStrings = displayStrings
     }
 
     /// Initializes the WordPressAuthenticator with the specified Configuration.
     ///
-    public static func initialize(configuration: WordPressAuthenticatorConfiguration, style: WordPressAuthenticatorStyle = .defaultStyle) {
+    public static func initialize(configuration: WordPressAuthenticatorConfiguration,
+                                  style: WordPressAuthenticatorStyle = .defaultStyle,
+                                  displayStrings: WordPressAuthenticatorDisplayStrings = .defaultStrings) {
         guard privateInstance == nil else {
             fatalError("WordPressAuthenticator is already initialized")
         }
 
-        privateInstance = WordPressAuthenticator(configuration: configuration, style: style)
+        privateInstance = WordPressAuthenticator(configuration: configuration, style: style, displayStrings: displayStrings)
     }
 
     // MARK: - Public Methods

WordPressAuthenticator/Authenticator/WordPressAuthenticatorDisplayStrings.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+
+// MARK: - WordPress Authenticator Display Strings
+//
+public struct WordPressAuthenticatorDisplayStrings {
+    /// Strings: Login instructions.
+    ///
+    public let emailLoginInstructions: String
+
+    public let jetpackLoginInstructions: String
+
+    public let siteLoginInstructions: String
+
+    /// Designated initializer.
+    ///
+    public init(emailLoginInstructions: String, jetpackLoginInstructions: String, siteLoginInstructions: String) {
+        self.emailLoginInstructions = emailLoginInstructions
+        self.jetpackLoginInstructions = jetpackLoginInstructions
+        self.siteLoginInstructions = siteLoginInstructions
+    }
+}
+
+public extension WordPressAuthenticatorDisplayStrings {
+    public static var defaultStrings: WordPressAuthenticatorDisplayStrings {
+        return WordPressAuthenticatorDisplayStrings(emailLoginInstructions: NSLocalizedString("Log in to WordPress.com using an email address to manage all your WordPress sites.", comment: "Instruction text on the login's email address screen."),
+                                                 jetpackLoginInstructions: NSLocalizedString("Log in to the WordPress.com account you used to connect Jetpack.", comment: "Instruction text on the login's email address screen."),
+                                                 siteLoginInstructions: NSLocalizedString("Enter the address of your WordPress site you'd like to connect.", comment: "Instruction text on the login's site addresss screen."))
+    }
+}

WordPressAuthenticator/Signin/LoginEmailViewController.swift

@@ -101,9 +101,9 @@ open class LoginEmailViewController: LoginViewController, NUXKeyboardResponder {
     ///
     func localizeControls() {
         if loginFields.meta.jetpackLogin {
-            instructionLabel?.text = NSLocalizedString("Log in to the WordPress.com account you used to connect Jetpack.", comment: "Instruction text on the login's email address screen.")
+            instructionLabel?.text = WordPressAuthenticator.shared.displayStrings.jetpackLoginInstructions
         } else {
-            instructionLabel?.text = NSLocalizedString("Log in to WordPress.com using an email address to manage all your WordPress sites.", comment: "Instruction text on the login's email address screen.")
+            instructionLabel?.text = WordPressAuthenticator.shared.displayStrings.emailLoginInstructions
         }
         emailTextField.placeholder = NSLocalizedString("Email address", comment: "Placeholder for a textfield. The user may enter their email address.")
         emailTextField.accessibilityIdentifier = "Email address"

WordPressAuthenticator/Signin/LoginSiteAddressViewController.swift

@@ -67,7 +67,7 @@ class LoginSiteAddressViewController: LoginViewController, NUXKeyboardResponder
     /// Assigns localized strings to various UIControl defined in the storyboard.
     ///
     @objc func localizeControls() {
-        instructionLabel?.text = NSLocalizedString("Enter the address of your WordPress site you'd like to connect.", comment: "Instruction text on the login's site addresss screen.")
+        instructionLabel?.text = WordPressAuthenticator.shared.displayStrings.siteLoginInstructions
 
         siteURLField.placeholder = NSLocalizedString("example.wordpress.com", comment: "Site Address placeholder")
 

WordPressAuthenticatorTests/Authenticator/WordPressAuthenticatorDisplayTextTests.swift

@@ -0,0 +1,24 @@
+import XCTest
+@testable import WordPressAuthenticator
+
+// MARK: - WordPressAuthenticator Display Text Unit Tests
+//
+class WordPressAuthenticatorDisplayTextTests: XCTestCase {
+    /// Default display text instance
+    ///
+    let displayTextDefaults = WordPressAuthenticatorDisplayStrings.defaultText
+
+    /// Verifies that values in defaultText are not nil
+    ///
+    func testThatDefaultTextValuesAreNotNil() {
+        XCTAssertNotNil(displayTextDefaults.emailLoginInstructions)
+        XCTAssertNotNil(displayTextDefaults.siteLoginInstructions)
+    }
+
+    /// Verifies that values in defaultText are not empty strings
+    ///
+    func testThatDefaultTextValuesAreNotEmpty() {
+        XCTAssertFalse(displayTextDefaults.emailLoginInstructions.isEmpty)
+        XCTAssertFalse(displayTextDefaults.siteLoginInstructions.isEmpty)
+    }
+}