yab62 1.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-p180@yab62

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in yab62.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Teng Siong Ong
+
+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.mkdn

@@ -0,0 +1,109 @@
+YAB62 (Yet Another Base 62 Convertor)
+=====================================
+
+The idea of this gem is simple: I want to write a url shortener with base62. Ruby doesn't support it natively.
+I checked out other gems: [radix62][1], [base62][2] and [alphadecimal][3].
+
+They are all written in Ruby. Then, I have this idea to write this gem in C extension. Hence, YAB62 is born.
+
+Btw, most of the tests are borrowed from [alphadecimal][3].
+
+How to use
+==========
+
+Install it with `gem install yab62`.
+
+```ruby
+require 'yab62'
+
+1.encode62 # => "1"
+"1".decode62 # => 1
+
+# Or, you can do this:
+YAB62.encode62(1) # => "1"
+YAB62.decode62("1") # => 1
+```
+
+Benchmark
+=========
+
+Check out the benchmark here:
+
+```ruby
+# gem alphadecimal
+time = Benchmark.measure do
+  1_000_000.times do |i|
+    encode = i.alphadecimal
+    decode = encode.alphadecimal
+    raise "Assertion error!" unless i == decode
+  end
+end
+
+puts time # 17.060000   0.050000  17.110000 ( 17.507562)
+
+# gem base62
+time = Benchmark.measure do
+  1_000_000.times do |i|
+    encode = i.base62_encode
+    decode = encode.base62_decode
+    raise "Assertion error!" unless i == decode
+  end
+end
+
+puts time # 9.600000   0.020000   9.620000 (  9.802189)
+
+# gem radix62
+time = Benchmark.measure do
+  1_000_000.times do |i|
+    encode = i.encode62
+    decode = encode.decode62
+    raise "Assertion error!" unless i == decode
+  end
+end
+
+puts time # 19.070000   0.040000  19.110000 ( 19.483596)
+
+# gem yab62
+time = Benchmark.measure do
+  1_000_000.times do |i|
+    encode = i.encode62
+    decode = encode.decode62
+    raise "Assertion error!" unless i == decode
+  end
+end
+
+puts time # 0.550000   0.000000   0.550000 (  0.605562)
+```
+
+Check out the full script [here][4].
+
+LICENSE
+=======
+
+(The MIT License)
+
+Copyright (c) 2011 Teng Siong Ong
+
+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.
+
+[1]: https://github.com/k33l0r/radix62
+[2]: https://github.com/jtzemp/base62
+[3]: https://github.com/JackDanger/alphadecimal
+[4]: https://gist.github.com/1369278

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << '.'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = true
+end

data/ext/yab62/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile('yab62/yab62')

data/ext/yab62/yab62.c

@@ -0,0 +1,119 @@
+#include <ruby.h>
+
+/*
+ *  base62.c
+ *
+ *  Created by Jason Hullinger on 5/27/10.
+ *
+ *  Modified by Teng Siong Ong on 11/15/2011.
+ */
+#include <ctype.h>
+#include <math.h>
+#include <stdlib.h>
+#include <string.h>
+
+static const char base62_vals[] = "0123456789"
+                                  "abcdefghijklmnopqrstuvwxyz"
+                                  "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+
+static const int base62_index[] = {
+       0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0, 
+       0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0, 
+       0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0, 
+       0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0, 
+    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09,    0,    0, 
+       0,    0,    0,    0,    0, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 
+    0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 
+    0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d,    0,    0,    0,    0,    0, 
+       0, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 
+    0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, 0x20, 
+    0x21, 0x22, 0x23, 
+};
+
+void
+strreverse_inplace (char *str)
+{
+    char c;
+    u_int64_t half;
+    u_int64_t len;
+    u_int64_t i;
+
+    len = strlen(str);
+    half = len >> 1;
+    for (i = 0; i < half; i++) {
+        c = str[i];
+        str[i] = str[len - i - 1];
+        str[len - i - 1] = c;
+    }
+}
+
+int
+base62_encode(u_int64_t val, char *str, size_t len)
+{
+    u_int64_t i = 0;
+    u_int64_t v;
+
+    do {
+        if (i + 1 >= len)
+            return 0;
+        v = val % 62;
+        str[i++] = base62_vals[v];
+        val = (val - v) / 62;
+    } while (val > 0);
+    str[i] = '\0';
+    strreverse_inplace(str);
+
+    return 1;
+}
+
+u_int64_t
+base62_decode (const char *str)
+{
+    u_int64_t val = 0;
+    char c;
+    u_int64_t len;
+    u_int64_t i;
+
+    len = strlen(str);
+    for (i = 0; i < len; i++) {
+        c = str[i];
+        if (!isalnum(c)) {
+            rb_raise(rb_eArgError, "Input is not alphanumeric.");
+        }
+        val += base62_index[c] * pow(62, len - i - 1);
+    }
+
+    return val; 
+}
+
+/* Ruby code starts here */
+
+static VALUE alphadecimal_base62_encode(VALUE self, VALUE arg) {
+  long val = NUM2LONG(arg);
+  if (val < 0)
+    rb_raise(rb_eRangeError, "Number must be greater than or equal to 0");
+
+  char str[12];
+  base62_encode(val, str, 12);
+  return rb_str_new2(str);
+}
+
+static VALUE alphadecimal_base62_decode(VALUE self, VALUE arg) {
+  char* str = StringValuePtr(arg);
+  long val = base62_decode(str);
+  return ULL2NUM(val);
+}
+
+/* ruby calls this to load the extension */
+void Init_yab62(void) {
+  // Create a Ruby module.
+  VALUE base62Module = rb_define_module("YAB62");
+
+  // Add a module method.
+  int arg_count = 1;
+  rb_define_singleton_method(base62Module, "encode62", alphadecimal_base62_encode, arg_count);
+
+  // Add a module method.
+  arg_count = 1;
+  rb_define_singleton_method(base62Module, "decode62", alphadecimal_base62_decode, arg_count);
+}

