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

.gitlab-ci.yml

@@ -0,0 +1,10 @@
+image: clojure:temurin-11-lein-2.10.0-alpine
+
+stages:
+  - test
+
+unit tests:
+  stage: test
+  script:
+    - lein test
+

CHANGELOG.md

@@ -0,0 +1,127 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.5.3] - 2023-10-05
+
+### Added
+- Add the CHANGELOG.
+
+## [0.5.2] - 2023-10-02
+
+### Fixed
+- Fix checking for file existence only when the options are set.
+- Fix writing to a file only when the option is set.
+
+## [0.5.1] - 2023-09-28
+
+### Added
+- Add the output option to save into a file.
+- Add the file errors to prevent using an invalid file path.
+
+## [0.5.0] - 2023-09-22
+
+### Changed
+- Update symbol defaults, factories to have only lower alphabets.
+- Update the Caesar to be case-insensitive and skip unknown symbols.
+- Update Caesar Analyzers to be case-insensitive and testable.
+
+## [0.4.3] - 2023-09-21
+
+### Added
+- Add the language option for symbols.
+
+### Changed
+- Update the CLI to have separated actions and an option initializer.
+
+## [0.4.2] - 2023-09-18
+
+### Added
+- Add tests for the cipher-analyzers module.
+
+### Changed
+- Rename the cipher_analyzer module to cipher-analyzers.
+
+## [0.4.1] - 2023-09-17
+
+### Added
+- Add symbol factories for punctuation, space, defaults symbols.
+- Add the action-type to distinguish the actions.
+- Add the symbol option and its default.
+- Add the cracking option.
+
+### Changed
+- Rename the language_analyzer module to language-analyzer.
+- Update the nonsense for the is-nonsense? test.
+- Rename the symbol_frequences module to symbol-frequences.
+
+## [0.4.0] - 2023-09-15
+
+### Added
+- Add Chi-squared Statistic function to analyze texts.
+- Add the caesar-analyzers to get the plaintext from a ciphertext.
+
+## [0.3.5] - 2023-09-14
+
+### Added
+- Add the frequences of symbols as defaults.
+
+## [0.3.4] - 2023-09-13
+
+### Added
+- Add a simple language analyzers.
+
+## [0.3.3] - 2023-09-12
+
+### Added
+- Add an option to read a message from a file.
+
+## [0.3.2] - 2023-09-11
+
+### Added
+- Add the CI/CD configuration.
+
+## [0.3.1] - 2023-09-11
+
+### Added
+- Add factories for symbols.
+- Add tests for factories.
+
+## [0.3.0] - 2023-09-10
+
+### Added
+- Add a simple cli interface.
+
+## [0.2.0] - 2023-09-09
+
+### Added
+- Add a implementation of Caesar cipher.
+
+## [0.1.0] - 2023-09-09
+
+### Added
+- Project initialization.
+
+[Unreleased]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.3...main?from_project_id=50218541&straight=false
+[0.5.3]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.2...0.5.3?from_project_id=50218541&straight=false
+[0.5.2]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.1...0.5.2?from_project_id=50218541&straight=false
+[0.5.1]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.0...0.5.1?from_project_id=50218541&straight=false
+[0.5.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.4.3...0.5.0?from_project_id=50218541&straight=false
+[0.4.3]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.4.2...0.4.3?from_project_id=50218541&straight=false
+[0.4.2]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.4.1...0.4.2?from_project_id=50218541&straight=false
+[0.4.1]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.4.0...0.4.1?from_project_id=50218541&straight=false
+[0.4.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.5...0.4.0?from_project_id=50218541&straight=false
+[0.3.5]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.4...0.3.5?from_project_id=50218541&straight=false
+[0.3.4]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.3...0.3.4?from_project_id=50218541&straight=false
+[0.3.3]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.2...0.3.3?from_project_id=50218541&straight=false
+[0.3.2]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.1...0.3.2?from_project_id=50218541&straight=false
+[0.3.1]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.3.0...0.3.1?from_project_id=50218541&straight=false
+[0.3.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.2.0...0.3.0?from_project_id=50218541&straight=false
+[0.2.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.1.0...0.2.0?from_project_id=50218541&straight=false
+[0.1.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/commit/a7a715b94276fc8f46fb6a44139636d27b551599
+

project.clj

@@ -4,8 +4,11 @@
   :license {:name "LGPL"
             :url "http://www.gnu.org/licenses/lgpl-3.0.txt"}
   :dependencies [[org.clojure/clojure "1.11.1"]
-                 [org.clojure/tools.cli "1.0.219"]]
+                 [org.clojure/tools.cli "1.0.219"]
+                 [org.apache.tika/tika-core "1.28.5"]
+                 [org.apache.tika/tika-langdetect "1.28.5"]]
   :main ^:skip-aot cipher-analytical-machine.core
+  :java-source-paths ["src/main/java"]
   :target-path "target/%s"
   :profiles {:uberjar {:aot :all
                        :jvm-opts ["-Dclojure.compiler.direct-linking=true"]}})

src/cipher_analytical_machine/analyzers/analyzers.clj

@@ -0,0 +1,38 @@
+(ns cipher-analytical-machine.analyzers.analyzers
+  (:require [clojure.string :as cs])
+  (:gen-class))
+
+(defn count-characters
+  "Count the letters and return map."
+  [text]
+  (reduce
+   (fn [acc val]
+     (assoc acc val
+            (inc (get acc val 0))))
+   {} text))
+
+(defn chi-squared-letter-statistic
+  "To calculate the frequency distribution of a letter."
+  [letter-count letter-frequence length-text]
+  (let [letter-frequence (* length-text letter-frequence)]
+    (/ (Math/pow
+        (- letter-count letter-frequence) 2)
+       letter-frequence)))
+
+(defn chi-squared-statistic
+  "To calculate the frequency distribution of a language. More detail about the algorithm here: http://practicalcryptography.com/cryptanalysis/text-characterisation/chi-squared-statistic/"
+  [text letter-frequencies]
+  (let [length-text (count text)
+        letter-counts (count-characters (cs/lower-case text))]
+    ;letter-counts
+    (reduce
+     (fn [acc [char count]]
+       (+ acc
+          (if (contains? letter-frequencies char)
+            (chi-squared-letter-statistic count
+                                          (get letter-frequencies char)
+                                          length-text)
+            0)))
+            0
+            letter-counts)))
+

src/cipher_analytical_machine/analyzers/caesar.clj

@@ -0,0 +1,59 @@
+(ns cipher-analytical-machine.analyzers.caesar
+  (:require [cipher-analytical-machine.ciphers.caesar :as caesar]
+            [clojure.string :as cs]
+            [cipher-analytical-machine.analyzers.analyzers :as ca])
+  (:import [cipher_analytical_machine.ciphers.caesar Decrypted]
+           [cipher_analytical_machine.analyzers.caesar FrequencyAnalyzer])
+  (:gen-class))
+
+(defn get-all-texts
+  "Return a list of pairs which have a key and a second posible plaintext."
+  [ciphertext symbols]
+  (let [keys (range (count symbols))]
+    (reduce
+     (fn [acc key]
+       (conj acc [key (caesar/decrypt-message ciphertext key symbols)]))
+     '() keys)))
+
+(defn get-all-scores
+  "For pairs (key, plaintext) finds scores and return list of pairs [key, score]."
+  [letter-frequencies pairs]
+  (map (fn [[key text]]
+         [key (ca/chi-squared-statistic text letter-frequencies)])
+       pairs))
+
+(defn get-min-score-pair
+  "For pairs (key, plaintext) finds scores and return list of pairs [key, score]."
+  [pairs]
+  (reduce
+   (fn [[key value] [new-key new-value]]
+     (if (> value new-value) [new-key new-value]
+         [key value]))
+   [0 Double/MAX_VALUE]
+   pairs))
+
+(defn get-key
+  "To find the key with frequencies of letters."
+  [ciphertext symbols letter-frequencies]
+  (->> (get-all-texts ciphertext symbols)
+       (get-all-scores letter-frequencies)
+       (get-min-score-pair)
+       (first)))
+
+(defn get-plaintext
+  "Return the plaintext from a ciphertext. The function is case-insensitive."
+  [ciphertext symbols letter-frequencies]
+  (let [ciphertext (cs/lower-case ciphertext)]
+    (caesar/decrypt-message ciphertext
+                            (get-key ciphertext symbols letter-frequencies)
+                            symbols)))
+
+(defn frequency-analizer-get-plaintext
+  "Return the plaintext from a ciphertext using simple analizer. The function is case-insensitive."
+  [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-frequencies-string decrypt)
+        .crack)))
+

src/cipher_analytical_machine/analyzers/language.clj

@@ -0,0 +1,21 @@
+(ns cipher-analytical-machine.analyzers.language
+  (:import [org.apache.tika.language LanguageIdentifier])
+  (:gen-class))
+
+(defn detect-language
+  "Return a identified language."
+  [text]
+  (-> (new LanguageIdentifier text)
+      .getLanguage))
+
+(defn is-language?
+  "Check if the text written a language."
+  [text language-id]
+  (= (detect-language text)
+     language-id))
+
+(defn is-nonsense?
+  "Check if the text written a language is not a language."
+  [text language-id]
+  (not (is-language? text language-id)))
+

src/cipher_analytical_machine/ciphers/caesar.clj

@@ -1,4 +1,4 @@
-(ns cipher-analytical-machine.caesar
+(ns cipher-analytical-machine.ciphers.caesar
   (:require [clojure.string :as cs])
   (:gen-class))
 
@@ -14,21 +14,28 @@
        (+ key)
        (mod max-index)))
 
+(defn encrypt-or-skip
+  "If symbols do not have a character, then it will be skipped."
+  [index character key symbols max-index]
+  (if (nil? index) character
+      (get symbols
+           (encrypt-index index key 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))))
+      (encrypt-or-skip char key symbols max-index)))
 
 (defn encrypt-message
-  "Encrypt a message using the Caesar cipher."
+  "Encrypt a message using the Caesar cipher. The function is case-insensitive."
   [message key symbols]
   (let [max-index (count symbols)]
-    (cs/join
-     (map (fn [char] (encrypt-char char key symbols max-index))
-          message))))
+    (->> message
+         (cs/lower-case)
+         (map (fn [char] (encrypt-char char key symbols max-index)))
+         (cs/join))))
 
 (defn decrypt-message
   "Decrypt the ciphtext using the Caesar cipher."

src/cipher_analytical_machine/cli.clj

@@ -1,82 +0,0 @@
-(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/cli/cli.clj

@@ -0,0 +1,197 @@
+(ns cipher-analytical-machine.cli.cli
+  (:require
+   [cipher-analytical-machine.cli.file :as file]
+   [cipher-analytical-machine.ciphers.caesar :as caesar]
+   [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))
+
+(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
+        ""
+        "Available values"
+        ""
+        (options/get-available-cipher-options-as-string)
+        ""
+        (options/get-available-analyzers-options-as-string)
+        ""]
+       (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 options/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!!!"])}
+
+      (map-has-keys? options [:message, :message-file])
+      {:exit-message (error-msg ["You can't use message and message-file options at the same time!!!"])}
+
+      (and (contains? options :message-file)
+           (file/is-file-not-exists? (:message-file options)))
+      {:exit-message (error-msg ["Please, check the path to the message file!!!"])}
+
+      (and (contains? options :output-file)
+           (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))
+           (or (contains? options :encrypt)
+               (contains? options :decrypt)))
+      (cond
+        (contains? options :encrypt)
+        {:options options :arguments arguments :action-type :encrypt}
+
+        (contains? options :decrypt)
+        {:options options :arguments arguments :action-type :decrypt})
+
+      (and (map-has-keys? options [:cipher, :cracking])
+           (or (contains? options :message)
+               (contains? options :message-file)))
+      {:options options :arguments arguments :action-type :cracking}
+
+      :else
+      {:exit-message (usage summary)})))
+
+(defn exit
+  [exit-message status]
+  (println exit-message)
+  (System/exit (if status 0 1)))
+
+(defn get-or-load-option
+  "Return the option value or load the value from a file."
+  [options arguments option]
+  (let [file-option (keyword (str (name option) "-file"))]
+    (cond
+      (contains? options option)
+      (option options)
+
+      (contains? options file-option)
+      (file/read-file (file-option options)))))
+
+(defn set-option
+  "Set a option in the option map."
+  [options option value]
+  (-> options
+      (assoc option value)))
+
+(defn set-symbols
+  "Set defaults symbols for a 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."
+  [options option]
+  (->> (get-or-load-option options nil option)
+       (set-option options option)))
+
+(defn load-all-options
+  "Load all options."
+  [options]
+  (-> options
+      (set-symbols)
+      (load-and-set-option :message)))
+
+(defn save-output
+  "Save the output to a file"
+  [output options]
+  (let [file-path (:output-file options)]
+    (file/write-file file-path output)))
+
+(defn show-and-save-output
+  "Print and save the output to a file if needed"
+  [output options]
+  (when (contains? options :output-file)
+    (save-output output options))
+  (println output))
+
+(defn cracking-caesar
+  [options arguments]
+  (let [analyzer (:analyzer options)
+        message (:message options)
+        symbols (:symbols options)
+        frequencies symbol-frequencies/english-letter-frequencies]
+    (cond
+      (= 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
+  [options arguments action-type]
+  (let [message (:message options)
+        key (Integer/parseInt (:key options))
+        symbols (:symbols options)]
+    (cond
+      (= action-type :encrypt)
+      (caesar/encrypt-message message key symbols)
+
+      (= action-type :decrypt)
+      (caesar/decrypt-message message key symbols))))
+
+(defn actions
+  [options arguments action-type]
+  (let [options (load-all-options options)]
+    (->
+     (cond
+       (contains? #{:encrypt :decrypt} action-type)
+       (crypt-actions options arguments action-type)
+
+       (= action-type :cracking)
+       (cracking-actions options arguments action-type))
+
+     (show-and-save-output options))))
+

src/cipher_analytical_machine/cli/file.clj

@@ -0,0 +1,21 @@
+(ns cipher-analytical-machine.cli.file
+  (:require [clojure.java.io :as io])
+  (:gen-class))
+
+(defn is-file-exists?
+  "Checks that a file is exists"
+  [file-path]
+  (-> (io/file file-path)
+      (.exists)))
+
+(defn is-file-not-exists?
+  "Checks that a file is not exists"
+  [file-path]
+  (not (is-file-exists? file-path)))
+
+(defn read-file [file-path]
+  (slurp file-path))
+
+(defn write-file [file-path content]
+  (spit file-path content))
+

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/core.clj

@@ -1,12 +1,12 @@
 (ns cipher-analytical-machine.core
   (:require
-   [cipher-analytical-machine.cli :as cli])
+   [cipher-analytical-machine.cli.cli :as cli])
   (:gen-class))
 
 (defn -main
   [& args]
-  (let [{:keys [options arguments exit-message ok?]} (cli/validate-args args)]
+  (let [{:keys [options arguments action-type exit-message ok?]} (cli/validate-args args)]
     (if exit-message
       (cli/exit exit-message ok?)
-      (cli/actions options arguments))))
+      (cli/actions options arguments action-type))))
 

src/cipher_analytical_machine/symbol_factories.clj

@@ -1,34 +0,0 @@
-(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")
-

src/cipher_analytical_machine/symbols/factories.clj

@@ -0,0 +1,47 @@
+(ns cipher-analytical-machine.symbols.factories
+  (:require [clojure.string :as cs])
+  (:gen-class))
+
+(defn 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 ukrainian-alphabet-factory
+  "Return the Ukrainian alphabet with only lowercase letters"
+  []
+  "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя")
+
+(defn digit-set-factory
+  "Return digits"
+  []
+  "0123456789")
+
+(defn punctuation-symbol-factory
+  "Return punctuation symbols"
+  []
+  ".,:;-!?")
+
+(defn space-symbol-factory
+  "Return punctuation symbols"
+  []
+  " \t\n")
+
+(defn default-symbol-factory
+  "Return a default string of symbols for a language"
+  [language-code]
+  (cond
+    (= language-code "en")
+    (str (english-alphabet-factory)
+         \ )
+
+    (= language-code "uk")
+    (str (ukrainian-alphabet-factory)
+         \ )
+
+    :else
+    (default-symbol-factory "en")))
+

src/cipher_analytical_machine/symbols/frequencies.clj

@@ -0,0 +1,79 @@
+(ns cipher-analytical-machine.symbols.frequencies
+  (:gen-class))
+
+(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
+   \d 0.0399
+   \e 0.1251
+   \f 0.0230
+   \g 0.0196
+   \h 0.0549
+   \i 0.0726
+   \j 0.0016
+   \k 0.0067
+   \l 0.0414
+   \m 0.0253
+   \n 0.0709
+   \o 0.0760
+   \p 0.0200
+   \q 0.0011
+   \r 0.0612
+   \s 0.0654
+   \t 0.0925
+   \u 0.0271
+   \v 0.0099
+   \w 0.0192
+   \x 0.0019
+   \y 0.0173
+   \z 0.0009
+})
+
+(def ukrainian-letter-frequencies {
+   \а 0.064
+   \б 0.013
+   \в 0.046
+   \г 0.013
+   \ґ 0.0001
+   \д 0.027
+   \е 0.042
+   \є 0.005
+   \ж 0.007
+   \з 0.020
+   \и 0.055
+   \і 0.044
+   \ї 0.010
+   \й 0.009
+   \к 0.033
+   \л 0.027
+   \м 0.029
+   \н 0.068
+   \о 0.086
+   \п 0.025
+   \р 0.043
+   \с 0.037
+   \т 0.045
+   \у 0.027
+   \ф 0.003
+   \х 0.011
+   \ц 0.010
+   \ч 0.011
+   \ш 0.005
+   \щ 0.004
+   \ь 0.016
+   \ю 0.008
+   \я 0.019
+   \  0.138
+})
+

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

@@ -0,0 +1,25 @@
+package cipher_analytical_machine.analyzers.caesar;
+
+import cipher_analytical_machine.ciphers.caesar.Decrypted;
+import java.util.Map;
+
+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, String symbol_frequences, Decrypted decryptor) {
+	this.ciphertext = ciphertext;
+	this.key = 1;
+	this.symbols = symbols;
+	this.symbol_frequences = symbol_frequences;
+	this.decryptor = decryptor;
+    }
+
+    public String crack() {
+	return decryptor.decrypt(ciphertext, key, symbols);
+    }
+}
+

