rotor_machine 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca40c7b0bde73376d2432b9bbaf53889c2e221732e9bd9ae7f36ab7007cb1ded
-  data.tar.gz: 72be1507e5a665d8bc5af4153121797824241761be5106d86deef1c6574be5a4
+  metadata.gz: 6e9e73f3f0d0dc5bf22074adf36c6232392581112ecddd4134ecdc4f64f6dc94
+  data.tar.gz: 934ff208c6cc22b67140633fdbca5f9b18c80a4c057448aad79b8c8859d3b562
 SHA512:
-  metadata.gz: d9100dd5fb06326ec6dfad165c05c31a8e566f3e0645404358a263d1ad3eb7eb6b0e029149df61c727c85f13d811182a83ee3e1a5207540b512b91893421dc01
-  data.tar.gz: 7a02cb6c72df3202d7c27a4df9560e1b41fbe203b34b101074f53ba0a3dacb4636f02a667bfcab9d4dc4c08c91a051fe95867b87505b1612b37a949725672698
+  metadata.gz: 4430444a33c8caf979d1854bb48539af1e3da74989a5da10a55cb21b6a415e7bdc46156fd5ee0cfc9c5153488f8667f9fa4e96e13d599236aae7028a96e10156
+  data.tar.gz: 0e4ffc2ff7a4ea276cc239d23a9b8bbf7fe1295f3dfc1376c3d23ed905cb04b4e3d04380fbfa8f8a9595c6c7f9800e4dabda9e434b104ccc4fa78b46cc049082

data/README.md

@@ -1,5 +1,7 @@
 # RotorMachine
 
