hackerbase/member2-record.scm

;;
;; member2-record.scm
;;
;; Procedures working with complete member record (as loaded by the
;; members-base).
;;
;; ISC License
;;
;; Copyright 2023 Brmlab, z.s.
;; Dominik Pantůček <dominik.pantucek@trustica.cz>
;;
;; Permission to use, copy, modify, and/or distribute this software
;; for any purpose with or without fee is hereby granted, provided
;; that the above copyright notice and this permission notice appear
;; in all copies.
;; 
;; THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
;; WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
;; WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
;; AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
;; CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
;; OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
;; NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
;; CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
;;

(declare (unit member2-record))

(module
 member2-record
 (
  make-member-record

  member-record-input-file

  member-record-set
  member-record-add-highlight
  member-record-sub-ref
  member-record-sub-set
  member-record-sub-prepend

  member-record-info

  member-destroyed?
  member-suspended?
  member-active?
  member-student?
  member-existing?

  member-record-tests!
  )

 (import scheme
	 (chicken base)
	 (chicken keyword)
	 dictionary
	 testing
	 month
	 period
	 configuration)

 ;; Creates new member record based on the file and symlinks
 ;; information received from the members directory. Any keyword
 ;; arguments are converted to respective symbols in the dictionary.
 (define (make-member-record file-name file-path symlinks . args)
   (let loop ((args args)
	      (pairs `((file-name . ,file-name)
		       (file-path . ,file-path)
		       (symlinks . ,symlinks))))
     (if (null? args)
	 (make-dict pairs)
	 (if (not (keyword? (car args)))
	     (error 'make-member-record "Optional arguments must be keywords" (car args))
	     (if (null? (cdr args))
		 (error 'make-member-record "Each optional keyword argument must have a value" (car args))
		 (loop (cddr args)
		       (cons (cons (string->symbol (keyword->string (car args)))
				   (cadr args))
			     pairs)))))))

 ;; Returns opened input file for this record (used by parser).
 (define (member-record-input-file mr)
   (open-input-file
    (dict-ref mr 'file-path)))

 ;; Sets pairs of keys/values for given member record.
 (define (member-record-set mr . args)
   (let loop ((args args)
	      (mr mr))
     (if (null? args)
	 mr
	 (if (not (keyword? (car args)))
	     (error 'member-record-set "Needs argument keyword" (car args))
	     (if (null? (cdr args))
		 (error 'member-record-set "Argument needs value" (car args))
		 (loop (cddr args)
		       (dict-set mr (string->symbol (keyword->string (car args)))
				 (cadr args))))))))

 ;; Adds highlight identified by line number, message, pass number and
 ;; type (error, warning, info).
 (define (member-record-add-highlight mr line-number message pass type)
   (dict-set mr 'highlights
	     (cons (list line-number message pass type)
		   (dict-ref mr 'highlights '()))))

 ;; Returns a key from particular section
 (define (member-record-sub-ref mr sec key . defaults)
   (let ((sec-dict (dict-ref mr sec)))
     (if (null? defaults)
	 (dict-ref sec-dict key)
	 (dict-ref sec-dict key (car defaults)))))

 ;; Sets a key in particular section
 (define (member-record-sub-set mr sec key val)
   (let ((sec-dict (dict-ref mr sec)))
     (dict-set mr sec
	       (dict-set sec-dict key val))))

 ;; Prepends value to given subkey
 (define (member-record-sub-prepend mr sec key val)
   (member-record-sub-set mr sec key
			  (cons val
				(member-record-sub-ref mr sec key '()))))

 ;; Returns member info key value
 (define (member-record-info mr key . defaults)
   (let ((info (dict-ref mr 'info)))
     (if (null? defaults)
	 (dict-ref info key)
	 (dict-ref info key (car defaults)))))

 ;; Returns true if the member record represents destroyed member. The
 ;; *current-month* is a global parameter from period module.
 (define (member-destroyed? mr)
   (let ((destroyed (member-record-info mr 'destroyed #f)))
     (and destroyed
	  (month<? (string->month destroyed)
		   (*current-month*)))))

 ;; Generic period-based predicate
 (define ((member-period-predicate? key) mr)
   (let ((periods (member-record-info mr key #f)))
     (and periods
	  (month-in-periods? periods))))

 ;; Returns true if the member is now suspended
 (define member-is-suspended?
   (member-period-predicate? 'suspend))

 ;; Suspended must not be destroyed
 (define (member-suspended? mr)
   (and (member-is-suspended? mr)
	(not (member-destroyed? mr))))

 ;; True if the member is student
 (define member-is-student?
   (member-period-predicate? 'student))

 ;; Only active members can be students.
 (define (member-student? mr)
   (and (member-active? mr)
	(member-is-student? mr)))

 ;; Returns true if the member is active (not suspended or destroyed).
 (define (member-active? mr)
   (and (not (member-destroyed? mr))
	(not (member-suspended? mr))))

 ;; Returns true if the member has joined.
 (define (member-existing? mr)
   (let ((joined (member-record-info mr 'joined)))
     (and joined
	  (month<=? joined (*current-month*)))))

 ;; Self-tests
 (define (member-record-tests!)
   (run-tests
    member-record
    (test-equal? make-member-record
		 (make-member-record "1234" "members/1234" '("member"))
		 '((file-name . "1234")
		   (file-path . "members/1234")
		   (symlinks "member")))
    (test-equal? make-member-record
		 (make-member-record "1234" "members/1234" '("member") #:id 1234)
		 '((id . 1234)
		   (file-name . "1234")
		   (file-path . "members/1234")
		   (symlinks "member")))
    (test-equal? member-record-set
		 (member-record-set '() #:id 1234)
		 '((id . 1234)))
    (test-equal? member-record-add-highlight
		 (member-record-add-highlight '() 123 "Interesting..." 0 'info)
		 '((highlights . ((123 "Interesting..." 0 info)))))
    ))

 )

(import member2-record)

(member-record-tests!)