Base62 0.0.1 → 0.0.2

data/lib/Base62.rb

@@ -1,8 +1,14 @@
 class Base62
-
-  @@base = 62
-  @@dictionary = nil
-    
+  ##
+  # Converts a base 10 number to base 62
+  #
+  # ==== Attributes
+  #
+  # * +n_base10+ - Base 10 number to convert
+  #  
+  # ==== Examples  
+  #  
+  #   Base62.to_base62(123456789)
   def self.to_base62(n_base10)
     init_dictionary if @@dictionary.nil?
     result = ''
@@ -14,6 +20,16 @@ class Base62
     @@dictionary[n_base10] + result    
   end
   
+  ##
+  # Converts a base 62 number to base 10
+  #
+  # ==== Attributes
+  #
+  # * +n_base62+ - Base 62 number to convert
+  #
+  # ==== Examples  
+  #
+  #   Base62.to_base10('AbCeF12345')
   def self.to_base10(n_base62)
     init_dictionary if @@dictionary.nil?
     result = 0
@@ -26,6 +42,11 @@ class Base62
     result
   end
   
+  private
+  
+  @@base = 62
+  @@dictionary = nil
+  
   def self.init_dictionary
     @@dictionary = [('0'..'9'), 
                     ('a'..'z'), 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Base62
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,14 +11,14 @@ bindir: bin
 cert_chain: []
 date: 2013-01-19 00:00:00.000000000 Z
 dependencies: []
-description: A simple base62 converter
+description: A simple base 10 <-> base 62 converter
 email: jorge.arrese@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/Base62.rb
-homepage: ''
+homepage: https://github.com/j0rg/Base62
 licenses: []
 post_install_message: 
 rdoc_options: []