human_codes 1.1.0

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+alphadecimal.gemspec
+bin/alphadecimal
+init.rb
+lib/alphadecimal.rb
+rails/init.rb
+test/test_alphadecimal.rb

data/README.txt

@@ -0,0 +1,68 @@
+= Human Codes
+
+* http://github.com/JackDanger/human_codes
+
+== DESCRIPTION:
+
+Convert integers to short, human-scannable alphanumeric strings (skipping 'l', '1', 'o', '0', etc.) and back.
+
+Unlike the code behind url shorteners, this supports case-insensitive conversion and
+omits letters and numbers that are difficult to distinguish by sight (like 'l' and '1')
+
+== SYNOPSIS:
+
+  # 45.human_code
+  # => '2E'
+  # 5234233.human_code
+  # '5ZRJT'
+  # 'AYH783XM3AJZ99'.human_code
+  # => 367212504123260337416
+  # 367212504123260337416.human_code
+  # => 'AYH783XM3AJZ99'
+  #
+  ## strings that weren't generated by this library don't get converted
+  #
+  # "ajYz2".human_code
+  # => "ajyz2"
+  #
+  ## But your users shouldn't have to use the shift key
+  #
+  # "AJYZ2".human_code
+  # => 10025953
+  # "ajYz2".human_code :fix_case => true
+  # => 10025953
+
+
+== INSTALL:
+
+* sudo gem install human_codes
+
+== WHERE CREDIT IS DUE
+
+This project was inspired by my and Mike Mondragon's alphadecimal, Shane Becker's
+NewBase60, and busy retail workers everywhere who need to enter coupon codes.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Jack Danger Canty
+
+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/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "human_codes"
+    gem.summary = %Q{Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly.}
+    gem.description = %Q{Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly. Uses base-32 compression of integers.}
+    gem.email = "rubygems@6brand.com"
+    gem.homepage = "http://github.com/JackDanger/human_codes"
+    gem.authors = ["Jack Danger Canty"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << '.'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/human_codes.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{human_codes}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jack Danger Canty"]
+  s.date = %q{2010-07-12}
+  s.description = %q{Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly. Uses base-32 compression of integers.}
+  s.email = %q{rubygems@6brand.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    "Manifest.txt",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "human_codes.gemspec",
+     "init.rb",
+     "lib/human_codes.rb",
+     "rails/init.rb",
+     "test/test_human_codes.rb"
+  ]
+  s.homepage = %q{http://github.com/JackDanger/human_codes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly.}
+  s.test_files = [
+    "test/test_human_codes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'alphadecimal'

data/lib/human_codes.rb

@@ -0,0 +1,63 @@
+module HumanCodes
+  SAFE_NUMBERS = '2','3','4','5','6','7','8','9'
+  SAFE_LETTERS = 'A','B','C','D','E','F','G','H','J','K','M','N','P','Q','R','S','T','U','V','W','X','Y','Z'
+  SAFE_BASE    = SAFE_NUMBERS.size + SAFE_LETTERS.size
+  SAFE_CHARACTERS_AS_ASCII =
+      [SAFE_NUMBERS + SAFE_LETTERS].flatten.inject({}) do |hash, char|
+        hash[char[0]] = hash.size
+        hash
+      end
+  SAFE_CHARACTERS_AS_STRINGS = [
+          SAFE_NUMBERS.map {|char| char },
+          SAFE_LETTERS.map {|char| char }
+        ].flatten
+
+  module Number
+    def human_code
+      return self if nil? || self <= 0
+      string = ""
+      value = self
+      until value == 0
+        mod = value % SAFE_BASE
+        string << SAFE_CHARACTERS_AS_STRINGS[mod]
+        value = value / SAFE_BASE
+      end
+      string.reverse
+    end
+  end
+  
+  module String
+    def human_code(options = {})
+      return upcase.human_code if options[:fix_case]
+      return self unless is_human_code?
+      val = 0
+      key = reverse
+      (0...key.size).each do |i|
+        char = key[i]
+        integer = SAFE_CHARACTERS_AS_ASCII[char]
+        val = val + (integer * (SAFE_BASE ** i))
+      end
+      val
+    end
+    
+    def is_human_code?
+      return false if nil?
+      string = self.dup
+      return false if string.length <= 0
+      (0...string.size).each do |i|
+        return false unless SAFE_CHARACTERS_AS_ASCII[string[i]]
+      end
+      true
+    end
+  end
+end
+
+class String
+  include HumanCodes::String
+end
+class Fixnum
+  include HumanCodes::Number
+end
+class Bignum
+  include HumanCodes::Number
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'alphadecimal'

data/test/test_human_codes.rb

@@ -0,0 +1,77 @@
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/human_codes"
+
+class TestHumanCodes < Test::Unit::TestCase
+
+  include HumanCodes
+  
+  def test_fixnum_becomes_string
+    assert_kind_of String, 45.human_code
+  end
+  
+  def test_bignum_becomes_string
+    assert_kind_of String, 231087934571049032.human_code
+  end
+  
+  def test_string_becomes_bignum
+    assert_kind_of Bignum, 'AHEATZZTAJBC43JZY'.human_code
+  end
+  
+  def test_string_allows_optional_auto_upcasing
+    assert_kind_of Fixnum, 'abh56ak'.human_code(:fix_case => true)
+  end
+  
+  def test_string_does_not_automatically_upcase
+    assert_kind_of String, 'abh56ak'.human_code
+  end
+  
+  def test_string_becomes_fixnum
+    assert_kind_of Fixnum, 'J'.human_code
+  end
+  
+  def test_invalid_string_returns_self
+    string = 'Whoah there!'
+    assert_equal string, string.human_code
+  end
+  
+  def test_identities
+    [123, 90000008, 733, '12331', 'abYzj', '0', 'A', 'z',
+     79823898923232, 'ZZZZZZZZZZZZZZZZZZZ', 'Yz82J3Ng5Nj9M1',
+     '!!!', '@$%!^', 'abc ', 'HP', 4, 'ǟ'].each do |object|
+      assert_equal object, object.human_code.human_code
+    end
+  end
+
+  def test_only_human_scannable_characters_should_validate
+    alphabet = ['2','3','4','5','6','7','8','9',
+                'A','B','C','D','E','F','G','H','J','K','M',
+                'N','P','Q','R','S','T','U','V','W','X','Y','Z'].map {|char| char[0] }
+    (0..255).each do |i|
+      case
+        when alphabet.include?(i)
+           assert i.chr.is_human_code?, "char #{i} is not valid as string #{i.chr}"
+        else
+           assert !i.chr.is_human_code?, "char #{i} is valid as string #{i.chr}"
+      end
+    end 
+  end
+
+  def test_edge_62_to_the_0_convertions_should_be_valid
+    (0...62).each do |i|
+      encode = i.human_code
+      decode = encode.human_code
+      assert_equal i, decode, "integer #{i} was encoded as #{encode} and was decoded to #{decode}"
+    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).human_code
+        decode = encode.human_code
+        assert_equal i+n, decode, "interger #{i+n} was encoded as #{encode} and was decoded to #{decode}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: human_codes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly. Uses base-32 compression of integers.
+email: rubygems@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- Manifest.txt
+- README.txt
+- Rakefile
+- VERSION
+- human_codes.gemspec
+- init.rb
+- lib/human_codes.rb
+- rails/init.rb
+- test/test_human_codes.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/human_codes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Convert integers to human-readable compressed alphanumeric strings and back. Lets humans enter very long integers quickly.
+test_files: 
+- test/test_human_codes.rb