Make [WebViewJavascriptBridge bridgeForWebView:] work for all web view types, including WKWebView. Fixes marcuswestin#252, marcuswestin#249.

marcuswestin · marcuswestin · commit f3d2aceb5bda · 2016-12-25T14:34:26.000-05:00
diff --git a/Example Apps/ExampleApp-OSX/AppDelegate.m b/Example Apps/ExampleApp-OSX/AppDelegate.m
@@ -9,13 +9,12 @@
 #import "AppDelegate.h"
 #import <WebKit/WebKit.h>
 #import "WebViewJavascriptBridge.h"
-#import "WKWebViewJavascriptBridge.h"
 
 @implementation AppDelegate {
     WebView* _webView;
     WKWebView *_WKWebView;
     WebViewJavascriptBridge* _bridge;
-    WKWebViewJavascriptBridge* _WKBridge;
+    WebViewJavascriptBridge* _WKBridge;
     NSView* _WKWebViewWrapper;
 }
 
@@ -63,7 +62,7 @@ - (void)_configureWebview {
 
 - (void)_configureWKWebview {
     // Create Bridge
-    _WKBridge = [WKWebViewJavascriptBridge bridgeForWebView:_WKWebView];
+    _WKBridge = [WebViewJavascriptBridge bridgeForWebView:_WKWebView];
     
     [_WKBridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
diff --git a/Example Apps/ExampleApp-iOS/ExampleWKWebViewController.m b/Example Apps/ExampleApp-iOS/ExampleWKWebViewController.m
@@ -7,11 +7,11 @@
 //
 
 #import "ExampleWKWebViewController.h"
-#import "WKWebViewJavascriptBridge.h"
+#import "WebViewJavascriptBridge.h"
 
 @interface ExampleWKWebViewController ()
 
-@property WKWebViewJavascriptBridge* bridge;
+@property WebViewJavascriptBridge* bridge;
 
 @end
 
@@ -23,8 +23,8 @@ - (void)viewWillAppear:(BOOL)animated {
     WKWebView* webView = [[NSClassFromString(@"WKWebView") alloc] initWithFrame:self.view.bounds];
     webView.navigationDelegate = self;
     [self.view addSubview:webView];
-    [WKWebViewJavascriptBridge enableLogging];
-    _bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView];
+    [WebViewJavascriptBridge enableLogging];
+    _bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
     [_bridge setWebViewDelegate:self];
     
     [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
diff --git a/Example Apps/ExampleApp.html b/Example Apps/ExampleApp.html
@@ -20,7 +20,7 @@ <h1>WebViewJavascriptBridge Demo</h1>
         window.WVJBCallbacks = [callback];
         var WVJBIframe = document.createElement('iframe');
         WVJBIframe.style.display = 'none';
-        WVJBIframe.src = 'http://__bridge_loaded__';
+        WVJBIframe.src = 'https://__bridge_loaded__';
         document.documentElement.appendChild(WVJBIframe);
         setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
     }
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ WebViewJavascriptBridge
 
 [![Build Status](https://travis-ci.org/marcuswestin/WebViewJavascriptBridge.svg)](https://travis-ci.org/marcuswestin/WebViewJavascriptBridge)
 
-An iOS/OSX bridge for sending messages between Obj-C and JavaScript in UIWebViews/WebViews.
+An iOS/OSX bridge for sending messages between Obj-C and JavaScript in WKWebViews, UIWebViews & WebViews.
 
 Who uses WebViewJavascriptBridge?
 ---------------------------------
@@ -62,7 +62,7 @@ Usage
 @property WebViewJavascriptBridge* bridge;
 ```
 
-2) Instantiate WebViewJavascriptBridge with a UIWebView (iOS) or WebView (OSX):
+2) Instantiate WebViewJavascriptBridge with a WKWebView, UIWebView (iOS) or WebView (OSX):
 
 ```objc
 self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
@@ -89,7 +89,7 @@ function setupWebViewJavascriptBridge(callback) {
 	window.WVJBCallbacks = [callback];
 	var WVJBIframe = document.createElement('iframe');
 	WVJBIframe.style.display = 'none';
-	WVJBIframe.src = 'http://__bridge_loaded__';
+	WVJBIframe.src = 'https://__bridge_loaded__';
 	document.documentElement.appendChild(WVJBIframe);
 	setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
 }
@@ -112,25 +112,6 @@ setupWebViewJavascriptBridge(function(bridge) {
 })
 ```
 
-WKWebView Support (iOS 8+ & OS 10.10+)
---------------------------------------
-
-(WARNING: WKWebView still has [bugs and missing network APIs.](https://github.com/ShingoFukuyama/WKWebViewTips/blob/master/README.md) It may not be a simple drop-in replacement).
-
-WebViewJavascriptBridge supports [WKWebView](http://nshipster.com/wkwebkit/) for iOS 8 and OSX Yosemite. In order to use WKWebView you need to instantiate the `WKWebViewJavascriptBridge`. The rest of the `WKWebViewJavascriptBridge` API is the same as `WebViewJavascriptBridge`.
-
-1) Import the header file:
-
-```objc
-#import "WKWebViewJavascriptBridge.h"
-```
-
-2) Instantiate WKWebViewJavascriptBridge and with a WKWebView object
-
-```objc
-WKWebViewJavascriptBridge* bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView];
-```
-
 Automatic reference counting (ARC)
 ----------------------------------
 This library relies on ARC, so if you use ARC in you project, all works fine.
@@ -155,7 +136,7 @@ API Reference
 
 ### ObjC API
 
-##### `[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview`
+##### `[WebViewJavascriptBridge bridgeForWebView:(WKWebVIew/UIWebView/WebView*)webview`
 
 Create a javascript bridge for the given web view.
 
@@ -195,9 +176,9 @@ Example:
 }];
 ```
 
-#### `[bridge setWebViewDelegate:(NSObject<UIWebViewDelegate> *)webViewDelegate]`
+#### `[bridge setWebViewDelegate:(id)webViewDelegate]`
 
-Optionally, set a `UIWebViewDelegate` if you need to respond to the [web view's lifecycle events](http://developer.apple.com/library/ios/documentation/uikit/reference/UIWebViewDelegate_Protocol/Reference/Reference.html).
+Optionally, set a `WKNavigationDelegate/UIWebViewDelegate` if you need to respond to the [web view's lifecycle events](https://developer.apple.com/reference/uikit/uiwebviewdelegate).
 
 ##### `[bridge disableJavscriptAlertBoxSafetyTimeout]`
 
diff --git a/Tests/WebViewJavascriptBridgeTests/BridgeTests.m b/Tests/WebViewJavascriptBridgeTests/BridgeTests.m
@@ -9,7 +9,6 @@
 #import <XCTest/XCTest.h>
 
 #import "WebViewJavascriptBridge.h"
-#import "WKWebViewJavascriptBridge.h"
 #import "AppDelegate.h"
 
 static NSString *const echoHandler = @"echoHandler";
@@ -21,8 +20,7 @@ @interface BridgeTests : XCTestCase
 @implementation BridgeTests {
     UIWebView *_uiWebView;
     WKWebView *_wkWebView;
-    WebViewJavascriptBridge* _uiWebViewBridge;
-    WKWebViewJavascriptBridge* _wkWebViewBridge;
+    NSMutableArray* _bridgeRefs;
 }
 
 - (void)setUp {
@@ -38,6 +36,8 @@ - (void)setUp {
     _wkWebView = [[WKWebView alloc] initWithFrame:frame];
     _wkWebView.backgroundColor = [UIColor redColor];
     [rootVC.view addSubview:_wkWebView];
+    
+    _bridgeRefs = [NSMutableArray array];
 }
 
 - (void)tearDown {
@@ -46,14 +46,10 @@ - (void)tearDown {
     [_wkWebView removeFromSuperview];
 }
 
-- (WebViewJavascriptBridge*)bridgeForCls:(Class)cls webView:(id)webView {
-    if (cls == [WebViewJavascriptBridge class]) {
-        _uiWebViewBridge = [WebViewJavascriptBridge bridgeForWebView:webView];
-        return _uiWebViewBridge;
-    } else {
-        _wkWebViewBridge = [WKWebViewJavascriptBridge bridgeForWebView:_wkWebView];
-        return (WebViewJavascriptBridge*) _wkWebViewBridge;
-    }
+- (WebViewJavascriptBridge*)bridgeForWebView:(id)webView {
+    WebViewJavascriptBridge* bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
+    [_bridgeRefs addObject:bridge];
+    return bridge;
 }
 
 static void loadEchoSample(id webView) {
@@ -64,13 +60,13 @@ static void loadEchoSample(id webView) {
 const NSTimeInterval timeoutSec = 100;
 
 - (void)testInitialization {
-    [self classSpecificTestInitialization:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestInitialization:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestInitialization:_uiWebView];
+    [self classSpecificTestInitialization:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestInitialization:(Class)cls webView:(id)webView {
+- (void)classSpecificTestInitialization:(id)webView {
     XCTestExpectation *startup = [self expectationWithDescription:@"Startup completed"];
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     [bridge registerHandler:@"Greet" handler:^(id data, WVJBResponseCallback responseCallback) {
         XCTAssertEqualObjects(data, @"Hello world");
         [startup fulfill];
@@ -81,12 +77,12 @@ - (void)classSpecificTestInitialization:(Class)cls webView:(id)webView {
 }
 
 - (void)testEchoHandler {
-    [self classSpecificTestEchoHandler:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestEchoHandler:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestEchoHandler:_uiWebView];
+    [self classSpecificTestEchoHandler:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestEchoHandler:(Class)cls webView:(id)webView {
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+- (void)classSpecificTestEchoHandler:(id)webView {
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     
     XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
     [bridge callHandler:echoHandler data:@"testEchoHandler" responseCallback:^(id responseData) {
@@ -98,12 +94,12 @@ - (void)classSpecificTestEchoHandler:(Class)cls webView:(id)webView {
 }
 
 - (void)testEchoHandlerAfterSetup {
-    [self classSpecificTestEchoHandlerAfterSetup:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestEchoHandlerAfterSetup:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestEchoHandlerAfterSetup:_uiWebView];
+    [self classSpecificTestEchoHandlerAfterSetup:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestEchoHandlerAfterSetup:(Class)cls webView:(id)webView {
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+- (void)classSpecificTestEchoHandlerAfterSetup:(id)webView {
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     
     XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
     loadEchoSample(webView);
@@ -116,12 +112,12 @@ - (void)classSpecificTestEchoHandlerAfterSetup:(Class)cls webView:(id)webView {
 }
 
 - (void)testObjectEncoding {
-    [self classSpecificTestObjectEncoding:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestObjectEncoding:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestObjectEncoding:_uiWebView];
+    [self classSpecificTestObjectEncoding:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestObjectEncoding:(Class)cls webView:(id)webView {
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+- (void)classSpecificTestObjectEncoding:(id)webView {
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     
     void (^echoObject)(id) = ^void(id object) {
         XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
@@ -140,12 +136,12 @@ - (void)classSpecificTestObjectEncoding:(Class)cls webView:(id)webView {
 }
 
 - (void)testJavascriptReceiveResponse {
-    [self classSpecificTestJavascriptReceiveResponse:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestJavascriptReceiveResponse:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestJavascriptReceiveResponse:_uiWebView];
+    [self classSpecificTestJavascriptReceiveResponse:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestJavascriptReceiveResponse:(Class)cls webView:(id)webView {
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+- (void)classSpecificTestJavascriptReceiveResponse:(id)webView {
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     loadEchoSample(webView);
     XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
     [bridge registerHandler:@"objcEchoToJs" handler:^(id data, WVJBResponseCallback responseCallback) {
@@ -158,12 +154,12 @@ - (void)classSpecificTestJavascriptReceiveResponse:(Class)cls webView:(id)webVie
 }
 
 - (void)testJavascriptReceiveResponseWithoutSafetyTimeout {
-    [self classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:[WebViewJavascriptBridge class] webView:_uiWebView];
-    [self classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:[WKWebViewJavascriptBridge class] webView:_wkWebView];
+    [self classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:_uiWebView];
+    [self classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:_wkWebView];
     [self waitForExpectationsWithTimeout:timeoutSec handler:NULL];
 }
-- (void)classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:(Class)cls webView:(id)webView {
-    WebViewJavascriptBridge *bridge = [self bridgeForCls:cls webView:webView];
+- (void)classSpecificTestJavascriptReceiveResponseWithoutSafetyTimeout:(id)webView {
+    WebViewJavascriptBridge *bridge = [self bridgeForWebView:webView];
     [bridge disableJavscriptAlertBoxSafetyTimeout];
     loadEchoSample(webView);
     XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
diff --git a/WebViewJavascriptBridge.podspec b/WebViewJavascriptBridge.podspec
@@ -12,6 +12,6 @@ Pod::Spec.new do |s|
   s.osx.source_files = 'WebViewJavascriptBridge/*.{h,m}'
   s.ios.private_header_files = 'WebViewJavascriptBridge/WebViewJavascriptBridge_JS.h'
   s.osx.private_header_files = 'WebViewJavascriptBridge/WebViewJavascriptBridge_JS.h'
+  s.framework        = 'WebKit'
   s.ios.framework    = 'UIKit'
-  s.osx.framework    = 'WebKit'
 end
diff --git a/WebViewJavascriptBridge/WKWebViewJavascriptBridge.h b/WebViewJavascriptBridge/WKWebViewJavascriptBridge.h
@@ -6,10 +6,10 @@
 //
 
 #if (__MAC_OS_X_VERSION_MAX_ALLOWED > __MAC_10_9 || __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_7_1)
-#define supportsWKWebKit
+#define supportsWKWebView
 #endif
 
-#if defined(supportsWKWebKit )
+#if defined supportsWKWebView
 
 #import <Foundation/Foundation.h>
 #import "WebViewJavascriptBridgeBase.h"
@@ -25,7 +25,7 @@
 - (void)callHandler:(NSString*)handlerName data:(id)data;
 - (void)callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback;
 - (void)reset;
-- (void)setWebViewDelegate:(id<WKNavigationDelegate>)webViewDelegate;
+- (void)setWebViewDelegate:(id)webViewDelegate;
 - (void)disableJavscriptAlertBoxSafetyTimeout;
 
 @end
diff --git a/WebViewJavascriptBridge/WKWebViewJavascriptBridge.m b/WebViewJavascriptBridge/WKWebViewJavascriptBridge.m
@@ -8,7 +8,7 @@
 
 #import "WKWebViewJavascriptBridge.h"
 
-#if defined(supportsWKWebKit)
+#if defined supportsWKWebView
 
 @implementation WKWebViewJavascriptBridge {
     __weak WKWebView* _webView;
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.h b/WebViewJavascriptBridge/WebViewJavascriptBridge.h
@@ -9,8 +9,15 @@
 #import <Foundation/Foundation.h>
 #import "WebViewJavascriptBridgeBase.h"
 
+#if (__MAC_OS_X_VERSION_MAX_ALLOWED > __MAC_10_9 || __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_7_1)
+#define supportsWKWebView
+#endif
+
+#if defined supportsWKWebView
+#import <WebKit/WebKit.h>
+#endif
+
 #if defined __MAC_OS_X_VERSION_MAX_ALLOWED
-    #import <WebKit/WebKit.h>
     #define WVJB_PLATFORM_OSX
     #define WVJB_WEBVIEW_TYPE WebView
     #define WVJB_WEBVIEW_DELEGATE_TYPE NSObject<WebViewJavascriptBridgeBaseDelegate>
@@ -25,15 +32,17 @@
 
 @interface WebViewJavascriptBridge : WVJB_WEBVIEW_DELEGATE_INTERFACE
 
-+ (instancetype)bridgeForWebView:(WVJB_WEBVIEW_TYPE*)webView;
+
++ (instancetype)bridgeForWebView:(id)webView;
+
 + (void)enableLogging;
 + (void)setLogMaxLength:(int)length;
 
 - (void)registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler;
 - (void)callHandler:(NSString*)handlerName;
 - (void)callHandler:(NSString*)handlerName data:(id)data;
 - (void)callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback;
-- (void)setWebViewDelegate:(WVJB_WEBVIEW_DELEGATE_TYPE*)webViewDelegate;
+- (void)setWebViewDelegate:(id)webViewDelegate;
 - (void)disableJavscriptAlertBoxSafetyTimeout;
 
 @end
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.m b/WebViewJavascriptBridge/WebViewJavascriptBridge.m
@@ -8,6 +8,10 @@
 
 #import "WebViewJavascriptBridge.h"
 
+#if defined(supportsWKWebView)
+#import "WKWebViewJavascriptBridge.h"
+#endif
+
 #if __has_feature(objc_arc_weak)
     #define WVJB_WEAK __weak
 #else
@@ -31,10 +35,19 @@ + (void)setLogMaxLength:(int)length {
     [WebViewJavascriptBridgeBase setLogMaxLength:length];
 }
 
-+ (instancetype)bridgeForWebView:(WVJB_WEBVIEW_TYPE*)webView {
-    WebViewJavascriptBridge* bridge = [[self alloc] init];
-    [bridge _platformSpecificSetup:webView];
-    return bridge;
++ (instancetype)bridgeForWebView:(id)webView {
+#if defined supportsWKWebView
+    if ([webView isKindOfClass:[WKWebView class]]) {
+        return (WebViewJavascriptBridge*) [WKWebViewJavascriptBridge bridgeForWebView:webView];
+    }
+#endif
+    if ([webView isKindOfClass:[WVJB_WEBVIEW_TYPE class]]) {
+        WebViewJavascriptBridge* bridge = [[self alloc] init];
+        [bridge _platformSpecificSetup:webView];
+        return bridge;
+    }
+    [NSException raise:@"BadWebViewType" format:@"Unknown web view type."];
+    return nil;
 }
 
 - (void)setWebViewDelegate:(WVJB_WEBVIEW_DELEGATE_TYPE*)webViewDelegate {

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ <h1>WebViewJavascriptBridge Demo</h1>`
`20`	`20`	`window.WVJBCallbacks = [callback];`
`21`	`21`	`var WVJBIframe = document.createElement('iframe');`
`22`	`22`	`WVJBIframe.style.display = 'none';`
`23`		`- WVJBIframe.src = 'http://__bridge_loaded__';`
	`23`	`+ WVJBIframe.src = 'https://__bridge_loaded__';`
`24`	`24`	`document.documentElement.appendChild(WVJBIframe);`
`25`	`25`	`setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)`
`26`	`26`	`}`