youyouaidi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1348322fab3186ecf944dd41ca64cae5316b4648
-  data.tar.gz: f469604e1089be795b4d49bb533af942be2af1d2
+  metadata.gz: 1713ea510982e9d0ef36b7ea4b5601342bbb7673
+  data.tar.gz: 883a63e7466046595d329ae52bae3739b2275ad7
 SHA512:
-  metadata.gz: 577327867e66034cf00973254f133b173c8799545916bb4403e7df4adcaf96c7f0f68570ebe620ef7b852c0110598857e667266b8cf5264ff4246ca3625065de
-  data.tar.gz: 90418860a463cba9a14a5cfad83ae40fed522ca6fce33ecdd611c2bfbfc7f8c2e6ce1a06f6544426d4dcba3d0f0f41346270afee0b8369e03de3581efddb1058
+  metadata.gz: 957ee30738eb6f2d5d1bb7520ecb2768148bc2a4d6d90d3e725804f553034e446f34b669bfabc14e3a29e6dffc5731f86dd6e2262a2b2da6c3979b269776f484
+  data.tar.gz: 4a9520ae3df9cfbc6aa393d02c867a95eb690cfcff6bab6a2693f7e3a0ffd3cb9d3a4d74ed79e6beb537d1fdb471769f84848c91a74706c16bb2ae7ebc512fcb

data/README.md

@@ -22,24 +22,58 @@ Or install it yourself as:
 
 ## Usage
 
+### 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
 
-Youyouaidi::UUID.valid? uuid_string # => true
-
 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
+
+# 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">
+```
+
+
+### Validity check and conversions
+
+```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.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
 ```
 
+
+### Comparing UUIDs
+
+```ruby
+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'
+
+uuid == similar_uuid # Two UUID objects representing same UUID (#=== behaves similar for this)
+# => true
+
+uuid == other_uuid   # Two UUID objects representing different UUIDs (#=== behaves similar for this)
+# => false
+
+uuid == uuid_string  # Comparing a UUID object and its string representation with `=='
+# => false
+
+uuid === uuid_string # Comparing a UUID object and its string representation with `===' (case insensetive)
+# => true
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/youyouaidi/fork )

data/lib/youyouaidi/uuid.rb

