ruby/simple-cipher: 1st iteration

README.md

@@ -20,7 +20,7 @@ Exercism Workspace
 |   July        |  Jurassic          |  C            (5/5),  C++   (5/5),  Fortran  (0/5)  |
 |   August      |  Apps              |  Dart         (5/5),  Java  (0/5),  Kotlin   (0/5)  |
 |   September   |  Slimline          |  Awk          (5/5),  Bash\*  (5/5),  jq       (0/5),  Perl  (0/5)  |
-|   October     |  Object-Oriented   |  Ruby         (0/5),  Java  (0/5)  |
+|   October     |  Object-Oriented   |  Ruby         (1/5),  Java  (0/5)  |
 |   November    |  Nibbly            |  |
 |   December    |  Diversions        |  |
 

ruby/README.md

@@ -67,3 +67,4 @@
 - [series](./series/README.md)
 - [word-count](./word-count/README.md)
 - [allergies](./allergies/README.md)
+- [simple-cipher](./simple-cipher/README.md)

ruby/simple-cipher/README.md

@@ -92,4 +92,9 @@ Take a look at [Diffie-Hellman on Wikipedia][dh] for one of the first implementa
 
 ### Based on
 
-Substitution Cipher at Wikipedia - https://en.wikipedia.org/wiki/Substitution_cipher
+Substitution Cipher at Wikipedia - https://en.wikipedia.org/wiki/Substitution_cipher
+
+### My Solution
+
+- [my solution](./simple_cipher.rb)
+- [run-tests](./run-tests-ruby.txt)

ruby/simple-cipher/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "line": 100.0
+  }
+}

ruby/simple-cipher/coverage/.resultset.json

@@ -0,0 +1,55 @@
+{
+  "test:exercism": {
+    "coverage": {
+      "/home/vpayno/git_vpayno/exercism-workspace/ruby/simple-cipher/simple_cipher.rb": {
+        "lines": [
+          null,
+          null,
+          null,
+          null,
+          1,
+          1,
+          null,
+          1,
+          417,
+          null,
+          17,
+          16,
+          null,
+          null,
+          1,
+          8,
+          83,
+          null,
+          null,
+          null,
+          1,
+          6,
+          60,
+          null,
+          null,
+          null,
+          1,
+          null,
+          1,
+          83,
+          null,
+          null,
+          1,
+          60,
+          null,
+          null,
+          1,
+          286,
+          null,
+          null,
+          1,
+          143,
+          null,
+          null
+        ]
+      }
+    },
+    "timestamp": 1698525013
+  }
+}

ruby/simple-cipher/coverage/coverage.xml