src/main/java/cipher_analytical_machine/ciphers/caesar/Decrypted.java

@@ -0,0 +1,6 @@
+package cipher_analytical_machine.ciphers.caesar;
+
+public interface Decrypted {
+    String decrypt(String message, int key, String symbols);
+}
+

test/cipher_analytical_machine/analyzers/caesar_test.clj

@@ -0,0 +1,86 @@
+(ns cipher-analytical-machine.analyzers.caesar-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.analyzers.caesar :refer :all]
+   [cipher-analytical-machine.symbols.frequencies :as sf]
+   [cipher-analytical-machine.analyzers.analyzers :as ca]
+   [clojure.string :as cs]))
+
+(deftest get-all-texts-test
+  (testing "There're three text when the text is 'abc' and the set of symbol is 'abc'."
+    (is (= 3 (count (get-all-texts "abc" "abc")))))
+
+  (testing "A pair must have an integer and a string."
+    (let [pairs (get-all-texts "abc" "abc")
+          pair (first pairs)]
+      (is (and (int? (first pair))
+               (string? (last pair))))))
+
+  (testing "There're 27 combinations for a 'Hello World'."
+    (let [ciphertext "khoorczruog"
+        symbols "abcdefghijklmnopqrstuvwxyz "]
+      (is (= 27 (count (get-all-texts ciphertext symbols)))))))
+
+(deftest get-all-scores-test
+  (testing "There're 27 combinations for a 'Hello World'."
+    (let [ciphertext "khoorczruog"
+          symbols "abcdefghijklmnopqrstuvwxyz "
+          frequencies sf/english-letter-frequencies
+          text-pairs (get-all-texts ciphertext symbols)]
+      (is (= 27 (count (get-all-scores frequencies text-pairs)))))))
+
+(deftest get-min-score-pair-test
+  (testing "If a key is one, then the min score pair is 15."
+    (let [scores (list [0 20.0] [1 15.0] [2 30.0])
+          min-score-pair (get-min-score-pair scores)]
+      (is (= [1 15.0] min-score-pair)))))
+
+(deftest get-key-test
+  (let [plaintext "hello world"
+        ciphertext "khoorczruog"
+        key 3
+        symbols "abcdefghijklmnopqrstuvwxyz "
+        frequencies sf/english-letter-frequencies]
+    (testing "The plaintext is encrypted with 3 as the key."
+      (is (= key (get-key ciphertext symbols frequencies)))))
+
+  (let [; З поеми "Кавказ" Тараса Григоровича Шевченка:
+        plaintext "Борітеся – поборете, Вам Бог помагає! За вас правда, за вас слава. І воля святая!"
+        ciphertext "жхчощйшде–ецхжхчйщй,езєуежхиецхуєиєк!емєезєшецчєзїє,емєезєшештєзє.еоезхтдешздщєд!"
+        key 7
+        symbols "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя "
+        frequencies sf/ukrainian-letter-frequencies]
+    (testing "The plaintext is encrypted with 3 as the key."
+      (is (= key (get-key ciphertext symbols frequencies))))))
+
+(deftest get-plaintext-test
+  (let [plaintext "hello world"
+        ciphertext "khoorczruog"
+        symbols "abcdefghijklmnopqrstuvwxyz "
+        frequencies sf/english-letter-frequencies]
+    (testing "The plaintext is encrypted with 3 as the key."
+      (is (= plaintext (get-plaintext ciphertext symbols frequencies))))
+
+    (testing "The ciphertext is case-insensitive."
+      (is (= plaintext (get-plaintext "KhoorcZruog" symbols frequencies)))))
+
+  (let [; З поеми "Кавказ" Тараса Григоровича Шевченка:
+        plaintext "Борітеся – поборете, Вам Бог помагає! За вас правда, за вас слава. І воля святая!"
+        ciphertext "жхчощйшде–ецхжхчйщй,езєуежхиецхуєиєк!емєезєшецчєзїє,емєезєшештєзє.еоезхтдешздщєд!"
+        key 7
+        symbols "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя "
+        frequencies sf/ukrainian-letter-frequencies]
+    (testing "The ciphertext is case-insensitive."
+      (is (= (cs/lower-case plaintext)
+             (get-plaintext ciphertext symbols frequencies))))))
+
+(deftest frequency-analizer-get-plaintext-test
+  (let [plaintext "abc"
+        ciphertext "bca"
+        key 1
+        symbols "abc"
+        frequencies "etaoinsrhldcumfpgwybvkxjqz"]
+    (testing "The ciphertext is 'bca' and key is 1."
+      (is (= plaintext
+             (frequency-analizer-get-plaintext ciphertext symbols frequencies))))))
+

