rspec-uuid 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4aa8aad7b8b1b71002560449a351a7bd23a83bf3d3becb4ed7f3df86258add3
-  data.tar.gz: 27a9d9b605a15c93f0f7c72c2f4a1c28f96752a50af0f741113881c8880f3529
+  metadata.gz: 9734bb31d88892de3d5c141afbcdbd444b942f327863c4e87be0198b0cf0d3e9
+  data.tar.gz: 7672b8b47603a9f895fb4586af1141edd7b0693c492991a5fecc1847f7f42348
 SHA512:
-  metadata.gz: f015ceddf27a116bf433006d9992c5f2622cd4f2e3587bdae9f142fce7cbabf778826494cc2b45f2793c1f18cacf054fd08c64024da0c4ad8a666a7f32451dd7
-  data.tar.gz: bf5a2c0775e30e310897e209a028b5f8746aafcc25b7b0b6af44af9fc32e7cbed5a1832b663dcde58ecc29adb7a23b2bde828080c320f5dc32bca07570ae5aad
+  metadata.gz: c59ae103abe71f91cb4902c2a98d33084cc5cfa5726c0c723fdb19267f85ff29f1f76ffc366d598743c740f49635b75490747f8a53a455b3bef84ffb14400262
+  data.tar.gz: c5cefea9b062dd117b02491684cc221b52651c56801975458519c222dac9152a8bfcbbb15dbe8d475dcdf2e94b304974cab9d8e47696f032be3cbb17828256f2

data/lib/rspec-uuid/version.rb

@@ -1,3 +1,3 @@
 module RSpecUUID
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/rspec-uuid.rb

@@ -1,8 +1,38 @@
-require "rspec/core"
 require "rspec/expectations"
-require "rspec-uuid/matchers"
-require "rspec-uuid/version"
 
-RSpec.configure do |config|
-  config.include(RSpecUUID::Matchers)
+RSpec::Matchers.define :be_a_uuid do |version: nil|
+  match do |actual|
+    return false unless actual.is_a?(String)
+
+    # https://www.uuidtools.com/what-is-uuid
+    matches = actual.match /^\h{8}-\h{4}-(\h{4})-\h{4}-\h{12}$/
+    return false unless matches
+
+    if version
+      # 1st nibble of 3rd section
+      @actual_version = matches[1].to_i(16) >> 12
+
+      version == @actual_version
+    else
+      true
+    end
+  end
+
+  description do
+    version ? "a UUID v#{version}" : "a UUID"
+  end
+
+  failure_message do
+    if @actual_version
+      "expected #{description}, found a UUID v#{@actual_version}"
+    else
+      "expected #{description}"
+    end
+  end
+
+  failure_message_when_negated do
+    "did not expect #{description}"
+  end
 end
+
+RSpec::Matchers.alias_matcher :a_uuid, :be_a_uuid

data/spec/matchers_spec.rb

@@ -1,4 +1,4 @@
-describe RSpecUUID::Matchers do
+describe "be_a_uuid" do
   context "with a valid UUID" do
     let(:uuid) { "992c94bd-5870-4e02-ad2d-a9435f7fffe6" }
 
@@ -8,6 +8,7 @@ describe RSpecUUID::Matchers do
   context "with generated UUIDs" do
     specify do
       100.times { expect(SecureRandom.uuid).to be_a_uuid }
+      100.times { expect(Faker::Internet.uuid).to be_a_uuid }
     end
   end
 
@@ -36,17 +37,34 @@ describe RSpecUUID::Matchers do
     let(:uuid_v4) { SecureRandom.uuid }
     let(:uuid_v5) { Digest::UUID.uuid_v5(namespace, "123") }
 
-    specify { expect(uuid_v3).to be_a_uuid(3) }
-    specify { expect(uuid_v3).not_to be_a_uuid(4) }
-    specify { expect(uuid_v3).not_to be_a_uuid(5) }
+    specify { expect(uuid_v3).to be_a_uuid(version: 3) }
+    specify { expect(uuid_v3).not_to be_a_uuid(version: 4) }
+    specify { expect(uuid_v3).not_to be_a_uuid(version: 5) }
 
-    specify { expect(uuid_v4).to be_a_uuid(4) }
-    specify { expect(uuid_v5).to be_a_uuid(5) }
+    specify { expect(uuid_v4).to be_a_uuid(version: 4) }
+    specify { expect(uuid_v5).to be_a_uuid(version: 5) }
 
     it "fails with a useful message" do
       expect {
-        expect(uuid_v3).to be_a_uuid(4)
-      }.to fail_including("UUID v4, found a UUID v3")
+        expect(uuid_v3).to be_a_uuid(version: 4)
+      }.to fail_including("expected a UUID v4, found a UUID v3")
     end
   end
+
+  it "is composable" do
+    data = {
+      res: {
+        abc: { a: 1 },
+        uuid: SecureRandom.uuid,
+        uuid_v5: Digest::UUID.uuid_v5(Digest::UUID::OID_NAMESPACE, "123"),
+      },
+      foo: nil,
+    }
+
+    expect(data).to include(res: {
+      abc: a_hash_including(:a),
+      uuid: a_uuid,
+      uuid_v5: a_uuid(version: 5),
+    })
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-uuid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +115,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rspec-uuid.rb
-- lib/rspec-uuid/matchers.rb
 - lib/rspec-uuid/version.rb
 - spec/matchers_spec.rb
 homepage: https://github.com/dpep/rspec-uuid

data/lib/rspec-uuid/matchers.rb

@@ -1,47 +0,0 @@
-module RSpecUUID
-  module Matchers
-    class UUIDMatcher
-      def initialize(version = nil)
-        @version = version
-      end
-
-      def matches?(actual)
-        return false unless actual.is_a?(String)
-
-        # https://www.uuidtools.com/what-is-uuid
-        match = actual.match /^\h{8}-\h{4}-(\h{4})-\h{4}-\h{12}$/
-
-        return false unless match
-
-        if @version
-          # 1st nibble of 3rd section
-          @actual_version = match[1].to_i(16) >> 12
-
-          @version == @actual_version
-        else
-          true
-        end
-      end
-
-      def description
-        @version ? "a UUID v#{@version}" : "a UUID"
-      end
-
-      def failure_message
-        if @actual_version
-          "expected #{description}, found a UUID v#{@actual_version}"
-        else
-          "expected #{description}"
-        end
-      end
-
-      def failure_message_when_negated
-        "did not expect #{description}"
-      end
-    end
-
-    def be_a_uuid(...)
-      UUIDMatcher.new(...)
-    end
-  end
-end