youyouaidi 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1713ea510982e9d0ef36b7ea4b5601342bbb7673
-  data.tar.gz: 883a63e7466046595d329ae52bae3739b2275ad7
+  metadata.gz: 383f96781da456cf785f37008b07cea302bc6465
+  data.tar.gz: 63ad6a4540f8f1740b5e9fb0477c610203c93a32
 SHA512:
-  metadata.gz: 957ee30738eb6f2d5d1bb7520ecb2768148bc2a4d6d90d3e725804f553034e446f34b669bfabc14e3a29e6dffc5731f86dd6e2262a2b2da6c3979b269776f484
-  data.tar.gz: 4a9520ae3df9cfbc6aa393d02c867a95eb690cfcff6bab6a2693f7e3a0ffd3cb9d3a4d74ed79e6beb537d1fdb471769f84848c91a74706c16bb2ae7ebc512fcb
+  metadata.gz: 98d5f4460aade04d5bd5b3d458057de3e04321968d7a65194ff26161ca219b6e2a6b1e0b259641eb24e9c8e5a55d8080f123f6821f1449ce5751ad9266531c4f
+  data.tar.gz: 769b6f76f82a8add80421b20ac845487cfa07138cd1286a5e6fb62d982120da90b9f3f90e2ec4c33a19ca2db85cdc0ec9f7c4a8a008bb72b18d7387f602bcf21

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'rspec'
+gem 'coveralls', require: false
 
 group :test do
   gem 'rake', '~> 10.1'

data/README.md

