Add tests for factories.

project.clj

@@ -3,7 +3,8 @@
   :url "https://gitlab.com/KKlochko/cipher-analytical-machine"
   :license {:name "LGPL"
             :url "http://www.gnu.org/licenses/lgpl-3.0.txt"}
-  :dependencies [[org.clojure/clojure "1.11.1"]]
+  :dependencies [[org.clojure/clojure "1.11.1"]
+                 [org.clojure/tools.cli "1.0.219"]]
   :main ^:skip-aot cipher-analytical-machine.core
   :target-path "target/%s"
   :profiles {:uberjar {:aot :all

src/cipher_analytical_machine/caesar.clj

@@ -0,0 +1,37 @@
+(ns cipher-analytical-machine.caesar
+  (:require [clojure.string :as cs])
+  (:gen-class))
+
+(defn calculate-char-index
+  "Calculate the index of a char."
+  [char symbols]
+  (cs/index-of symbols char))
+
+(defn encrypt-index
+  "Calculates new index of a character. Uses its index, the key and max-index (exclusive)."
+  [index key max-index]
+  (-> index
+       (+ key)
+       (mod max-index)))
+
+(defn encrypt-char
+  "Calculates new index of a character. Uses a char from symbols, the key and max-index (exclusive)."
+  [char key symbols max-index]
+  (get symbols
+       (-> char
+           (calculate-char-index symbols)
+           (encrypt-index key max-index))))
+
+(defn encrypt-message
+  "Encrypt a message using the Caesar cipher."
+  [message key symbols]
+  (let [max-index (count symbols)]
+    (cs/join
+     (map (fn [char] (encrypt-char char key symbols max-index))
+          message))))
+
+(defn decrypt-message
+  "Decrypt the ciphtext using the Caesar cipher."
+  [ciphertext key symbols]
+  (encrypt-message ciphertext (- key) symbols))
+

src/cipher_analytical_machine/cli.clj

@@ -0,0 +1,82 @@
+(ns cipher-analytical-machine.cli
+  (:require
+   [cipher-analytical-machine.caesar :as caesar]
+   [clojure.string :as cs]
+   [clojure.tools.cli :refer [parse-opts]])
+  (:gen-class))
+
+(def cipher-options
+  #{"Caesar"})
+
+(def cli-options
+  [["-m" "--message MESSAGE" "The message will be encrypted or decrypted."]
+   ["-k" "--key KEY" "The key will be used to encrypt or decrypt."]
+   ["-c" "--cipher CIPHER" "The cipher will be used to encrypt or decrypt a message."
+    :default "Caesar"]
+   ["-e" "--encrypt" "Encrypt the message."]
+   ["-d" "--decrypt" "Decrypt the message."]
+   ["-h" "--help"]])
+
+(defn usage [options-summary]
+  (->> ["This is cipher-analytical-machine. It can help you to learn how ciphers works."
+        ""
+        "Usage: cipher-analytical-machine [options]"
+        ""
+        "Options:"
+        options-summary
+        ""]
+       (cs/join \newline)))
+
+(defn error-msg [errors]
+  (str "The following errors occurred while parsing your command:\n\n"
+       (cs/join \newline errors)))
+
+(defn map-has-keys?
+  "Return true if all keys in the map."
+  [map keys]
+  (every? #(contains? map %) keys))
+
+(defn validate-args
+  "Validate command line arguments. Either return a map indicating the program
+  should exit (with an error message, and optional ok status), or a map
+  indicating the action the program should take and the options provided."
+  [args]
+  (let [{:keys [options arguments errors summary]} (parse-opts args cli-options)]
+    (cond
+      (:help options)
+      {:exit-message (usage summary) :ok? true}
+
+      errors
+      {:exit-message (error-msg errors)}
+
+      (map-has-keys? options [:encrypt, :decrypt])
+      {:exit-message (error-msg ["You can't use enctypt and decrypt mode at the same time!!!"])}
+
+      (and (map-has-keys? options [:cipher, :key])
+           (contains? options :message)
+           (or (contains? options :encrypt)
+               (contains? options :decrypt)))
+      {:options options :arguments arguments}
+
+      :else
+      {:exit-message (usage summary)})))
+
+(defn exit
+  [exit-message status]
+  (println exit-message)
+  (System/exit (if status 0 1)))
+
+(defn actions
+  [options arguments]
+  (println (str options arguments))
+  (let [message (:message options)
+        key (Integer/parseInt (:key options))
+        symbols "abc"]
+    (println
+     (cond
+       (contains? options :encrypt)
+       (caesar/encrypt-message message key symbols)
+
+       (contains? options :decrypt)
+       (caesar/decrypt-message message key symbols)))))
+

src/cipher_analytical_machine/core.clj

@@ -1,7 +1,12 @@
 (ns cipher-analytical-machine.core
+  (:require
+   [cipher-analytical-machine.cli :as cli])
   (:gen-class))
 
 (defn -main
-  "I don't do a whole lot ... yet."
   [& args]
-  (println "Hello, World!"))
+  (let [{:keys [options arguments exit-message ok?]} (cli/validate-args args)]
+    (if exit-message
+      (cli/exit exit-message ok?)
+      (cli/actions options arguments))))
+

src/cipher_analytical_machine/symbol_factories.clj

@@ -0,0 +1,34 @@
+(ns cipher-analytical-machine.symbol_factories
+  (:require [clojure.string :as cs])
+  (:gen-class))
+
+(defn lower-english-alphabet-factory
+  "Return the English alphabet with only lowercase letters"
+  []
+  (reduce
+   (fn [acc val] (str acc (char val)))
+   ""
+   (range (int \a) (inc (int \z)))))
+
+(defn english-alphabet-factory
+  "Return the English alphabet with lower and upper case letters"
+  []
+  (let [letters (lower-english-alphabet-factory)]
+    (str letters (cs/upper-case letters))))
+
+(defn lower-ukrainian-alphabet-factory
+  "Return the Ukrainian alphabet with only lowercase letters"
+  []
+  "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя")
+
+(defn ukrainian-alphabet-factory
+  "Return the Ukrainian alphabet with lower and upper case letters"
+  []
+  (let [letters (lower-ukrainian-alphabet-factory)]
+    (str letters (cs/upper-case letters))))
+
+(defn digit-set-factory
+  "Return digits"
+  []
+  "0123456789")
+

test/cipher_analytical_machine/caesar_test.clj

@@ -0,0 +1,64 @@
+(ns cipher-analytical-machine.caesar-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.caesar :refer :all]
+  ))
+
+(deftest calculate-char-index-test
+  (let [symbols "abc123%$"]
+    (testing "Letter 'b' in symbols"
+      (is (= 1 (calculate-char-index \b symbols))))
+
+    (testing "Letter 'd' does not in symbols"
+      (is (= nil (calculate-char-index \d symbols))))
+
+    (testing "Digit '1' in symbols"
+      (is (= 3 (calculate-char-index \1 symbols))))
+
+    (testing "Digit '0' does not in symbols"
+      (is (= nil (calculate-char-index \0 symbols))))
+
+    (testing "Symbol '?' does not in symbols"
+      (is (= nil (calculate-char-index \? symbols))))))
+
+(deftest encrypt-index-test
+  (testing "The new index is in the range."
+    (is (= 2 (encrypt-index 0 2 33))))
+
+  (testing "The new index that equal to max-index."
+    (is (= 0 (encrypt-index 30 3 33))))
+
+  (testing "The new index that greater than max-index."
+    (is (= 1 (encrypt-index 30 4 33))))
+
+  (testing "The new index that lower than 0."
+    (is (= 32 (encrypt-index 0 -1 33)))))
+
+(deftest encrypt-char-test
+  (let [symbols "abc"
+        max-index (count symbols)]
+    (testing "Letter 'a' is encrypted to 'b'"
+      (is (= \b (encrypt-char \a 1 symbols max-index))))
+
+    (testing "Letter 'b' is encrypted to 'a'"
+      (is (= \a (encrypt-char \b 2 symbols max-index))))
+
+    (testing "Letter 'b' is decryped to 'a'"
+      (is (= \a (encrypt-char \b -1 symbols max-index))))))
+
+(deftest encrypt-message-text
+  (let [symbols "abc"]
+    (testing "The message 'abc' is encrypted to 'bca'"
+      (is (= "bca" (encrypt-message "abc" 1 symbols))))
+
+    (testing "The message 'bca' is decrypted to 'abc'"
+      (is (= "abc" (encrypt-message "bca" -1 symbols))))))
+
+(deftest decrypt-message-text
+  (let [symbols "abc"]
+    (testing "The message 'bca' is decrypted to 'abc'"
+      (is (= "abc" (decrypt-message "bca" 1 symbols)))
+
+    (testing "The message 'abc' is encrypted to 'bca'"
+      (is (= "bca" (decrypt-message "abc" -1 symbols)))))))
+

test/cipher_analytical_machine/core_test.clj

@@ -2,6 +2,3 @@
   (:require [clojure.test :refer :all]
             [cipher-analytical-machine.core :refer :all]))
 
-(deftest a-test
-  (testing "FIXME, I fail."
-    (is (= 0 1))))

test/cipher_analytical_machine/symbol_factories_test.clj

@@ -0,0 +1,46 @@
+(ns cipher-analytical-machine.symbol-factories-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.symbol_factories :refer :all]
+  ))
+
+(deftest lower-english-alphabet-factory-test
+  (let [symbols (lower-english-alphabet-factory)]
+    (testing "It must have same order"
+      (is (= "abcdefghijklmnopqrstuvwxyz" symbols)))
+
+    (testing "It must have 26 letters"
+      (is (= 26 (count symbols))))))
+
+(deftest english-alphabet-factory-test
+  (let [symbols (english-alphabet-factory)]
+    (testing "It must have same order"
+      (is (= "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" symbols)))
+
+    (testing "It must have 2*26 letters"
+      (is (= (* 2 26) (count symbols))))))
+
+(deftest lower-ukrainian-alphabet-factory-test
+  (let [symbols (lower-ukrainian-alphabet-factory)]
+    (testing "It must have same order"
+      (is (= "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя" symbols)))
+
+    (testing "It must have 33 letters"
+      (is (= 33 (count symbols))))))
+
+(deftest ukrainian-alphabet-factory-test
+  (let [symbols (ukrainian-alphabet-factory)]
+    (testing "It must have same order"
+      (is (= "абвгґдеєжзиіїйклмнопрстуфхцчшщьюяАБВГҐДЕЄЖЗИІЇЙКЛМНОПРСТУФХЦЧШЩЬЮЯ" symbols)))
+
+    (testing "It must have 2*33 letters"
+      (is (= (* 2 33) (count symbols))))))
+
+(deftest digit-set-factory-test
+  (let [symbols (digit-set-factory)]
+    (testing "It must have same order"
+      (is (= "0123456789" symbols)))
+
+    (testing "It must have 10 digits"
+      (is (= 10 (count symbols))))))
+