alnum 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 540fcbabc9ec1452ffe147f018924f7594511c84
-  data.tar.gz: ffc28febfd232baa286f2a70027751755c5a9163
+  metadata.gz: c1ea393ce1bb8a32bb43a3065ca50d691cb05024
+  data.tar.gz: 02915a7d82a094c5ffb0b8e40d4209c5ad905754
 SHA512:
-  metadata.gz: 543ec3b8eeea6fca40eb8ad85844635295db713b02f16efbaed9ad51b9407ed99d64184c515fb5ec42c2eb6242d4674b0aa7d4d5240ccda0e63517ae4da9cea7
-  data.tar.gz: 2c201eb26e79a302d369ff96731c7b18c244b1d36a7d939dc99640fdb744fd90aea2d3e8b25a4fab013d8d39d1a3ff5b228118590394ed234851484f13a921a1
+  metadata.gz: e29306672a9acacdfbe878ceeefbc9e6c4af8d13c9ce3be9579841954cb60fe55b06ef5ba8d6ea5300b7fbfe03b17f3e30de1d3b1cf88a5f16dfd8133d69a335
+  data.tar.gz: bbb2b9cb9c3f30aa3892a2f08af7e15f52f22f338dc12fea842810dcce74de3265fe6e9e997ab1ca5811af8b58dfffb0358ae04d086a00458ed5bcf7b163b78c

data/README.md

@@ -1,6 +1,6 @@
 # alnum
 
-Alnum is a generator of alphanumeric code from integers and vice-versa.
+Alnum is a generator of alphanumeric code from integers and vice-versa. Inspired in the POSIX character class [:alnum:] it uses just alphanumeric characters accordingly to the pattern [a-zA-Z0-9].
 
 ## Installation
 
@@ -12,28 +12,16 @@ Alnum is a generator of alphanumeric code from integers and vice-versa.
 
 Quick examples to hit the road:
 
-### Instantiate your cypher
-
-```ruby
-cypher = Alnum::Cypher.new
-```
-
 ### Get your alphanumeric code
 
 ```ruby
-cypher.write(32456) => "8ru"
-```
-
-### Instantiate your decipher
-
-```ruby
-decipher = Alnum::Decipher.new
+Alnum::cypher(32456) => "8ru"
 ```
 
 ### Get your integer back
 
 ```ruby
- decipher.read("8ru") => 32456
+Alnum::decipher("8ru") => 32456
 ```
 
 ## Purpose

data/alnum.gemspec

@@ -1,6 +1,8 @@
+require_relative 'lib/alnum/version'
+
 Gem::Specification.new do |s|
   s.name        = 'alnum'
-  s.version     = '0.0.1'
+  s.version     = Alnum::VERSION
   s.date        = '2015-05-26'
   s.summary     = "Alphanumeric code generator."
   s.description = "Alnum is a generator of alphanumeric code from integers and vice-versa. Can be useful shortening ID numbers in order to create tiny or short URLs."

data/lib/alnum.rb

@@ -1,14 +1,34 @@
-require_relative 'alnum/cypher'
-require_relative 'alnum/decipher'
+require_relative 'alnum/symbols'
 
 module Alnum
 
-  SYMBOLS = %w{
-    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
-  }
-
   BASE = SYMBOLS.length
 
+  def self.cypher(number)
+    raise TypeError, "Only integers allowed" unless number.is_a? Integer   
+
+    numbers = []
+
+    until number < BASE do
+      remainder = number % BASE
+      numbers << SYMBOLS[remainder]
+      number = (number - remainder) / BASE
+    end
+
+    numbers << SYMBOLS[number]
+    numbers.reverse.join
+  end
+
+  def self.decipher(alphanumeric)
+    number, count = 0, 0
+
+    alphanumeric.to_s.reverse.each_char() do |c|
+      raise RangeError, "Code contains characters out of range: '#{c}'" if SYMBOLS.index(c).nil?
+      number += SYMBOLS.index(c) * BASE**count
+      count += 1
+    end
+
+    number    
+  end
+
 end

