pontifex 1.0.1

data/lib/pontifex/key_stream.rb

@@ -0,0 +1,79 @@
+require 'pontifex/card'
+
+module Pontifex 
+
+  DEFAULT_KEY = "Ac,2c,3c,4c,5c,6c,7c,8c,9c,Tc,Jc,Qc,Kc," +
+                "Ad,2d,3d,4d,5d,6d,7d,8d,9d,Td,Jd,Qd,Kd," +
+                "Ah,2h,3h,4h,5h,6h,7h,8h,9h,Th,Jh,Qh,Kh," +
+                "As,2s,3s,4s,5s,6s,7s,8s,9s,Ts,Js,Qs,Ks," +
+                "ja,jb"
+
+  class KeyStream
+    attr_reader :deck
+    JA = Card.new("ja")
+    JB = Card.new("jb")
+
+    def initialize(key=Pontifex::DEFAULT_KEY)
+      @deck = process_param(key)
+    end
+
+    def sequence!
+      move_down!("ja", 1)
+      move_down!("jb", 2)
+      triple_cut!
+      count_cut!
+    end
+
+    def letter
+      count = @deck.first.to_i
+      if result = @deck[count].to_c
+        result
+      else
+        sequence!
+        letter
+      end
+    end
+
+    def to_key
+      @deck.map { |card| card.str }.join(",")
+    end
+
+
+    private
+    def process_param(str)
+      #TODO I need to raise an exception here if any 'Ja' jokers,
+      #     as opposed to 'ja' jokers, (or 'Jb') are included in
+      #     the key -- Or does this exception belong in Card?
+      key_ary = str.split(",")
+      key_ary.map { |param| Card.new(param) }
+    end
+
+    def move_down!(card_str, num)
+      num.times do
+        index = @deck.index { |c| c.str == card_str }
+        unless @deck[index] == @deck.last
+          @deck[index], @deck[index + 1] = @deck[index + 1], @deck[index]
+        else
+          @deck.insert(1, @deck.pop)
+        end
+      end
+    end
+
+    def triple_cut!
+      ti, bi = @deck.index(JA), @deck.index(JB)
+      ti, bi = bi, ti if ti > bi
+
+      top = @deck[0...ti]
+      middle = @deck[ti..bi]
+      bottom = @deck[(bi + 1)..-1]
+
+      @deck.replace(bottom + middle + top)
+    end
+
+    def count_cut!
+      count = @deck.last.to_i
+      top = @deck.shift(count)
+      @deck.insert(-2, *top)
+    end
+  end
+end

data/lib/pontifex.rb