@@ -1,10 +1,13 @@
-# Youyouaidi
-
-[![Gem Version](https://badge.fury.io/rb/youyouaidi.svg)](https://rubygems.org/gems/youyouaidi)
+# Youyouaidi 
+[![Gem Version](https://badge.fury.io/rb/youyouaidi.svg)](https://rubygems.org/gems/youyouaidi) 
 [![Build Status](https://travis-ci.org/nicolas-fricke/youyouaidi.svg)](https://travis-ci.org/nicolas-fricke/youyouaidi)
+[![Coverage Status](http://img.shields.io/coveralls/nicolas-fricke/youyouaidi.svg)](https://coveralls.io/r/nicolas-fricke/youyouaidi)
+[![Code Climate](http://img.shields.io/codeclimate/github/nicolas-fricke/youyouaidi.svg)](https://codeclimate.com/github/nicolas-fricke/youyouaidi)
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
 
 
-Ruby Gem `Youyouaidi` offers a UUID class for parsing, validating and converting UUIDs into / from shorter representations.
+`Youyouaidi` is a Ruby Gem that offers a UUID class for parsing, validating and converting UUIDs into / from shorter representations.
+While a UUID consists of 32 hexadecimal characters by dashes divided into 5 subgroups, the short representation (invoked via `#to_shrort_string`) consists of exactly 22 digit and lower- and uppercase characters.
 
 ## Installation
 
@@ -25,8 +28,8 @@ Or install it yourself as:
 ### Initializing UUIDs
 
 ```ruby
-uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format
-uuid_short  = '_oGOAbD9fsFFEHWSMal1v'                # Same UUID in its short format
+uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format, has exactly 32 hexadecimal characters in 5 groups
+uuid_short  = '2AuYQJcZeiIeCymkJ7tzTW'               # Same UUID in its short format, has exactly 22 characters of [0-9a-zA-Z]
 
 uuid = UUID uuid_string   # creates new Youyouaidi::UUID object, patches Youyouaidi::UUID.parse uuid_string into kernel.
 # => #<Youyouaidi::UUID:0x0000010150bb60 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
@@ -49,7 +52,7 @@ uuid.to_s                 # Returns the string representation of the UUID object
 # => '550e8400-e29b-41d4-a716-446655440000'
 
 uuid.to_short_s           # Returns the short string representation of the UUID object
-# => '_oGOAbD9fsFFEHWSMal1v', alias for method: #to_param
+# => '2AuYQJcZeiIeCymkJ7tzTW', alias for method: #to_param
 ```
 
 

data/lib/youyouaidi/converter.rb

@@ -7,11 +7,14 @@ class Youyouaidi::Converter
     end
 
     def decode(encoded_uuid)
+      encoded_uuid = encoded_uuid.to_s
+      raise Youyouaidi::InvalidUUIDError.new "`#{encoded_uuid}' needs to have exactly #{ENCODED_LENGTH} characters" unless encoded_uuid.length == ENCODED_LENGTH
       Youyouaidi::UUID.new convert_bignum_to_uuid_string base_decode encoded_uuid
     end
 
     private
-      BASE = ('0'..'9').to_a + ('a'..'z').to_a + ('A'..'Z').to_a + %w(_ - +)
+      BASE           = ('0'..'9').to_a + ('a'..'z').to_a + ('A'..'Z').to_a
+      ENCODED_LENGTH = 22 # Needs to be greater than `(Math.log 2**128, BASE.length).floor + 1`
 
       def base_encode(numeric)
         raise Youyouaidi::InvalidUUIDError.new "`#{numeric}' needs to be a Numeric" unless numeric.is_a? Numeric
@@ -23,6 +26,9 @@ class Youyouaidi::Converter
           s << BASE[numeric.modulo(BASE.size)]
           numeric /= BASE.size
         end
+        while s.length < ENCODED_LENGTH
+          s << BASE[0]
+        end
         s.reverse
       end
 
@@ -40,9 +46,11 @@ class Youyouaidi::Converter
         total
       end
 
-      def convert_bignum_to_uuid_string(short_uuid_string)
-        uuid = short_uuid_string.to_i.to_s(16)
-        "#{uuid[0,8]}-#{uuid[8,4]}-#{uuid[12,4]}-#{uuid[16,4]}-#{uuid[20,12]}"
+      def convert_bignum_to_uuid_string(decoded_uuid_bignum)
+        decoded_uuid = decoded_uuid_bignum.to_i.to_s(16).rjust(32, '0')
+        parsed_uuid  = "#{decoded_uuid[0,8]}-#{decoded_uuid[8,4]}-#{decoded_uuid[12,4]}-#{decoded_uuid[16,4]}-#{decoded_uuid[20,12]}"
+        raise Youyouaidi::InvalidUUIDError.new "Converted string `#{decoded_uuid}' has too many characters" if decoded_uuid.length > 32
+        parsed_uuid
       end
   end
 end

data/lib/youyouaidi/version.rb

@@ -1,3 +1,3 @@
 module Youyouaidi
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/spec/kernel_patch_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Kernel do
   describe '.UUID' do
     let(:valid_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
-    let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+    let(:encoded_uuid) { '2AuYQJcZeiIeCymkJ7tzTW' }
     let(:action) { UUID param }
 
     subject { action }

data/spec/spec_helper.rb

@@ -3,6 +3,10 @@ require 'rspec'
 require 'bundler'
 Bundler.require
 
+# Code coverage statistics at coveralls.io: https://coveralls.io/r/nicolas-fricke/youyouaidi
+require 'coveralls'
+Coveralls.wear!
+
 require 'youyouaidi'
 
 RSpec.configure do |config|

data/spec/youyouaidi/converter_spec.rb

@@ -3,7 +3,12 @@ require 'spec_helper'
 describe Youyouaidi::Converter do
   let(:uuid) { Youyouaidi::UUID.new uuid_string }
   let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-  let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+  let(:encoded_uuid) { '2AuYQJcZeiIeCymkJ7tzTW' }
+
+  uuids_with_encoding = {
+    '550e8400-e29b-41d4-a716-446655440000' => '2AuYQJcZeiIeCymkJ7tzTW',
+    '00000000-bbbb-2222-8888-000000000000' => '000001dyObGywDRlcScExy'
+  }
 
   describe 'use case' do
     subject { described_class.decode described_class.encode(uuid) }
@@ -17,20 +22,40 @@ describe Youyouaidi::Converter do
     describe '.encode' do
       subject { described_class.encode uuid }
 
-      it { should eq encoded_uuid }
+      uuids_with_encoding.each do |valid_uuid, encoded_uuid|
+        context "for uuid `#{valid_uuid}'" do
+          let(:uuid_string) { valid_uuid }
+          it { should have(22).characters }
+          it { should eq encoded_uuid }
+        end
+      end
     end
 
     describe '.decode' do
-      subject { described_class.decode encoded_uuid }
+      let(:action) { described_class.decode encoded_param }
 
-      it { should be_a Youyouaidi::UUID }
-      its(:to_s) { should eq uuid_string }
+      context 'with valid param' do
+        subject { action }
 
-      context 'with invalid characters' do
-        let(:encoded_uuid) { ' ' }
+        uuids_with_encoding.each do |valid_uuid, encoded_uuid|
+          context "for encoded uuid `#{encoded_uuid}'" do
+            let(:encoded_param) { encoded_uuid }
+            it { should be_a Youyouaidi::UUID }
+            its(:to_s) { should eq valid_uuid }
+          end
+        end
+      end
+
+      context 'with invalid param' do
+        subject { -> { action } }
+        context 'with invalid characters' do
+          let(:encoded_param) { ' ' }
+          it { should raise_error Youyouaidi::InvalidUUIDError }
+        end
 
-        it 'raises error' do
-          expect { subject }.to raise_error Youyouaidi::InvalidUUIDError
+        context 'with too long encoded param' do
+          let(:encoded_param) { "#{encoded_uuid}abc" }
+          it { should raise_error Youyouaidi::InvalidUUIDError }
         end
       end
     end

data/spec/youyouaidi/uuid_spec.rb

@@ -7,15 +7,24 @@ describe Youyouaidi::UUID do
     subject { -> { action } }
 
     context 'with valid uuid string' do
-      let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
       subject { action }
 
-      it { should be_a Youyouaidi::UUID }
-      its(:to_s) { should eq param }
+      uuid_string   = '550e8400-e29b-41d4-a716-446655440000'
+      encoded_uuid  = '2AuYQJcZeiIeCymkJ7tzTW'
+      valid_uuids = ['550e8400-e29b-41d4-a716-446655440000',
+                     '00000000-bbbb-2222-8888-000000000000']
+
+      valid_uuids.each do |valid_uuid|
+        context "for uuid `#{valid_uuid}'" do
+          let(:param) { valid_uuid }
+          it { should be_a Youyouaidi::UUID }
+          its(:to_s) { should eq param }
+        end
+      end
     end
 
     context 'with uuid in short format' do
-      let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
+      let(:param) { '2AuYQJcZeiIeCymkJ7tzTW' }
       it { should raise_error Youyouaidi::InvalidUUIDError }
     end
 
@@ -42,7 +51,7 @@ describe Youyouaidi::UUID do
     end
 
     context 'with uuid in short format' do
-        let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
+        let(:param) { '2AuYQJcZeiIeCymkJ7tzTW' }
         let(:decoded_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
 
         it { should be_a Youyouaidi::UUID }
@@ -68,7 +77,7 @@ describe Youyouaidi::UUID do
 
   shared_examples_for 'equality check for two UUID objects' do
     let(:first_uuid_string)  { 'aaaaaaaa-eeee-4444-aaaa-444444444444' }
-    let(:second_uuid_string) { '00000000-bbbb-2222-6666-000000000000' }
+    let(:second_uuid_string) { '00000000-bbbb-2222-8888-000000000000' }
     let(:first_uuid)  { Youyouaidi::UUID.new first_uuid_string }
     let(:second_uuid) { Youyouaidi::UUID.new second_uuid_string }
 
@@ -168,7 +177,7 @@ describe Youyouaidi::UUID do
 
   shared_examples_for 'method for short format' do
     let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-    let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+    let(:encoded_uuid) { '2AuYQJcZeiIeCymkJ7tzTW' }
     let(:uuid) { Youyouaidi::UUID.new uuid_string }
 
     let(:action) { uuid.send method }
@@ -198,7 +207,7 @@ describe Youyouaidi::UUID do
 
     context 'with invalid uuid' do
       uuid_string   = '550e8400-e29b-41d4-a716-446655440000'
-      encoded_uuid  = '_oGOAbD9fsFFEHWSMal1v'
+      encoded_uuid  = '2AuYQJcZeiIeCymkJ7tzTW'
       invalid_uuids = ['Kekse', "aa#{uuid_string}", "#{uuid_string}bb",
         "#{encoded_uuid}" ]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youyouaidi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Nicolas Fricke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler