enigma_machine 0.0.1.alpha1 → 0.0.1

data/README.md

@@ -0,0 +1,38 @@
+# EnigmaMachine
+
+This is a simulator for an [Enigma Machine](http://en.wikipedia.org/wiki/Enigma_machine). It currently simulates both the Enigma I/M3 and the Enigma M4. It also allows for specifying your own custom rotor/reflector configurations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enigma_machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enigma_machine
+
+## Usage
+
+    e = EnigmaMachine.new(
+      :reflector => :B,
+      :rotors => [[:i, 10], [:ii, 14], [:iii, 21]],
+      :plug_pairs => %w(AP BR CM FZ GJ IL NT OV QS WX)
+    )
+    e.set_rotors('V', 'Q', 'Q')
+    
+    result = e.translate('HABHV HLYDF NADZY')
+
+See `integration_spec.rb` for some more examples
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/enigma_machine/rotor.rb

@@ -1,16 +1,16 @@
 class EnigmaMachine
   class Rotor
     STANDARD_ROTORS = {
-      :i      => "EKMFLGDQVZNTOWYHXUSPAIBRCJ_A",
-      :ii     => "AJDKSIRUXBLHWTMCQGZNPYFVOE_A",
-      :iii    => "BDFHJLCPRTXVZNYEIWGAKMUSQO_A",
-      :iv     => "ESOVPZJAYQUIRHXLNFTGKDCMWB_A",
-      :v      => "VZBRGITYUPSDNHLXAWMJQOFECK_A",
-      :vi     => "JPGVOUMFYQBENHZRDKASXLICTW_A",
-      :vii    => "NZJHGRCXMYSWBOUFAIVLPEKQDT_A",
-      :viii   => "FKQHTLXOCBJSPDZRAMEWNIUYGV_A",
-      :beta   => "LEYJVCNIXWPBQMDRTAKZGFUHOS_A",
-      :gamma  => "FSOKANUERHMBTIYCWLQPZXVGJD_A",
+      :i      => "EKMFLGDQVZNTOWYHXUSPAIBRCJ_Q",
+      :ii     => "AJDKSIRUXBLHWTMCQGZNPYFVOE_E",
+      :iii    => "BDFHJLCPRTXVZNYEIWGAKMUSQO_V",
+      :iv     => "ESOVPZJAYQUIRHXLNFTGKDCMWB_J",
+      :v      => "VZBRGITYUPSDNHLXAWMJQOFECK_Z",
+      :vi     => "JPGVOUMFYQBENHZRDKASXLICTW_MZ",
+      :vii    => "NZJHGRCXMYSWBOUFAIVLPEKQDT_MZ",
+      :viii   => "FKQHTLXOCBJSPDZRAMEWNIUYGV_MZ",
+      :beta   => "LEYJVCNIXWPBQMDRTAKZGFUHOS_", # The beta and gamma rotors caould only go 
+      :gamma  => "FSOKANUERHMBTIYCWLQPZXVGJD_", # in position 4, and hence have no notches.
     }
 
     def initialize(rotor_spec, ring_setting, decorated)
@@ -18,8 +18,9 @@ class EnigmaMachine
         raise ConfigurationError unless STANDARD_ROTORS.has_key?(rotor_spec)
         rotor_spec = STANDARD_ROTORS[rotor_spec]
       end
-      mapping, step_points = rotor_spec.split('_', 2)
+      mapping, notch_positions = rotor_spec.split('_', 2)
       @mapping = mapping.each_char.map {|c| ALPHABET.index(c) }
+      @notch_positions = notch_positions.split('')
       @ring_offset = ring_setting - 1
       @decorated = decorated
       self.position = 'A'
@@ -36,6 +37,10 @@ class EnigmaMachine
       @position = (@position + 1).modulo(26)
     end
 
+    def at_notch?
+      @notch_positions.include?(self.position)
+    end
+
     def forward(letter)
       index = add_offset ALPHABET.index(letter)
       new_index = sub_offset @mapping[index]

data/lib/enigma_machine/version.rb

@@ -1,3 +1,3 @@
 class EnigmaMachine
-  VERSION = "0.0.1.alpha1"
+  VERSION = "0.0.1"
 end

data/lib/enigma_machine.rb

@@ -28,8 +28,8 @@ class EnigmaMachine
       case letter
       when /[A-Z]/
         press_key(letter)
-      when ' '
-        ' '
+      when /[ -]/
+        letter
       end
     end.join
   end
@@ -37,7 +37,8 @@ class EnigmaMachine
   private
 
   def advance_rotors
-    # Temporarily only advance right rotor
+    @rotors[-3].advance_position if @rotors[-2].at_notch?
+    @rotors[-2].advance_position if @rotors[-2].at_notch? or @rotors[-1].at_notch?
     @rotors[-1].advance_position
   end
 end

data/spec/enigma_machine_spec.rb

@@ -63,10 +63,11 @@ describe EnigmaMachine do
       @e.translate('ABC').should == 'BCD'
     end
 
-    it "should pass through spaces unmodified" do
+    it "should pass through spaces and dashes unmodified" do
       @e.should_not_receive(:press_key).with(' ')
+      @e.should_not_receive(:press_key).with('-')
 
-      @e.translate('ABC DEF').should == 'ZZZ ZZZ'
+      @e.translate('ABCDE F----').should == 'ZZZZZ Z----'
     end
 
     it "should upcase the input before passing to press_key" do
@@ -109,6 +110,83 @@ describe EnigmaMachine do
   end
 
   describe "advancing rotors" do
+    before :each do
+      @left_rotor = mock("Rotor", :at_notch? => false, :advance_position => nil)
+      @middle_rotor = mock("Rotor", :at_notch? => false, :advance_position => nil)
+      @right_rotor = mock("Rotor", :at_notch? => false, :advance_position => nil)
+      EnigmaMachine::Rotor.stub!(:new).with(:i, anything(), anything()).and_return(@left_rotor)
+      EnigmaMachine::Rotor.stub!(:new).with(:ii, anything(), anything()).and_return(@middle_rotor)
+      EnigmaMachine::Rotor.stub!(:new).with(:iii, anything(), anything()).and_return(@right_rotor)
+      EnigmaMachine::Reflector.stub!(:new)
+      EnigmaMachine::Plugboard.stub!(:new)
+
+      @e = EnigmaMachine.new(:rotors => [[:i,1], [:ii,2], [:iii,3]])
+    end
+
+    describe "right rotor" do
+      it "should be advanced every time" do
+        @right_rotor.should_receive(:advance_position)
+        @e.send(:advance_rotors)
+      end
+    end
+
+    describe "middle rotor" do
+      it "should be advanced if the right rotor is at a notch" do
+        @right_rotor.stub!(:at_notch?).and_return(true)
+        @middle_rotor.should_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+
+      it "should be advanced if it is at a notch" do
+        @middle_rotor.stub!(:at_notch?).and_return(true)
+        @middle_rotor.should_receive(:advance_position)
 
+        @e.send(:advance_rotors)
+      end
+
+      it "should not be advanced otherwise" do
+        @middle_rotor.should_not_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+    end
+
+    describe "left rotor" do
+      it "should be advanced if the middle rotor is at a notch" do
+        @middle_rotor.stub!(:at_notch?).and_return(true)
+        @left_rotor.should_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+
+      it "should not be advanced if it is at a notch" do
+        @left_rotor.stub!(:at_notch?).and_return(true)
+        @left_rotor.should_not_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+
+      it "should not be advanced otherwise" do
+        @left_rotor.should_not_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+    end
+
+    describe "4th rotor (when present)" do
+      before :each do
+        @fourth_rotor = mock("Rotor", :at_notch? => false, :advance_position => nil)
+        @e.instance_variable_get('@rotors').unshift(@fourth_rotor)
+      end
+
+      it "should never be advanced" do
+        @fourth_rotor.stub!(:at_notch?).and_return(true)
+        @left_rotor.stub!(:at_notch?).and_return(true)
+        @fourth_rotor.should_not_receive(:advance_position)
+
+        @e.send(:advance_rotors)
+      end
+    end
   end
 end

data/spec/integration_spec.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'spec_helper'
 
 describe "Integration tests" do
@@ -15,6 +16,46 @@ describe "Integration tests" do
       e.translate('AEFAE JXXBN XYJTY').should == 'CONGR ATULA TIONS'
     end
 
+    it "should translate a message with rotor turnover" do
+      e = EnigmaMachine.new(
+        :reflector => :B,
+        :rotors => [[:i, 1], [:ii, 1], [:iii, 1]]
+      )
+      e.set_rotors('A', 'B', 'R')
+
+      e.translate('MABEK GZXSG').should == 'TURNM IDDLE'
+    end
+
+    it "should translate a message with double stepping" do
+      e = EnigmaMachine.new(
+        :reflector => :B,
+        :rotors => [[:i, 1], [:ii, 1], [:iii, 1]]
+      )
+      e.set_rotors('A', 'D', 'S')
+
+      e.translate('RZFOG FYHPL').should == 'TURNS THREE'
+    end
+
+    it "should translate a message with ring settings" do
+      e = EnigmaMachine.new(
+        :reflector => :B,
+        :rotors => [[:i, 10], [:ii, 14], [:iii, 21]]
+      )
+      e.set_rotors('X', 'Y', 'Z')
+
+      e.translate('QKTPE BZIUK').should == 'GOODR ESULT'
+    end
+
+    it "should translate a message with a plugboard as well" do
+      e = EnigmaMachine.new(
+        :reflector => :B,
+        :rotors => [[:i, 10], [:ii, 14], [:iii, 21]],
+        :plug_pairs => %w(AP BR CM FZ GJ IL NT OV QS WX)
+      )
+      e.set_rotors('V', 'Q', 'Q')
+
+      e.translate('HABHV HLYDF NADZY').should == 'THATS ITWEL LDONE'
+    end
   end
 
   describe "real world sample messages" do
@@ -63,12 +104,28 @@ describe "Integration tests" do
 
         e.set_rotors('U', 'Z', 'V')
         result = e.translate('YKAE NZAP MSCH ZBFO CUVM RMDP YCOF HADZ IZME FXTH FLOL PZLF GGBO TGOX GRET DWTJ IQHL MXVJ WKZU ASTR')
-        result.should == 'STEUE REJTA NAFJO RDJAN STAND ORTQU AAACC CVIER NEUNN EUNZW OFAHR TZWON ULSMX XSCHA RNHOR STHCO'
+        result.should == 'STEU EREJ TANA FJOR DJAN STAN DORT QUAA ACCC VIER NEUN NEUN ZWOF AHRT ZWON ULSM XXSC HARN HORS THCO'
 
         # German: Steuere Tanafjord an. Standort Quadrat AC4992, fahrt 20sm. Scharnhorst. [hco - padding?]
         # English: Heading for Tanafjord. Position is square AC4992, speed 20 knots. Scharnhorst.
       end
     end
 
+    describe "Enigma M4" do
+      specify "U-264 (Kapitänleutnant Hartwig Looks), 1942" do
+        e = EnigmaMachine.new(
+          :reflector => :Bthin,
+          :rotors => [[:beta, 1], [:ii, 1], [:iv, 1], [:i, 22]],
+          :plug_pairs => %w(AT BL DF GJ HM NW OP QY RZ VX)
+        )
+
+        e.set_rotors('V', 'J', 'N', 'A')
+        result = e.translate('NCZW VUSX PNYM INHZ XMQX SFWX WLKJ AHSH NMCO CCAK UQPM KCSM HKSE INJU SBLK IOSX CKUB HMLL XCSJ USRR DVKO HULX WCCB GVLI YXEO AHXR HKKF VDRE WEZL XOBA FGYU JQUK GRTV UKAM EURB VEKS UHHV OYHA BCJW MAKL FKLM YFVN RIZR VVRT KOFD ANJM OLBG FFLE OPRG TFLV RHOW OPBE KVWM UQFM PWPA RMFH AGKX IIBG')
+        result.should == 'VONV ONJL OOKS JHFF TTTE INSE INSD REIZ WOYY QNNS NEUN INHA LTXX BEIA NGRI FFUN TERW ASSE RGED RUEC KTYW ABOS XLET ZTER GEGN ERST ANDN ULAC HTDR EINU LUHR MARQ UANT ONJO TANE UNAC HTSE YHSD REIY ZWOZ WONU LGRA DYAC HTSM YSTO SSEN ACHX EKNS VIER MBFA ELLT YNNN NNNO OOVI ERYS ICHT EINS NULL'
+
+        # German: Von Von 'Looks' F T 1132/19 Inhalt: Bei Angriff unter Wasser gedrückt, Wasserbomben. Letzter Gegnerstandort 08:30 Uhr Marine Quadrat AJ9863, 220 Grad, 8sm, stosse nach. 14mb fällt, NNO 4, Sicht 10.
+        # English: From Looks, radio-telegram 1132/19 contents: Forced to submerge under attack, depth charges. Last enemy location 08:30 hours, sea square AJ9863, following 220 degrees, 8 knots. [Pressure] 14 millibars falling, [wind] north-north-east 4, visibility 10.
+      end
+    end
   end
 end

data/spec/rotor_spec.rb

@@ -14,48 +14,70 @@ describe EnigmaMachine::Rotor do
         r = EnigmaMachine::Rotor.new(:i, 1, :next)
         r.forward('A').should == 'E'
         r.forward('Q').should == 'X'
+        r.position = 'Q'
+        r.at_notch?.should == true
       end
 
       it "should support rotor ii" do
         r = EnigmaMachine::Rotor.new(:ii, 1, :next)
         r.forward('A').should == 'A'
         r.forward('M').should == 'W'
+        r.position = 'E'
+        r.at_notch?.should == true
       end
 
       it "should support rotor iii" do
         r = EnigmaMachine::Rotor.new(:iii, 1, :next)
         r.forward('A').should == 'B'
         r.forward('Q').should == 'I'
+        r.position = 'V'
+        r.at_notch?.should == true
       end
 
       it "should support rotor iv" do
         r = EnigmaMachine::Rotor.new(:iv, 1, :next)
         r.forward('A').should == 'E'
         r.forward('Q').should == 'N'
+        r.position = 'J'
+        r.at_notch?.should == true
       end
 
       it "should support rotor v" do
         r = EnigmaMachine::Rotor.new(:v, 1, :next)
         r.forward('A').should == 'V'
         r.forward('Q').should == 'A'
+        r.position = 'Z'
+        r.at_notch?.should == true
       end
 
       it "should support rotor vi" do
         r = EnigmaMachine::Rotor.new(:vi, 1, :next)
         r.forward('A').should == 'J'
         r.forward('Q').should == 'D'
+        r.position = 'M'
+        r.at_notch?.should == true
+        r.position = 'Z'
+        r.at_notch?.should == true
       end
 
       it "should support rotor vii" do
         r = EnigmaMachine::Rotor.new(:vii, 1, :next)
         r.forward('A').should == 'N'
         r.forward('Q').should == 'A'
+        r.position = 'M'
+        r.at_notch?.should == true
+        r.position = 'Z'
+        r.at_notch?.should == true
       end
 
       it "should support rotor viii" do
         r = EnigmaMachine::Rotor.new(:viii, 1, :next)
         r.forward('A').should == 'F'
         r.forward('Q').should == 'A'
+        r.position = 'M'
+        r.at_notch?.should == true
+        r.position = 'Z'
+        r.at_notch?.should == true
       end
 
       it "should support rotor beta" do
@@ -71,9 +93,10 @@ describe EnigmaMachine::Rotor do
       end
     end
   end
+
   describe "setting and manipulating rotor positions" do
     before :each do
-      @rotor = EnigmaMachine::Rotor.new("ABCD", 1, :foo)
+      @rotor = EnigmaMachine::Rotor.new(:i, 1, :foo)
     end
 
     it "should set the position to 'A' by default" do
@@ -99,6 +122,53 @@ describe EnigmaMachine::Rotor do
     end
   end
 
+  describe "checking notch position" do
+    it "should return true if the rotor is at one of the notch positions" do
+      rotor = EnigmaMachine::Rotor.new('EKMFLGDQVZNTOWYHXUSPAIBRCJ_DR', 1, :foo)
+
+      rotor.position = 'D'
+      rotor.at_notch?.should == true
+
+      rotor.position = 'R'
+      rotor.at_notch?.should == true
+    end
+
+    it "should return false otherwise" do
+      rotor = EnigmaMachine::Rotor.new('EKMFLGDQVZNTOWYHXUSPAIBRCJ_DR', 1, :foo)
+
+      rotor.position = 'C'
+      rotor.at_notch?.should == false
+      rotor.position = 'E'
+      rotor.at_notch?.should == false
+
+      rotor.position = 'Q'
+      rotor.at_notch?.should == false
+      rotor.position = 'S'
+      rotor.at_notch?.should == false
+
+      rotor.position = 'A'
+      rotor.at_notch?.should == false
+    end
+
+    it "should be unaffected by the ring position" do
+      rotor = EnigmaMachine::Rotor.new('EKMFLGDQVZNTOWYHXUSPAIBRCJ_DR', 6, :foo)
+
+      rotor.position = 'C'
+      rotor.at_notch?.should == false
+      rotor.position = 'D'
+      rotor.at_notch?.should == true
+      rotor.position = 'E'
+      rotor.at_notch?.should == false
+
+      rotor.position = 'Q'
+      rotor.at_notch?.should == false
+      rotor.position = 'R'
+      rotor.at_notch?.should == true
+      rotor.position = 'S'
+      rotor.at_notch?.should == false
+    end
+  end
+
   describe "forward and reverse translation" do
     context "with a ring-setting of 1 (no adjustment), and a rotor position of A (the default)" do
       before :each do

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: enigma_machine
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Alex Tomlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13890560 !ruby/object:Gem::Requirement
+  requirement: &18339180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13890560
+  version_requirements: *18339180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13890040 !ruby/object:Gem::Requirement
+  requirement: &18357640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13890040
+  version_requirements: *18357640
 description: Enigma machine simulator
 email:
 - alex@tomlins.org.uk
@@ -43,6 +43,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- README.md
 - Rakefile
 - enigma_machine.gemspec
 - lib/enigma_machine.rb
@@ -70,13 +71,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1944969372318025887
+      hash: 2207890655996414444
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 2207890655996414444
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10