@@ -0,0 +1,114 @@
+require 'bundler/setup'
+require 'trollop'
+require 'pontifex/cipher'
+
+
+module Pontifex
+  extend self
+
+  def run
+    parse_options!
+
+    case @cmd
+    when "encrypt"
+      @output = @pontifex.encrypted
+    when "decrypt"
+      @output = @pontifex.decrypted
+    end
+
+    handle_output
+  end
+
+
+  private
+  def handle_output
+    if @cmd_options[:out_file]
+      File.open(@cmd_options[:out_file], 'w') {|f| f.write(@output) }
+      puts "Message #{@cmd}ed.  You can find the results in the file: #{@cmd_options[:out_file]}\n"
+    else
+      puts @output
+    end
+  end
+
+  SUB_COMMANDS = %w[encrypt decrypt]
+
+  def parse_options!
+    version_str = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+    Trollop::options do
+      banner <<-EOS
+      pontifex will encrypt, or decrypt messages.
+      
+      Usage:
+               pontifex [options]
+               pontifex encrypt [options] [file ...]
+               pontifex decrypt [options] [file ...]
+               where [options] are:
+      EOS
+      version version_str      
+      stop_on SUB_COMMANDS
+    end
+
+    @cmd = ARGV.shift
+    @cmd_options = case @cmd
+    when "encrypt"
+      Trollop::options do
+        banner <<-EOS
+        pontifex will encrypt messages from STDIN or from files.
+        
+        Usage:
+                 pontifex encrypt [options] [file ...]
+                 where [options] are:
+        EOS
+        version version_str
+        opt :deck_key, "A file setting the key (a deck of cards) in a specific, initial order", :type => :string
+        opt :out_file, "An output file for the encrypted message", :type => :string
+      end
+
+    when "decrypt"
+      Trollop::options do
+        banner <<-EOS
+        pontifex will decrypt messages from STDIN or from files.
+        
+        Usage:
+                 pontifex decrypt [options] [file ...]
+                 where [options] are:
+        EOS
+        version version_str
+        opt :deck_key, "A file setting the key (a deck of cards) in a specific, initial order", :type => :string
+        opt :out_file, "An output file for the decrypted message", :type => :string
+      end
+
+    else
+      Trollop::die "Either 'encrypt' or 'decrypt' must be passed as a sub-command"
+    end
+
+    key = ""
+    if @cmd_options[:deck_key]
+      Trollop::die "Can't find #{@cmd_options[:deck_key]} key file" unless File.exists?(@cmd_options[:deck_key])
+
+      File.open(@cmd_options[:deck_key], "r") do |infile|
+        while (line = infile.gets)
+          key << line.chomp
+        end
+      end
+    end
+
+    if ARGV.empty?
+      puts "Enter the message to encrypt."
+      puts "enter 'Done' on a line by itself when you are done"
+    end
+
+    message = ""
+    while input = gets
+      break if input.nil? || input.chomp.downcase == "done"
+      message << input.chomp
+    end
+
+    if key.empty?
+      @pontifex = Cipher.new(message)
+    else
+      @pontifex = Cipher.new(message, key)
+    end
+  end
+end