test/cipher_analytical_machine/analyzers/language_test.clj

@@ -0,0 +1,45 @@
+(ns cipher-analytical-machine.analyzers.language-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.analyzers.language :refer :all]
+  ))
+
+(deftest detect-language-test
+  (testing "Checking the English text"
+    (is (= "en" (detect-language "This is a sentence that uses English."))))
+
+  (testing "Checking the Ukrainian text"
+    (is (= "uk" (detect-language "Текст, що написаний українською."))))
+
+  (testing "Checking a gibberish that uses English letters"
+    (is (= "lt" (detect-language "dfgjldfjgdfl gjdfg idfjig hdgesr khs e."))))
+
+  (testing "Checking a gibberish that uses Ukrainian letters"
+    (is (= "uk" (detect-language "іаврпшшцді врадів аргів аріл варї йцґ.")))))
+
+(deftest is-language?-test
+  (testing "Checking the English text"
+    (is (is-language? "This is a sentence that uses English." "en")))
+
+  (testing "Checking the Ukrainian text"
+    (is (is-language? "Текст, що написаний українською." "uk")))
+
+  (testing "Checking a gibberish that uses English letters"
+    (is (is-language? "dfgjldfjgdfl gjdfg idfjig hdgesr khs e." "lt")))
+
+  (testing "Checking a gibberish that uses Ukrainian letters"
+    (is (is-language? "іаврпшшцді врадів аргів аріл варї йцґ." "uk"))))
+
+(deftest is-nonsense?-test
+  (testing "Checking the English text"
+    (is (not (is-nonsense? "This is a sentence that uses English." "en"))))
+
+  (testing "Checking the Ukrainian text"
+    (is (not (is-nonsense? "Текст, що написаний українською." "uk"))))
+
+  (testing "Checking a gibberish that uses English letters"
+    (is (is-nonsense? "dfgjldfjgdfl gjdfg idfjig hdgesr khs e." "en")))
+
+  (testing "Checking a gibberish that uses Ukrainian letters"
+    (is (is-nonsense? "іаврпшшцді івафі лоінїмч йцувіа івапґ." "uk"))))
+

