code style

coderyi · coderyi · commit c53301046589 · 2015-11-14T13:49:39.000+08:00
diff --git a/NetworkEye.xcodeproj/project.pbxproj b/NetworkEye.xcodeproj/project.pbxproj
@@ -7,7 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
-		0A1202451BEC8C9700B710A9 /* UIWindow+NEShakeGesture.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A1202441BEC8C9700B710A9 /* UIWindow+NEShakeGesture.m */; settings = {ASSET_TAGS = (); }; };
+		0A09FAC01BF6FC3F0009EC53 /* UIWindow+NEExtension.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A09FABF1BF6FC3F0009EC53 /* UIWindow+NEExtension.m */; settings = {ASSET_TAGS = (); }; };
 		0A1202E31BF097BC00B710A9 /* NEURLSessionConfiguration.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A1202E21BF097BC00B710A9 /* NEURLSessionConfiguration.m */; settings = {ASSET_TAGS = (); }; };
 		0A4EF8451BEB66FF000D2D7E /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A4EF8441BEB66FF000D2D7E /* main.m */; };
 		0A4EF8481BEB66FF000D2D7E /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A4EF8471BEB66FF000D2D7E /* AppDelegate.m */; };
@@ -46,8 +46,8 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
-		0A1202431BEC8C9700B710A9 /* UIWindow+NEShakeGesture.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "UIWindow+NEShakeGesture.h"; sourceTree = "<group>"; };
-		0A1202441BEC8C9700B710A9 /* UIWindow+NEShakeGesture.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "UIWindow+NEShakeGesture.m"; sourceTree = "<group>"; };
+		0A09FABE1BF6FC3F0009EC53 /* UIWindow+NEExtension.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "UIWindow+NEExtension.h"; sourceTree = "<group>"; };
+		0A09FABF1BF6FC3F0009EC53 /* UIWindow+NEExtension.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "UIWindow+NEExtension.m"; sourceTree = "<group>"; };
 		0A1202E11BF097BC00B710A9 /* NEURLSessionConfiguration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NEURLSessionConfiguration.h; sourceTree = "<group>"; };
 		0A1202E21BF097BC00B710A9 /* NEURLSessionConfiguration.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NEURLSessionConfiguration.m; sourceTree = "<group>"; };
 		0A4EF8401BEB66FF000D2D7E /* NetworkEye.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = NetworkEye.app; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -195,8 +195,8 @@
 				0A4EF8881BEB6735000D2D7E /* NEHTTPModelManager.m */,
 				0A4EF8891BEB6735000D2D7E /* NEShakeGestureManager.h */,
 				0A4EF88A1BEB6735000D2D7E /* NEShakeGestureManager.m */,
-				0A1202431BEC8C9700B710A9 /* UIWindow+NEShakeGesture.h */,
-				0A1202441BEC8C9700B710A9 /* UIWindow+NEShakeGesture.m */,
+				0A09FABE1BF6FC3F0009EC53 /* UIWindow+NEExtension.h */,
+				0A09FABF1BF6FC3F0009EC53 /* UIWindow+NEExtension.m */,
 				0A1202E11BF097BC00B710A9 /* NEURLSessionConfiguration.h */,
 				0A1202E21BF097BC00B710A9 /* NEURLSessionConfiguration.m */,
 			);
@@ -413,7 +413,7 @@
 				0A4EF8971BEB6735000D2D7E /* NEHTTPEyeViewController.m in Sources */,
 				0A4EF8991BEB6735000D2D7E /* NEHTTPModelManager.m in Sources */,
 				0ADE8CFA1BF4999A0096A1E5 /* NEHTTPEyeSettingsViewController.m in Sources */,
-				0A1202451BEC8C9700B710A9 /* UIWindow+NEShakeGesture.m in Sources */,
+				0A09FAC01BF6FC3F0009EC53 /* UIWindow+NEExtension.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
diff --git a/NetworkEye/NetworkEye/NEHTTPEye.h b/NetworkEye/NetworkEye/NEHTTPEye.h
@@ -12,6 +12,17 @@
 #define kSaveRequestMaxCount 300
 
 @interface NEHTTPEye : NSURLProtocol
+/**
+ *  open or close HTTP/HTTPS monitor
+ *
+ *  @param enabled
+ */
 + (void)setEnabled:(BOOL)enabled;
+
+/**
+ *  display HTTP/HTTPS monitor state
+ *
+ *  @return HTTP/HTTPS monitor state
+ */
 + (BOOL)isEnabled;
 @end
