release/v0.6.0

Author: xiaoxinghu

README.org

@@ -24,7 +24,7 @@
     let doc = try parser.parse(lines: lines)
   #+END_SRC
 
-* Supported Syntax (so far) [15/18]
+* Supported Syntax (so far) [16/19]
 ** DONE Affiliated Keywords (aka In Buffer Settings)
    CLOSED: [2016-09-03 Sat 12:47]
 
@@ -70,6 +70,20 @@
      ,* Section with multiple tags                                 :tag1:tag2:tag3:
    #+END_SRC
 
+** DONE Planning
+   CLOSED: [2017-01-09 Mon 16:09]
+
+   #+BEGIN_SRC org
+     ,* DONE Closed task
+       CLOSED: [2017-01-09 Mon 15:58]
+
+     ,* Scheduled task
+       SCHEDULED: <2017-01-09 Mon>
+
+     ,* TODO task that has a deadline
+       DEADLINE: <2017-01-16 Mon +1w>
+   #+END_SRC
+
 ** DONE Paragraph
    CLOSED: [2016-09-03 Sat 12:47]
    Lines without *line breaker* becomes a *paragraph*.

Sources/Constants.swift

@@ -0,0 +1,23 @@
+//
+//  Constants.swift
+//  SwiftOrg
+//
+//  Created by Xiaoxing Hu on 9/01/17.
+//  Copyright © 2017 Xiaoxing Hu. All rights reserved.
+//
+
+import Foundation
+
+public enum PlanningKeyword: String {
+    case deadline = "DEADLINE"
+    case scheduled = "SCHEDULED"
+    case closed = "CLOSED"
+    
+    static let all = [deadline.rawValue, scheduled.rawValue, closed.rawValue]
+}
+
+public enum Priority: String {
+    case A = "A"
+    case B = "B"
+    case C = "C"
+}

Sources/Info-iOS.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.5.1</string>
+	<string>0.6.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

Sources/Info-macOS.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.5.1</string>
+	<string>0.6.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>

Sources/JsonConverter.swift

@@ -61,6 +61,18 @@ func toDict(_ node: Node) -> [String: Any] {
         json["label"] = footnote.label
         json["content"] = footnote.content.map { n in toDict(n) }
     }
+    if let planning = node as? Planning {
+        json["type"] = "planning"
+        json["keyword"] = planning.keyword.rawValue
+        // TODO: jsonfiy timestamp
+//        if let timestamp = planning.timestamp {
+//            var ts = [String: Any]()
+//            ts["active"] = timestamp.active
+//            ts["date"] = timestamp.date
+//            ts["repeater"] = timestamp.repeater
+//            json["timestamp"] = ts
+//        }
+    }
     return json
 }
 

Sources/Node.swift

@@ -83,6 +83,9 @@ extension OrgParser {
             return try parseDrawer()
         case .listItem:
             return try parseList()
+        case .planning(let keyword, let timestamp):
+            _ = tokens.dequeue()
+            return Planning(keyword: keyword, timestamp: timestamp)
         default:
             throw Errors.unexpectedToken("\(token) is not expected")
         }

Sources/Regex.swift

