base31_guid 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 foomip
+
+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.rdoc

@@ -0,0 +1,37 @@
+= base31_guid
+
+This is a small class library, used to display base 10 integers as an easy to read base31 number. This was library was 
+created as part of a bigger project, where a human-readable guid was required.
+
+Requirements for the GUID:
+1. The GUID should be easy for a human to read and memorise, if required (ie. no too long and alpha-numeric).
+2. The GUID should not randomly generate string that would be considered profanity (hence the exclusion of all
+   vowel characters from the GUID alpha-numeric range).
+
+Sample usage:
+
+#Convert base10 integer to base31 guid string:
+base10 = 12345
+obj = Base31Guid.new(base_length=5)
+base31 = obj.dec_to_base31($base10num) # base31 = "00DV7"
+
+#Convert base31 guid string to base10 integer
+base31 = "00DV7"
+obj = Base31Guid.new(base_length=5)
+base10 = obj.base31str_to_dec($base31num) # base10 = 12345
+
+== Contributing to base31_guid
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 foomip. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "base31_guid"
+  gem.homepage = "http://github.com/foomip/base31_guid"
+  gem.license = "MIT"
+  gem.summary = %Q{base10 to base31 guid conversion library}
+  gem.description = %Q{used (primarily) for converting auto-incrementing integer values to a base31 hyman-readable form}
+  gem.email = "nelsondcp@gmail.com"
+  gem.authors = ["foomip"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "base31_guid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/base31_guid.rb

@@ -0,0 +1,71 @@
+# This module is used to convert a base10 integer into an equivalent base31 guid string (and vice-versa).
+# The base31 number is represented as a alpha-numeric characters (excluding the vowel charatcers A, E, I, O, U); 
+# this is done to avoid confusion between numbers and letters (eg. 1 and I, 0 and O) and also to avoid
+# nasty words from being generated from their equivalent decimal values.
+
+class Base31Guid
+  # base31/base10 equivalent string definitions
+  Dec_vals = {
+    "0" => "0","1" => "1","2" => "2","3" => "3","4" => "4","5" => "5",
+    "6" => "6","7" => "7","8" => "8","9" => "9","10" => "B","11" => "C",
+    "12" => "D","13" => "F","14" => "G","15" => "H","16" => "J",
+    "17" => "K","18" => "L","19" => "M","20" => "N","21" => "P",
+    "22" => "Q","23" => "R","24" => "S","25" => "T","26" => "V",
+    "27" => "W","28" => "X","29" => "Y","30" => "Z","B" => "10",
+    "C" => "11","D" => "12","F" => "13","G" => "14","H" => "15",
+    "J" => "16","K" => "17","L" => "18","M" => "19","N" => "20",
+    "P" => "21","Q" => "22","R" => "23","S" => "24","T" => "25",
+    "V" => "26","W" => "27","X" => "28","Y" => "29","Z" => "30"
+  }
+  
+  def initialize(base_length=6)
+    @base_length = base_length
+  end
+  
+  def base31str_to_dec(str)
+    if not str.is_a?(String)
+      raise StandardError, "Received value is not a valid string"
+    end
+    
+    len = pos = str.length
+    total = 0
+    
+    while pos > 0 do
+      val = str[(len - pos), 1]
+      intval = Dec_vals[val].to_i
+      
+      tmp = pos
+      while (tmp - 1) > 0 do
+        intval = intval * 31
+        tmp -= 1
+      end
+      
+      total += intval
+      pos -= 1
+    end
+    
+    return total
+  end
+  
+  def dec_to_base31(num)
+    if not num.is_a?(Integer)
+      raise StandardError, "Received value is not a valid integer"
+    end
+    
+    base31 = ""
+    
+    while num > 0 do
+      rem = num % 31
+      num = num / 31
+      val = Dec_vals[rem.to_s]
+      
+      base31 = val + base31
+    end
+    
+    while base31.length < @base_length do
+      base31 = "0" + base31
+    end
+    
+    return base31
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'base31_guid'
+
+class Test::Unit::TestCase
+end

data/test/test_base31_guid.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestBase31Guid < Test::Unit::TestCase
+  $base10num = 12345
+  
+  should "testing conversion from base10 to base31" do
+    obj = Base31Guid.new(base_length=5)
+    $base31num = obj.dec_to_base31($base10num)
+  end
+  
+  should "testing conversion from base31 to base10 - and that numbers are correctly converted" do
+    obj = Base31Guid.new(base_length=5)
+    newbase10num = obj.base31str_to_dec($base31num)
+    
+    if not newbase10num == $base10num
+      flunk "Conversions did not return valid numbers between conversions - logic error in base31_guid"
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: base31_guid
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- foomip
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: used (primarily) for converting auto-incrementing integer values to a base31 hyman-readable form
+email: nelsondcp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/base31_guid.rb
+- test/helper.rb
+- test/test_base31_guid.rb
+has_rdoc: true
+homepage: http://github.com/foomip/base31_guid
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: base10 to base31 guid conversion library
+test_files: 
+- test/helper.rb
+- test/test_base31_guid.rb