Update the diffs in the CHANGELOG.

.drone.yaml

@@ -5,6 +5,42 @@ name: default
 steps:
   - name: test
     image: clojure:temurin-11-lein-2.10.0-alpine
+    volumes:
+      - name: package_cache
+        path: /root/.m2/
     commands:
       - lein test
 
+  - name: build
+    image: clojure:temurin-11-lein-2.10.0-alpine
+    volumes:
+      - name: package_cache
+        path: /root/.m2/
+    commands:
+      - lein uberjar
+    when:
+      event: tag
+
+  - name: gitea_release
+    image: plugins/gitea-release
+    settings:
+      api_key:
+        from_secret: API_KEY
+      base_url:
+        from_secret: BASE_URL
+      files:
+        - target/uberjar/*.jar
+      checksum:
+        - md5
+        - sha1
+        - sha256
+        - sha512
+        - adler32
+        - crc32
+    when:
+      event: tag
+
+volumes:
+  - name: package_cache
+    temp: {}
+

CHANGELOG.md

@@ -7,6 +7,76 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.2] - 2023-10-21
+
+### Changed
+- Update the CHANGELOG.
+- Update the version.
+- Update the README.
+- Update the CI/CD configuration to publish the artifacts to the release.
+- Update the diffs in the CHANGELOG.
+
+## [0.7.1] - 2023-10-20
+
+### Removed
+- Remove the test for FrequencyAnalyzer.
+- Remove the option for FrequencyAnalyzer.
+
+## [0.7.0] - 2023-10-20
+
+### Changed
+- Refactor to move actions to separated files.
+
+## [0.6.3] - 2023-10-14
+
+### Added
+- Add the IsNonsense interface for FrequencyAnalyzer.
+
+### Changed
+- Update the frequency analyzer.
+
+## [0.6.2] - 2023-10-14
+
+### Added
+- Add the analyzer options and their actions.
+- Add the available ciphers and analyzer for the help.
+- Add validations to check if a cipher or an analyzer is available.
+
+### Changed
+- Refactor to move options to a separated file.
+
+## [0.6.1] - 2023-10-13
+
+### Added
+- Add the function to make a frequency string from a map.
+
+### Fixed
+- Fix the bug that the default language symbols override the symbols.
+
+### Changed
+- Update the FrequencyAnalyzer to use the frequency string instead.
+
+## [0.6.0] - 2023-10-12
+
+### Fixed
+- Fix the typo "frequences" to frequencies.
+
+### Changed
+- Refactor the project structure.
+
+## [0.5.5] - 2023-10-09
+
+### Added
+- Add the Gitlab CI/CD configuration.
+
+## [0.5.4] - 2023-10-05
+
+### Added
+- Add the java source path.
+- Add the Caesar decrypted interface for Java.
+- Add a frequency analyzer as a stub.
+- Add the clojure wrapper for the frequency analizer and its test.
+
 ## [0.5.3] - 2023-10-05
 
 ### Added
@@ -107,7 +177,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Project initialization.
 
-[Unreleased]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.3...main?from_project_id=50218541&straight=false
+[Unreleased]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.7.2...main?from_project_id=50218541&straight=false
+[0.7.2]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.7.1...0.7.2?from_project_id=50218541&straight=false
+[0.7.1]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.7.0...0.7.1?from_project_id=50218541&straight=false
+[0.7.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.6.3...0.7.0?from_project_id=50218541&straight=false
+[0.6.3]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.6.2...0.6.3?from_project_id=50218541&straight=false
+[0.6.2]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.6.1...0.6.2?from_project_id=50218541&straight=false
+[0.6.1]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.6.0...0.6.1?from_project_id=50218541&straight=false
+[0.6.0]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.5...0.6.0?from_project_id=50218541&straight=false
+[0.5.5]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.4...0.5.5?from_project_id=50218541&straight=false
+[0.5.4]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.3...0.5.4?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

README.md

@@ -11,10 +11,12 @@ Download from https://gitlab.com/KKlochko/cipher-analytical-machine.
 You need install java, before run the application.
 Run the application with a command:
 
-    $ java -jar cipher-analytical-machine-0.1.0-standalone.jar [args]
+    $ java -jar cipher-analytical-machine-VERSION-standalone.jar [args]
+    $ java -jar cipher-analytical-machine-0.7.2-standalone.jar [args]
 
 ## License
 
 Copyright © 2023 Kostiantyn Klochko
 
 Under the GNU Lesser General Public License v3.0 or later.
+

project.clj

@@ -1,4 +1,4 @@
-(defproject cipher-analytical-machine "0.1.0-SNAPSHOT"
+(defproject cipher-analytical-machine "0.7.2"
   :description "A program helps to learn how ciphers works."
   :url "https://gitlab.com/KKlochko/cipher-analytical-machine"
   :license {:name "LGPL"

src/cipher_analytical_machine/analyzers/caesar.clj

@@ -1,8 +1,10 @@
 (ns cipher-analytical-machine.analyzers.caesar
   (:require [cipher-analytical-machine.ciphers.caesar :as caesar]
             [clojure.string :as cs]
+            [cipher-analytical-machine.analyzers.language :as language]
             [cipher-analytical-machine.analyzers.analyzers :as ca])
   (:import [cipher_analytical_machine.ciphers.caesar Decrypted]
+           [cipher_analytical_machine.analyzers.caesar IsNonsense]
            [cipher_analytical_machine.analyzers.caesar FrequencyAnalyzer])
   (:gen-class))
 
@@ -50,10 +52,13 @@
 
 (defn frequency-analizer-get-plaintext
   "Return the plaintext from a ciphertext using simple analizer. The function is case-insensitive."
-  [ciphertext symbols letter-frequencies-string]
+  [ciphertext symbols letter-frequencies-string language-code]
   (let [decrypt (reify Decrypted
                   (decrypt [this message key symbols]
-                    (caesar/decrypt-message message key symbols)))]
-    (-> (new FrequencyAnalyzer ciphertext symbols letter-frequencies-string decrypt)
+                    (caesar/decrypt-message message key symbols)))
+        is-nonsense (reify IsNonsense
+                  (isNonsense [this message]
+                    (language/is-nonsense? message language-code)))]
+    (-> (new FrequencyAnalyzer ciphertext symbols letter-frequencies-string decrypt is-nonsense)
         .crack)))
 

src/cipher_analytical_machine/cli/actions/cracking.clj

@@ -0,0 +1,26 @@
+(ns cipher-analytical-machine.cli.actions.cracking
+  (:require
+   [cipher-analytical-machine.analyzers.caesar :as caesar-analyzers]
+   [cipher-analytical-machine.symbols.frequencies :as symbol-frequencies])
+  (:gen-class))
+
+(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)
+
+      :else
+      (caesar-analyzers/get-plaintext message symbols frequencies))))
+
+(defn cracking-actions
+  [options arguments action-type]
+  (let [cipher (:cipher options)]
+    (cond
+      (= cipher "Caesar")
+      (cracking-caesar options arguments))))
+

src/cipher_analytical_machine/cli/actions/cryptography.clj

@@ -0,0 +1,24 @@
+(ns cipher-analytical-machine.cli.actions.cryptography
+  (:require
+   [cipher-analytical-machine.ciphers.caesar :as caesar])
+  (:gen-class))
+
+(defn caesar-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 cryptography-actions
+  [options arguments action-type]
+  (let [cipher (:cipher options)]
+    (cond
+      (= cipher "Caesar")
+      (caesar-actions options arguments action-type))))
+

src/cipher_analytical_machine/cli/cli.clj

@@ -1,36 +1,14 @@
 (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]
+   [cipher-analytical-machine.cli.actions.cryptography :as cryptography]
+   [cipher-analytical-machine.cli.actions.cracking :as cracking]
    [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 +16,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 +39,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 +61,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))
@@ -153,38 +147,16 @@
     (save-output output options))
   (println output))
 
-(defn cracking-actions
-  [options arguments action-type]
-  (let [message (:message options)
-        symbols (:symbols options)
-        frequencies symbol-frequencies/english-letter-frequencies]
-    (cond
-      (= action-type :cracking)
-      (caesar-analyzers/get-plaintext message symbols frequencies)
-      )))
-
-(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)
+       (cryptography/cryptography-actions options arguments action-type)
 
        (= action-type :cracking)
-       (cracking-actions options arguments action-type))
+       (cracking/cracking-actions options arguments action-type))
 
      (show-and-save-output options))))
 

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"}})
+
+(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/main/java/cipher_analytical_machine/analyzers/caesar/FrequencyAnalyzer.java

@@ -1,25 +1,53 @@
 package cipher_analytical_machine.analyzers.caesar;
 
+import cipher_analytical_machine.analyzers.caesar.IsNonsense;
 import cipher_analytical_machine.ciphers.caesar.Decrypted;
+
+import java.util.HashMap;
 import java.util.Map;
+import java.util.Map.Entry;
 
 public class FrequencyAnalyzer {
     private String ciphertext;
-    private int key;
     private String symbols;
     private String symbol_frequences;
     private Decrypted decryptor;
+    private IsNonsense isNonsense;
 
-    public FrequencyAnalyzer(String ciphertext, String symbols, String symbol_frequences, Decrypted decryptor) {
+    public FrequencyAnalyzer(String ciphertext, String symbols, String symbol_frequences, Decrypted decryptor, IsNonsense isNonsense) {
 	    this.ciphertext = ciphertext;
-	this.key = 1;
-	this.symbols = symbols;
         this.symbol_frequences = symbol_frequences;
+        this.symbols = symbols;
 	    this.decryptor = decryptor;
+	    this.isNonsense = isNonsense;
     }
 
     public String crack() {
-	return decryptor.decrypt(ciphertext, key, symbols);
+        // Знаходимо кількість літер
+        Map<Character, Integer> encryptedLetterCounts = new HashMap<>();
+
+        for (char c : ciphertext.toLowerCase().toCharArray()) {
+            encryptedLetterCounts.put(c, encryptedLetterCounts.getOrDefault(c, 0) + 1);
+        }
+
+        // Знаходимо букву, яка зустрічається найчастіше
+        char mostFrequentEncryptedLetter = ' ';
+        int mostFrequentEncryptedLetterCount = 0;
+
+        for (Entry<Character, Integer> entry : encryptedLetterCounts.entrySet()) {
+            if (entry.getValue() > mostFrequentEncryptedLetterCount) {
+                mostFrequentEncryptedLetter = entry.getKey();
+                mostFrequentEncryptedLetterCount = entry.getValue();
+            }
+        }
+
+        // Обчислимо зміщення
+        int size = symbols.length();
+        int indexOfMostFrequentEncryptedLetter = symbols.indexOf(mostFrequentEncryptedLetter);
+        int indexOfMostFrequentLetter = symbols.indexOf(symbol_frequences.charAt(0));
+        int shift = (indexOfMostFrequentEncryptedLetter - indexOfMostFrequentLetter) % size;
+
+        return decryptor.decrypt(ciphertext, shift, symbols);
     }
 }
 

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

@@ -0,0 +1,6 @@
+package cipher_analytical_machine.analyzers.caesar;
+
+public interface IsNonsense {
+    boolean isNonsense(String message);
+}
+

test/cipher_analytical_machine/analyzers/caesar_test.clj

@@ -74,13 +74,3 @@
       (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))))))
-