Merge pull request #1 from marcuswestin/master

update

Author: yinghuiwang

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+# WVJB Bug Report
+
+Thanks for reporting an issue with WebViewJavascriptBridge.
+
+### Do these 4 things and I will fix your problem!
+
+1. Go to https://github.com/marcuswestin/WebViewJavascriptBridge and click Fork.
+2. Clone your fork, `cd` into it and run `make test`. All tests should pass!
+3. Edit `Tests/WebViewJavascriptBridgeTests/BridgeTests.m` and create a new, failing test which demostrates your issue.
+4. Create a pull request for https://github.com/marcuswestin/WebViewJavascriptBridge
+
+#### That's it!
+
+I will take it from there and promise that I'll fix your problem ASAP.
+
+#### If you don't do this then I can't help you!
+
+And I probably won't :)
+
+Cheers,
+@marcuswestin

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Before your create your PR:
+
+#### Please add tests for any new or changed functionality!
+
+1. Edit `Tests/WebViewJavascriptBridgeTests/BridgeTests.m`
+2. Create a new test which demostrates your changes.
+3. Run `make test` and make sure your test is passing
+4. That's it!
+
+#### Thanks for improving WebViewJavascriptBridge!
+
+Cheers,
+@marcuswestin

.travis.yml

@@ -13,12 +13,33 @@ Release Checklist
 Version History
 ---------------
 
-Intended v5.0.0
+v5.1.1
++ Swift unit tests and examples
++ Implement removeHandler
+
+v5.1.0
++ A single instantiation function for all webview types.
++ Improved test runner.
++ New instructions & templates for github issues and pull requests.
+
+v5.0.5
++ Run all tests for both UIWebView and WKWebView webviews/bridges.
++ Allow for calling handlers from JS with just a handler name and responseCallback function (#184).
+
+v5.0.3 & v5.0.4
++ Recalled builds :)
+
+v5.0.2
++ Fix bug that could cause a crash if the webview loads a new page immediately after JS sends a message.
+
+v5.0.1
 + Removed `WebViewJavascriptBridge -reset`. It should never have been exposed as a public API.
 + Fixed compilation in C99 mode
-
-Next version
-+ Pretty-print json in log messages
++ Inline JS source code. WVJB no longer requires `WebViewJavascriptBridge.js.txt` to be included as a resource.
++ Automated testing: see `make test`
++ Added Makefile with common commands
++ Significantly simplified and improved wvjb load detection
++ Simplify API by focusing on explicitly named handlers instead of a default handler and plain `send`.
 
 v4.1.4
 + Improve how WVJB handles the case when there is no ObjC handler for a message received from js.

Changelog

@@ -164,7 +164,7 @@
 		2C136A1917641106004C7401 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0510;
+				LastUpgradeCheck = 0810;
 				ORGANIZATIONNAME = "Marcus Westin";
 			};
 			buildConfigurationList = 2C136A1C17641106004C7401 /* Build configuration list for PBXProject "ExampleApp-OSX" */;
@@ -241,15 +241,22 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
+				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				COPY_PHASE_STRIP = NO;
+				ENABLE_STRICT_OBJC_MSGSEND = YES;
+				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_DYNAMIC_NO_PIC = NO;
 				GCC_ENABLE_OBJC_EXCEPTIONS = YES;
+				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_OPTIMIZATION_LEVEL = 0;
 				GCC_PREPROCESSOR_DEFINITIONS = (
 					"DEBUG=1",
@@ -258,7 +265,9 @@
 				GCC_SYMBOLS_PRIVATE_EXTERN = NO;
 				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
 				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNDECLARED_SELECTOR = YES;
 				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				MACOSX_DEPLOYMENT_TARGET = 10.8;
 				ONLY_ACTIVE_ARCH = YES;
@@ -273,18 +282,26 @@
 				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
+				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				COPY_PHASE_STRIP = YES;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
+				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_ENABLE_OBJC_EXCEPTIONS = YES;
+				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
 				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNDECLARED_SELECTOR = YES;
 				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				MACOSX_DEPLOYMENT_TARGET = 10.8;
 				SDKROOT = macosx;
@@ -299,6 +316,7 @@
 				GCC_PREFIX_HEADER = "ExampleApp-OSX/ExampleApp-OSX-Prefix.pch";
 				INFOPLIST_FILE = "ExampleApp-OSX/ExampleApp-OSX-Info.plist";
 				MACOSX_DEPLOYMENT_TARGET = 10.7;
+				PRODUCT_BUNDLE_IDENTIFIER = "WebViewJavascriptBridge.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				WRAPPER_EXTENSION = app;
 			};
