# HG changeset patch
# User Brian Neal <bgneal@gmail.com>
# Date 1385520586 21600
# Node ID ef5345212e14fe3c840d698466840104a9caea52
# Parent  de0527b15cdfbd8f5515464a6f8ef05dd27fea35
Refactor existing modules.

diff -r de0527b15cdf -r ef5345212e14 purple/data.py
--- a/purple/data.py	Mon Nov 25 21:28:09 2013 -0600
+++ b/purple/data.py	Tue Nov 26 20:49:46 2013 -0600
@@ -21,35 +21,8 @@
 module.
 
 """
-from .switch import SteppingSwitch
 
-NUM_SWITCHES = 4
-
-# "Enum" to name the switches:
-SIXES, TWENTIES_1, TWENTIES_2, TWENTIES_3 = range(NUM_SWITCHES)
-
-# Raw wiring data for the switches is stored here:
-WIRING_DATA = [None] * NUM_SWITCHES
-
-
-def create_switch(switch_type, init_pos=0):
-    """Factory function for building a SteppingSwitch of the requested
-    type. The initial position of the switch can be specified.
-
-    """
-    if switch_type not in range(NUM_SWITCHES):
-        raise ValueError("illegal switch_type")
-
-    return SteppingSwitch(WIRING_DATA[switch_type], init_pos)
-
-
-# Actual wiring data follows.
-# Note: this data is currently 1-based to match the data found in the
-# Cryptologia paper. We convert to 0-based at module import time.
-# This may change as the program matures and confidence is gained in the wiring
-# data.
-
-WIRING_DATA[SIXES] = \
+SIXES_DATA = \
 [[2, 1, 3, 5, 4, 6],
  [6, 3, 5, 2, 1, 4],
  [1, 5, 4, 6, 2, 3],
@@ -76,7 +49,7 @@
  [4, 6, 1, 2, 5, 3],
  [5, 2, 4, 3, 6, 1]]
 
-WIRING_DATA[TWENTIES_1] = \
+TWENTIES_1_DATA = \
 [[6, 19, 14, 1, 10, 4, 2, 7, 13, 9, 8, 16, 3, 18, 15, 11, 5, 12, 20, 17],
  [4, 5, 16, 17, 14, 1, 20, 15, 3, 8, 18, 11, 12, 13, 10, 19, 2, 6, 9, 7],
  [17, 1, 13, 6, 15, 11, 19, 12, 16, 18, 10, 3, 7, 14, 8, 20, 4, 9, 2, 5],
@@ -103,7 +76,7 @@
  [5, 8, 1, 15, 19, 9, 12, 2, 6, 3, 14, 17, 4, 20, 16, 13, 18, 10, 7, 11],
  [14, 10, 4, 8, 9, 12, 3, 11, 17, 20, 19, 6, 15, 5, 2, 18, 16, 7, 1, 13]]
 
-WIRING_DATA[TWENTIES_2] = \
+TWENTIES_2_DATA = \
 [[15, 9, 1, 5, 17, 19, 3, 2, 10, 8, 11, 18, 12, 16, 6, 13, 20, 4, 14, 7],
  [12, 6, 15, 2, 4, 9, 8, 16, 19, 17, 5, 11, 20, 7, 10, 18, 1, 14, 13, 3],
  [4, 18, 5, 8, 16, 1, 12, 15, 20, 14, 13, 17, 11, 2, 7, 9, 6, 3, 10, 19],
@@ -130,7 +103,7 @@
  [19, 13, 8, 16, 20, 10, 7, 1, 2, 18, 14, 6, 9, 5, 12, 3, 17, 15, 11, 4],
  [13, 1, 17, 15, 7, 4, 16, 3, 14, 5, 2, 10, 18, 8, 11, 9, 19, 12, 20, 6]]
 
-WIRING_DATA[TWENTIES_3] = \
+TWENTIES_3_DATA = \
 [[7, 19, 11, 3, 20, 1, 10, 6, 16, 12, 17, 13, 8, 9, 4, 18, 5, 14, 15, 2],
  [15, 17, 14, 2, 12, 13, 8, 3, 1, 19, 9, 4, 10, 7, 11, 20, 16, 6, 18, 5],
  [2, 11, 20, 12, 1, 19, 4, 10, 9, 14, 6, 15, 13, 3, 7, 16, 18, 8, 5, 17],
@@ -159,7 +132,9 @@
 
 # Convert wiring data to be 0-based.
 
-for table in WIRING_DATA:
+_WIRING_DATA = [SIXES_DATA, TWENTIES_1_DATA, TWENTIES_2_DATA, TWENTIES_3_DATA]
+
+for table in _WIRING_DATA:
     for i in range(len(table)):
         for j in range(len(table[i])):
             table[i][j] = table[i][j] - 1
diff -r de0527b15cdf -r ef5345212e14 purple/switch.py
--- a/purple/switch.py	Mon Nov 25 21:28:09 2013 -0600
+++ b/purple/switch.py	Tue Nov 26 20:49:46 2013 -0600
@@ -2,7 +2,14 @@
 # This file is part of purple, the PURPLE (Cipher Machine 97) simulation.
 # purple is released under the MIT License (see LICENSE.txt).
 
-"""This module contains the SteppingSwitch class."""
+"""This module contains the SteppingSwitch class and a factory function to
+create the standard switches used on the PURPLE machine.
+
+"""
+import purple.data as data
+
+# "Enum" to name the standard switches:
+SIXES, TWENTIES_1, TWENTIES_2, TWENTIES_3 = range(4)
 
 
 class SteppingSwitchError(Exception):
@@ -26,13 +33,20 @@
         self.wiring = wiring
         self.num_positions = len(wiring)
         self.num_levels = len(wiring[0])
-        self.pos = init_pos
 
         if not all(self.num_levels == len(level) for level in wiring):
             raise SteppingSwitchError("Ragged wiring table")
 
-        if not (0 <= self.pos < self.num_positions):
-            raise SteppingSwitchError("Illegal initial position")
+        self.set_pos(init_pos)
+
+    def set_pos(self, pos):
+        """Set the switch position to pos.
+        Raises a SteppingSwitchError if pos is out of range.
+
+        """
+        if not (0 <= pos < self.num_positions):
+            raise SteppingSwitchError("Illegal switch position")
+        self.pos = pos
 
     def step(self):
         """Advance the stepping switch position."""
@@ -45,3 +59,29 @@
 
         """
         return self.wiring[self.pos][level]
+
+
+def create_switch(switch_type, init_pos=0):
+    """Factory function for building a SteppingSwitch of the requested
+    standard type. The initial position of the switch can be specified.
+
+    The switch_type parameter must be one of the module level constants:
+        * SIXES
+        * TWENTIES_1
+        * TWENTIES_2
+        * TWENTIES_3
+
+    A ValueError will be raised if switch_type is an illegal value.
+
+    """
+    wiring_map = {
+        SIXES: data.SIXES_DATA,
+        TWENTIES_1: data.TWENTIES_1_DATA,
+        TWENTIES_2: data.TWENTIES_2_DATA,
+        TWENTIES_3: data.TWENTIES_3_DATA,
+    }
+    wiring = wiring_map.get(switch_type)
+    if not wiring:
+        raise ValueError("illegal switch type")
+
+    return SteppingSwitch(wiring, init_pos)