Merge pull request kidd#192 from telotortium/pr-179

Adopt kidd#179, merging current master into this and fixing tests.

- Move to beginning of line everywhere before running `org-element-headline-parser`.
- Prevent archiving in a cycle.

Fix kidd#172

.github/workflows/main.yml

@@ -39,3 +39,10 @@ jobs:
 
     - name: Test
       run: make test
+
+    - name: SSH into container on failure
+      if: ${{ failure() }}
+      uses: lhotari/action-upterm@v1
+      with:
+        ## limits ssh access and adds the ssh public key for the user which triggered the workflow
+        limit-access-to-actor: true

.gitignore

@@ -2,3 +2,5 @@
 .load-path.el
 .cask
 build.log
+
+flycheck_*.el

Cask

@@ -5,4 +5,5 @@
 
 (development
   (depends-on "el-mock")
-  (depends-on "ert-runner"))
+  (depends-on "ert-runner")
+  (depends-on "load-relative"))

Makefile

@@ -1,3 +1,4 @@
+THIS_MAKEFILE_DIR = $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
 EMACS ?= emacs
 SRC=org-gcal.el org-generic-id.el
 TEST=test/org-gcal-test.el test/org-generic-id-test.el
@@ -24,4 +25,5 @@ compile: $(SRC) elpa
 	! ( grep -E -e ':(Warning|Error):' $(BUILD_LOG) )
 
 test: $(SRC) $(TEST) elpa
-	$(CASK) exec ert-runner -L . -L test/
+	$(CASK) exec ert-runner -L $(THIS_MAKEFILE_DIR) \
+		$(foreach test,$(TEST),$(addprefix $(THIS_MAKEFILE_DIR)/,$(test)))

org-gcal.el

@@ -1486,25 +1486,35 @@ delete calendar info from events on calendars you no longer have access to."
   (save-excursion
     (goto-char (point-min))
     (while (re-search-forward org-heading-regexp nil t)
-      (condition-case nil
-          (goto-char (cdr (org-gcal--timestamp-successor)))
-        (error (error "Org-gcal error: Couldn't parse %s"
-                      (buffer-file-name))))
-      (let ((elem (org-element-headline-parser (point-max) t))
-            (tobj (cadr (org-element-timestamp-parser))))
-        (when (>
-               (time-to-seconds (time-subtract (current-time) (days-to-time org-gcal-up-days)))
-               (time-to-seconds (encode-time 0  (if (plist-get tobj :minute-end)
-                                                    (plist-get tobj :minute-end) 0)
-                                             (if (plist-get tobj :hour-end)
-                                                 (plist-get tobj :hour-end) 24)
-                                             (plist-get tobj :day-end)
-                                             (plist-get tobj :month-end)
-                                             (plist-get tobj :year-end))))
-          (org-gcal--notify "Archived event." (org-element-property :title elem))
-          (let ((kill-ring kill-ring)
-                (select-enable-clipboard nil))
-            (org-archive-subtree)))))
+      (let ((properties (org-entry-properties)))
+        ; Check if headline is managed by `org-gcal', and hasn't been archived
+        ; yet. Only in that case, potentially archive.
+        (when (and (assoc "ORG-GCAL-MANAGED" properties)
+                     (not (assoc "ARCHIVE_TIME" properties)))
+
+          ; Go to beginning of line to parse the headline
+          (beginning-of-line)
+          (let ((elem (org-element-headline-parser (point-max) t)))
+
+            ; Go to next timestamp to parse it
+            (condition-case nil
+                (goto-char (cdr (org-gcal--timestamp-successor)))
+              (error (error "Org-gcal error: Couldn't parse %s"
+                            (buffer-file-name))))
+            (let ((tobj (cadr (org-element-timestamp-parser))))
+              (when (>
+                     (time-to-seconds (time-subtract (current-time) (days-to-time org-gcal-up-days)))
+                     (time-to-seconds (encode-time 0 (if (plist-get tobj :minute-end)
+                                                         (plist-get tobj :minute-end) 0)
+                                                   (if (plist-get tobj :hour-end)
+                                                       (plist-get tobj :hour-end) 24)
+                                                   (plist-get tobj :day-end)
+                                                   (plist-get tobj :month-end)
+                                                   (plist-get tobj :year-end))))
+                (org-gcal--notify "Archived event." (org-element-property :title elem))
+                (let ((kill-ring kill-ring)
+                      (select-enable-clipboard nil))
+                  (org-archive-subtree))))))))
     (save-buffer)))
 
 (defun org-gcal--save-sexp (data file)

test/org-gcal-test.el

@@ -1,7 +1,7 @@
 ;;; org-gcal-test.el --- Tests for org-gcal.el -*- lexical-binding: t -*-
 
 ;; Copyright (C) 2019 Robert Irelan
-;; Package-Requires: ((org-gcal) (el-mock) (emacs "26"))
+;; Package-Requires: ((org-gcal) (el-mock) (emacs "26") (load-relative "1.3"))
 
 ;; Author: Robert Irelan <[email protected]>
 
@@ -29,6 +29,9 @@
 (require 'org-gcal)
 (require 'cl-lib)
 (require 'el-mock)
+(require 'load-relative)
+(unless (featurep 'org-test)
+  (load-relative "org-test"))
 
 (defconst org-gcal-test-calendar-id "[email protected]")
 
@@ -1224,6 +1227,52 @@ Second paragraph
   ;;          "2021-03-04T03:30:00+0800"))
 
 
+(ert-deftest org-gcal-test--headline-archive-old-event ()
+  "Check that `org-gcal--archive-old-event' parses headlines correctly.
+Regression test for https://github.com/kidd/org-gcal.el/issues/172 .
+
+Also tests that the `org-gcal--archive-old-event' function does
+not loop over and over, archiving the same entry because it is
+under another heading in the same file."
+  (let ((org-archive-location "::* Archived")  ; Make the archive this same buffer
+        (test-time "2022-01-30 Sun 01:23")
+        (buf "\
+#+CATEGORY: Test
+
+* Event Title
+:PROPERTIES:
+:org-gcal-managed: something
+:END:
+<2021-01-01 Fri 12:34-14:35>
+"))
+    (org-test-with-temp-text-in-file
+        buf
+      (org-test-at-time (format "<%s>" test-time)
+        ;; Ensure property drawer is not indented
+        (setq-local org-adapt-indentation nil)
+        (let* ((target-buf (format "\
+#+CATEGORY: Test
+
+* Archived
+
+** Event Title
+:PROPERTIES:
+:org-gcal-managed: something
+:ARCHIVE_TIME: %s
+:ARCHIVE_FILE: %s
+:ARCHIVE_CATEGORY: Test
+:END:
+<2021-01-01 Fri 12:34-14:35>
+"
+                                   test-time
+                                   ; The variable `file' is the current file
+                                   ; name under the macro
+                                   ; `org-test-with-temp-text-in-file'
+                                   file)))
+          (org-gcal--archive-old-event)
+          (let ((bufstr
+                 (buffer-substring-no-properties (point-min) (point-max))))
+            (should (string-equal bufstr target-buf))))))))
 
 ;;; TODO: Figure out mocking for POST/PATCH followed by GET
 ;;; - ‘mock‘ might work for this - the argument list must be specified up