data/lib/alnum/symbols.rb

@@ -0,0 +1,9 @@
+module Alnum
+
+  SYMBOLS = %w{
+      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

data/lib/alnum/version.rb

@@ -0,0 +1,3 @@
+module Alnum
+  VERSION = '0.1.0'
+end

data/test/test_cypher.rb

@@ -1,28 +1,23 @@
 require 'test/unit'
-require_relative '../lib/alnum/cypher'
 require_relative './support/test_data'
 
 class TestCypher < Test::Unit::TestCase
 
-  def setup
-    @cypher = Alnum::Cypher.new
-  end
-
   def test_one_character_range
     62.times do |number|
-      assert_equal @cypher.write(number), "#{SYMBOLS[number]}"
+      assert_equal Alnum::cypher(number), "#{SYMBOLS[number]}"
     end
   end
 
   def test_only_integers_allowed
     assert_raise TypeError do
-      @cypher.write('a')
+      Alnum::cypher('a')
     end   
   end
 
   def test_empty_arguments
     assert_raise ArgumentError do
-      @cypher.write()
+      Alnum::cypher()
     end
   end
 

data/test/test_decipher.rb

@@ -1,29 +1,24 @@
 require 'test/unit'
-require_relative '../lib/alnum/decipher'
 require_relative './support/test_data'
 
 class TestDecipher < Test::Unit::TestCase
 
-	def setup
-		@decipher = Alnum::Decipher.new		
-	end
+  def test_one_character_range
+    62.times do |number|
+      assert_equal Alnum::decipher(SYMBOLS[number]), number
+    end
+  end
 
-	def test_one_character_range
-		62.times do |number|
-			assert_equal @decipher.read(SYMBOLS[number]), number
-		end
-	end
+  def test_character_out_of_range
+    assert_raise RangeError do
+      Alnum::decipher('-')
+    end
+  end
 
-	def test_character_out_of_range
-		assert_raise RangeError do
-			@decipher.read('-')
-		end
-	end
-
-	def test_empty_arguments
-		assert_raise ArgumentError do
-			@decipher.read()
-		end
-	end
+  def test_empty_arguments
+    assert_raise ArgumentError do
+      Alnum::decipher()
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alnum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Hanes Barbosa
@@ -21,8 +21,8 @@ files:
 - README.md
 - alnum.gemspec
 - lib/alnum.rb
-- lib/alnum/cypher.rb
-- lib/alnum/decipher.rb
+- lib/alnum/symbols.rb
+- lib/alnum/version.rb
 - test/support/test_data.rb
 - test/test_alnum.rb
 - test/test_cypher.rb

data/lib/alnum/cypher.rb

@@ -1,26 +0,0 @@
-require_relative '../alnum'
-
-module Alnum
-
-  class Cypher
-
-    def write(number)
-      raise TypeError, "Only integers allowed" unless number.is_a? Integer   
-
-      numbers = []
-      quotient = 0
-
-      until number < BASE do
-        rest = number % BASE
-        quotient = (number - rest) / BASE
-        numbers << SYMBOLS[rest]
-        number = quotient
-      end
-
-      numbers << SYMBOLS[number]
-      numbers.reverse.join
-    end
-
-  end
-
-end

data/lib/alnum/decipher.rb

@@ -1,22 +0,0 @@
-require_relative '../alnum'
-
-module Alnum
-
-  class Decipher
-
-    def read(alphanumeric)
-      number = 0
-      count = 0
-
-      alphanumeric.to_s.reverse.each_char() do |c|
-        raise RangeError, "Code contains characters out of range: '#{c}'" if SYMBOLS.index(c).nil?
-        number += SYMBOLS.index(c) * BASE**count
-        count += 1
-      end
-
-      number
-    end
-    
-  end
-
-end