Renamed files.

Author: insanoid

SwiftyJSONAccelerator.xcodeproj/project.pbxproj

@@ -11,7 +11,7 @@
 		9362F8661BD07DBA0001372E /* JSONHelperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9362F8651BD07DBA0001372E /* JSONHelperTests.swift */; settings = {ASSET_TAGS = (); }; };
 		93CDE7721BD1A00B00B5B234 /* SJTextView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 93CDE7711BD1A00B00B5B234 /* SJTextView.swift */; settings = {ASSET_TAGS = (); }; };
 		93F174431BD0707D007E7DFC /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 93F174421BD0707D007E7DFC /* AppDelegate.swift */; };
-		93F174451BD0707D007E7DFC /* ViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 93F174441BD0707D007E7DFC /* ViewController.swift */; };
+		93F174451BD0707D007E7DFC /* SJEditorViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 93F174441BD0707D007E7DFC /* SJEditorViewController.swift */; };
 		93F174471BD0707D007E7DFC /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 93F174461BD0707D007E7DFC /* Assets.xcassets */; };
 		93F1744A1BD0707D007E7DFC /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 93F174481BD0707D007E7DFC /* Main.storyboard */; };
 		93F174551BD0707D007E7DFC /* SwiftyJSONAcceleratorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 93F174541BD0707D007E7DFC /* SwiftyJSONAcceleratorTests.swift */; };
@@ -34,7 +34,7 @@
 		93CDE7711BD1A00B00B5B234 /* SJTextView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SJTextView.swift; sourceTree = "<group>"; };
 		93F1743F1BD0707D007E7DFC /* SwiftyJSONAccelerator.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = SwiftyJSONAccelerator.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		93F174421BD0707D007E7DFC /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
-		93F174441BD0707D007E7DFC /* ViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = "<group>"; };
+		93F174441BD0707D007E7DFC /* SJEditorViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SJEditorViewController.swift; sourceTree = "<group>"; };
 		93F174461BD0707D007E7DFC /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
 		93F174491BD0707D007E7DFC /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
 		93F1744B1BD0707D007E7DFC /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -84,7 +84,7 @@
 			isa = PBXGroup;
 			children = (
 				93F174421BD0707D007E7DFC /* AppDelegate.swift */,
-				93F174441BD0707D007E7DFC /* ViewController.swift */,
+				93F174441BD0707D007E7DFC /* SJEditorViewController.swift */,
 				9361FD131BD18558001ED533 /* LineNumberRulerView.swift */,
 				93F174461BD0707D007E7DFC /* Assets.xcassets */,
 				93F174481BD0707D007E7DFC /* Main.storyboard */,
@@ -206,7 +206,7 @@
 			files = (
 				93CDE7721BD1A00B00B5B234 /* SJTextView.swift in Sources */,
 				93F174601BD070AA007E7DFC /* JSONHelper.swift in Sources */,
-				93F174451BD0707D007E7DFC /* ViewController.swift in Sources */,
+				93F174451BD0707D007E7DFC /* SJEditorViewController.swift in Sources */,
 				9361FD141BD18558001ED533 /* LineNumberRulerView.swift in Sources */,
 				93F174431BD0707D007E7DFC /* AppDelegate.swift in Sources */,
 			);

SwiftyJSONAccelerator/Base.lproj/Main.storyboard

@@ -668,7 +668,7 @@
         <!--SwiftyJSONAccelerator-->
         <scene sceneID="hIz-AP-VOD">
             <objects>
-                <viewController title="SwiftyJSONAccelerator" id="XfG-lQ-9wD" customClass="ViewController" customModule="SwiftyJSONAccelerator" customModuleProvider="target" sceneMemberID="viewController">
+                <viewController title="SwiftyJSONAccelerator" id="XfG-lQ-9wD" customClass="SJEditorViewController" customModule="SwiftyJSONAccelerator" customModuleProvider="target" sceneMemberID="viewController">
                     <view key="view" id="m2S-Jp-Qdl">
                         <rect key="frame" x="0.0" y="0.0" width="593" height="460"/>
                         <autoresizingMask key="autoresizingMask"/>

SwiftyJSONAccelerator/JSONHelper.swift

