user_friendly_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cf76745e7b09f8d74ec33802bdb3e4ce3cd854b
+  data.tar.gz: 215888ec2be67489940feb426807a2bc9ee8eeb8
+SHA512:
+  metadata.gz: 89976bd39fce604428b45c02269f4c8ccfd7f996224a27c3d9d5445c0d628af70678cdd2691bcb694d2e7eed031322a1bc563936866524b60ba11b1c120f11e1
+  data.tar.gz: 650d7d09da855c6c8d78dcdaa7bcb85b46d53ef57f0e48d704578e27acaa78559e05708e0dc486ff87a6841cd8067ce8ac892ffbe9bbd26827c67d59bfd24c75

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Alex Agranov
+
+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.md

@@ -0,0 +1,54 @@
+user_friendly_id
+======
+Add methods to Integer and String to convert between base10 and base34 representations of a number.  
+
+Base34 rocks!!!
+- shorter than decimal
+- shorter than hexadecimal 
+- case insensitive when compared with base64
+- avoids user input confusion associated with 1/I and 0/O
+
+Base34 is represented with the following characters: [0-9] and [A-Z, minus I & O to avoid any readability issues]
+
+Applications of user_friendly_id could include, but are not limited to:
+- gift/promotion/discount/redemption code generation
+- much shorter string representation of long decimal strings, such as a UUID or MongoDB object id
+
+Example Usage:
+==============
+
+```ruby
+>> 33.to_base34
+=> "Z"
+
+>> 34.to_base34
+=> "10"
+
+>> "10".to_base10
+=> 34
+
+>> 1155.to_base34
+=> "ZZ"
+
+>> "ZZ".from_base34
+=> 1155
+
+>> "0000000000ZZ".from_base34
+=> 1155
+
+>> "   00ZZ  ".from_base34
+=> 1155
+
+# you can represent 10^24 - one septillion - with just 16 base34 digits, aka, a string of length 16
+>> (10 ** 24).to_base34
+=> "ANGMLFL5UA0AW72G"
+
+# typical MongoDB ObjectId
+>> "507f191e810c19729de860ea".hex.to_base34
+=> "6RRUV0LLDJG0N6MAYBL" 
+
+# typical UUID
+>> "6948DF80-14BD-4E04-8842-7668D9C001F5".gsub(/-/,'').hex.to_base34
+=> "QKH6RDPUM5ACPE8GWKWB2PSMB" 
+
+```

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+

data/lib/user_friendly_id.rb

@@ -0,0 +1,4 @@
+require "user_friendly_id/version"
+require "user_friendly_id/digits"
+require "user_friendly_id/integer"
+require "user_friendly_id/string"

data/lib/user_friendly_id/digits.rb

@@ -0,0 +1,8 @@
+module UserFriendlyId
+
+  BASE34_DIGITS = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
+                   'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z']
+
+
+
+end

data/lib/user_friendly_id/integer.rb

@@ -0,0 +1,43 @@
+class Integer
+
+=begin rdoc
+  Turn a base10 integer into a base34 string representation.
+  The basic methodology is to decompose work into multiples of 34 - we create the base34 number by taking base34 chunks away from the base10 number.
+=end
+  def to_base34
+    # our storage string...
+    base34_str = String.new
+
+    # the zero case...
+    if self == 0
+      base34_str << UserFriendlyId::BASE34_DIGITS[0]
+      return base34_str
+    end
+
+    # get sign...
+    sign = self/(self.abs)
+
+    # make a working copy of self...
+    work = self.abs
+
+    # we build the base34 number from right to left...
+    place = 0
+    while work > 0 do
+      # grab the portion that is representable in our 'place' before we have to increment up to the next 'place'
+      remainder =  work % (34**(place+1))
+      # build the base34 number from right to left (i.e, tack on at the front)...
+      base34_str.insert(0, UserFriendlyId::BASE34_DIGITS[remainder/(34**place)])
+      # remove the portion we just represented...
+      work = work - remainder
+      # keep going...
+      place += 1
+    end
+
+    # append a negative sign if negative...
+    if sign < 0
+      base34_str.insert(0,'-')
+    end
+
+    return base34_str
+  end
+end

data/lib/user_friendly_id/string.rb

@@ -0,0 +1,37 @@
+class String
+
+=begin rdoc
+  Turn a base34 string representation into a base10 integer.
+=end
+  def from_base34
+    raise ArgumentError.new("Invalid characters for a base34 number found") unless self.valid_base34?
+    # strip whitespace, negative sign, and upcase
+    kleen = self.kleened.upcase
+    total = 0
+    size = kleen.length
+    for i in 0..size-1
+      total += UserFriendlyId::BASE34_DIGITS.index(kleen[i,1]) * 34**(size-(i+1))
+    end
+    total *= -1 if is_negative?
+    return total
+  end
+
+  def valid_base34?
+    # only the alpha minus I & O is what we want...
+    not /[^0-9a-zA-Z&&[^ioIO]]/.match(self.kleened)
+  end
+
+  def is_negative?
+    self.chr == '-'
+  end
+
+  protected
+
+  def kleened
+    # get rid of leading/trailing whitespace...
+    kleen = self.strip
+    # strip any leading negative sign...
+    kleen = kleen[1..-1] if is_negative?
+    kleen
+  end
+end

data/lib/user_friendly_id/version.rb

@@ -0,0 +1,3 @@
+module UserFriendlyId
+  VERSION = "1.0.0"
+end