data/lib/yab62.rb

@@ -0,0 +1,14 @@
+require "yab62/version"
+require "yab62/yab62"
+
+class Integer
+  def encode62
+    YAB62.encode62(self)
+  end
+end
+
+class String
+  def decode62
+    YAB62.decode62(self)
+  end
+end

data/lib/yab62/version.rb

@@ -0,0 +1,3 @@
+module YAB62
+  VERSION = "1.0.1"
+end

data/test/test_yab62.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/yab62"
+
+class TestYAB62 < Test::Unit::TestCase
+
+  include YAB62
+  
+  def test_fixnum_becomes_string
+    assert_kind_of String, 45.encode62
+  end
+  
+  def test_bignum_becomes_string
+    assert_kind_of String, 231087934571049032.encode62
+  end
+  
+  def test_string_becomes_bignum
+    assert_kind_of Bignum, 'aHealk43JZy'.decode62
+  end
+  
+  def test_string_becomes_fixnum
+    assert_kind_of Fixnum, 'j'.decode62
+  end
+  
+
+  def test_edge_62_to_the_0_convertions_should_be_valid
+    (0...62).each do |i|
+      encode = i.encode62
+      decode = encode.decode62
+      assert_equal i, decode, "integer #{i.inspect} was encoded as #{encode.inspect} and was decoded to #{decode.inspect}"
+    end
+  end
+
+  def test_edge_62_to_the_n_convertions_should_be_valid
+    (0...3).each do |p|
+      n = 62 ** p
+      (0...62).each do |i|
+        encode = (i+n).encode62
+        decode = encode.decode62
+        assert_equal i+n, decode, "interger #{i+n} was encoded as #{encode} and was decoded to #{decode}"
+      end
+    end
+  end
+end

data/yab62.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yab62/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Teng Siong Ong"]
+  gem.email         = ["siong1987@gmail.com"]
+  gem.description   = %q{Yet another Base62 convertor}
+  gem.summary       = %q{What do you expect? This is yet another Base62 convertor written in C extension.}
+  gem.homepage      = "https://github.com/siong1987/yab62"
+  gem.extensions    = ['ext/yab62/extconf.rb']
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "yab62"
+  gem.require_paths = ["lib"]
+  gem.version       = YAB62::VERSION
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: yab62
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Teng Siong Ong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-16 00:00:00.000000000Z
+dependencies: []
+description: Yet another Base62 convertor
+email:
+- siong1987@gmail.com
+executables: []
+extensions:
+- ext/yab62/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.mkdn
+- Rakefile
+- ext/yab62/extconf.rb
+- ext/yab62/yab62.c
+- lib/yab62.rb
+- lib/yab62/version.rb
+- test/test_yab62.rb
+- yab62.gemspec
+homepage: https://github.com/siong1987/yab62
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: What do you expect? This is yet another Base62 convertor written in C extension.
+test_files:
+- test/test_yab62.rb