rotor_machine 1.0.14 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443abe9d94a7c609dc9e6e737a9cf134cc7c81d485977b7f32b9672572cacb4f
-  data.tar.gz: 4f9ac00ff8680eb8c1f10d385d6905a35d97d240da5b9ef209a3a26304f3e2d5
+  metadata.gz: b9b724da9efeeb1cb707e1b455a0cca97b9a911ce0b8bf11824e786c044135d6
+  data.tar.gz: 844f9bc228874dc922369d00a3e2ae6caec69c14c63491961e21fb5b32988873
 SHA512:
-  metadata.gz: 1280cdc56b4e65ea14716c454316cd1c8b4411c92e944230ac67fe526f36f708108afb6a89c0b9f6662afa556e2c54c21035bf780ea0a2e75b45cd4a53e69726
-  data.tar.gz: f1225743be6ea1947a8d1fc1b0966f42f4686b38d7762cbfbd65baf27ccd0951bc7c64efdb5930d277f7b88f660eb3121cf7a29ddb32b1a506013c3673ccf88f
+  metadata.gz: 3da1a7af7b05149bb3ba3bbb2e514e548ea8f6b7727a1b35858a9c381372f01c2cec692e95d20cd0a435b7a21d5cfa1e1f3ec659806aba9862a7c2b7ddfa6900
+  data.tar.gz: 04a238d1393e0b9ca931f6af190e1813ee9251b299c829ba1df7928a1a94fc2479149576aaef3505fac2ce02d5b1ba7afa347ed3400a2fc500137e15fdac5f76

data/Rakefile

@@ -5,3 +5,13 @@ require "tcravit_ruby_lib/rake_tasks"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+require 'rake'
+
+namespace :coverage do
+  desc "Generate a contextual report from the SimpleCov output"
+  task :resolve do
+    project_root = File.expand_path(File.join(File.dirname(__FILE__)))
+    system("#{project_root}/bin/resolve_coverage.pl #{project_root}/coverage/coverage.txt")
+  end
+end
+

data/bin/resolve_coverage.pl

