rotor_machine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a55afe85f516f188aa8964e6c8bbebfd737c55b07869433c5d733a3c6b0f72a
+  data.tar.gz: c846899187ea3ff7d4decfb67304a6088adf89ccde26e9e5dd31684938a1433d
+SHA512:
+  metadata.gz: 59394be7631a1a94ce384698b39447ef20d23a2bd21160728d48461342dc6eff2b56480d0702f4289482c980a164f26bf1f672bf2eaf0b616c632ee864634a62
+  data.tar.gz: 7f08cab18c273394e4ac4227d8fae60e8cf1c941866ccb801924efd725ba4dbb7ad8969f5e89b546ac12e02bc88fc412b2e917e2bdba655023257e4d434e6551

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+rotor_machine

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tammycravit@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rotor_machine.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    rotor_machine (1.0.0)
+      pry (~> 0.11)
+      tcravit_ruby_lib
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simple-password-gen (0.1.5)
+    tcravit_ruby_lib (0.2.8)
+      simple-password-gen (~> 0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rotor_machine!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tammy Cravit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# RotorMachine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rotor_machine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rotor_machine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rotor_machine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rotor_machine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RotorMachine project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rotor_machine/blob/master/CODE_OF_CONDUCT.md).
+# rotor_machine

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rotor_machine"
+require "pry"
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rotor_machine

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "rotor_machine"

data/lib/rotor_machine/machine.rb

@@ -0,0 +1,221 @@
+module RotorMachine #-nodoc-#
+  ##
+  # The {RotorMachine::Machine} class serves as the entrypoint and orchestrator
+  # for an Enigma machine.
+  #
+  # == Components of an Enigma machine
+  #
+  # The Enigma machine, as represented by the RotorMachine module, consists
+  # of the following components:
+  #
+  # - One or more rotors, which perform the transposition ciphering and also
+  #   rotate to produce a polyalphabetic (rather than simple substitution)
+  #   cipher.
+  #
+  # - A reflector, which performs a simple symmetric substitution of letters
+  #
+  # - A plugboard, which allows pairs of letters to be transposed on a
+  #   per-message basis.
+  #
+  # On an actual Enigma machine, these components are all electromechanical,
+  # and the Enigma also included a keyboard, a grid of lights to show the
+  # results, and in some cases a printer. Since this is a simulated Enigma,
+  # obviously, no keyboard/printer are supplied here.
+  #
+  # The polyalphabetic encryption of the Enigma comes from the fact that the
+  # rotors are linked (mechanically in a real Enigma) so that they rotate
+  # one or more "steps" after each character, changing the signal paths and
+  # transpositions. This means that a sequence of the same plaintext character
+  # will encipher to different ciphertext characters.
+  #
+  # The rotors are designed to advance such that each time a rotor completes
+  # a full revolution, it will advance the rotor to its left once. The rotors
+  # allow you to configure how many positions they advance when they do. So,
+  # assuming all rotors are advancing one position at a time, if the rotors
+  # have position "AAZ", their state after the next character is typed will
+  # be "ABA".
+  #
+  # To learn much more about the inner workings of actual Enigma machines,
+  # visit {https://en.wikipedia.org/wiki/Enigma_machine}.
+  #
+  # == The Signal Path of Letters
+  #
+  # 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 
+  # finally back through the plugboard a second time before being displayed on
+  # the light grid and/or printer.
+  #
+  # One important consequence of this signal path is that encryption and
+  # decryption are the same operation. That is to say, if you set the rotors
+  # and plugboard, and then type your plaintext into the machine, you'll get
+  # a string of ciphertext. If you then reset the machine to its initial state
+  # and type the ciphertext characters into the machine, you'll produce your
+  # original plaintext.
+  #
+  # One consequence of the Enigma's design is that a plaintext letter will
+  # never encipher to itself. The Allies were able to exploit this property
+  # 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:
+  #
+  # 1. Create a new {RotorMachine::Machine} object.
+  # 2. Add one or more {RotorMachine::Rotor Rotors} to the `rotors` array.
+  # 3. Set the `reflector` to an instance of the {RotorMachine::Reflector Reflector} class.
+  # 4. Make any desired connections in the {RotorMachine::Plugboard Plugboard}.
+  # 5. Optionally, set the rotor positions with {#set_rotors}.
+  #
+  # You're now ready to encipher and decipher your text using the {#encipher}
+  # 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 
+  # with a default set of rotors and reflector, and an empty machine with
+  # no rotors or reflector.
+  class Machine
+    attr_accessor :rotors, :reflector, :plugboard
+
+    ##
+    # 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
+    def self.default_machine
+       machine = self.empty_machine
+       machine.rotors << RotorMachine::Rotor.new(RotorMachine::Rotor::ROTOR_I, "A", 1)
+       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
+    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.
+    def self.empty_machine
+       machine = RotorMachine::Machine.new()
+       machine.rotors = []
+       machine.reflector = nil
+       machine.plugboard = RotorMachine::Plugboard.new()
+       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
+    end
+
+    ##
+    # Encipher (or decipher) a string.
+    #
+    # Each character of the string is, in turn, passed through the machine.
+    # This process is documented in the class comment for the
+    # {RotorMachine::Machine} class.
+    #
+    # Because the Enigma machine did not differentiate uppercase and lowercase
+    # letters, the source string is upcase'd before processing.
+    # @param text [String] the text to encipher or decipher
+    # @return [String] the enciphered or deciphered text
+    def encipher(text)
+      raise ArgumentError, "Cannot encipher; no rotors loaded" if (@rotors.count == 0)
+      raise ArgumentError, "Cannot encipher; no reflector loaded" if (@reflector.nil?)
+      text.upcase.chars.collect { |c| self.encipher_char(c) }.join("")
+    end
+
+    ##
+    # Coordinate the stepping of the set of rotors after a character is 
+    # enciphered. 
+    def step_rotors
+      @rotors.reverse.each do |rotor|
+        rotor.step
+        break unless rotor.wrapped?
+      end
+    end
+
+    ##
+    # Set the initial positions of the set of rotors before begining an
+    # enciphering or deciphering operation.
+    #
+    # 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. 
+    #
+    # 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
+    # the "extra" rotors will be unchanged.
+    #
+    # @param init_val [String] A string containing the initial values
+    # for the rotors.
+    def set_rotors(init_val)
+      init_val.chars.each_with_index do |c, i|
+        @rotors[i].position = c if (i < @rotors.length)
+      end
+    end
+
+    ##
+    # Describe the current state of the machine in human-readable form.
+    #
+    # @return [String] A description of the Rotor Machine's current internal
+    # state.
+    def to_s
+      buf = "a RotorMachine::Machine with the following configuration:\n"
+      buf += "  Rotors: #{@rotors.count}\n"
+      @rotors.each { |r| buf += "    - #{r.to_s}\n" }
+      buf += "  Reflector: #{@reflector.nil? ? "none" : @reflector.to_s}\n"
+      buf += "  Plugboard: #{@plugboard.nil? ? "none" : @plugboard.to_s}"
+      return buf
+    end
+
+    ##
+    # Encipher a single character. 
+    #
+    # Used by {#encipher} to walk a single character of text through the
+    # signal path of all components of the machine.
+    #
+    # @param c [String] a single-character string containing the next
+    #          character to encipher/decipher
+    # @return [String] the enciphered/deciphered character. After the
+    #         character passes through the machine, a call is made to
+    #         {#step_rotors} to advance the rotors.
+    def encipher_char(c)
+      ec = c
+
+      unless @plugboard.nil?
+        ec = @plugboard.transpose(ec)
+      end
+
+      @rotors.each { |rotor| ec = rotor.forward(ec) }
+      ec = @reflector.reflect(ec)
+      @rotors.reverse.each { |rotor| ec = rotor.reverse(ec) }
+
+      unless @plugboard.nil?
+        ec = @plugboard.transpose(ec)
+      end
+
+      self.step_rotors
+      ec
+    end
+  end
+end

data/lib/rotor_machine/plugboard.rb

@@ -0,0 +1,102 @@
+module RotorMachine
+  ##
+  # Plugboard implementaion for the {RotorMachine} Enigma simulation.
+  #
+  # The Plugboard was an enhancement to the original Enigma machine to add an
+  # additional layer of transposition into the signal path. Signals passed
+  # through the plugboard as they were leaving the keyboard and, to maintain
+  # the symmetry of the Enigma's encryption, before being displayed on the
+  # lightboard.
+  #
+  # The properties of the {Plugboard} which are relevant to how the encryption
+  # works are:
+  #
+  # - Each letter may only be connected to one other letter.
+  # - Connections are reciprocal. Connecting A to B also implies a connection
+  #   from B to A.
+  # - A letter cannot be connected to itself.
+  class Plugboard
+
+    ## 
+    # Create a new, empty Plugboard object.
+    #
+    # By default, no letters are connected in the plugboard, and all input
+    # characters are passed through unchanged.
+    def initialize
+      @connections = {}
+    end
+
+    ##
+    # Connect a pair of letters on the {Plugboard}.
+    #
+    # The designations of "from" and "to" are rather arbitrary, since the
+    # connection is reciprocal.
+    #
+    # An {ArgumentError} will be raised if either +from+ or +to+ are already
+    # connected, or if you try to connect a letter to itself. 
+    #
+    # @param from [String] A single-character string designating the start
+    #        of the connection.
+    # @param to [String] A single-character string designating the end
+    #        of the connection.
+    def connect(from, to)
+      from.upcase!
+      to.upcase!
+      raise ArgumentError, "#{from} is already connected" if (connected?(from))
+      raise ArgumentError, "#{to} is already connected" if (connected?(to))
+      raise ArgumentError, "#{from} cannot be connected to itself" if (to == from)
+
+      @connections[from] = to
+      @connections[to] = from
+    end
+
+    ##
+    # Disconnect a plugboard mapping for a letter.
+    #
+    # Because the {Plugboard} mappings are reciprocal (they were represented by
+    # a physical wire on the actual machine), this also removes the reciprocal
+    # mapping.
+    #
+    # An {ArgumentError} is raised if the specified letter is not connected.
+    #
+    # @param letter [String] The letter to disconnect. You may specify the
+    #        letter at either end of the mapping.
+    def disconnect(letter)
+      letter.upcase!
+      if (connected?(letter))
+        other_end = @connections.delete(letter)
+        @connections.delete(other_end)
+      else
+        raise ArgumentError, "#{letter} is not connected"
+      end
+    end
+
+    ##
+    # Feed a string of characters through the {Plugboard} and return the mapped
+    # characters. Characters which are not mapped are passed through unchanged
+    # (but the parameter string is upcased before processing.
+    #
+    # @param the_string [String] The string being enciphered.
+    # @return [String] The enciphered text.
+    def transpose(the_string)
+      the_string.chars.collect { |c| @connections[c.upcase] || c.upcase }.join("")
+    end
+
+    ##
+    # Test if a particular letter is connected on the {Plugboard}.
+    #
+    # @param letter [String] The letter to test.
+    # @return True if the letter is connected, nil otherwise.
+    def connected?(letter)
+      @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
+  end
+end

data/lib/rotor_machine/reflector.rb

@@ -0,0 +1,97 @@
+module RotorMachine
+  ##
+  # Implementation of the Reflector rotor.
+  #
+  # A {Reflector} behaves similarly to a {RotorMachine::Rotor Rotor}, except
+  # that the {Reflector} did not rotate. Its purpose is to reflect the
+  # signal path back through the rotor stack in the opposite direction,
+  # thereby ensuring that the encryption algorithm is symmetric.
+  #
+  # The module defines constants for the standard German Enigma reflectors,
+  # but you can create a reflector with any string of 26 alphabetic
+  # characters. However, you may not repeat a given letter more than once
+  # in your string, or else the symmetry of the encipherment algorithm will
+  # be broken.
+  class Reflector
+
+    ##
+    # The letter mapping for the German "A" reflector.
+    REFLECTOR_A      = "EJMZALYXVBWFCRQUONTSPIKHGD".freeze
+
+    ##
+    # The letter mapping for the German "B" reflector.
+    REFLECTOR_B      = "YRUHQSLDPXNGOKMIEBFZCWVJAT".freeze
+
+    ##
+    # The letter mapping for the German "C" reflector.
+    REFLECTOR_C      = "FVPJIAOYEDRZXWGCTKUQSBNMHL".freeze
+
+    ##
+    # The letter mapping for the German "B Thin" reflector.
+    REFLECTOR_B_THIN = "ENKQAUYWJICOPBLMDXZVFTHRGS".freeze
+
+    ##
+    # The letter mapping for the German "C Thin" reflector.
+    REFLECTOR_C_THIN = "RDOBJNTKVEHMLFCWZAXGYIPSUQ".freeze
+
+    ##
+    # The letter mapping for the German "ETW" reflector.
+    REFLECTOR_ETW    = "ABCDEFGHIJKLMNOPQRSTUVWXYZ".freeze
+
+    ##
+    # Initialize a new {Reflector}.
+    #
+    # @param selected_reflector [String] The character sequqnece for the
+    #        reflector. You can use one of the class constants which define
+    #        the standard German reflectors, or pass a custom sequence of
+    #        26 letters.
+    # @param start_position [Integer] The start position of the reflector.
+    #        Because the reflector does not rotate, this is essentially just
+    #        an additional permutation factor for the encipherment.
+    def initialize(selected_reflector, start_position = 0)
+      @letters = selected_reflector.chars.freeze
+      @alphabet = REFLECTOR_ETW.chars.freeze
+      @position = start_position
+    end
+
+    ##
+    # Feed a sequence of characters through the reflector, and return the
+    # results.
+    #
+    # Any characters which are not present on the reflector will be passed
+    # through unchanged.
+    #
+    # @param input [String] The string of characters to encipher.
+    # @return [String] The results of passing the input string through the
+    #         {Reflector}.
+    def reflect(input)
+      input.upcase.chars.each.collect { |c| 
+        if @alphabet.include?(c) then 
+          @letters[(@alphabet.index(c) + @position) % @alphabet.length] 
+        else 
+          c 
+        end }.join("")
+    end
+
+    ##
+    # Return the reflector kind.
+    #
+    # If the {Reflector} is initialized with one of the provided rotor type
+    # constants (such as {REFLECTOR_A}), the name of the reflector will be
+    # returned as a symbol. If not, the symbol `:CUSTOM` will be returned..
+    #
+    # @return [Symbol] The kind of this {Reflector} object.
+    def reflector_kind_name
+      self.class.constants.each { |r| return r if (@letters.join("") == self.class.const_get(r)) }
+      return :CUSTOM
+    end
+
+    ##
+    # Return a human-readable representation of the {Reflector}
+    #
+    # @return [String] A description of the Reflector.
+    def to_s
+      "a RotorMachine::Reflector of type '#{self.reflector_kind_name.to_s}'"
+    end
+  end
+end

data/lib/rotor_machine/rotor.rb

@@ -0,0 +1,201 @@
+module RotorMachine
+  ##
+  # Implment an Enigma machine rotor.
+  #
+  # The {Rotor} is the central component of the Enigma machine's polyalphabetic
+  # substitution cipher. Each rotor consisted of a ring with a series of 
+  # internal connections and wiring which mapped input letters on the left side
+  # of the rotor to (different) output letters on the right side. The signal
+  # from the Enigma's keyboard would pass twice through the rotor/reflector
+  # stack (and plugboard) in opposite directions before being displayed. This
+  # ensured the algorithm was symmetrical; without this property, the Enigma
+  # could not both encipher and decipher text.
+  #
+  # Adding to the complexity of the algorithm, the rotors rotated after 
+  # enciphering each character. In a standard 3-rotor Enigma machine, the
+  # rightmost rotor advanced position for each character. The middle rotor
+  # advanced one position with each full revolution of the right rotor, and
+  # the left rotor advanced one position with each full rotation of the middle
+  # rotor. These rotations permuted the signal path, so a sequence of several
+  # of the same input character would produce different output characters.
+  #
+  # The {Rotor} as implemented here allows the `step_size` (the number of
+  # positions each rotor advances when it's stepped) to be varied.
+  class Rotor
+
+    ##
+    # Query the current numeric position (0-based) of the rotor. The {#position=}
+    # method provides a setter for this property to allow for setting the
+    # {Rotor} based on either a numeric position or a letter position.
+    attr_reader  :position
+
+    ##
+    # Get or set the `step_size` - the number of positions the rotor should
+    # advance every time it's stepped.
+    attr_accessor :step_size
+
+    ##
+    # 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
+    
+    ##
+    # Provides the configuration of the German IIIC Enigma {Rotor}.
+    ROTOR_IIIC = "UQNTLSZFMREHDPXKIBVYGJCWOA".freeze
+    
+    ##
+    # Provides the configuration of the German I Enigma {Rotor}.
+    ROTOR_I = "JGDQOXUSCAMIFRVTPNEWKBLZYH".freeze
+    
+    ##
+    # Provides the configuration of the German II Enigma {Rotor}.
+    ROTOR_II = "NTZPSFBOKMWRCJDIVLAEYUXHGQ".freeze
+    
+    ##
+    # Provides the configuration of the German III Enigma {Rotor}.
+    ROTOR_III = "JVIUBHTCDYAKEQZPOSGXNRMWFL".freeze
+    
+    ##
+    # Provides the configuration of the German UKW Enigma {Rotor}.
+    ROTOR_UKW = "QYHOGNECVPUZTFDJAXWMKISRBL".freeze
+    
+    ##
+    # Provides the configuration of the German ETW Enigma {Rotor}.
+    ROTOR_ETW = "QWERTZUIOASDFGHJKPYXCVBNML".freeze
+    
+    ##
+    # Provides the alphabet in order. Used for mapping rotor indices, but
+    # could also be used as a {Rotor} configuration.
+    ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ".freeze
+
+    ##
+    # Initialize a new rotor.
+    #
+    # @param rotor [String] The letter sequence used for the new rotor. In
+    #        normal use, this should be one of the class constants which
+    #        define the standard German Enigma rotors, but any sequence of
+    #        26 unique letters can be used.
+    # @param start_on [Integer] The (0-based) starting position for the rotor. 
+    #        Defaults to 0. To start on a specific letter, use {#position=} to 
+    #        set the rotor after creating it.
+    # @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)
+      @letters = rotor.chars.freeze
+      self.position = start_on
+      @step_size = step_size
+      @wrapped = nil
+    end
+
+    ##
+    # Set the position of the {Rotor}.
+    #
+    # If a numeric position is provided, an {ArgumentError} will be raised if
+    # the position is outside the bounds of the rotor. If an alphabetic position
+    # is provided, an {ArgumentError} will be raised if the supplied character
+    # is not a character represented on the rotor.
+    #
+    # @param pos [Numeric, String] The position of the rotor.
+    def position=(pos)
+      if pos.class.to_s == "String"
+        raise ArgumentError, "#{pos[0]} is not a character on the rotor" unless @letters.include?(pos[0])
+        @position = @letters.index(pos[0])
+      elsif pos.class.to_s == "Integer"
+        raise ArgumentError, "Position #{pos} is invalid" if (pos < 0 or pos > @letters.length)
+        @position = pos
+      else
+        raise ArgumentError, "Invalid argument to position= (#{pos.class.to_s})"
+      end
+    end
+
+    ## 
+    # Return the "forward" (left-to-right) transposition of the supplied letter.
+    #
+    # @param letter [String] The letter to encipher.
+    # @return [String] The enciphered letter.
+    def forward(letter)
+      if ALPHABET.include?(letter)
+        @letters[((ALPHABET.index(letter) + self.position) % @letters.length)]
+      else
+        letter
+      end
+    end
+
+    
+    ## 
+    # Return the "reverse" (right-to-left) transposition of the supplied letter.
+    #
+    # @param letter [String] The letter to encipher.
+    # @return [String] The enciphered letter.
+    def reverse(letter)
+      if ALPHABET.include?(letter)
+        ALPHABET[((@letters.index(letter) - self.position) % @letters.length)]
+      else
+        letter
+      end
+    end
+
+    ## 
+    # Step the rotor.
+    #
+    # @param step_size [Integer] The number of positions to step the rotor.
+    #        Defaults to the value of {#step_size} if not provided.
+    def step(step_size=@step_size)
+      old_position = @position
+      @position = (@position + step_size) % @letters.length
+      @wrapped = (old_position > @position)
+    end
+
+    ##
+    # Get the current letter position of the rotor.
+    #
+    # @return [String] The current letter position of the rotor.
+    def current_letter
+      @letters[@position]
+    end
+
+    ##
+    # Return the current rotor's "kind" (a string containing the mappings of
+    # the rotor.
+    #
+    # @return [String] The sequence of letters on the {Rotor}.
+    def rotor_kind
+      @letters.join("")
+    end
+
+    ## 
+    # Return the name of this kind of rotor.
+    #
+    # If the rotor's sequence matches one of the defined class constants for a
+    # standsard Enigma rotor, the name of the constant will be returned as a
+    # symbol. Otherwise, :CUSTOM is returned.
+    #
+    # @return [Symbol] The name of the kind of this rotor.
+    def rotor_kind_name
+      self.class.constants.each { |k| return k if (self.class.const_get(k) == rotor_kind) }
+      return :CUSTOM
+    end
+
+    ##
+    # Check if the last {#step} operation caused the rotor to wrap around in
+    # position. This is used by the {RotorMachine::Machine Machine} to determine
+    # whether to advance the adjacent rotor.
+    #
+    # @return [Booleam] True if the last {#step} operation caused the rotor to 
+    #         wrap around.
+    def wrapped?
+      @wrapped
+    end
+
+    ##
+    # Generate a human-readable representation of the {Rotor}'s state.
+    #
+    # @return [String] The current state of the Rotor
+    def to_s
+      return "a RotorMachine::Rotor of type '#{self.rotor_kind_name}', position=#{self.position} (#{self.current_letter}), step_size=#{@step_size}"
+    end
+  end
+end

data/lib/rotor_machine/version.rb

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

data/lib/rotor_machine.rb

@@ -0,0 +1,27 @@
+$:.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)) 
+end
+
+##
+# The RotorMachine gem is a relatively simple implementation of the German
+# WWII "Enigma"-style of rotor-based encryption machine.
+#
+# I wrote RotorMachine primarily as an exercise in Test-Driven Development
+# with RSpec. It is not intended to be efficient or performant, and I wasn't
+# striving much for idiomatic conciseness. My aims were fairly modular code
+# and a relatively complete RSpec test suite.
+#
+# The documentation for {RotorMachine::Machine} shows an example of how to
+# use the module.
+#
+# 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/rotor_machine.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rotor_machine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rotor_machine"
+  spec.version       = RotorMachine::VERSION
+  spec.authors       = ["Tammy Cravit"]
+  spec.email         = ["tammycravit@me.com"]
+
+  spec.summary       = %q{Simple Enigma-like rotor machine in Ruby}
+  spec.homepage      = "https://github.com/tammycravit/rotor_machine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.20"
+  spec.add_dependency "pry", "~> 0.11"
+  spec.add_dependency "tcravit_ruby_lib"
+  
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rotor_machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tammy Cravit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: tcravit_ruby_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tammycravit@me.com
+executables:
+- rotor_machine
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rotor_machine
+- lib/rotor_machine.rb
+- lib/rotor_machine/machine.rb
+- lib/rotor_machine/plugboard.rb
+- lib/rotor_machine/reflector.rb
+- lib/rotor_machine/rotor.rb
+- lib/rotor_machine/version.rb
+- rotor_machine.gemspec
+homepage: https://github.com/tammycravit/rotor_machine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Simple Enigma-like rotor machine in Ruby
+test_files: []