@@ -4,7 +4,17 @@ class Youyouaidi::UUID
   def initialize(uuid_string, 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
+    @uuid = uuid_string.to_s.downcase
+  end
+
+  def ==(other_object)
+    return false unless other_object.is_a? self.class
+    self.to_s == other_object.to_s
+  end
+
+  def ===(other_object)
+    return true if self == other_object
+    self.to_s == other_object.to_s.downcase
   end
 
   def to_i

data/lib/youyouaidi/version.rb

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

data/spec/youyouaidi/uuid_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+
+describe Youyouaidi::UUID do
+  describe '.new' do
+    let(: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 }
+      its(:to_s) { should eq param }
+    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' }
+
+      it { should be_a Youyouaidi::UUID }
+    end
+
+    context 'with uuid in short format' do
+        let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
+        let(:decoded_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
+
+        it { should be_a Youyouaidi::UUID }
+        its(:to_s) { should eq decoded_uuid }
+    end
+
+    context 'with invalid uuid string' do
+      let(:param) { 'Kekse' }
+
+      it 'raises error' do
+        expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
+      end
+    end
+
+    context 'with non-string input' do
+      let(:param) { 1234 }
+
+      it 'raises error' do
+        expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
+      end
+    end
+  end
+
+  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(:first_uuid)  { Youyouaidi::UUID.new first_uuid_string }
+    let(:second_uuid) { Youyouaidi::UUID.new second_uuid_string }
+
+    subject { action }
+
+    context 'passing a UUID object' do
+      context 'when comparing same instance' do
+        let(:action) { first_uuid.send described_method, first_uuid }
+        it { should be_true }
+      end
+
+      context 'when comparing different instances' do
+        let(:action) { first_uuid.send described_method, second_uuid }
+        context 'with same UUID strings' do
+          let(:second_uuid_string) { first_uuid_string }
+          it { should be_true }
+        end
+
+        context 'with different UUID strings' do
+            it { should be_false }
+        end
+      end
+    end
+  end
+
+  describe '#== (equal operator)' do
+    let(:uuid_string)  { 'aaaaaaaa-eeee-4444-aaaa-444444444444' }
+    let(:uuid)  { Youyouaidi::UUID.new uuid_string }
+
+    let(:described_method) { :== }
+    it_behaves_like 'equality check for two UUID objects'
+
+    subject { action }
+
+    context 'passing a non-UUID object' do
+      let(:action) { uuid == test_object }
+
+      context 'when this is the UUID as string' do
+        let(:test_object) { uuid_string }
+        it { should be_false }
+      end
+
+      context 'when this is a random other object' do
+        let(:test_object) { '123' }
+        it { should be_false }
+      end
+    end
+  end
+
+  describe '#=== (equal operator)' do
+    let(:uuid_string)  { 'aaaaaaaa-eeee-4444-aaaa-444444444444' }
+    let(:uuid)  { Youyouaidi::UUID.new uuid_string }
+
+    let(:described_method) { :=== }
+    it_behaves_like 'equality check for two UUID objects'
+
+    subject { action }
+
+    context 'passing a non-UUID object' do
+      let(:action) { uuid === test_object }
+
+      context 'when this is the same UUID as string' do
+        context 'when string is upcase' do
+          let(:test_object) { uuid_string.upcase }
+          it { should be_true }
+        end
+        context 'when string is downcase' do
+          let(:test_object) { uuid_string.downcase }
+          it { should be_true }
+        end
+      end
+
+      context 'when this is a random other object' do
+        let(:test_object) { '123' }
+        it { should be_false }
+      end
+    end
+  end
+
+  describe '#to_s' do
+    let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+    let(:uuid) { Youyouaidi::UUID.new uuid_string }
+    subject { uuid.to_s }
+
+    it { should be_a String }
+    it { should eq uuid_string }
+  end
+
+  describe '#to_i' do
+    let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+    let(:uuid) { Youyouaidi::UUID.new uuid_string }
+    subject { uuid.to_i }
+
+    it { should be_a Bignum }
+    it { should eq 113059749145936325402354257176981405696 }
+  end
+
+  shared_examples_for 'method for short format' do
+    let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+    let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+    let(:uuid) { Youyouaidi::UUID.new uuid_string }
+
+    let(:action) { uuid.send method }
+    subject { action }
+
+    it { should be_a String }
+    it { should eq encoded_uuid }
+  end
+  describe '#to_short_string' do
+    let(:method) { :to_short_string }
+    it_behaves_like 'method for short format'
+  end
+  describe '#to_param' do
+    let(:method) { :to_param }
+    it_behaves_like 'method for short format'
+  end
+
+  describe '.valid?' do
+    let(:param) { '' }
+    subject { Youyouaidi::UUID.valid? param }
+
+    context 'with valid uuid' do
+      let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
+
+      it { should be_true }
+    end
+
+    context 'with invalid uuid' do
+      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? invalid_uuid).to eq false
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youyouaidi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nicolas Fricke
@@ -61,7 +61,7 @@ files:
 - spec/kernel_patch_spec.rb
 - spec/spec_helper.rb
 - spec/youyouaidi/converter_spec.rb
-- spec/youyouaidi_spec.rb
+- spec/youyouaidi/uuid_spec.rb
 - youyouaidi.gemspec
 homepage: https://github.com/nicolas-fricke/youyouaidi
 licenses:
@@ -91,5 +91,5 @@ test_files:
 - spec/kernel_patch_spec.rb
 - spec/spec_helper.rb
 - spec/youyouaidi/converter_spec.rb
-- spec/youyouaidi_spec.rb
+- spec/youyouaidi/uuid_spec.rb
 has_rdoc: 

data/spec/youyouaidi_spec.rb

@@ -1,131 +0,0 @@
-require 'spec_helper'
-
-describe Youyouaidi do
-  describe Youyouaidi::UUID do
-    describe '.new' do
-      let(: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' }
-
-        it { should be_a Youyouaidi::UUID }
-      end
-
-      context 'with uuid in short format' do
-          let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
-          let(:decoded_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
-
-          it { should be_a Youyouaidi::UUID }
-          its(:to_s) { should eq decoded_uuid }
-      end
-
-      context 'with invalid uuid string' do
-        let(:param) { 'Kekse' }
-
-        it 'raises error' do
-          expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
-        end
-      end
-
-      context 'with non-string input' do
-        let(:param) { 1234 }
-
-        it 'raises error' do
-          expect { Youyouaidi::UUID.parse param }.to raise_error Youyouaidi::InvalidUUIDError
-        end
-      end
-    end
-
-    describe '#to_s' do
-      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-      let(:uuid) { Youyouaidi::UUID.new uuid_string }
-      subject { uuid.to_s }
-
-      it { should be_a String }
-      it { should eq uuid_string }
-    end
-
-    describe '#to_i' do
-      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-      let(:uuid) { Youyouaidi::UUID.new uuid_string }
-      subject { uuid.to_i }
-
-      it { should be_a Bignum }
-      it { should eq 113059749145936325402354257176981405696 }
-    end
-
-    shared_examples_for 'method for short format' do
-      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
-      let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
-      let(:uuid) { Youyouaidi::UUID.new uuid_string }
-
-      let(:action) { uuid.send method }
-      subject { action }
-
-      it { should be_a String }
-      it { should eq encoded_uuid }
-    end
-    describe '#to_short_string' do
-      let(:method) { :to_short_string }
-      it_behaves_like 'method for short format'
-    end
-    describe '#to_param' do
-      let(:method) { :to_param }
-      it_behaves_like 'method for short format'
-    end
-
-    describe '.valid?' do
-      let(:param) { '' }
-      subject { Youyouaidi::UUID.valid? param }
-
-      context 'with valid uuid' do
-        let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
-
-        it { should be_true }
-      end
-
-      context 'with invalid uuid' do
-        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? invalid_uuid).to eq false
-          end
-        end
-      end
-    end
-  end
-end