@@ -0,0 +1,171 @@
+#!/usr/bin/perl -w
+############################################################################
+# resolve_coverage.pl: Parse the output of a Ruby simplecov_erb text file,
+#                      and generate a report with code context for missed
+#                      lines.
+#
+# Version 1.00, 2018-06-15, tammycravit@me.com
+############################################################################
+
+use File::Spec;
+use File::Basename;
+use File::Slurp;
+use Term::ANSIColor qw(:constants);
+use Cwd;
+use Getopt::Long;
+
+####################
+# CONFIGURATION CONSTANTS
+####################
+
+$FILE_PREFIX              = "";
+$FILE_SUFFIX              = "";
+$EXAMPLE_PREFIX           = "";
+$EXAMPLE_SUFFIX           = "\n";
+$CONTEXT_SIZE             = 2;
+$CONTEXT_UNCOVERED_MARKER = "->";
+$CONTEXT_UNCOVERED_COLOR  = RED;
+$FILENAME_COLOR           = BLUE;
+$BARE_OUTPUT              = undef;
+
+$cov_files = 0;
+$cov_lines = 0;
+
+####################
+# Script begins here
+####################
+
+sub generate_file_context
+{
+  my ($filename, $lines_list) = @_;
+  $filename =~ s@//@/@g;
+
+  my @lines = @$lines_list;
+  @content = read_file($filename, chomp => 1);
+
+  if (length $FILE_PREFIX) { print $FILE_PREFIX; }
+
+  if ($BARE_OUTPUT)
+  {
+    print "*** ", $filename, " ($#content lines)", "\n";
+  }
+  else
+  {
+    print
+      BOLD, WHITE, "*** ", RESET
+      BOLD, $FILENAME_COLOR, $filename, RESET,
+      WHITE, " ($#content lines)", RESET,
+      "\n";
+  }
+  print "\n";
+
+  foreach my $which_line (@lines)
+  {
+    $which_line--;
+    if (length $EXAMPLE_PREFIX) { print $EXAMPLE_PREFIX; }
+
+    for ($i = $which_line - $CONTEXT_SIZE; $i <= $which_line + $CONTEXT_SIZE; $i++)
+    {
+      if ($i <= $#content)
+      {
+        my $color = ($i == $which_line ? $CONTEXT_UNCOVERED_COLOR : WHITE);
+        my $number_color = CYAN;
+        my $reset = RESET;
+        if ($BARE_OUTPUT)
+        {
+          printf "%s%s%s%5.0d:%s %s%s\n",
+            "",
+            ($i == $which_line ? $CONTEXT_UNCOVERED_MARKER : (" " x length($CONTEXT_UNCOVERED_MARKER))),
+            "",
+            $i+1,
+            "",
+            $content[$i],
+            "";
+        }
+        else
+        {
+          printf "%s%s%s%5.0d:%s %s%s\n",
+            $color,
+            ($i == $which_line ? $CONTEXT_UNCOVERED_MARKER : (" " x length($CONTEXT_UNCOVERED_MARKER))),
+            $number_color,
+            $i+1,
+            $color,
+            $content[$i],
+            $reset;
+        }
+      }
+    }
+
+    if (length $EXAMPLE_SUFFIX) { print $EXAMPLE_SUFFIX; }
+    $cov_lines++;
+  }
+
+  if (length $FILE_SUFFIX) { print $FILE_SUFFIX; }
+  $cov_files++;
+}
+
+GetOptions(
+  "file-prefix=s" => \$FILE_PREFIX,
+  "file-suffix=s" => \$FILE_SUFFIX,
+  "example-prefix=s" => \$EXAMPLE_PREFIX,
+  "example-suffix=s" => \$EXAMPLE_SUFFIX,
+  "context-size=i"   => \$CONTEXT_SIZE,
+  "context-marker=s" => \$CONTEXT_UNCOVERED_MARKER,
+  "bare"             => \$BARE_OUTPUT,
+);
+
+$coverage_file = File::Spec->rel2abs($ARGV[0]);
+$project_root  = dirname($coverage_file);
+do
+{
+  $project_root  = dirname($project_root);
+}
+until ((-d "$project_root/coverage") || ($project_root eq '/'));
+die "Could not find project root starting from $coverage_file\n" if ($project_root eq "/");
+
+unless ($BARE_OUTPUT)
+{
+  print "****************************************************************************\n";
+  print "* resolve_coverage.pl: Parse a simplecov-erb coverage report and generate  *\n";
+  print "*                      contextual code snippets for uncovered lines.       *\n";
+  print "*                                                                          *\n";
+  print "* Version 1.00, 2018-06-15, Tammy Cravit, tammycravit\@me.com               *\n";
+  print "****************************************************************************\n";
+  print "\n";
+
+  print BOLD, MAGENTA, "==> Coverage file: ", RESET, MAGENTA, $coverage_file, "\n", RESET;
+  print BOLD, MAGENTA, "==> Project root : ", RESET, MAGENTA, $project_root, "\n", RESET;
+  print BOLD, MAGENTA, "==> Context lines: ", RESET, MAGENTA, $CONTEXT_SIZE, "\n", RESET;
+  print "\n";
+}
+
+
+die "Usage: $0 coverage_file.txt\n" unless (-f $coverage_file);
+
+open (COVERAGE, $coverage_file) || die;
+while (<COVERAGE>)
+{
+  chomp;
+  if ($_ =~ m/^(\S+)\b.*?missed:\s?([0123456789,]+)/)
+  {
+    $filename = $1;
+    @lines = split(/,/, $2);
+    generate_file_context("$project_root/$filename", \@lines);
+  }
+}
+close (COVERAGE);
+
+if ($BARE_OUTPUT)
+{
+  print "resolve_coverage.pl processed ", $cov_lines, " examples from ", $cov_files,
+        " files.\n";
+}
+else
+{
+  print "Done. Processed ",
+        CYAN, $cov_lines, RESET,
+        " examples from ",
+        CYAN, $cov_files, RESET,
+        " files.\n";
+}
+exit 0;

data/lib/rotor_machine.rb

@@ -3,7 +3,7 @@ $:.unshift File.dirname(__FILE__)
 require "rotor_machine/version"
 
 Dir[File.join(File.dirname(__FILE__), "rotor_machine", "*.rb")].reject { |x| File.basename(x) == "version.rb" }.each do |f|
-  require File.join("rotor_machine", File.basename(f)) 
+  require File.join("rotor_machine", File.basename(f))
 end
 
 ##
@@ -21,7 +21,7 @@ end
 # Many thanks to Kevin Sylvestre, whose {https://ksylvest.com/posts/2015-01-03/the-enigma-machine-using-ruby blog post}
 # helped me understand some aspects of the internal workings of the Enigma
 # and how the signals flowed through the pieces of the machine.
-# 
+#
 #@author Tammy Cravit <tammycravit@me.com>
 module RotorMachine
 end

data/lib/rotor_machine/factory.rb

@@ -6,15 +6,52 @@ module RotorMachine
   module Factory
     extend self
 
+    ##
+    # Generates a default-configuration RotorMachine, with the following
+    # state:
+    #
+    # - Rotors I, II, III, each set to A and configured to advance a single
+    #   step at a time
+    # - Reflector A
+    # - An empty plugboard with no connections
+    #
+    # The {RotorMachine::Machine#default_machine} method calls this factory
+    # method, and is maintained there for backward compatibility.
+    def default_machine
+      m = build_machine(
+        rotors: [:ROTOR_I, :ROTOR_II, :ROTOR_III],
+        reflector: build_reflector(reflector_kind: :REFLECTOR_A)
+        )
+      m.set_rotors("AAA")
+      return m
+    end
+
+    ##
+    # Generates an empty-configuration RotorMachine, with the following
+    # state:
+    #
+    # - No rotors
+    # - No reflector
+    # - An empty plugboard with no connections
+    #
+    # A RotorMachine in this state will raise an {ArgumentError} until you
+    # outfit it with at least one rotor and a reflector.
+    #
+    # The {RotorMachine::Machine#default_machine} method calls this factory
+    # method, and is maintained there for backward compatibility.
+    def empty_machine
+      return build_machine()
+    end
+
     ##
     # Build a new {Rotor} and return it.
     #
-    # The options hash for this method can accept the following named 
+    # The options hash for this method can accept the following named
     # arguments:
     #
     # *:rotor_kind* - The type of rotor to create. Should be a symbol matching
     # a rotor type constant in the {RotorMachine::Rotor} class,
-    # or a 26-character string giving the letter sequence for 
+    # or a 26-character string giving the letter sequence for
     # the rotor. Defaults to *:ROTOR_1* if not specified.
     #
     # *:initial_position* - The initial position of the rotor (0-based
@@ -28,16 +65,19 @@ module RotorMachine
     #                       rotor.
     # @return The newly-built rotor.
     def build_rotor(options={})
-      rotor_kind         = options.fetch(:rotor_kind,         :ROTOR_I)
+      rotor_kind         = options.fetch(:rotor_kind, nil)
       initial_position   = options.fetch(:initial_position,   0)
       step_size          = options.fetch(:step_size,          1)
 
       rotor_alphabet = nil
+      if rotor_kind.nil?
+        raise ArgumentError, "Rotor kind not specified"
+      end
 
-      if (rotor_kind.class.name == "Symbol")
+      if rotor_kind.is_a? Symbol
         raise ArgumentError, "Invalid rotor kind (symbol #{rotor_kind} not found)" unless RotorMachine::Rotor.constants.include?(rotor_kind)
         rotor_alphabet = RotorMachine::Rotor.const_get(rotor_kind)
-      elsif (rotor_kind.class.name == "String")
+      elsif rotor_kind.is_a? String
         raise ArgumentError, "Invalid rotor kind (invalid length)" unless rotor_kind.length == 26
         rotor_alphabet = rotor_kind.upcase
       else
@@ -66,12 +106,12 @@ module RotorMachine
     ##
     # Build a new {Reflector} and return it.
     #
-    # The options hash for this method can accept the following named 
+    # The options hash for this method can accept the following named
     # arguments:
     #
     # *:reflector_kind* - The type of reflector to create. Should be a symbol matching
     # a reflector type constant in the {RotorMachine::Reflector} class,
-    # or a 26-character string giving the letter sequence for 
+    # or a 26-character string giving the letter sequence for
     # the reflector. Defaults to *:REFLECTOR_A* if not specified.
     #
     # *:initial_position* - The initial position of the reflector (0-based
@@ -82,21 +122,27 @@ module RotorMachine
     # reflector.
     # @return The newly-built reflector.
     def build_reflector(options={})
-      reflector_kind     = options.fetch(:reflector_kind,   :REFLECTOR_A)
-      initial_position   = options.fetch(:initial_position, 0)
+      reflector_kind     = options.fetch(:reflector_kind, nil)
+      initial_position   = options.fetch(:initial_position, nil)
 
       reflector_alphabet = nil
+      if reflector_kind.nil?
+        raise ArgumentError, "Reflector type not specified"
+      end
+      if initial_position.nil?
+        initial_position = 0
+      end
 
-      if (reflector_kind.class.name == "Symbol")
+      if reflector_kind.is_a? Symbol
         unless RotorMachine::Reflector.constants.include?(reflector_kind)
-          raise ArgumentError, "Invalid reflector kind (symbol #{reflector_kind} not found)" 
+          raise ArgumentError, "Invalid reflector kind (symbol #{reflector_kind} not found)"
         end
         reflector_alphabet = RotorMachine::Reflector.const_get(reflector_kind)
-      elsif (reflector_kind.class.name == "String")
+      elsif reflector_kind.is_a? String
         raise ArgumentError, "Invalid reflector kind (invalid length)" unless reflector_kind.length == 26
         reflector_alphabet = reflector_kind.upcase
       else
-        raise ArgumentError, "Invalid reflector kind (invalid type #{reflector_kind.class.name})"
+        raise ArgumentError, "Invalid reflector kind (invalid type)"
       end
 
       if initial_position.is_a? Numeric
@@ -107,7 +153,7 @@ module RotorMachine
         end
         initial_position = reflector_alphabet.index(initial_position)
       else
-        raise ArgumentError, "Invalid position (invalid type #{initial_position.class.name})"
+        raise ArgumentError, "Invalid position (invalid type)"
       end
 
       return RotorMachine::Reflector.new(reflector_alphabet, initial_position)
@@ -149,19 +195,22 @@ module RotorMachine
 
       m = RotorMachine::Machine.new()
       rotors.each do |r|
-        if r.class.name == "RotorMachine::Rotor"
+        if r.is_a? RotorMachine::Rotor
           m.rotors << r
-        elsif r.class.name == "Symbol"
+        elsif r.is_a? Symbol
           m.rotors << RotorMachine::Factory.build_rotor(rotor_kind: r)
+        else
+          raise ArgumentError, "#{r} is not a rotor or a rotor kind symbol"
         end
       end
 
       unless reflector.nil?
-        if reflector.class.name == "Symbol"
+        if reflector.is_a? Symbol
           m.reflector = RotorMachine::Factory.build_reflector(reflector_kind: reflector)
-        elsif reflector.class.name == "RotorMachine::Reflector"
+        elsif reflector.is_a? RotorMachine::Reflector
           m.reflector = reflector
         else
+          raise ArgumentError, "#{reflector} is not a reflector or reflector kind symbol"
         end
       end
 

data/lib/rotor_machine/machine.rb

@@ -1,4 +1,4 @@
-module RotorMachine 
+module RotorMachine
   ##
   # The {RotorMachine::Machine} class serves as the entrypoint and orchestrator
   # for an Enigma machine.
@@ -43,7 +43,7 @@ module RotorMachine
   # On a physical Enigma machine, 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 
+  # 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.
   #
@@ -59,7 +59,7 @@ module RotorMachine
   # to help break the Enigma's encryption in World War II.
   #
   # == Usage
-  # 
+  #
   # To use the RotorMachine Enigma machine, you need to perform the following
   # steps:
   #
@@ -73,12 +73,24 @@ module RotorMachine
   # method to encode/decode, and {#set_rotors} to reset the machine state.
   #
   # The {#default_machine} and {#empty_machine} class methods are shortcut
-  # factory methods whcih set up, respectively, a fully configured machine 
+  # 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.
   class Machine
     attr_accessor :rotors, :reflector, :plugboard
 
+    ##
+    # Initialize a RotorMachine object.
+    #
+    # This object won't be usable until you add rotors, a reflector and a
+    # plugboard. Using the {#default_machine} and {#empty_machine} helper class
+    # methods is the preferred way to initialize functioning machines.
+    def initialize()
+      @rotors = []
+      @reflector = nil
+      @plugboard = nil
+    end
+
     ##
     # Generates a default-configuration RotorMachine, with the following
     # state:
@@ -87,13 +99,12 @@ module RotorMachine
     #   step at a time
     # - Reflector A
     # - An empty plugboard with no connections
+    #
+    # This method is just a proxy for the equivalently-named factory method in the
+    # {RotorMachine::Factory} class, and is maintained here for backward
+    # compatibility.
     def self.default_machine
-      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
+      RotorMachine::Factory.default_machine
     end
 
     ##
@@ -106,20 +117,12 @@ module RotorMachine
     #
     # A RotorMachine in this state will raise an {ArgumentError} until you
     # outfit it with at least one rotor and a reflector.
-    def self.empty_machine
-      RotorMachine::Factory.build_machine()
-    end
-
-    ##
-    # Initialize a RotorMachine object.
     #
-    # This object won't be usable until you add rotors, a reflector and a
-    # plugboard. Using the {#default_machine} and {#empty_machine} helper class
-    # methods is the preferred way to initialize functioning machines. 
-    def initialize()
-      @rotors = []
-      @reflector = nil
-      @plugboard = nil
+    # This method is just a proxy for the equivalently-named factory method in the
+    # {RotorMachine::Factory} class, and is maintained here for backward
+    # compatibility.
+    def self.empty_machine
+      RotorMachine::Factory.empty_machine()
     end
 
     ##
@@ -140,8 +143,8 @@ module RotorMachine
     end
 
     ##
-    # Coordinate the stepping of the set of rotors after a character is 
-    # enciphered. 
+    # Coordinate the stepping of the set of rotors after a character is
+    # enciphered.
     def step_rotors
       @rotors.reverse.each do |rotor|
         rotor.step
@@ -156,7 +159,7 @@ module RotorMachine
     # This is a helper method to avoid having to manipulate the rotor
     # positions individually. Starting with the leftmost rotor, each
     # character from this string is used to set the position of one
-    # rotor. 
+    # rotor.
     #
     # If the string is longer than the number of rotors, the extra
     # values (to the right) are ignored. If it's shorter, the values of
@@ -185,7 +188,7 @@ module RotorMachine
     end
 
     ##
-    # Encipher a single character. 
+    # Encipher a single character.
     #
     # Used by {#encipher} to walk a single character of text through the
     # signal path of all components of the machine.
@@ -215,5 +218,174 @@ module RotorMachine
       end
       ec
     end
+
+    ##
+    # Create a Ruby hash containing a snapshot of the current machine state.
+    #
+    # The hash returned by this method contains enough information to capture
+    # the current internal state of the machine. Although you can invoke it
+    # directly if you want to, it is primarily intended to be accessed via
+    # the {#save_machine_state_to} and {#load_machine_state_from} methods,
+    # which save and load machine state to YAML files.
+    #
+    # @return [Hash] A Hash representing the internal state of the machine.
+    def machine_state
+      machine_state = {}
+      machine_state[:serialization_version] = RotorMachine::VERSION_DATA[0]
+
+      machine_state[:rotors] = []
+      self.rotors.each do |r|
+        rstate = {
+          kind: r.rotor_kind_name,
+          position: r.position,
+          step_size: r.step_size
+        }
+        if r.rotor_kind_name == :CUSTOM
+          rstate[:letters] = r.rotor_kind
+        end
+
+        machine_state[:rotors] << rstate
+      end
+      machine_state[:reflector] = {
+        kind: self.reflector.reflector_kind_name,
+        position: self.reflector.position
+      }
+      if (self.reflector.reflector_kind_name == :CUSTOM)
+        machine_state[:reflector][:letters] = self.reflector.letters
+      end
+
+      machine_state[:plugboard] = {
+        connections: self.plugboard.connections.clone
+      }
+      return machine_state
+    end
+
+    ##
+    # Write the internal machine state to a YAML file.
+    #
+    # The generated YAML file can be loaded using the #{load_machine_state_from}
+    # method to restore a saved machine state.
+    #
+    # @param filepath [String] The path to the YAML file to which the machine
+    # state should be saved.
+    # @return [Boolean] True if the save operation completed successfully, false
+    # if an error was raised.
+    def save_machine_state_to(filepath)
+      begin
+        File.open(filepath, "w") do |f|
+          f.puts machine_state.to_yaml
+        end
+        return true
+      rescue
+        return false
+      end
+    end
+
+    ##
+    # Read the internal machine state from a YAML file.
+    #
+    # The YAML file can be created using the #{save_machine_state_to} method to
+    # save the machine state of an existing {RotorMachine::Machine} object.
+    #
+    # The internal state is captured as is, so if you save the state from a machine
+    # that's not validly configured (no rotors, no reflector, etc.), the
+    # reconstituted machine will also have an invalid state.
+    #
+    # @param filepath [String] The path to the YAML file to which the machine
+    # state should be saved.
+    def load_machine_state_from(filepath)
+      raise ArgumentError, "File path \"#{filepath}\" not found!" unless File.exist?(filepath)
+      c = YAML.load(File.open(filepath))
+      self.set_machine_config_from(c)
+      return true
+    end
+
+    ##
+    # Create a new {RotorMachine::Machine} from a YAML configuration file.
+    #
+    # This class method is a one-step shortcut for creating an empty {RotorMachine::Machine}
+    # and then loading its machine state.
+    #
+    # @param config [Hash] A configuration hash for the new machine, such as a config
+    # hash generated by {#machine_state}.
+    # @return [RotorMachine::Machine] A new {RotorMachine::Machine} created from the
+    # supplied config hash.
+    def self.from_yaml(config)
+      unless config.keys.include?(:serialization_version)
+        raise ArgumentError, "Serialization Data Version Mismatch"
+      end
+      unless config[:serialization_version].is_a?(Numeric)
+        raise ArgumentError, "Serialization Data Version Mismatch"
+      end
+      if (config[:serialization_version] > RotorMachine::VERSION_DATA[0]) || (config[:serialization_version] < 1)
+        raise ArgumentError, "Serialization Data Version Mismatch"
+      end
+
+      m = self.empty_machine
+      m.set_machine_config_from(config)
+      return m
+    end
+
+    ##
+    # Set the state of the machine based on values in a config hash.
+    #
+    # Any config hash (such as that generated by {#machine_state}) can be provided
+    # as an argument, but this method is primarily intended to be accessed by the
+    # {#from_yaml} and {#load_config_state_from} methods to deserialize a machine
+    # state hash.
+    #
+    # @param config [Hash] The configuration hash describing the state of the
+    # {RotorMachine::Machine}.
+    # @return [RotorMachine::Machine] The {RotorMachine::Machine} which was just
+    # configured.  def set_machine_config_from(config)
+    def set_machine_config_from(config)
+      @rotors = []
+      @reflector = nil
+      @plugboard = RotorMachine::Plugboard.new()
+
+      # Create rotors
+      config[:rotors].each do |rs|
+        if rs[:kind] == :CUSTOM
+          r = RotorMachine::Rotor.new(rs[:letters], rs[:position], rs[:step_size])
+        else
+          letters = RotorMachine::Rotor.const_get(rs[:kind])
+          r = RotorMachine::Rotor.new(letters, rs[:position], rs[:step_size])
+        end
+        @rotors << r
+      end
+
+      # Create reflector
+      if config[:reflector][:kind] == :CUSTOM
+        letters = config[:reflector][:letters]
+      else
+        letters = RotorMachine::Reflector.const_get(config[:reflector][:kind])
+      end
+      @reflector = RotorMachine::Reflector.new(letters, config[:reflector][:position])
+
+      # Plugboard mappings
+      config[:plugboard][:connections].keys.each do |l|
+        unless @plugboard.connected?(l)
+          @plugboard.connect(l, config[:plugboard][:connections][l])
+        end
+      end
+
+      return self
+    end
+
+    ##
+    # Compare another {RotorMachine::Machine} instance to this one.
+    #
+    # Returns true if the provided {RotorMachine::Machine} has the same
+    # configuration as this one, and false otherwise.
+    #
+    # @param another_machine [RotorMachine::Machine] The Machine to compare to
+    # this one.
+    # @return [Boolean] True if the machines have identical configuration, false
+    # otherwise.
+    def ==(another_machine)
+      @rotors == another_machine.rotors &&
+        @reflector == another_machine.reflector &&
+        @plugboard == another_machine.plugboard
+    end
   end
 end

data/lib/rotor_machine/plugboard.rb

@@ -16,8 +16,9 @@ module RotorMachine
   #   from B to A.
   # - A letter cannot be connected to itself.
   class Plugboard
+    attr_reader :connections
 
-    ## 
+    ##
     # Create a new, empty Plugboard object.
     #
     # By default, no letters are connected in the plugboard, and all input
@@ -89,12 +90,25 @@ module RotorMachine
       @connections.keys.include?(letter.upcase)
     end
 
-    ## 
+    ##
     # Produce a human-readable representation of the #{Plugboard}'s state.
     #
     # @return [String] A description of the current state.
     def to_s
       "a RotorMachine::Plugboard with connections: #{@connections.to_s}"
     end
+
+    ##
+    # Compare this {RotorMachine::Plugboard} to another one.
+    #
+    # Returns True if the configuration of the supplied {RotorMachine::Plugboard}
+    # matches this one, false otherwise.
+    #
+    # @param another_plugboard [RotorMachine::Plugboard] The Plugboard to compare to
+    # this one.
+    # @return [Boolean] True if the configurations match, false otherwise.
+    def ==(another_plugboard)
+      @connections == another_plugboard.connections
+    end
   end
 end

data/lib/rotor_machine/reflector.rb

@@ -58,6 +58,8 @@ module RotorMachine
     #        Because the reflector does not rotate, this is essentially just
     #        an additional permutation factor for the encipherment.
     def initialize(selected_reflector, start_position = 0)
+      raise ArgumentError, "Initialization string contains duplicate letters" unless selected_reflector.is_uniq?
+
       @letters = selected_reflector.chars.freeze
       @alphabet = ALPHABET.chars.freeze
       @position = start_position
@@ -139,5 +141,19 @@ module RotorMachine
     def to_s
       "a RotorMachine::Reflector of type '#{self.reflector_kind_name.to_s}'"
     end
+
+    ##
+    # Compare this {RotorMachine::Reflector} to another one.
+    #
+    # Returns True if the configuration of the supplied {RotorMachine::Reflector}
+    # matches this one, false otherwise.
+    #
+    # @param another_reflector [RotorMachine::Reflector] The Reflector to compare 
+    # to this one.
+    # @return [Boolean] True if the configurations match, false otherwise.
+    def ==(another_reflector)
+      self.letters == another_reflector.letters &&
+      self.position == another_reflector.position
+    end
   end
 end

data/lib/rotor_machine/rotor.rb

@@ -29,6 +29,8 @@ module RotorMachine
     # {Rotor} based on either a numeric position or a letter position.
     attr_reader  :position
 
+    attr_reader :letters
+
     ##
     # Get or set the `step_size` - the number of positions the rotor should
     # advance every time it's stepped.
@@ -37,7 +39,7 @@ module RotorMachine
     ##
     # Provides the configuration of the German IC Enigma {Rotor}.
     ROTOR_IC = "DMTWSILRUYQNKFEJCAZBPGXOHV".freeze
-    
+
     ##
     # Provides the configuration of the German IIC Enigma {Rotor}.
     ROTOR_IIC = "HQZGPJTMOBLNCIFDYAWVEUSRKX".freeze
@@ -84,6 +86,7 @@ module RotorMachine
     # @param step_size [Integer] The number of positions to step the rotor
     #        each time it is advanced. Defaults to 1.
     def initialize(rotor, start_on=0, step_size=1)
+      raise ArgumentError, "Initialization string contains duplicate letters" unless rotor.is_uniq?
       @letters = rotor.chars.freeze
       self.position = start_on
       @step_size = step_size
@@ -197,5 +200,20 @@ module RotorMachine
     def to_s
       return "a RotorMachine::Rotor of type '#{self.rotor_kind_name}', position=#{self.position} (#{self.current_letter}), step_size=#{@step_size}"
     end
+
+    ##
+    # Compare this {RotorMachine::Rotor} to another one.
+    #
+    # Returns True if the configuration of the supplied {RotorMachine::Rotor} matches
+    # this one, false otherwise.
+    #
+    # @param another_rotor [RotorMachine::Rotor] The Rotor to compare to this one.
+    # @return [Boolean] True if the configurations match, false otherwise.
+    def ==(another_rotor)
+      @letters == another_rotor.letters &&
+      position == another_rotor.position &&
+      step_size == another_rotor.step_size
+    end
+
   end
 end

data/lib/rotor_machine/string_extensions.rb

@@ -4,6 +4,16 @@
 # @author Tammy Cravit <tammycravit@me.com>
 
 class String
+
+  ##
+  # Detect if a string has any duplicated characters
+  #
+  # @return True if the string has no duplicated characters, false otherwise.
+  def is_uniq?
+    self.chars.uniq.length == self.chars.length
+  end
+  alias :uniq? :is_uniq?
+
   ##
   # Break a string into blocks of a certain number of characters.
   #

data/lib/rotor_machine/version.rb

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

data/rotor_machine.gemspec

@@ -8,8 +8,6 @@ Gem::Specification.new do |spec|
   spec.version       = RotorMachine::VERSION
   spec.authors       = ['Tammy Cravit']
   spec.email         = ['tammycravit@me.com']
-  spec.cert_chain    = ['certs/tammycravit.pem']
-  spec.signing_key   = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
 
   spec.summary       = %q{Simple Enigma-like rotor machine in Ruby}
   spec.homepage      = 'https://github.com/tammycravit/rotor_machine'
@@ -22,15 +20,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'tcravit_ruby_lib'
+  spec.add_dependency 'tcravit_ruby_lib', '~> 0.2'
 
   spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'guard-bundler'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-bundler', '~> 2.1'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'simplecov-erb', '~> 0.1'
 end

metadata

@@ -1,55 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rotor_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.1.1
 platform: ruby
 authors:
 - Tammy Cravit
 autorequire: 
 bindir: exe
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBh0YW1t
-  eWNyYXZpdC9EQz1tZS9EQz1jb20wHhcNMTgwMjE5MjMxNDQzWhcNMTkwMjE5MjMx
-  NDQzWjAjMSEwHwYDVQQDDBh0YW1teWNyYXZpdC9EQz1tZS9EQz1jb20wggGiMA0G
-  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDDUddItdpGGMBoBfJZ2LWlXnfwEJWx
-  iOc478enSEQFOLXj3nVuTUhyac6MQFH6nB8CkNZt7MSokuWdQ7H//1Ajq+jeCwUm
-  WpjHF2BIL3WK7n8aAMH00p4gMAI4R8JnRjotmhUTIJCXtkIXoDTk1PGRzkH29q8+
-  dByUGmkAoX+iHqNRLbgiywLlpVapRT5B1nE+K8oETb0TilCfdvOh+91dM1LX/z69
-  uSOQOFoZSgnVNP/LTYaqDixdeEaDdslPRO1l8JSPdAzl1sn+YaeJwQbBWfbi+sGs
-  MB53CkLGDsz5MsrPx8b0iBNM/xFSEmXE+du3vCSAZktjNR7kNuFGbSOQW4SQkld6
-  mvw/Gi3TMmlgw2bELiXyUvEkHdkonFKMv9Rs2eq6Opw880YXl52/AcVi0dcsMZ3t
-  qp70xuUgsDF7zNdSfIgQzBX+GsmIIgbRQKUyGuXMnqUJlPm4fPnl5i3mIyZnqKyx
-  gg+2NNhKneabQF8wItZWdTGOVu87YFUOsosCAwEAAaN3MHUwCQYDVR0TBAIwADAL
-  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFMSFUfz/8w+SLDZIFy54jEKUPq4IMB0GA1Ud
-  EQQWMBSBEnRhbW15Y3Jhdml0QG1lLmNvbTAdBgNVHRIEFjAUgRJ0YW1teWNyYXZp
-  dEBtZS5jb20wDQYJKoZIhvcNAQELBQADggGBAC/hS37ZCB/MYxt6gE9i5qvjdY5j
-  qPiiQ7i5Yf2Gx6Jbe/wxiW1A3QcMdRvUSfIdC3XP3rYQf0AiyaQmbxhRn5e0LkYd
-  riChjHZxLQG3CKj+7YiUijIv0mgaw/lA0pEhMxIb/xY03Jwh64cg2FZrd/5wWLh2
-  QpyGVAktJp3rQolYO0fXbqRt40lg2+h2UWmaFvj++sFoCWdZzaopJZ3CS96IgUt+
-  sqm+r9HvzygOChJyLAjM8OwabZ4e2yRR2ZLiRxvHBL4FGf7hg6Y0YAvwvyRJw/7b
-  x6WTe0KO4pSZD02hl1A4gblx72eDvRwYkWO+dT1j9R+Wvrp/puwnzrLdThLwTsWQ
-  YGgdQBodP4Wqsew3nfbNJOKkqOnry4lWJugso3w2fe0nUbrWuaC3++J9Eazm++n/
-  F9wFDQvW5Nv6grw3Unc9miwN6NHA5kEjKzDDSXzWKSzAWbqzlMp/FxD+zP7NuibT
-  pjZmBE7TzW3JK1L4mE7lBh9bwUC5WoyMBDPT7A==
-  -----END CERTIFICATE-----
-date: 2018-02-19 00:00:00.000000000 Z
+cert_chain: []
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tcravit_ruby_lib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,58 +98,72 @@ dependencies:
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov-erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: 
 email:
 - tammycravit@me.com
@@ -182,8 +184,8 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/resolve_coverage.pl
 - bin/setup
-- certs/tammycravit.pem
 - exe/rotor_machine
 - images/Bundesarchiv_Enigma.jpg
 - images/File:Enigma_wiring_kleur.png
@@ -216,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Simple Enigma-like rotor machine in Ruby

checksums.yaml.gz.sig

@@ -1,2 +0,0 @@
-*�Qf�ڲ�g�Eq
-7 ����v(X�\�2z>����,�wg

data.tar.gz.sig

@@ -1,2 +0,0 @@
-�?S�:��� 3�
-�0&������cr�5L�f����-?>��"��ao���	i���rb8����p���O����#ޔu�#�\������oP��t�x�0 bpɠ�?���,u7��ޠ>L14.���+��

data/certs/tammycravit.pem

@@ -1,25 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBh0YW1t
-eWNyYXZpdC9EQz1tZS9EQz1jb20wHhcNMTgwMjE5MjMxNDQzWhcNMTkwMjE5MjMx
-NDQzWjAjMSEwHwYDVQQDDBh0YW1teWNyYXZpdC9EQz1tZS9EQz1jb20wggGiMA0G
-CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDDUddItdpGGMBoBfJZ2LWlXnfwEJWx
-iOc478enSEQFOLXj3nVuTUhyac6MQFH6nB8CkNZt7MSokuWdQ7H//1Ajq+jeCwUm
-WpjHF2BIL3WK7n8aAMH00p4gMAI4R8JnRjotmhUTIJCXtkIXoDTk1PGRzkH29q8+
-dByUGmkAoX+iHqNRLbgiywLlpVapRT5B1nE+K8oETb0TilCfdvOh+91dM1LX/z69
-uSOQOFoZSgnVNP/LTYaqDixdeEaDdslPRO1l8JSPdAzl1sn+YaeJwQbBWfbi+sGs
-MB53CkLGDsz5MsrPx8b0iBNM/xFSEmXE+du3vCSAZktjNR7kNuFGbSOQW4SQkld6
-mvw/Gi3TMmlgw2bELiXyUvEkHdkonFKMv9Rs2eq6Opw880YXl52/AcVi0dcsMZ3t
-qp70xuUgsDF7zNdSfIgQzBX+GsmIIgbRQKUyGuXMnqUJlPm4fPnl5i3mIyZnqKyx
-gg+2NNhKneabQF8wItZWdTGOVu87YFUOsosCAwEAAaN3MHUwCQYDVR0TBAIwADAL
-BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFMSFUfz/8w+SLDZIFy54jEKUPq4IMB0GA1Ud
-EQQWMBSBEnRhbW15Y3Jhdml0QG1lLmNvbTAdBgNVHRIEFjAUgRJ0YW1teWNyYXZp
-dEBtZS5jb20wDQYJKoZIhvcNAQELBQADggGBAC/hS37ZCB/MYxt6gE9i5qvjdY5j
-qPiiQ7i5Yf2Gx6Jbe/wxiW1A3QcMdRvUSfIdC3XP3rYQf0AiyaQmbxhRn5e0LkYd
-riChjHZxLQG3CKj+7YiUijIv0mgaw/lA0pEhMxIb/xY03Jwh64cg2FZrd/5wWLh2
-QpyGVAktJp3rQolYO0fXbqRt40lg2+h2UWmaFvj++sFoCWdZzaopJZ3CS96IgUt+
-sqm+r9HvzygOChJyLAjM8OwabZ4e2yRR2ZLiRxvHBL4FGf7hg6Y0YAvwvyRJw/7b
-x6WTe0KO4pSZD02hl1A4gblx72eDvRwYkWO+dT1j9R+Wvrp/puwnzrLdThLwTsWQ
-YGgdQBodP4Wqsew3nfbNJOKkqOnry4lWJugso3w2fe0nUbrWuaC3++J9Eazm++n/
-F9wFDQvW5Nv6grw3Unc9miwN6NHA5kEjKzDDSXzWKSzAWbqzlMp/FxD+zP7NuibT
-pjZmBE7TzW3JK1L4mE7lBh9bwUC5WoyMBDPT7A==
------END CERTIFICATE-----