youyouaidi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 383f96781da456cf785f37008b07cea302bc6465
-  data.tar.gz: 63ad6a4540f8f1740b5e9fb0477c610203c93a32
+  metadata.gz: 9bc980217243ad4ab182d95a4bc4e1c32ca04dc9
+  data.tar.gz: 6bad0870b6e0cf45e6fc8f3d783c0253d9e072d0
 SHA512:
-  metadata.gz: 98d5f4460aade04d5bd5b3d458057de3e04321968d7a65194ff26161ca219b6e2a6b1e0b259641eb24e9c8e5a55d8080f123f6821f1449ce5751ad9266531c4f
-  data.tar.gz: 769b6f76f82a8add80421b20ac845487cfa07138cd1286a5e6fb62d982120da90b9f3f90e2ec4c33a19ca2db85cdc0ec9f7c4a8a008bb72b18d7387f602bcf21
+  metadata.gz: 1715bbde2ec432104c9d3012940fa4e9f51bd5e930171885136b288507de1b76f80905a15973158d7b30e978ade65e06221a55028cfd0f2b539659ad49a3a2a2
+  data.tar.gz: 11a1b217560ebfb1142b9405df2d186a8a60131161802530145dbbf86b534ff53804a99672dcc117a3ffa3104458bd551da586b2ff0dc2bc9ddbbb774ac15242

data/README.md

