youyouaidi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bc980217243ad4ab182d95a4bc4e1c32ca04dc9
-  data.tar.gz: 6bad0870b6e0cf45e6fc8f3d783c0253d9e072d0
+  metadata.gz: 5dc034244f89c5e008ac157a3623fee8c410506a
+  data.tar.gz: df6894a97327c5a0947d143a9c367e0901ab5261
 SHA512:
-  metadata.gz: 1715bbde2ec432104c9d3012940fa4e9f51bd5e930171885136b288507de1b76f80905a15973158d7b30e978ade65e06221a55028cfd0f2b539659ad49a3a2a2
-  data.tar.gz: 11a1b217560ebfb1142b9405df2d186a8a60131161802530145dbbf86b534ff53804a99672dcc117a3ffa3104458bd551da586b2ff0dc2bc9ddbbb774ac15242
+  metadata.gz: 8dddadf28922905d8c8a1797add44e48971e046354fc74031ccacecdacec9ab785e97c9703eee06579474a454770d12b25e4b31ad374c905958acbd194a0d02d
+  data.tar.gz: 7afcc05faff44845fd8a5b844660dd4f714ddfd475153d7e47de3643c5d31388f896e248e710f0f155e173b3efc19a88576aca17eb254d1ffff8c0e0d898f567

data/README.md

@@ -14,12 +14,11 @@ For UUID generation, the `SecureRandom.uuid` method is used which generates vali
 
 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
+                           number    a, or b
+                                ▼    ▼
+                  caed3f49-b0ca-454b-adf8-5ee2a1764759
+# chars in group:     8   | 4  | 4  | 4  |    12
 ```
 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`.
@@ -43,6 +42,9 @@ Or install it yourself as:
 
 ## Usage
 
+For usability, `UUID(...)` is patched into the kernel as a shorthand call to `Youyouaidi::UUID.parse(...)`.
+Also, `UUID` is patched as a reference for the class `Youyouid::UUID`.
+
 ### Initializing UUIDs
 
 ```ruby
@@ -64,11 +66,15 @@ new_uuid = UUID()         # generates a random UUID version 4 using the SecureRa
 
 ### Validity check and conversions
 
+The validity check `UUID.valid? uuid_string` checks, if UUID contains exactly 32 hexadecimal characters which are divided by four dashes ('-') into five groups of sizes 8, 4, 4, 4, and 12.
+Also, it validates that the first character of the fourth group is either a `8`, `9`, an `a`, or a `b`.
+
 ```ruby
 uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format
 uuid = UUID uuid_string
 
-Youyouaidi::UUID.valid? uuid_string # => true
+UUID.valid? uuid_string # Checks if `uuid_string' is a valid UUID, same as Youyouaidi::UUID.valid? uuid_string
+# => true
 
 uuid.to_s        # Returns the string representation of the UUID object
 # => '550e8400-e29b-41d4-a716-446655440000'

data/lib/kernel_patch.rb

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

data/lib/youyouaidi/version.rb

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

data/spec/kernel_patch_spec.rb

@@ -35,4 +35,18 @@ describe Kernel do
       it { should raise_error Youyouaidi::InvalidUUIDError }
     end
   end
+
+  describe 'UUID class behaves as an alias for Youyouaidi::UUID' do
+    describe '.new' do
+      let(:param) { '' }
+      let(:action) { UUID.new param }
+      subject { action }
+
+      context 'without a param' do
+        let(:action) { UUID.new }
+        subject { action }
+        it { should be_a Youyouaidi::UUID }
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -4,8 +4,11 @@ require 'bundler'
 Bundler.require
 
 # Code coverage statistics at coveralls.io: https://coveralls.io/r/nicolas-fricke/youyouaidi
-require 'coveralls'
-Coveralls.wear!
+# Generate coverage reports only when using MRI, see: https://github.com/lemurheavy/coveralls-public/issues/144
+if ENV['TRAVIS'] && ENV['COVERALLS'] && RUBY_ENGINE == 'ruby'
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 require 'youyouaidi'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youyouaidi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicolas Fricke