cider-clojuredocs-tests.el

;;; cider-clojuredocs-tests.el  -*- lexical-binding: t; -*-

;; Copyright © 2012-2024 Tim King, Bozhidar Batsov

;; Author: Tim King <kingtim@gmail.com>
;;         Bozhidar Batsov <bozhidar@batsov.dev>
;;         Artur Malabarba <bruce.connor.am@gmail.com>

;; This file is NOT part of GNU Emacs.

;; This program is free software: you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see `http://www.gnu.org/licenses/'.

;;; Commentary:

;; This file is part of CIDER

;;; Code:

(require 'buttercup)
(require 'cider-clojuredocs)

;; Please, for each `describe', ensure there's an `it' block, so that its execution is visible in CI.

;;; clojuredocs tests

(describe "cider-clojuredocs-replace-special"
  (it "converts the input to a clojuredocs friendly format"
    (expect (cider-clojuredocs-replace-special "isa?") :to-equal "isa_q")
    (expect (cider-clojuredocs-replace-special "really-isa?") :to-equal "really-isa_q")
    (expect (cider-clojuredocs-replace-special "..") :to-equal "_..")
    (expect (cider-clojuredocs-replace-special ".") :to-equal "_.")
    (expect (cider-clojuredocs-replace-special "/") :to-equal "fs")
    ))

(describe "cider-clojuredocs-url"
  (it "creates a clojuredocs search URL"
    (expect (cider-clojuredocs-url "even?" "clojure.core") :to-equal "https://clojuredocs.org/clojure.core/even_q")
    (expect (cider-clojuredocs-url nil "clojure.core") :to-equal nil)
    (expect (cider-clojuredocs-url "even?" nil) :to-equal nil)))