@@ -0,0 +1,40 @@
+<?xml version='1.0'?> 
+<!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
+<!-- Generated by simplecov-cobertura version 2.1.0 (https://github.com/dashingrocket/simplecov-cobertura) -->
+<coverage line-rate="1.0" lines-covered="21" lines-valid="21" complexity="0" version="0" timestamp="1698525013">
+  <sources>
+    <source>/home/vpayno/git_vpayno/exercism-workspace/ruby/simple-cipher</source>
+  </sources>
+  <packages>
+    <package name="simple-cipher" line-rate="1.0" complexity="0">
+      <classes>
+        <class name="simple_cipher" filename="simple_cipher.rb" line-rate="1.0" complexity="0">
+          <methods/>
+          <lines>
+            <line number="5" hits="1"/>
+            <line number="6" hits="1"/>
+            <line number="8" hits="1"/>
+            <line number="9" hits="417"/>
+            <line number="11" hits="17"/>
+            <line number="12" hits="16"/>
+            <line number="15" hits="1"/>
+            <line number="16" hits="8"/>
+            <line number="17" hits="83"/>
+            <line number="21" hits="1"/>
+            <line number="22" hits="6"/>
+            <line number="23" hits="60"/>
+            <line number="27" hits="1"/>
+            <line number="29" hits="1"/>
+            <line number="30" hits="83"/>
+            <line number="33" hits="1"/>
+            <line number="34" hits="60"/>
+            <line number="37" hits="1"/>
+            <line number="38" hits="286"/>
+            <line number="41" hits="1"/>
+            <line number="42" hits="143"/>
+          </lines>
+        </class>
+      </classes>
+    </package>
+  </packages>
+</coverage>

ruby/simple-cipher/run-tests-ruby.txt

@@ -0,0 +1,232 @@
+Running automated test file(s):
+
+
+===============================================================================
+
+Running: ../../.github/citools/ruby/ruby-lint-rubycritic
+
+Running RubyCritic
+
+Ruby version:
+
+	ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-linux]
+	rbenv 1.2.0-11-ge4f61e6
+
+
+ ==============================================================================
+
+Running: rubycritic --path .rubycritic --format console --no-browser .
+
+running flay smells
+.
+running flog smells
+..
+running reek smells
+..
+running complexity
+..
+running attributes
+..
+running churn
+..
+running simple_cov
+..
+/home/vpayno/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/rubycritic-4.6.1/lib/rubycritic/generators/text/list.rb:13: warning: Passing safe_level with the 2nd argument of ERB.new is deprecated. Do not use it, and specify other arguments as keyword arguments.
+/home/vpayno/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/rubycritic-4.6.1/lib/rubycritic/generators/text/list.rb:13: warning: Passing trim_mode with the 3rd argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, trim_mode: ...) instead.
+Cipher:
+  Rating:       B
+  Churn:        0
+  Complexity:   54.66
+  Duplication:  32
+  Smells:       4
+    * (DuplicateCode) Similar code found in 2 nodes
+      - simple_cipher.rb:15
+      - simple_cipher.rb:21
+    * (ControlParameter) Cipher#initialize is controlled by argument 'key'
+      - simple_cipher.rb:9
+    * (UtilityFunction) Cipher#to_char doesn't depend on instance state (maybe move it to another class?)
+      - simple_cipher.rb:41
+    * (UtilityFunction) Cipher#to_ord doesn't depend on instance state (maybe move it to another class?)
+      - simple_cipher.rb:37
+
+RandomKeyCipherTest:
+  Rating:       B
+  Churn:        0
+  Complexity:   62.74
+  Duplication:  0
+  Smells:       8
+    * (InstanceVariableAssumption) PseudoShiftCipherTest assumes too much for instance variable '@cipher'
+      - simple_cipher_test.rb:128
+    * (InstanceVariableAssumption) RandomKeyCipherTest assumes too much for instance variable '@cipher'
+      - simple_cipher_test.rb:28
+    * (InstanceVariableAssumption) SubstitutionCipherTest assumes too much for instance variable '@cipher'
+      - simple_cipher_test.rb:82
+    * (InstanceVariableAssumption) SubstitutionCipherTest assumes too much for instance variable '@key'
+      - simple_cipher_test.rb:82
+    * (IrresponsibleModule) IncorrectKeyCipherTest has no descriptive comment
+      - simple_cipher_test.rb:59
+    * (IrresponsibleModule) PseudoShiftCipherTest has no descriptive comment
+      - simple_cipher_test.rb:128
+    * (IrresponsibleModule) RandomKeyCipherTest has no descriptive comment
+      - simple_cipher_test.rb:28
+    * (IrresponsibleModule) SubstitutionCipherTest has no descriptive comment
+      - simple_cipher_test.rb:82
+Score: 82.2
+
+real	0m0.652s
+user	0m0.544s
+sys	0m0.104s
+
+
+ ==============================================================================
+
+Exit code: 0
+
+real	0m0.740s
+user	0m0.588s
+sys	0m0.154s
+
+real	0m0.742s
+user	0m0.589s
+sys	0m0.155s
+
+===============================================================================
+
+Running: ../../.github/citools/ruby/ruby-lint-formatter
+
+Running Ruby Formatter
+
+Ruby version:
+
+	ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-linux]
+	rbenv 1.2.0-11-ge4f61e6
+
+
+ ==============================================================================
+
+Running: rubocop -a .
+
+Inspecting 2 files
+.C
+
+Offenses:
+
+simple_cipher_test.rb:28:1: C: Style/Documentation: Missing top-level documentation comment for class RandomKeyCipherTest.
+class RandomKeyCipherTest < Minitest::Test
+^^^^^^^^^^^^^^^^^^^^^^^^^
+simple_cipher_test.rb:59:1: C: Style/Documentation: Missing top-level documentation comment for class IncorrectKeyCipherTest.
+class IncorrectKeyCipherTest < Minitest::Test
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+simple_cipher_test.rb:82:1: C: Style/Documentation: Missing top-level documentation comment for class SubstitutionCipherTest.
+class SubstitutionCipherTest < Minitest::Test
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+simple_cipher_test.rb:128:1: C: Style/Documentation: Missing top-level documentation comment for class PseudoShiftCipherTest.
+class PseudoShiftCipherTest < Minitest::Test
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+2 files inspected, 4 offenses detected
+
+real	0m0.944s
+user	0m0.809s
+sys	0m0.225s
+
+
+ ==============================================================================
+
+Exit code: -1
+
+real	0m1.039s
+user	0m0.857s
+sys	0m0.276s
+
+real	0m1.041s
+user	0m0.858s
+sys	0m0.277s
+
+===============================================================================
+
+Running: ../../.github/citools/ruby/ruby-test-with-coverage
+
+Running Ruby Tests With Coverage
+
+Ruby version:
+
+	ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-linux]
+	rbenv 1.2.0-11-ge4f61e6
+
+
+ ==============================================================================
+
+Running: rm -rf ./coverage
+
+
+real	0m0.001s
+user	0m0.001s
+sys	0m0.000s
+
+
+ ==============================================================================
+
+Running: ruby ./simple_cipher_test.rb -v
+
+Run options: -v --seed 5422
+
+# Running:
+
+RandomKeyCipherTest#test_cipher_encode = 0.00 s = .
+RandomKeyCipherTest#test_cipher_key_is_letters = 0.00 s = .
+RandomKeyCipherTest#test_cipher_decode = 0.00 s = .
+RandomKeyCipherTest#test_cipher_reversible = 0.00 s = .
+SubstitutionCipherTest#test_cipher_decode = 0.00 s = .
+SubstitutionCipherTest#test_cipher_encode = 0.00 s = .
+SubstitutionCipherTest#test_cipher_encode_wrap = 0.00 s = .
+SubstitutionCipherTest#test_cipher_key_is_as_submitted = 0.00 s = .
+SubstitutionCipherTest#test_cipher_reversible = 0.00 s = .
+SubstitutionCipherTest#test_double_shift_encode = 0.00 s = .
+PseudoShiftCipherTest#test_cipher_encode = 0.00 s = .
+PseudoShiftCipherTest#test_cipher_reversible = 0.00 s = .
+PseudoShiftCipherTest#test_cipher_decode = 0.00 s = .
+IncorrectKeyCipherTest#test_cipher_with_empty_key = 0.00 s = .
+IncorrectKeyCipherTest#test_cipher_with_caps_key = 0.00 s = .
+IncorrectKeyCipherTest#test_cipher_with_numeric_key = 0.00 s = .
+
+Finished in 0.006156s, 2599.2398 runs/s, 2761.6922 assertions/s.
+
+16 runs, 17 assertions, 0 failures, 0 errors, 0 skips
+Coverage report generated for test:exercism to /home/vpayno/git_vpayno/exercism-workspace/ruby/simple-cipher/coverage/coverage.xml. 21 / 21 LOC (100.00%) covered
+
+real	0m0.189s
+user	0m0.133s
+sys	0m0.057s
+
+
+ ==============================================================================
+
+Coverage: 100.0%
+
+ ==============================================================================
+
+Exit code: 0
+
+real	0m0.251s
+user	0m0.160s
+sys	0m0.095s
+
+real	0m0.253s
+user	0m0.161s
+sys	0m0.096s
+
+===============================================================================
+
+Running: misspell .
+
+real	0m0.025s
+user	0m0.024s
+sys	0m0.013s
+
+===============================================================================
+
+/home/vpayno/git_vpayno/exercism-workspace/ruby
+
+===============================================================================
+