data/spec/spec_helper.rb

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

data/spec/user_friendly_id_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe UserFriendlyId do
+  subject { UserFriendlyId.new }
+
+  describe '#to_base34' do
+    context 'method existence' do
+      it 'is callable on any Integer' do
+        expect(Integer(45)).to respond_to :to_base34
+        expect(45).to respond_to :to_base34
+        expect(456789012345678901234567).to respond_to :to_base34
+      end
+    end
+
+    context 'correct conversion' do
+      it 'handles 0 just fine' do
+        expect(0.to_base34).to eq "0"
+      end
+
+      it 'handles conversion to base34 as expected' do
+        expect((34 ** 1).to_base34).to eq "10"
+        expect((34 ** 5).to_base34).to eq "100000"
+        expect((34 ** 10).to_base34).to eq "10000000000"
+        expect(1155.to_base34).to eq "ZZ"
+      end
+
+      it 'handles negative integer as expected' do
+        expect((-34 ** 1).to_base34).to eq "-10"
+        expect((-34 ** 5).to_base34).to eq "-100000"
+        expect((-34 ** 10).to_base34).to eq "-10000000000"
+        expect(-1155.to_base34).to eq "-ZZ"
+      end
+    end
+  end
+
+  describe '#valid_base34?' do
+    context 'method existence' do
+      it 'is callable on any String' do
+        expect(String.new("sdfasdfasdf")).to respond_to :valid_base34?
+        expect("45").to respond_to :valid_base34?
+        expect("45AU34KFH567").to respond_to :valid_base34?
+      end
+    end
+
+    context 'valid base34 characters' do
+      it "should handle any base34 character" do
+        expect("0123456789".valid_base34?).to eq true
+        expect("abcdefghjklmnpqrstuvwxyz".valid_base34?).to eq true
+        expect("ABCDEFGHJKLMNPQRSTUVWXYZ".valid_base34?).to eq true
+      end
+
+      it "should handle any base34 character beginning with negative sign" do
+        expect("-0123456789".valid_base34?).to eq true
+        expect("-abcdefghjklmnpqrstuvwxyz".valid_base34?).to eq true
+        expect("-ABCDEFGHJKLMNPQRSTUVWXYZ".valid_base34?).to eq true
+      end
+
+      it "should not like negative sign embedded within string" do
+        expect("-01234-56789".valid_base34?).to eq false
+        expect("-abcdefghj-klmnpqrstuvwxyz".valid_base34?).to eq false
+        expect("-ABCDEFGHJK-LMNPQRSTUVWXYZ".valid_base34?).to eq false
+      end
+
+      it "should not like I or O within string" do
+        expect("io".valid_base34?).to eq false
+        expect("IO".valid_base34?).to eq false
+      end
+    end
+
+  end
+
+  describe '#from_base34' do
+    context 'method existence' do
+      it 'is callable on any String' do
+        expect(String.new("sdfasdfasdf")).to respond_to :from_base34
+        expect("45").to respond_to :from_base34
+        expect("45AU34KFH567").to respond_to :from_base34
+      end
+    end
+
+    context 'correct conversion' do
+      it 'handles 0 just fine' do
+        expect("0".from_base34).to eq 0
+      end
+
+      it 'handles whitespace at front/back just fine' do
+        expect("   10   ".from_base34).to eq 34
+      end
+
+      it 'handles conversion from base34 as expected' do
+        expect("10".from_base34).to eq (34 ** 1)
+        expect("100000".from_base34).to eq (34 ** 5)
+        expect("10000000000".from_base34).to eq (34 ** 10)
+        expect("ZZ".from_base34).to eq 1155
+      end
+
+      it 'handles negative integer as expected' do
+        expect("-10".from_base34).to eq (-34 ** 1)
+        expect("-100000".from_base34).to eq (-34 ** 5)
+        expect("-10000000000".from_base34).to eq (-34 ** 10)
+        expect("-ZZ".from_base34).to eq -1155
+      end
+    end
+
+    context 'bad strings' do
+      it 'should raise ArgumentError' do
+        expect{"-90 0453".from_base34}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/user_friendly_id.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/user_friendly_id/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Agranov"]
+  gem.email         = ["alex@morphogenic.net"]
+  gem.description   = %q{Make long integer ids pretty, short and less confusing by shortening via conversion to base34}
+  gem.summary       = %q{By leveraging base34 - [0-9, A-Z minus I & O] - we can significantly reduce the number of characters used to represent a number.  For instance, a 24-digit base10 number can be represented with just 16 digits in base34.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "user_friendly_id"
+  gem.require_paths = ["lib"]
+  gem.version       = UserFriendlyId::VERSION
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: user_friendly_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Agranov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make long integer ids pretty, short and less confusing by shortening
+  via conversion to base34
+email:
+- alex@morphogenic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/user_friendly_id.rb
+- lib/user_friendly_id/digits.rb
+- lib/user_friendly_id/integer.rb
+- lib/user_friendly_id/string.rb
+- lib/user_friendly_id/version.rb
+- spec/spec_helper.rb
+- spec/user_friendly_id_spec.rb
+- user_friendly_id.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: By leveraging base34 - [0-9, A-Z minus I & O] - we can significantly reduce
+  the number of characters used to represent a number.  For instance, a 24-digit base10
+  number can be represented with just 16 digits in base34.
+test_files:
+- spec/spec_helper.rb
+- spec/user_friendly_id_spec.rb