Compare commits

...
4 Commits
Author SHA1 Message Date
KKlochko 63f55bbc50 Add the CI/CD configuration. 2023-09-11 22:23:17 +03:00
KKlochko 4b50b9289b Add tests for factories. 2023-09-11 22:20:27 +03:00
KKlochko 0b368c144e Add factories for symbols. 2023-09-11 22:09:23 +03:00
KKlochko 453b90d537 Add a simple cli interface. 2023-09-10 20:53:30 +03:00
6 changed files with 181 additions and 3 deletions
+10
View File
@@ -0,0 +1,10 @@
kind: pipeline
type: docker
name: default
steps:
- name: test
image: clojure:temurin-11-lein-2.10.0-alpine
commands:
- lein test
+2 -1
View File
@@ -3,7 +3,8 @@
:url "https://gitlab.com/KKlochko/cipher-analytical-machine" :url "https://gitlab.com/KKlochko/cipher-analytical-machine"
:license {:name "LGPL" :license {:name "LGPL"
:url "http://www.gnu.org/licenses/lgpl-3.0.txt"} :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 :main ^:skip-aot cipher-analytical-machine.core
:target-path "target/%s" :target-path "target/%s"
:profiles {:uberjar {:aot :all :profiles {:uberjar {:aot :all
+82
View File
@@ -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)))))
+7 -2
View File
@@ -1,7 +1,12 @@
(ns cipher-analytical-machine.core (ns cipher-analytical-machine.core
(:require
[cipher-analytical-machine.cli :as cli])
(:gen-class)) (:gen-class))
(defn -main (defn -main
"I don't do a whole lot ... yet."
[& args] [& 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))))
@@ -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")
@@ -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))))))