youyouaidi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d8a7918c5ccc52c7b51c259aef312e9c0c4b74
-  data.tar.gz: 4e280e52b10d17e1adebe93986e353078d90de18
+  metadata.gz: 1348322fab3186ecf944dd41ca64cae5316b4648
+  data.tar.gz: f469604e1089be795b4d49bb533af942be2af1d2
 SHA512:
-  metadata.gz: 31b9dbba81a25d1923a44ca05b731d4b7762c3fbde742f36259269d781e10e45d9911042d385891f828fae2469f09d8913d0dfd74022b05d67f12a742d77950f
-  data.tar.gz: e162eb97d5f4609ebd91389ba0907134a0e5f1761764139730f9cfcedb4562561ea14edc6b2dc895a7d1a0a584d43b3fec32837d55b63e803ebce72c2f8471cd
+  metadata.gz: 577327867e66034cf00973254f133b173c8799545916bb4403e7df4adcaf96c7f0f68570ebe620ef7b852c0110598857e667266b8cf5264ff4246ca3625065de
+  data.tar.gz: 90418860a463cba9a14a5cfad83ae40fed522ca6fce33ecdd611c2bfbfc7f8c2e6ce1a06f6544426d4dcba3d0f0f41346270afee0b8369e03de3581efddb1058

data/README.md

@@ -1,5 +1,9 @@
 # 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)
+
+
 Ruby Gem `Youyouaidi` offers a UUID class for parsing, validating and converting UUIDs into / from shorter representations.
 
 ## Installation
@@ -22,9 +26,9 @@ Or install it yourself as:
 uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format
 uuid_short  = '_oGOAbD9fsFFEHWSMal1v'                # Same UUID in its short format
 
-Youyouaidi::UUID.valid_uuid? uuid_string # => true
+Youyouaidi::UUID.valid? uuid_string # => true
 
-uuid = UUID uuid_string   # creates new Youyouaidi::UUID object, patches Youyouaidi::UUID.new uuid_string into kernel.
+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">
 # or alternatively a short UUID can be passed
 uuid = UUID uuid_short    # creates similar Youyouaidi::UUID object

data/lib/kernel_patch.rb

@@ -2,6 +2,6 @@ require 'youyouaidi'
 
 module Kernel
   def UUID(uuid_param)
-    Youyouaidi::UUID.new uuid_param
+    Youyouaidi::UUID.parse uuid_param
   end
 end

data/lib/youyouaidi.rb

@@ -4,5 +4,6 @@ require 'kernel_patch'
 module Youyouaidi
   # Your code goes here...
   require 'youyouaidi/uuid'
+  require 'youyouaidi/invalid_uuid'
   require 'youyouaidi/converter'
 end

data/lib/youyouaidi/converter.rb

@@ -7,14 +7,14 @@ class Youyouaidi::Converter
     end
 
     def decode(encoded_uuid)
-      base_decode encoded_uuid
+      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(_ - +)
 
       def base_encode(numeric)
-        raise ArgumentError, "`#{numeric}' needs to be a Numeric" unless numeric.is_a? Numeric
+        raise Youyouaidi::InvalidUUIDError.new "`#{numeric}' needs to be a Numeric" unless numeric.is_a? Numeric
 
         return '0' if numeric == 0
         s = ''
@@ -34,10 +34,15 @@ class Youyouaidi::Converter
           if ord = BASE.index(char)
             total += ord * (BASE.size ** index)
           else
-            raise ArgumentError, "`#{encoded_numeric}' has `#{char}' which is not valid"
+            raise Youyouaidi::InvalidUUIDError.new "`#{encoded_numeric}' has `#{char}' which is not valid"
           end
         end
         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]}"
+      end
   end
-end
+end

data/lib/youyouaidi/invalid_uuid.rb

@@ -0,0 +1,2 @@
+class Youyouaidi::InvalidUUIDError < TypeError
+end

data/lib/youyouaidi/uuid.rb

@@ -1,14 +1,10 @@
 class Youyouaidi::UUID
   attr_reader :uuid
 
-  def initialize(uuid_param, options = {})
+  def initialize(uuid_string, options = {})
     @converter = options[:converter] || Youyouaidi::Converter
-    if self.class.valid_uuid? uuid_param
-      @uuid = uuid_param.to_s
-    else
-      @uuid = decode_short_string uuid_param
-      raise ArgumentError.new "`#{uuid_param}' could not be converted to valid UUID" unless self.class.valid_uuid? @uuid
-    end
+    raise Youyouaidi::InvalidUUIDError.new "`#{uuid_string}' could not be converted to valid UUID" unless self.class.valid? uuid_string
+    @uuid = uuid_string.to_s
   end
 
   def to_i
@@ -25,14 +21,21 @@ class Youyouaidi::UUID
   alias_method :to_param, :to_short_string
 
   private
-  def decode_short_string(short_uuid_string)
-    uuid = @converter.decode(short_uuid_string).to_i.to_s(16)
-    "#{uuid[0,8]}-#{uuid[8,4]}-#{uuid[12,4]}-#{uuid[16,4]}-#{uuid[20,12]}"
-  end
 
   class << self
