crypt-rot13 1.0.1

data/CHANGES

@@ -0,0 +1,7 @@
+== 1.0.1 - 6-Jun-2005
+* Moved project to RubyForge.
+* Minor test and doc changes.
+* Added a .gemspec file.  Gem available online.
+
+== 1.0.0 - 18-May-2004
+* Initial release

data/MANIFEST

@@ -0,0 +1,9 @@
+CHANGES
+MANIFEST
+README
+install.rb
+crypt-rot13.gemspec
+
+lib/crypt/rot13.rb
+
+test/tc_rot13.rb

data/README

@@ -0,0 +1,48 @@
+== Description
+   A package for performing simple character rotation (i.e. Caesar Cipher)
+   encryption.  There are many like it, but this one is mine.
+
+== Installation
+
+=== Manual Installation
+   ruby test/tc_rot13.rb (optional)
+   ruby install.rb
+   
+=== Gem Installation
+   ruby crypt-rot13.gem
+   gem install crypt-rot13-<version>.gem
+   
+== Synopsis
+   require "crypt/rot13"
+   include Crypt
+
+   str = Rot13.new("Hello World", 3) # Caesar cipher
+   puts str # "Khoor Zruog"
+
+== Notes
+   * Not unicode friendly.  Only works on ASCII values 65-90 and 97-122.
+
+== Acknowledgements
+   Thanks go to Gaius Julius Caesar (d. 44 BC) for creating one of the first,
+   and most simple, encryption schemes.  Hail Caesar!
+
+== Known Bugs
+   None that I'm aware of.
+
+   Please log any bugs you find on the SourceForge project page at
+   http://www.rubyforge.org/projects/shards.
+
+== License
+   Ruby's
+
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (irc.freenode.net)
+
+

data/lib/crypt/rot13.rb

@@ -0,0 +1,44 @@
+module Crypt
+   class Rot13Error < ArgumentError; end
+   class Rot13 < String
+      VERSION = "1.0.1"
+      
+      # Returns a new Rot13 object. The object is a string with the letters
+      # each rotated by +degree+.
+      #
+      # You cannot use a multiple of 26 as the degree or a Rot13Error will
+      # be raised. So, your days of double rot13 encryption are over.
+      def initialize(str="", degree=13)
+         unless str.empty?
+            str = rotate_string(str, degree)
+         end
+         super(str)
+      end
+
+      # Rotates the object by +degree+.
+      def rotate(degree)
+         rotate_string(self,degree)
+      end
+
+      private
+      def rotate_string(str,degree)
+         case degree.modulo(26)
+            when 0
+               raise Rot13Error, "degree must not be a multiple of 26"
+            when 13
+               str.tr!("a-zA-Z","n-za-mN-ZA-M")
+            else
+               str = str.unpack("C"*str.length).map!{ |e|
+                  if e >= 97 && e <= 122
+                     e = ((e - 97 + degree) % 26) + 97
+                  elsif e >= 65 && e <= 90
+                     e = ((e - 65 + degree) % 26) + 65
+                  else
+                     e = e
+                  end
+               }.pack("C"*str.length)
+         end
+         return str
+      end
+   end
+end

data/test/tc_rot13.rb

@@ -0,0 +1,84 @@
+##########################################################
+# tc_rot13.rb
+#
+# Test suite for the crypt-rot13 package.
+##########################################################
+base = File.basename(Dir.pwd)
+if base == "test" || base =~ /crypt-rot13/
+   Dir.chdir("..") if base == "test"
+   $LOAD_PATH.unshift(Dir.pwd + "/lib")
+end
+
+require "crypt/rot13"
+require "test/unit"
+include Crypt
+
+class TC_Rot13 < Test::Unit::TestCase
+   def setup
+      @r1 = Rot13.new('abc')
+      @r2 = Rot13.new('ABC')
+      @r3 = Rot13.new('xyz')
+      @r4 = Rot13.new('XYZ')
+      @r5 = Rot13.new('a1b2c3@#$')
+      @r6 = Rot13.new('abc',3)
+      @r7 = Rot13.new('ABC',3)
+      @r8 = Rot13.new('xyz',23)
+      @r9 = Rot13.new('XYZ',23)
+   end
+
+   def test_version
+      assert_equal("1.0.1", Rot13::VERSION)
+   end
+
+   def test_constructor
+      assert_respond_to(Rot13,:new)
+      assert_nothing_raised{ Rot13.new }
+      assert_nothing_raised{ Rot13.new("foo") }
+      assert_nothing_raised{ Rot13.new("foo",7) }
+   end
+
+   def test_available_methods
+      assert_respond_to(@r1, :rotate)
+   end
+
+   def test_degree
+      assert_raises(Rot13Error){ Rot13.new("foo",26) }
+      assert_raises(Rot13Error){ Rot13.new("foo",52) }
+      assert_nothing_raised{ Rot13.new("foo",25) }
+   end
+
+   def test_string_class
+      assert_kind_of(String,@r1)
+   end
+
+   def test_return_value_default_degree
+      assert_equal('nop', @r1)
+      assert_equal('NOP', @r2)
+      assert_equal('klm', @r3)
+      assert_equal('KLM', @r4)
+      assert_equal('n1o2p3@#$', @r5)
+   end
+
+   def test_return_value_custom_degree
+      assert_equal('def', @r6)
+      assert_equal('DEF', @r7)
+      assert_equal('uvw', @r8)
+      assert_equal('UVW', @r9)
+   end
+
+   def test_rotate_instance_method
+      assert_equal('abc', @r6.rotate(-3))
+   end
+
+   def teardown
+      @r1 = nil
+      @r2 = nil
+      @r3 = nil
+      @r4 = nil
+      @r5 = nil
+      @r6 = nil
+      @r7 = nil
+      @r8 = nil
+      @r9 = nil
+   end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: crypt-rot13
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+date: 2005-06-06
+summary: "Character rotation encryption, i.e. Caesar Cipher"
+require_paths: 
+  - lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/shards
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Daniel J. Berger
+files: 
+  - lib/crypt/rot13.rb
+  - README
+  - CHANGES
+  - MANIFEST
+  - test/tc_rot13.rb
+test_files: 
+  - test/tc_rot13.rb
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+  - CHANGES
+executables: []
+extensions: []
+requirements: []
+dependencies: []