friendly_digest 1.0 → 1.1

data/CHANGELOG

@@ -1 +1,2 @@
+v1.1. Flag which adds a one character checksum for sanity checking
 v1.0. Initial commit. Only supports integers.

data/Manifest

@@ -4,3 +4,4 @@ Manifest
 README
 Rakefile
 lib/friendly_digest.rb
+test/test_all.rb

data/README

@@ -16,3 +16,28 @@ gem install 'friendly_digest'
    => 12345
 
 
+
+New! Parity flag
+----------------
+
+Adds a 1 character checksum to detect input mistakes.
+
+ irb> FriendlyDigest.new(12345, true)
+   => "4ADM"
+
+ irb> FriendlyDigest.decode('4adm', true)
+   => 12345
+
+ irb> FriendlyDigest.decode('4abm', true)
+ FriendlyDigest::InvalidInputException: Invalid input
+
+
+
+
+Contact the author
+------------------
+
+Andrew Snow <andrew@modulus.org>
+Andys^ on irc.freenode.net
+@andy_snow on the twitter
+

data/friendly_digest.gemspec

@@ -2,21 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{friendly_digest}
-  s.version = "1.0"
+  s.version = "1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Snow"]
-  s.date = %q{2010-12-11}
+  s.date = %q{2011-02-23}
   s.description = %q{Ruby gem to send to convert integer IDs into easy to type strings}
   s.email = %q{andrew@modulus.org}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/friendly_digest.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "lib/friendly_digest.rb", "friendly_digest.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "lib/friendly_digest.rb", "test/test_all.rb", "friendly_digest.gemspec"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Friendly_digest", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{friendly_digest}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby gem to send to convert integer IDs into easy to type strings}
+  s.test_files = ["test/test_all.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/friendly_digest.rb

@@ -1,5 +1,6 @@
 
 class FriendlyDigest < String
+  class InvalidInputException < Exception ; end
   class << self
     def [](*p) ; new(*p) ; end
     
@@ -7,18 +8,33 @@ class FriendlyDigest < String
       @codes ||= ['Z','2','B','T','C','9','H','Q','V','K','N','W','7','P','4','J','Y','G','E','A','D','3','F','8','M','X','6','U','R']
     end
     
-    def decode(input)
-      input.strip.upcase.split('').inject(0) {|tot,c| (tot * codes.length) + codes.index(c) }
+    def numcodes
+      @numcodes ||= codes.length
+    end
+    
+    def decode(input, parity=false)
+      cleaned = input.strip.upcase.split('')
+      raise InvalidInputException.new "Invalid character" if cleaned.any?(&:nil?)
+      raise InvalidInputException.new "Invalid input" if parity && cleaned.pop!= checksum(cleaned)
+      
+      cleaned.map {|c| codes.index(c) }.inject(0) {|tot,c| (tot * numcodes) + c }
+    end
+    
+    def checksum(array)
+      codes[array.inject(0) {|sum,c| (sum + codes.index(c)) % numcodes }]
     end
   end
 
-  def initialize(input)
+  def initialize(input, parity=false)
     output = input == 0 ? [self.class.codes.first] : []
     while input > 0
       rem = input % self.class.codes.length
-      input = (input - rem) / self.class.codes.length #/
+      input = (input - rem) / self.class.numcodes #/
       output << self.class.codes[rem]
     end
     output.reverse.each {|c| self << c }
+    self << self.class.checksum(output) if parity
   end
+  
+  
 end

data/test/test_all.rb

@@ -0,0 +1,20 @@
+
+require 'friendly_digest'
+require 'test/unit'
+
+class TestFriendlyDigest < Test::Unit::TestCase
+  def test_no_parity
+    (0..10000).each do |n|
+      assert_equal n, FriendlyDigest.decode(FriendlyDigest.new(n))
+    end
+  end
+
+  def test_with_parity
+    (0..10000).each do |n|
+      assert_equal n, FriendlyDigest.decode(FriendlyDigest.new(n, true), true)
+      assert_raise(FriendlyDigest::InvalidInputException) { FriendlyDigest.decode('X' + FriendlyDigest.new(n, true), true) }
+    end
+  end
+    
+end
+

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 0
-  version: "1.0"
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Andrew Snow
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 +11:00
+date: 2011-02-23 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - README
 - Rakefile
 - lib/friendly_digest.rb
+- test/test_all.rb
 - friendly_digest.gemspec
 has_rdoc: true
 homepage: ""
@@ -74,5 +75,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby gem to send to convert integer IDs into easy to type strings
-test_files: []
-
+test_files: 
+- test/test_all.rb