Moved the Javascript implementation to a file ending in "_JS.(h/m).

mbishop-fiksu · mbishop-fiksu · commit 71649ae32ec6 · 2015-08-06T09:04:22.000-04:00
Added explanation to _JS.m file.
diff --git a/WebViewJavascriptBridge.podspec b/WebViewJavascriptBridge.podspec
@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.osx.platform     = :osx
   s.ios.source_files = 'WebViewJavascriptBridge/*.{h,m}'
   s.osx.source_files = 'WebViewJavascriptBridge/*.{h,m}'
-  s.private_header_files = 'WebViewJavascriptBridge/*_Private.h'
+  s.private_header_files = 'WebViewJavascriptBridge/*_JS.h'
   s.ios.framework    = 'UIKit'
   s.osx.framework    = 'WebKit'
 end
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.m b/WebViewJavascriptBridge/WebViewJavascriptBridge.m
@@ -7,7 +7,7 @@
 //
 
 #import "WebViewJavascriptBridge.h"
-#import "WebViewJavascriptBridge_Private.h"
+#import "WebViewJavascriptBridge_JS.h"
 
 #if __has_feature(objc_arc_weak)
     #define WVJB_WEAK __weak
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge_JS.h b/WebViewJavascriptBridge/WebViewJavascriptBridge_JS.h
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge_JS.m b/WebViewJavascriptBridge/WebViewJavascriptBridge_JS.m
@@ -1,5 +1,14 @@
+// This file contains the source for the Javascript side of the
+// WebViewJavascriptBridge. It is plaintext, but converted to an NSString
+// via some preprocessor tricks.
+//
+// Previous implementations of WebViewJavascriptBridge loaded the javascript source
+// from a resource. This worked fine for app developers, but library developers who
+// included the bridge into their library, awkwardly had to ask consumers of their
+// library to include the resource, violating their encapsulation. By including the
+// Javascript as a string resource, the encapsulation of the library is maintained.
 
-#import "WebViewJavascriptBridge_Private.h"
+#import "WebViewJavascriptBridge_JS.h"
 
 NSString * WebViewJavascriptBridge_js() {
 // Create a unique preprocessor symbol that last only the duration of this function
