test/automated/map-tests.el

   1 ;;; map-tests.el --- Tests for map.el
   2
   3 ;; Copyright (C) 2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Nicolas Petton <nicolas@petton.fr>
   6 ;; Maintainer: emacs-devel@gnu.org
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;; Tests for map.el
  26
  27 ;;; Code:
  28
  29 (require 'ert)
  30 (require 'map)
  31
  32 (defmacro with-maps-do (var &rest body)
  33   "Successively bind VAR to an alist, vector and hash-table.
  34 Each map is built from the following alist data:
  35 '((0 . 3) (1 . 4) (2 . 5)).
  36 Evaluate BODY for each created map.
  37
  38 \(fn (var map) body)"
  39   (declare (indent 1) (debug t))
  40   (let ((alist (make-symbol "alist"))
  41         (vec (make-symbol "vec"))
  42         (ht (make-symbol "ht")))
  43    `(let ((,alist '((0 . 3)
  44                     (1 . 4)
  45                     (2 . 5)))
  46           (,vec (make-vector 3 nil))
  47           (,ht (make-hash-table)))
  48       (aset ,vec 0 '3)
  49       (aset ,vec 1 '4)
  50       (aset ,vec 2 '5)
  51       (puthash '0 3 ,ht)
  52       (puthash '1 4 ,ht)
  53       (puthash '2 5 ,ht)
  54       (dolist (,var (list ,alist ,vec ,ht))
  55         ,@body))))
  56
  57 (ert-deftest test-map-elt ()
  58   (with-maps-do map
  59     (should (= 3 (map-elt map 0)))
  60     (should (= 4 (map-elt map 1)))
  61     (should (= 5 (map-elt map 2)))
  62     (should (null (map-elt map -1)))
  63     (should (null (map-elt map 4)))))
  64
  65 (ert-deftest test-map-elt-default ()
  66   (with-maps-do map
  67     (should (= 5 (map-elt map 7 5)))))
  68
  69 (ert-deftest test-map-elt-with-nil-value ()
  70   (should (null (map-elt '((a . 1)
  71                            (b))
  72                          'b
  73                          '2))))
  74
  75 (ert-deftest test-map-put ()
  76   (with-maps-do map
  77     (map-put map 2 'hello)
  78     (should (eq (map-elt map 2) 'hello)))
  79   (let ((ht (make-hash-table)))
  80     (map-put ht 2 'a)
  81     (should (eq (map-elt ht 2)
  82                 'a)))
  83   (let ((alist '((0 . a) (1 . b) (2 . c))))
  84     (map-put alist 2 'a)
  85     (should (eq (map-elt alist 2)
  86                 'a)))
  87   (let ((vec [3 4 5]))
  88    (should-error (map-put vec 3 6))))
  89
  90 (ert-deftest test-map-put-literal ()
  91   (should (= (map-elt (map-put [1 2 3] 1 4) 1)
  92              4))
  93   (should (= (map-elt (map-put (make-hash-table) 'a 2) 'a)
  94              2))
  95   (should-error (map-put '((a . 1)) 'b 2))
  96   (should-error (map-put '() 'a 1)))
  97
  98 (ert-deftest test-map-put-return-value ()
  99   (let ((ht (make-hash-table)))
 100     (should (eq (map-put ht 'a 'hello) ht))))
 101
 102 (ert-deftest test-map-delete ()
 103   (with-maps-do map
 104     (map-delete map 1)
 105     (should (null (map-elt map 1))))
 106   (with-maps-do map
 107     (map-delete map -2)
 108     (should (null (map-elt map -2)))))
 109
 110 (ert-deftest test-map-delete-return-value ()
 111   (let ((ht (make-hash-table)))
 112     (should (eq (map-delete ht 'a) ht))))
 113
 114 (ert-deftest test-map-nested-elt ()
 115   (let ((vec [a b [c d [e f]]]))
 116     (should (eq (map-nested-elt vec '(2 2 0)) 'e)))
 117   (let ((alist '((a . 1)
 118                  (b . ((c . 2)
 119                        (d . 3)
 120                        (e . ((f . 4)
 121                              (g . 5))))))))
 122     (should (eq (map-nested-elt alist '(b e f))
 123                 4)))
 124   (let ((ht (make-hash-table)))
 125     (map-put ht 'a 1)
 126     (map-put ht 'b (make-hash-table))
 127     (map-put (map-elt ht 'b) 'c 2)
 128     (should (eq (map-nested-elt ht '(b c))
 129                 2))))
 130
 131 (ert-deftest test-map-nested-elt-default ()
 132   (let ((vec [a b [c d]]))
 133     (should (null (map-nested-elt vec '(2 3))))
 134     (should (null (map-nested-elt vec '(2 1 1))))
 135     (should (= 4 (map-nested-elt vec '(2 1 1) 4)))))
 136
 137 (ert-deftest test-map-p ()
 138   (should (map-p nil))
 139   (should (map-p '((a . b) (c . d))))
 140   (should (map-p '(a b c d)))
 141   (should (map-p []))
 142   (should (map-p [1 2 3]))
 143   (should (map-p (make-hash-table)))
 144   (should (map-p "hello"))
 145   (should (not (map-p 1)))
 146   (should (not (map-p 'hello))))
 147
 148 (ert-deftest test-map-keys ()
 149   (with-maps-do map
 150     (should (equal (map-keys map) '(0 1 2))))
 151   (should (null (map-keys nil)))
 152   (should (null (map-keys []))))
 153
 154 (ert-deftest test-map-values ()
 155   (with-maps-do map
 156     (should (equal (map-values map) '(3 4 5)))))
 157
 158 (ert-deftest test-map-pairs ()
 159   (with-maps-do map
 160     (should (equal (map-pairs map) '((0 . 3)
 161                                      (1 . 4)
 162                                      (2 . 5))))))
 163
 164 (ert-deftest test-map-length ()
 165   (let ((ht (make-hash-table)))
 166     (puthash 'a 1 ht)
 167     (puthash 'b 2 ht)
 168     (puthash 'c 3 ht)
 169     (puthash 'd 4 ht)
 170     (should (= 0 (map-length nil)))
 171     (should (= 0 (map-length [])))
 172     (should (= 0 (map-length (make-hash-table))))
 173     (should (= 5 (map-length [0 1 2 3 4])))
 174     (should (= 2 (map-length '((a . 1) (b . 2)))))
 175     (should (= 4 (map-length ht)))))
 176
 177 (ert-deftest test-map-copy ()
 178   (with-maps-do map
 179     (let ((copy (map-copy map)))
 180       (should (equal (map-keys map) (map-keys copy)))
 181       (should (equal (map-values map) (map-values copy)))
 182       (should (not (eq map copy))))))
 183
 184 (ert-deftest test-map-apply ()
 185   (with-maps-do map
 186     (should (equal (map-apply (lambda (k v) (cons (int-to-string k) v))
 187                               map)
 188                    '(("0" . 3) ("1" . 4) ("2" . 5)))))
 189   (let ((vec [a b c]))
 190     (should (equal (map-apply (lambda (k v) (cons (1+ k) v))
 191                               vec)
 192                    '((1 . a)
 193                      (2 . b)
 194                      (3 . c))))))
 195
 196 (ert-deftest test-map-keys-apply ()
 197   (with-maps-do map
 198     (should (equal (map-keys-apply (lambda (k) (int-to-string k))
 199                                    map)
 200                    '("0" "1" "2"))))
 201   (let ((vec [a b c]))
 202     (should (equal (map-keys-apply (lambda (k) (1+ k))
 203                                    vec)
 204                    '(1 2 3)))))
 205
 206 (ert-deftest test-map-values-apply ()
 207   (with-maps-do map
 208     (should (equal (map-values-apply (lambda (v) (1+ v))
 209                                      map)
 210                    '(4 5 6))))
 211   (let ((vec [a b c]))
 212     (should (equal (map-values-apply (lambda (v) (symbol-name v))
 213                                      vec)
 214                    '("a" "b" "c")))))
 215
 216 (ert-deftest test-map-filter ()
 217   (with-maps-do map
 218     (should (equal (map-keys (map-filter (lambda (k v)
 219                                            (<= 4 v))
 220                                          map))
 221                    '(1 2)))
 222     (should (null (map-filter (lambda (k v)
 223                                 (eq 'd k))
 224                               map))))
 225   (should (null (map-filter (lambda (k v)
 226                               (eq 3 v))
 227                             [1 2 4 5])))
 228   (should (equal (map-filter (lambda (k v)
 229                                (eq 3 k))
 230                              [1 2 4 5])
 231                  '((3 . 5)))))
 232
 233 (ert-deftest test-map-remove ()
 234   (with-maps-do map
 235     (should (equal (map-keys (map-remove (lambda (k v)
 236                                            (>= v 4))
 237                                          map))
 238                    '(0)))
 239     (should (equal (map-keys (map-remove (lambda (k v)
 240                                            (eq 'd k))
 241                                          map))
 242                    (map-keys map))))
 243   (should (equal (map-remove (lambda (k v)
 244                                (eq 3 v))
 245                              [1 2 4 5])
 246                  '((0 . 1)
 247                    (1 . 2)
 248                    (2 . 4)
 249                    (3 . 5))))
 250   (should (null (map-remove (lambda (k v)
 251                               (>= k 0))
 252                             [1 2 4 5]))))
 253
 254 (ert-deftest test-map-empty-p ()
 255   (should (map-empty-p nil))
 256   (should (not (map-empty-p '((a . b) (c . d)))))
 257   (should (map-empty-p []))
 258   (should (not (map-empty-p [1 2 3])))
 259   (should (map-empty-p (make-hash-table)))
 260   (should (not (map-empty-p "hello")))
 261   (should (map-empty-p "")))
 262
 263 (ert-deftest test-map-contains-key-p ()
 264   (should (map-contains-key-p '((a . 1) (b . 2)) 'a))
 265   (should (not (map-contains-key-p '((a . 1) (b . 2)) 'c)))
 266   (should (map-contains-key-p '(("a" . 1)) "a"))
 267   (should (not (map-contains-key-p '(("a" . 1)) "a" #'eq)))
 268   (should (map-contains-key-p [a b c] 2))
 269   (should (not (map-contains-key-p [a b c] 3))))
 270
 271 (ert-deftest test-map-some-p ()
 272   (with-maps-do map
 273     (should (equal (map-some-p (lambda (k v)
 274                                  (eq 1 k))
 275                                map)
 276                    (cons 1 4)))
 277     (should (not (map-some-p (lambda (k v)
 278                                (eq 'd k))
 279                              map))))
 280   (let ((vec [a b c]))
 281     (should (equal (map-some-p (lambda (k v)
 282                                  (> k 1))
 283                                vec)
 284                    (cons 2 'c)))
 285     (should (not (map-some-p (lambda (k v)
 286                                (> k 3))
 287                              vec)))))
 288
 289 (ert-deftest test-map-every-p ()
 290   (with-maps-do map
 291     (should (map-every-p (lambda (k v)
 292                            k)
 293                          map))
 294     (should (not (map-every-p (lambda (k v)
 295                                 nil)
 296                               map))))
 297   (let ((vec [a b c]))
 298     (should (map-every-p (lambda (k v)
 299                            (>= k 0))
 300                          vec))
 301     (should (not (map-every-p (lambda (k v)
 302                                 (> k 3))
 303                               vec)))))
 304
 305 (ert-deftest test-map-into ()
 306   (let* ((alist '((a . 1) (b . 2)))
 307          (ht (map-into alist 'hash-table)))
 308     (should (hash-table-p ht))
 309     (should (equal (map-into (map-into alist 'hash-table) 'list)
 310                    alist))
 311     (should (listp (map-into ht 'list)))
 312     (should (equal (map-keys (map-into (map-into ht 'list) 'hash-table))
 313                    (map-keys ht)))
 314     (should (equal (map-values (map-into (map-into ht 'list) 'hash-table))
 315                    (map-values ht)))
 316     (should (null (map-into nil 'list)))
 317     (should (map-empty-p (map-into nil 'hash-table)))
 318     (should-error (map-into [1 2 3] 'string))))
 319
 320 (ert-deftest test-map-let ()
 321   (map-let (foo bar baz) '((foo . 1) (bar . 2))
 322     (should (= foo 1))
 323     (should (= bar 2))
 324     (should (null baz)))
 325   (map-let (('foo a)
 326             ('bar b)
 327             ('baz c)) '((foo . 1) (bar . 2))
 328     (should (= a 1))
 329     (should (= b 2))
 330     (should (null c))))
 331
 332 (provide 'map-tests)
 333 ;;; map-tests.el ends here