radix62 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in radix62.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    radix62 (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  radix62!
+  rspec (~> 2.0.0.beta20)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matias Korhonen
+
+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,35 @@
+Radix62
+=======
+
+Convert integers to base 62 strings and back.
+
+Base 62 includes the numbers 0-9 and characters A-Z (both lower and upper case). This can be useful for applications such as URL shorteners.
+
+## Installation
+
+Just like any other gem:
+
+    gem install radix62
+
+## Usage
+
+Two methods are provided, Radix62#encode62 and Radix62#decode62
+
+    require "radix62"
+    Radix62.encode62(1000)                          #=> "g8"
+    Radix62.encode62(9999999)                       #=> "FXsj"
+    Radix62.decode62("a")                           #=> "10"
+    Radix62.decode62("A")                           #=> "36"
+    Radix62.decode62("Abc123")                      #=> "33146185555"
+    Radix62.decode62(Radix62.encode62(1234567890))  #=> 1234567890
+
+Radix62 also adds the `decode62` and `encode62` convenience methods to the String and Integer classes, respectively.
+
+    1000.encode62                                   #=> "g8"
+    "Abc123".decode62                               #=> "33146185555"
+
+## License and copyright
+
+Copyright (c) 2010 Matias Korhonen
+
+Licensed under the MIT license, see the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/radix62.rb

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+require "radix62/core_ext/string"
+require "radix62/core_ext/integer"
+
+# Convert integers to base 62 strings and back.
+module Radix62
+  ALPHABET = ('0'..'9').to_a + ('a'..'z').to_a + ('A'..'Z').to_a
+  
+  # Encode an Integer to a base 62 string. The input value *must* be a positive 
+  # integer.
+  # 
+  # If the input number is not an Integer, a TypeError will be raised and if the
+  # input number is negative, a RangeError will be raised.
+  def self.encode62(number)
+    unless number.is_a? Integer
+      raise TypeError.new "number not an integer"
+    end
+    
+    if number < 0
+      raise RangeError.new "number must be greater than or equal to 0"
+    elsif number == 0
+      return "0"
+    end
+
+    base62 = ""
+      
+    while number > 0
+      base62 << ALPHABET[number.modulo(62)]
+      number /= 62
+    end
+    
+    base62.reverse
+  end
+  
+  # Decode a base 62 String to a base 10 Integer. The input value 
+  # <b>must not</b> contain illegal characters.
+  # 
+  # If the input is not alphanumeric, an ArgumentError will be raised.
+  def self.decode62(string)
+    if !!string.match(/^([a-z0-9]+)$/i)
+      integer = 0
+      string.split(//).reverse.each_with_index do |char,index|
+        place = ALPHABET.size ** index
+        integer += ALPHABET.find_index(char) * place
+      end
+      integer
+    else
+      raise ArgumentError.new "Input is not alphanumeric."
+    end
+  end
+end

data/lib/radix62/core_ext/integer.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+class Integer
+  def encode62
+    Radix62.encode62(self)
+  end
+end

data/lib/radix62/core_ext/string.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+class String
+  def decode62
+    Radix62.decode62(self)
+  end
+end

data/lib/radix62/version.rb

@@ -0,0 +1,3 @@
+module Radix62
+  VERSION = "0.1.0"
+end

data/radix62.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/radix62/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "radix62"
+  s.version     = Radix62::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matias Korhonen"]
+  s.email       = ["matias@kiskolabs.com"]
+  s.homepage    = "http://github.com/k33l0r/radix62"
+  s.summary     = "Convert integers to base 62 strings and back."
+  s.description = "Convert base 10 integers to base 62 strings (or base 62 strings to base 10 integers)."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "radix62"
+
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.0.0.beta20"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/radix62_spec.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+require "spec_helper"
+
+describe Radix62 do
+  context "alphabet" do
+    it "has the ALPHABET array" do
+      Radix62::ALPHABET.should be_kind_of Array
+    end
+    
+    it "has 62 items" do
+      Radix62::ALPHABET.should_not be_empty
+      Radix62::ALPHABET.count.should == 62
+    end
+    
+    it "has the right contents" do
+      Radix62::ALPHABET.should == ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z"]
+    end
+  end
+  
+  context "encode62" do
+    it "raises an exception with negative numbers" do
+      (-1000..-1).step(100).each do |n|
+        lambda { Radix62.encode62(n) }.should raise_error(RangeError)
+      end
+      (-99999..-9999).step(1000).each do |n|
+        lambda { Radix62.encode62(n) }.should raise_error(RangeError)
+      end
+      (-9999999..-999999).step(10000).each do |n|
+        lambda { Radix62.encode62(n) }.should raise_error(RangeError)
+      end
+      (-333333333..-222222222).step(1000000).each do |n|
+        lambda { Radix62.encode62(n) }.should raise_error(RangeError)
+      end
+    end
+    
+    it "fails if the input number is not an Integer" do
+      lambda { Radix62.encode62("123") }.should raise_error(TypeError)
+      lambda { Radix62.encode62(true) }.should raise_error(TypeError)
+      lambda { Radix62.encode62(:symbol) }.should raise_error(TypeError)
+      lambda { Radix62.encode62([1]) }.should raise_error(TypeError)
+      lambda { Radix62.encode62(0.1) }.should raise_error(TypeError)
+    end
+    
+    it "has output which matches known good examples" do
+      KnownGood::ENCODE62.each do |key, value|
+        Radix62.encode62(key).should == value
+      end
+    end
+  end
+  
+  context "decode62" do
+    it "raises an exception with invalid characters" do
+      lambda { Radix62.decode62("/") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("123.0") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("-100") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("Ä") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("ö") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62(" ") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("123 000") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("123,9") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("123\t123") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("1&1") }.should raise_error(ArgumentError)
+      lambda { Radix62.decode62("1%") }.should raise_error(ArgumentError)
+    end
+    
+    it "has output which matches known good examples" do
+      KnownGood::DECODE62.each do |key, value|
+        Radix62.decode62(key).should == value
+      end
+    end
+  end
+  
+  context "core_ext" do
+    it "extends the Integer class with #encode62" do
+      9999.encode62.should be_kind_of String
+      9999.encode62.should == "2Bh"
+    end
+    
+    it "extends the String class with #decode62" do
+      "aBC".decode62.should be_kind_of Integer
+      "aBc".decode62.should == 40746
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "support/known_good"
+require "radix62"
+
+RSpec.configure do |config|
+end

data/spec/support/known_good.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+module KnownGood
+  ENCODE62 = Marshal.load(File.open("./spec/support/encode62_examples", "r"))
+  DECODE62 = Marshal.load(File.open("./spec/support/decode62_examples", "r"))
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: radix62
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matias Korhonen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-04 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta20
+        version: 2.0.0.beta20
+  type: :development
+  version_requirements: *id002
+description: Convert base 10 integers to base 62 strings (or base 62 strings to base 10 integers).
+email: 
+- matias@kiskolabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/radix62.rb
+- lib/radix62/core_ext/integer.rb
+- lib/radix62/core_ext/string.rb
+- lib/radix62/version.rb
+- radix62.gemspec
+- spec/radix62_spec.rb
+- spec/spec_helper.rb
+- spec/support/decode62_examples
+- spec/support/encode62_examples
+- spec/support/known_good.rb
+has_rdoc: true
+homepage: http://github.com/k33l0r/radix62
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: radix62
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Convert integers to base 62 strings and back.
+test_files: []
+