rotor_machine 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bee549dee381db8f08c906984d17aa7a543733f38eb468102b56c7662443f2
-  data.tar.gz: e72ba384c15532351786ee8d3521e9c3316a230889f8799d5197e40f0749e561
+  metadata.gz: 8c6ce5057e6c37a1b68b51d95b163d24a77a082f88a67b5784ca88bfec9c70de
+  data.tar.gz: 1fc04d49911e0b2b22b76f4187cbbe17aac542f5125c6c9fb03ad73ba811cf4e
 SHA512:
-  metadata.gz: 43f67bbc06116c4c1a3d0ccef333f01ebb4c2eb2ff7b76528b2a03a8be4a4ece9f0f6e226ad34bc227aa6c9ca6323d6ec686ede3fd64026c84a10f08f4cc6c4d
-  data.tar.gz: 65a8df5ae035d2ff47fb1164ce30470566da792dd7c5a72779f525000f1e99c62b5bd19f0c3378634cccca8029e9546967426e5aea20fc12116abc5d86cd0215
+  metadata.gz: 9f9a30fb69dad2d52311d477d832618c3a33f535f966340ff27ce04fc057d65ffe603f0e7fd051e9662647e52fd05c85b834fb6b5badaa30078bc02018fc6800
+  data.tar.gz: ece40597dfcb3fee99a900a294a4e9a24dabc4479b09e4a97485ce33f3946ff6104ee50987e13b5e5350486e71009f73caced494685b25e78403f2ece457017e

data/README.md

@@ -72,7 +72,7 @@ have position "AAZ", their state after the next character is typed will
 be "ABA".
   
 To learn much more about the inner workings of actual Enigma machines,
-visit [https://en.wikipedia.org/wiki/Enigma_machine].
+visit [Enigma Machine (Wikipedia)](https://en.wikipedia.org/wiki/Enigma_machine).
   
 ###  The Signal Path of Letters
   
@@ -82,11 +82,11 @@ 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.
+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.
   
 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
@@ -95,9 +95,10 @@ a string of ciphertext. If you then reset the machine to its initial state
 and type the ciphertext characters into the machine, you'll produce your
 original plaintext.
   
-One consequence of the Enigma's design is that a plaintext letter will
-never encipher to itself. The Allies were able to exploit this property
-to help break the Enigma's encryption in World War II.
+One consequence of the Enigma's design is that a plaintext letter will never 
+encipher to itself. The Allies were able to exploit this property to help 
+[break the Enigma's encryption](https://en.wikipedia.org/wiki/Cryptanalysis_of_the_Enigma) 
+during World War II.
   
 ## Usage
 
@@ -144,7 +145,7 @@ machine.set_rotors("CFL")
 new_plaintext = machine.encipher(ciphertext)  # => "THISI SASUP ERSEC RETME SSAGE"
 ```
 
-## Example - Simplified Setup Using the Factory Methods
+## Example - Simplified Setup Using the Factory 
 
 ```ruby
 require 'rotor_machine'
@@ -157,7 +158,6 @@ machine = RotorMachine::Factory.build_machine(
 machine.set_rotors("CFL")
 
 plaintext = "This is a super secret message".upcase
-
 ciphertext = machine.encipher(plaintext)      # => "MYGMS ZLTWS AAIDD VTGOC RFKFO"
 
 machine.set_rotors("CFL")
@@ -194,7 +194,7 @@ the version number. (These tasks rewrite the file
 After using them, you'll need to run a `git add lib/rotor_machine/version.rb` 
 and `git commit -m "version bump"`.
 
-## Contributing
+### Contributing
 
 Bug reports and pull requests are welcome on GitHub at 
 [https://github.com/tammycravit/rotor_machine]. Pull requests for code changes 
@@ -207,17 +207,17 @@ contributors are expected to adhere to the
 Contributions from people who identify as women, BIPOC folx, LGBT folx, 
 and members of other marginalized communities are especially welcomed.
 
-## License
-
-The gem is available as open source under the terms of the 
-[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
-
-## Code of Conduct
+### Code of Conduct
 
 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).
 
+## License
+
+The gem is available as open source under the terms of the 
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
+
 ## Image Credits
 
 * Enigma image - from [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Bundesarchiv_Bild_183-2007-0705-502,_Chiffriermaschine_%22Enigma%22.jpg),

data/lib/rotor_machine/factory.rb

@@ -121,35 +121,14 @@ module RotorMachine
       return RotorMachine::Plugboard.new()
     end
 
-    ##
-    # Build a set of {Rotor}s and return them.
-    #
-    # @param rotors [Array] A list of rotor types. Each type should be either
-    # a symbol corresponding to a constant in the {Rotor} class, or a 26 
-    # character string providing the sequence of letters for the rotor.
-    # @param initial_positions [String] The starting letter to set each rotor
-    # to.
-    # @return [Array] An array of {Rotor} objects.
-    def build_rotor_set(rotors=[], initial_positions=nil)
-      ra = rotors.each.collect { |r| build_rotor(rotor_kind: r) }
-      unless initial_positions.nil?
-        ra.each_with_index do |r, i|
-          unless initial_positions[i].nil?
-            r.position = initial_positions[i] 
-          end
-        end
-      end
-      return ra
-    end
-
     ##
     # Build a {Machine} and return it.
     #
     # The options hash can provide the following options:
     #
     # - `:rotors` - An array of {Rotor} objects. This can be constructed
-    #   manually, through multiple calls to {#build_rotor}, or through a single
-    #   call to {#build_rotor_set}. Alternatively, you can pass an array of
+    #   manually, or through multiple calls to {#build_rotor}.
+    #   Alternatively, you can pass an array of
     #   symbols which match the constants in the {Rotor} class, and {Rotor}
     #   objects will be built from those (using default position and step
     #   sizes).
@@ -186,7 +165,7 @@ module RotorMachine
         end
       end
 
-      m.plugboard = RotorMachine::Plugboard.new()
+      m.plugboard = build_plugboard()
       unless connections.empty?
         connections.each { |from, to| m.plugboard.connect(from, to) }
       end
@@ -209,9 +188,5 @@ module RotorMachine
     ##
     # {make_machine} is an alias for {build_machine}
     alias :make_machine :build_machine
-
-    ##
-    # {make_rotor_set} is an alias for {build_rotor_set}
-    alias :make_rotor_set :build_rotor_set
   end
 end

data/lib/rotor_machine/machine.rb

@@ -88,10 +88,12 @@ module RotorMachine
     # - Reflector A
     # - An empty plugboard with no connections
     def self.default_machine
-      RotorMachine::Factory.build_machine(
-        rotors: RotorMachine::Factory::build_rotor_set([:ROTOR_I, :ROTOR_II, :ROTOR_III], "AAA"),
+      m = RotorMachine::Factory.build_machine(
+        rotors: [:ROTOR_I, :ROTOR_II, :ROTOR_III],
         reflector: RotorMachine::Factory::build_reflector(reflector_kind: :REFLECTOR_A)
       )
+      m.set_rotors("AAA")
+      return m
     end
 
     ##

data/lib/rotor_machine/reflector.rb

@@ -116,6 +116,14 @@ module RotorMachine
       return :CUSTOM
     end
 
+    ##
+    # Return the sequence of letters on the reflector.
+    # 
+    # @return [String] The sequence of letters on the reflector.
+    def letters
+      @letters.join("")
+    end
+
     ##
     # Get the current letter position of the rotor.
     #

data/lib/rotor_machine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rotor_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Tammy Cravit
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tcravit_ruby_lib