Merge pull request #7 from denismaggior8/feature/v1.3.0

Feature/v1.3.0

Author: denismaggior8

.gitignore

@@ -4,4 +4,5 @@
 **/dist
 **/*.drawio.bkp
 **/*.drawio.dtmp
-**/.DS_Store
+**/.DS_Store
+**/.venv

diagrams/rotors.drawio

@@ -136,6 +136,7 @@ classDiagram
 
  class Reflector {
  + None tag
+ - __str__(self) str
  }
 
  class Observable {

docs/classdiagram/enigmapython.md

@@ -107,7 +107,7 @@ def update(self, observable, *args, **kwargs):
  # Engaging the enigma double step issue, only if the next rotor position is in its notch indexe/s
  if self.rotors[self.rotors.index(observable)+1].position in self.rotors[self.rotors.index(observable)+1].notch_indexes:
  self.rotors[self.rotors.index(observable)+1].double_step_triggered = True
- # If the rotor is the last one in the list, but the machine has a rotating reflector, increment it position by 1
+ # If the rotor is the last one in the list, but the machine has a rotating reflector, increment its position by 1
  if observable in self.rotors and self.rotors.index(observable) == len(self.rotors)-1 and isinstance(self.reflector, RotatingReflector):
  self.reflector.increment_position()
  logging.debug("Reflector has been incremented by 1 position")

src/enigma/enigmapython/Enigma.py

@@ -16,4 +16,7 @@ def __init__(self, wiring, alphabet=Alphabets.lookup.get("latin_i18n_26chars_low
  self.alphabet_list = list(alphabet)
 
  def __str__(self):
- return self.wiring
+ str = Scrambler.__str__(self)
+ str += "\n"
+ str += self.wiring
+ return str

src/enigma/enigmapython/Etw.py

@@ -17,4 +17,7 @@ def __init__(self, wiring, alphabet):
 
 
  def __str__(self):
- return self.wiring
+ str = Scrambler.__str__(self)
+ str += "\n"
+ str += self.wiring
+ return str

src/enigma/enigmapython/Plugboard.py

@@ -1,4 +1,10 @@
 from .Scrambler import Scrambler
 
 class Reflector(Scrambler):
- tag = None
+ tag = None
+
+ def __str__(self):
+ str = Scrambler.__str__(self)
+ str += "\n"
+ str += self.wiring
+ return str

src/enigma/enigmapython/Reflector.py

@@ -40,8 +40,13 @@ def __init__(self, wiring, notch_indexes, alphabet, position = 0, ring = 0):
 
 
  def __str__(self):
- pointer = ' ' * self.position + '^'
- return self.wiring + '\n' + pointer 
+ str = Scrambler.__str__(self)
+ str += "\n"
+ # Slice the wiring, in order to left-rotate it according to the position
+ n = self.position % len(self.wiring)
+ str += self.wiring[n:] + self.wiring[:n]
+ return str
+ 
 
  def __eq__(self, __value: object) -> bool:
  return id(self) == id(object)

src/enigma/enigmapython/Rotor.py

@@ -60,4 +60,9 @@ def __shift(letter, shift, alphabet_list):
  return alphabet_list[(i + shift) % len(alphabet_list)]
 
  def __str__(self):
- return self.wiring
+ str = ""
+ for char in self.alphabet_list:
+ str += char
+ str += "\n"
+ str += "|" * len(self.alphabet_list)
+ return str

src/enigma/enigmapython/Scrambler.py

@@ -1,6 +1,7 @@
 from rich.console import Console
 from rich.text import Text
-from enigmapython.RotatingReflector import RotatingReflector 
+
+from enigmapython.RotatingReflector import RotatingReflector
 
 class XRay():
  @staticmethod
@@ -21,9 +22,13 @@ def render_enigma_xray(enigma):
 
  rotor_walls_top = " ".join(["+-----+"] * rotor_count)
 
- rotors_positions = " ".join(["{:02}".format(enigma.rotors[i].position) for i in range(rotor_count - 1, -1, -1)])
+ rotors_positions = " ".join(["{} ({:02})".format(enigma.alphabet_list[enigma.rotors[i].position].upper(),enigma.rotors[i].position) for i in range(rotor_count - 1, -1, -1)])
+
+ rotors_rings = " ".join(["{} ({:02})".format(enigma.alphabet_list[enigma.rotors[i].ring].upper(),enigma.rotors[i].ring) for i in range(rotor_count - 1, -1, -1)])
+
+ reflector_ring = ""
 
- rotors_rings = "  ".join(["{:02}".format(enigma.rotors[i].ring) for i in range(rotor_count - 1, -1, -1)])
+ rotor_walls_position = " ".join(["| {} |".format(enigma.alphabet_list[enigma.rotors[i].position].upper()) for i in range(rotor_count - 1, -1, -1)])
 
  rotor_walls = " ".join(["| |"] * rotor_count)
 
@@ -42,17 +47,17 @@ def render_enigma_xray(enigma):
  {rotor_numbers} 
  +-----+ {rotor_walls_top} +-----+ +-----+
  | | {rotor_walls} | | | |
- | +--|--<--{rotor_wiring_top}|-----|--<--|-----|----< {enigma.journal[-1]['input_char'] if len(enigma.journal) >= 1 else ' '} <-- Key
+ | +--|--<--{rotor_wiring_top}|-----|--<--|-----|----< {enigma.journal[-1]['input_char'] if len(enigma.journal) >= 1 else ' '} <-- Key ⌨️
  | | {rotor_walls_forward} | {enigma.etw.journal[-2]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | {enigma.plugboard.journal[-2]['output_char'] if len(enigma.plugboard.journal) >= 2 else ' '} | |
  | | | {rotor_walls} | | | |
  | | | {rotor_walls} | | | |
  | | | {enigma.reflector.journal[-1]['output_char'] if len(enigma.reflector.journal) >= 1 else ' '} | {rotor_walls_backward} | {enigma.etw.journal[-1]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | 
- | +--|-->--{rotor_wiring_bottom}|-----|-->--|-----|----> {enigma.journal[-1]['output_char'] if len(enigma.journal) >= 1 else ' '} --> Lamp
+ | +--|-->--{rotor_wiring_bottom}|-----|-->--|-----|----> {enigma.journal[-1]['output_char'] if len(enigma.journal) >= 1 else ' '} --> Lamp 💡
  | | {rotor_walls} | | | |
  +-----+ {rotor_walls_bottom} +-----+ +-----+
 
-  Pos.: {"{:02}".format(enigma.reflector.position) if isinstance(enigma.reflector, RotatingReflector) else '  '}  {rotors_positions} 
-  Ring:   {rotors_rings}
+ Pos.:  {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.position].upper(),enigma.reflector.position) if isinstance(enigma.reflector, RotatingReflector) else ' N/A '} {rotors_positions} 
+ Ring: {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.ring].upper(),enigma.reflector.ring)} {rotors_rings}
  """
  console.print(Text(diagram, style="bold"))
  return Text(diagram, style="bold")