@@ -10,7 +10,14 @@ import Foundation
 
 var expressions = [String: NSRegularExpression]()
 public extension String {
-    func getExpression(_ regex: String, options: NSRegularExpression.Options) -> NSRegularExpression {
+    
+    /// Cache regex (for performance and resource sake)
+    ///
+    /// - Parameters:
+    ///   - regex: regex pattern
+    ///   - options: options
+    /// - Returns: the regex
+    private func getExpression(_ regex: String, options: NSRegularExpression.Options) -> NSRegularExpression {
         let expression: NSRegularExpression
         if let exists = expressions[regex] {
             expression = exists
@@ -21,7 +28,7 @@ public extension String {
         return expression
     }
 
-    func getMatches(_ match: NSTextCheckingResult) -> [String?] {
+    private func getMatches(_ match: NSTextCheckingResult) -> [String?] {
         var matches = [String?]()
         switch match.numberOfRanges {
         case 0:

Sources/Section.swift

@@ -8,20 +8,17 @@
 
 import Foundation
 
-
 public struct Section: Node {
-    public enum Priority: String {
-        case A = "A"
-        case B = "B"
-        case C = "C"
-    }
 
+    // MARK: properties
     public var index: OrgIndex?
 
     public var title: String?
     public var stars: Int
     public var keyword: String?
     public var priority: Priority?
+    public var tags: [String]?
+    public var content = [Node]()
 
     public var drawers: [Drawer]? {
         let ds = content.filter { node in
@@ -31,10 +28,12 @@ public struct Section: Node {
         }
         return ds
     }
-    public var tags: [String]?
 
-    public var content = [Node]()
+    public var planning: Planning? {
+        return content.first { $0 is Planning } as? Planning
+    }
 
+    // MARK: func
     public init(stars l: Int, title t: String?, todos: [String]) {
         stars = l
         // TODO limit charset on tags
@@ -58,6 +57,15 @@ public struct Section: Node {
     }
 }
 
+public struct Planning: Node {
+    public let keyword: PlanningKeyword
+    public let timestamp: Timestamp?
+    
+    public var description: String {
+        return "Planning(keyword: \(keyword), timestamp: \(timestamp))"
+    }
+}
+
 extension OrgParser {    
     func parseSection(_ index: OrgIndex) throws -> Node? {
         skipBlanks() // in a section, you don't care about blanks

Sources/Timestamp.swift

@@ -0,0 +1,46 @@
+//
+//  Timestamp.swift
+//  SwiftOrg
+//
+//  Created by Xiaoxing Hu on 8/01/17.
+//  Copyright © 2017 Xiaoxing Hu. All rights reserved.
+//
+
+import Foundation
+
+public struct Timestamp {
+    public let active: Bool
+    public let date: Date
+    public let repeater: String?
+    
+    static func from(string: String) -> Timestamp? {
+        let markPattern = "\\+|\\+\\+|\\.\\+|-|--"
+        let pattern = "^(<|\\[)(.+?)(?: (\(markPattern))(\\d+)([hdwmy])\\s*)?(>|])$"
+        guard let m = string.trimmed.match(pattern) else {
+            print("'\(string)' doesn't match.")
+            return nil
+        }
+        
+        print("match: \(m)")
+        
+        let formater = DateFormatter()
+        let formats = [
+            "yyyy-MM-dd EEE H:mm",
+            "yyyy-MM-dd EEE",
+        ]
+        
+        for format in formats {
+            formater.dateFormat = format
+            guard let date = formater.date(from: m[2]!) else { continue }
+            let active = m[1]! == "<"
+            
+            var repeater: String? = nil
+            if let mark = m[3], let value = m[4], let unit = m[5] {
+                repeater = "\(mark)\(value)\(unit)"
+            }
+            let timestamp = Timestamp(active: active, date: date, repeater: repeater)
+            return timestamp
+        }
+        return nil
+    }
+}

Sources/Tokens.swift

@@ -17,6 +17,7 @@ public struct TokenMeta {
 public enum Token {
     case setting(key: String, value: String?)
     case headline(stars: Int, text: String?)
+    case planning(keyword: PlanningKeyword, timestamp: Timestamp?)
     case blank
     case horizontalRule
     case blockBegin(name: String, params: [String]?)
@@ -104,6 +105,10 @@ func defineTokens() {
     define("^(\\*+)\\s+(.*)$") { matches in
         .headline(stars: matches[1]!.characters.count, text: matches[2]) }
 
+    define("^\\s*(\(PlanningKeyword.all.joined(separator: "|"))):\\s+(.+)$") { matches in
+        let timestamp = Timestamp.from(string: matches[2]!)
+        return .planning(keyword: PlanningKeyword(rawValue: matches[1]!)!, timestamp: timestamp)
+    }
     // Block
     define("^(\\s*)#\\+begin_([a-z]+)(?:\\s+(.*))?$",
            options: [.caseInsensitive])