test/cipher_analytical_machine/ciphers/caesar_test.clj

@@ -1,7 +1,7 @@
-(ns cipher-analytical-machine.caesar-test
+(ns cipher-analytical-machine.ciphers.caesar-test
   (:require
    [clojure.test :refer :all]
-   [cipher-analytical-machine.caesar :refer :all]
+   [cipher-analytical-machine.ciphers.caesar :refer :all]
   ))
 
 (deftest calculate-char-index-test
@@ -51,14 +51,20 @@
     (testing "The message 'abc' is encrypted to 'bca'"
       (is (= "bca" (encrypt-message "abc" 1 symbols))))
 
+    (testing "The message 'ABC' is encrypted to 'bca', because of case-insensitive."
+      (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)))
+      (is (= "abc" (decrypt-message "bca" 1 symbols))))
+
+    (testing "The message 'BCA' is decrypted to 'abc', because of case-insensitive."
+      (is (= "abc" (decrypt-message "BCA" 1 symbols))))
 
     (testing "The message 'abc' is encrypted to 'bca'"
-      (is (= "bca" (decrypt-message "abc" -1 symbols)))))))
+      (is (= "bca" (decrypt-message "abc" -1 symbols))))))
 

test/cipher_analytical_machine/symbol_factories_test.clj