-    def valid_uuid?(uuid_canidate)
-      (uuid_canidate.to_s =~ /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i) == 0
+    def parse(uuid_param, options = {})
+      @converter = options[:converter] || Youyouaidi::Converter
+      if valid? uuid_param
+        self.new uuid_param.to_s, options
+      else
+        uuid_obj = @converter.decode uuid_param
+        raise Youyouaidi::InvalidUUIDError.new "`#{uuid_param}' could not be converted to valid UUID" unless valid? uuid_obj.to_s
+        uuid_obj
+      end
+    end
+
+    def valid?(uuid_canidate)
+      (uuid_canidate.to_s =~ /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i) == 0
     end
   end
-end
+end

data/lib/youyouaidi/version.rb

@@ -1,3 +1,3 @@
 module Youyouaidi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/kernel_patch_spec.rb

@@ -27,7 +27,7 @@ describe Kernel do
     context 'initialized with invalid param' do
       let(:param) { 'KEKSE' }
       subject { -> { action } }
-      it { should raise_error ArgumentError }
+      it { should raise_error Youyouaidi::InvalidUUIDError }
     end
   end
-end
+end

data/spec/youyouaidi/converter_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
 describe Youyouaidi::Converter do
+  let(:uuid) { Youyouaidi::UUID.new uuid_string }
   let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-  let(:uuid_bignum) { 113059749145936325402354257176981405696 }
   let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
 
   describe 'use case' do
-    subject { described_class.decode described_class.encode(uuid_bignum) }
+    subject { described_class.decode described_class.encode(uuid) }
 
-    it { should eq uuid_bignum }
+    it { should be_a Youyouaidi::UUID }
+    its(:to_s) { should eq uuid_string }
   end
 
   describe 'methods' do
-    let(:uuid) { Youyouaidi::UUID.new uuid_string }
 
     describe '.encode' do
       subject { described_class.encode uuid }
@@ -23,7 +23,16 @@ describe Youyouaidi::Converter do
     describe '.decode' do
       subject { described_class.decode encoded_uuid }
 
-      it { should eq uuid_bignum }
+      it { should be_a Youyouaidi::UUID }
+      its(:to_s) { should eq uuid_string }
+
+      context 'with invalid characters' do
+        let(:encoded_uuid) { ' ' }
+
+        it 'raises error' do
+          expect { subject }.to raise_error Youyouaidi::InvalidUUIDError
+        end
+      end
     end
   end
-end
+end

data/spec/youyouaidi_spec.rb

@@ -4,7 +4,36 @@ describe Youyouaidi do
   describe Youyouaidi::UUID do
     describe '.new' do
       let(:param) { '' }
-      subject { Youyouaidi::UUID.new param }
+      let(:action) { Youyouaidi::UUID.new param }
+      subject { -> { action } }
+
+      context 'with valid uuid string' do
+        let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
+        subject { action }
+
+        it { should be_a Youyouaidi::UUID }
+      end
+
+      context 'with uuid in short format' do
+        let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
+        it { should raise_error Youyouaidi::InvalidUUIDError }
+      end
+
+      context 'with invalid uuid string' do
+        let(:param) { 'Kekse' }
+        it { should raise_error Youyouaidi::InvalidUUIDError }
+      end
+
+      context 'with non-uuid-string input' do
+        let(:param) { 1234 }
+        it { should raise_error Youyouaidi::InvalidUUIDError }
+      end
+    end
+
+    describe '.parse' do
+      let(:param) { '' }
+      let(:action) { Youyouaidi::UUID.parse param }
+      subject { action }
 
       context 'with valid uuid string' do
         let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
@@ -24,7 +53,7 @@ describe Youyouaidi do
         let(:param) { 'Kekse' }
 
         it 'raises error' do
-          expect { Youyouaidi::UUID.new param }.to raise_error ArgumentError
+          expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
         end
       end
 
@@ -32,7 +61,7 @@ describe Youyouaidi do
         let(:param) { 1234 }
 
         it 'raises error' do
-          expect { Youyouaidi::UUID.new param }.to raise_error ArgumentError
+          expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
         end
       end
     end
@@ -75,9 +104,9 @@ describe Youyouaidi do
       it_behaves_like 'method for short format'
     end
 
-    describe '.valid_uuid?' do
+    describe '.valid?' do
       let(:param) { '' }
-      subject { Youyouaidi::UUID.valid_uuid? param }
+      subject { Youyouaidi::UUID.valid? param }
 
       context 'with valid uuid' do
         let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
@@ -86,14 +115,17 @@ describe Youyouaidi do
       end
 
       context 'with invalid uuid' do
-        invalid_uuids = ['Kekse', 'aa550e8400-e29b-41d4-a716-446655440000']
+        uuid_string   = '550e8400-e29b-41d4-a716-446655440000'
+        encoded_uuid  = '_oGOAbD9fsFFEHWSMal1v'
+        invalid_uuids = ['Kekse', "aa#{uuid_string}", "#{uuid_string}bb",
+          "#{encoded_uuid}" ]
 
         invalid_uuids.each do |invalid_uuid|
           it "should return false for `#{invalid_uuid}`" do
-            expect(Youyouaidi::UUID.valid_uuid? invalid_uuid).to eq false
+            expect(Youyouaidi::UUID.valid? invalid_uuid).to eq false
           end
         end
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youyouaidi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nicolas Fricke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,7 @@ files:
 - lib/kernel_patch.rb
 - lib/youyouaidi.rb
 - lib/youyouaidi/converter.rb
+- lib/youyouaidi/invalid_uuid.rb
 - lib/youyouaidi/uuid.rb
 - lib/youyouaidi/version.rb
 - spec/kernel_patch_spec.rb