@@ -1,13 +1,31 @@
-# 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)
 
 
-`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.
+`Youyouaidi` is a Ruby Gem that offers a UUID class for generating, parsing, validating and converting UUIDs into / from shorter representations.
+
+While a UUID consists of 32 hexadecimal characters by dashes divided into 5 subgroups - which makes 36 characters in total - the short representation (invoked via `#to_shrort_string`) consists of exactly 22 digit and lower- and uppercase characters.
+
+For UUID generation, the `SecureRandom.uuid` method is used which generates valid, random *version 4* UUIDs.
+
+This is what a valid, random (version 4) UUID looks like:
+```
+# chars in group:     8   | 4  | 4  | 4  |    12
+                      ▼     ▼    ▼    ▼       ▼
+                  caed3f49-b0ca-454b-adf8-5ee2a1764759
+                                ▲    ▲
+                          version    either 8, 9
+                           number        a, or b
+```
+As shown, the first digit of the third group indicates the UUID version.
+The first digit of the fourth group always has to be one of either `8`, `9`, `a`, or `b`.
+All other digits are randomly assigned hexadecimals.
+
+Find out more about UUIDs and the different versions on [Wikipedia](https://en.wikipedia.org/wiki/Uuid).
 
 ## Installation
 
@@ -32,11 +50,15 @@ uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string fo
 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">
+# => #<Youyouaidi::UUID:0x000001021f2590 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
 
 # Alternatively a short UUID can be passed:
 uuid = UUID uuid_short    # creates similar Youyouaidi::UUID object
-# => #<Youyouaidi::UUID:0x0000010150bb60 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
+# => #<Youyouaidi::UUID:0x00000102201b80 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
+
+# To generate a new random UUID simply do not pass a parameter:
+new_uuid = UUID()         # generates a random UUID version 4 using the SecureRandom.uuid method
+# => #<Youyouaidi::UUID:0x00000102201b80 @converter=Youyouaidi::Converter, @uuid="27f8bc29-be8e-4dc7-ab30-0295b2a5e902">
 ```
 
 
@@ -48,10 +70,10 @@ uuid = UUID uuid_string
 
 Youyouaidi::UUID.valid? uuid_string # => true
 
-uuid.to_s                 # Returns the string representation of the UUID object
+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
+uuid.to_short_s  # Returns the short string representation of the UUID object
 # => '2AuYQJcZeiIeCymkJ7tzTW', alias for method: #to_param
 ```
 
@@ -62,7 +84,7 @@ uuid.to_short_s           # Returns the short string representation of the UUID
 uuid_string  = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format
 uuid         = UUID uuid_string
 similar_uuid = UUID uuid_string
-other_uuid   = UUID 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
+other_uuid   = UUID '00000000-1111-2222-aaaa-eeeeeeeeeeee'
 
 uuid == similar_uuid # Two UUID objects representing same UUID (#=== behaves similar for this)
 # => true
@@ -79,7 +101,7 @@ uuid === uuid_string # Comparing a UUID object and its string representation wit
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/youyouaidi/fork )
+1. Fork it ( http://github.com/nicolas-fricke/youyouaidi/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/kernel_patch.rb

@@ -1,7 +1,7 @@
 require 'youyouaidi'
 
 module Kernel
-  def UUID(uuid_param)
+  def UUID(uuid_param = nil)
     Youyouaidi::UUID.parse uuid_param
   end
 end

data/lib/youyouaidi/uuid.rb

@@ -1,10 +1,15 @@
+require 'securerandom'
+
 class Youyouaidi::UUID
   attr_reader :uuid
 
-  def initialize(uuid_string, options = {})
+  def initialize(uuid_string = nil, options = {})
     @converter = options[:converter] || Youyouaidi::Converter
-    raise Youyouaidi::InvalidUUIDError.new "`#{uuid_string}' could not be converted to valid UUID" unless self.class.valid? uuid_string
-    @uuid = uuid_string.to_s.downcase
+    if uuid_string
+      initialize_with_uuid_string uuid_string
+    else
+      initialize_without_param
+    end
   end
 
   def ==(other_object)
@@ -32,11 +37,22 @@ class Youyouaidi::UUID
 
   private
 
+    def initialize_without_param
+      @uuid = SecureRandom.uuid
+    end
+
+    def initialize_with_uuid_string(uuid_string)
+      raise Youyouaidi::InvalidUUIDError.new "`#{uuid_string}' could not be converted to valid UUID" unless self.class.valid? uuid_string
+      @uuid = uuid_string.to_s.downcase
+    end
+
   class << self
-    def parse(uuid_param, options = {})
+    def parse(uuid_param = nil, options = {})
       @converter = options[:converter] || Youyouaidi::Converter
       if valid? uuid_param
         self.new uuid_param.to_s, options
+      elsif uuid_param.nil?
+        self.new nil, 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
@@ -45,7 +61,7 @@ class Youyouaidi::UUID
     end
 
     def valid?(uuid_canidate)
-      (uuid_canidate.to_s =~ /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i) == 0
+      (uuid_canidate.to_s =~ /^[\da-f]{8}(-[\da-f]{4}){2}-[89ab][\da-f]{3}-[\da-f]{12}$/i) == 0
     end
   end
 end

data/lib/youyouaidi/version.rb

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

data/spec/kernel_patch_spec.rb

@@ -14,6 +14,11 @@ describe Kernel do
       its(:to_s) { should eq valid_uuid }
     end
 
+    context 'initialized without a param' do
+      let(:action) { UUID() }
+      it { should be_a Youyouaidi::UUID }
+    end
+
     context 'initialized via valid uuid' do
       let(:param) { valid_uuid }
       it_behaves_like 'a valid UUID object'

data/spec/youyouaidi/uuid_spec.rb

@@ -6,6 +6,20 @@ describe Youyouaidi::UUID do
     let(:action) { Youyouaidi::UUID.new param }
     subject { -> { action } }
 
+    context 'without a param' do
+      let(:action) { Youyouaidi::UUID.new }
+      subject { action }
+
+      it { should be_a Youyouaidi::UUID }
+      describe 'having a valid UUID version 4' do
+        subject { action.to_s }
+
+        it { should be_a String }
+        it { should have(36).characters }
+        it { should match /[\da-f]{8}-[\da-f]{4}-4[\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}/i }
+      end
+    end
+
     context 'with valid uuid string' do
       subject { action }
 
@@ -200,16 +214,21 @@ describe Youyouaidi::UUID do
     subject { Youyouaidi::UUID.valid? param }
 
     context 'with valid uuid' do
-      let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
+      valid_uuids = ['550e8400-e29b-41d4-a716-446655440000',
+                     '27f8bc29-be8e-4dc7-8b30-0295b2a5e902']
 
-      it { should be_true }
+      valid_uuids.each do |valid_uuid|
+        it "should return true for `#{valid_uuid}`" do
+          expect(Youyouaidi::UUID.valid? valid_uuid).to eq true
+        end
+      end
     end
 
     context 'with invalid uuid' do
       uuid_string   = '550e8400-e29b-41d4-a716-446655440000'
       encoded_uuid  = '2AuYQJcZeiIeCymkJ7tzTW'
       invalid_uuids = ['Kekse', "aa#{uuid_string}", "#{uuid_string}bb",
-        "#{encoded_uuid}" ]
+        "#{encoded_uuid}", '550e8400-e29b-41d4-2716-446655440000']
 
       invalid_uuids.each do |invalid_uuid|
         it "should return false for `#{invalid_uuid}`" do

metadata

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