diff --git a/NetworkEye/NetworkEye/NEHTTPEye.m b/NetworkEye/NetworkEye/NEHTTPEye.m
@@ -10,7 +10,7 @@
 
 #import "NEHTTPModel.h"
 #import "NEHTTPModelManager.h"
-#import "UIWindow+NEShakeGesture.h"
+#import "UIWindow+NEExtension.h"
 #import "NEURLSessionConfiguration.h"
 @interface NEHTTPEye ()<NSURLConnectionDelegate, NSURLConnectionDataDelegate>
 @property (nonatomic, strong) NSURLConnection *connection;
@@ -22,9 +22,9 @@ @interface NEHTTPEye ()<NSURLConnectionDelegate, NSURLConnectionDataDelegate>
 
 @implementation NEHTTPEye
 @synthesize ne_HTTPModel;
+#pragma mark - public
 + (void)setEnabled:(BOOL)enabled
 {
-//    BOOL previouslyEnabled =[NEHTTPEye isEnabled];
     [[NSUserDefaults standardUserDefaults] setDouble:enabled forKey:@"NetworkEyeEnable"];
     [[NSUserDefaults standardUserDefaults] synchronize];
     NEURLSessionConfiguration * sessionConfiguration=[NEURLSessionConfiguration defaultConfiguration];
@@ -133,7 +133,7 @@ - (void)stopLoading {
     flowCount=flowCount+self.response.expectedContentLength/(1024.0*1024.0);
     [[NSUserDefaults standardUserDefaults] setDouble:flowCount forKey:@"flowCount"];
     [[NSUserDefaults standardUserDefaults] synchronize];//https://github.com/coderyi/NetworkEye/pull/6
-    [[NEHTTPModelManager defaultManager] addModel:ne_HTTPModel error:nil];
+    [[NEHTTPModelManager defaultManager] addModel:ne_HTTPModel];
 }
 
 #pragma mark - NSURLConnectionDelegate
diff --git a/NetworkEye/NetworkEye/NEHTTPEyeDetailViewController.h b/NetworkEye/NetworkEye/NEHTTPEyeDetailViewController.h
@@ -11,7 +11,9 @@
 @class NEHTTPModel;
 
 @interface NEHTTPEyeDetailViewController : UIViewController
-
+/**
+ *  detail page's data model,about request,response and data
+ */
 @property (nonatomic,strong) NEHTTPModel *model;
 
 @end
diff --git a/NetworkEye/NetworkEye/NEHTTPEyeSettingsViewController.m b/NetworkEye/NetworkEye/NEHTTPEyeSettingsViewController.m
@@ -114,7 +114,7 @@ - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath
 
 - (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex NS_DEPRECATED_IOS(2_0, 9_0){
     if(buttonIndex==0){
-        [[NEHTTPModelManager defaultManager] deleteAllItem:nil];
+        [[NEHTTPModelManager defaultManager] deleteAllItem];
 
     }
 }
diff --git a/NetworkEye/NetworkEye/NEHTTPModelManager.h b/NetworkEye/NetworkEye/NEHTTPModelManager.h
@@ -15,11 +15,43 @@
     FMDatabaseQueue *sqliteDatabase;
     NSMutableArray *allobjects;
 }
-
+/**
+ *  get recorded requests 's SQLite filename
+ *
+ *  @return filename
+ */
 +(NSString *)filename;
+
+/**
+ *  get NEHTTPModelManager's singleton object
+ *
+ *  @return singleton object
+ */
 +(NEHTTPModelManager *)defaultManager;
+
+/**
+ *  create NEHTTPModel table
+ */
 +(void)createTable;
--(int)addModel:(NEHTTPModel *) aModel error:(NSError **) error;
+
+
+/**
+ *  add a NEHTTPModel object to SQLite
+ *
+ *  @param aModel a NEHTTPModel object
+ */
+-(void)addModel:(NEHTTPModel *) aModel;
+
+/**
+ *  get SQLite all NEHTTPModel object
+ *
+ *  @return all NEHTTPModel object
+ */
 -(NSMutableArray *)allobjects;
-- (int) deleteAllItem:(NSError **) error;
+
+/**
+ *  delete all SQLite records
+ */
+- (void) deleteAllItem;
+
 @end
diff --git a/NetworkEye/NetworkEye/NEHTTPModelManager.m b/NetworkEye/NetworkEye/NEHTTPModelManager.m
@@ -51,14 +51,14 @@ +(void)createTable{
     
 }
 
--(int)addModel:(NEHTTPModel *) aModel error:(NSError **) error{
+-(void)addModel:(NEHTTPModel *) aModel{
     
     if ([aModel.responseMIMEType isEqualToString:@"text/html"]) {
         aModel.receiveJSONData=@"";
     }
     
     if ([[[NSUserDefaults standardUserDefaults] objectForKey:@"nenetworkhttpeyecache"] isEqualToString:@"a"]) {
-        [self deleteAllItem:nil];
+        [self deleteAllItem];
         [[NSUserDefaults standardUserDefaults] setObject:@"b" forKey:@"nenetworkhttpeyecache"];
     }
 
@@ -76,7 +76,7 @@ -(int)addModel:(NEHTTPModel *) aModel error:(NSError **) error{
         [db executeUpdate:sql];
     }];
     
-    return 0;
+    return ;
     
 }
 
@@ -118,7 +118,7 @@ -(NSMutableArray *)allobjects{
     
 }
 
-- (int) deleteAllItem:(NSError **) error{
+- (void) deleteAllItem{
     
     NSString *sql=[NSString stringWithFormat:@"delete from nenetworkhttpeyes"];
     FMDatabaseQueue *queue = [FMDatabaseQueue databaseQueueWithPath:[NEHTTPModelManager filename]];
@@ -127,7 +127,7 @@ - (int) deleteAllItem:(NSError **) error{
         [db executeUpdate:sql];
     }];
     
-    return 0;
+    return ;
     
 }
 
diff --git a/NetworkEye/NetworkEye/NEShakeGestureManager.h b/NetworkEye/NetworkEye/NEShakeGestureManager.h
@@ -10,7 +10,16 @@
 
 @interface NEShakeGestureManager : NSObject
 
+/**
+ *  get NEShakeGestureManager's singleton object
+ *
+ *  @return singleton object
+ */
 +(NEShakeGestureManager *)defaultManager;
+
+/**
+ *  show Go NetworkEye page 's alertView
+ */
 - (void)showAlertView;
 
 @end
diff --git a/NetworkEye/NetworkEye/NEURLSessionConfiguration.h b/NetworkEye/NetworkEye/NEURLSessionConfiguration.h
@@ -9,8 +9,22 @@
 #import <Foundation/Foundation.h>
 
 @interface NEURLSessionConfiguration : NSObject
-@property (nonatomic,assign) BOOL isSwizzle;
+@property (nonatomic,assign) BOOL isSwizzle;// whether swizzle NSURLSessionConfiguration's protocolClasses method
+
+/**
+ *  get NEURLSessionConfiguration's singleton object
+ *
+ *  @return singleton object
+ */
 +(NEURLSessionConfiguration *)defaultConfiguration;
+
+/**
+ *  swizzle NSURLSessionConfiguration's protocolClasses method
+ */
 - (void)load;
+
+/**
+ *  make NSURLSessionConfiguration's protocolClasses method is normal
+ */
 - (void)unload;
 @end
diff --git a/NetworkEye/NetworkEye/NEURLSessionConfiguration.m b/NetworkEye/NetworkEye/NEURLSessionConfiguration.m
@@ -31,28 +31,19 @@ - (instancetype)init {
 }
 
 - (void)load {
+    
     self.isSwizzle=YES;
-
-//    static dispatch_once_t onceToken;
-//    dispatch_once(&onceToken, ^{
-//        Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
-//        [self swizzleSelector:@selector(protocolClasses) fromClass:cls toClass:[self class]];
-//    });
     Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
     [self swizzleSelector:@selector(protocolClasses) fromClass:cls toClass:[self class]];
     
 }
 
 - (void)unload {
+    
     self.isSwizzle=NO;
-
     Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
     [self swizzleSelector:@selector(protocolClasses) fromClass:cls toClass:[self class]];
-//    static dispatch_once_t onceToken;
-//    dispatch_once(&onceToken, ^{
-//        Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
-//        [self swizzleSelector:@selector(protocolClasses) fromClass:cls toClass:[self class]];
-//    });
+
 }
 
 - (void)swizzleSelector:(SEL)selector fromClass:(Class)original toClass:(Class)stub {
diff --git a/NetworkEye/NetworkEye/UIWindow+NEExtension.h b/NetworkEye/NetworkEye/UIWindow+NEExtension.h
@@ -1,13 +1,13 @@
 //
-//  UIWindow+NEShakeGesture.h
+//  UIWindow+NEExtension.h
 //  NetworkEye
 //
-//  Created by coderyi on 15/11/6.
+//  Created by coderyi on 15/11/14.
 //  Copyright © 2015年 coderyi. All rights reserved.
 //
 
 #import <UIKit/UIKit.h>
 
-@interface UIWindow (NEShakeGesture)
+@interface UIWindow (NEExtension)
 
 @end
diff --git a/NetworkEye/NetworkEye/UIWindow+NEExtension.m b/NetworkEye/NetworkEye/UIWindow+NEExtension.m
@@ -1,16 +1,15 @@
 //
-//  UIWindow+NEShakeGesture.m
+//  UIWindow+NEExtension.m
 //  NetworkEye
 //
-//  Created by coderyi on 15/11/6.
+//  Created by coderyi on 15/11/14.
 //  Copyright © 2015年 coderyi. All rights reserved.
 //
 
-#import "UIWindow+NEShakeGesture.h"
-
+#import "UIWindow+NEExtension.h"
 #import "NEShakeGestureManager.h"
 
-@implementation UIWindow (NEShakeGesture)
+@implementation UIWindow (NEExtension)
 
 - (void)motionEnded:(UIEventSubtype)motion withEvent:(UIEvent *)event {
     
@@ -38,4 +37,5 @@ -(void)touchesEnded:(NSSet *)touches withEvent:(UIEvent *)event
     }
     
 }
+
 @end
diff --git a/README.md b/README.md
@@ -13,6 +13,10 @@ It can be detected HTTP request include web pages, NSURLConnection, NSURLSession
 I created a google group，this group is for general discussion NetworkEye
 ,welcome to join,[https://groups.google.com/d/forum/networkeye](https://groups.google.com/d/forum/networkeye)
 
+if you use NetworkEye, you can add it in here,[Who-Uses-NetworkEye](https://github.com/coderyi/NetworkEye/wiki/Who-Uses-NetworkEye)
+
+welcome to new pull request,that fix bug,add new features,add support other platform.and welcome to [new issues](https://github.com/coderyi/NetworkEye/issues).
+
 #### Podfile
 
 ```ruby

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath`
`114`	`114`
`115`	`115`	`- (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex NS_DEPRECATED_IOS(2_0, 9_0){`
`116`	`116`	`if(buttonIndex==0){`
`117`		`- [[NEHTTPModelManager defaultManager] deleteAllItem:nil];`
	`117`	`+ [[NEHTTPModelManager defaultManager] deleteAllItem];`
`118`	`118`
`119`	`119`	`}`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,14 +51,14 @@ +(void)createTable{`
`51`	`51`
`52`	`52`	`}`
`53`	`53`
`54`		`--(int)addModel:(NEHTTPModel ) aModel error:(NSError *) error{`
	`54`	`+-(void)addModel:(NEHTTPModel *) aModel{`
`55`	`55`
`56`	`56`	`if ([aModel.responseMIMEType isEqualToString:@"text/html"]) {`
`57`	`57`	`aModel.receiveJSONData=@"";`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`if ([[[NSUserDefaults standardUserDefaults] objectForKey:@"nenetworkhttpeyecache"] isEqualToString:@"a"]) {`
`61`		`- [self deleteAllItem:nil];`
	`61`	`+ [self deleteAllItem];`
`62`	`62`	`[[NSUserDefaults standardUserDefaults] setObject:@"b" forKey:@"nenetworkhttpeyecache"];`
`63`	`63`	`}`
`64`	`64`
`@@ -76,7 +76,7 @@ -(int)addModel:(NEHTTPModel ) aModel error:(NSError *) error{`
`76`	`76`	`[db executeUpdate:sql];`
`77`	`77`	`}];`
`78`	`78`
`79`		`- return 0;`
	`79`	`+ return ;`
`80`	`80`
`81`	`81`	`}`
`82`	`82`
`@@ -118,7 +118,7 @@ -(NSMutableArray *)allobjects{`
`118`	`118`
`119`	`119`	`}`
`120`	`120`
`121`		`-- (int) deleteAllItem:(NSError **) error{`
	`121`	`+- (void) deleteAllItem{`
`122`	`122`
`123`	`123`	`NSString *sql=[NSString stringWithFormat:@"delete from nenetworkhttpeyes"];`
`124`	`124`	`FMDatabaseQueue *queue = [FMDatabaseQueue databaseQueueWithPath:[NEHTTPModelManager filename]];`
`@@ -127,7 +127,7 @@ - (int) deleteAllItem:(NSError **) error{`
`127`	`127`	`[db executeUpdate:sql];`
`128`	`128`	`}];`
`129`	`129`
`130`		`- return 0;`
	`130`	`+ return ;`
`131`	`131`
`132`	`132`	`}`
`133`	`133`