+![German Enigma machine](https://github.com/tammycravit/rotor_machine/blob/master/images/Bundesarchiv_Enigma.jpg?raw=1)
+
 The `RotorMachine` gem provides a simple Ruby implementation of the 
 [Enigma](https://en.wikipedia.org/wiki/Enigma_machine) rotor encryption machine.
 
@@ -31,26 +33,30 @@ Or install it yourself as:
 
 ## Architecture
 
-The `RotorMachine::Machine` class serves as the entrypoint and orchestrator for an Enigma machine.
+The [`RotorMachine::Machine`](http://www.rubydoc.info/gems/rotor_machine/RotorMachine/Machine) 
+class serves as the entrypoint and orchestrator for an Enigma machine.
   
 ### Components of an Enigma machine
   
-The Enigma machine, as represented by the RotorMachine module, consists
-of the following components:
+The Enigma machine, as represented by the [RotorMachine](http://www.rubydoc.info/gems/rotor_machine) 
+module, consists of the following components:
   
-* One or more rotors, which perform the transposition ciphering and also
-  rotate to produce a polyalphabetic (rather than simple substitution)
-  cipher.
+* One or more [rotors](http://www.rubydoc.info/gems/rotor_machine/RotorMachine/Rotor), which 
+  perform the transposition ciphering and also rotate to produce a polyalphabetic (rather 
+  than simple substitution) cipher.
   
-* A reflector, which performs a simple symmetric substitution of letters
+* A [reflector](http://www.rubydoc.info/gems/rotor_machine/RotorMachine/Reflector), which 
+  performs a simple symmetric substitution of letters
   
-* A plugboard, which allows pairs of letters to be transposed on a
-  per-message basis.
+* A [plugboard](http://www.rubydoc.info/gems/rotor_machine/RotorMachine/Plugboard), which 
+  allows pairs of letters to be transposed on a per-message basis.
   
-On an actual Enigma machine, these components are all electromechanical,
-and the Enigma also included a keyboard, a grid of lights to show the
-results, and in some cases a printer. Since this is a simulated Enigma,
-obviously, no keyboard/printer are supplied here.
+On an actual Enigma machine, these components are all electromechanical, and 
+the Enigma also included a keyboard, a grid of lights to show the results, and 
+in some cases a printer. Since this is a simulated Enigma, obviously, no 
+keyboard/printer are supplied here. In this simulation, the
+[Machine](http://www.rubydoc.info/gems/rotor_machine/RotorMachine/Machine)
+class serves to encapsulate all of these components.
   
 The polyalphabetic encryption of the Enigma comes from the fact that the
 rotors are linked (mechanically in a real Enigma) so that they rotate
@@ -70,17 +76,19 @@ visit [https://en.wikipedia.org/wiki/Enigma_machine].
   
 ###  The Signal Path of Letters
   
-On a physical Enigma machine, the electrical signal from a keypress is
-routed through the plugboard, then through each of the rotors in sequence
+Here's a visual depiction of the signal path of a single character through
+a (physical) Enigma machine:
+
+![Enigma signal path](https://github.com/tammycravit/rotor_machine/blob/master/images/File:Enigma_wiring_kleur.png?raw=1)
+
+As you can see, the electrical signal from a keypress is routed through the 
+plugboard, then through each of the rotors in sequence
 from left to right. The signal then passes through the reflector (where it
 is transposed again), then back through the rotors in reverse order, and 
 finally back through the plugboard a second time before being displayed on
 the light grid and/or printer.
-
-[https://commons.wikimedia.org/wiki/File:Enigma_wiring_kleur.svg] depicts
-this visually.
   
-One important consequence of this signal path is that encryption and
+The result of the machine's signal path being a loop is that encryption and
 decryption are the same operation. That is to say, if you set the rotors
 and plugboard, and then type your plaintext into the machine, you'll get
 a string of ciphertext. If you then reset the machine to its initial state
@@ -116,12 +124,13 @@ no rotors or reflector.
 require 'rotor_machine'
 
 machine = RotorMachine::Machine.empty_machine
+
 machine.rotors << RotorMachine::Rotor.new(RotorMachine::Rotor::ROTOR_I, "A", 1)
 machine.rotors << RotorMachine::Rotor.new(RotorMachine::Rotor::ROTOR_II, "A", 1)
 machine.rotors << RotorMachine::Rotor.new(RotorMachine::Rotor::ROTOR_III, "A", 1)
 machine.reflector = RotorMachine::Reflector.new(RotorMachine::Reflector::REFLECTOR_A)
-machine.plugboard.connect("A", "M")
-machine.plugboard.connect("Q", "K")
+
+machine.plugboard.connect("A", "M") machine.plugboard.connect("Q", "K")
 
 machine.set_rotors("CFL")
 plaintext = "This is a super secret message".upcase
@@ -135,9 +144,12 @@ new_plaintext == plaintext                    # => true
 
 ## Documentation
 
-The classes in `rotor_machine/lib/rotor_machine/*.rb` all contain doc comments that 
-pretty exhaustively describe their operation. The RSpec tests in the `spec/` directory
-are also instructive for how the library works and how to use it.
+The classes in 
+[`lib/rotor_machine/`](https://github.com/tammycravit/rotor_machine/tree/master/lib/rotor_machine) 
+all contain [documentation](http://www.rubydoc.info/gems/rotor_machine/) that 
+pretty exhaustively describe their operation. 
+The RSpec tests in the [`spec/`](https://github.com/tammycravit/rotor_machine/tree/master/spec) 
+directory are also instructive for how the library works and how to use it.
 
 ## Development
 
@@ -151,12 +163,14 @@ To release a new version, update the version number in `version.rb`, and then
 run `bundle exec rake release`, which will create a git tag for the version, 
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-This gem depends on the `tcravit_ruby_lib` gem, which provides Rake tasks to
-update the version number. You can use the `bundle exec rake version:bump:build`,
-`bundle exec version:bump:minor` and `bundle exec rake version:bump:major` tasks
-to increment the parts of the version number. (These tasks rewrite the file
-`lib/rotor_machine/version.rb`). After using them, you'll need to run a
-`git add lib/rotor_machine/version.rb` and `git commit -m "version bump"`.
+This gem depends on the [`tcravit_ruby_lib`](https://github.com/tammycravit/tcravit_ruby_lib) 
+gem, which provides Rake tasks to update the version number. You can use the 
+`bundle exec rake version:bump:build`, `bundle exec version:bump:minor` and 
+`bundle exec rake version:bump:major` tasks to increment the parts of 
+the version number. (These tasks rewrite the file
+[`lib/rotor_machine/version.rb`](https://github.com/tammycravit/rotor_machine/blob/master/lib/rotor_machine/version.rb). 
+After using them, you'll need to run a `git add lib/rotor_machine/version.rb` 
+and `git commit -m "version bump"`.
 
 ## Contributing
 
@@ -182,3 +196,11 @@ Everyone interacting in the RotorMachine project’s codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the 
 [code of conduct](https://github.com/tammycravit/rotor_machine/blob/master/CODE_OF_CONDUCT.md).
 
+## Image Credits
+
+* Enigma image - from [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Bundesarchiv_Bild_183-2007-0705-502,_Chiffriermaschine_%22Enigma%22.jpg),
+  provided by Das Bundesarchiv (German Federal Archives).
+
+* Enigma signal path image - from [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Enigma_wiring_kleur.svg), 
+  by [MesserWoland](https://commons.wikimedia.org/wiki/User:MesserWoland)
+

data/lib/rotor_machine/version.rb

@@ -1,4 +1,4 @@
 module RotorMachine
-	VERSION_DATA = [1, 0, 6]
+	VERSION_DATA = [1, 0, 7]
 	VERSION = VERSION_DATA.join(".")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotor_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Tammy Cravit
@@ -100,6 +100,8 @@ files:
 - bin/console
 - bin/setup
 - exe/rotor_machine
+- images/Bundesarchiv_Enigma.jpg
+- images/File:Enigma_wiring_kleur.png
 - lib/rotor_machine.rb
 - lib/rotor_machine/machine.rb
 - lib/rotor_machine/plugboard.rb