data/pontifex.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pontifex}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Errin Larsen"]
+  s.date = %q{2011-06-01}
+  s.default_executable = %q{pontifex}
+  s.description = %q{This gem is a solution to ruby quiz #1: http://www.rubyquiz.com/quiz1.html}
+  s.email = %q{errinlarsen@gmail.com}
+  s.executables = ["pontifex"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "bin/pontifex",
+    "cucumber.yml",
+    "feature/pontifex_interactive.feature",
+    "feature/pontifex_with_files.feature",
+    "feature/support/env.rb",
+    "lib/pontifex.rb",
+    "lib/pontifex/card.rb",
+    "lib/pontifex/cipher.rb",
+    "lib/pontifex/key_stream.rb",
+    "pontifex.gemspec",
+    "spec/pontifex/card_spec.rb",
+    "spec/pontifex/cipher_spec.rb",
+    "spec/pontifex/key_stream_spec.rb",
+    "spec/pontifex/pontifex_spec.rb",
+    "spec/spec_helper.rb",
+    "vendor/cache/aruba-0.3.6.gem",
+    "vendor/cache/builder-3.0.0.gem",
+    "vendor/cache/childprocess-0.1.9.gem",
+    "vendor/cache/cucumber-0.10.3.gem",
+    "vendor/cache/diff-lcs-1.1.2.gem",
+    "vendor/cache/ffi-1.0.9.gem",
+    "vendor/cache/gherkin-2.3.9.gem",
+    "vendor/cache/git-1.2.5.gem",
+    "vendor/cache/jeweler-1.6.0.gem",
+    "vendor/cache/json-1.5.1.gem",
+    "vendor/cache/rake-0.9.0.gem",
+    "vendor/cache/rcov-0.9.9.gem",
+    "vendor/cache/rspec-2.6.0.gem",
+    "vendor/cache/rspec-core-2.6.3.gem",
+    "vendor/cache/rspec-expectations-2.6.0.gem",
+    "vendor/cache/rspec-mocks-2.6.0.gem",
+    "vendor/cache/term-ansicolor-1.0.5.gem",
+    "vendor/cache/trollop-1.16.2.gem"
+  ]
+  s.homepage = %q{http://github.com/errinlarsen/pontifex}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{An implementation of the Solitaire Cipher in Ruby}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<trollop>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<aruba>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<aruba>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<aruba>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/pontifex/card_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module Pontifex
+  describe Card do
+    describe "#new" do
+      describe "input validations" do
+        it "should raise an error with an input paramter that is less than 2 characters" do
+          expect { Card.new("5") }.to raise_error ArgumentError, "Cards must be 2 characters long"
+        end
+
+        it "should raise an error with an input paramter that is more than 2 characters" do
+          expect { Card.new("5As") }.to raise_error ArgumentError, "Cards must be 2 characters long"
+        end
+
+        it "should raise an error with an input parameter outside of the letters j,A,T,J,Q or K and the numbers 2-9 as the first character" do
+          expect { Card.new("bs") }.to raise_error ArgumentError, "first character of a card must be one of [2-9,j,A,T,J,Q,K]"
+        end
+
+        it "should raise an error with an input parameter outside of the letters c,d,h,s,a,b as the second character"do
+          expect { Card.new("9g") }.to raise_error ArgumentError, "second character of a card must be one of [a,b,c,d,h,s]"
+        end
+
+        it "should raise an error with a valid card value character, but with a suit of 'a' or 'b'" do
+          expect { Card.new("9b") }.to raise_error ArgumentError, "only Jokers may have a suit of 'a' or 'b'"
+        end
+
+        it "should raise an error with an input parameter of a Joker with a suit other than 'a' or 'b'" do
+          expect { Card.new("jd") }.to raise_error ArgumentError, "Jokers may not have a suit other than 'a' or 'b'"
+        end
+      end
+
+      describe "Card integer values" do
+        it "should create a card with a value of 2 if '2c' is input as a parameter" do
+          Card.new("2c").to_i.should == 2
+        end
+
+        it "should create a card with a value of 25 if 'Qd' is input as a parameter" do
+          Card.new("Qd").to_i.should == 25
+        end
+
+        it "should create a card with a value of 36 if 'Th' is input as a parameter" do
+          Card.new("Th").to_i.should == 36
+        end
+
+        it "should create a card with a value of 40 if 'As' is input as a parameter" do
+          Card.new("As").to_i.should == 40
+        end
+
+        it "should create a card with a value of 53 if 'ja' is input as a paramter" do
+          Card.new("ja").to_i.should == 53
+        end
+      end
+
+      describe "Card letter values" do
+        it "should create a card with a letter of 'd' if '4c' is input as a parameter" do
+          Card.new("4c").to_c.should == "D"
+        end
+
+        it "should create a card with a letter of 'u' if 'Jd' is input as a parameter" do
+          Card.new("Jd").to_c.should == "X"
+        end
+
+        it "should create a card with a letter of 'j' if 'Th' is input as a parameter" do
+          Card.new("Th").to_c.should == "J"
+        end
+
+        it "should create a card with a letter of 'x' if 'Js' is input as a parameter" do
+          Card.new("Js").to_c.should == "X"
+        end
+
+        it "should create a card with a letter of NIL if 'Jb' is input as a paramter" do
+          Card.new("jb").to_c.should be_nil
+        end
+      end
+
+      describe "Equality" do
+        it "should be equal to another card created with the same input as a parameter" do
+          param = "Qh"
+          Card.new(param).should == Card.new(param)
+        end
+      end
+    end
+  end
+end

data/spec/pontifex/cipher_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Pontifex
+  describe Cipher do
+    let(:raw_unencrypted_msg) { "Code in Ruby, live longer!" }
+    let(:decrypted_msg) { "CODEI NRUBY LIVEL ONGER" }
+    let(:encrypted_msg) {  "GLNCQ MJAFF FVOMB JIYCB" }
+
+    describe "#encrypted" do
+      it "should return an encrypted conversion of the input String paramter" do
+        msg = Cipher.new(raw_unencrypted_msg)
+        msg.encrypted.should == encrypted_msg
+      end
+    end
+
+    describe "#decrypted" do
+      it "should return a decrypted plain text conversion of the input String parameter" do
+        msg = Cipher.new(encrypted_msg)
+        msg.decrypted.should == decrypted_msg
+      end
+    end
+  end
+end

data/spec/pontifex/key_stream_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+module Pontifex
+  describe KeyStream do
+    let(:default_key) do
+      "Ac,2c,3c,4c,5c,6c,7c,8c,9c,Tc,Jc,Qc,Kc," +
+      "Ad,2d,3d,4d,5d,6d,7d,8d,9d,Td,Jd,Qd,Kd," +
+      "Ah,2h,3h,4h,5h,6h,7h,8h,9h,Th,Jh,Qh,Kh," +
+      "As,2s,3s,4s,5s,6s,7s,8s,9s,Ts,Js,Qs,Ks," +
+      "ja,jb"
+    end
+    let(:key_stream) { KeyStream.new(default_key) }
+
+    it "should never contain more than one 'ja' or 'jb' joker" do
+      ks = key_stream
+      20.times { ks.sequence! }
+      ks.deck.select { |c| c.str =~/j[ab]/ }.count.should == 2
+    end
+
+    it "should correctly generate new letters when continuously sequencing the deck" do
+      ks = key_stream
+      expected_string = "DWJXHYRFDGTMSHPUURXJ"
+      found_string = ""
+      while found_string.length < 20
+        ks.sequence!
+        next if ks.letter.nil?
+        found_string += ks.letter
+      end
+    end
+
+    describe "#new" do
+      it "should create a standard ordered deck by default" do
+        KeyStream.new.deck.should == default_key.split(",").map { |k| Card.new(k) }
+      end
+    end
+
+    describe "#deck" do
+      it "should return a representation of a deck of cards implemented with an Array" do
+        key_stream.deck.should be_an_instance_of(Array)
+      end
+
+      it "should contain nothing but Card instances" do
+        expected_count = key_stream.deck.count
+        key_stream.deck.select { |c| c.instance_of?(Card) }.count.should == expected_count
+      end
+
+      it "should only contain each card once" do
+        expected_count = key_stream.deck.count
+        key_stream.deck.uniq.count.should == expected_count
+      end
+    end
+
+    describe "#sequence!" do
+      let(:expected_deck) do
+        key = "2c,3c,4c,5c,6c,7c,8c,9c,Tc,Jc,Qc,Kc," +
+        "Ad,2d,3d,4d,5d,6d,7d,8d,9d,Td,Jd,Qd,Kd," +
+        "Ah,2h,3h,4h,5h,6h,7h,8h,9h,Th,Jh,Qh,Kh," +
+        "As,2s,3s,4s,5s,6s,7s,8s,9s,Ts,Js,Qs,Ks," +
+        "ja,jb,Ac"
+        key.split(",").map { |str| Card.new(str) }
+      end
+
+      it "should modify the deck" do
+        ks = KeyStream.new
+        ks.sequence!
+        ks.deck.should_not == KeyStream.new.deck 
+      end
+
+      it "should leave the deck modified according to the algorithm" do
+        ks = KeyStream.new
+        ks.sequence!
+        ks.deck.should == expected_deck
+      end
+    end
+
+    describe "#letter" do
+      it "should return a string" do
+        key_stream.letter.should be_an_instance_of(String)
+      end
+
+      it "should only return a single character" do
+        key_stream.letter.length.should == 1
+      end
+
+      it "should return a 'D' after a single sequence of the default deck" do
+        key_stream.sequence!
+        key_stream.letter.should == 'D'
+      end
+
+    end
+  end
+end

data/spec/pontifex/pontifex_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Pontifex do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require "pontifex"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end