@@ -14,7 +14,8 @@ public class JSONHelper {
     /**
     Validates if te string that is provided can be converted into a valid JSON.
 
-    - parameter jsonString: Input string that is to be checked as JSON.
+    - parameters:
+        - jsonString: Input string that is to be checked as JSON.
 
     - returns: Bool indicating if it is a JSON or NSError with the error about the validation.
     */
@@ -26,7 +27,8 @@ public class JSONHelper {
     /**
     Converts the given string into an Object.
 
-    - parameter jsonString: Input string that has to be converted.
+    - parameters:
+        - jsonString: Input string that has to be converted.
 
     - returns: Bool indicating if the process was successful, Object if it worked else NSError.
     */
@@ -49,7 +51,8 @@ public class JSONHelper {
     /**
     Formats the given string into beautiful JSON with indentation.
 
-    - parameter jsonString: JSON string that has to be formatted.
+    - parameters:
+        - jsonString: JSON string that has to be formatted.
 
     - returns: String with JSON but well formatted.
     */
@@ -65,7 +68,8 @@ public class JSONHelper {
     /**
     Formats the given Object into beautiful JSON with indentation.
 
-    - parameter object: Object that has to be formatted.
+    - parameters:
+        - object: Object that has to be formatted.
 
     - returns: String with JSON but well formatted.
     */

SwiftyJSONAccelerator/ViewController.swift renamed to SwiftyJSONAccelerator/SJEditorViewController.swift

@@ -1,5 +1,5 @@
 //
-//  ViewController.swift
+//  SJEditorViewController.swift
 //  SwiftyJSONAccelerator
 //
 //  Created by Karthik on 16/10/2015.
@@ -8,12 +8,15 @@
 
 import Cocoa
 
-class ViewController: NSViewController, NSTextViewDelegate {
+/// View for the processing of the content and generation of the files.
+class SJEditorViewController: NSViewController, NSTextViewDelegate {
 
+    // MARK: Outlet files.
     @IBOutlet var textView: SJTextView?
     @IBOutlet var messageLabel: NSTextField?
     @IBOutlet var errorImageView: NSImageView?
 
+    // MARK: View methods
     override func viewDidLoad() {
         super.viewDidLoad()
 
@@ -29,7 +32,7 @@ class ViewController: NSViewController, NSTextViewDelegate {
             // Update the view, if already loaded.
         }
     }
-    
+    // MARK: Actions
     @IBAction func format(sender: AnyObject?) {
 
         if textView?.string?.characters.count == 0 {
@@ -49,6 +52,20 @@ class ViewController: NSViewController, NSTextViewDelegate {
         textView!.lnv_textDidChange(NSNotification.init(name: NSTextDidChangeNotification, object: nil))
     }
 
+    // MARK: Internal Methods
+    
+    /**
+    Get the line number, column and the character for the position in the given string.
+    
+    - parameters:
+    - string: The JSON string that is in the textview.
+    - position: the location where the error is.
+    
+    - returns:
+    - character: the string that was causing the issue.
+    - line: the linenumber where the error was.
+    - column: the column where the error was.
+    */
     func characterRowAndLineAt(string: String,position: Int) -> (character: String, line: Int, column:Int) {
         var lineNumber = 0
         var characterPosition = 0
@@ -70,9 +87,13 @@ class ViewController: NSViewController, NSTextViewDelegate {
         return ("", 0,0)
     }
 
+    /**
+    Handle Error message that is provided by the JSON helper and extract the message and showing them accordingly.
 
+    - parameters:
+    - error: NSError that was provided.
+    */
     func handleError(error: NSError?) {
-        let alert: NSAlert = NSAlert.init(error: error!)
         if let _ = error!.userInfo["debugDescription"] as? String? {
             let message: String = error!.userInfo["NSDebugDescription"]! as! String
             let numbers: [String] = message.componentsSeparatedByCharactersInSet(NSCharacterSet.decimalDigitCharacterSet().invertedSet)
@@ -91,22 +112,41 @@ class ViewController: NSViewController, NSTextViewDelegate {
                 invalidJSONError(message)
             }
         }
-        alert.runModal()
     }
 
+    ///MARK: Resetting and showing error messages
+    
+    /**
+    Reset the whole error view with no image and message.
+    */
     func resetErrorImage() {
         errorImageView?.image = nil
         messageLabel?.stringValue = ""
     }
 
+    /**
+    Show that the JSON is fine with proper icon.
+    */
     func correctJSONMessage() {
         errorImageView?.image = NSImage.init(named: "success")
         messageLabel?.stringValue = "Valid JSON!"
     }
 
+    /**
+    Show the invalid JSON error with proper error and message.
+    
+    - parameters:
+    - message: Error message that is to be shown.
+    */
     func invalidJSONError(message: String) {
-         errorImageView?.image = NSImage.init(named: "failure")
+        errorImageView?.image = NSImage.init(named: "failure")
         messageLabel?.stringValue = message
     }
+    
+    //MARK: TextView Delegate
+    func textDidChange(notification: NSNotification) {
+        format(textView)
+    }
+    
 }
 

SwiftyJSONAccelerator/SJTextView.swift

@@ -8,6 +8,7 @@
 
 import Cocoa
 
+/// A textview customization to handle formatting and handling removal of quotes.
 class SJTextView: NSTextView {
 
     override init(frame frameRect: NSRect, textContainer container: NSTextContainer?) {