@@ -1,46 +0,0 @@
-(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))))))
-

test/cipher_analytical_machine/symbols/factories_test.clj

@@ -0,0 +1,59 @@
+(ns cipher-analytical-machine.symbols.factories-test
+  (:require
+   [clojure.test :refer :all]
+   [cipher-analytical-machine.symbols.factories :refer :all]
+  ))
+
+(deftest english-alphabet-factory-test
+  (let [symbols (english-alphabet-factory)]
+    (testing "It must have the same order."
+      (is (= "abcdefghijklmnopqrstuvwxyz" symbols)))
+
+    (testing "It must have 26 letters."
+      (is (= 26 (count symbols))))))
+
+(deftest ukrainian-alphabet-factory-test
+  (let [symbols (ukrainian-alphabet-factory)]
+    (testing "It must have the same order."
+      (is (= "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя" symbols)))
+
+    (testing "It must have 33 letters."
+      (is (= 33 (count symbols))))))
+
+(deftest digit-set-factory-test
+  (let [symbols (digit-set-factory)]
+    (testing "It must have the same order."
+      (is (= "0123456789" symbols)))
+
+    (testing "It must have 10 digits."
+      (is (= 10 (count symbols))))))
+
+(deftest punctuation-symbol-factory-test
+  (let [symbols (punctuation-symbol-factory)]
+    (testing "It must have the same order."
+      (is (= ".,:;-!?" symbols)))
+
+    (testing "It must have 7 symbols."
+      (is (= 7 (count symbols))))))
+
+(deftest space-symbol-factory-test
+  (let [symbols (space-symbol-factory)]
+    (testing "It must have the same order."
+      (is (= " \t\n" symbols)))
+
+    (testing "It must have 3 symbols."
+      (is (= 3 (count symbols))))))
+
+(deftest default-symbol-factory-test
+  (testing "If language code is 'en', then it must have 27 symbols."
+    (let [symbols (default-symbol-factory "en")]
+      (is (= 27 (count symbols)))))
+
+  (testing "If language code is 'uk', then it must have 34 symbols."
+    (let [symbols (default-symbol-factory "uk")]
+      (is (= 34 (count symbols)))))
+
+  (testing "If language code is unidentified, then it must have the 'en'."
+    (let [symbols (default-symbol-factory "Maybe a code")]
+      (is (= 27 (count symbols))))))
+

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))))))
+