Add validations to check if a cipher or an analyzer is available.

src/cipher_analytical_machine/analyzers/caesar.clj

@@ -50,10 +50,10 @@
 
 (defn frequency-analizer-get-plaintext
   "Return the plaintext from a ciphertext using simple analizer. The function is case-insensitive."
-  [ciphertext symbols letter-frequences]
+  [ciphertext symbols letter-frequencies-string]
   (let [decrypt (reify Decrypted
                   (decrypt [this message key symbols]
                     (caesar/decrypt-message message key symbols)))]
-    (-> (new FrequencyAnalyzer ciphertext symbols letter-frequences decrypt)
+    (-> (new FrequencyAnalyzer ciphertext symbols letter-frequencies-string decrypt)
         .crack)))
 

src/cipher_analytical_machine/cli/cli.clj

@@ -5,32 +5,11 @@
    [cipher-analytical-machine.analyzers.caesar :as caesar-analyzers]
    [cipher-analytical-machine.symbols.factories :as sf]
    [cipher-analytical-machine.symbols.frequencies :as symbol-frequencies]
+   [cipher-analytical-machine.cli.options :as options]
    [clojure.string :as cs]
    [clojure.tools.cli :refer [parse-opts]])
   (:gen-class))
 
-(def cipher-options
-  #{"Caesar"})
-
-(def language-options
-  #{"en", "uk"})
-
-(def cli-options
-  [["-m" "--message MESSAGE" "The message will be encrypted or decrypted."]
-   ["-M" "--message-file MESSAGE-FILE" "The file contains the message that 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."]
-   ["-s" "--symbols" "The string will be used as a set of symbols for a cipher."
-    :default (sf/default-symbol-factory "en")]
-   ["-l" "--language CODE" "The string will be used to set a default symbols for a cipher."
-    :validate [#(contains? language-options %) "Must be a code from the list: en, uk!!!"]]
-   ["-C" "--cracking" "Cracking the encrypted message."]
-   ["-O" "--output-file OUTPUT-FILE" "Save the program output to a file."]
-   ["-h" "--help"]])
-
 (defn usage [options-summary]
   (->> ["This is cipher-analytical-machine. It can help you to learn how ciphers works."
         ""
@@ -38,6 +17,12 @@
         ""
         "Options:"
         options-summary
+        ""
+        "Available values"
+        ""
+        (options/get-available-cipher-options-as-string)
+        ""
+        (options/get-available-analyzers-options-as-string)
         ""]
        (cs/join \newline)))
 
@@ -55,7 +40,7 @@
   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)]
+  (let [{:keys [options arguments errors summary]} (parse-opts args options/cli-options)]
     (cond
       (:help options)
       {:exit-message (usage summary) :ok? true}
@@ -77,6 +62,16 @@
            (file/is-file-exists? (:output-file options)))
       {:exit-message (error-msg ["Please, choose another file!!! Overwriting was prevented!!!"])}
 
+      (false? (contains? options/cipher-options (:cipher options)))
+      {:exit-message (error-msg ["Please, choose an available cipher!!!\n"
+                                 (options/get-available-cipher-options-as-string)])}
+
+      (and (map-has-keys? options [:cipher, :cracking, :analyzer])
+           (false? (contains?
+             (get options/analyzers-options (:cipher options)) (:analyzer options))))
+      {:exit-message (error-msg ["Please, choose an available analyzer!!!\n"
+                                 (options/get-available-analyzers-options-as-string)])}
+
       (and (map-has-keys? options [:cipher, :key])
            (or (contains? options :message)
                (contains? options :message-file))
@@ -122,8 +117,10 @@
 (defn set-symbols
   "Set defaults symbols for a language."
   [options]
-  (set-option options :symbols
-              (sf/default-symbol-factory (:language options))))
+  (if (contains? options :language)
+    (set-option options :symbols
+                (sf/default-symbol-factory (:language options)))
+    options))
 
 (defn load-and-set-option
   "Load the option and set it."
@@ -151,14 +148,26 @@
     (save-output output options))
   (println output))
 
-(defn cracking-actions
-  [options arguments action-type]
-  (let [message (:message options)
+(defn cracking-caesar
+  [options arguments]
+  (let [analyzer (:analyzer options)
+        message (:message options)
         symbols (:symbols options)
         frequencies symbol-frequencies/english-letter-frequencies]
     (cond
-      (= action-type :cracking)
+      (= analyzer "Chi^2")
       (caesar-analyzers/get-plaintext message symbols frequencies)
+
+      (= analyzer "Frequency")
+      (caesar-analyzers/frequency-analizer-get-plaintext message symbols
+                                                         (symbol-frequencies/map-to-string frequencies)))))
+
+(defn cracking-actions
+  [options arguments action-type]
+  (let [cipher (:cipher options)]
+    (cond
+      (= cipher "Caesar")
+      (cracking-caesar options arguments)
       )))
 
 (defn crypt-actions

src/cipher_analytical_machine/cli/options.clj

@@ -0,0 +1,64 @@
+(ns cipher-analytical-machine.cli.options
+  (:require
+   [cipher-analytical-machine.symbols.factories :as sf]
+   [clojure.string :as cs])
+  (:gen-class))
+
+(defn option-values-as-row
+  "Return the formatted string of values for an option."
+  [option values]
+  (str option ": " (cs/join ", " values)))
+
+(defn option-values-as-list
+  "Return the formatted string of values for an option as a multiline list."
+  [option values]
+  (str option ": \n - " (cs/join "\n - " values)))
+
+(defn map-of-option-value-as-list
+  "Return the formatted string of values for an option as a multiline list.
+   The values are a map of pairs (suboption and its options)."
+  [option values]
+  (let [values (map #(apply option-values-as-row %) values)]
+    (option-values-as-list option values)))
+
+(def cipher-options
+  #{"Caesar"})
+
+(def default-cipher "Caesar")
+
+(defn get-available-cipher-options-as-string
+  "Return the formatted string of analyzers options."
+  []
+  (option-values-as-row "Ciphers" cipher-options))
+
+(def analyzers-options
+  {"Caesar" #{"Chi^2" "Frequency"}})
+
+(defn get-available-analyzers-options-as-string
+  "Return the formatted string of analyzers options."
+  []
+  (map-of-option-value-as-list "Analyzers" analyzers-options))
+
+(def language-options
+  #{"en", "uk"})
+
+(def default-symbols
+  (sf/default-symbol-factory "en"))
+
+(def cli-options
+  [["-m" "--message MESSAGE" "The message will be encrypted or decrypted."]
+   ["-M" "--message-file MESSAGE-FILE" "The file contains the message that 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 default-cipher]
+   ["-e" "--encrypt" "Encrypt the message."]
+   ["-d" "--decrypt" "Decrypt the message."]
+   ["-s" "--symbols SYMBOLS" "The string will be used as a set of symbols for a cipher."
+    :default default-symbols]
+   ["-l" "--language CODE" "The string will be used to set a default symbols for a cipher."
+    :validate [#(contains? language-options %) "Must be a code from the list: en, uk!!!"]]
+   ["-C" "--cracking" "Cracking the encrypted message."]
+   ["-a" "--analyzer ANALYZER" "The way of cracking."]
+   ["-O" "--output-file OUTPUT-FILE" "Save the program output to a file."]
+   ["-h" "--help"]])
+

src/cipher_analytical_machine/symbols/frequencies.clj

@@ -1,7 +1,17 @@
 (ns cipher-analytical-machine.symbols.frequencies
   (:gen-class))
 
-(def english-letter-frequences {
+(defn map-to-string
+  "Convert the map of frequencies to the frequency string. Letters are sorted by frequency in descending order."
+  [frequency-map]
+  (->> frequency-map
+       (reduce (fn [acc el] (conj acc el)) [])
+       (sort-by last)
+       (map first)
+       (reverse)
+       (apply str)))
+
+(def english-letter-frequencies {
    \a 0.0804
    \b 0.0154
    \c 0.0306
@@ -30,7 +40,7 @@
    \z 0.0009
 })
 
-(def ukrainian-letter-frequences {
+(def ukrainian-letter-frequencies {
    \а 0.064
    \б 0.013
    \в 0.046

src/main/java/cipher_analytical_machine/analyzers/caesar/FrequencyAnalyzer.java

@@ -7,12 +7,14 @@ public class FrequencyAnalyzer {
     private String ciphertext;
     private int key;
     private String symbols;
+    private String symbol_frequences;
     private Decrypted decryptor;
 
-    public FrequencyAnalyzer(String ciphertext, String symbols, Map<Character, Double> symbol_frequences, Decrypted decryptor) {
+    public FrequencyAnalyzer(String ciphertext, String symbols, String symbol_frequences, Decrypted decryptor) {
 	this.ciphertext = ciphertext;
 	this.key = 1;
 	this.symbols = symbols;
+	this.symbol_frequences = symbol_frequences;
 	this.decryptor = decryptor;
     }
 

test/cipher_analytical_machine/analyzers/caesar_test.clj

@@ -79,7 +79,7 @@
         ciphertext "bca"
         key 1
         symbols "abc"
-        frequencies sf/english-letter-frequencies]
+        frequencies "etaoinsrhldcumfpgwybvkxjqz"]
     (testing "The ciphertext is 'bca' and key is 1."
       (is (= plaintext
              (frequency-analizer-get-plaintext ciphertext symbols frequencies))))))

test/cipher_analytical_machine/symbols/frequencies_test.clj

@@ -0,0 +1,11 @@
+(ns cipher-analytical-machine.symbols.frequencies-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.symbols.frequencies :refer :all]))
+
+(deftest calculate-char-index-test
+  (let [symbol-map english-letter-frequencies]
+    (testing "The map must be converted to 'etaoinsrhldcumfpgwybvkxjqz'"
+      (is (= "etaoinsrhldcumfpgwybvkxjqz"
+             (map-to-string symbol-map))))))
+