shorten 1.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+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 "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    rcov (0.9.10-java)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Junegunn Choi
+
+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 @@
+= shorten
+
+A number shortener.
+
+== Example
+
+  # Default: Shorten::BASE62
+  12345.shorten
+  12345.shorten.unshorten
+
+  # Using Shorten::BASE36 for case-insensitivity
+  12345.shorten(Shorten::BASE36)
+  12345.shorten(Shorten::BASE36).unshorten(Shorten::BASE36)
+
+  # Using an arbitrary sequence of characters for shortening
+  12345.shorten("ㄱㄴㄷㄹㅁㅂㅅㅇㅈㅊㅋㅌㅍㅎ")
+
+== TODO
+
+* Negative numbers.
+* Float support.
+
+== Contributing to shorten
+ 
+* 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 Junegunn Choi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+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 = "shorten"
+  gem.homepage = "http://github.com/junegunn/shorten"
+  gem.license = "MIT"
+  gem.summary = %Q{Number shortener}
+  gem.description = %Q{Number shortener}
+  gem.email = "junegunn.c@gmail.com"
+  gem.authors = ["Junegunn Choi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/shorten.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+
+module Shorten
+	BASE36 = ((0..9).to_a + ('a'..'z').to_a).map(&:to_s).join
+	BASE62 = BASE36 + ('A'..'Z').map(&:to_s).join
+
+	module Numeric
+		# @param [String] chars Sequence of characters for shortening
+		# @return [String] Shortened string
+		def shorten chars = Shorten::BASE62
+			raise ArgumentError.new('String required') unless chars.is_a? String
+			raise ArgumentError.new('Only non-negative integers can be shortened') if self < 0
+
+			num = self
+			len = chars.length
+			str = ''
+			while num > 0
+				mod = num % len
+				str = chars[mod, 1] + str
+				num /= len
+			end
+			str
+		end
+	end
+
+	module String
+		# @param [String] chars Sequence of characters for unshortening
+		# @return [Fixnum/Bignum] Unshortened number
+		def unshorten chars = Shorten::BASE62
+			raise ArgumentError.new('String required') unless chars.is_a? String
+
+			num = 0
+			len = chars.length
+			self.each_char do |c|
+				num *= len
+				char = chars.index(c)
+				raise ArgumentError.new('Cannot unshorten: invalid characters') if char.nil?
+				num += char
+			end
+			num
+		end
+	end
+end
+
+class Fixnum
+	include Shorten::Numeric
+end
+
+class Bignum
+	include Shorten::Numeric
+end
+
+class String
+	include Shorten::String
+end
+

data/spec/shorten_spec.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env rspec
+# encoding: UTF-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+CHEETSHEET = {
+	:base62 => {
+		1 => '1',
+		9 => '9',
+		10 => 'a',
+		36 => 'A',
+		37 => 'B',
+		62 => '10',
+		63 => '11',
+		100000000000000000000000000000000 => 'xPEhw0uJHtT7g9cK7C'
+	},
+	:base36 => {
+		1 => '1',
+		9 => '9',
+		10 => 'a',
+		36 => '10',
+		37 => '11'
+	}
+}
+
+describe "Shorten" do
+	it "shortens a number" do
+		CHEETSHEET[:base62].each do |k, v|
+			k.shorten.should eq v
+			k.shorten(Shorten::BASE62).should eq v
+		end
+
+		CHEETSHEET[:base36].each do |k, v|
+			k.shorten(Shorten::BASE36).should eq v
+			k.shorten(Shorten::BASE36).should eq k.to_s(36)
+		end
+
+		(1..10000).each do |i|
+			i.shorten.unshorten.should eq i
+		end
+
+		(9999999999999999999989999..9999999999999999999999999).each do |i|
+			i.shorten.unshorten.should eq i
+		end
+	end
+
+	it "shortens a number with any given characters" do
+		chars = Shorten::BASE62
+		my_chars = chars.each_char.to_a.shuffle.join
+		map = {}
+
+		chars.each_char.each_with_index do |e, idx|
+			map[e] = my_chars[idx]
+		end
+
+		CHEETSHEET[:base62].each do |k, v|
+			k.shorten(my_chars).should eq(v.each_char.map { |e| map[e] }.join)
+			k.shorten(my_chars).unshorten(my_chars).should eq(k)
+		end
+
+		12345.shorten("ㄱㄴㄷㄹㅁㅂㅅㅇㅈㅊㅋㅌㅍㅎ").should eq "ㅁㅅㅎㅌ"
+		"ㅁㅅㅎㅌ".unshorten("ㄱㄴㄷㄹㅁㅂㅅㅇㅈㅊㅋㅌㅍㅎ").should eq 12345
+	end
+
+	it "shortens Bignums" do
+		bn = 1000000000000000000000000000000000
+		bn.shorten(Shorten::BASE36).should eq bn.to_s(36)
+	end
+
+	it "unshortens a shortened number" do
+		CHEETSHEET[:base62].each do |k, v|
+			k.shorten.unshorten.should eq k
+			k.shorten(Shorten::BASE62).unshorten(Shorten::BASE62).should eq k
+		end
+
+		CHEETSHEET[:base36].each do |k, v|
+			k.shorten(Shorten::BASE36).unshorten(Shorten::BASE36).should eq k
+			k.shorten(Shorten::BASE36).unshorten(Shorten::BASE36).should eq k
+		end
+	end
+	
+	it "throws error on unshorten-able string" do
+		expect { "-_-;".unshorten }.to raise_error(ArgumentError)
+	end
+
+	it "cannot shorten negative integers" do
+		expect { -5.shorten }.to raise_error(ArgumentError)
+	end
+
+	it "does not support Float" do
+		expect { 8.27.shorten }.to raise_error(NoMethodError)
+	end
+
+	it "throws error on invalid parameter" do
+		[
+			1234,
+			'a'..'z',
+			{:a => 1},
+			["hello"]
+		].each do |inv|
+			expect { 1234.shorten(inv) }.to raise_error(ArgumentError)
+			expect { "1234".unshorten(inv) }.to raise_error(ArgumentError)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'shorten'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: shorten
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152905400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152905400
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152904880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152904880
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152904400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152904400
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152903900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2152903900
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152903380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152903380
+description: Number shortener
+email: junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/shorten.rb
+- spec/shorten_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/junegunn/shorten
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1233340932936789572
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Number shortener
+test_files: []