rotor_machine 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c14a896f17d79c8e20bd1200db2e03b9faa5dd1a8cd54a6f9dc7b09874914c1
-  data.tar.gz: 1550e595a556ff4c2ae33b89450e66ba25e46f702a8b635b8790f232d858265d
+  metadata.gz: 54bee549dee381db8f08c906984d17aa7a543733f38eb468102b56c7662443f2
+  data.tar.gz: e72ba384c15532351786ee8d3521e9c3316a230889f8799d5197e40f0749e561
 SHA512:
-  metadata.gz: 4f09458966fbaa7ef8e399960a9d2d05cb003504fca2713e0c89d59a710fbb9f7e2b71fd6d2a11f3acfea4ad3cc1c64532c79c2818215d4c2975db823815f1dd
-  data.tar.gz: 404d1be8f4939c3c141784ef4ffbf8d96cf0dc0a94eb881b9ebda058dc731c827d58446285ff6ef6f2f5f22f9f22ca5bcfa55208cd52b89d307d4ed12e0a6c74
+  metadata.gz: 43f67bbc06116c4c1a3d0ccef333f01ebb4c2eb2ff7b76528b2a03a8be4a4ece9f0f6e226ad34bc227aa6c9ca6323d6ec686ede3fd64026c84a10f08f4cc6c4d
+  data.tar.gz: 65a8df5ae035d2ff47fb1164ce30470566da792dd7c5a72779f525000f1e99c62b5bd19f0c3378634cccca8029e9546967426e5aea20fc12116abc5d86cd0215

data/README.md

@@ -118,6 +118,9 @@ factory methods whcih set up, respectively, a fully configured machine
 with a default set of rotors and reflector, and an empty machine with
 no rotors or reflector.
 
+You can also create a new `RotorMachine::Machine` (or its various parts)
+using the `RotorMachine::Factory` methods, as shown in the second example.
+
 ## Example
 
 ```ruby
@@ -130,16 +133,35 @@ 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
-ciphertext = machine.encipher(plaintext)      # => "MYGM AO I VVTDI QZXMGY AOGVIRJ"
+ciphertext = machine.encipher(plaintext)      # => "MYGMS ZLTWS AAIDD VTGOC RFKFO"
+
+machine.set_rotors("CFL")
+new_plaintext = machine.encipher(ciphertext)  # => "THISI SASUP ERSEC RETME SSAGE"
+```
+
+## Example - Simplified Setup Using the Factory Methods
+
+```ruby
+require 'rotor_machine'
 
+machine = RotorMachine::Factory.build_machine(
+  rotors: [:ROTOR_I, :ROTOR_II, :ROTOR_III],
+  reflector: :REFLECTOR_A,
+  connections: {"A" => "M", "Q" => "K" }
+)
 machine.set_rotors("CFL")
-new_plaintext = machine.encipher(ciphertext)  # => "THIS IS A SUPER SECRET MESSAGE"
 
-new_plaintext == plaintext                    # => true
+plaintext = "This is a super secret message".upcase
+
+ciphertext = machine.encipher(plaintext)      # => "MYGMS ZLTWS AAIDD VTGOC RFKFO"
+
+machine.set_rotors("CFL")
+new_plaintext = machine.encipher(ciphertext)  # => "THISI SASUP ERSEC RETME SSAGE"
 ```
 
 ## Documentation

data/lib/rotor_machine/factory.rb

@@ -148,9 +148,16 @@ module RotorMachine
     # 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}.
-    # - `:reflector` - A {Reflector object.
+    #   manually, through multiple calls to {#build_rotor}, or through a single
+    #   call to {#build_rotor_set}. 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).
+    #
+    # - `:reflector` - A {Reflector} object. Alternatively, a symbol
+    #   matching one of the reflector type constants can be passed in, and
+    #   a {Reflector} of the specified type will be created.j
+    #
     # - `:connections` - A {Hash} of connections to make on the new {Machine}'s
     #   {Plugboard}.
     #
@@ -162,8 +169,23 @@ module RotorMachine
       connections = options.fetch(:connections, {})
 
       m = RotorMachine::Machine.new()
-      rotors.each { |r| m.rotors << r }
-      m.reflector = reflector
+      rotors.each do |r|
+        if r.class.name == "RotorMachine::Rotor"
+          m.rotors << r
+        elsif r.class.name == "Symbol"
+          m.rotors << RotorMachine::Factory.build_rotor(rotor_kind: r)
+        end
+      end
+
+      unless reflector.nil?
+        if reflector.class.name == "Symbol"
+          m.reflector = RotorMachine::Factory.build_reflector(reflector_kind: reflector)
+        elsif reflector.class.name == "RotorMachine::Reflector"
+          m.reflector = reflector
+        else
+        end
+      end
+
       m.plugboard = RotorMachine::Plugboard.new()
       unless connections.empty?
         connections.each { |from, to| m.plugboard.connect(from, to) }

data/lib/rotor_machine/version.rb

@@ -1,4 +1,4 @@
 module RotorMachine
-	VERSION_DATA = [1, 0, 11]
+	VERSION_DATA = [1, 0, 12]
 	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.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Tammy Cravit