feat: Allow user to limit new cards shown daily

org-fc-core.el

@@ -596,6 +596,7 @@ element."
       :id (plist-get card :id)
       :type (plist-get card :type)
       :due (plist-get pos :due)
+      :box (plist-get pos :box)
       :position (plist-get pos :position)))
    (plist-get card :positions)))
 
@@ -643,6 +644,10 @@ Positions are shuffled in a way that preserves the order of the
      #'cdr
      (sort positions (lambda (a b) (> (car a) (car b)))))))
 
+(defun org-fc-position-new-p (pos)
+  "Return t if the provided POS ition is new; nil otherwise."
+  (eq -1 (plist-get pos :box)))
+
 ;;; Demo Mode
 
 ;;;###autoload

org-fc-review.el

@@ -36,6 +36,7 @@
 ;;; Code:
 
 (require 'eieio)
+(require 'dash)
 
 (require 'org-fc-core)
 
@@ -79,6 +80,26 @@ Used to calculate the time needed for reviewing a card.")
   "Track if the current buffer was open before the review.")
 (make-variable-buffer-local 'org-fc-reviewing-existing-buffer)
 
+(defcustom org-fc-review-new-limit -1
+  "Limits the number of new positions shown per `org-fc-review-new-limit-schedule'. Resets at midnight.
+
+-1 for unlimited."
+  :type 'integer
+  :group 'org-fc)
+
+(defcustom org-fc-review-new-limit-schedule 'session
+  "The schedule at which to limit the inclusion of new positions. "
+  :type '(choice (const session)
+                 (const day))
+  :group 'org-fc)
+
+(defvar org-fc-review-new-limit--new-seen-today -1
+  "Remaining new cards for today's reviews.
+Don't access directly! Use `org-fc-review-new-limit--get-remaining'.")
+
+(defvar org-fc-review-new-limit--reset-day nil
+  "The day number on which we should reset `org-fc-review-new-limit--new-seen-today'.")
+
 ;;; Main Review Functions
 
 ;;;###autoload
@@ -94,15 +115,28 @@ Valid contexts:
       (when (yes-or-no-p "Flashcards are already being reviewed. Resume? ")
         (org-fc-review-resume))
     (let* ((index (org-fc-index context))
-           (cards (org-fc-index-filter-due index)))
-      (if org-fc-shuffle-positions
-          (setq cards (org-fc-index-shuffled-positions cards))
-        (setq cards (org-fc-index-positions cards)))
-      (if (null cards)
-          (message "No cards due right now")
+           (cards (org-fc-index-filter-due index))
+           (positions (if org-fc-shuffle-positions
+                          (org-fc-index-shuffled-positions cards)
+                        (org-fc-index-positions cards)))
+           (positions-limited-new (if (> org-fc-review-new-limit 0)
+                                      (let ((remaining-new (org-fc-review-new-limit--get-remaining)))
+                                        (cl-remove-if
+                                         (lambda (pos)
+                                           (cond
+                                            ((org-fc-position-new-p pos)
+                                             (when (>= remaining-new 0)
+                                               (cl-decf remaining-new))
+                                             (< remaining-new 0))
+                                            (t
+                                             nil)))
+                                         positions))
+                                    positions)))
+      (if (null positions-limited-new)
+          (message "No positions due right now")
         (progn
           (setq org-fc-review--session
-                (org-fc-make-review-session cards))
+                (org-fc-make-review-session positions-limited-new))
           (run-hooks 'org-fc-before-review-hook)
           (org-fc-review-next-card))))))
 
@@ -573,6 +607,27 @@ removed."
     (unless (and (derived-mode-p 'org-mode) org-fc-review--session)
       (org-fc-review-edit-mode -1))))
 
+
+;;;; Daily limit
+
+(defun org-fc-review-new-limit--get-remaining ()
+  "Return the remaining new cards for the `org-fc-review-new-card-schedule'."
+  (when (and org-fc-review-new-limit
+             (> org-fc-review-new-limit 0))
+    (cond
+     ((eq 'session
+          org-fc-review-new-limit-schedule)
+      org-fc-review-new-limit)
+     ((eq 'day
+          org-fc-review-new-limit-schedule)
+      (let ((current-day (time-to-days (current-time))))
+        (when (or (not org-fc-review-new-limit--reset-day)
+                  (= org-fc-review-new-limit--reset-day current-day))
+          (setq org-fc-review-new-limit--reset-day (1+ current-day)
+                org-fc-review-new-limit--new-seen-today 0))
+        (- org-fc-review-new-limit
+           org-fc-review-new-limit--new-seen-today))))))
+
 ;;; Footer
 
 (provide 'org-fc-review)