@@ -312,6 +330,7 @@
 				GCC_PREFIX_HEADER = "ExampleApp-OSX/ExampleApp-OSX-Prefix.pch";
 				INFOPLIST_FILE = "ExampleApp-OSX/ExampleApp-OSX-Info.plist";
 				MACOSX_DEPLOYMENT_TARGET = 10.7;
+				PRODUCT_BUNDLE_IDENTIFIER = "WebViewJavascriptBridge.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				WRAPPER_EXTENSION = app;
 			};

Example Apps/ExampleApp-OSX.xcodeproj/project.pbxproj

@@ -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;
 }
 
@@ -28,38 +27,24 @@ - (void)applicationDidFinishLaunching:(NSNotification *)aNotification
 
 - (void)_configureWebview {
     // Create Bridge
-    _bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
+    _bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
 
     [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_bridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     // Create Buttons
-    NSButton *messageButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
-    [messageButton setTitle:@"Send message"];
-    [messageButton setBezelStyle:NSRoundedBezelStyle];
-    [messageButton setTarget:self];
-    [messageButton setAction:@selector(_sendMessage)];
-    [_webView addSubview:messageButton];
-    
-    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 120, 40)];
+    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
     [callbackButton setTitle:@"Call handler"];
     [callbackButton setBezelStyle:NSRoundedBezelStyle];
     [callbackButton setTarget:self];
     [callbackButton setAction:@selector(_callHandler)];
     [_webView addSubview:callbackButton];
 
-    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(235, 0, 180, 40)];
+    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 180, 40)];
     [webViewToggleButton setTitle:@"Switch to WKWebView"];
     [webViewToggleButton setBezelStyle:NSRoundedBezelStyle];
     [webViewToggleButton setTarget:self];
@@ -70,44 +55,31 @@ - (void)_configureWebview {
     // Load Page
     NSString* htmlPath = [[NSBundle mainBundle] pathForResource:@"ExampleApp" ofType:@"html"];
     NSString* html = [NSString stringWithContentsOfFile:htmlPath encoding:NSUTF8StringEncoding error:nil];
-    [[_webView mainFrame] loadHTMLString:html baseURL:nil];
+    NSURL *baseURL = [NSURL fileURLWithPath:htmlPath];
+    [[_webView mainFrame] loadHTMLString:html baseURL: baseURL];
 }
 
 
 - (void)_configureWKWebview {
     // Create Bridge
-    _WKBridge = [WKWebViewJavascriptBridge bridgeForWebView:_WKWebView handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
+    _WKBridge = [WebViewJavascriptBridge bridgeForWebView:_WKWebView];
 
     [_WKBridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_WKBridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_WKBridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     // Create Buttons
-    NSButton *messageButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
-    [messageButton setTitle:@"Send message"];
-    [messageButton setBezelStyle:NSRoundedBezelStyle];
-    [messageButton setTarget:self];
-    [messageButton setAction:@selector(_WKSendMessage)];
-    [_WKWebView addSubview:messageButton];
-    
-    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 120, 40)];
+    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
     [callbackButton setTitle:@"Call handler"];
     [callbackButton setBezelStyle:NSRoundedBezelStyle];
     [callbackButton setTarget:self];
     [callbackButton setAction:@selector(_WKCallHandler)];
     [_WKWebView addSubview:callbackButton];
 
-    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(235, 0, 180, 40)];
+    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 180, 40)];
     [webViewToggleButton setTitle:@"Switch to WebView"];
     [webViewToggleButton setBezelStyle:NSRoundedBezelStyle];
     [webViewToggleButton setTarget:self];
@@ -117,33 +89,22 @@ - (void)_configureWKWebview {
     // Load Page
     NSString* htmlPath = [[NSBundle mainBundle] pathForResource:@"ExampleApp" ofType:@"html"];
     NSString* html = [NSString stringWithContentsOfFile:htmlPath encoding:NSUTF8StringEncoding error:nil];
-    [_WKWebView loadHTMLString:html baseURL:nil];
+    NSURL *baseURL = [NSURL fileURLWithPath:htmlPath];
+    [_WKWebView loadHTMLString:html baseURL:baseURL];
 }
 
 -(void)_toggleExample {
     _WKWebView.hidden = !_WKWebView.isHidden;
     _webView.hidden = !_webView.isHidden;
 }
 
-- (void)_sendMessage {
-    [_bridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)_callHandler {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_bridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {
         NSLog(@"testJavascriptHandler responded: %@", response);
     }];
 }
 
-- (void)_WKSendMessage {
-    [_WKBridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)_WKCallHandler {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_WKBridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {

Example Apps/ExampleApp-OSX/AppDelegate.m

@@ -9,7 +9,7 @@
 	<key>CFBundleIconFile</key>
 	<string></string>
 	<key>CFBundleIdentifier</key>
-	<string>WebViewJavascriptBridge.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>