shortuuid 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5b102b6f8fd80fbd6e8d2d781ade1061c1bc129
-  data.tar.gz: 68a2030a24eca5c2d5dd97cc8e1ad2d58e6fa759
+SHA256:
+  metadata.gz: e9c37e30262bfa1797992cf06f6396ed074a22ac2d3c129935a616ca8206d1fb
+  data.tar.gz: a7c799ee1b68fac269a43c2647fb1a6e9b4d2a2e5ae3d1d5446928dd57c1eb3a
 SHA512:
-  metadata.gz: 0b08481115bc685e1aa4fe2216e5888ebe0449f121b0472636b849da8facc1f22d4192a751f140c813de2b34e6d35c839671078d43dbc719fec87a5d50b9a106
-  data.tar.gz: d1eaa1cc544c23b27915104443101a2093c13a3712755814047d6af9414637b124e66059f5d9c0538001397d8dc3079bd2dfac34466f54e1f78314ab612395ed
+  metadata.gz: 64bb7deea0727eca9d12da918c63933637b43b961573f04af0d3553b1fac7c5ee211e04f574d7107d618ba379b1aa8da5759fd2244828117a5b0e4b222c74dc5
+  data.tar.gz: ab8dec350cd401767a11ef16d5773986c3d29b9ed0164902b5dcad64c2f6074d3e99cb86014118426063b73d1ddc34dce60d143e7e2de38e05d5de4315bad058

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /test/reports
+/.idea

data/README.md

@@ -1,8 +1,29 @@
-# ShortUUID [![CircleCI](https://circleci.com/gh/sudhirj/shortuuid.svg?style=svg)](https://circleci.com/gh/sudhirj/shortuuid)
+# ShortUUID
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shortuuid`. To experiment with that code, run `bin/console` for an interactive prompt.
+Encode and decode UUIDs into any alphabet. Can either be used to improve space efficiency by using any alphabet with more than 16 characters, or any other alphabet for fun or profit.
 
-TODO: Delete this and the text above, and describe your gem
+The default alphabet is a URL safe base62, as defined by
+
+`DEFAULT_BASE62 = %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).freeze`
+
+## Usage
+
+```
+irb(main):001:0> id = SecureRandom.uuid
+=> "4890586e-32a5-4f9c-a000-2a2bb68eb1ce"
+
+irb(main):003:0> short_id = ShortUUID.shorten id
+=> "2CvPdpytrcURpSLoPxYb30"
+
+irb(main):005:0> ShortUUID.expand short_id
+=> "4890586e-32a5-4f9c-a000-2a2bb68eb1ce"
+
+irb(main):007:0> vowel_id = ShortUUID.shorten id, "AEIOU".chars
+=> "EOOIAUUEOUUIOIIEUUUAOOUIOOUUAOIIIEAUAOUAAAOEOOEOAUAUUEE"
+
+irb(main):009:0> ShortUUID.expand vowel_id, "AEIOU".chars
+=> "4890586e-32a5-4f9c-a000-2a2bb68eb1ce"
+```
 
 ## Installation
 
@@ -20,19 +41,10 @@ Or install it yourself as:
 
     $ gem install shortuuid
 
-## Usage
-
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shortuuid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sudhirj/shortuuid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/shortuuid.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'shortuuid/version'
 
 module ShortUUID
-  DEFAULT_BASE62 = %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).freeze
+  DEFAULT_BASE62 = %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].freeze
 
   def self.shorten(uuid, alphabet = DEFAULT_BASE62)
     return nil unless uuid && !uuid.empty?
@@ -9,20 +11,21 @@ module ShortUUID
     convert_decimal_to_alphabet(decimal_value, alphabet)
   end
 
-  def self.convert_decimal_to_alphabet(decimal, alphabet)
+  def self.convert_decimal_to_alphabet(decimal, alphabet = DEFAULT_BASE62)
     alphabet = alphabet.to_a
     radix = alphabet.length
     i = decimal.to_i
     out = []
+    return alphabet[0] if i.zero?
     loop do
-      break if i == 0
+      break if i.zero?
       out.unshift(alphabet[i % radix])
       i /= radix
     end
     out.join
   end
 
-  def self.convert_alphabet_to_decimal(word, alphabet)
+  def self.convert_alphabet_to_decimal(word, alphabet = DEFAULT_BASE62)
     num = 0
     radix = alphabet.length
     word.chars.to_a.reverse.each_with_index do |char, index|
@@ -31,6 +34,14 @@ module ShortUUID
     num
   end
 
+  def self.encode(number, alphabet = DEFAULT_BASE62)
+    convert_decimal_to_alphabet(number, alphabet)
+  end
+
+  def self.decode(word, alphabet = DEFAULT_BASE62)
+    convert_alphabet_to_decimal(word, alphabet)
+  end
+
   def self.expand(short_uuid, alphabet = DEFAULT_BASE62)
     return nil unless short_uuid && !short_uuid.empty?
     decimal_value = convert_alphabet_to_decimal(short_uuid, alphabet)

data/lib/shortuuid/version.rb

@@ -1,3 +1,3 @@
 module ShortUUID
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/shortuuid.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Sudhir Jonathan']
   spec.email         = ['sudhir.j@gmail.com']
 
-  spec.summary       = 'Quickly and easily convert UUIDs to space efficient Base58 strings.'
+  spec.summary       = 'Quickly and easily convert UUIDs to space efficient Base62 strings.'
   spec.homepage      = 'https://github.com/sudhirj/shortuuid'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shortuuid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sudhir Jonathan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2018-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Quickly and easily convert UUIDs to space efficient Base58 strings.
+summary: Quickly and easily convert UUIDs to space efficient Base62 strings.
 test_files: []