rotor_machine 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a55afe85f516f188aa8964e6c8bbebfd737c55b07869433c5d733a3c6b0f72a
-  data.tar.gz: c846899187ea3ff7d4decfb67304a6088adf89ccde26e9e5dd31684938a1433d
+  metadata.gz: 3c2c0891a862a37a0d6a5bcc4c371963be0b6e6253e903aa244e01128e0e083f
+  data.tar.gz: 495ea928a095c71e3fa9652c17e2bd315a9cf40db9cc1940c9215a8bbdf1f9b2
 SHA512:
-  metadata.gz: 59394be7631a1a94ce384698b39447ef20d23a2bd21160728d48461342dc6eff2b56480d0702f4289482c980a164f26bf1f672bf2eaf0b616c632ee864634a62
-  data.tar.gz: 7f08cab18c273394e4ac4227d8fae60e8cf1c941866ccb801924efd725ba4dbb7ad8969f5e89b546ac12e02bc88fc412b2e917e2bdba655023257e4d434e6551
+  metadata.gz: 7aabcfcd91a31b4938036b777a74d7baf7a75e39ae4bc80dca251928f205b927b3bd69abb8924c399426a996630cd3569ac09f6390697ea2e2b340afa4403777
+  data.tar.gz: fd909b02710019b64b2ad18527612c1f74b711ae338f820db952ae6582f33642b11a3d3de881c18ac68a014848fea172fb1b75c766a40592c72f92b38f7fe32b

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/LICENSE.txt

@@ -1,21 +1,202 @@
-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.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,10 @@
 # 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.
+The RotorMAchine gem provides a simple Ruby implementation of the [Enigma](https://en.wikipedia.org/wiki/Enigma_machine) rotor encryption machine.
 
-TODO: Delete this and the text above, and describe your gem
+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.
+
+Many thanks to Kevin Sylvestre, whose [blog post](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.
 
 ## Installation
 
@@ -22,7 +24,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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`s  to the `rotors` array.
+3. Set the `reflector` to an instance of the `RotorMachine::Reflector` class.
+4. Make any desired connections in the 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.
 
 ## Development
 
@@ -32,13 +108,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tammycravit/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).
+The gem is available as open source under the terms of the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
 
 ## 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
+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.comtammycravitrotor_machine/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "tcravit_ruby_lib/rake_tasks"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/rotor_machine/machine.rb

@@ -1,4 +1,4 @@
-module RotorMachine #-nodoc-#
+module RotorMachine 
   ##
   # The {RotorMachine::Machine} class serves as the entrypoint and orchestrator
   # for an Enigma machine.

data/lib/rotor_machine/version.rb

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

data/rotor_machine.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Simple Enigma-like rotor machine in Ruby}
   spec.homepage      = "https://github.com/tammycravit/rotor_machine"
-  spec.license       = "MIT"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -20,10 +20,9 @@ Gem::Specification.new do |spec|
   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 "pry", "~> 0.11"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotor_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tammy Cravit
@@ -11,19 +11,19 @@ cert_chain: []
 date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: tcravit_ruby_lib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -31,27 +31,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-  type: :runtime
+  type: :development
   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
@@ -109,7 +95,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -125,7 +110,7 @@ files:
 - rotor_machine.gemspec
 homepage: https://github.com/tammycravit/rotor_machine
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/Gemfile.lock

@@ -1,47 +0,0 @@
-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